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

DescribeOrganizationConfiguration

Describe Amazon Inspector configuration settings for an AWS organization.

Request Syntax


POST /organizationconfiguration/describe HTTP/1.1

URI Request Parameters

The request does not use any URI parameters.

Request Body

The request does not have a request body.

Response Syntax


HTTP/1.1 200
Content-type: application/json

{
   "autoEnable": { 
      "ec2": boolean,
      "ecr": boolean,
      "lambda": boolean,
      "lambdaCode": boolean
   },
   "maxAccountLimitReached": 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

The scan types are automatically enabled for new members of your organization.

Type: AutoEnable object

maxAccountLimitReached

Represents whether your organization has reached the maximum AWS account limit for Amazon Inspector.

Type: Boolean

Errors

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

AccessDeniedException

You do not have sufficient access to perform this action.

HTTP Status Code: 403

InternalServerException

The request has failed due to an internal failure of the Amazon Inspector service.

HTTP Status Code: 500

ThrottlingException

The limit on the number of requests per second was exceeded.

HTTP Status Code: 429

ValidationException

The request has failed validation due to missing required fields or having invalid inputs.

HTTP Status Code: 400