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

BatchGetAccountStatus

Retrieves the Amazon Inspector status of multiple AWS accounts within your environment.

Request Syntax


POST /status/batch/get HTTP/1.1
Content-type: application/json

{
   "accountIds": [ "string" ]
}

URI Request Parameters

The request does not use any URI parameters.

Request Body

The request accepts the following data in JSON format.

accountIds

The 12-digit AWS account IDs of the accounts to retrieve Amazon Inspector status 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

Response Syntax


HTTP/1.1 200
Content-type: application/json

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

An array of objects that provide details on the status of Amazon Inspector for each of the requested accounts.

Type: Array of AccountState objects

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

failedAccounts

An array of objects detailing any accounts that failed to enable Amazon Inspector and why.

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.

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

ValidationException

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

HTTP Status Code: 400