Request Syntax Request Parameters Response Syntax Response Elements Errors See Also

GetFreeTierUsage

Returns a list of all Free Tier usage objects that match your filters.

Request Syntax


{
   "filter": { 
      "And": [ 
         "Expression"
      ],
      "Dimensions": { 
         "Key": "string",
         "MatchOptions": [ "string" ],
         "Values": [ "string" ]
      },
      "Not": "Expression",
      "Or": [ 
         "Expression"
      ]
   },
   "maxResults": number,
   "nextToken": "string"
}

Request Parameters

For information about the parameters that are common to all actions, see Common Parameters.

The request accepts the following data in JSON format.

filter

An expression that specifies the conditions that you want each FreeTierUsage object to meet.

Type: Expression object

Required: No

maxResults

The maximum number of results to return in the response. MaxResults means that there can be up to the specified number of values, but there might be fewer results based on your filters.

Type: Integer

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

Required: No

nextToken

The pagination token that indicates the next set of results to retrieve.

Type: String

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

Pattern: ^[\S\s]*$

Required: No

Response Syntax


{
   "freeTierUsages": [ 
      { 
         "actualUsageAmount": number,
         "description": "string",
         "forecastedUsageAmount": number,
         "freeTierType": "string",
         "limit": number,
         "operation": "string",
         "region": "string",
         "service": "string",
         "unit": "string",
         "usageType": "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.

freeTierUsages

The list of Free Tier usage objects that meet your filter expression.

Type: Array of FreeTierUsage objects

nextToken

The pagination token that indicates the next set of results to retrieve.

Type: String

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

Pattern: ^[\S\s]*$

Errors

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

InternalServerException

An unexpected error occurred during the processing of your request.

HTTP Status Code: 500

ThrottlingException

The request was denied due to request throttling.

HTTP Status Code: 400

ValidationException

The input fails to satisfy the constraints specified by an AWS service.

HTTP Status Code: 400