/ - Amazon Simple Systems Manager (SSM)

View a summary of operations metadata (OpsData) based on specified filters and aggregators. OpsData can include information about Amazon Web Services Systems Manager OpsCenter operational workitems (OpsItems) as well as information about any Amazon Web Services resource or service configured to report OpsData to Amazon Web Services Systems Manager Explorer.

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

Request

Query Params

MaxResults

string

optional

Pagination limit

NextToken

string

optional

Pagination token

Header Params

X-Amz-Target

string

required

Body Params application/json

SyncName

string

optional

Specify the name of a resource data sync to get.

>= 1 characters<= 64 characters

Filters

array[object (OpsFilter) {3}]

optional

Optional filters used to scope down the returned OpsData.

>= 1 items<= 5 items

Key

string

required

The name of the filter.

>= 1 characters<= 200 characters

Values

array[string]

required

The filter value.

>= 1 items<= 40 items

Type

enum<string>

optional

The type of filter.

Allowed values:

EqualNotEqualBeginWithLessThanGreaterThanExists

Aggregators

array[object (OpsAggregator) {6}]

optional

Optional aggregators that return counts of OpsData based on one or more expressions.

>= 1 items<= 12 items

AggregatorType

string

optional

Either a Range or Count aggregator for limiting an OpsData summary.

>= 1 characters<= 20 characters

Match pattern:

^(range|count|sum)

TypeName

string

optional

The data type name to use for viewing counts of OpsData.

>= 1 characters<= 100 characters

Match pattern:

^(AWS|Custom):.*$

AttributeName

string

optional

The name of an OpsData attribute on which to limit the count of OpsData.

>= 1 characters<= 128 characters

Values

object

optional

The aggregator value.

Filters

array[object (OpsFilter) {3}]

optional

The aggregator filters.

>= 1 items<= 5 items

Aggregators

array[object (OpsAggregator) {6}]

optional

A nested aggregator for viewing counts of OpsData.

>= 1 items<= 12 items

ResultAttributes

array[object (OpsResultAttribute) {1}]

optional

The OpsData data type to return.

>= 1 items

TypeName

string

required

Name of the data type. Valid value: AWS:OpsItem, AWS:EC2InstanceInformation, AWS:OpsItemTrendline, or AWS:ComplianceSummary.

>= 1 characters<= 100 characters

Match pattern:

^(AWS|Custom):.*$

NextToken

string

optional

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

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

Examples

Responses

🟢200Success

application/json

Body

Entities

array[object (OpsEntity) {2}]

optional

The list of aggregated details and filtered OpsData.

string

optional

The query ID.

Data

object

optional

The data returned by the query.

NextToken

string

optional

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

🟠480InternalServerError

🟠481ResourceDataSyncNotFoundException

🟠482InvalidFilter

🟠483InvalidNextToken

🟠484InvalidTypeNameException

🟠485InvalidAggregatorException