Table Of Contents

Feedback

User Guide

First time using the AWS CLI? See the User Guide for help getting started.

Note: You are viewing the documentation for an older major version of the AWS CLI (version 1).

AWS CLI version 2, the latest major version of AWS CLI, is now stable and recommended for general use. To view this page for the AWS CLI version 2, click here. For more information see the AWS CLI version 2 installation instructions and migration guide.

[ aws . iot ]

create-audit-suppression

Description

Creates a Device Defender audit suppression.

See also: AWS API Documentation

See 'aws help' for descriptions of global parameters.

Synopsis

  create-audit-suppression
--check-name <value>
--resource-identifier <value>
[--expiration-date <value>]
[--suppress-indefinitely | --no-suppress-indefinitely]
[--description <value>]
[--client-request-token <value>]
[--cli-input-json <value>]
[--generate-cli-skeleton <value>]

Options

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

--resource-identifier (structure)

Information that identifies the noncompliant resource.

deviceCertificateId -> (string)

The ID of the certificate attached to the resource.

caCertificateId -> (string)

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

cognitoIdentityPoolId -> (string)

The ID of the Amazon Cognito identity pool.

clientId -> (string)

The client ID.

policyVersionIdentifier -> (structure)

The version of the policy associated with the resource.

policyName -> (string)

The name of the policy.

policyVersionId -> (string)

The ID of the version of the policy associated with the resource.

account -> (string)

The account with which the resource is associated.

iamRoleArn -> (string)

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

roleAliasArn -> (string)

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

Shorthand Syntax:

deviceCertificateId=string,caCertificateId=string,cognitoIdentityPoolId=string,clientId=string,policyVersionIdentifier={policyName=string,policyVersionId=string},account=string,iamRoleArn=string,roleAliasArn=string

JSON Syntax:

{
  "deviceCertificateId": "string",
  "caCertificateId": "string",
  "cognitoIdentityPoolId": "string",
  "clientId": "string",
  "policyVersionIdentifier": {
    "policyName": "string",
    "policyVersionId": "string"
  },
  "account": "string",
  "iamRoleArn": "string",
  "roleAliasArn": "string"
}

--expiration-date (timestamp)

The epoch timestamp in seconds at which this suppression expires.

--suppress-indefinitely | --no-suppress-indefinitely (boolean)

Indicates whether a suppression should exist indefinitely or not.

--description (string)

The description of the audit suppression.

--client-request-token (string)

The epoch timestamp in seconds at which this suppression expires.

--cli-input-json (string) Performs service operation based on the JSON string provided. The JSON string follows the format provided by --generate-cli-skeleton. If other arguments are provided on the command line, the CLI values will override the JSON-provided values. It is not possible to pass arbitrary binary values using a JSON-provided value as the string will be taken literally.

--generate-cli-skeleton (string) Prints a JSON skeleton to standard output without sending an API request. If provided with no value or the value input, prints a sample input JSON that can be used as an argument for --cli-input-json. If provided with the value output, it validates the command inputs and returns a sample output JSON for that command.

See 'aws help' for descriptions of global parameters.

Examples

To create an audit finding suppression

The following create-audit-suppression example creates an audit finding suppression for a policy named "virtualMachinePolicy" that has been flagged for being overly permissive.

aws iot create-audit-suppression \
    --check-name IOT_POLICY_OVERLY_PERMISSIVE_CHECK \
    --resource-identifier policyVersionIdentifier={"policyName"="virtualMachinePolicy","policyVersionId"="1"} \
    --no-suppress-indefinitely \
    --expiration-date 2020-10-20

This command produces no output.

For more information, see Audit finding suppressions in the AWS IoT Developers Guide.

Output

None