Table Of Contents

Feedback

User Guide

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

[ aws . iot ]

describe-account-audit-configuration

Description

Gets information about 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

  describe-account-audit-configuration
[--cli-input-json <value>]
[--generate-cli-skeleton <value>]

Options

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

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

On the first call to UpdateAccountAuditConfiguration this parameter is required.

auditNotificationTargetConfigurations -> (map)

Information about the targets to which audit notifications are sent for this account.

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.

auditCheckConfigurations -> (map)

Which audit checks are enabled and disabled for this account.

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