/ - Amazon Simple Systems Manager (SSM)

Returns a resource-level summary count. The summary includes information about compliant and non-compliant statuses and detailed compliance-item severity counts, according to the filter criteria 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 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. 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

ResourceComplianceSummaryItems

array[object (ResourceComplianceSummaryItem) {8}]

optional

A summary count for specified or targeted managed nodes. Summary count includes information about compliant and non-compliant State Manager associations, patch status, or custom items according to the filter criteria that you specify.

ComplianceType

string

optional

The compliance type.

>= 1 characters<= 100 characters

Match pattern:

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

ResourceType

string

optional

The resource type.

>= 1 characters<= 50 characters

ResourceId

string

optional

The resource ID.

>= 1 characters<= 100 characters

Status

enum<string>

optional

The compliance status for the resource.

Allowed values:

COMPLIANTNON_COMPLIANT

OverallSeverity

enum<string>

optional

The highest severity item found for the resource. The resource is compliant for this item.

Allowed values:

CRITICALHIGHMEDIUMLOWINFORMATIONALUNSPECIFIED

ExecutionSummary

object

optional

Information about the execution.

CompliantSummary

object

optional

A list of items that are compliant for the resource.

NonCompliantSummary

object

optional

A list of items that aren't compliant for the resource.

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