UpdateSettings - AWS Audit Manager

UpdateSettings

Updates AWS Audit Manager settings for the current user account.

Request Syntax

PUT /settings HTTP/1.1 Content-type: application/json { "defaultAssessmentReportsDestination": { "destination": "string", "destinationType": "string" }, "defaultProcessOwners": [ { "roleArn": "string", "roleType": "string" } ], "kmsKey": "string", "snsTopic": "string" }

URI Request Parameters

The request does not use any URI parameters.

Request Body

The request accepts the following data in JSON format.

defaultAssessmentReportsDestination

The default storage destination for assessment reports.

Type: AssessmentReportsDestination object

Required: No

defaultProcessOwners

A list of the default audit owners.

Type: Array of Role objects

Required: No

kmsKey

The AWS KMS key details.

Type: String

Length Constraints: Minimum length of 7. Maximum length of 2048.

Pattern: ^arn:.*:kms:.*|DEFAULT

Required: No

snsTopic

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

Type: String

Length Constraints: Minimum length of 20. Maximum length of 2048.

Pattern: ^arn:.*:sns:.*

Required: No

Response Syntax

HTTP/1.1 200 Content-type: application/json { "settings": { "defaultAssessmentReportsDestination": { "destination": "string", "destinationType": "string" }, "defaultProcessOwners": [ { "roleArn": "string", "roleType": "string" } ], "isAwsOrgEnabled": boolean, "kmsKey": "string", "snsTopic": "string" } }

Response Elements

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

settings

The current list of settings.

Type: Settings object

Errors

For information about the errors that are common to all actions, see Common Errors.

AccessDeniedException

Your account is not registered with AWS Audit Manager. Check the delegated administrator setup on the AWS Audit Manager settings page, and try again.

HTTP Status Code: 403

InternalServerException

An internal service error occurred during the processing of your request. Try again later.

HTTP Status Code: 500

ValidationException

The request has invalid or missing parameters.

HTTP Status Code: 400

See Also

For more information about using this API in one of the language-specific AWS SDKs, see the following: