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

Enable

Enables Amazon Inspector scans for one or more AWS accounts.

Request Syntax


POST /enable HTTP/1.1
Content-type: application/json

{
   "accountIds": [ "string" ],
   "clientToken": "string",
   "resourceTypes": [ "string" ]
}

URI Request Parameters

The request does not use any URI parameters.

Request Body

The request accepts the following data in JSON format.

accountIds

A list of account IDs you want to enable Amazon Inspector scans for.

Type: Array of strings

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

Length Constraints: Fixed length of 12.

Pattern: \d{12}

Required: No

clientToken

The idempotency token for the request.

Type: String

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

Required: No

resourceTypes

The resource scan types you want to enable.

Type: Array of strings

Array Members: Minimum number of 1 item. Maximum number of 5 items.

Valid Values: EC2 | ECR | LAMBDA | LAMBDA_CODE | CODE_REPOSITORY

Required: Yes

Response Syntax


HTTP/1.1 200
Content-type: application/json

{
   "accounts": [ 
      { 
         "accountId": "string",
         "resourceStatus": { 
            "codeRepository": "string",
            "ec2": "string",
            "ecr": "string",
            "lambda": "string",
            "lambdaCode": "string"
         },
         "status": "string"
      }
   ],
   "failedAccounts": [ 
      { 
         "accountId": "string",
         "errorCode": "string",
         "errorMessage": "string",
         "resourceStatus": { 
            "codeRepository": "string",
            "ec2": "string",
            "ecr": "string",
            "lambda": "string",
            "lambdaCode": "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.

accounts

Information on the accounts that have had Amazon Inspector scans successfully enabled. Details are provided for each account.

Type: Array of Account objects

failedAccounts

Information on any accounts for which Amazon Inspector scans could not be enabled. Details are provided for each account.

Type: Array of FailedAccount objects

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

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 AWS 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

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.

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