CreateAnomalyMonitor

$result = $client->createAnomalyMonitor([/* ... */]);
$promise = $client->createAnomalyMonitorAsync([/* ... */]);

Creates a new cost anomaly detection monitor with the requested type and monitor specification.

Parameter Syntax

$result = $client->createAnomalyMonitor([
    'AnomalyMonitor' => [ // REQUIRED
        'CreationDate' => '<string>',
        'DimensionalValueCount' => <integer>,
        'LastEvaluatedDate' => '<string>',
        'LastUpdatedDate' => '<string>',
        'MonitorArn' => '<string>',
        'MonitorDimension' => 'SERVICE',
        'MonitorName' => '<string>', // REQUIRED
        'MonitorSpecification' => [
            'And' => [
                [...], // RECURSIVE
                // ...
            ],
            'CostCategories' => [
                'Key' => '<string>',
                'MatchOptions' => ['<string>', ...],
                'Values' => ['<string>', ...],
            ],
            'Dimensions' => [
                'Key' => 'AZ|INSTANCE_TYPE|LINKED_ACCOUNT|LINKED_ACCOUNT_NAME|OPERATION|PURCHASE_TYPE|REGION|SERVICE|SERVICE_CODE|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|BILLING_ENTITY|RESERVATION_ID|RESOURCE_ID|RIGHTSIZING_TYPE|SAVINGS_PLANS_TYPE|SAVINGS_PLAN_ARN|PAYMENT_OPTION|AGREEMENT_END_DATE_TIME_AFTER|AGREEMENT_END_DATE_TIME_BEFORE|INVOICING_ENTITY|ANOMALY_TOTAL_IMPACT_ABSOLUTE|ANOMALY_TOTAL_IMPACT_PERCENTAGE',
                'MatchOptions' => ['<string>', ...],
                'Values' => ['<string>', ...],
            ],
            'Not' => [...], // RECURSIVE
            'Or' => [
                [...], // RECURSIVE
                // ...
            ],
            'Tags' => [
                'Key' => '<string>',
                'MatchOptions' => ['<string>', ...],
                'Values' => ['<string>', ...],
            ],
        ],
        'MonitorType' => 'DIMENSIONAL|CUSTOM', // REQUIRED
    ],
    'ResourceTags' => [
        [
            'Key' => '<string>', // REQUIRED
            'Value' => '<string>', // REQUIRED
        ],
        // ...
    ],
]);

Parameter Details

Result Syntax

[
    'MonitorArn' => '<string>',
]

Result Details

Errors

LimitExceededException:

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

CreateAnomalySubscription

$result = $client->createAnomalySubscription([/* ... */]);
$promise = $client->createAnomalySubscriptionAsync([/* ... */]);

Adds an alert subscription to a cost anomaly detection monitor. You can use each subscription to define subscribers with email or SNS notifications. Email subscribers can set an absolute or percentage threshold and a time frequency for receiving notifications.

Parameter Syntax

$result = $client->createAnomalySubscription([
    'AnomalySubscription' => [ // REQUIRED
        'AccountId' => '<string>',
        'Frequency' => 'DAILY|IMMEDIATE|WEEKLY', // REQUIRED
        'MonitorArnList' => ['<string>', ...], // REQUIRED
        'Subscribers' => [ // REQUIRED
            [
                'Address' => '<string>',
                'Status' => 'CONFIRMED|DECLINED',
                'Type' => 'EMAIL|SNS',
            ],
            // ...
        ],
        'SubscriptionArn' => '<string>',
        'SubscriptionName' => '<string>', // REQUIRED
        'Threshold' => <float>,
        'ThresholdExpression' => [
            'And' => [
                [...], // RECURSIVE
                // ...
            ],
            'CostCategories' => [
                'Key' => '<string>',
                'MatchOptions' => ['<string>', ...],
                'Values' => ['<string>', ...],
            ],
            'Dimensions' => [
                'Key' => 'AZ|INSTANCE_TYPE|LINKED_ACCOUNT|LINKED_ACCOUNT_NAME|OPERATION|PURCHASE_TYPE|REGION|SERVICE|SERVICE_CODE|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|BILLING_ENTITY|RESERVATION_ID|RESOURCE_ID|RIGHTSIZING_TYPE|SAVINGS_PLANS_TYPE|SAVINGS_PLAN_ARN|PAYMENT_OPTION|AGREEMENT_END_DATE_TIME_AFTER|AGREEMENT_END_DATE_TIME_BEFORE|INVOICING_ENTITY|ANOMALY_TOTAL_IMPACT_ABSOLUTE|ANOMALY_TOTAL_IMPACT_PERCENTAGE',
                'MatchOptions' => ['<string>', ...],
                'Values' => ['<string>', ...],
            ],
            'Not' => [...], // RECURSIVE
            'Or' => [
                [...], // RECURSIVE
                // ...
            ],
            'Tags' => [
                'Key' => '<string>',
                'MatchOptions' => ['<string>', ...],
                'Values' => ['<string>', ...],
            ],
        ],
    ],
    'ResourceTags' => [
        [
            'Key' => '<string>', // REQUIRED
            'Value' => '<string>', // REQUIRED
        ],
        // ...
    ],
]);

Parameter Details

Result Syntax

[
    'SubscriptionArn' => '<string>',
]

Result Details

Errors

UnknownMonitorException:

The cost anomaly monitor does not exist for the account.

LimitExceededException:

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

CreateCostCategoryDefinition

$result = $client->createCostCategoryDefinition([/* ... */]);
$promise = $client->createCostCategoryDefinitionAsync([/* ... */]);

Creates a new Cost Category with the requested name and rules.

Parameter Syntax

$result = $client->createCostCategoryDefinition([
    'DefaultValue' => '<string>',
    'EffectiveStart' => '<string>',
    'Name' => '<string>', // REQUIRED
    'ResourceTags' => [
        [
            'Key' => '<string>', // REQUIRED
            'Value' => '<string>', // REQUIRED
        ],
        // ...
    ],
    'RuleVersion' => 'CostCategoryExpression.v1', // REQUIRED
    'Rules' => [ // REQUIRED
        [
            'InheritedValue' => [
                'DimensionKey' => '<string>',
                'DimensionName' => 'LINKED_ACCOUNT_NAME|TAG',
            ],
            'Rule' => [
                'And' => [
                    [...], // RECURSIVE
                    // ...
                ],
                'CostCategories' => [
                    'Key' => '<string>',
                    'MatchOptions' => ['<string>', ...],
                    'Values' => ['<string>', ...],
                ],
                'Dimensions' => [
                    'Key' => 'AZ|INSTANCE_TYPE|LINKED_ACCOUNT|LINKED_ACCOUNT_NAME|OPERATION|PURCHASE_TYPE|REGION|SERVICE|SERVICE_CODE|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|BILLING_ENTITY|RESERVATION_ID|RESOURCE_ID|RIGHTSIZING_TYPE|SAVINGS_PLANS_TYPE|SAVINGS_PLAN_ARN|PAYMENT_OPTION|AGREEMENT_END_DATE_TIME_AFTER|AGREEMENT_END_DATE_TIME_BEFORE|INVOICING_ENTITY|ANOMALY_TOTAL_IMPACT_ABSOLUTE|ANOMALY_TOTAL_IMPACT_PERCENTAGE',
                    'MatchOptions' => ['<string>', ...],
                    'Values' => ['<string>', ...],
                ],
                'Not' => [...], // RECURSIVE
                'Or' => [
                    [...], // RECURSIVE
                    // ...
                ],
                'Tags' => [
                    'Key' => '<string>',
                    'MatchOptions' => ['<string>', ...],
                    'Values' => ['<string>', ...],
                ],
            ],
            'Type' => 'REGULAR|INHERITED_VALUE',
            'Value' => '<string>',
        ],
        // ...
    ],
    'SplitChargeRules' => [
        [
            'Method' => 'FIXED|PROPORTIONAL|EVEN', // REQUIRED
            'Parameters' => [
                [
                    'Type' => 'ALLOCATION_PERCENTAGES', // REQUIRED
                    'Values' => ['<string>', ...], // REQUIRED
                ],
                // ...
            ],
            'Source' => '<string>', // REQUIRED
            'Targets' => ['<string>', ...], // REQUIRED
        ],
        // ...
    ],
]);

Parameter Details

Result Syntax

[
    'CostCategoryArn' => '<string>',
    'EffectiveStart' => '<string>',
]

Result Details

Errors

ServiceQuotaExceededException:

You've reached the limit on the number of resources you can create, or exceeded the size of an individual resource.

LimitExceededException:

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

DeleteAnomalyMonitor

$result = $client->deleteAnomalyMonitor([/* ... */]);
$promise = $client->deleteAnomalyMonitorAsync([/* ... */]);

Deletes a cost anomaly monitor.

Parameter Syntax

$result = $client->deleteAnomalyMonitor([
    'MonitorArn' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

[]

Result Details

Errors

LimitExceededException:

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

UnknownMonitorException:

The cost anomaly monitor does not exist for the account.

DeleteAnomalySubscription

$result = $client->deleteAnomalySubscription([/* ... */]);
$promise = $client->deleteAnomalySubscriptionAsync([/* ... */]);

Deletes a cost anomaly subscription.

Parameter Syntax

$result = $client->deleteAnomalySubscription([
    'SubscriptionArn' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

[]

Result Details

Errors

LimitExceededException:

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

UnknownSubscriptionException:

The cost anomaly subscription does not exist for the account.

DeleteCostCategoryDefinition

$result = $client->deleteCostCategoryDefinition([/* ... */]);
$promise = $client->deleteCostCategoryDefinitionAsync([/* ... */]);

Deletes a Cost Category. Expenses from this month going forward will no longer be categorized with this Cost Category.

Parameter Syntax

$result = $client->deleteCostCategoryDefinition([
    'CostCategoryArn' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

[
    'CostCategoryArn' => '<string>',
    'EffectiveEnd' => '<string>',
]

Result Details

Errors

ResourceNotFoundException:

The specified ARN in the request doesn't exist.

LimitExceededException:

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

DescribeCostCategoryDefinition

$result = $client->describeCostCategoryDefinition([/* ... */]);
$promise = $client->describeCostCategoryDefinitionAsync([/* ... */]);

Returns the name, Amazon Resource Name (ARN), rules, definition, and effective dates of a Cost Category that's defined in the account.

You have the option to use EffectiveOn to return a Cost Category that's active on a specific date. If there's no EffectiveOn specified, you see a Cost Category that's effective on the current date. If Cost Category is still effective, EffectiveEnd is omitted in the response.

Parameter Syntax

$result = $client->describeCostCategoryDefinition([
    'CostCategoryArn' => '<string>', // REQUIRED
    'EffectiveOn' => '<string>',
]);

Parameter Details

Result Syntax

[
    'CostCategory' => [
        'CostCategoryArn' => '<string>',
        'DefaultValue' => '<string>',
        'EffectiveEnd' => '<string>',
        'EffectiveStart' => '<string>',
        'Name' => '<string>',
        'ProcessingStatus' => [
            [
                'Component' => 'COST_EXPLORER',
                'Status' => 'PROCESSING|APPLIED',
            ],
            // ...
        ],
        'RuleVersion' => 'CostCategoryExpression.v1',
        'Rules' => [
            [
                'InheritedValue' => [
                    'DimensionKey' => '<string>',
                    'DimensionName' => 'LINKED_ACCOUNT_NAME|TAG',
                ],
                'Rule' => [
                    'And' => [
                        [...], // RECURSIVE
                        // ...
                    ],
                    'CostCategories' => [
                        'Key' => '<string>',
                        'MatchOptions' => ['<string>', ...],
                        'Values' => ['<string>', ...],
                    ],
                    'Dimensions' => [
                        'Key' => 'AZ|INSTANCE_TYPE|LINKED_ACCOUNT|LINKED_ACCOUNT_NAME|OPERATION|PURCHASE_TYPE|REGION|SERVICE|SERVICE_CODE|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|BILLING_ENTITY|RESERVATION_ID|RESOURCE_ID|RIGHTSIZING_TYPE|SAVINGS_PLANS_TYPE|SAVINGS_PLAN_ARN|PAYMENT_OPTION|AGREEMENT_END_DATE_TIME_AFTER|AGREEMENT_END_DATE_TIME_BEFORE|INVOICING_ENTITY|ANOMALY_TOTAL_IMPACT_ABSOLUTE|ANOMALY_TOTAL_IMPACT_PERCENTAGE',
                        'MatchOptions' => ['<string>', ...],
                        'Values' => ['<string>', ...],
                    ],
                    'Not' => [...], // RECURSIVE
                    'Or' => [
                        [...], // RECURSIVE
                        // ...
                    ],
                    'Tags' => [
                        'Key' => '<string>',
                        'MatchOptions' => ['<string>', ...],
                        'Values' => ['<string>', ...],
                    ],
                ],
                'Type' => 'REGULAR|INHERITED_VALUE',
                'Value' => '<string>',
            ],
            // ...
        ],
        'SplitChargeRules' => [
            [
                'Method' => 'FIXED|PROPORTIONAL|EVEN',
                'Parameters' => [
                    [
                        'Type' => 'ALLOCATION_PERCENTAGES',
                        'Values' => ['<string>', ...],
                    ],
                    // ...
                ],
                'Source' => '<string>',
                'Targets' => ['<string>', ...],
            ],
            // ...
        ],
    ],
]

Result Details

Errors

ResourceNotFoundException:

The specified ARN in the request doesn't exist.

LimitExceededException:

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

GetAnomalies

$result = $client->getAnomalies([/* ... */]);
$promise = $client->getAnomaliesAsync([/* ... */]);

Retrieves all of the cost anomalies detected on your account during the time period that's specified by the DateInterval object. Anomalies are available for up to 90 days.

Parameter Syntax

$result = $client->getAnomalies([
    'DateInterval' => [ // REQUIRED
        'EndDate' => '<string>',
        'StartDate' => '<string>', // REQUIRED
    ],
    'Feedback' => 'YES|NO|PLANNED_ACTIVITY',
    'MaxResults' => <integer>,
    'MonitorArn' => '<string>',
    'NextPageToken' => '<string>',
    'TotalImpact' => [
        'EndValue' => <float>,
        'NumericOperator' => 'EQUAL|GREATER_THAN_OR_EQUAL|LESS_THAN_OR_EQUAL|GREATER_THAN|LESS_THAN|BETWEEN', // REQUIRED
        'StartValue' => <float>, // REQUIRED
    ],
]);

Parameter Details

Result Syntax

[
    'Anomalies' => [
        [
            'AnomalyEndDate' => '<string>',
            'AnomalyId' => '<string>',
            'AnomalyScore' => [
                'CurrentScore' => <float>,
                'MaxScore' => <float>,
            ],
            'AnomalyStartDate' => '<string>',
            'DimensionValue' => '<string>',
            'Feedback' => 'YES|NO|PLANNED_ACTIVITY',
            'Impact' => [
                'MaxImpact' => <float>,
                'TotalActualSpend' => <float>,
                'TotalExpectedSpend' => <float>,
                'TotalImpact' => <float>,
                'TotalImpactPercentage' => <float>,
            ],
            'MonitorArn' => '<string>',
            'RootCauses' => [
                [
                    'LinkedAccount' => '<string>',
                    'LinkedAccountName' => '<string>',
                    'Region' => '<string>',
                    'Service' => '<string>',
                    'UsageType' => '<string>',
                ],
                // ...
            ],
        ],
        // ...
    ],
    'NextPageToken' => '<string>',
]

Result Details

Errors

LimitExceededException:

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

InvalidNextTokenException:

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

GetAnomalyMonitors

$result = $client->getAnomalyMonitors([/* ... */]);
$promise = $client->getAnomalyMonitorsAsync([/* ... */]);

Retrieves the cost anomaly monitor definitions for your account. You can filter using a list of cost anomaly monitor Amazon Resource Names (ARNs).

Parameter Syntax

$result = $client->getAnomalyMonitors([
    'MaxResults' => <integer>,
    'MonitorArnList' => ['<string>', ...],
    'NextPageToken' => '<string>',
]);

Parameter Details

Result Syntax

[
    'AnomalyMonitors' => [
        [
            'CreationDate' => '<string>',
            'DimensionalValueCount' => <integer>,
            'LastEvaluatedDate' => '<string>',
            'LastUpdatedDate' => '<string>',
            'MonitorArn' => '<string>',
            'MonitorDimension' => 'SERVICE',
            'MonitorName' => '<string>',
            'MonitorSpecification' => [
                'And' => [
                    [...], // RECURSIVE
                    // ...
                ],
                'CostCategories' => [
                    'Key' => '<string>',
                    'MatchOptions' => ['<string>', ...],
                    'Values' => ['<string>', ...],
                ],
                'Dimensions' => [
                    'Key' => 'AZ|INSTANCE_TYPE|LINKED_ACCOUNT|LINKED_ACCOUNT_NAME|OPERATION|PURCHASE_TYPE|REGION|SERVICE|SERVICE_CODE|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|BILLING_ENTITY|RESERVATION_ID|RESOURCE_ID|RIGHTSIZING_TYPE|SAVINGS_PLANS_TYPE|SAVINGS_PLAN_ARN|PAYMENT_OPTION|AGREEMENT_END_DATE_TIME_AFTER|AGREEMENT_END_DATE_TIME_BEFORE|INVOICING_ENTITY|ANOMALY_TOTAL_IMPACT_ABSOLUTE|ANOMALY_TOTAL_IMPACT_PERCENTAGE',
                    'MatchOptions' => ['<string>', ...],
                    'Values' => ['<string>', ...],
                ],
                'Not' => [...], // RECURSIVE
                'Or' => [
                    [...], // RECURSIVE
                    // ...
                ],
                'Tags' => [
                    'Key' => '<string>',
                    'MatchOptions' => ['<string>', ...],
                    'Values' => ['<string>', ...],
                ],
            ],
            'MonitorType' => 'DIMENSIONAL|CUSTOM',
        ],
        // ...
    ],
    'NextPageToken' => '<string>',
]

Result Details

Errors

LimitExceededException:

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

UnknownMonitorException:

The cost anomaly monitor does not exist for the account.

InvalidNextTokenException:

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

GetAnomalySubscriptions

$result = $client->getAnomalySubscriptions([/* ... */]);
$promise = $client->getAnomalySubscriptionsAsync([/* ... */]);

Retrieves the cost anomaly subscription objects for your account. You can filter using a list of cost anomaly monitor Amazon Resource Names (ARNs).

Parameter Syntax

$result = $client->getAnomalySubscriptions([
    'MaxResults' => <integer>,
    'MonitorArn' => '<string>',
    'NextPageToken' => '<string>',
    'SubscriptionArnList' => ['<string>', ...],
]);

Parameter Details

Result Syntax

[
    'AnomalySubscriptions' => [
        [
            'AccountId' => '<string>',
            'Frequency' => 'DAILY|IMMEDIATE|WEEKLY',
            'MonitorArnList' => ['<string>', ...],
            'Subscribers' => [
                [
                    'Address' => '<string>',
                    'Status' => 'CONFIRMED|DECLINED',
                    'Type' => 'EMAIL|SNS',
                ],
                // ...
            ],
            'SubscriptionArn' => '<string>',
            'SubscriptionName' => '<string>',
            'Threshold' => <float>,
            'ThresholdExpression' => [
                'And' => [
                    [...], // RECURSIVE
                    // ...
                ],
                'CostCategories' => [
                    'Key' => '<string>',
                    'MatchOptions' => ['<string>', ...],
                    'Values' => ['<string>', ...],
                ],
                'Dimensions' => [
                    'Key' => 'AZ|INSTANCE_TYPE|LINKED_ACCOUNT|LINKED_ACCOUNT_NAME|OPERATION|PURCHASE_TYPE|REGION|SERVICE|SERVICE_CODE|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|BILLING_ENTITY|RESERVATION_ID|RESOURCE_ID|RIGHTSIZING_TYPE|SAVINGS_PLANS_TYPE|SAVINGS_PLAN_ARN|PAYMENT_OPTION|AGREEMENT_END_DATE_TIME_AFTER|AGREEMENT_END_DATE_TIME_BEFORE|INVOICING_ENTITY|ANOMALY_TOTAL_IMPACT_ABSOLUTE|ANOMALY_TOTAL_IMPACT_PERCENTAGE',
                    'MatchOptions' => ['<string>', ...],
                    'Values' => ['<string>', ...],
                ],
                'Not' => [...], // RECURSIVE
                'Or' => [
                    [...], // RECURSIVE
                    // ...
                ],
                'Tags' => [
                    'Key' => '<string>',
                    'MatchOptions' => ['<string>', ...],
                    'Values' => ['<string>', ...],
                ],
            ],
        ],
        // ...
    ],
    'NextPageToken' => '<string>',
]

Result Details

Errors

LimitExceededException:

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

UnknownSubscriptionException:

The cost anomaly subscription does not exist for the account.

InvalidNextTokenException:

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

GetApproximateUsageRecords

$result = $client->getApproximateUsageRecords([/* ... */]);
$promise = $client->getApproximateUsageRecordsAsync([/* ... */]);

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

Parameter Syntax

$result = $client->getApproximateUsageRecords([
    'ApproximationDimension' => 'SERVICE|RESOURCE', // REQUIRED
    'Granularity' => 'DAILY|MONTHLY|HOURLY', // REQUIRED
    'Services' => ['<string>', ...],
]);

Parameter Details

Result Syntax

[
    'LookbackPeriod' => [
        'End' => '<string>',
        'Start' => '<string>',
    ],
    'Services' => [<integer>, ...],
    'TotalRecords' => <integer>,
]

Result Details

Errors

LimitExceededException:

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

DataUnavailableException:

The requested data is unavailable.

GetCostAndUsage

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

Retrieves cost and usage metrics for your account. You can specify which cost and usage-related metric that you want the request to return. For example, you can specify BlendedCosts or UsageQuantity. 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. Management account in an organization in Organizations have access to all member accounts.

For information about filter limitations, see Quotas and restrictions in the Billing and Cost Management User Guide.

Parameter Syntax

$result = $client->getCostAndUsage([
    'Filter' => [
        'And' => [
            [...], // RECURSIVE
            // ...
        ],
        'CostCategories' => [
            'Key' => '<string>',
            'MatchOptions' => ['<string>', ...],
            'Values' => ['<string>', ...],
        ],
        'Dimensions' => [
            'Key' => 'AZ|INSTANCE_TYPE|LINKED_ACCOUNT|LINKED_ACCOUNT_NAME|OPERATION|PURCHASE_TYPE|REGION|SERVICE|SERVICE_CODE|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|BILLING_ENTITY|RESERVATION_ID|RESOURCE_ID|RIGHTSIZING_TYPE|SAVINGS_PLANS_TYPE|SAVINGS_PLAN_ARN|PAYMENT_OPTION|AGREEMENT_END_DATE_TIME_AFTER|AGREEMENT_END_DATE_TIME_BEFORE|INVOICING_ENTITY|ANOMALY_TOTAL_IMPACT_ABSOLUTE|ANOMALY_TOTAL_IMPACT_PERCENTAGE',
            'MatchOptions' => ['<string>', ...],
            'Values' => ['<string>', ...],
        ],
        'Not' => [...], // RECURSIVE
        'Or' => [
            [...], // RECURSIVE
            // ...
        ],
        'Tags' => [
            'Key' => '<string>',
            'MatchOptions' => ['<string>', ...],
            'Values' => ['<string>', ...],
        ],
    ],
    'Granularity' => 'DAILY|MONTHLY|HOURLY', // REQUIRED
    'GroupBy' => [
        [
            'Key' => '<string>',
            'Type' => 'DIMENSION|TAG|COST_CATEGORY',
        ],
        // ...
    ],
    'Metrics' => ['<string>', ...], // REQUIRED
    'NextPageToken' => '<string>',
    'TimePeriod' => [ // REQUIRED
        'End' => '<string>', // REQUIRED
        'Start' => '<string>', // REQUIRED
    ],
]);

Parameter Details

Result Syntax

[
    'DimensionValueAttributes' => [
        [
            'Attributes' => ['<string>', ...],
            'Value' => '<string>',
        ],
        // ...
    ],
    'GroupDefinitions' => [
        [
            'Key' => '<string>',
            'Type' => 'DIMENSION|TAG|COST_CATEGORY',
        ],
        // ...
    ],
    '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

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.

GetCostAndUsageWithResources

$result = $client->getCostAndUsageWithResources([/* ... */]);
$promise = $client->getCostAndUsageWithResourcesAsync([/* ... */]);

Retrieves cost and usage metrics with resources 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. Management account in an organization in Organizations have access to all member accounts.

Hourly granularity is only available for EC2-Instances (Elastic Compute Cloud) resource-level data. All other resource-level data is available at daily granularity.

Parameter Syntax

$result = $client->getCostAndUsageWithResources([
    'Filter' => [ // REQUIRED
        'And' => [
            [...], // RECURSIVE
            // ...
        ],
        'CostCategories' => [
            'Key' => '<string>',
            'MatchOptions' => ['<string>', ...],
            'Values' => ['<string>', ...],
        ],
        'Dimensions' => [
            'Key' => 'AZ|INSTANCE_TYPE|LINKED_ACCOUNT|LINKED_ACCOUNT_NAME|OPERATION|PURCHASE_TYPE|REGION|SERVICE|SERVICE_CODE|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|BILLING_ENTITY|RESERVATION_ID|RESOURCE_ID|RIGHTSIZING_TYPE|SAVINGS_PLANS_TYPE|SAVINGS_PLAN_ARN|PAYMENT_OPTION|AGREEMENT_END_DATE_TIME_AFTER|AGREEMENT_END_DATE_TIME_BEFORE|INVOICING_ENTITY|ANOMALY_TOTAL_IMPACT_ABSOLUTE|ANOMALY_TOTAL_IMPACT_PERCENTAGE',
            'MatchOptions' => ['<string>', ...],
            'Values' => ['<string>', ...],
        ],
        'Not' => [...], // RECURSIVE
        'Or' => [
            [...], // RECURSIVE
            // ...
        ],
        'Tags' => [
            'Key' => '<string>',
            'MatchOptions' => ['<string>', ...],
            'Values' => ['<string>', ...],
        ],
    ],
    'Granularity' => 'DAILY|MONTHLY|HOURLY', // REQUIRED
    'GroupBy' => [
        [
            'Key' => '<string>',
            'Type' => 'DIMENSION|TAG|COST_CATEGORY',
        ],
        // ...
    ],
    'Metrics' => ['<string>', ...],
    'NextPageToken' => '<string>',
    'TimePeriod' => [ // REQUIRED
        'End' => '<string>', // REQUIRED
        'Start' => '<string>', // REQUIRED
    ],
]);

Parameter Details

Result Syntax

[
    'DimensionValueAttributes' => [
        [
            'Attributes' => ['<string>', ...],
            'Value' => '<string>',
        ],
        // ...
    ],
    'GroupDefinitions' => [
        [
            'Key' => '<string>',
            'Type' => 'DIMENSION|TAG|COST_CATEGORY',
        ],
        // ...
    ],
    '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

Errors

DataUnavailableException:

The requested data is unavailable.

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.

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.

GetCostCategories

$result = $client->getCostCategories([/* ... */]);
$promise = $client->getCostCategoriesAsync([/* ... */]);

Retrieves an array of Cost Category names and values incurred cost.

Parameter Syntax

$result = $client->getCostCategories([
    'CostCategoryName' => '<string>',
    'Filter' => [
        'And' => [
            [...], // RECURSIVE
            // ...
        ],
        'CostCategories' => [
            'Key' => '<string>',
            'MatchOptions' => ['<string>', ...],
            'Values' => ['<string>', ...],
        ],
        'Dimensions' => [
            'Key' => 'AZ|INSTANCE_TYPE|LINKED_ACCOUNT|LINKED_ACCOUNT_NAME|OPERATION|PURCHASE_TYPE|REGION|SERVICE|SERVICE_CODE|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|BILLING_ENTITY|RESERVATION_ID|RESOURCE_ID|RIGHTSIZING_TYPE|SAVINGS_PLANS_TYPE|SAVINGS_PLAN_ARN|PAYMENT_OPTION|AGREEMENT_END_DATE_TIME_AFTER|AGREEMENT_END_DATE_TIME_BEFORE|INVOICING_ENTITY|ANOMALY_TOTAL_IMPACT_ABSOLUTE|ANOMALY_TOTAL_IMPACT_PERCENTAGE',
            'MatchOptions' => ['<string>', ...],
            'Values' => ['<string>', ...],
        ],
        'Not' => [...], // RECURSIVE
        'Or' => [
            [...], // RECURSIVE
            // ...
        ],
        'Tags' => [
            'Key' => '<string>',
            'MatchOptions' => ['<string>', ...],
            'Values' => ['<string>', ...],
        ],
    ],
    'MaxResults' => <integer>,
    'NextPageToken' => '<string>',
    'SearchString' => '<string>',
    'SortBy' => [
        [
            'Key' => '<string>', // REQUIRED
            'SortOrder' => 'ASCENDING|DESCENDING',
        ],
        // ...
    ],
    'TimePeriod' => [ // REQUIRED
        'End' => '<string>', // REQUIRED
        'Start' => '<string>', // REQUIRED
    ],
]);

Parameter Details

Result Syntax

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

Result Details

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.

GetCostForecast

$result = $client->getCostForecast([/* ... */]);
$promise = $client->getCostForecastAsync([/* ... */]);

Retrieves a forecast for how much Amazon Web Services predicts that you will spend over the forecast time period that you select, based on your past costs.

Parameter Syntax

$result = $client->getCostForecast([
    'Filter' => [
        'And' => [
            [...], // RECURSIVE
            // ...
        ],
        'CostCategories' => [
            'Key' => '<string>',
            'MatchOptions' => ['<string>', ...],
            'Values' => ['<string>', ...],
        ],
        'Dimensions' => [
            'Key' => 'AZ|INSTANCE_TYPE|LINKED_ACCOUNT|LINKED_ACCOUNT_NAME|OPERATION|PURCHASE_TYPE|REGION|SERVICE|SERVICE_CODE|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|BILLING_ENTITY|RESERVATION_ID|RESOURCE_ID|RIGHTSIZING_TYPE|SAVINGS_PLANS_TYPE|SAVINGS_PLAN_ARN|PAYMENT_OPTION|AGREEMENT_END_DATE_TIME_AFTER|AGREEMENT_END_DATE_TIME_BEFORE|INVOICING_ENTITY|ANOMALY_TOTAL_IMPACT_ABSOLUTE|ANOMALY_TOTAL_IMPACT_PERCENTAGE',
            'MatchOptions' => ['<string>', ...],
            'Values' => ['<string>', ...],
        ],
        'Not' => [...], // RECURSIVE
        'Or' => [
            [...], // RECURSIVE
            // ...
        ],
        'Tags' => [
            'Key' => '<string>',
            'MatchOptions' => ['<string>', ...],
            'Values' => ['<string>', ...],
        ],
    ],
    'Granularity' => 'DAILY|MONTHLY|HOURLY', // REQUIRED
    'Metric' => 'BLENDED_COST|UNBLENDED_COST|AMORTIZED_COST|NET_UNBLENDED_COST|NET_AMORTIZED_COST|USAGE_QUANTITY|NORMALIZED_USAGE_AMOUNT', // REQUIRED
    'PredictionIntervalLevel' => <integer>,
    'TimePeriod' => [ // REQUIRED
        'End' => '<string>', // REQUIRED
        'Start' => '<string>', // REQUIRED
    ],
]);

Parameter Details

Result Syntax

[
    'ForecastResultsByTime' => [
        [
            'MeanValue' => '<string>',
            'PredictionIntervalLowerBound' => '<string>',
            'PredictionIntervalUpperBound' => '<string>',
            'TimePeriod' => [
                'End' => '<string>',
                'Start' => '<string>',
            ],
        ],
        // ...
    ],
    'Total' => [
        'Amount' => '<string>',
        'Unit' => '<string>',
    ],
]

Result Details

Errors

LimitExceededException:

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

DataUnavailableException:

The requested data is unavailable.

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|SAVINGS_PLANS',
    'Dimension' => 'AZ|INSTANCE_TYPE|LINKED_ACCOUNT|LINKED_ACCOUNT_NAME|OPERATION|PURCHASE_TYPE|REGION|SERVICE|SERVICE_CODE|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|BILLING_ENTITY|RESERVATION_ID|RESOURCE_ID|RIGHTSIZING_TYPE|SAVINGS_PLANS_TYPE|SAVINGS_PLAN_ARN|PAYMENT_OPTION|AGREEMENT_END_DATE_TIME_AFTER|AGREEMENT_END_DATE_TIME_BEFORE|INVOICING_ENTITY|ANOMALY_TOTAL_IMPACT_ABSOLUTE|ANOMALY_TOTAL_IMPACT_PERCENTAGE', // REQUIRED
    'Filter' => [
        'And' => [
            [...], // RECURSIVE
            // ...
        ],
        'CostCategories' => [
            'Key' => '<string>',
            'MatchOptions' => ['<string>', ...],
            'Values' => ['<string>', ...],
        ],
        'Dimensions' => [
            'Key' => 'AZ|INSTANCE_TYPE|LINKED_ACCOUNT|LINKED_ACCOUNT_NAME|OPERATION|PURCHASE_TYPE|REGION|SERVICE|SERVICE_CODE|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|BILLING_ENTITY|RESERVATION_ID|RESOURCE_ID|RIGHTSIZING_TYPE|SAVINGS_PLANS_TYPE|SAVINGS_PLAN_ARN|PAYMENT_OPTION|AGREEMENT_END_DATE_TIME_AFTER|AGREEMENT_END_DATE_TIME_BEFORE|INVOICING_ENTITY|ANOMALY_TOTAL_IMPACT_ABSOLUTE|ANOMALY_TOTAL_IMPACT_PERCENTAGE',
            'MatchOptions' => ['<string>', ...],
            'Values' => ['<string>', ...],
        ],
        'Not' => [...], // RECURSIVE
        'Or' => [
            [...], // RECURSIVE
            // ...
        ],
        'Tags' => [
            'Key' => '<string>',
            'MatchOptions' => ['<string>', ...],
            'Values' => ['<string>', ...],
        ],
    ],
    'MaxResults' => <integer>,
    'NextPageToken' => '<string>',
    'SearchString' => '<string>',
    'SortBy' => [
        [
            'Key' => '<string>', // REQUIRED
            'SortOrder' => 'ASCENDING|DESCENDING',
        ],
        // ...
    ],
    'TimePeriod' => [ // REQUIRED
        'End' => '<string>', // REQUIRED
        'Start' => '<string>', // REQUIRED
    ],
]);

Parameter Details

Result Syntax

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

Result Details

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, which you can use 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 management account can see the coverage of the associated member accounts. This supports dimensions, Cost Categories, and nested expressions. 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
            // ...
        ],
        'CostCategories' => [
            'Key' => '<string>',
            'MatchOptions' => ['<string>', ...],
            'Values' => ['<string>', ...],
        ],
        'Dimensions' => [
            'Key' => 'AZ|INSTANCE_TYPE|LINKED_ACCOUNT|LINKED_ACCOUNT_NAME|OPERATION|PURCHASE_TYPE|REGION|SERVICE|SERVICE_CODE|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|BILLING_ENTITY|RESERVATION_ID|RESOURCE_ID|RIGHTSIZING_TYPE|SAVINGS_PLANS_TYPE|SAVINGS_PLAN_ARN|PAYMENT_OPTION|AGREEMENT_END_DATE_TIME_AFTER|AGREEMENT_END_DATE_TIME_BEFORE|INVOICING_ENTITY|ANOMALY_TOTAL_IMPACT_ABSOLUTE|ANOMALY_TOTAL_IMPACT_PERCENTAGE',
            'MatchOptions' => ['<string>', ...],
            'Values' => ['<string>', ...],
        ],
        'Not' => [...], // RECURSIVE
        'Or' => [
            [...], // RECURSIVE
            // ...
        ],
        'Tags' => [
            'Key' => '<string>',
            'MatchOptions' => ['<string>', ...],
            'Values' => ['<string>', ...],
        ],
    ],
    'Granularity' => 'DAILY|MONTHLY|HOURLY',
    'GroupBy' => [
        [
            'Key' => '<string>',
            'Type' => 'DIMENSION|TAG|COST_CATEGORY',
        ],
        // ...
    ],
    'MaxResults' => <integer>,
    'Metrics' => ['<string>', ...],
    'NextPageToken' => '<string>',
    'SortBy' => [
        'Key' => '<string>', // REQUIRED
        'SortOrder' => 'ASCENDING|DESCENDING',
    ],
    'TimePeriod' => [ // REQUIRED
        'End' => '<string>', // REQUIRED
        'Start' => '<string>', // REQUIRED
    ],
]);

Parameter Details

Result Syntax

[
    'CoveragesByTime' => [
        [
            'Groups' => [
                [
                    'Attributes' => ['<string>', ...],
                    'Coverage' => [
                        'CoverageCost' => [
                            'OnDemandCost' => '<string>',
                        ],
                        'CoverageHours' => [
                            'CoverageHoursPercentage' => '<string>',
                            'OnDemandHours' => '<string>',
                            'ReservedHours' => '<string>',
                            'TotalRunningHours' => '<string>',
                        ],
                        'CoverageNormalizedUnits' => [
                            'CoverageNormalizedUnitsPercentage' => '<string>',
                            'OnDemandNormalizedUnits' => '<string>',
                            'ReservedNormalizedUnits' => '<string>',
                            'TotalRunningNormalizedUnits' => '<string>',
                        ],
                    ],
                ],
                // ...
            ],
            'TimePeriod' => [
                'End' => '<string>',
                'Start' => '<string>',
            ],
            'Total' => [
                'CoverageCost' => [
                    'OnDemandCost' => '<string>',
                ],
                'CoverageHours' => [
                    'CoverageHoursPercentage' => '<string>',
                    'OnDemandHours' => '<string>',
                    'ReservedHours' => '<string>',
                    'TotalRunningHours' => '<string>',
                ],
                'CoverageNormalizedUnits' => [
                    'CoverageNormalizedUnitsPercentage' => '<string>',
                    'OnDemandNormalizedUnits' => '<string>',
                    'ReservedNormalizedUnits' => '<string>',
                    'TotalRunningNormalizedUnits' => '<string>',
                ],
            ],
        ],
        // ...
    ],
    'NextPageToken' => '<string>',
    'Total' => [
        'CoverageCost' => [
            'OnDemandCost' => '<string>',
        ],
        'CoverageHours' => [
            'CoverageHoursPercentage' => '<string>',
            'OnDemandHours' => '<string>',
            'ReservedHours' => '<string>',
            'TotalRunningHours' => '<string>',
        ],
        'CoverageNormalizedUnits' => [
            'CoverageNormalizedUnitsPercentage' => '<string>',
            'OnDemandNormalizedUnits' => '<string>',
            'ReservedNormalizedUnits' => '<string>',
            'TotalRunningNormalizedUnits' => '<string>',
        ],
    ],
]

Result Details

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 reservation purchases. These recommendations might help you to reduce your costs. Reservations provide a discounted hourly rate (up to 75%) compared to On-Demand pricing.

Amazon Web Services 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 Amazon Web Services has these categories, it simulates every combination of reservations in each category of usage to identify the best number of each type of Reserved Instance (RI) to purchase to maximize your estimated savings.

For example, Amazon Web Services automatically aggregates your Amazon 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. Amazon Web Services recommends the smallest size instance in an instance family. This makes it easier to purchase a size-flexible Reserved Instance (RI). Amazon Web Services also shows the equal number of normalized units. This way, you can purchase any instance size that you want. For this example, your RI recommendation is 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',
    'Filter' => [
        'And' => [
            [...], // RECURSIVE
            // ...
        ],
        'CostCategories' => [
            'Key' => '<string>',
            'MatchOptions' => ['<string>', ...],
            'Values' => ['<string>', ...],
        ],
        'Dimensions' => [
            'Key' => 'AZ|INSTANCE_TYPE|LINKED_ACCOUNT|LINKED_ACCOUNT_NAME|OPERATION|PURCHASE_TYPE|REGION|SERVICE|SERVICE_CODE|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|BILLING_ENTITY|RESERVATION_ID|RESOURCE_ID|RIGHTSIZING_TYPE|SAVINGS_PLANS_TYPE|SAVINGS_PLAN_ARN|PAYMENT_OPTION|AGREEMENT_END_DATE_TIME_AFTER|AGREEMENT_END_DATE_TIME_BEFORE|INVOICING_ENTITY|ANOMALY_TOTAL_IMPACT_ABSOLUTE|ANOMALY_TOTAL_IMPACT_PERCENTAGE',
            'MatchOptions' => ['<string>', ...],
            'Values' => ['<string>', ...],
        ],
        'Not' => [...], // RECURSIVE
        'Or' => [
            [...], // RECURSIVE
            // ...
        ],
        'Tags' => [
            'Key' => '<string>',
            'MatchOptions' => ['<string>', ...],
            'Values' => ['<string>', ...],
        ],
    ],
    '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

Result Syntax

[
    'Metadata' => [
        'AdditionalMetadata' => '<string>',
        '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' => [
                [
                    'AccountId' => '<string>',
                    'AverageNormalizedUnitsUsedPerHour' => '<string>',
                    'AverageNumberOfCapacityUnitsUsedPerHour' => '<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,
                        ],
                        'MemoryDBInstanceDetails' => [
                            'CurrentGeneration' => true || false,
                            'Family' => '<string>',
                            'NodeType' => '<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>',
                    'MaximumNumberOfCapacityUnitsUsedPerHour' => '<string>',
                    'MaximumNumberOfInstancesUsedPerHour' => '<string>',
                    'MinimumNormalizedUnitsUsedPerHour' => '<string>',
                    'MinimumNumberOfCapacityUnitsUsedPerHour' => '<string>',
                    'MinimumNumberOfInstancesUsedPerHour' => '<string>',
                    'RecommendedNormalizedUnitsToPurchase' => '<string>',
                    'RecommendedNumberOfCapacityUnitsToPurchase' => '<string>',
                    'RecommendedNumberOfInstancesToPurchase' => '<string>',
                    'RecurringStandardMonthlyCost' => '<string>',
                    'ReservedCapacityDetails' => [
                        'DynamoDBCapacityDetails' => [
                            'CapacityUnits' => '<string>',
                            'Region' => '<string>',
                        ],
                    ],
                    'UpfrontCost' => '<string>',
                ],
                // ...
            ],
            'RecommendationSummary' => [
                'CurrencyCode' => '<string>',
                'TotalEstimatedMonthlySavingsAmount' => '<string>',
                'TotalEstimatedMonthlySavingsPercentage' => '<string>',
            ],
            'ServiceSpecification' => [
                'EC2Specification' => [
                    'OfferingClass' => 'STANDARD|CONVERTIBLE',
                ],
            ],
            'TermInYears' => 'ONE_YEAR|THREE_YEARS',
        ],
        // ...
    ],
]

Result Details

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. Management account 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
            // ...
        ],
        'CostCategories' => [
            'Key' => '<string>',
            'MatchOptions' => ['<string>', ...],
            'Values' => ['<string>', ...],
        ],
        'Dimensions' => [
            'Key' => 'AZ|INSTANCE_TYPE|LINKED_ACCOUNT|LINKED_ACCOUNT_NAME|OPERATION|PURCHASE_TYPE|REGION|SERVICE|SERVICE_CODE|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|BILLING_ENTITY|RESERVATION_ID|RESOURCE_ID|RIGHTSIZING_TYPE|SAVINGS_PLANS_TYPE|SAVINGS_PLAN_ARN|PAYMENT_OPTION|AGREEMENT_END_DATE_TIME_AFTER|AGREEMENT_END_DATE_TIME_BEFORE|INVOICING_ENTITY|ANOMALY_TOTAL_IMPACT_ABSOLUTE|ANOMALY_TOTAL_IMPACT_PERCENTAGE',
            'MatchOptions' => ['<string>', ...],
            'Values' => ['<string>', ...],
        ],
        'Not' => [...], // RECURSIVE
        'Or' => [
            [...], // RECURSIVE
            // ...
        ],
        'Tags' => [
            'Key' => '<string>',
            'MatchOptions' => ['<string>', ...],
            'Values' => ['<string>', ...],
        ],
    ],
    'Granularity' => 'DAILY|MONTHLY|HOURLY',
    'GroupBy' => [
        [
            'Key' => '<string>',
            'Type' => 'DIMENSION|TAG|COST_CATEGORY',
        ],
        // ...
    ],
    'MaxResults' => <integer>,
    'NextPageToken' => '<string>',
    'SortBy' => [
        'Key' => '<string>', // REQUIRED
        'SortOrder' => 'ASCENDING|DESCENDING',
    ],
    'TimePeriod' => [ // REQUIRED
        'End' => '<string>', // REQUIRED
        'Start' => '<string>', // REQUIRED
    ],
]);

Parameter Details

Result Syntax

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

Result Details

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.

GetRightsizingRecommendation

$result = $client->getRightsizingRecommendation([/* ... */]);
$promise = $client->getRightsizingRecommendationAsync([/* ... */]);

Creates recommendations that help you save cost by identifying idle and underutilized Amazon EC2 instances.

Recommendations are generated to either downsize or terminate instances, along with providing savings detail and metrics. For more information about calculation and function, see Optimizing Your Cost with Rightsizing Recommendations in the Billing and Cost Management User Guide.

Parameter Syntax

$result = $client->getRightsizingRecommendation([
    'Configuration' => [
        'BenefitsConsidered' => true || false, // REQUIRED
        'RecommendationTarget' => 'SAME_INSTANCE_FAMILY|CROSS_INSTANCE_FAMILY', // REQUIRED
    ],
    'Filter' => [
        'And' => [
            [...], // RECURSIVE
            // ...
        ],
        'CostCategories' => [
            'Key' => '<string>',
            'MatchOptions' => ['<string>', ...],
            'Values' => ['<string>', ...],
        ],
        'Dimensions' => [
            'Key' => 'AZ|INSTANCE_TYPE|LINKED_ACCOUNT|LINKED_ACCOUNT_NAME|OPERATION|PURCHASE_TYPE|REGION|SERVICE|SERVICE_CODE|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|BILLING_ENTITY|RESERVATION_ID|RESOURCE_ID|RIGHTSIZING_TYPE|SAVINGS_PLANS_TYPE|SAVINGS_PLAN_ARN|PAYMENT_OPTION|AGREEMENT_END_DATE_TIME_AFTER|AGREEMENT_END_DATE_TIME_BEFORE|INVOICING_ENTITY|ANOMALY_TOTAL_IMPACT_ABSOLUTE|ANOMALY_TOTAL_IMPACT_PERCENTAGE',
            'MatchOptions' => ['<string>', ...],
            'Values' => ['<string>', ...],
        ],
        'Not' => [...], // RECURSIVE
        'Or' => [
            [...], // RECURSIVE
            // ...
        ],
        'Tags' => [
            'Key' => '<string>',
            'MatchOptions' => ['<string>', ...],
            'Values' => ['<string>', ...],
        ],
    ],
    'NextPageToken' => '<string>',
    'PageSize' => <integer>,
    'Service' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

[
    'Configuration' => [
        'BenefitsConsidered' => true || false,
        'RecommendationTarget' => 'SAME_INSTANCE_FAMILY|CROSS_INSTANCE_FAMILY',
    ],
    'Metadata' => [
        'AdditionalMetadata' => '<string>',
        'GenerationTimestamp' => '<string>',
        'LookbackPeriodInDays' => 'SEVEN_DAYS|THIRTY_DAYS|SIXTY_DAYS',
        'RecommendationId' => '<string>',
    ],
    'NextPageToken' => '<string>',
    'RightsizingRecommendations' => [
        [
            'AccountId' => '<string>',
            'CurrentInstance' => [
                'CurrencyCode' => '<string>',
                'InstanceName' => '<string>',
                'MonthlyCost' => '<string>',
                'OnDemandHoursInLookbackPeriod' => '<string>',
                'ReservationCoveredHoursInLookbackPeriod' => '<string>',
                'ResourceDetails' => [
                    'EC2ResourceDetails' => [
                        'HourlyOnDemandRate' => '<string>',
                        'InstanceType' => '<string>',
                        'Memory' => '<string>',
                        'NetworkPerformance' => '<string>',
                        'Platform' => '<string>',
                        'Region' => '<string>',
                        'Sku' => '<string>',
                        'Storage' => '<string>',
                        'Vcpu' => '<string>',
                    ],
                ],
                'ResourceId' => '<string>',
                'ResourceUtilization' => [
                    'EC2ResourceUtilization' => [
                        'DiskResourceUtilization' => [
                            'DiskReadBytesPerSecond' => '<string>',
                            'DiskReadOpsPerSecond' => '<string>',
                            'DiskWriteBytesPerSecond' => '<string>',
                            'DiskWriteOpsPerSecond' => '<string>',
                        ],
                        'EBSResourceUtilization' => [
                            'EbsReadBytesPerSecond' => '<string>',
                            'EbsReadOpsPerSecond' => '<string>',
                            'EbsWriteBytesPerSecond' => '<string>',
                            'EbsWriteOpsPerSecond' => '<string>',
                        ],
                        'MaxCpuUtilizationPercentage' => '<string>',
                        'MaxMemoryUtilizationPercentage' => '<string>',
                        'MaxStorageUtilizationPercentage' => '<string>',
                        'NetworkResourceUtilization' => [
                            'NetworkInBytesPerSecond' => '<string>',
                            'NetworkOutBytesPerSecond' => '<string>',
                            'NetworkPacketsInPerSecond' => '<string>',
                            'NetworkPacketsOutPerSecond' => '<string>',
                        ],
                    ],
                ],
                'SavingsPlansCoveredHoursInLookbackPeriod' => '<string>',
                'Tags' => [
                    [
                        'Key' => '<string>',
                        'MatchOptions' => ['<string>', ...],
                        'Values' => ['<string>', ...],
                    ],
                    // ...
                ],
                'TotalRunningHoursInLookbackPeriod' => '<string>',
            ],
            'FindingReasonCodes' => ['<string>', ...],
            'ModifyRecommendationDetail' => [
                'TargetInstances' => [
                    [
                        'CurrencyCode' => '<string>',
                        'DefaultTargetInstance' => true || false,
                        'EstimatedMonthlyCost' => '<string>',
                        'EstimatedMonthlySavings' => '<string>',
                        'ExpectedResourceUtilization' => [
                            'EC2ResourceUtilization' => [
                                'DiskResourceUtilization' => [
                                    'DiskReadBytesPerSecond' => '<string>',
                                    'DiskReadOpsPerSecond' => '<string>',
                                    'DiskWriteBytesPerSecond' => '<string>',
                                    'DiskWriteOpsPerSecond' => '<string>',
                                ],
                                'EBSResourceUtilization' => [
                                    'EbsReadBytesPerSecond' => '<string>',
                                    'EbsReadOpsPerSecond' => '<string>',
                                    'EbsWriteBytesPerSecond' => '<string>',
                                    'EbsWriteOpsPerSecond' => '<string>',
                                ],
                                'MaxCpuUtilizationPercentage' => '<string>',
                                'MaxMemoryUtilizationPercentage' => '<string>',
                                'MaxStorageUtilizationPercentage' => '<string>',
                                'NetworkResourceUtilization' => [
                                    'NetworkInBytesPerSecond' => '<string>',
                                    'NetworkOutBytesPerSecond' => '<string>',
                                    'NetworkPacketsInPerSecond' => '<string>',
                                    'NetworkPacketsOutPerSecond' => '<string>',
                                ],
                            ],
                        ],
                        'PlatformDifferences' => ['<string>', ...],
                        'ResourceDetails' => [
                            'EC2ResourceDetails' => [
                                'HourlyOnDemandRate' => '<string>',
                                'InstanceType' => '<string>',
                                'Memory' => '<string>',
                                'NetworkPerformance' => '<string>',
                                'Platform' => '<string>',
                                'Region' => '<string>',
                                'Sku' => '<string>',
                                'Storage' => '<string>',
                                'Vcpu' => '<string>',
                            ],
                        ],
                    ],
                    // ...
                ],
            ],
            'RightsizingType' => 'TERMINATE|MODIFY',
            'TerminateRecommendationDetail' => [
                'CurrencyCode' => '<string>',
                'EstimatedMonthlySavings' => '<string>',
            ],
        ],
        // ...
    ],
    'Summary' => [
        'EstimatedTotalMonthlySavingsAmount' => '<string>',
        'SavingsCurrencyCode' => '<string>',
        'SavingsPercentage' => '<string>',
        'TotalRecommendationCount' => '<string>',
    ],
]

Result Details

Errors

LimitExceededException:

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

InvalidNextTokenException:

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

GetSavingsPlanPurchaseRecommendationDetails

$result = $client->getSavingsPlanPurchaseRecommendationDetails([/* ... */]);
$promise = $client->getSavingsPlanPurchaseRecommendationDetailsAsync([/* ... */]);

Retrieves the details for a Savings Plan recommendation. These details include the hourly data-points that construct the cost, coverage, and utilization charts.

Parameter Syntax

$result = $client->getSavingsPlanPurchaseRecommendationDetails([
    'RecommendationDetailId' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

[
    'RecommendationDetailData' => [
        'AccountId' => '<string>',
        'AccountScope' => 'PAYER|LINKED',
        'CurrencyCode' => '<string>',
        'CurrentAverageCoverage' => '<string>',
        'CurrentAverageHourlyOnDemandSpend' => '<string>',
        'CurrentMaximumHourlyOnDemandSpend' => '<string>',
        'CurrentMinimumHourlyOnDemandSpend' => '<string>',
        'EstimatedAverageCoverage' => '<string>',
        'EstimatedAverageUtilization' => '<string>',
        'EstimatedMonthlySavingsAmount' => '<string>',
        'EstimatedOnDemandCost' => '<string>',
        'EstimatedOnDemandCostWithCurrentCommitment' => '<string>',
        'EstimatedROI' => '<string>',
        'EstimatedSPCost' => '<string>',
        'EstimatedSavingsAmount' => '<string>',
        'EstimatedSavingsPercentage' => '<string>',
        'ExistingHourlyCommitment' => '<string>',
        'GenerationTimestamp' => '<string>',
        'HourlyCommitmentToPurchase' => '<string>',
        'InstanceFamily' => '<string>',
        'LatestUsageTimestamp' => '<string>',
        'LookbackPeriodInDays' => 'SEVEN_DAYS|THIRTY_DAYS|SIXTY_DAYS',
        'MetricsOverLookbackPeriod' => [
            [
                'CurrentCoverage' => '<string>',
                'EstimatedCoverage' => '<string>',
                'EstimatedNewCommitmentUtilization' => '<string>',
                'EstimatedOnDemandCost' => '<string>',
                'StartTime' => '<string>',
            ],
            // ...
        ],
        'OfferingId' => '<string>',
        'PaymentOption' => 'NO_UPFRONT|PARTIAL_UPFRONT|ALL_UPFRONT|LIGHT_UTILIZATION|MEDIUM_UTILIZATION|HEAVY_UTILIZATION',
        'Region' => '<string>',
        'SavingsPlansType' => 'COMPUTE_SP|EC2_INSTANCE_SP|SAGEMAKER_SP',
        'TermInYears' => 'ONE_YEAR|THREE_YEARS',
        'UpfrontCost' => '<string>',
    ],
    'RecommendationDetailId' => '<string>',
]

Result Details

Errors

LimitExceededException:

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

DataUnavailableException:

The requested data is unavailable.

GetSavingsPlansCoverage

$result = $client->getSavingsPlansCoverage([/* ... */]);
$promise = $client->getSavingsPlansCoverageAsync([/* ... */]);

Retrieves the Savings Plans covered for your account. This enables you to see how much of your cost is covered by a Savings Plan. An organization’s management account can see the coverage of the associated member accounts. This supports dimensions, Cost Categories, and nested expressions. For any time period, you can filter data for Savings Plans usage with the following dimensions:

• LINKED_ACCOUNT

• REGION

• SERVICE

• INSTANCE_FAMILY

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

Parameter Syntax

$result = $client->getSavingsPlansCoverage([
    'Filter' => [
        'And' => [
            [...], // RECURSIVE
            // ...
        ],
        'CostCategories' => [
            'Key' => '<string>',
            'MatchOptions' => ['<string>', ...],
            'Values' => ['<string>', ...],
        ],
        'Dimensions' => [
            'Key' => 'AZ|INSTANCE_TYPE|LINKED_ACCOUNT|LINKED_ACCOUNT_NAME|OPERATION|PURCHASE_TYPE|REGION|SERVICE|SERVICE_CODE|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|BILLING_ENTITY|RESERVATION_ID|RESOURCE_ID|RIGHTSIZING_TYPE|SAVINGS_PLANS_TYPE|SAVINGS_PLAN_ARN|PAYMENT_OPTION|AGREEMENT_END_DATE_TIME_AFTER|AGREEMENT_END_DATE_TIME_BEFORE|INVOICING_ENTITY|ANOMALY_TOTAL_IMPACT_ABSOLUTE|ANOMALY_TOTAL_IMPACT_PERCENTAGE',
            'MatchOptions' => ['<string>', ...],
            'Values' => ['<string>', ...],
        ],
        'Not' => [...], // RECURSIVE
        'Or' => [
            [...], // RECURSIVE
            // ...
        ],
        'Tags' => [
            'Key' => '<string>',
            'MatchOptions' => ['<string>', ...],
            'Values' => ['<string>', ...],
        ],
    ],
    'Granularity' => 'DAILY|MONTHLY|HOURLY',
    'GroupBy' => [
        [
            'Key' => '<string>',
            'Type' => 'DIMENSION|TAG|COST_CATEGORY',
        ],
        // ...
    ],
    'MaxResults' => <integer>,
    'Metrics' => ['<string>', ...],
    'NextToken' => '<string>',
    'SortBy' => [
        'Key' => '<string>', // REQUIRED
        'SortOrder' => 'ASCENDING|DESCENDING',
    ],
    'TimePeriod' => [ // REQUIRED
        'End' => '<string>', // REQUIRED
        'Start' => '<string>', // REQUIRED
    ],
]);

Parameter Details

Result Syntax

[
    'NextToken' => '<string>',
    'SavingsPlansCoverages' => [
        [
            'Attributes' => ['<string>', ...],
            'Coverage' => [
                'CoveragePercentage' => '<string>',
                'OnDemandCost' => '<string>',
                'SpendCoveredBySavingsPlans' => '<string>',
                'TotalCost' => '<string>',
            ],
            'TimePeriod' => [
                'End' => '<string>',
                'Start' => '<string>',
            ],
        ],
        // ...
    ],
]

Result Details

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.

GetSavingsPlansPurchaseRecommendation

$result = $client->getSavingsPlansPurchaseRecommendation([/* ... */]);
$promise = $client->getSavingsPlansPurchaseRecommendationAsync([/* ... */]);

Retrieves the Savings Plans recommendations for your account. First use StartSavingsPlansPurchaseRecommendationGeneration to generate a new set of recommendations, and then use GetSavingsPlansPurchaseRecommendation to retrieve them.

Parameter Syntax

$result = $client->getSavingsPlansPurchaseRecommendation([
    'AccountScope' => 'PAYER|LINKED',
    'Filter' => [
        'And' => [
            [...], // RECURSIVE
            // ...
        ],
        'CostCategories' => [
            'Key' => '<string>',
            'MatchOptions' => ['<string>', ...],
            'Values' => ['<string>', ...],
        ],
        'Dimensions' => [
            'Key' => 'AZ|INSTANCE_TYPE|LINKED_ACCOUNT|LINKED_ACCOUNT_NAME|OPERATION|PURCHASE_TYPE|REGION|SERVICE|SERVICE_CODE|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|BILLING_ENTITY|RESERVATION_ID|RESOURCE_ID|RIGHTSIZING_TYPE|SAVINGS_PLANS_TYPE|SAVINGS_PLAN_ARN|PAYMENT_OPTION|AGREEMENT_END_DATE_TIME_AFTER|AGREEMENT_END_DATE_TIME_BEFORE|INVOICING_ENTITY|ANOMALY_TOTAL_IMPACT_ABSOLUTE|ANOMALY_TOTAL_IMPACT_PERCENTAGE',
            'MatchOptions' => ['<string>', ...],
            'Values' => ['<string>', ...],
        ],
        'Not' => [...], // RECURSIVE
        'Or' => [
            [...], // RECURSIVE
            // ...
        ],
        'Tags' => [
            'Key' => '<string>',
            'MatchOptions' => ['<string>', ...],
            'Values' => ['<string>', ...],
        ],
    ],
    'LookbackPeriodInDays' => 'SEVEN_DAYS|THIRTY_DAYS|SIXTY_DAYS', // REQUIRED
    'NextPageToken' => '<string>',
    'PageSize' => <integer>,
    'PaymentOption' => 'NO_UPFRONT|PARTIAL_UPFRONT|ALL_UPFRONT|LIGHT_UTILIZATION|MEDIUM_UTILIZATION|HEAVY_UTILIZATION', // REQUIRED
    'SavingsPlansType' => 'COMPUTE_SP|EC2_INSTANCE_SP|SAGEMAKER_SP', // REQUIRED
    'TermInYears' => 'ONE_YEAR|THREE_YEARS', // REQUIRED
]);

Parameter Details

Result Syntax

[
    'Metadata' => [
        'AdditionalMetadata' => '<string>',
        'GenerationTimestamp' => '<string>',
        'RecommendationId' => '<string>',
    ],
    'NextPageToken' => '<string>',
    'SavingsPlansPurchaseRecommendation' => [
        'AccountScope' => 'PAYER|LINKED',
        'LookbackPeriodInDays' => 'SEVEN_DAYS|THIRTY_DAYS|SIXTY_DAYS',
        'PaymentOption' => 'NO_UPFRONT|PARTIAL_UPFRONT|ALL_UPFRONT|LIGHT_UTILIZATION|MEDIUM_UTILIZATION|HEAVY_UTILIZATION',
        'SavingsPlansPurchaseRecommendationDetails' => [
            [
                'AccountId' => '<string>',
                'CurrencyCode' => '<string>',
                'CurrentAverageHourlyOnDemandSpend' => '<string>',
                'CurrentMaximumHourlyOnDemandSpend' => '<string>',
                'CurrentMinimumHourlyOnDemandSpend' => '<string>',
                'EstimatedAverageUtilization' => '<string>',
                'EstimatedMonthlySavingsAmount' => '<string>',
                'EstimatedOnDemandCost' => '<string>',
                'EstimatedOnDemandCostWithCurrentCommitment' => '<string>',
                'EstimatedROI' => '<string>',
                'EstimatedSPCost' => '<string>',
                'EstimatedSavingsAmount' => '<string>',
                'EstimatedSavingsPercentage' => '<string>',
                'HourlyCommitmentToPurchase' => '<string>',
                'RecommendationDetailId' => '<string>',
                'SavingsPlansDetails' => [
                    'InstanceFamily' => '<string>',
                    'OfferingId' => '<string>',
                    'Region' => '<string>',
                ],
                'UpfrontCost' => '<string>',
            ],
            // ...
        ],
        'SavingsPlansPurchaseRecommendationSummary' => [
            'CurrencyCode' => '<string>',
            'CurrentOnDemandSpend' => '<string>',
            'DailyCommitmentToPurchase' => '<string>',
            'EstimatedMonthlySavingsAmount' => '<string>',
            'EstimatedOnDemandCostWithCurrentCommitment' => '<string>',
            'EstimatedROI' => '<string>',
            'EstimatedSavingsAmount' => '<string>',
            'EstimatedSavingsPercentage' => '<string>',
            'EstimatedTotalCost' => '<string>',
            'HourlyCommitmentToPurchase' => '<string>',
            'TotalRecommendationCount' => '<string>',
        ],
        'SavingsPlansType' => 'COMPUTE_SP|EC2_INSTANCE_SP|SAGEMAKER_SP',
        'TermInYears' => 'ONE_YEAR|THREE_YEARS',
    ],
]

Result Details

Errors

LimitExceededException:

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

InvalidNextTokenException:

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

GetSavingsPlansUtilization

$result = $client->getSavingsPlansUtilization([/* ... */]);
$promise = $client->getSavingsPlansUtilizationAsync([/* ... */]);

Retrieves the Savings Plans utilization for your account across date ranges with daily or monthly granularity. Management account in an organization have access to member accounts. You can use GetDimensionValues in SAVINGS_PLANS to determine the possible dimension values.

Parameter Syntax

$result = $client->getSavingsPlansUtilization([
    'Filter' => [
        'And' => [
            [...], // RECURSIVE
            // ...
        ],
        'CostCategories' => [
            'Key' => '<string>',
            'MatchOptions' => ['<string>', ...],
            'Values' => ['<string>', ...],
        ],
        'Dimensions' => [
            'Key' => 'AZ|INSTANCE_TYPE|LINKED_ACCOUNT|LINKED_ACCOUNT_NAME|OPERATION|PURCHASE_TYPE|REGION|SERVICE|SERVICE_CODE|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|BILLING_ENTITY|RESERVATION_ID|RESOURCE_ID|RIGHTSIZING_TYPE|SAVINGS_PLANS_TYPE|SAVINGS_PLAN_ARN|PAYMENT_OPTION|AGREEMENT_END_DATE_TIME_AFTER|AGREEMENT_END_DATE_TIME_BEFORE|INVOICING_ENTITY|ANOMALY_TOTAL_IMPACT_ABSOLUTE|ANOMALY_TOTAL_IMPACT_PERCENTAGE',
            'MatchOptions' => ['<string>', ...],
            'Values' => ['<string>', ...],
        ],
        'Not' => [...], // RECURSIVE
        'Or' => [
            [...], // RECURSIVE
            // ...
        ],
        'Tags' => [
            'Key' => '<string>',
            'MatchOptions' => ['<string>', ...],
            'Values' => ['<string>', ...],
        ],
    ],
    'Granularity' => 'DAILY|MONTHLY|HOURLY',
    'SortBy' => [
        'Key' => '<string>', // REQUIRED
        'SortOrder' => 'ASCENDING|DESCENDING',
    ],
    'TimePeriod' => [ // REQUIRED
        'End' => '<string>', // REQUIRED
        'Start' => '<string>', // REQUIRED
    ],
]);

Parameter Details

Result Syntax

[
    'SavingsPlansUtilizationsByTime' => [
        [
            'AmortizedCommitment' => [
                'AmortizedRecurringCommitment' => '<string>',
                'AmortizedUpfrontCommitment' => '<string>',
                'TotalAmortizedCommitment' => '<string>',
            ],
            'Savings' => [
                'NetSavings' => '<string>',
                'OnDemandCostEquivalent' => '<string>',
            ],
            'TimePeriod' => [
                'End' => '<string>',
                'Start' => '<string>',
            ],
            'Utilization' => [
                'TotalCommitment' => '<string>',
                'UnusedCommitment' => '<string>',
                'UsedCommitment' => '<string>',
                'UtilizationPercentage' => '<string>',
            ],
        ],
        // ...
    ],
    'Total' => [
        'AmortizedCommitment' => [
            'AmortizedRecurringCommitment' => '<string>',
            'AmortizedUpfrontCommitment' => '<string>',
            'TotalAmortizedCommitment' => '<string>',
        ],
        'Savings' => [
            'NetSavings' => '<string>',
            'OnDemandCostEquivalent' => '<string>',
        ],
        'Utilization' => [
            'TotalCommitment' => '<string>',
            'UnusedCommitment' => '<string>',
            'UsedCommitment' => '<string>',
            'UtilizationPercentage' => '<string>',
        ],
    ],
]

Result Details

Errors

LimitExceededException:

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

DataUnavailableException:

The requested data is unavailable.

GetSavingsPlansUtilizationDetails

$result = $client->getSavingsPlansUtilizationDetails([/* ... */]);
$promise = $client->getSavingsPlansUtilizationDetailsAsync([/* ... */]);

Retrieves attribute data along with aggregate utilization and savings data for a given time period. This doesn't support granular or grouped data (daily/monthly) in response. You can't retrieve data by dates in a single response similar to GetSavingsPlanUtilization, but you have the option to make multiple calls to GetSavingsPlanUtilizationDetails by providing individual dates. You can use GetDimensionValues in SAVINGS_PLANS to determine the possible dimension values.

Parameter Syntax

$result = $client->getSavingsPlansUtilizationDetails([
    'DataType' => ['<string>', ...],
    'Filter' => [
        'And' => [
            [...], // RECURSIVE
            // ...
        ],
        'CostCategories' => [
            'Key' => '<string>',
            'MatchOptions' => ['<string>', ...],
            'Values' => ['<string>', ...],
        ],
        'Dimensions' => [
            'Key' => 'AZ|INSTANCE_TYPE|LINKED_ACCOUNT|LINKED_ACCOUNT_NAME|OPERATION|PURCHASE_TYPE|REGION|SERVICE|SERVICE_CODE|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|BILLING_ENTITY|RESERVATION_ID|RESOURCE_ID|RIGHTSIZING_TYPE|SAVINGS_PLANS_TYPE|SAVINGS_PLAN_ARN|PAYMENT_OPTION|AGREEMENT_END_DATE_TIME_AFTER|AGREEMENT_END_DATE_TIME_BEFORE|INVOICING_ENTITY|ANOMALY_TOTAL_IMPACT_ABSOLUTE|ANOMALY_TOTAL_IMPACT_PERCENTAGE',
            'MatchOptions' => ['<string>', ...],
            'Values' => ['<string>', ...],
        ],
        'Not' => [...], // RECURSIVE
        'Or' => [
            [...], // RECURSIVE
            // ...
        ],
        'Tags' => [
            'Key' => '<string>',
            'MatchOptions' => ['<string>', ...],
            'Values' => ['<string>', ...],
        ],
    ],
    'MaxResults' => <integer>,
    'NextToken' => '<string>',
    'SortBy' => [
        'Key' => '<string>', // REQUIRED
        'SortOrder' => 'ASCENDING|DESCENDING',
    ],
    'TimePeriod' => [ // REQUIRED
        'End' => '<string>', // REQUIRED
        'Start' => '<string>', // REQUIRED
    ],
]);

Parameter Details

Result Syntax

[
    'NextToken' => '<string>',
    'SavingsPlansUtilizationDetails' => [
        [
            'AmortizedCommitment' => [
                'AmortizedRecurringCommitment' => '<string>',
                'AmortizedUpfrontCommitment' => '<string>',
                'TotalAmortizedCommitment' => '<string>',
            ],
            'Attributes' => ['<string>', ...],
            'Savings' => [
                'NetSavings' => '<string>',
                'OnDemandCostEquivalent' => '<string>',
            ],
            'SavingsPlanArn' => '<string>',
            'Utilization' => [
                'TotalCommitment' => '<string>',
                'UnusedCommitment' => '<string>',
                'UsedCommitment' => '<string>',
                'UtilizationPercentage' => '<string>',
            ],
        ],
        // ...
    ],
    'TimePeriod' => [
        'End' => '<string>',
        'Start' => '<string>',
    ],
    'Total' => [
        'AmortizedCommitment' => [
            'AmortizedRecurringCommitment' => '<string>',
            'AmortizedUpfrontCommitment' => '<string>',
            'TotalAmortizedCommitment' => '<string>',
        ],
        'Savings' => [
            'NetSavings' => '<string>',
            'OnDemandCostEquivalent' => '<string>',
        ],
        'Utilization' => [
            'TotalCommitment' => '<string>',
            'UnusedCommitment' => '<string>',
            'UsedCommitment' => '<string>',
            'UtilizationPercentage' => '<string>',
        ],
    ],
]

Result Details

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([
    'Filter' => [
        'And' => [
            [...], // RECURSIVE
            // ...
        ],
        'CostCategories' => [
            'Key' => '<string>',
            'MatchOptions' => ['<string>', ...],
            'Values' => ['<string>', ...],
        ],
        'Dimensions' => [
            'Key' => 'AZ|INSTANCE_TYPE|LINKED_ACCOUNT|LINKED_ACCOUNT_NAME|OPERATION|PURCHASE_TYPE|REGION|SERVICE|SERVICE_CODE|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|BILLING_ENTITY|RESERVATION_ID|RESOURCE_ID|RIGHTSIZING_TYPE|SAVINGS_PLANS_TYPE|SAVINGS_PLAN_ARN|PAYMENT_OPTION|AGREEMENT_END_DATE_TIME_AFTER|AGREEMENT_END_DATE_TIME_BEFORE|INVOICING_ENTITY|ANOMALY_TOTAL_IMPACT_ABSOLUTE|ANOMALY_TOTAL_IMPACT_PERCENTAGE',
            'MatchOptions' => ['<string>', ...],
            'Values' => ['<string>', ...],
        ],
        'Not' => [...], // RECURSIVE
        'Or' => [
            [...], // RECURSIVE
            // ...
        ],
        'Tags' => [
            'Key' => '<string>',
            'MatchOptions' => ['<string>', ...],
            'Values' => ['<string>', ...],
        ],
    ],
    'MaxResults' => <integer>,
    'NextPageToken' => '<string>',
    'SearchString' => '<string>',
    'SortBy' => [
        [
            'Key' => '<string>', // REQUIRED
            'SortOrder' => 'ASCENDING|DESCENDING',
        ],
        // ...
    ],
    'TagKey' => '<string>',
    'TimePeriod' => [ // REQUIRED
        'End' => '<string>', // REQUIRED
        'Start' => '<string>', // REQUIRED
    ],
]);

Parameter Details

Result Syntax

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

Result Details

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.

GetUsageForecast

$result = $client->getUsageForecast([/* ... */]);
$promise = $client->getUsageForecastAsync([/* ... */]);

Retrieves a forecast for how much Amazon Web Services predicts that you will use over the forecast time period that you select, based on your past usage.

Parameter Syntax

$result = $client->getUsageForecast([
    'Filter' => [
        'And' => [
            [...], // RECURSIVE
            // ...
        ],
        'CostCategories' => [
            'Key' => '<string>',
            'MatchOptions' => ['<string>', ...],
            'Values' => ['<string>', ...],
        ],
        'Dimensions' => [
            'Key' => 'AZ|INSTANCE_TYPE|LINKED_ACCOUNT|LINKED_ACCOUNT_NAME|OPERATION|PURCHASE_TYPE|REGION|SERVICE|SERVICE_CODE|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|BILLING_ENTITY|RESERVATION_ID|RESOURCE_ID|RIGHTSIZING_TYPE|SAVINGS_PLANS_TYPE|SAVINGS_PLAN_ARN|PAYMENT_OPTION|AGREEMENT_END_DATE_TIME_AFTER|AGREEMENT_END_DATE_TIME_BEFORE|INVOICING_ENTITY|ANOMALY_TOTAL_IMPACT_ABSOLUTE|ANOMALY_TOTAL_IMPACT_PERCENTAGE',
            'MatchOptions' => ['<string>', ...],
            'Values' => ['<string>', ...],
        ],
        'Not' => [...], // RECURSIVE
        'Or' => [
            [...], // RECURSIVE
            // ...
        ],
        'Tags' => [
            'Key' => '<string>',
            'MatchOptions' => ['<string>', ...],
            'Values' => ['<string>', ...],
        ],
    ],
    'Granularity' => 'DAILY|MONTHLY|HOURLY', // REQUIRED
    'Metric' => 'BLENDED_COST|UNBLENDED_COST|AMORTIZED_COST|NET_UNBLENDED_COST|NET_AMORTIZED_COST|USAGE_QUANTITY|NORMALIZED_USAGE_AMOUNT', // REQUIRED
    'PredictionIntervalLevel' => <integer>,
    'TimePeriod' => [ // REQUIRED
        'End' => '<string>', // REQUIRED
        'Start' => '<string>', // REQUIRED
    ],
]);

Parameter Details

Result Syntax

[
    'ForecastResultsByTime' => [
        [
            'MeanValue' => '<string>',
            'PredictionIntervalLowerBound' => '<string>',
            'PredictionIntervalUpperBound' => '<string>',
            'TimePeriod' => [
                'End' => '<string>',
                'Start' => '<string>',
            ],
        ],
        // ...
    ],
    'Total' => [
        'Amount' => '<string>',
        'Unit' => '<string>',
    ],
]

Result Details

Errors

LimitExceededException:

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

DataUnavailableException:

The requested data is unavailable.

UnresolvableUsageUnitException:

Cost Explorer was unable to identify the usage unit. Provide UsageType/UsageTypeGroup filter selections that contain matching units, for example: hours.

ListCostAllocationTagBackfillHistory

$result = $client->listCostAllocationTagBackfillHistory([/* ... */]);
$promise = $client->listCostAllocationTagBackfillHistoryAsync([/* ... */]);

Retrieves a list of your historical cost allocation tag backfill requests.

Parameter Syntax

$result = $client->listCostAllocationTagBackfillHistory([
    'MaxResults' => <integer>,
    'NextToken' => '<string>',
]);

Parameter Details

Result Syntax

[
    'BackfillRequests' => [
        [
            'BackfillFrom' => '<string>',
            'BackfillStatus' => 'SUCCEEDED|PROCESSING|FAILED',
            'CompletedAt' => '<string>',
            'LastUpdatedAt' => '<string>',
            'RequestedAt' => '<string>',
        ],
        // ...
    ],
    'NextToken' => '<string>',
]

Result Details

Errors

LimitExceededException:

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

InvalidNextTokenException:

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

ListCostAllocationTags

$result = $client->listCostAllocationTags([/* ... */]);
$promise = $client->listCostAllocationTagsAsync([/* ... */]);

Get a list of cost allocation tags. All inputs in the API are optional and serve as filters. By default, all cost allocation tags are returned.

Parameter Syntax

$result = $client->listCostAllocationTags([
    'MaxResults' => <integer>,
    'NextToken' => '<string>',
    'Status' => 'Active|Inactive',
    'TagKeys' => ['<string>', ...],
    'Type' => 'AWSGenerated|UserDefined',
]);

Parameter Details

Result Syntax

[
    'CostAllocationTags' => [
        [
            'LastUpdatedDate' => '<string>',
            'LastUsedDate' => '<string>',
            'Status' => 'Active|Inactive',
            'TagKey' => '<string>',
            'Type' => 'AWSGenerated|UserDefined',
        ],
        // ...
    ],
    'NextToken' => '<string>',
]

Result Details

Errors

LimitExceededException:

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

InvalidNextTokenException:

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

ListCostCategoryDefinitions

$result = $client->listCostCategoryDefinitions([/* ... */]);
$promise = $client->listCostCategoryDefinitionsAsync([/* ... */]);

Returns the name, Amazon Resource Name (ARN), NumberOfRules and effective dates of all Cost Categories defined in the account. You have the option to use EffectiveOn to return a list of Cost Categories that were active on a specific date. If there is no EffectiveOn specified, you’ll see Cost Categories that are effective on the current date. If Cost Category is still effective, EffectiveEnd is omitted in the response. ListCostCategoryDefinitions supports pagination. The request can have a MaxResults range up to 100.

Parameter Syntax

$result = $client->listCostCategoryDefinitions([
    'EffectiveOn' => '<string>',
    'MaxResults' => <integer>,
    'NextToken' => '<string>',
]);

Parameter Details

Result Syntax

[
    'CostCategoryReferences' => [
        [
            'CostCategoryArn' => '<string>',
            'DefaultValue' => '<string>',
            'EffectiveEnd' => '<string>',
            'EffectiveStart' => '<string>',
            'Name' => '<string>',
            'NumberOfRules' => <integer>,
            'ProcessingStatus' => [
                [
                    'Component' => 'COST_EXPLORER',
                    'Status' => 'PROCESSING|APPLIED',
                ],
                // ...
            ],
            'Values' => ['<string>', ...],
        ],
        // ...
    ],
    'NextToken' => '<string>',
]

Result Details

Errors

LimitExceededException:

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

ListSavingsPlansPurchaseRecommendationGeneration

$result = $client->listSavingsPlansPurchaseRecommendationGeneration([/* ... */]);
$promise = $client->listSavingsPlansPurchaseRecommendationGenerationAsync([/* ... */]);

Retrieves a list of your historical recommendation generations within the past 30 days.

Parameter Syntax

$result = $client->listSavingsPlansPurchaseRecommendationGeneration([
    'GenerationStatus' => 'SUCCEEDED|PROCESSING|FAILED',
    'NextPageToken' => '<string>',
    'PageSize' => <integer>,
    'RecommendationIds' => ['<string>', ...],
]);

Parameter Details

Result Syntax

[
    'GenerationSummaryList' => [
        [
            'EstimatedCompletionTime' => '<string>',
            'GenerationCompletionTime' => '<string>',
            'GenerationStartedTime' => '<string>',
            'GenerationStatus' => 'SUCCEEDED|PROCESSING|FAILED',
            'RecommendationId' => '<string>',
        ],
        // ...
    ],
    'NextPageToken' => '<string>',
]

Result Details

Errors

LimitExceededException:

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

InvalidNextTokenException:

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

DataUnavailableException:

The requested data is unavailable.

ListTagsForResource

$result = $client->listTagsForResource([/* ... */]);
$promise = $client->listTagsForResourceAsync([/* ... */]);

Returns a list of resource tags associated with the resource specified by the Amazon Resource Name (ARN).

Parameter Syntax

$result = $client->listTagsForResource([
    'ResourceArn' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

[
    'ResourceTags' => [
        [
            'Key' => '<string>',
            'Value' => '<string>',
        ],
        // ...
    ],
]

Result Details

Errors

ResourceNotFoundException:

The specified ARN in the request doesn't exist.

LimitExceededException:

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

ProvideAnomalyFeedback

$result = $client->provideAnomalyFeedback([/* ... */]);
$promise = $client->provideAnomalyFeedbackAsync([/* ... */]);

Modifies the feedback property of a given cost anomaly.

Parameter Syntax

$result = $client->provideAnomalyFeedback([
    'AnomalyId' => '<string>', // REQUIRED
    'Feedback' => 'YES|NO|PLANNED_ACTIVITY', // REQUIRED
]);

Parameter Details

Result Syntax

[
    'AnomalyId' => '<string>',
]

Result Details

Errors

LimitExceededException:

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

StartCostAllocationTagBackfill

$result = $client->startCostAllocationTagBackfill([/* ... */]);
$promise = $client->startCostAllocationTagBackfillAsync([/* ... */]);

Request a cost allocation tag backfill. This will backfill the activation status (either active or inactive) for all tag keys from para:BackfillFrom up to the when this request is made.

You can request a backfill once every 24 hours.

Parameter Syntax

$result = $client->startCostAllocationTagBackfill([
    'BackfillFrom' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

[
    'BackfillRequest' => [
        'BackfillFrom' => '<string>',
        'BackfillStatus' => 'SUCCEEDED|PROCESSING|FAILED',
        'CompletedAt' => '<string>',
        'LastUpdatedAt' => '<string>',
        'RequestedAt' => '<string>',
    ],
]

Result Details

Errors

LimitExceededException:

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

BackfillLimitExceededException:

A request to backfill is already in progress. Once the previous request is complete, you can create another request.

StartSavingsPlansPurchaseRecommendationGeneration

$result = $client->startSavingsPlansPurchaseRecommendationGeneration([/* ... */]);
$promise = $client->startSavingsPlansPurchaseRecommendationGenerationAsync([/* ... */]);

Requests a Savings Plans recommendation generation. This enables you to calculate a fresh set of Savings Plans recommendations that takes your latest usage data and current Savings Plans inventory into account. You can refresh Savings Plans recommendations up to three times daily for a consolidated billing family.

Parameter Syntax

$result = $client->startSavingsPlansPurchaseRecommendationGeneration([
]);

Parameter Details

Result Syntax

[
    'EstimatedCompletionTime' => '<string>',
    'GenerationStartedTime' => '<string>',
    'RecommendationId' => '<string>',
]

Result Details

Errors

LimitExceededException:

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

ServiceQuotaExceededException:

You've reached the limit on the number of resources you can create, or exceeded the size of an individual resource.

GenerationExistsException:

A request to generate a recommendation is already in progress.

DataUnavailableException:

The requested data is unavailable.

TagResource

$result = $client->tagResource([/* ... */]);
$promise = $client->tagResourceAsync([/* ... */]);

An API operation for adding one or more tags (key-value pairs) to a resource.

You can use the TagResource operation with a resource that already has tags. If you specify a new tag key for the resource, this tag is appended to the list of tags associated with the resource. If you specify a tag key that is already associated with the resource, the new tag value you specify replaces the previous value for that tag.

Although the maximum number of array members is 200, user-tag maximum is 50. The remaining are reserved for Amazon Web Services use.

Parameter Syntax

$result = $client->tagResource([
    'ResourceArn' => '<string>', // REQUIRED
    'ResourceTags' => [ // REQUIRED
        [
            'Key' => '<string>', // REQUIRED
            'Value' => '<string>', // REQUIRED
        ],
        // ...
    ],
]);

Parameter Details

Result Syntax

[]

Result Details

Errors

ResourceNotFoundException:

The specified ARN in the request doesn't exist.

TooManyTagsException:

Can occur if you specify a number of tags for a resource greater than the maximum 50 user tags per resource.

LimitExceededException:

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

UntagResource

$result = $client->untagResource([/* ... */]);
$promise = $client->untagResourceAsync([/* ... */]);

Removes one or more tags from a resource. Specify only tag keys in your request. Don't specify the value.

Parameter Syntax

$result = $client->untagResource([
    'ResourceArn' => '<string>', // REQUIRED
    'ResourceTagKeys' => ['<string>', ...], // REQUIRED
]);

Parameter Details

Result Syntax

[]

Result Details

Errors

ResourceNotFoundException:

The specified ARN in the request doesn't exist.

LimitExceededException:

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

UpdateAnomalyMonitor

$result = $client->updateAnomalyMonitor([/* ... */]);
$promise = $client->updateAnomalyMonitorAsync([/* ... */]);

Updates an existing cost anomaly monitor. The changes made are applied going forward, and doesn't change anomalies detected in the past.

Parameter Syntax

$result = $client->updateAnomalyMonitor([
    'MonitorArn' => '<string>', // REQUIRED
    'MonitorName' => '<string>',
]);

Parameter Details

Result Syntax

[
    'MonitorArn' => '<string>',
]

Result Details

Errors

LimitExceededException:

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

UnknownMonitorException:

The cost anomaly monitor does not exist for the account.

UpdateAnomalySubscription

$result = $client->updateAnomalySubscription([/* ... */]);
$promise = $client->updateAnomalySubscriptionAsync([/* ... */]);

Updates an existing cost anomaly subscription. Specify the fields that you want to update. Omitted fields are unchanged.

Parameter Syntax

$result = $client->updateAnomalySubscription([
    'Frequency' => 'DAILY|IMMEDIATE|WEEKLY',
    'MonitorArnList' => ['<string>', ...],
    'Subscribers' => [
        [
            'Address' => '<string>',
            'Status' => 'CONFIRMED|DECLINED',
            'Type' => 'EMAIL|SNS',
        ],
        // ...
    ],
    'SubscriptionArn' => '<string>', // REQUIRED
    'SubscriptionName' => '<string>',
    'Threshold' => <float>,
    'ThresholdExpression' => [
        'And' => [
            [...], // RECURSIVE
            // ...
        ],
        'CostCategories' => [
            'Key' => '<string>',
            'MatchOptions' => ['<string>', ...],
            'Values' => ['<string>', ...],
        ],
        'Dimensions' => [
            'Key' => 'AZ|INSTANCE_TYPE|LINKED_ACCOUNT|LINKED_ACCOUNT_NAME|OPERATION|PURCHASE_TYPE|REGION|SERVICE|SERVICE_CODE|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|BILLING_ENTITY|RESERVATION_ID|RESOURCE_ID|RIGHTSIZING_TYPE|SAVINGS_PLANS_TYPE|SAVINGS_PLAN_ARN|PAYMENT_OPTION|AGREEMENT_END_DATE_TIME_AFTER|AGREEMENT_END_DATE_TIME_BEFORE|INVOICING_ENTITY|ANOMALY_TOTAL_IMPACT_ABSOLUTE|ANOMALY_TOTAL_IMPACT_PERCENTAGE',
            'MatchOptions' => ['<string>', ...],
            'Values' => ['<string>', ...],
        ],
        'Not' => [...], // RECURSIVE
        'Or' => [
            [...], // RECURSIVE
            // ...
        ],
        'Tags' => [
            'Key' => '<string>',
            'MatchOptions' => ['<string>', ...],
            'Values' => ['<string>', ...],
        ],
    ],
]);

Parameter Details

Result Syntax

[
    'SubscriptionArn' => '<string>',
]

Result Details

Errors

LimitExceededException:

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

UnknownMonitorException:

The cost anomaly monitor does not exist for the account.

UnknownSubscriptionException:

The cost anomaly subscription does not exist for the account.

UpdateCostAllocationTagsStatus

$result = $client->updateCostAllocationTagsStatus([/* ... */]);
$promise = $client->updateCostAllocationTagsStatusAsync([/* ... */]);

Updates status for cost allocation tags in bulk, with maximum batch size of 20. If the tag status that's updated is the same as the existing tag status, the request doesn't fail. Instead, it doesn't have any effect on the tag status (for example, activating the active tag).

Parameter Syntax

$result = $client->updateCostAllocationTagsStatus([
    'CostAllocationTagsStatus' => [ // REQUIRED
        [
            'Status' => 'Active|Inactive', // REQUIRED
            'TagKey' => '<string>', // REQUIRED
        ],
        // ...
    ],
]);

Parameter Details

Result Syntax

[
    'Errors' => [
        [
            'Code' => '<string>',
            'Message' => '<string>',
            'TagKey' => '<string>',
        ],
        // ...
    ],
]

Result Details

Errors

LimitExceededException:

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

UpdateCostCategoryDefinition

$result = $client->updateCostCategoryDefinition([/* ... */]);
$promise = $client->updateCostCategoryDefinitionAsync([/* ... */]);

Updates an existing Cost Category. Changes made to the Cost Category rules will be used to categorize the current month’s expenses and future expenses. This won’t change categorization for the previous months.

Parameter Syntax

$result = $client->updateCostCategoryDefinition([
    'CostCategoryArn' => '<string>', // REQUIRED
    'DefaultValue' => '<string>',
    'EffectiveStart' => '<string>',
    'RuleVersion' => 'CostCategoryExpression.v1', // REQUIRED
    'Rules' => [ // REQUIRED
        [
            'InheritedValue' => [
                'DimensionKey' => '<string>',
                'DimensionName' => 'LINKED_ACCOUNT_NAME|TAG',
            ],
            'Rule' => [
                'And' => [
                    [...], // RECURSIVE
                    // ...
                ],
                'CostCategories' => [
                    'Key' => '<string>',
                    'MatchOptions' => ['<string>', ...],
                    'Values' => ['<string>', ...],
                ],
                'Dimensions' => [
                    'Key' => 'AZ|INSTANCE_TYPE|LINKED_ACCOUNT|LINKED_ACCOUNT_NAME|OPERATION|PURCHASE_TYPE|REGION|SERVICE|SERVICE_CODE|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|BILLING_ENTITY|RESERVATION_ID|RESOURCE_ID|RIGHTSIZING_TYPE|SAVINGS_PLANS_TYPE|SAVINGS_PLAN_ARN|PAYMENT_OPTION|AGREEMENT_END_DATE_TIME_AFTER|AGREEMENT_END_DATE_TIME_BEFORE|INVOICING_ENTITY|ANOMALY_TOTAL_IMPACT_ABSOLUTE|ANOMALY_TOTAL_IMPACT_PERCENTAGE',
                    'MatchOptions' => ['<string>', ...],
                    'Values' => ['<string>', ...],
                ],
                'Not' => [...], // RECURSIVE
                'Or' => [
                    [...], // RECURSIVE
                    // ...
                ],
                'Tags' => [
                    'Key' => '<string>',
                    'MatchOptions' => ['<string>', ...],
                    'Values' => ['<string>', ...],
                ],
            ],
            'Type' => 'REGULAR|INHERITED_VALUE',
            'Value' => '<string>',
        ],
        // ...
    ],
    'SplitChargeRules' => [
        [
            'Method' => 'FIXED|PROPORTIONAL|EVEN', // REQUIRED
            'Parameters' => [
                [
                    'Type' => 'ALLOCATION_PERCENTAGES', // REQUIRED
                    'Values' => ['<string>', ...], // REQUIRED
                ],
                // ...
            ],
            'Source' => '<string>', // REQUIRED
            'Targets' => ['<string>', ...], // REQUIRED
        ],
        // ...
    ],
]);

Parameter Details

Result Syntax

[
    'CostCategoryArn' => '<string>',
    'EffectiveStart' => '<string>',
]

Result Details

Errors

ResourceNotFoundException:

The specified ARN in the request doesn't exist.

ServiceQuotaExceededException:

You've reached the limit on the number of resources you can create, or exceeded the size of an individual resource.

LimitExceededException:

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