Menu
AWS Systems Manager
API Reference (API Version 2014-11-06)

ListComplianceItems

For a specified resource ID, this API action 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 Syntax

{ "Filters": [ { "Key": "string", "Type": "string", "Values": [ "string" ] } ], "MaxResults": number, "NextToken": "string", "ResourceIds": [ "string" ], "ResourceTypes": [ "string" ] }

Request Parameters

For information about the parameters that are common to all actions, see Common Parameters.

The request accepts the following data in JSON format.

Filters

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

Type: Array of ComplianceStringFilter objects

Required: No

MaxResults

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.

Type: Integer

Valid Range: Minimum value of 1. Maximum value of 50.

Required: No

NextToken

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

Type: String

Required: No

ResourceIds

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

Type: Array of strings

Array Members: Minimum number of 1 item.

Length Constraints: Minimum length of 1. Maximum length of 100.

Required: No

ResourceTypes

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

Type: Array of strings

Array Members: Minimum number of 1 item.

Length Constraints: Minimum length of 1. Maximum length of 50.

Required: No

Response Syntax

{ "ComplianceItems": [ { "ComplianceType": "string", "Details": { "string" : "string" }, "ExecutionSummary": { "ExecutionId": "string", "ExecutionTime": number, "ExecutionType": "string" }, "Id": "string", "ResourceId": "string", "ResourceType": "string", "Severity": "string", "Status": "string", "Title": "string" } ], "NextToken": "string" }

Response Elements

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

ComplianceItems

A list of compliance information for the specified resource ID.

Type: Array of ComplianceItem objects

NextToken

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

Type: String

Errors

For information about the errors that are common to all actions, see Common Errors.

InternalServerError

An error occurred on the server side.

HTTP Status Code: 400

InvalidFilter

The filter name is not valid. Verify the you entered the correct name and try again.

HTTP Status Code: 400

InvalidNextToken

The specified token is not valid.

HTTP Status Code: 400

InvalidResourceId

The resource ID is not valid. Verify that you entered the correct ID and try again.

HTTP Status Code: 400

InvalidResourceType

The resource type is not valid. For example, if you are attempting to tag an instance, the instance must be a registered, managed instance.

HTTP Status Code: 400

See Also

For more information about using this API in one of the language-specific AWS SDKs, see the following: