GSP
Quick Navigator
Search Site

Unix VPS
A - Starter
B - Basic
C - Preferred
D - Commercial
MPS - Dedicated
Previous VPSs
* Sign Up! *

Support
Contact Us
Online Help
Handbooks
Domain Status
Man Pages

FAQ
Virtual Servers
Pricing
Billing
Technical

Network
Facilities
Connectivity
Topology Map

Miscellaneous
Server Agreement
Year 2038
Credits
 

USA Flag

 

 

Man Pages
Paws::CostExplorer(3) User Contributed Perl Documentation Paws::CostExplorer(3)

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

  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' } ],
  );

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 (http://aws.amazon.com/aws-cost-management/pricing/).

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

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

Returns: a Paws::CostExplorer::CreateAnomalyMonitorResponse instance

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

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

Returns: a Paws::CostExplorer::CreateAnomalySubscriptionResponse instance

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

[DefaultValue => Str]

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

Returns: a Paws::CostExplorer::CreateCostCategoryDefinitionResponse instance

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

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

Returns: a Paws::CostExplorer::DeleteAnomalyMonitorResponse instance

Deletes a cost anomaly monitor.

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

Returns: a Paws::CostExplorer::DeleteAnomalySubscriptionResponse instance

Deletes a cost anomaly subscription.

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

Returns: a Paws::CostExplorer::DeleteCostCategoryDefinitionResponse instance

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

[EffectiveOn => Str]

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

Returns: a Paws::CostExplorer::DescribeCostCategoryDefinitionResponse instance

Returns the 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 is active on a specific date. If there is no "EffectiveOn" specified, you’ll see a Cost Category that is effective on the current date. If Cost Category is still effective, "EffectiveEnd" is omitted in the response.

[Feedback => Str]
[MaxResults => Int]
[MonitorArn => Str]
[NextPageToken => Str]
[TotalImpact => Paws::CostExplorer::TotalImpactFilter]

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

Returns: a Paws::CostExplorer::GetAnomaliesResponse instance

Retrieves all of the cost anomalies detected on your account, during the time period specified by the "DateInterval" object.

[MaxResults => Int]
[MonitorArnList => ArrayRef[Str|Undef]]
[NextPageToken => Str]

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

Returns: a Paws::CostExplorer::GetAnomalyMonitorsResponse instance

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

[MaxResults => Int]
[MonitorArn => Str]
[NextPageToken => Str]
[SubscriptionArnList => ArrayRef[Str|Undef]]

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

Returns: a Paws::CostExplorer::GetAnomalySubscriptionsResponse instance

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

[Filter => Paws::CostExplorer::Expression]
[GroupBy => ArrayRef[Paws::CostExplorer::GroupDefinition]]
[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 (https://docs.aws.amazon.com/aws-cost-management/latest/APIReference/API_GetDimensionValues.html) operation. Management account in an organization in AWS Organizations have access to all member accounts.

For information about filter limitations, see Quotas and restrictions (https://docs.aws.amazon.com/awsaccountbilling/latest/aboutv2/billing-limits.html) in the Billing and Cost Management User Guide.

[GroupBy => ArrayRef[Paws::CostExplorer::GroupDefinition]]
[Metrics => ArrayRef[Str|Undef]]
[NextPageToken => Str]

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

Returns: a Paws::CostExplorer::GetCostAndUsageWithResourcesResponse instance

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 (https://docs.aws.amazon.com/aws-cost-management/latest/APIReference/API_GetDimensionValues.html) operation. Management account in an organization in AWS Organizations have access to all member accounts. This API is currently available for the Amazon Elastic Compute Cloud – Compute service only.

This is an opt-in only feature. You can enable this feature from the Cost Explorer Settings page. For information on how to access the Settings page, see Controlling Access for Cost Explorer (https://docs.aws.amazon.com/awsaccountbilling/latest/aboutv2/ce-access.html) in the AWS Billing and Cost Management User Guide.

[CostCategoryName => Str]
[Filter => Paws::CostExplorer::Expression]
[MaxResults => Int]
[NextPageToken => Str]
[SearchString => Str]
[SortBy => ArrayRef[Paws::CostExplorer::SortDefinition]]

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

Returns: a Paws::CostExplorer::GetCostCategoriesResponse instance

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

If some Cost Category names and values are not associated with any cost, they will not be returned by this API.

[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.

[Context => Str]
[Filter => Paws::CostExplorer::Expression]
[MaxResults => Int]
[NextPageToken => Str]
[SearchString => Str]
[SortBy => ArrayRef[Paws::CostExplorer::SortDefinition]]

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.

[Filter => Paws::CostExplorer::Expression]
[Granularity => Str]
[GroupBy => ArrayRef[Paws::CostExplorer::GroupDefinition]]
[MaxResults => Int]
[Metrics => ArrayRef[Str|Undef]]
[NextPageToken => Str]
[SortBy => Paws::CostExplorer::SortDefinition]

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 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.

[AccountId => Str]
[AccountScope => Str]
[Filter => Paws::CostExplorer::Expression]
[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.

[Filter => Paws::CostExplorer::Expression]
[Granularity => Str]
[GroupBy => ArrayRef[Paws::CostExplorer::GroupDefinition]]
[MaxResults => Int]
[NextPageToken => Str]
[SortBy => Paws::CostExplorer::SortDefinition]

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

Returns: a Paws::CostExplorer::GetReservationUtilizationResponse instance

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".

[Configuration => Paws::CostExplorer::RightsizingRecommendationConfiguration]
[Filter => Paws::CostExplorer::Expression]
[NextPageToken => Str]
[PageSize => Int]

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

Returns: a Paws::CostExplorer::GetRightsizingRecommendationResponse instance

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 details on calculation and function, see Optimizing Your Cost with Rightsizing Recommendations (https://docs.aws.amazon.com/awsaccountbilling/latest/aboutv2/ce-rightsizing.html) in the AWS Billing and Cost Management User Guide.

[Filter => Paws::CostExplorer::Expression]
[Granularity => Str]
[GroupBy => ArrayRef[Paws::CostExplorer::GroupDefinition]]
[MaxResults => Int]
[Metrics => ArrayRef[Str|Undef]]
[NextToken => Str]
[SortBy => Paws::CostExplorer::SortDefinition]

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

Returns: a Paws::CostExplorer::GetSavingsPlansCoverageResponse instance

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.

[AccountScope => Str]
[Filter => Paws::CostExplorer::Expression]
[NextPageToken => Str]
[PageSize => Int]

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

Returns: a Paws::CostExplorer::GetSavingsPlansPurchaseRecommendationResponse instance

Retrieves your request parameters, Savings Plan Recommendations Summary and Details.

[Filter => Paws::CostExplorer::Expression]
[Granularity => Str]
[SortBy => Paws::CostExplorer::SortDefinition]

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

Returns: a Paws::CostExplorer::GetSavingsPlansUtilizationResponse instance

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.

You cannot group by any dimension values for "GetSavingsPlansUtilization".

[DataType => ArrayRef[Str|Undef]]
[Filter => Paws::CostExplorer::Expression]
[MaxResults => Int]
[NextToken => Str]
[SortBy => Paws::CostExplorer::SortDefinition]

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

Returns: a Paws::CostExplorer::GetSavingsPlansUtilizationDetailsResponse instance

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.

"GetSavingsPlanUtilizationDetails" internally groups data by "SavingsPlansArn".

[Filter => Paws::CostExplorer::Expression]
[MaxResults => Int]
[NextPageToken => Str]
[SearchString => Str]
[SortBy => ArrayRef[Paws::CostExplorer::SortDefinition]]
[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.

[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.

[EffectiveOn => Str]
[MaxResults => Int]
[NextToken => Str]

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

Returns: a Paws::CostExplorer::ListCostCategoryDefinitionsResponse instance

Returns the 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.

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

Returns: a Paws::CostExplorer::ProvideAnomalyFeedbackResponse instance

Modifies the feedback property of a given cost anomaly.

[MonitorName => Str]

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

Returns: a Paws::CostExplorer::UpdateAnomalyMonitorResponse instance

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

[Frequency => Str]
[MonitorArnList => ArrayRef[Str|Undef]]
[Subscribers => ArrayRef[Paws::CostExplorer::Subscriber]]
[SubscriptionName => Str]
[Threshold => Num]

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

Returns: a Paws::CostExplorer::UpdateAnomalySubscriptionResponse instance

Updates an existing cost anomaly monitor subscription.

[DefaultValue => Str]

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

Returns: a Paws::CostExplorer::UpdateCostCategoryDefinitionResponse instance

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.

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

This service class forms part of Paws

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>

2022-06-01 perl v5.40.2
Search for    or go to Top of page |  Section 3 |  Main Index

Powered by GSP Visit the GSP FreeBSD Man Page Interface.
Output converted with ManDoc.