/audit/suppressions/list - AWS IoT Wireless

Lists your Device Defender audit listings.

Requires permission to access the ListAuditSuppressions action.

curl --location -g --request POST 'https://api.iotwireless.{region}.amazonaws.com/audit/suppressions/list' \ --header 'Content-Type: application/json' \ --data-raw '{ "checkName": "string", "resourceIdentifier": { "deviceCertificateId": "string", "caCertificateId": "string", "cognitoIdentityPoolId": "string", "clientId": "string", "policyVersionIdentifier": { "policyName": "string", "policyVersionId": "string" }, "account": "string", "iamRoleArn": "string", "roleAliasArn": "string" }, "ascendingOrder": true, "nextToken": "string", "maxResults": 1 }'

Request

Query Params

maxResults

string

optional

Pagination limit

nextToken

string

optional

Pagination token

Body Params application/json

checkName

string

optional

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

resourceIdentifier

object

optional

Information that identifies the noncompliant resource.

deviceCertificateId

string

optional

The ID of the certificate attached to the resource.

>= 64 characters<= 64 characters

Match pattern:

(0x)?[a-fA-F0-9]+

caCertificateId

string

optional

The ID of the CA certificate used to authorize the certificate.

>= 64 characters<= 64 characters

Match pattern:

(0x)?[a-fA-F0-9]+

cognitoIdentityPoolId

string

optional

The ID of the Amazon Cognito identity pool.

clientId

string

optional

The client ID.

policyVersionIdentifier

object

optional

The version of the policy associated with the resource.

account

string

optional

The account with which the resource is associated.

>= 12 characters<= 12 characters

Match pattern:

[0-9]+

iamRoleArn

string

optional

The ARN of the IAM role that has overly permissive actions.

>= 20 characters<= 2048 characters

roleAliasArn

string

optional

The ARN of the role alias that has overly permissive actions.

>= 1 characters<= 2048 characters

ascendingOrder

boolean

optional

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

nextToken

string

optional

The token for the next set of results.

maxResults

integer

optional

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

>= 1<= 250

Examples

Responses

🟢200Success

application/json

Body

suppressions

array[object (AuditSuppression) {5}]

optional

List of audit suppressions.

checkName

string

AuditCheckName

required

resourceIdentifier

string

ResourceIdentifier

required

The identifier of the resource. For a Wireless Device, it is the wireless device ID. For a wireless gateway, it is the wireless gateway ID.

<= 256 characters

expirationDate

string <date-time>

optional

The expiration date (epoch timestamp in seconds) that you want the suppression to adhere to.

suppressIndefinitely

boolean

optional

Indicates whether a suppression should exist indefinitely or not.

description

string

optional

The description of the audit suppression.

<= 1000 characters

Match pattern:

[\p{Graph}\x20]*

nextToken

string

optional

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

<= 4096 characters

🟠480InvalidRequestException

🟠481ThrottlingException

🟠482InternalFailureException