/

The Amazon SSM multi-region endpoint

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

POST

For a specified resource ID, this API operation returns a list of compliance statuses for different resource types. Currently, you can only specify one resource ID per call. List results depend on the criteria specified in the filter.

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 '{
    "Filters": [],
    "ResourceIds": [],
    "ResourceTypes": [],
    "NextToken": "string",
    "MaxResults": 0
}'

Response Example

200 - Example 1

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

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

ResourceIds

array[string]

optional

The ID for the resources from which to get compliance information. Currently, you can only specify one resource ID.

>= 1 items

ResourceTypes

array[string]

optional

The type of resource from which to get compliance information. Currently, the only supported resource type is ManagedInstance.

>= 1 items

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

ComplianceItems

array[object (ComplianceItem) {9}]

optional

A list of compliance information for the specified resource ID.

ComplianceType

string

optional

The compliance type. For example, Association (for a State Manager association), Patch, or Custom:string are all valid compliance types.

>= 1 characters<= 100 characters

Match pattern:

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

ResourceType

string

optional

The type of resource. ManagedInstance is currently the only supported resource type.

>= 1 characters<= 50 characters

ResourceId

string

optional

An ID for the resource. For a managed node, this is the node ID.

>= 1 characters<= 100 characters

string

optional

An ID for the compliance item. For example, if the compliance item is a Windows patch, the ID could be the number of the KB article; for example: KB4010320.

Title

string

optional

A title for the compliance item. For example, if the compliance item is a Windows patch, the title could be the title of the KB article for the patch; for example: Security Update for Active Directory Federation Services.

<= 500 characters

Status

enum<string>

optional

The status of the compliance item. An item is either COMPLIANT, NON_COMPLIANT, or an empty string (for Windows patches that aren't applicable).

Allowed values:

COMPLIANTNON_COMPLIANT

Severity

enum<string>

optional

The severity of the compliance status. Severity can be one of the following: Critical, High, Medium, Low, Informational, Unspecified.

Allowed values:

CRITICALHIGHMEDIUMLOWINFORMATIONALUNSPECIFIED

ExecutionSummary

object

optional

A summary for the compliance item. The summary includes an execution ID, the execution type (for example, command), and the execution time.

Details

object

optional

A "Key": "Value" tag combination for the compliance item.

NextToken

string

optional

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

🟠480InvalidResourceType

🟠481InvalidResourceId

🟠482InternalServerError

🟠483InvalidFilter

🟠484InvalidNextToken