audit_suppressions

Creates, updates, deletes, gets or lists an audit_suppressions resource.

Overview

Name	audit_suppressions
Type	Resource
Id	aws.iot.audit_suppressions

Fields

The following fields are returned by SELECT queries:

describe_audit_suppression

Name	Datatype	Description
check_name	string	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.)
description	string	The description of the audit suppression. (pattern: <code>[\p{Graph}\x20]*</code>)
expiration_date	string (date-time)	The epoch timestamp in seconds at which this suppression expires.
resource_identifier	object	Information that identifies the noncompliant resource.
suppress_indefinitely	boolean	Indicates whether a suppression should exist indefinitely or not.

list_audit_suppressions

Name	Datatype	Description
check_name	string	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.)
description	string	The description of the audit suppression. (pattern: <code>[\p{Graph}\x20]*</code>)
expiration_date	string (date-time)	The expiration date (epoch timestamp in seconds) that you want the suppression to adhere to.
resource_identifier	object	Information that identifies the noncompliant resource.
suppress_indefinitely	boolean	Indicates whether a suppression should exist indefinitely or not.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
describe_audit_suppression	select	region		Gets information about a Device Defender audit suppression.
list_audit_suppressions	select	region		Lists your Device Defender audit listings. Requires permission to access the ListAuditSuppressions action.
create_audit_suppression	insert	region, checkName, resourceIdentifier, clientRequestToken		Creates a Device Defender audit suppression. Requires permission to access the CreateAuditSuppression action.
update_audit_suppression	update	region, checkName, resourceIdentifier		Updates a Device Defender audit suppression.
delete_audit_suppression	delete	region		Deletes a Device Defender audit suppression. Requires permission to access the DeleteAuditSuppression action.

Parameters

Parameters can be passed in the WHERE clause of a query. Check the Methods section to see which parameters are required or optional for each operation.

Name	Datatype	Description
region	string	AWS region (default: us-east-1)

SELECT examples

describe_audit_suppression

Gets information about a Device Defender audit suppression.

SELECT
check_name,
description,
expiration_date,
resource_identifier,
suppress_indefinitely
FROM aws.iot.audit_suppressions
WHERE region = '{{ region }}' -- required
;

list_audit_suppressions

Lists your Device Defender audit listings. Requires permission to access the ListAuditSuppressions action.

SELECT
check_name,
description,
expiration_date,
resource_identifier,
suppress_indefinitely
FROM aws.iot.audit_suppressions
WHERE region = '{{ region }}' -- required
;

INSERT examples

create_audit_suppression

Creates a Device Defender audit suppression. Requires permission to access the CreateAuditSuppression action.

INSERT INTO aws.iot.audit_suppressions (
checkName,
resourceIdentifier,
expirationDate,
suppressIndefinitely,
description,
clientRequestToken,
region
)
SELECT 
'{{ checkName }}' /* required */,
'{{ resourceIdentifier }}' /* required */,
'{{ expirationDate }}',
{{ suppressIndefinitely }},
'{{ description }}',
'{{ clientRequestToken }}' /* required */,
'{{ region }}'
;

Manifest

# Description fields are for documentation purposes
- name: audit_suppressions
props:
  - name: region
    value: "{{ region }}"
    description: Required parameter for the audit_suppressions resource.
  - name: checkName
    value: "{{ checkName }}"
    description: |
      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.)
  - name: resourceIdentifier
    description: |
      Information that identifies the noncompliant resource.
    value:
      deviceCertificateId: "{{ deviceCertificateId }}"
      caCertificateId: "{{ caCertificateId }}"
      cognitoIdentityPoolId: "{{ cognitoIdentityPoolId }}"
      clientId: "{{ clientId }}"
      policyVersionIdentifier:
        policyName: "{{ policyName }}"
        policyVersionId: "{{ policyVersionId }}"
      account: "{{ account }}"
      iamRoleArn: "{{ iamRoleArn }}"
      roleAliasArn: "{{ roleAliasArn }}"
      issuerCertificateIdentifier:
        issuerCertificateSubject: "{{ issuerCertificateSubject }}"
        issuerId: "{{ issuerId }}"
        issuerCertificateSerialNumber: "{{ issuerCertificateSerialNumber }}"
      deviceCertificateArn: "{{ deviceCertificateArn }}"
  - name: expirationDate
    value: "{{ expirationDate }}"
  - name: suppressIndefinitely
    value: {{ suppressIndefinitely }}
  - name: description
    value: "{{ description }}"
  - name: clientRequestToken
    value: "{{ clientRequestToken }}"

UPDATE examples

update_audit_suppression

Updates a Device Defender audit suppression.

UPDATE aws.iot.audit_suppressions
SET 
checkName = '{{ checkName }}',
resourceIdentifier = '{{ resourceIdentifier }}',
expirationDate = '{{ expirationDate }}',
suppressIndefinitely = {{ suppressIndefinitely }},
description = '{{ description }}'
WHERE 
region = '{{ region }}' --required
AND checkName = '{{ checkName }}' --required
AND resourceIdentifier = '{{ resourceIdentifier }}' --required;

DELETE examples

delete_audit_suppression

Deletes a Device Defender audit suppression. Requires permission to access the DeleteAuditSuppression action.

DELETE FROM aws.iot.audit_suppressions
WHERE region = '{{ region }}' --required
;