NAME

Paws::CostExplorer::GetSavingsPlansUtilizationDetails - Arguments for method GetSavingsPlansUtilizationDetails on Paws::CostExplorer

DESCRIPTION

This class represents the parameters used for calling the method GetSavingsPlansUtilizationDetails on the AWS Cost Explorer Service service. Use the attributes of this class as arguments to method GetSavingsPlansUtilizationDetails.

You shouldn't make instances of this class. Each attribute should be used as a named argument in the call to GetSavingsPlansUtilizationDetails.

SYNOPSIS

my $ce = Paws->service('CostExplorer');
my $GetSavingsPlansUtilizationDetailsResponse =
  $ce->GetSavingsPlansUtilizationDetails(
  TimePeriod => {
    End   => 'MyYearMonthDay',    # max: 40
    Start => 'MyYearMonthDay',    # max: 40

  },
  DataType => [
    'ATTRIBUTES',
    ...    # values: ATTRIBUTES, UTILIZATION, AMORTIZED_COMMITMENT, SAVINGS
  ],    # OPTIONAL
  Filter => {
    And            => [ <Expression>, ... ],    # OPTIONAL
    CostCategories => {
      Key          => 'MyCostCategoryName',     # min: 1, max: 50; OPTIONAL
      MatchOptions => [
        'EQUALS',
        ... # values: EQUALS, ABSENT, STARTS_WITH, ENDS_WITH, CONTAINS, CASE_SENSITIVE, CASE_INSENSITIVE
      ],    # OPTIONAL
      Values => [
        'MyValue', ...    # max: 1024
      ],    # OPTIONAL
    },    # OPTIONAL
    Dimensions => {
      Key => 'AZ'
      , # values: 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; OPTIONAL
      MatchOptions => [
        'EQUALS',
        ... # values: EQUALS, ABSENT, STARTS_WITH, ENDS_WITH, CONTAINS, CASE_SENSITIVE, CASE_INSENSITIVE
      ],    # OPTIONAL
      Values => [
        'MyValue', ...    # max: 1024
      ],    # OPTIONAL
    },    # OPTIONAL
    Not  => <Expression>,
    Or   => [ <Expression>, ... ],    # OPTIONAL
    Tags => {
      Key          => 'MyTagKey',     # max: 1024; OPTIONAL
      MatchOptions => [
        'EQUALS',
        ... # values: EQUALS, ABSENT, STARTS_WITH, ENDS_WITH, CONTAINS, CASE_SENSITIVE, CASE_INSENSITIVE
      ],    # OPTIONAL
      Values => [
        'MyValue', ...    # max: 1024
      ],    # OPTIONAL
    },    # OPTIONAL
  },    # OPTIONAL
  MaxResults => 1,                    # OPTIONAL
  NextToken  => 'MyNextPageToken',    # OPTIONAL
  SortBy     => {
    Key       => 'MySortDefinitionKey',    # max: 1024
    SortOrder => 'ASCENDING',    # values: ASCENDING, DESCENDING; OPTIONAL
  },    # OPTIONAL
  );

# Results:
my $NextToken = $GetSavingsPlansUtilizationDetailsResponse->NextToken;
my $SavingsPlansUtilizationDetails =
  $GetSavingsPlansUtilizationDetailsResponse
  ->SavingsPlansUtilizationDetails;
my $TimePeriod = $GetSavingsPlansUtilizationDetailsResponse->TimePeriod;
my $Total      = $GetSavingsPlansUtilizationDetailsResponse->Total;

# Returns a Paws::CostExplorer::GetSavingsPlansUtilizationDetailsResponse object.

Values for attributes that are native types (Int, String, Float, etc) can passed as-is (scalar values). Values for complex Types (objects) can be passed as a HashRef. The keys and values of the hashref will be used to instance the underlying object. For the AWS API documentation, see https://docs.aws.amazon.com/goto/WebAPI/ce/GetSavingsPlansUtilizationDetails

ATTRIBUTES

DataType => ArrayRef[Str|Undef]

The data type.

Filter => Paws::CostExplorer::Expression

Filters Savings Plans utilization coverage data for active Savings Plans dimensions. You can filter data with the following dimensions:

• LINKED_ACCOUNT

• SAVINGS_PLAN_ARN

• REGION

• PAYMENT_OPTION

• INSTANCE_TYPE_FAMILY

GetSavingsPlansUtilizationDetails uses the same Expression (https://docs.aws.amazon.com/aws-cost-management/latest/APIReference/API_Expression.html) object as the other operations, but only AND is supported among each dimension.

MaxResults => Int

The number of items to be returned in a response. The default is 20, with a minimum value of 1.

NextToken => Str

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

SortBy => Paws::CostExplorer::SortDefinition

The value by which you want to sort the data.

The following values are supported for Key:

• UtilizationPercentage

• TotalCommitment

• UsedCommitment

• UnusedCommitment

• NetSavings

• AmortizedRecurringCommitment

• AmortizedUpfrontCommitment

Supported values for SortOrder are ASCENDING or DESCENDING.

REQUIRED TimePeriod => Paws::CostExplorer::DateInterval

The time period that you want the usage and costs for. The Start date must be within 13 months. The End date must be after the Start date, and before the current date. Future dates can't be used as an End date.

SEE ALSO

This class forms part of Paws, documenting arguments for method GetSavingsPlansUtilizationDetails in Paws::CostExplorer

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

cpanm Paws

perl -MCPAN -e shell
install Paws