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::GetCostCategories(3) User Contributed Perl Documentation Paws::CostExplorer::GetCostCategories(3)

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

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

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

    my $ce = Paws->service('CostExplorer');
    my $GetCostCategoriesResponse = $ce->GetCostCategories(
      TimePeriod => {
        End   => 'MyYearMonthDay',    # max: 40
        Start => 'MyYearMonthDay',    # max: 40
      },
      CostCategoryName => 'MyCostCategoryName',    # OPTIONAL
      Filter           => {
        And            => [ <Expression>, ... ],    # OPTIONAL
        CostCategories => {
          Key          => 'MyCostCategoryName',     # min: 1, max: 50
          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
      NextPageToken => 'MyNextPageToken',    # OPTIONAL
      SearchString  => 'MySearchString',     # OPTIONAL
      SortBy        => [
        {
          Key       => 'MySortDefinitionKey',    # max: 1024
          SortOrder => 'ASCENDING',    # values: ASCENDING, DESCENDING; OPTIONAL
        },
        ...
      ],    # OPTIONAL
    );
    # Results:
    my $CostCategoryNames  = $GetCostCategoriesResponse->CostCategoryNames;
    my $CostCategoryValues = $GetCostCategoriesResponse->CostCategoryValues;
    my $NextPageToken      = $GetCostCategoriesResponse->NextPageToken;
    my $ReturnSize         = $GetCostCategoriesResponse->ReturnSize;
    my $TotalSize          = $GetCostCategoriesResponse->TotalSize;
    # Returns a L<Paws::CostExplorer::GetCostCategoriesResponse> 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/GetCostCategories>

This field is only used when "SortBy" is provided in the request.

The maximum number of objects that to be returned for this request. If "MaxResults" is not specified with "SortBy", the request will return 1000 results as the default value for this parameter.

For "GetCostCategories", MaxResults has an upper limit of 1000.

If the number of objects that are still available for retrieval exceeds the limit, AWS returns a NextPageToken value in the response. To retrieve the next batch of objects, provide the NextPageToken from the prior call in your next request.

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

If you do not specify a "CostCategoryName", "SearchString" will be used to filter Cost Category names that match the "SearchString" pattern. If you do specifiy a "CostCategoryName", "SearchString" will be used to filter Cost Category values that match the "SearchString" pattern.

The value by which you want to sort the data.

The key represents cost and usage metrics. The following values are supported:

  • "BlendedCost"
  • "UnblendedCost"
  • "AmortizedCost"
  • "NetAmortizedCost"
  • "NetUnblendedCost"
  • "UsageQuantity"
  • "NormalizedUsageAmount"

Supported values for "SortOrder" are "ASCENDING" or "DESCENDING".

When using "SortBy", "NextPageToken" and "SearchString" are not supported.

REQUIRED TimePeriod => Paws::CostExplorer::DateInterval

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

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.