describe-ops-items¶

Description¶

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

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

Synopsis¶

  describe-ops-items
[--ops-item-filters <value>]
[--max-results <value>]
[--next-token <value>]
[--cli-input-json | --cli-input-yaml]
[--generate-cli-skeleton <value>]
[--cli-auto-prompt <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: 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

*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"|"OperationalData"|"OperationalDataKey"|"OperationalDataValue"|"ResourceId"|"AutomationId"|"Category"|"Severity",
    "Values": ["string", ...],
    "Operator": "Equal"|"Contains"|"GreaterThan"|"LessThan"
  }
  ...
]

--max-results (integer)

The maximum number of items to return for this call. The call also returns a token that you can specify in a subsequent call to get the next set of results.

--next-token (string)

A token to start the list. Use this token to get the next set of results.

--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.

--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.

--cli-auto-prompt (boolean) Automatically prompt for CLI input parameters.

See ‘aws help’ for descriptions of global parameters.

Examples¶

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 AWS 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.

Table of Contents

Feedback

User Guide