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

GetEc2DeepInspectionConfiguration

Retrieves the activation status of Amazon Inspector deep inspection and custom paths associated with your account.

Request Syntax


POST /ec2deepinspectionconfiguration/get 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

{
   "errorMessage": "string",
   "orgPackagePaths": [ "string" ],
   "packagePaths": [ "string" ],
   "status": "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.

errorMessage

An error message explaining why Amazon Inspector deep inspection configurations could not be retrieved for your account.

Type: String

Length Constraints: Minimum length of 1.

orgPackagePaths

The Amazon Inspector deep inspection custom paths for your organization.

Type: Array of strings

Array Members: Minimum number of 0 items. Maximum number of 5 items.

Length Constraints: Minimum length of 1. Maximum length of 512.

Pattern: ^(?:/(?:\.[-\w]+|[-\w]+(?:\.[-\w]+)?))+/?$

packagePaths

The Amazon Inspector deep inspection custom paths for your account.

Type: Array of strings

Array Members: Minimum number of 0 items. Maximum number of 5 items.

Length Constraints: Minimum length of 1. Maximum length of 512.

Pattern: ^(?:/(?:\.[-\w]+|[-\w]+(?:\.[-\w]+)?))+/?$

status

The activation status of Amazon Inspector deep inspection in your account.

Type: String

Valid Values: ACTIVATED | DEACTIVATED | PENDING | FAILED

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

ResourceNotFoundException

The operation tried to access an invalid resource. Make sure the resource is specified correctly.

HTTP Status Code: 404

ThrottlingException

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

HTTP Status Code: 429