/

The Amazon SSM multi-region endpoint

http://ssm.{region}.amazonaws.com

POST

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.

Request Example

Shell

JavaScript

Java

Swift

curl --location -g --request POST 'http://ssm.{region}.amazonaws.com/' \
--header 'X-Amz-Target;' \
--header 'Content-Type: application/json' \
--data-raw '{
    "OpsItemFilters": [],
    "MaxResults": 0,
    "NextToken": "string"
}'

Response Example

200 - Example 1

{
    "NextToken": "string",
    "OpsItemSummaries": []
}

Request

Query Params

MaxResults

string

optional

Pagination limit

NextToken

string

optional

Pagination token

Header Params

X-Amz-Target

string

required

Body Params application/json

OpsItemFilters

array[object (OpsItemFilter) {3}]

optional

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

Key

enum<string>

required

The name of the filter.

Allowed values:

StatusCreatedBySourcePriorityTitleOpsItemIdCreatedTimeLastModifiedTimeActualStartTimeActualEndTimePlannedStartTimePlannedEndTimeOperationalDataOperationalDataKeyOperationalDataValueResourceIdAutomationIdCategorySeverityOpsItemTypeChangeRequestByRequesterArnChangeRequestByRequesterNameChangeRequestByApproverArnChangeRequestByApproverNameChangeRequestByTemplateChangeRequestByTargetsResourceGroupInsightByTypeAccountId

Values

array[string]

required

The filter value.

Operator

enum<string>

required

The operator used by the filter call.

Allowed values:

EqualContainsGreaterThanLessThan

MaxResults

integer

optional

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.

>= 1<= 50

NextToken

string

optional

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

Examples

Responses

🟢200Success

application/json

Body

NextToken

string

optional

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

OpsItemSummaries

array[object (OpsItemSummary) {17}]

optional

A list of OpsItems.

CreatedBy

string

optional

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

CreatedTime

string <date-time>

optional

The date and time the OpsItem was created.

LastModifiedBy

string

optional

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

LastModifiedTime

string <date-time>

optional

The date and time the OpsItem was last updated.

Priority

integer

optional

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

>= 1<= 5

Source

string

optional

The impacted Amazon Web Services resource.

>= 1 characters<= 128 characters

Match pattern:

^(?!\s*$).+

Status

enum<string>

optional

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

Allowed values:

OpenInProgressResolvedPendingTimedOutCancellingCancelledFailedCompletedWithSuccessCompletedWithFailureScheduledRunbookInProgressPendingChangeCalendarOverrideChangeCalendarOverrideApprovedChangeCalendarOverrideRejectedPendingApprovalApprovedRejectedClosed

OpsItemId

string

optional

The ID of the OpsItem.

Match pattern:

^(oi)-[0-9a-f]{12}$

Title

string

optional

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

>= 1 characters<= 1024 characters

Match pattern:

^(?!\s*$).+

OperationalData

object

optional

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