ListAuditSuppressions - AWS IoT

ListAuditSuppressions

Lists your Device Defender audit listings.

Request Syntax

POST /audit/suppressions/list HTTP/1.1 Content-type: application/json { "ascendingOrder": boolean, "checkName": "string", "maxResults": number, "nextToken": "string", "resourceIdentifier": { "account": "string", "caCertificateId": "string", "clientId": "string", "cognitoIdentityPoolId": "string", "deviceCertificateId": "string", "iamRoleArn": "string", "policyVersionIdentifier": { "policyName": "string", "policyVersionId": "string" }, "roleAliasArn": "string" } }

URI Request Parameters

The request does not use any URI parameters.

Request Body

The request accepts the following data in JSON format.

ascendingOrder

Determines whether suppressions are listed in ascending order by expiration date or not. If parameter isn't provided, ascendingOrder=true.

Type: Boolean

Required: No

checkName

An audit check name. Checks must be enabled for your account. (Use DescribeAccountAuditConfiguration to see the list of all checks, including those that are enabled or use UpdateAccountAuditConfiguration to select which checks are enabled.)

Type: String

Required: No

maxResults

The maximum number of results to return at one time. The default is 25.

Type: Integer

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

Required: No

nextToken

The token for the next set of results.

Type: String

Required: No

resourceIdentifier

Information that identifies the noncompliant resource.

Type: ResourceIdentifier object

Required: No

Response Syntax

HTTP/1.1 200 Content-type: application/json { "nextToken": "string", "suppressions": [ { "checkName": "string", "description": "string", "expirationDate": number, "resourceIdentifier": { "account": "string", "caCertificateId": "string", "clientId": "string", "cognitoIdentityPoolId": "string", "deviceCertificateId": "string", "iamRoleArn": "string", "policyVersionIdentifier": { "policyName": "string", "policyVersionId": "string" }, "roleAliasArn": "string" }, "suppressIndefinitely": boolean } ] }

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.

nextToken

A token that can be used to retrieve the next set of results, or null if there are no additional results.

Type: String

suppressions

List of audit suppressions.

Type: Array of AuditSuppression objects

Errors

InternalFailureException

An unexpected error has occurred.

HTTP Status Code: 500

InvalidRequestException

The request is not valid.

HTTP Status Code: 400

ThrottlingException

The rate exceeds the limit.

HTTP Status Code: 400

See Also

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