/ - Amazon Simple Systems Manager (SSM)

Returns a summary count of compliant and non-compliant resources for a compliance type. For example, this call can return State Manager associations, patches, or custom compliance types according to the filter criteria that you specify.

curl --location -g --request POST 'http://ssm.{region}.amazonaws.com/' \ --header 'X-Amz-Target;' \ --header 'Content-Type: application/json' \ --data-raw '{ "Filters": [], "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

Filters

array[object (ComplianceStringFilter) {3}]

optional

One or more compliance or inventory filters. Use a filter to return a more specific list of results.

Key

string

optional

The name of the filter.

>= 1 characters<= 200 characters

Values

array[string]

optional

The value for which to search.

>= 1 items<= 20 items

Type

enum<string>

optional

The type of comparison that should be performed for the value: Equal, NotEqual, BeginWith, LessThan, or GreaterThan.

Allowed values:

EQUALNOT_EQUALBEGIN_WITHLESS_THANGREATER_THAN

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. Currently, you can specify null or 50. 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

ComplianceSummaryItems

array[object (ComplianceSummaryItem) {3}]

optional

A list of compliant and non-compliant summary counts based on compliance types. For example, this call returns State Manager associations, patches, or custom compliance types according to the filter criteria that you specified.

ComplianceType

string

optional

The type of compliance item. For example, the compliance type can be Association, Patch, or Custom:string.

>= 1 characters<= 100 characters

Match pattern:

[A-Za-z0-9_\-]\w+|Custom:[a-zA-Z0-9_\-]\w+

CompliantSummary

object

optional

A list of COMPLIANT items for the specified compliance type.

NonCompliantSummary

object

optional

A list of NON_COMPLIANT items for the specified compliance type.

NextToken

string

optional

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

🟠480InvalidFilter

🟠481InvalidNextToken

🟠482InternalServerError