[ aws . auditmanager ]

get-settings

Description

Returns the settings for the specified AWS account.

See also: AWS API Documentation

See ‘aws help’ for descriptions of global parameters.

Synopsis

  get-settings
--attribute <value>
[--cli-input-json | --cli-input-yaml]
[--generate-cli-skeleton <value>]

Options

--attribute (string)

The list of SettingAttribute enum values.

Possible values:

• ALL

• IS_AWS_ORG_ENABLED

• SNS_TOPIC

• DEFAULT_ASSESSMENT_REPORTS_DESTINATION

• DEFAULT_PROCESS_OWNERS

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

See ‘aws help’ for descriptions of global parameters.

Output

settings -> (structure)

The settings object that holds all supported AWS Audit Manager settings.

isAwsOrgEnabled -> (boolean)

Specifies whether AWS Organizations is enabled.

snsTopic -> (string)

The designated Amazon Simple Notification Service (Amazon SNS) topic.

defaultAssessmentReportsDestination -> (structure)

The default storage destination for assessment reports.

destinationType -> (string)

The destination type, such as Amazon S3.

destination -> (string)

The destination of the assessment report.

defaultProcessOwners -> (list)

The designated default audit owners.

(structure)

The wrapper that contains AWS Audit Manager role information, such as the role type and IAM Amazon Resource Name (ARN).

roleType -> (string)

The type of customer persona.

Note

In CreateAssessment , roleType can only be PROCESS_OWNER .

In UpdateSettings , roleType can only be PROCESS_OWNER .

In BatchCreateDelegationByAssessment , roleType can only be RESOURCE_OWNER .

roleArn -> (string)

The Amazon Resource Name (ARN) of the IAM role.

kmsKey -> (string)

The AWS KMS key details.