CostExplorer / Paginator / ListCostAllocationTags

ListCostAllocationTags

class CostExplorer.Paginator.ListCostAllocationTags

paginator = client.get_paginator('list_cost_allocation_tags')

paginate(**kwargs)

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

See also: AWS API Documentation

Request Syntax

response_iterator = paginator.paginate(
    Status='Active'|'Inactive',
    TagKeys=[
        'string',
    ],
    Type='AWSGenerated'|'UserDefined',
    PaginationConfig={
        'MaxItems': 123,
        'PageSize': 123,
        'StartingToken': 'string'
    }
)

Parameters:

• Status (string) – The status of cost allocation tag keys that are returned for this request.

• TagKeys (list) –

  The list of cost allocation tag keys that are returned for this request.

  • (string) –

• Type (string) – The type of CostAllocationTag object that are returned for this request. The AWSGenerated type tags are tags that Amazon Web Services defines and applies to support Amazon Web Services resources for cost allocation purposes. The UserDefined type tags are tags that you define, create, and apply to resources.

• 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

{
    'CostAllocationTags': [
        {
            'TagKey': 'string',
            'Type': 'AWSGenerated'|'UserDefined',
            'Status': 'Active'|'Inactive',
            'LastUpdatedDate': 'string',
            'LastUsedDate': 'string'
        },
    ],

}

Response Structure

• (dict) –

  • CostAllocationTags (list) –

    A list of cost allocation tags that includes the detailed metadata for each one.

    • (dict) –

      The cost allocation tag structure. This includes detailed metadata for the CostAllocationTag object.

      • TagKey (string) –

        The key for the cost allocation tag.

      • Type (string) –

        The type of cost allocation tag. You can use AWSGenerated or UserDefined type tags. AWSGenerated type tags are tags that Amazon Web Services defines and applies to support Amazon Web Services resources for cost allocation purposes. UserDefined type tags are tags that you define, create, and apply to resources.

      • Status (string) –

        The status of a cost allocation tag.

      • LastUpdatedDate (string) –

        The last date that the tag was either activated or deactivated.

      • LastUsedDate (string) –

        The last month that the tag was used on an Amazon Web Services resource.