Table Of Contents

Feedback

User Guide

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

[ aws . iot ]

update-account-audit-configuration

Description

Configures or reconfigures the Device Defender audit settings for this account. Settings include how audit notifications are sent and which audit checks are enabled or disabled.

See also: AWS API Documentation

See 'aws help' for descriptions of global parameters.

Synopsis

  update-account-audit-configuration
[--role-arn <value>]
[--audit-notification-target-configurations <value>]
[--audit-check-configurations <value>]
[--cli-input-json <value>]
[--generate-cli-skeleton <value>]

Options

--role-arn (string)

The ARN of the role that grants permission to AWS IoT to access information about your devices, policies, certificates and other items as necessary when performing an audit.

--audit-notification-target-configurations (map)

Information about the targets to which audit notifications are sent.

Shorthand Syntax:

  KeyName1=targetArn=string,roleArn=string,enabled=boolean,KeyName2=targetArn=string,roleArn=string,enabled=boolean

Where valid key names are:
  SNS

JSON Syntax:

{"SNS": {
      "targetArn": "string",
      "roleArn": "string",
      "enabled": true|false
    }
  ...}

--audit-check-configurations (map)

Specifies which audit checks are enabled and disabled for this account. Use DescribeAccountAuditConfiguration to see the list of all checks including those that are currently enabled.

Note that some data collection may begin immediately when certain checks are enabled. When a check is disabled, any data collected so far in relation to the check is deleted.

You cannot disable a check if it is used by any scheduled audit. You must first delete the check from the scheduled audit or delete the scheduled audit itself.

On the first call to UpdateAccountAuditConfiguration this parameter is required and must specify at least one enabled check.

Shorthand Syntax:

KeyName1=enabled=boolean,KeyName2=enabled=boolean

JSON Syntax:

{"string": {
      "enabled": true|false
    }
  ...}

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

Output