[ 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 | --cli-input-yaml]
[--generate-cli-skeleton <value>]
[--cli-auto-prompt <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 required when performing an audit.

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

Information about the targets to which audit notifications are sent.

key -> (string)

value -> (structure)

Information about the targets to which audit notifications are sent.

targetArn -> (string)

The ARN of the target (SNS topic) to which audit notifications are sent.

roleArn -> (string)

The ARN of the role that grants permission to send notifications to the target.

enabled -> (boolean)

True if notifications to the target are enabled.

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.

Some data collection might start 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.

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

value -> (structure)

Which audit checks are enabled and disabled for this account.

enabled -> (boolean)

True if this audit check is enabled for this account.

Shorthand Syntax:

KeyName1=enabled=boolean,KeyName2=enabled=boolean

JSON Syntax:

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

--cli-input-json | --cli-input-yaml (string) Reads arguments from the JSON string provided. The JSON string follows the format provided by --generate-cli-skeleton. If other arguments are provided on the command line, those 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. This may not be specified along with --cli-input-yaml.

--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. Similarly, if provided yaml-input it will print a sample input YAML that can be used with --cli-input-yaml. If provided with the value output, it validates the command inputs and returns a sample output JSON for that command.

--cli-auto-prompt (boolean) Automatically prompt for CLI input parameters.

See ‘aws help’ for descriptions of global parameters.

Examples

Example 1: To enable Amazon SNS notifications for audit notifications

The following update-account-audit-configuration example enables Amazon SNS notifications for AWS IoT Device Defender audit notifications, specifying a target and the role used to write to that target.

aws iot update-account-audit-configuration \
    --audit-notification-target-configurations "SNS={targetArn=\"arn:aws:sns:us-west-2:123456789012:ddaudits\",roleArn=\"arn:aws:iam::123456789012:role/service-role/AWSIoTDeviceDefenderAudit\",enabled=true}"

This command produces no output.

Example 2: To enable an audit check

The following update-account-audit-configuration example enables the AWS IoT Device Defender audit check named AUTHENTICATED_COGNITO_ROLE_OVERLY_PERMISSIVE_CHECK. You cannot disable an audit check if it is part of the targetCheckNames for one or more scheduled audits for the AWS account.

aws iot update-account-audit-configuration \
    --audit-check-configurations "{\"AUTHENTICATED_COGNITO_ROLE_OVERLY_PERMISSIVE_CHECK\":{\"enabled\":true}}"

This command produces no output.

For more information, see Audit Commands in the AWS IoT Developer Guide.

Output

None