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

UpdateEc2DeepInspectionConfiguration

Activates, deactivates Amazon Inspector deep inspection, or updates custom paths for your account.

Request Syntax


POST /ec2deepinspectionconfiguration/update HTTP/1.1
Content-type: application/json

{
   "activateDeepInspection": boolean,
   "packagePaths": [ "string" ]
}

URI Request Parameters

The request does not use any URI parameters.

Request Body

The request accepts the following data in JSON format.

activateDeepInspection

Specify TRUE to activate Amazon Inspector deep inspection in your account, or FALSE to deactivate. Member accounts in an organization cannot deactivate deep inspection, instead the delegated administrator for the organization can deactivate a member account using BatchUpdateMemberEc2DeepInspectionStatus.

Type: Boolean

Required: No

packagePaths

The Amazon Inspector deep inspection custom paths you are adding 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]+)?))+/?

Required: No

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 new Amazon Inspector deep inspection custom paths could not be added.

Type: String

Length Constraints: Minimum length of 1.

orgPackagePaths

The current Amazon Inspector deep inspection custom paths for the 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 current 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 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.

For Enable, you receive this error if you attempt to use a feature in an unsupported Amazon Web Services Region.

HTTP Status Code: 403

InternalServerException

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

retryAfterSeconds: The number of seconds to wait before retrying the request.

HTTP Status Code: 500

ThrottlingException

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

retryAfterSeconds: The number of seconds to wait before retrying the request.

HTTP Status Code: 429

ValidationException

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

fields: The fields that failed validation.
reason: The reason for the validation failure.

HTTP Status Code: 400