describe-ops-items¶

Description¶

Query a set of OpsItems. You must have permission in Identity and Access Management (IAM) to query a list of OpsItems. For more information, see Getting started with OpsCenter in the Amazon Web Services Systems Manager User Guide .

Operations engineers and IT professionals use Amazon Web Services Systems Manager OpsCenter to view, investigate, and remediate operational issues impacting the performance and health of their Amazon Web Services resources. For more information, see OpsCenter in the Amazon Web Services Systems Manager User Guide .

Synopsis¶

  describe-ops-items
[--ops-item-filters <value>]
[--cli-input-json | --cli-input-yaml]
[--starting-token <value>]
[--page-size <value>]
[--max-items <value>]
[--generate-cli-skeleton <value>]

Options¶

--ops-item-filters (list)

One or more filters to limit the response.

Key: CreatedTime Operations: GreaterThan, LessThan

Key: LastModifiedBy Operations: Contains, Equals

Key: LastModifiedTime Operations: GreaterThan, LessThan

Key: Priority Operations: Equals

Key: Source Operations: Contains, Equals

Key: Status Operations: Equals

Key: Title* Operations: Equals,Contains

Key: OperationalData** Operations: Equals

Key: OperationalDataKey Operations: Equals

Key: OperationalDataValue Operations: Equals, Contains

Key: OpsItemId Operations: Equals

Key: ResourceId Operations: Contains

Key: AutomationId Operations: Equals

*The Equals operator for Title matches the first 100 characters. If you specify more than 100 characters, they system returns an error that the filter value exceeds the length limit.

**If you filter the response by using the OperationalData operator, specify a key-value pair by using the following JSON format: {“key”:”key_name”,”value”:”a_value”}

(structure)

Describes an OpsItem filter.

Key -> (string)

The name of the filter.

Values -> (list)

The filter value.

(string)

Operator -> (string)

The operator used by the filter call.

Shorthand Syntax:

Key=string,Values=string,string,Operator=string ...

JSON Syntax:

[
  {
    "Key": "Status"|"CreatedBy"|"Source"|"Priority"|"Title"|"OpsItemId"|"CreatedTime"|"LastModifiedTime"|"ActualStartTime"|"ActualEndTime"|"PlannedStartTime"|"PlannedEndTime"|"OperationalData"|"OperationalDataKey"|"OperationalDataValue"|"ResourceId"|"AutomationId"|"Category"|"Severity"|"OpsItemType"|"ChangeRequestByRequesterArn"|"ChangeRequestByRequesterName"|"ChangeRequestByApproverArn"|"ChangeRequestByApproverName"|"ChangeRequestByTemplate"|"ChangeRequestByTargetsResourceGroup"|"InsightByType",
    "Values": ["string", ...],
    "Operator": "Equal"|"Contains"|"GreaterThan"|"LessThan"
  }
  ...
]

--cli-input-json | --cli-input-yaml (string) Reads arguments from the JSON string provided. The JSON string follows the format provided by --generate-cli-skeleton. If other arguments are provided on the command line, those values will override the JSON-provided values. It is not possible to pass arbitrary binary values using a JSON-provided value as the string will be taken literally. This may not be specified along with --cli-input-yaml.

--starting-token (string)

A token to specify where to start paginating. This is the NextToken from a previously truncated response.

For usage examples, see Pagination in the AWS Command Line Interface User Guide .

--page-size (integer)

The size of each page to get in the AWS service call. This does not affect the number of items returned in the command’s output. Setting a smaller page size results in more calls to the AWS service, retrieving fewer items in each call. This can help prevent the AWS service calls from timing out.

For usage examples, see Pagination in the AWS Command Line Interface User Guide .

--max-items (integer)

The total number of items to return in the command’s output. If the total number of items available is more than the value specified, a NextToken is provided in the command’s output. To resume pagination, provide the NextToken value in the starting-token argument of a subsequent command. Do not use the NextToken response element directly outside of the AWS CLI.

For usage examples, see Pagination in the AWS Command Line Interface User Guide .

--generate-cli-skeleton (string) Prints a JSON skeleton to standard output without sending an API request. If provided with no value or the value input, prints a sample input JSON that can be used as an argument for --cli-input-json. Similarly, if provided yaml-input it will print a sample input YAML that can be used with --cli-input-yaml. If provided with the value output, it validates the command inputs and returns a sample output JSON for that command. The generated JSON skeleton is not stable between versions of the AWS CLI and there are no backwards compatibility guarantees in the JSON skeleton generated.

See ‘aws help’ for descriptions of global parameters.

Examples¶

Note

To use the following examples, you must have the AWS CLI installed and configured. See the Getting started guide in the AWS CLI User Guide for more information.

Unless otherwise stated, all examples have unix-like quotation rules. These examples will need to be adapted to your terminal’s quoting rules. See Using quotation marks with strings in the AWS CLI User Guide .

To list a set of OpsItems

The following describe-ops-items example displays a list of all open OpsItems in your AWS account.

aws ssm describe-ops-items \
    --ops-item-filters "Key=Status,Values=Open,Operator=Equal"

Output:

{
    "OpsItemSummaries": [
        {
            "CreatedBy": "arn:aws:sts::111222333444:assumed-role/OpsItem-CWE-Role/fbf77cbe264a33509569f23e4EXAMPLE",
            "CreatedTime": "2020-03-14T17:02:46.375000-07:00",
            "LastModifiedBy": "arn:aws:sts::111222333444:assumed-role/OpsItem-CWE-Role/fbf77cbe264a33509569f23e4EXAMPLE",
            "LastModifiedTime": "2020-03-14T17:02:46.375000-07:00",
            "Source": "SSM",
            "Status": "Open",
            "OpsItemId": "oi-7cfc5EXAMPLE",
            "Title": "SSM Maintenance Window execution failed",
            "OperationalData": {
                "/aws/dedup": {
                    "Value": "{\"dedupString\":\"SSMOpsItems-SSM-maintenance-window-execution-failed\"}",
                    "Type": "SearchableString"
                },
                "/aws/resources": {
                    "Value": "[{\"arn\":\"arn:aws:ssm:us-east-2:111222333444:maintenancewindow/mw-034093d322EXAMPLE\"}]",
                    "Type": "SearchableString"
                }
            },
            "Category": "Availability",
            "Severity": "3"
        },
        {
            "CreatedBy": "arn:aws:sts::1112223233444:assumed-role/OpsItem-CWE-Role/fbf77cbe264a33509569f23e4EXAMPLE",
            "CreatedTime": "2020-02-26T11:43:15.426000-08:00",
            "LastModifiedBy": "arn:aws:sts::111222333444:assumed-role/OpsItem-CWE-Role/fbf77cbe264a33509569f23e4EXAMPLE",
            "LastModifiedTime": "2020-02-26T11:43:15.426000-08:00",
            "Source": "EC2",
            "Status": "Open",
            "OpsItemId": "oi-6f966EXAMPLE",
            "Title": "EC2 instance stopped",
            "OperationalData": {
                "/aws/automations": {
                    "Value": "[ { \"automationType\": \"AWS:SSM:Automation\", \"automationId\": \"AWS-RestartEC2Instance\" } ]",
                    "Type": "SearchableString"
                },
                "/aws/dedup": {
                    "Value": "{\"dedupString\":\"SSMOpsItems-EC2-instance-stopped\"}",
                    "Type": "SearchableString"
                },
                "/aws/resources": {
                    "Value": "[{\"arn\":\"arn:aws:ec2:us-east-2:111222333444:instance/i-0beccfbc02EXAMPLE\"}]",
                    "Type": "SearchableString"
                }
            },
            "Category": "Availability",
            "Severity": "3"
        }
    ]
}

For more information, see Working with OpsItems in the AWS Systems Manager User Guide.

Output¶

NextToken -> (string)

The token for the next set of items to return. Use this token to get the next set of results.

OpsItemSummaries -> (list)

A list of OpsItems.

(structure)

A count of OpsItems.

CreatedBy -> (string)

The Amazon Resource Name (ARN) of the IAM entity that created the OpsItem.

CreatedTime -> (timestamp)

The date and time the OpsItem was created.

LastModifiedBy -> (string)

The Amazon Resource Name (ARN) of the IAM entity that created the OpsItem.

LastModifiedTime -> (timestamp)

The date and time the OpsItem was last updated.

Priority -> (integer)

The importance of this OpsItem in relation to other OpsItems in the system.

Source -> (string)

The impacted Amazon Web Services resource.

Status -> (string)

The OpsItem status. Status can be Open , In Progress , or Resolved .

OpsItemId -> (string)

The ID of the OpsItem.

Title -> (string)

A short heading that describes the nature of the OpsItem and the impacted resource.

OperationalData -> (map)

Operational data is custom data that provides useful reference details about the OpsItem.

key -> (string)

value -> (structure)

An object that defines the value of the key and its type in the OperationalData map.

Value -> (string)

The value of the OperationalData key.

Type -> (string)

The type of key-value pair. Valid types include SearchableString and String .

Category -> (string)

A list of OpsItems by category.

Severity -> (string)

A list of OpsItems by severity.

OpsItemType -> (string)

The type of OpsItem. Currently, the only valid values are /aws/changerequest and /aws/issue .

ActualStartTime -> (timestamp)

The time a runbook workflow started. Currently reported only for the OpsItem type /aws/changerequest .

ActualEndTime -> (timestamp)

The time a runbook workflow ended. Currently reported only for the OpsItem type /aws/changerequest .

PlannedStartTime -> (timestamp)

The time specified in a change request for a runbook workflow to start. Currently supported only for the OpsItem type /aws/changerequest .

PlannedEndTime -> (timestamp)

The time specified in a change request for a runbook workflow to end. Currently supported only for the OpsItem type /aws/changerequest .

Table of Contents

Feedback

User Guide