GetCostCategoriesRequest

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

interface GetCostCategoriesRequest {

CostCategoryName?: string | null;

Filter?: Expression | null;

MaxResults?: number | null;

NextPageToken?: string | null;

SearchString?: string | null;

SortBy?: SortDefinition[] | null;

TimePeriod: DateInterval;

}

§Properties

CostCategoryName?: string | null

[src]

Filter?: Expression | null

[src]

MaxResults?: number | null

[src]

This field is only used when SortBy is provided in the request.

The maximum number of objects that to be returned for this request. If MaxResults is not specified with SortBy, the request will return 1000 results as the default value for this parameter.

For GetCostCategories, MaxResults has an upper limit of 1000.

NextPageToken?: string | null

[src]

If the number of objects that are still available for retrieval exceeds the limit, Amazon Web Services returns a NextPageToken value in the response. To retrieve the next batch of objects, provide the NextPageToken from the prior call in your next request.

SearchString?: string | null

[src]

The value that you want to search the filter values for.

If you do not specify a CostCategoryName, SearchString will be used to filter Cost Category names that match the SearchString pattern. If you do specifiy a CostCategoryName, SearchString will be used to filter Cost Category values that match the SearchString pattern.

SortBy?: SortDefinition[] | null

[src]

The value by which you want to sort the data.

The key represents cost and usage metrics. The following values are supported:

```
BlendedCost
```
```
UnblendedCost
```
```
AmortizedCost
```
```
NetAmortizedCost
```
```
NetUnblendedCost
```
```
UsageQuantity
```
```
NormalizedUsageAmount
```

Supported values for SortOrder are ASCENDING or DESCENDING.

When using SortBy, NextPageToken and SearchString are not supported.

TimePeriod: DateInterval

[src]