BatchGetFreeTrialInfo
Gets free trial status for multiple AWS accounts.
Request Syntax
POST /freetrialinfo/batchget 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 account IDs to get free trial status for.
Type: Array of strings
Array Members: Minimum number of 1 item. Maximum number of 100 items.
Pattern:
[0-9]{12}Required: Yes
Response Syntax
HTTP/1.1 200
Content-type: application/json
{
"accounts": [
{
"accountId": "string",
"freeTrialInfo": [
{
"end": number,
"start": number,
"status": "string",
"type": "string"
}
]
}
],
"failedAccounts": [
{
"accountId": "string",
"code": "string",
"message": "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 Amazon Inspector free trial details for each of the requested accounts.
Type: Array of FreeTrialAccountInfo objects
- failedAccounts
-
An array of objects detailing any accounts that free trial data could not be returned for.
Type: Array of FreeTrialInfoError objects
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
See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
