AWS SDK for PHP 3.x

Client: Aws\CostExplorer\CostExplorerClient

Service ID: ce

Version: 2017-10-25

This page describes the parameters and results for the operations of the AWS Cost Explorer Service (2017-10-25), and shows how to use the Aws\CostExplorer\CostExplorerClient object to call the described operations. This documentation is specific to the 2017-10-25 API version of the service.

Operation Summary

Each of the following operations can be created from a client using $client->getCommand('CommandName'), where "CommandName" is the name of one of the following operations. Note: a command is a value that encapsulates an operation and the parameters used to create an HTTP request.

You can also create and send a command immediately using the magic methods available on a client object: $client->commandName(/* parameters */). You can send the command asynchronously (returning a promise) by appending the word "Async" to the operation name: $client->commandNameAsync(/* parameters */).

GetCostAndUsage ( array $params = [] )
Retrieves cost and usage metrics for your account.
GetDimensionValues ( array $params = [] )
Retrieves all available filter values for a specified filter over a period of time.
GetReservationCoverage ( array $params = [] )
Retrieves the reservation coverage for your account.
GetReservationPurchaseRecommendation ( array $params = [] )
Gets recommendations for which reservations to purchase.
GetReservationUtilization ( array $params = [] )
Retrieves the reservation utilization for your account.
GetTags ( array $params = [] )
Queries for available tag keys and tag values for a specified period.

Operations

GetCostAndUsage

$result = $client->getCostAndUsage([/* ... */]);
$promise = $client->getCostAndUsageAsync([/* ... */]);

Retrieves cost and usage metrics for your account. You can specify which cost and usage-related metric, such as BlendedCosts or UsageQuantity, that you want the request to return. You can also filter and group your data by various dimensions, such as SERVICE or AZ, in a specific time range. For a complete list of valid dimensions, see the GetDimensionValues operation. Master accounts in an organization in AWS Organizations have access to all member accounts.

Parameter Syntax

$result = $client->getCostAndUsage([
    'Filter' => [
        'And' => [
            [...], // RECURSIVE
            // ...
        ],
        'Dimensions' => [
            'Key' => 'AZ|INSTANCE_TYPE|LINKED_ACCOUNT|OPERATION|PURCHASE_TYPE|REGION|SERVICE|USAGE_TYPE|USAGE_TYPE_GROUP|RECORD_TYPE|OPERATING_SYSTEM|TENANCY|SCOPE|PLATFORM|SUBSCRIPTION_ID|LEGAL_ENTITY_NAME|DEPLOYMENT_OPTION|DATABASE_ENGINE|CACHE_ENGINE|INSTANCE_TYPE_FAMILY',
            'Values' => ['<string>', ...],
        ],
        'Not' => [...], // RECURSIVE
        'Or' => [
            [...], // RECURSIVE
            // ...
        ],
        'Tags' => [
            'Key' => '<string>',
            'Values' => ['<string>', ...],
        ],
    ],
    'Granularity' => 'DAILY|MONTHLY',
    'GroupBy' => [
        [
            'Key' => '<string>',
            'Type' => 'DIMENSION|TAG',
        ],
        // ...
    ],
    'Metrics' => ['<string>', ...],
    'NextPageToken' => '<string>',
    'TimePeriod' => [
        'End' => '<string>', // REQUIRED
        'Start' => '<string>', // REQUIRED
    ],
]);

Parameter Details

Members

Filter

Type: Expression structure

Filters AWS costs by different dimensions. For example, you can specify SERVICE and LINKED_ACCOUNT and get the costs that are associated with that account's usage of that service. You can nest Expression objects to define any combination of dimension filters. For more information, see Expression.

Granularity

Type: string

Sets the AWS cost granularity to MONTHLY or DAILY. If Granularity isn't set, the response object doesn't include the Granularity, either MONTHLY or DAILY.

GroupBy

Type: Array of GroupDefinition structures

You can group AWS costs using up to two different groups, either dimensions, tag keys, or both.

When you group by tag key, you get all tag values, including empty strings.

Valid values are AZ, INSTANCE_TYPE, LEGAL_ENTITY_NAME, LINKED_ACCOUNT, OPERATION, PLATFORM, PURCHASE_TYPE, SERVICE, TAGS, TENANCY, and USAGE_TYPE.

Metrics

Type: Array of strings

Which metrics are returned in the query. For more information about blended and unblended rates, see Why does the "blended" annotation appear on some line items in my bill?.

Valid values are AmortizedCost, BlendedCost, UnblendedCost, and UsageQuantity.

If you return the UsageQuantity metric, the service aggregates all usage numbers without taking into account the units. For example, if you aggregate usageQuantity across all of EC2, the results aren't meaningful because EC2 compute hours and data transfer are measured in different units (for example, hours vs. GB). To get more meaningful UsageQuantity metrics, filter by UsageType or UsageTypeGroups.

Metrics is required for GetCostAndUsage requests.

NextPageToken

Type: string

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

TimePeriod

Required: Yes
Type: DateInterval structure

Sets the start and end dates for retrieving AWS costs. The start date is inclusive, but the end date is exclusive. For example, if start is 2017-01-01 and end is 2017-05-01, then the cost and usage data is retrieved from 2017-01-01 up to and including 2017-04-30 but not including 2017-05-01.

Result Syntax

[
    'GroupDefinitions' => [
        [
            'Key' => '<string>',
            'Type' => 'DIMENSION|TAG',
        ],
        // ...
    ],
    'NextPageToken' => '<string>',
    'ResultsByTime' => [
        [
            'Estimated' => true || false,
            'Groups' => [
                [
                    'Keys' => ['<string>', ...],
                    'Metrics' => [
                        '<MetricName>' => [
                            'Amount' => '<string>',
                            'Unit' => '<string>',
                        ],
                        // ...
                    ],
                ],
                // ...
            ],
            'TimePeriod' => [
                'End' => '<string>',
                'Start' => '<string>',
            ],
            'Total' => [
                '<MetricName>' => [
                    'Amount' => '<string>',
                    'Unit' => '<string>',
                ],
                // ...
            ],
        ],
        // ...
    ],
]

Result Details

Members

GroupDefinitions

Type: Array of GroupDefinition structures

The groups that are specified by the Filter or GroupBy parameters in the request.

NextPageToken

Type: string

The token for the next set of retrievable results. AWS provides the token when the response from a previous call has more results than the maximum page size.

ResultsByTime

Type: Array of ResultByTime structures

The time period that is covered by the results in the response.

Errors

LimitExceededException:
You made too many calls in a short period of time. Try again later.
BillExpirationException:
The requested report expired. Update the date interval and try again.
DataUnavailableException:
The requested data is unavailable.
InvalidNextTokenException:
The pagination token is invalid. Try again without a pagination token.
RequestChangedException:
Your request parameters changed between pages. Try again with the old parameters or without a pagination token.

GetDimensionValues

$result = $client->getDimensionValues([/* ... */]);
$promise = $client->getDimensionValuesAsync([/* ... */]);

Retrieves all available filter values for a specified filter over a period of time. You can search the dimension values for an arbitrary string.

Parameter Syntax

$result = $client->getDimensionValues([
    'Context' => 'COST_AND_USAGE|RESERVATIONS',
    'Dimension' => 'AZ|INSTANCE_TYPE|LINKED_ACCOUNT|OPERATION|PURCHASE_TYPE|REGION|SERVICE|USAGE_TYPE|USAGE_TYPE_GROUP|RECORD_TYPE|OPERATING_SYSTEM|TENANCY|SCOPE|PLATFORM|SUBSCRIPTION_ID|LEGAL_ENTITY_NAME|DEPLOYMENT_OPTION|DATABASE_ENGINE|CACHE_ENGINE|INSTANCE_TYPE_FAMILY', // REQUIRED
    'NextPageToken' => '<string>',
    'SearchString' => '<string>',
    'TimePeriod' => [ // REQUIRED
        'End' => '<string>', // REQUIRED
        'Start' => '<string>', // REQUIRED
    ],
]);

Parameter Details

Members

Context

Type: string

The context for the call to GetDimensionValues. This can be RESERVATIONS or COST_AND_USAGE. The default value is COST_AND_USAGE. If the context is set to RESERVATIONS, the resulting dimension values can be used in the GetReservationUtilization operation. If the context is set to COST_AND_USAGE the resulting dimension values can be used in the GetCostAndUsage operation.

If you set the context to COST_AND_USAGE, you can use the following dimensions for searching:

AZ - The Availability Zone. An example is us-east-1a.
DATABASE_ENGINE - The Amazon Relational Database Service database. Examples are Aurora or MySQL.
INSTANCE_TYPE - The type of EC2 instance. An example is m4.xlarge.
LEGAL_ENTITY_NAME - The name of the organization that sells you AWS services, such as Amazon Web Services.
LINKED_ACCOUNT - The description in the attribute map that includes the full name of the member account. The value field contains the AWS ID of the member account.
OPERATING_SYSTEM - The operating system. Examples are Windows or Linux.
OPERATION - The action performed. Examples include RunInstance and CreateBucket.
PLATFORM - The EC2 operating system. Examples are Windows or Linux.
PURCHASE_TYPE - The reservation type of the purchase to which this usage is related. Examples include On-Demand Instances and Standard Reserved Instances.
SERVICE - The AWS service such as Amazon DynamoDB.
USAGE_TYPE - The type of usage. An example is DataTransfer-In-Bytes. The response for the GetDimensionValues operation includes a unit attribute. Examples include GB and Hrs.
USAGE_TYPE_GROUP - The grouping of common usage types. An example is EC2: CloudWatch – Alarms. The response for this operation includes a unit attribute.
RECORD_TYPE - The different types of charges such as RI fees, usage costs, tax refunds, and credits.

If you set the context to RESERVATIONS, you can use the following dimensions for searching:

AZ - The Availability Zone. An example is us-east-1a.
CACHE_ENGINE - The Amazon ElastiCache operating system. Examples are Windows or Linux.
DEPLOYMENT_OPTION - The scope of Amazon Relational Database Service deployments. Valid values are SingleAZ and MultiAZ.
INSTANCE_TYPE - The type of EC2 instance. An example is m4.xlarge.
LINKED_ACCOUNT - The description in the attribute map that includes the full name of the member account. The value field contains the AWS ID of the member account.
PLATFORM - The EC2 operating system. Examples are Windows or Linux.
REGION - The AWS Region.
SCOPE (Utilization only) - The scope of a Reserved Instance (RI). Values are regional or a single Availability Zone.
TAG (Coverage only) - The tags that are associated with a Reserved Instance (RI).
TENANCY - The tenancy of a resource. Examples are shared or dedicated.

Dimension

Type: string

The name of the dimension. Each Dimension is available for different a Context. For more information, see Context.

NextPageToken

Type: string

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

SearchString

Type: string

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

TimePeriod

Required: Yes
Type: DateInterval structure

The start and end dates for retrieving the dimension values. The start date is inclusive, but the end date is exclusive. For example, if start is 2017-01-01 and end is 2017-05-01, then the cost and usage data is retrieved from 2017-01-01 up to and including 2017-04-30 but not including 2017-05-01.

Result Syntax

[
    'DimensionValues' => [
        [
            'Attributes' => ['<string>', ...],
            'Value' => '<string>',
        ],
        // ...
    ],
    'NextPageToken' => '<string>',
    'ReturnSize' => <integer>,
    'TotalSize' => <integer>,
]

Result Details

Members

DimensionValues

Type: Array of DimensionValuesWithAttributes structures

The filters that you used to filter your request. Some dimensions are available only for a specific context:

If you set the context to COST_AND_USAGE, you can use the following dimensions for searching:

AZ - The Availability Zone. An example is us-east-1a.
DATABASE_ENGINE - The Amazon Relational Database Service database. Examples are Aurora or MySQL.
INSTANCE_TYPE - The type of EC2 instance. An example is m4.xlarge.
LEGAL_ENTITY_NAME - The name of the organization that sells you AWS services, such as Amazon Web Services.
LINKED_ACCOUNT - The description in the attribute map that includes the full name of the member account. The value field contains the AWS ID of the member account.
OPERATING_SYSTEM - The operating system. Examples are Windows or Linux.
OPERATION - The action performed. Examples include RunInstance and CreateBucket.
PLATFORM - The EC2 operating system. Examples are Windows or Linux.
PURCHASE_TYPE - The reservation type of the purchase to which this usage is related. Examples include On-Demand Instances and Standard Reserved Instances.
SERVICE - The AWS service such as Amazon DynamoDB.
USAGE_TYPE - The type of usage. An example is DataTransfer-In-Bytes. The response for the GetDimensionValues operation includes a unit attribute. Examples include GB and Hrs.
USAGE_TYPE_GROUP - The grouping of common usage types. An example is EC2: CloudWatch – Alarms. The response for this operation includes a unit attribute.
RECORD_TYPE - The different types of charges such as RI fees, usage costs, tax refunds, and credits.

If you set the context to RESERVATIONS, you can use the following dimensions for searching:

AZ - The Availability Zone. An example is us-east-1a.
CACHE_ENGINE - The Amazon ElastiCache operating system. Examples are Windows or Linux.
DEPLOYMENT_OPTION - The scope of Amazon Relational Database Service deployments. Valid values are SingleAZ and MultiAZ.
INSTANCE_TYPE - The type of EC2 instance. An example is m4.xlarge.
LINKED_ACCOUNT - The description in the attribute map that includes the full name of the member account. The value field contains the AWS ID of the member account.
PLATFORM - The EC2 operating system. Examples are Windows or Linux.
REGION - The AWS Region.
SCOPE (Utilization only) - The scope of a Reserved Instance (RI). Values are regional or a single Availability Zone.
TAG (Coverage only) - The tags that are associated with a Reserved Instance (RI).
TENANCY - The tenancy of a resource. Examples are shared or dedicated.

NextPageToken

Type: string

The token for the next set of retrievable results. AWS provides the token when the response from a previous call has more results than the maximum page size.

ReturnSize

Type: int

The number of results that AWS returned at one time.

TotalSize

Type: int

The total number of search results.

Errors

LimitExceededException:
You made too many calls in a short period of time. Try again later.
BillExpirationException:
The requested report expired. Update the date interval and try again.
DataUnavailableException:
The requested data is unavailable.
InvalidNextTokenException:
The pagination token is invalid. Try again without a pagination token.
RequestChangedException:
Your request parameters changed between pages. Try again with the old parameters or without a pagination token.

GetReservationCoverage

$result = $client->getReservationCoverage([/* ... */]);
$promise = $client->getReservationCoverageAsync([/* ... */]);

Retrieves the reservation coverage for your account. This allows you to see how much of your Amazon Elastic Compute Cloud, Amazon ElastiCache, Amazon Relational Database Service, or Amazon Redshift usage is covered by a reservation. An organization's master account can see the coverage of the associated member accounts. For any time period, you can filter data about reservation usage by the following dimensions:

AZ
CACHE_ENGINE
DATABASE_ENGINE
DEPLOYMENT_OPTION
INSTANCE_TYPE
LINKED_ACCOUNT
OPERATING_SYSTEM
PLATFORM
REGION
SERVICE
TAG
TENANCY

To determine valid values for a dimension, use the GetDimensionValues operation.

Parameter Syntax

$result = $client->getReservationCoverage([
    'Filter' => [
        'And' => [
            [...], // RECURSIVE
            // ...
        ],
        'Dimensions' => [
            'Key' => 'AZ|INSTANCE_TYPE|LINKED_ACCOUNT|OPERATION|PURCHASE_TYPE|REGION|SERVICE|USAGE_TYPE|USAGE_TYPE_GROUP|RECORD_TYPE|OPERATING_SYSTEM|TENANCY|SCOPE|PLATFORM|SUBSCRIPTION_ID|LEGAL_ENTITY_NAME|DEPLOYMENT_OPTION|DATABASE_ENGINE|CACHE_ENGINE|INSTANCE_TYPE_FAMILY',
            'Values' => ['<string>', ...],
        ],
        'Not' => [...], // RECURSIVE
        'Or' => [
            [...], // RECURSIVE
            // ...
        ],
        'Tags' => [
            'Key' => '<string>',
            'Values' => ['<string>', ...],
        ],
    ],
    'Granularity' => 'DAILY|MONTHLY',
    'GroupBy' => [
        [
            'Key' => '<string>',
            'Type' => 'DIMENSION|TAG',
        ],
        // ...
    ],
    'NextPageToken' => '<string>',
    'TimePeriod' => [ // REQUIRED
        'End' => '<string>', // REQUIRED
        'Start' => '<string>', // REQUIRED
    ],
]);

Parameter Details

Members

Filter

Type: Expression structure

Filters utilization data by dimensions. You can filter by the following dimensions:

AZ
CACHE_ENGINE
DATABASE_ENGINE
DEPLOYMENT_OPTION
INSTANCE_TYPE
LINKED_ACCOUNT
OPERATING_SYSTEM
PLATFORM
REGION
SERVICE
TAG
TENANCY

GetReservationCoverage uses the same Expression object as the other operations, but only AND is supported among each dimension. You can nest only one level deep. If there are multiple values for a dimension, they are OR'd together.

If you don't provide a SERVICE filter, Cost Explorer defaults to EC2.

Granularity

Type: string

The granularity of the AWS cost data for the reservation. Valid values are MONTHLY and DAILY.

If GroupBy is set, Granularity can't be set. If Granularity isn't set, the response object doesn't include Granularity, either MONTHLY or DAILY.

GroupBy

Type: Array of GroupDefinition structures

You can group the data by the following attributes:

AZ
CACHE_ENGINE
DATABASE_ENGINE
DEPLOYMENT_OPTION
INSTANCE_TYPE
LINKED_ACCOUNT
OPERATING_SYSTEM
PLATFORM
REGION
TAG
TENANCY

NextPageToken

Type: string

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

TimePeriod

Required: Yes
Type: DateInterval structure

The start and end dates of the period for which you want to retrieve data about reservation coverage. You can retrieve data for a maximum of 13 months: the last 12 months and the current month. The start date is inclusive, but the end date is exclusive. For example, if start is 2017-01-01 and end is 2017-05-01, then the cost and usage data is retrieved from 2017-01-01 up to and including 2017-04-30 but not including 2017-05-01.

Result Syntax

[
    'CoveragesByTime' => [
        [
            'Groups' => [
                [
                    'Attributes' => ['<string>', ...],
                    'Coverage' => [
                        'CoverageHours' => [
                            'CoverageHoursPercentage' => '<string>',
                            'OnDemandHours' => '<string>',
                            'ReservedHours' => '<string>',
                            'TotalRunningHours' => '<string>',
                        ],
                    ],
                ],
                // ...
            ],
            'TimePeriod' => [
                'End' => '<string>',
                'Start' => '<string>',
            ],
            'Total' => [
                'CoverageHours' => [
                    'CoverageHoursPercentage' => '<string>',
                    'OnDemandHours' => '<string>',
                    'ReservedHours' => '<string>',
                    'TotalRunningHours' => '<string>',
                ],
            ],
        ],
        // ...
    ],
    'NextPageToken' => '<string>',
    'Total' => [
        'CoverageHours' => [
            'CoverageHoursPercentage' => '<string>',
            'OnDemandHours' => '<string>',
            'ReservedHours' => '<string>',
            'TotalRunningHours' => '<string>',
        ],
    ],
]

Result Details

Members

CoveragesByTime

Type: Array of CoverageByTime structures

The amount of time that your reservations covered.

NextPageToken

Type: string

The token for the next set of retrievable results. AWS provides the token when the response from a previous call has more results than the maximum page size.

Total

Type: Coverage structure

The total amount of instance usage that is covered by a reservation.

Errors

LimitExceededException:
You made too many calls in a short period of time. Try again later.
DataUnavailableException:
The requested data is unavailable.
InvalidNextTokenException:
The pagination token is invalid. Try again without a pagination token.

GetReservationPurchaseRecommendation

$result = $client->getReservationPurchaseRecommendation([/* ... */]);
$promise = $client->getReservationPurchaseRecommendationAsync([/* ... */]);

Gets recommendations for which reservations to purchase. These recommendations could help you reduce your costs. Reservations provide a discounted hourly rate (up to 75%) compared to On-Demand pricing.

AWS generates your recommendations by identifying your On-Demand usage during a specific time period and collecting your usage into categories that are eligible for a reservation. After AWS has these categories, it simulates every combination of reservations in each category of usage to identify the best number of each type of RI to purchase to maximize your estimated savings.

For example, AWS automatically aggregates your EC2 Linux, shared tenancy, and c4 family usage in the US West (Oregon) Region and recommends that you buy size-flexible regional reservations to apply to the c4 family usage. AWS recommends the smallest size instance in an instance family. This makes it easier to purchase a size-flexible RI. AWS also shows the equal number of normalized units so that you can purchase any instance size that you want. For this example, your RI recommendation would be for c4.large, because that is the smallest size instance in the c4 instance family.

Parameter Syntax

$result = $client->getReservationPurchaseRecommendation([
    'AccountId' => '<string>',
    'AccountScope' => 'PAYER|LINKED',
    'LookbackPeriodInDays' => 'SEVEN_DAYS|THIRTY_DAYS|SIXTY_DAYS',
    'NextPageToken' => '<string>',
    'PageSize' => <integer>,
    'PaymentOption' => 'NO_UPFRONT|PARTIAL_UPFRONT|ALL_UPFRONT|LIGHT_UTILIZATION|MEDIUM_UTILIZATION|HEAVY_UTILIZATION',
    'Service' => '<string>', // REQUIRED
    'ServiceSpecification' => [
        'EC2Specification' => [
            'OfferingClass' => 'STANDARD|CONVERTIBLE',
        ],
    ],
    'TermInYears' => 'ONE_YEAR|THREE_YEARS',
]);

Parameter Details

Members

AccountId

Type: string

The account ID that is associated with the recommendation.

AccountScope

Type: string

The account scope that you want recommendations for. PAYER means that AWS includes the master account and any member accounts when it calculates its recommendations. LINKED means that AWS includes only member accounts when it calculates its recommendations.

Valid values are PAYER and LINKED.

LookbackPeriodInDays

Type: string

The number of previous days that you want AWS to consider when it calculates your recommendations.

NextPageToken

Type: string

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

PageSize

Type: int

The number of recommendations that you want returned in a single response object.

PaymentOption

Type: string

The reservation purchase option that you want recommendations for.

Service

Type: string

The specific service that you want recommendations for.

ServiceSpecification

Type: ServiceSpecification structure

The hardware specifications for the service instances that you want recommendations for, such as standard or convertible EC2 instances.

TermInYears

Type: string

The reservation term that you want recommendations for.

Result Syntax

[
    'Metadata' => [
        'GenerationTimestamp' => '<string>',
        'RecommendationId' => '<string>',
    ],
    'NextPageToken' => '<string>',
    'Recommendations' => [
        [
            'AccountScope' => 'PAYER|LINKED',
            'LookbackPeriodInDays' => 'SEVEN_DAYS|THIRTY_DAYS|SIXTY_DAYS',
            'PaymentOption' => 'NO_UPFRONT|PARTIAL_UPFRONT|ALL_UPFRONT|LIGHT_UTILIZATION|MEDIUM_UTILIZATION|HEAVY_UTILIZATION',
            'RecommendationDetails' => [
                [
                    'AverageNormalizedUnitsUsedPerHour' => '<string>',
                    'AverageNumberOfInstancesUsedPerHour' => '<string>',
                    'AverageUtilization' => '<string>',
                    'CurrencyCode' => '<string>',
                    'EstimatedBreakEvenInMonths' => '<string>',
                    'EstimatedMonthlyOnDemandCost' => '<string>',
                    'EstimatedMonthlySavingsAmount' => '<string>',
                    'EstimatedMonthlySavingsPercentage' => '<string>',
                    'EstimatedReservationCostForLookbackPeriod' => '<string>',
                    'InstanceDetails' => [
                        'EC2InstanceDetails' => [
                            'AvailabilityZone' => '<string>',
                            'CurrentGeneration' => true || false,
                            'Family' => '<string>',
                            'InstanceType' => '<string>',
                            'Platform' => '<string>',
                            'Region' => '<string>',
                            'SizeFlexEligible' => true || false,
                            'Tenancy' => '<string>',
                        ],
                        'ESInstanceDetails' => [
                            'CurrentGeneration' => true || false,
                            'InstanceClass' => '<string>',
                            'InstanceSize' => '<string>',
                            'Region' => '<string>',
                            'SizeFlexEligible' => true || false,
                        ],
                        'ElastiCacheInstanceDetails' => [
                            'CurrentGeneration' => true || false,
                            'Family' => '<string>',
                            'NodeType' => '<string>',
                            'ProductDescription' => '<string>',
                            'Region' => '<string>',
                            'SizeFlexEligible' => true || false,
                        ],
                        'RDSInstanceDetails' => [
                            'CurrentGeneration' => true || false,
                            'DatabaseEdition' => '<string>',
                            'DatabaseEngine' => '<string>',
                            'DeploymentOption' => '<string>',
                            'Family' => '<string>',
                            'InstanceType' => '<string>',
                            'LicenseModel' => '<string>',
                            'Region' => '<string>',
                            'SizeFlexEligible' => true || false,
                        ],
                        'RedshiftInstanceDetails' => [
                            'CurrentGeneration' => true || false,
                            'Family' => '<string>',
                            'NodeType' => '<string>',
                            'Region' => '<string>',
                            'SizeFlexEligible' => true || false,
                        ],
                    ],
                    'MaximumNormalizedUnitsUsedPerHour' => '<string>',
                    'MaximumNumberOfInstancesUsedPerHour' => '<string>',
                    'MinimumNormalizedUnitsUsedPerHour' => '<string>',
                    'MinimumNumberOfInstancesUsedPerHour' => '<string>',
                    'RecommendedNormalizedUnitsToPurchase' => '<string>',
                    'RecommendedNumberOfInstancesToPurchase' => '<string>',
                    'RecurringStandardMonthlyCost' => '<string>',
                    'UpfrontCost' => '<string>',
                ],
                // ...
            ],
            'RecommendationSummary' => [
                'CurrencyCode' => '<string>',
                'TotalEstimatedMonthlySavingsAmount' => '<string>',
                'TotalEstimatedMonthlySavingsPercentage' => '<string>',
            ],
            'ServiceSpecification' => [
                'EC2Specification' => [
                    'OfferingClass' => 'STANDARD|CONVERTIBLE',
                ],
            ],
            'TermInYears' => 'ONE_YEAR|THREE_YEARS',
        ],
        // ...
    ],
]

Result Details

Members

Metadata

Type: ReservationPurchaseRecommendationMetadata structure

Information about this specific recommendation call, such as the time stamp for when Cost Explorer generated this recommendation.

NextPageToken

Type: string

The pagination token for the next set of retrievable results.

Recommendations

Type: Array of ReservationPurchaseRecommendation structures

Recommendations for reservations to purchase.

Errors

LimitExceededException:
You made too many calls in a short period of time. Try again later.
DataUnavailableException:
The requested data is unavailable.
InvalidNextTokenException:
The pagination token is invalid. Try again without a pagination token.

GetReservationUtilization

$result = $client->getReservationUtilization([/* ... */]);
$promise = $client->getReservationUtilizationAsync([/* ... */]);

Retrieves the reservation utilization for your account. Master accounts in an organization have access to member accounts. You can filter data by dimensions in a time period. You can use GetDimensionValues to determine the possible dimension values. Currently, you can group only by SUBSCRIPTION_ID.

Parameter Syntax

$result = $client->getReservationUtilization([
    'Filter' => [
        'And' => [
            [...], // RECURSIVE
            // ...
        ],
        'Dimensions' => [
            'Key' => 'AZ|INSTANCE_TYPE|LINKED_ACCOUNT|OPERATION|PURCHASE_TYPE|REGION|SERVICE|USAGE_TYPE|USAGE_TYPE_GROUP|RECORD_TYPE|OPERATING_SYSTEM|TENANCY|SCOPE|PLATFORM|SUBSCRIPTION_ID|LEGAL_ENTITY_NAME|DEPLOYMENT_OPTION|DATABASE_ENGINE|CACHE_ENGINE|INSTANCE_TYPE_FAMILY',
            'Values' => ['<string>', ...],
        ],
        'Not' => [...], // RECURSIVE
        'Or' => [
            [...], // RECURSIVE
            // ...
        ],
        'Tags' => [
            'Key' => '<string>',
            'Values' => ['<string>', ...],
        ],
    ],
    'Granularity' => 'DAILY|MONTHLY',
    'GroupBy' => [
        [
            'Key' => '<string>',
            'Type' => 'DIMENSION|TAG',
        ],
        // ...
    ],
    'NextPageToken' => '<string>',
    'TimePeriod' => [ // REQUIRED
        'End' => '<string>', // REQUIRED
        'Start' => '<string>', // REQUIRED
    ],
]);

Parameter Details

Members

Filter

Type: Expression structure

Filters utilization data by dimensions. You can filter by the following dimensions:

AZ
CACHE_ENGINE
DATABASE_ENGINE
DEPLOYMENT_OPTION
INSTANCE_TYPE
LINKED_ACCOUNT
OPERATING_SYSTEM
PLATFORM
REGION
SERVICE
SCOPE
TENANCY

GetReservationUtilization uses the same Expression object as the other operations, but only AND is supported among each dimension, and nesting is supported up to only one level deep. If there are multiple values for a dimension, they are OR'd together.

Granularity

Type: string

If GroupBy is set, Granularity can't be set. If Granularity isn't set, the response object doesn't include Granularity, either MONTHLY or DAILY. If both GroupBy and Granularity aren't set, GetReservationUtilization defaults to DAILY.

GroupBy

Type: Array of GroupDefinition structures

Groups only by SUBSCRIPTION_ID. Metadata is included.

NextPageToken

Type: string

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

TimePeriod

Required: Yes
Type: DateInterval structure

Sets the start and end dates for retrieving Reserved Instance (RI) utilization. The start date is inclusive, but the end date is exclusive. For example, if start is 2017-01-01 and end is 2017-05-01, then the cost and usage data is retrieved from 2017-01-01 up to and including 2017-04-30 but not including 2017-05-01.

Result Syntax

[
    'NextPageToken' => '<string>',
    'Total' => [
        'AmortizedRecurringFee' => '<string>',
        'AmortizedUpfrontFee' => '<string>',
        'NetRISavings' => '<string>',
        'OnDemandCostOfRIHoursUsed' => '<string>',
        'PurchasedHours' => '<string>',
        'TotalActualHours' => '<string>',
        'TotalAmortizedFee' => '<string>',
        'TotalPotentialRISavings' => '<string>',
        'UnusedHours' => '<string>',
        'UtilizationPercentage' => '<string>',
    ],
    'UtilizationsByTime' => [
        [
            'Groups' => [
                [
                    'Attributes' => ['<string>', ...],
                    'Key' => '<string>',
                    'Utilization' => [
                        'AmortizedRecurringFee' => '<string>',
                        'AmortizedUpfrontFee' => '<string>',
                        'NetRISavings' => '<string>',
                        'OnDemandCostOfRIHoursUsed' => '<string>',
                        'PurchasedHours' => '<string>',
                        'TotalActualHours' => '<string>',
                        'TotalAmortizedFee' => '<string>',
                        'TotalPotentialRISavings' => '<string>',
                        'UnusedHours' => '<string>',
                        'UtilizationPercentage' => '<string>',
                    ],
                    'Value' => '<string>',
                ],
                // ...
            ],
            'TimePeriod' => [
                'End' => '<string>',
                'Start' => '<string>',
            ],
            'Total' => [
                'AmortizedRecurringFee' => '<string>',
                'AmortizedUpfrontFee' => '<string>',
                'NetRISavings' => '<string>',
                'OnDemandCostOfRIHoursUsed' => '<string>',
                'PurchasedHours' => '<string>',
                'TotalActualHours' => '<string>',
                'TotalAmortizedFee' => '<string>',
                'TotalPotentialRISavings' => '<string>',
                'UnusedHours' => '<string>',
                'UtilizationPercentage' => '<string>',
            ],
        ],
        // ...
    ],
]

Result Details

Members

NextPageToken

Type: string

The token for the next set of retrievable results. AWS provides the token when the response from a previous call has more results than the maximum page size.

Total

Type: ReservationAggregates structure

The total amount of time that you utilized your RIs.

UtilizationsByTime

Type: Array of UtilizationByTime structures

The amount of time that you utilized your RIs.

Errors

LimitExceededException:
You made too many calls in a short period of time. Try again later.
DataUnavailableException:
The requested data is unavailable.
InvalidNextTokenException:
The pagination token is invalid. Try again without a pagination token.

GetTags

$result = $client->getTags([/* ... */]);
$promise = $client->getTagsAsync([/* ... */]);

Queries for available tag keys and tag values for a specified period. You can search the tag values for an arbitrary string.

Parameter Syntax

$result = $client->getTags([
    'NextPageToken' => '<string>',
    'SearchString' => '<string>',
    'TagKey' => '<string>',
    'TimePeriod' => [ // REQUIRED
        'End' => '<string>', // REQUIRED
        'Start' => '<string>', // REQUIRED
    ],
]);

Parameter Details

Members

NextPageToken

Type: string

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

SearchString

Type: string

The value that you want to search for.

TagKey

Type: string

The key of the tag that you want to return values for.

TimePeriod

Required: Yes
Type: DateInterval structure

Result Syntax

[
    'NextPageToken' => '<string>',
    'ReturnSize' => <integer>,
    'Tags' => ['<string>', ...],
    'TotalSize' => <integer>,
]

Result Details

Members

NextPageToken

Type: string

The token for the next set of retrievable results. AWS provides the token when the response from a previous call has more results than the maximum page size.

ReturnSize

Type: int

The number of query results that AWS returns at a time.

Tags

Type: Array of strings

The tags that match your request.

TotalSize

Type: int

The total number of query results.

Errors

LimitExceededException:
You made too many calls in a short period of time. Try again later.
BillExpirationException:
The requested report expired. Update the date interval and try again.
DataUnavailableException:
The requested data is unavailable.
InvalidNextTokenException:
The pagination token is invalid. Try again without a pagination token.
RequestChangedException:
Your request parameters changed between pages. Try again with the old parameters or without a pagination token.

Shapes

BillExpirationException

Description

The requested report expired. Update the date interval and try again.

Members

Message

Type: string

Coverage

Description

The amount of instance usage that a reservation covered.

Members

CoverageHours

Type: CoverageHours structure

The amount of instance usage that a reservation covered, in hours.

CoverageByTime

Description

Reservation coverage for a specified period, in hours.

Members

Groups

Type: Array of ReservationCoverageGroup structures

The groups of instances that are covered by a reservation.

TimePeriod

Required: Yes
Type: DateInterval structure

The period over which this coverage was used.

Total

Type: Coverage structure

The total reservation coverage, in hours.

CoverageHours

Description

How long a running instance either used a reservation or was On-Demand.

Members

CoverageHoursPercentage

Type: string

The percentage of instance hours that are covered by a reservation.

OnDemandHours

Type: string

The number of instance running hours that are covered by On-Demand Instances.

ReservedHours

Type: string

The number of instance running hours that are covered by reservations.

TotalRunningHours

Type: string

The total instance usage, in hours.

DataUnavailableException

Description

The requested data is unavailable.

Members

Message

Type: string

DateInterval

Description

The time period that you want the usage and costs for.

Members

End

Type: string

The end of the time period that you want the usage and costs for. The end date is exclusive. For example, if end is 2017-05-01, AWS retrieves cost and usage data from the start date up to, but not including, 2017-05-01.

Start

Type: string

The beginning of the time period that you want the usage and costs for. The start date is inclusive. For example, if start is 2017-01-01, AWS retrieves cost and usage data starting at 2017-01-01 up to the end date.

DimensionValues

Description

The metadata that you can use to filter and group your results. You can use GetDimensionValues to find specific values.

Members

Key

Type: string

The names of the metadata types that you can use to filter and group your results. For example, AZ returns a list of Availability Zones.

Values

Type: Array of strings

The metadata values that you can use to filter and group your results. You can use GetDimensionValues to find specific values.

DimensionValuesWithAttributes

Description

The metadata of a specific type that you can use to filter and group your results. You can use GetDimensionValues to find specific values.

Members

Attributes

Type: Associative array of custom strings keys (AttributeType) to strings

The attribute that applies to a specific Dimension.

Value

Type: string

The value of a dimension with a specific attribute.

EC2InstanceDetails

Description

Details about the EC2 instances that AWS recommends that you purchase.

Members

AvailabilityZone

Type: string

The Availability Zone of the recommended reservation.

CurrentGeneration

Type: boolean

Whether the recommendation is for a current generation instance.

Family

Type: string

The instance family of the recommended reservation.

InstanceType

Type: string

The type of instance that AWS recommends.

Platform

Type: string

The platform of the recommended reservation. The platform is the specific combination of operating system, license model, and software on an instance.

Region

Type: string

The AWS Region of the recommended reservation.

SizeFlexEligible

Type: boolean

Whether the recommended reservation is size flexible.

Tenancy

Type: string

Whether the recommended reservation is dedicated or shared.

EC2Specification

Description

The EC2 hardware specifications that you want AWS to provide recommendations for.

Members

OfferingClass

Type: string

Whether you want a recommendation for standard or convertible reservations.

ESInstanceDetails

Description

Details about the ES instances that AWS recommends that you purchase.

Members

CurrentGeneration

Type: boolean

Whether the recommendation is for a current generation instance.

InstanceClass

Type: string

The class of instance that AWS recommends.

InstanceSize

Type: string

The size of instance that AWS recommends.

Region

Type: string

The AWS Region of the recommended reservation.

SizeFlexEligible

Type: boolean

Whether the recommended reservation is size flexible.

ElastiCacheInstanceDetails

Description

Details about the ElastiCache instances that AWS recommends that you purchase.

Members

CurrentGeneration

Type: boolean

Whether the recommendation is for a current generation instance.

Family

Type: string

The instance family of the recommended reservation.

NodeType

Type: string

The type of node that AWS recommends.

ProductDescription

Type: string

The description of the recommended reservation.

Region

Type: string

The AWS Region of the recommended reservation.

SizeFlexEligible

Type: boolean

Whether the recommended reservation is size flexible.

Expression

Description

Use Expression to filter by cost or by usage. There are two patterns:

Simple dimension values - You can set the dimension name and values for the filters that you plan to use. For example, you can filter for INSTANCE_TYPE==m4.xlarge OR INSTANCE_TYPE==c4.large. The Expression for that looks like this:

{ "Dimensions": { "Key": "INSTANCE_TYPE", "Values": [ "m4.xlarge", “c4.large” ] } }

The list of dimension values are OR'd together to retrieve cost or usage data. You can create Expression and DimensionValues objects using either with* methods or set* methods in multiple lines.
Compound dimension values with logical operations - You can use multiple Expression types and the logical operators AND/OR/NOT to create a list of one or more Expression objects. This allows you to filter on more advanced options. For example, you can filter on ((INSTANCE_TYPE == m4.large OR INSTANCE_TYPE == m3.large) OR (TAG.Type == Type1)) AND (USAGE_TYPE != DataTransfer). The Expression for that looks like this:

{ "And": [ {"Or": [ {"Dimensions": { "Key": "INSTANCE_TYPE", "Values": [ "m4.x.large", "c4.large" ] }}, {"Tags": { "Key": "TagName", "Values": ["Value1"] } } ]}, {"Not": {"Dimensions": { "Key": "USAGE_TYPE", "Values": ["DataTransfer"] }}} ] }

Because each Expression can have only one operator, the service returns an error if more than one is specified. The following example shows an Expression object that creates an error.

{ "And": [ ... ], "DimensionValues": { "Dimension": "USAGE_TYPE", "Values": [ "DataTransfer" ] } }

Members

And

Type: Array of Expression structures

Return results that match both Dimension objects.

Dimensions

Type: DimensionValues structure

The specific Dimension to use for Expression.

Not

Type: Expression structure

Return results that don't match a Dimension object.

Or

Type: Array of Expression structures

Return results that match either Dimension object.

Tags

Type: TagValues structure

The specific Tag to use for Expression.

Group

Description

One level of grouped data within the results.

Members

Keys

Type: Array of strings

The keys that are included in this group.

Metrics

Type: Associative array of custom strings keys (MetricName) to MetricValue structures

The metrics that are included in this group.

GroupDefinition

Description

Represents a group when you specify a group by criteria, or in the response to a query with a specific grouping.

Members

Key

Type: string

The string that represents a key for a specified group.

Type

Type: string

The string that represents the type of group.

InstanceDetails

Description

Details about the instances that AWS recommends that you purchase.

Members

EC2InstanceDetails

Type: EC2InstanceDetails structure

The EC2 instances that AWS recommends that you purchase.

ESInstanceDetails

Type: ESInstanceDetails structure

The Amazon ES instances that AWS recommends that you purchase.

ElastiCacheInstanceDetails

Type: ElastiCacheInstanceDetails structure

The ElastiCache instances that AWS recommends that you purchase.

RDSInstanceDetails

Type: RDSInstanceDetails structure

The RDS instances that AWS recommends that you purchase.

RedshiftInstanceDetails

Type: RedshiftInstanceDetails structure

The Amazon Redshift instances that AWS recommends that you purchase.

InvalidNextTokenException

Description

The pagination token is invalid. Try again without a pagination token.

Members

Message

Type: string

LimitExceededException

Description

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

Members

Message

Type: string

MetricValue

Description

The aggregated value for a metric.

Members

Amount

Type: string

The actual number that represents the metric.

Unit

Type: string

The unit that the metric is given in.

RDSInstanceDetails

Description

Details about the RDS instances that AWS recommends that you purchase.

Members

CurrentGeneration

Type: boolean

Whether the recommendation is for a current generation instance.

DatabaseEdition

Type: string

The database edition that the recommended reservation supports.

DatabaseEngine

Type: string

The database engine that the recommended reservation supports.

DeploymentOption

Type: string

Whether the recommendation is for a reservation in a single Availability Zone or a reservation with a backup in a second Availability Zone.

Family

Type: string

The instance family of the recommended reservation.

InstanceType

Type: string

The type of instance that AWS recommends.

LicenseModel

Type: string

The license model that the recommended reservation supports.

Region

Type: string

The AWS Region of the recommended reservation.

SizeFlexEligible

Type: boolean

Whether the recommended reservation is size flexible.

RedshiftInstanceDetails

Description

Details about the Amazon Redshift instances that AWS recommends that you purchase.

Members

CurrentGeneration

Type: boolean

Whether the recommendation is for a current generation instance.

Family

Type: string

The instance family of the recommended reservation.

NodeType

Type: string

The type of node that AWS recommends.

Region

Type: string

The AWS Region of the recommended reservation.

SizeFlexEligible

Type: boolean

Whether the recommended reservation is size flexible.

RequestChangedException

Description

Your request parameters changed between pages. Try again with the old parameters or without a pagination token.

Members

Message

Type: string

ReservationAggregates

Description

The aggregated numbers for your Reserved Instance (RI) usage.

Members

AmortizedRecurringFee

Type: string

The monthly cost of your RI, amortized over the RI period.

AmortizedUpfrontFee

Type: string

The upfront cost of your RI, amortized over the RI period.

NetRISavings

Type: string

How much you saved due to purchasing and utilizing RIs. AWS calculates this by subtracting TotalAmortizedFee from OnDemandCostOfRIHoursUsed.

OnDemandCostOfRIHoursUsed

Type: string

How much your RIs would cost if charged On-Demand rates.

PurchasedHours

Type: string

How many RI hours that you purchased.

TotalActualHours

Type: string

The total number of RI hours that you used.

TotalAmortizedFee

Type: string

The total cost of your RI, amortized over the RI period.

TotalPotentialRISavings

Type: string

How much you could save if you use your entire reservation.

UnusedHours

Type: string

The number of RI hours that you didn't use.

UtilizationPercentage

Type: string

The percentage of RI time that you used.

ReservationCoverageGroup

Description

A group of reservations that share a set of attributes.

Members

Attributes

Type: Associative array of custom strings keys (AttributeType) to strings

The attributes for this group of reservations.

Coverage

Type: Coverage structure

How much instance usage this group of reservations covered.

ReservationPurchaseRecommendation

Description

A specific reservation that AWS recommends for purchase.

Members

AccountScope

Type: string

The account scope that AWS recommends that you purchase this instance for. For example, you can purchase this reservation for an entire organization in AWS Organizations.

LookbackPeriodInDays

Type: string

How many days of previous usage that AWS considers when making this recommendation.

PaymentOption

Type: string

The payment option for the reservation. For example, AllUpfront or NoUpfront.

RecommendationDetails

Type: Array of ReservationPurchaseRecommendationDetail structures

Details about the recommended purchases.

RecommendationSummary

Type: ReservationPurchaseRecommendationSummary structure

A summary about the recommended purchase.

ServiceSpecification

Type: ServiceSpecification structure

Hardware specifications for the service that you want recommendations for.

TermInYears

Type: string

The term of the reservation that you want recommendations for, in years.

ReservationPurchaseRecommendationDetail

Description

Details about your recommended reservation purchase.

Members

AverageNormalizedUnitsUsedPerHour

Type: string

The average number of normalized units that you used in an hour during the historical period. AWS uses this to calculate your recommended reservation purchases.

AverageNumberOfInstancesUsedPerHour

Type: string

The average number of instances that you used in an hour during the historical period. AWS uses this to calculate your recommended reservation purchases.

AverageUtilization

Type: string

The average utilization of your instances. AWS uses this to calculate your recommended reservation purchases.

CurrencyCode

Type: string

The currency code that AWS used to calculate the costs for this instance.

EstimatedBreakEvenInMonths

Type: string

How long AWS estimates that it takes for this instance to start saving you money, in months.

EstimatedMonthlyOnDemandCost

Type: string

How much AWS estimates that you spend on On-Demand Instances in a month.

EstimatedMonthlySavingsAmount

Type: string

How much AWS estimates that this specific recommendation could save you in a month.

EstimatedMonthlySavingsPercentage

Type: string

How much AWS estimates that this specific recommendation could save you in a month, as a percentage of your overall costs.

EstimatedReservationCostForLookbackPeriod

Type: string

How much AWS estimates that you would have spent for all usage during the specified historical period if you had had a reservation.

InstanceDetails

Type: InstanceDetails structure

Details about the instances that AWS recommends that you purchase.

MaximumNormalizedUnitsUsedPerHour

Type: string

The maximum number of normalized units that you used in an hour during the historical period. AWS uses this to calculate your recommended reservation purchases.

MaximumNumberOfInstancesUsedPerHour

Type: string

The maximum number of instances that you used in an hour during the historical period. AWS uses this to calculate your recommended reservation purchases.

MinimumNormalizedUnitsUsedPerHour

Type: string

The minimum number of hours that you used in an hour during the historical period. AWS uses this to calculate your recommended reservation purchases.

MinimumNumberOfInstancesUsedPerHour

Type: string

The minimum number of instances that you used in an hour during the historical period. AWS uses this to calculate your recommended reservation purchases.

RecommendedNormalizedUnitsToPurchase

Type: string

The number of normalized units that AWS recommends that you purchase.

RecommendedNumberOfInstancesToPurchase

Type: string

The number of instances that AWS recommends that you purchase.

RecurringStandardMonthlyCost

Type: string

How much purchasing this instance costs you on a monthly basis.

UpfrontCost

Type: string

How much purchasing this instance costs you upfront.

ReservationPurchaseRecommendationMetadata

Description

Information about this specific recommendation, such as the time stamp for when AWS made a specific recommendation.

Members

GenerationTimestamp

Type: string

The time stamp for when AWS made this recommendation.

RecommendationId

Type: string

The ID for this specific recommendation.

ReservationPurchaseRecommendationSummary

Description

A summary about this recommendation, such as the currency code, the amount that AWS estimates that you could save, and the total amount of reservation to purchase.

Members

CurrencyCode

Type: string

The currency code used for this recommendation.

TotalEstimatedMonthlySavingsAmount

Type: string

The total amount that AWS estimates that this recommendation could save you in a month.

TotalEstimatedMonthlySavingsPercentage

Type: string

The total amount that AWS estimates that this recommendation could save you in a month, as a percentage of your costs.

ReservationUtilizationGroup

Description

A group of Reserved Instances (RIs) that share a set of attributes.

Members

Attributes

Type: Associative array of custom strings keys (AttributeType) to strings

The attributes for this group of RIs.

Key

Type: string

The key for a specific RI attribute.

Utilization

Type: ReservationAggregates structure

How much you used this group of RIs.

Value

Type: string

The value of a specific RI attribute.

ResultByTime

Description

The result that is associated with a time period.

Members

Estimated

Type: boolean

Whether this result is estimated.

Groups

Type: Array of Group structures

The groups that are included in this time period.

TimePeriod

Required: Yes
Type: DateInterval structure

The time period covered by a result.

Total

Type: Associative array of custom strings keys (MetricName) to MetricValue structures

The total amount of cost or usage accrued during the time period.

ServiceSpecification

Description

Hardware specifications for the service that you want recommendations for.

Members

EC2Specification

Type: EC2Specification structure

The EC2 hardware specifications that you want AWS to provide recommendations for.

TagValues

Description

The values that are available for a tag.

Members

Key

Type: string

The key for a tag.

Values

Type: Array of strings

The specific value of a tag.

UtilizationByTime

Description

The amount of utilization, in hours.

Members

Groups

Type: Array of ReservationUtilizationGroup structures

The groups that are included in this utilization result.

TimePeriod

Required: Yes
Type: DateInterval structure

The period of time over which this utilization was used.

Total

Type: ReservationAggregates structure

The total number of RI hours that were used.

Namespaces

Classes

Interfaces

Traits

Exceptions

Functions

AWS Cost Explorer Service 2017-10-25

Operation Summary

Operations

GetCostAndUsage

Parameter Syntax

Parameter Details

Members

Result Syntax

Result Details

Members

Errors

GetDimensionValues

Parameter Syntax

Parameter Details

Members

Result Syntax

Result Details

Members

Errors

GetReservationCoverage

Parameter Syntax

Parameter Details

Members

Result Syntax

Result Details

Members

Errors

GetReservationPurchaseRecommendation

Parameter Syntax

Parameter Details

Members

Result Syntax

Result Details

Members

Errors

GetReservationUtilization

Parameter Syntax

Parameter Details

Members

Result Syntax

Result Details

Members

Errors

GetTags

Parameter Syntax

Parameter Details

Members

Result Syntax

Result Details

Members

Errors

Shapes

BillExpirationException

Description

Members

Coverage

Description

Members

CoverageByTime

Description

Members

CoverageHours

Description

Members

DataUnavailableException

Description

Members

DateInterval

Description

Members

DimensionValues

Description

Members

DimensionValuesWithAttributes