GetSavingsPlansCoverageRequest

import type { GetSavingsPlansCoverageRequest } from "https://aws-api.deno.dev/v0.3/services/costexplorer.ts?docs=full";

interface GetSavingsPlansCoverageRequest {

Filter?: Expression | null;

Granularity?: Granularity | null;

GroupBy?: GroupDefinition[] | null;

MaxResults?: number | null;

Metrics?: string[] | null;

NextToken?: string | null;

SortBy?: SortDefinition | null;

TimePeriod: DateInterval;

}

§Properties

Filter?: Expression | null

[src]

Filters Savings Plans coverage data by dimensions. You can filter data for Savings Plans usage with the following dimensions:

```
LINKED_ACCOUNT
```
```
REGION
```
```
SERVICE
```
```
INSTANCE_FAMILY
```

GetSavingsPlansCoverage uses the same Expression object as the other operations, but only AND is supported among each dimension.

Cost category is supported. Tags are not supported.

Granularity?: Granularity | null

[src]

The granularity of the Amazon Web Services cost data for your Savings Plans. Granularity can't be set if GroupBy is set.

The GetSavingsPlansCoverage operation supports only DAILY and MONTHLY granularities.

GroupBy?: GroupDefinition[] | null

[src]

You can group the data using the attributes INSTANCE_FAMILY, REGION, or SERVICE.

MaxResults?: number | null

[src]

The number of items to be returned in a response. The default is 20, with a minimum value of 1.

Metrics?: string[] | null

[src]

The measurement that you want your Savings Plans coverage reported in. The only valid value is SpendCoveredBySavingsPlans.

NextToken?: string | null

[src]

The token to retrieve the next set of results. Amazon Web Services provides the token when the response from a previous call has more results than the maximum page size.

SortBy?: SortDefinition | null

[src]

The value by which you want to sort the data.

The following values are supported for Key:

```
SpendCoveredBySavingsPlan
```
```
OnDemandCost
```
```
CoveragePercentage
```
```
TotalCost
```
```
InstanceFamily
```
```
Region
```
```
Service
```

Supported values for SortOrder are ASCENDING or DESCENDING.

TimePeriod: DateInterval

[src]

The time period that you want the usage and costs for. The Start date must be within 13 months. The End date must be after the Start date, and before the current date. Future dates can't be used as an End date.