DescribeAuditSuppression - AWS IoT

DescribeAuditSuppression

Gets information about a Device Defender audit suppression.

Request Syntax

POST /audit/suppressions/describe HTTP/1.1 Content-type: application/json { "checkName": "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.

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

resourceIdentifier

Information that identifies the noncompliant resource.

Type: ResourceIdentifier object

Required: Yes

Response Syntax

HTTP/1.1 200 Content-type: application/json { "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.

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

description

The description of the audit suppression.

Type: String

Length Constraints: Maximum length of 1000.

Pattern: [\p{Graph}\x20]*

expirationDate

The epoch timestamp in seconds at which this suppression expires.

Type: Timestamp

resourceIdentifier

Information that identifies the noncompliant resource.

Type: ResourceIdentifier object

suppressIndefinitely

Indicates whether a suppression should exist indefinitely or not.

Type: Boolean

Errors

InternalFailureException

An unexpected error has occurred.

HTTP Status Code: 500

InvalidRequestException

The request is not valid.

HTTP Status Code: 400

ResourceNotFoundException

The specified resource does not exist.

HTTP Status Code: 404

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: