Request Syntax Request Parameters Response Syntax Response Elements Errors Examples See Also

GetApproximateUsageRecords

Retrieves estimated usage records for hourly granularity or resource-level data at daily granularity.

Request Syntax


{
   "ApproximationDimension": "string",
   "Granularity": "string",
   "Services": [ "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.

ApproximationDimension

The service to evaluate for the usage records. You can choose resource-level data at daily granularity, or hourly granularity with or without resource-level data.

Type: String

Valid Values: SERVICE | RESOURCE

Required: Yes

Granularity

How granular you want the data to be. You can enable data at hourly or daily granularity.

Type: String

Valid Values: DAILY | MONTHLY | HOURLY

Required: Yes

Services

The service metadata for the service or services you want to query. If not specified, all elements are returned.

Type: Array of strings

Length Constraints: Minimum length of 0. Maximum length of 1024.

Pattern: [\S\s]*

Required: No

Response Syntax


{
   "LookbackPeriod": { 
      "End": "string",
      "Start": "string"
   },
   "Services": { 
      "string" : number 
   },
   "TotalRecords": number
}

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.

LookbackPeriod

The lookback period that's used for the estimation.

Type: DateInterval object

Services

The service metadata for the service or services in the response.

Type: String to long map

Key Length Constraints: Minimum length of 0. Maximum length of 1024.

Key Pattern: [\S\s]*

Valid Range: Minimum value of 0.

TotalRecords

The total number of usage records for all services in the services list.

Type: Long

Valid Range: Minimum value of 0.

Errors

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

DataUnavailableException

The requested data is unavailable.

HTTP Status Code: 400

LimitExceededException

You made too many calls in a short period of time. Try again later.

HTTP Status Code: 400

Examples

The following is a sample request of the GetApproximateUsageRecords operation.

This example illustrates one usage of GetApproximateUsageRecords.

Sample Request


{
    "ApproximationDimension":"SERVICE",
    "Granularity": "HOURLY"
 }

The following is a sample response of the GetApproximateUsageRecords operation.

This example illustrates one usage of GetApproximateUsageRecords.

Sample Response


{
    "LookbackPeriod": {
        "End": "2023-12-31",
        "Start": "2023-12-01"
    },
    "Services": {
        "Amazon Virtual Private Cloud": 336,
        "Amazon Relational Database Service": 1344,
        "AmazonCloudWatch": 350,
        "Tax": 0,
        "Amazon DynamoDB": 672
    },
    "TotalRecords": 2702
}