Table Of Contents

Feedback

User Guide

First time using the AWS CLI? See the User Guide for help getting started.

[ aws . ssm ]

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 .

See also: AWS API Documentation

See 'aws help' for descriptions of global parameters.

Synopsis

  describe-ops-items
[--ops-item-filters <value>]
[--max-results <value>]
[--next-token <value>]
[--cli-input-json <value>]
[--generate-cli-skeleton <value>]

Options

--ops-item-filters (list)

One or more filters to limit the reponse.

  • 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"}

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",
    "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 (string) Performs service operation based on the JSON string provided. The JSON string follows the format provided by --generate-cli-skeleton. If other arguments are provided on the command line, the CLI 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.

--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. If provided with the value output, it validates the command inputs and returns a sample output JSON for that command.

See 'aws help' for descriptions of global parameters.

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 .