DescribeOrganizationConfiguration - Amazon Detective

DescribeOrganizationConfiguration

Returns information about the configuration for the organization behavior graph. Currently indicates whether to automatically enable new organization accounts as member accounts.

Can only be called by the Detective administrator account for the organization.

Request Syntax

POST /orgs/describeOrganizationConfiguration HTTP/1.1 Content-type: application/json { "GraphArn": "string" }

URI Request Parameters

The request does not use any URI parameters.

Request Body

The request accepts the following data in JSON format.

GraphArn

The ARN of the organization behavior graph.

Type: String

Pattern: ^arn:aws[-\w]{0,10}?:detective:[-\w]{2,20}?:\d{12}?:graph:[abcdef\d]{32}?$

Required: Yes

Response Syntax

HTTP/1.1 200 Content-type: application/json { "AutoEnable": boolean }

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.

AutoEnable

Indicates whether to automatically enable new organization accounts as member accounts in the organization behavior graph.

Type: Boolean

Errors

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

InternalServerException

The request was valid but failed because of a problem with the service.

HTTP Status Code: 500

TooManyRequestsException

The request cannot be completed because too many other requests are occurring at the same time.

HTTP Status Code: 429

ValidationException

The request parameters are invalid.

HTTP Status Code: 400

Examples

Example

This example illustrates one usage of DescribeOrganizationConfiguration.

Sample Request

POST /orgs/describeOrganizationConfiguration HTTP/1.1 Host: api.detective.us-west-2.amazonaws.com Accept-Encoding: identity Content-Length: 94 Authorization: AUTHPARAMS X-Amz-Date: 20210923T193018Z User-Agent: aws-cli/1.14.29 Python/2.7.9 Windows/8 botocore/1.8.33 { "GraphArn": "arn:aws:detective:us-east-1:111122223333:graph:027c7c4610ea4aacaf0b883093cab899" }

Example

This example illustrates one usage of DescribeOrganizationConfiguration.

Sample Response

HTTP/1.1 200 OK Content-Length: 19 Date: Thu, 23 Sep 2021 23:07:46 GMT x-amzn-RequestId: 397d0549-0092-11e8-a0ee-a7f9aa6e7572 Connection: Keep-alive { "AutoEnable": true }

See Also

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