CostExplorer / Paginator / ListCostCategoryDefinitions

ListCostCategoryDefinitions

class CostExplorer.Paginator.ListCostCategoryDefinitions

paginator = client.get_paginator('list_cost_category_definitions')

paginate(**kwargs)

Creates an iterator that will paginate through responses from CostExplorer.Client.list_cost_category_definitions().

See also: AWS API Documentation

Request Syntax

response_iterator = paginator.paginate(
    EffectiveOn='string',
    SupportedResourceTypes=[
        'string',
    ],
    PaginationConfig={
        'MaxItems': 123,
        'PageSize': 123,
        'StartingToken': 'string'
    }
)

Parameters:

• EffectiveOn (string) – The date when the cost category was effective.

• SupportedResourceTypes (list) –

  Filter cost category definitions that are supported by given resource types based on the latest version. If the filter is present, the result only includes Cost Categories that supports input resource type. If the filter isn’t provided, no filtering is applied. The valid values are billing:rispgroupsharing and billing:billingview.

  • (string) –

• PaginationConfig (dict) –

  A dictionary that provides parameters to control pagination.

  • MaxItems (integer) –

    The total number of items to return. If the total number of items available is more than the value specified in max-items then a NextToken will be provided in the output that you can use to resume pagination.

  • PageSize (integer) –

    The size of each page.

  • StartingToken (string) –

    A token to specify where to start paginating. This is the NextToken from a previous response.

Return type:

dict

Returns:

Response Syntax

{
    'CostCategoryReferences': [
        {
            'CostCategoryArn': 'string',
            'Name': 'string',
            'EffectiveStart': 'string',
            'EffectiveEnd': 'string',
            'NumberOfRules': 123,
            'ProcessingStatus': [
                {
                    'Component': 'COST_EXPLORER',
                    'Status': 'PROCESSING'|'APPLIED'
                },
            ],
            'Values': [
                'string',
            ],
            'DefaultValue': 'string',
            'SupportedResourceTypes': [
                'string',
            ]
        },
    ],

}

Response Structure

• (dict) –

  • CostCategoryReferences (list) –

    A reference to a cost category that contains enough information to identify the Cost Category.

    • (dict) –

      A reference to a cost category containing only enough information to identify the Cost Category.

      You can use this information to retrieve the full cost category information using DescribeCostCategory.

      • CostCategoryArn (string) –

        The unique identifier for your cost category.

      • Name (string) –

        The unique name of the cost category.

      • EffectiveStart (string) –

        The cost category’s effective start date.

      • EffectiveEnd (string) –

        The cost category’s effective end date.

      • NumberOfRules (integer) –

        The number of rules that are associated with a specific cost category.

      • ProcessingStatus (list) –

        The list of processing statuses for Cost Management products for a specific cost category.

        • (dict) –

          The list of processing statuses for Cost Management products for a specific cost category.

          • Component (string) –

            The Cost Management product name of the applied status.

          • Status (string) –

            The process status for a specific cost category.

      • Values (list) –

        A list of unique cost category values in a specific cost category.

        • (string) –

          The default value for the cost category.

      • DefaultValue (string) –

        The default value for the cost category.

      • SupportedResourceTypes (list) –

        The resource types supported by a specific cost category.

        • (string) –