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

update-settings

Description

Updates Audit Manager settings for the current user account.

See also: AWS API Documentation

Synopsis

  update-settings
[--sns-topic <value>]
[--default-assessment-reports-destination <value>]
[--default-process-owners <value>]
[--kms-key <value>]
[--evidence-finder-enabled | --no-evidence-finder-enabled]
[--cli-input-json <value>]
[--generate-cli-skeleton <value>]
[--debug]
[--endpoint-url <value>]
[--no-verify-ssl]
[--no-paginate]
[--output <value>]
[--query <value>]
[--profile <value>]
[--region <value>]
[--version <value>]
[--color <value>]
[--no-sign-request]
[--ca-bundle <value>]
[--cli-read-timeout <value>]
[--cli-connect-timeout <value>]

Options

--sns-topic (string)

The Amazon Simple Notification Service (Amazon SNS) topic that Audit Manager sends notifications to.

--default-assessment-reports-destination (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.

Shorthand Syntax:

destinationType=string,destination=string

JSON Syntax:

{
  "destinationType": "S3",
  "destination": "string"
}

--default-process-owners (list)

A list of the default audit owners.

(structure)

The wrapper that contains the Audit Manager role information of the current user. This includes 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.

Shorthand Syntax:

roleType=string,roleArn=string ...

JSON Syntax:

[
  {
    "roleType": "PROCESS_OWNER"|"RESOURCE_OWNER",
    "roleArn": "string"
  }
  ...
]

--kms-key (string)

The KMS key details.

--evidence-finder-enabled | --no-evidence-finder-enabled (boolean)

Specifies whether the evidence finder feature is enabled. Change this attribute to enable or disable evidence finder.

Warning

When you use this attribute to disable evidence finder, Audit Manager deletes the event data store that’s used to query your evidence data. As a result, you can’t re-enable evidence finder and use the feature again. Your only alternative is to deregister and then re-register Audit Manager.

Disabling evidence finder is permanent, so consider this decision carefully before you proceed. If you’re using Audit Manager as a delegated administrator, keep in mind that this action applies to all member accounts in your organization.

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

Global Options

--debug (boolean)

Turn on debug logging.

--endpoint-url (string)

Override command's default URL with the given URL.

--no-verify-ssl (boolean)

By default, the AWS CLI uses SSL when communicating with AWS services. For each SSL connection, the AWS CLI will verify SSL certificates. This option overrides the default behavior of verifying SSL certificates.

--no-paginate (boolean)

Disable automatic pagination.

--output (string)

The formatting style for command output.

  • json
  • text
  • table

--query (string)

A JMESPath query to use in filtering the response data.

--profile (string)

Use a specific profile from your credential file.

--region (string)

The region to use. Overrides config/env settings.

--version (string)

Display the version of this tool.

--color (string)

Turn on/off color output.

  • on
  • off
  • auto

--no-sign-request (boolean)

Do not sign requests. Credentials will not be loaded if this argument is provided.

--ca-bundle (string)

The CA certificate bundle to use when verifying SSL certificates. Overrides config/env settings.

--cli-read-timeout (int)

The maximum socket read time in seconds. If the value is set to 0, the socket read will be blocking and not timeout. The default value is 60 seconds.

--cli-connect-timeout (int)

The maximum socket connect time in seconds. If the value is set to 0, the socket connect will be blocking and not timeout. The default value is 60 seconds.

Output

settings -> (structure)

The current list of settings.

isAwsOrgEnabled -> (boolean)

Specifies whether 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 the Audit Manager role information of the current user. This includes 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 KMS key details.

evidenceFinderEnablement -> (structure)

The current evidence finder status and event data store details.

eventDataStoreArn -> (string)

The Amazon Resource Name (ARN) of the CloudTrail Lake event data store that’s used by evidence finder. The event data store is the lake of evidence data that evidence finder runs queries against.

enablementStatus -> (string)

The current status of the evidence finder feature and the related event data store.

  • ENABLE_IN_PROGRESS means that you requested to enable evidence finder. An event data store is currently being created to support evidence finder queries.
  • ENABLED means that an event data store was successfully created and evidence finder is enabled. We recommend that you wait 24 hours until the event data store is backfilled with your past evidence data. You can use evidence finder in the meantime, but not all data might be available until the backfill is complete.
  • DISABLE_IN_PROGRESS means that you requested to disable evidence finder, and your request is pending the deletion of the event data store.
  • DISABLED means that you have permanently disabled evidence finder and the event data store has been deleted. You can't re-enable evidence finder after this point.

backfillStatus -> (string)

The current status of the evidence data backfill process.

The backfill starts after you enable evidence finder. During this task, Audit Manager populates an event data store with your past evidence data so that your evidence can be queried.

  • NOT_STARTED means that the backfill hasn’t started yet.
  • IN_PROGRESS means that the backfill is in progress. This can take up to 24 hours to complete, depending on the amount of evidence data.
  • COMPLETED means that the backfill is complete. All of your past evidence is now queryable.

error -> (string)

Represents any errors that occurred when enabling or disabling evidence finder.