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

ListFreeTrialStatusesV2

Lists the free trial status of Security Hub features. A delegated Security Hub administrator can list the status for accounts in its organization. Any other account can list the status only for itself. Free trial status remains available after a feature is disabled.

Request Syntax


POST /freetrial/statusv2/list HTTP/1.1
Content-type: application/json

{
   "AccountIds": [ "string" ],
   "MaxResults": number,
   "NextToken": "string",
   "Statuses": [ "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 AWS account identifiers to list free trial status for. You can specify accounts other than your own only if you are a delegated Security Hub administrator.

Type: Array of strings

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

Pattern: ^[0-9]{12}$

Required: No

MaxResults

The maximum number of results to return. If you don't specify a value, Security Hub returns up to 100 results.

Type: Integer

Valid Range: Minimum value of 1. Maximum value of 100.

Required: No

NextToken

The pagination token to request the next page of results.

Type: String

Required: No

Statuses

The free trial statuses to filter the results by. Valid values:

ACTIVE returns only features with an ongoing free trial period.
INACTIVE returns only features whose free trial period has ended, or that never started.

Type: Array of strings

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

Valid Values: ACTIVE | INACTIVE

Required: No

Response Syntax


HTTP/1.1 200
Content-type: application/json

{
   "AccountFreeTrialStatuses": [ 
      { 
         "AccountId": "string",
         "EvaluatedAt": "string",
         "FreeTrialStatuses": [ 
            { 
               "ExpiresAt": "string",
               "FeatureType": "string",
               "StartedAt": "string",
               "Status": "string"
            }
         ]
      }
   ],
   "NextToken": "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.

AccountFreeTrialStatuses

An array of free trial statuses, one for each account in scope.

Type: Array of objects

Array Members: Maximum number of 100 items.

NextToken

The pagination token to use to request the next page of results. If there are no additional results, this value is null.

Type: String

Errors

For information about the errors that are common to all actions, see Common Error Types.

AccessDeniedException

You don't have permission to perform the action specified in the request.

HTTP Status Code: 403

InternalServerException

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

HTTP Status Code: 500

ResourceNotFoundException

The request was rejected because we can't find the specified resource.

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 because it's missing required fields or has invalid inputs.

HTTP Status Code: 400