Request Syntax URI Request Parameters Request Body Response Syntax Response Elements Errors See Also

GetSettings

Returns the settings for the specified AWS account.

Request Syntax


GET /settings/attribute HTTP/1.1

URI Request Parameters

The request uses the following URI parameters.

attribute

The list of SettingAttribute enum values.

Valid Values: ALL | IS_AWS_ORG_ENABLED | SNS_TOPIC | DEFAULT_ASSESSMENT_REPORTS_DESTINATION | DEFAULT_PROCESS_OWNERS

Required: Yes

Request Body

The request does not have a request body.

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 settings object that holds all supported AWS Audit Manager 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