NAME

Paws::CostExplorer - Perl Interface to AWS AWS Cost Explorer Service

SYNOPSIS

  use Paws;

  my $obj = Paws->service('CostExplorer');
  my $res = $obj->Method(
    Arg1 => $val1,
    Arg2 => [ 'V1', 'V2' ],
    # if Arg3 is an object, the HashRef will be used as arguments to the constructor
    # of the arguments type
    Arg3 => { Att1 => 'Val1' },
    # if Arg4 is an array of objects, the HashRefs will be passed as arguments to
    # the constructor of the arguments type
    Arg4 => [ { Att1 => 'Val1'  }, { Att1 => 'Val2' } ],
  );

DESCRIPTION

The Cost Explorer API enables you to programmatically query your cost and usage data. You can query for aggregated data such as total monthly costs or total daily usage. You can also query for granular data, such as the number of daily write operations for Amazon DynamoDB database tables in your production environment.

Service Endpoint

The Cost Explorer API provides the following endpoint:

  • https://ce.us-east-1.amazonaws.com

For information about costs associated with the Cost Explorer API, see AWS Cost Management Pricing (https://aws.amazon.com/aws-cost-management/pricing/).

For the AWS API documentation, see https://docs.aws.amazon.com/account-billing/

METHODS

GetCostAndUsage

TimePeriod => Paws::CostExplorer::DateInterval
[Filter => Paws::CostExplorer::Expression]
[Granularity => Str]
[GroupBy => ArrayRef[Paws::CostExplorer::GroupDefinition]]
[Metrics => ArrayRef[Str|Undef]]
[NextPageToken => Str]

Each argument is described in detail in: Paws::CostExplorer::GetCostAndUsage

Returns: a Paws::CostExplorer::GetCostAndUsageResponse instance

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

GetCostForecast

Granularity => Str
Metric => Str
TimePeriod => Paws::CostExplorer::DateInterval
[Filter => Paws::CostExplorer::Expression]
[PredictionIntervalLevel => Int]

Each argument is described in detail in: Paws::CostExplorer::GetCostForecast

Returns: a Paws::CostExplorer::GetCostForecastResponse instance

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.

GetDimensionValues

Dimension => Str
TimePeriod => Paws::CostExplorer::DateInterval
[Context => Str]
[NextPageToken => Str]
[SearchString => Str]

Each argument is described in detail in: Paws::CostExplorer::GetDimensionValues

Returns: a Paws::CostExplorer::GetDimensionValuesResponse instance

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

GetReservationCoverage

TimePeriod => Paws::CostExplorer::DateInterval
[Filter => Paws::CostExplorer::Expression]
[Granularity => Str]
[GroupBy => ArrayRef[Paws::CostExplorer::GroupDefinition]]
[Metrics => ArrayRef[Str|Undef]]
[NextPageToken => Str]

Each argument is described in detail in: Paws::CostExplorer::GetReservationCoverage

Returns: a Paws::CostExplorer::GetReservationCoverageResponse instance

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

  • AZ

  • CACHE_ENGINE

  • DATABASE_ENGINE

  • DEPLOYMENT_OPTION

  • INSTANCE_TYPE

  • LINKED_ACCOUNT

  • OPERATING_SYSTEM

  • PLATFORM

  • REGION

  • SERVICE

  • TAG

  • TENANCY

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

GetReservationPurchaseRecommendation

Service => Str
[AccountId => Str]
[AccountScope => Str]
[LookbackPeriodInDays => Str]
[NextPageToken => Str]
[PageSize => Int]
[PaymentOption => Str]
[ServiceSpecification => Paws::CostExplorer::ServiceSpecification]
[TermInYears => Str]

Each argument is described in detail in: Paws::CostExplorer::GetReservationPurchaseRecommendation

Returns: a Paws::CostExplorer::GetReservationPurchaseRecommendationResponse instance

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

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

For example, AWS automatically aggregates your 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. AWS recommends the smallest size instance in an instance family. This makes it easier to purchase a size-flexible RI. AWS also shows the equal number of normalized units so that you can purchase any instance size that you want. For this example, your RI recommendation would be for c4.large because that is the smallest size instance in the c4 instance family.

GetReservationUtilization

TimePeriod => Paws::CostExplorer::DateInterval
[Filter => Paws::CostExplorer::Expression]
[Granularity => Str]
[GroupBy => ArrayRef[Paws::CostExplorer::GroupDefinition]]
[NextPageToken => Str]

Each argument is described in detail in: Paws::CostExplorer::GetReservationUtilization

Returns: a Paws::CostExplorer::GetReservationUtilizationResponse instance

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

GetTags

TimePeriod => Paws::CostExplorer::DateInterval
[NextPageToken => Str]
[SearchString => Str]
[TagKey => Str]

Each argument is described in detail in: Paws::CostExplorer::GetTags

Returns: a Paws::CostExplorer::GetTagsResponse instance

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

GetUsageForecast

Granularity => Str
Metric => Str
TimePeriod => Paws::CostExplorer::DateInterval
[Filter => Paws::CostExplorer::Expression]
[PredictionIntervalLevel => Int]

Each argument is described in detail in: Paws::CostExplorer::GetUsageForecast

Returns: a Paws::CostExplorer::GetUsageForecastResponse instance

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.

PAGINATORS

Paginator methods are helpers that repetively call methods that return partial results

SEE ALSO

This service class forms part of Paws

BUGS and CONTRIBUTIONS

The source code is located here: https://github.com/pplu/aws-sdk-perl

Please report bugs to: https://github.com/pplu/aws-sdk-perl/issues