BillingandCostManagementPricingCalculator / Paginator / ListBillEstimateLineItems

ListBillEstimateLineItems

class BillingandCostManagementPricingCalculator.Paginator.ListBillEstimateLineItems

paginator = client.get_paginator('list_bill_estimate_line_items')

paginate(**kwargs)

Creates an iterator that will paginate through responses from BillingandCostManagementPricingCalculator.Client.list_bill_estimate_line_items().

See also: AWS API Documentation

Request Syntax

response_iterator = paginator.paginate(
    billEstimateId='string',
    filters=[
        {
            'name': 'USAGE_ACCOUNT_ID'|'SERVICE_CODE'|'USAGE_TYPE'|'OPERATION'|'LOCATION'|'LINE_ITEM_TYPE',
            'values': [
                'string',
            ],
            'matchOption': 'EQUALS'|'STARTS_WITH'|'CONTAINS'
        },
    ],
    PaginationConfig={
        'MaxItems': 123,
        'PageSize': 123,
        'StartingToken': 'string'
    }
)

Parameters:

• billEstimateId (string) –

  [REQUIRED]

  The unique identifier of the bill estimate to list line items for.

• filters (list) –

  Filters to apply to the list of line items.

  • (dict) –

    Represents a filter for listing bill estimate line items.

    • name (string) – [REQUIRED]

      The name of the filter attribute.

    • values (list) – [REQUIRED]

      The values to filter by.

      • (string) –

    • matchOption (string) –

      The match option for the filter (e.g., equals, contains).

• 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

{
    'items': [
        {
            'serviceCode': 'string',
            'usageType': 'string',
            'operation': 'string',
            'location': 'string',
            'availabilityZone': 'string',
            'id': 'string',
            'lineItemId': 'string',
            'lineItemType': 'string',
            'payerAccountId': 'string',
            'usageAccountId': 'string',
            'estimatedUsageQuantity': {
                'amount': 123.0,
                'unit': 'string'
            },
            'estimatedCost': {
                'amount': 123.0,
                'currency': 'USD'
            },
            'historicalUsageQuantity': {
                'amount': 123.0,
                'unit': 'string'
            },
            'historicalCost': {
                'amount': 123.0,
                'currency': 'USD'
            },
            'savingsPlanArns': [
                'string',
            ]
        },
    ],
    'NextToken': 'string'
}

Response Structure

• (dict) –

  • items (list) –

    The list of line items associated with the bill estimate.

    • (dict) –

      Provides a summary of a line item in a bill estimate.

      • serviceCode (string) –

        The Amazon Web Services service code associated with this line item.

      • usageType (string) –

        The type of usage for this line item.

      • operation (string) –

        The specific operation associated with this line item.

      • location (string) –

        The location associated with this line item.

      • availabilityZone (string) –

        The availability zone associated with this line item, if applicable.

      • id (string) –

        The unique identifier of this line item.

      • lineItemId (string) –

        The line item identifier from the original bill.

      • lineItemType (string) –

        The type of this line item (e.g., Usage, Tax, Credit).

      • payerAccountId (string) –

        The Amazon Web Services account ID of the payer for this line item.

      • usageAccountId (string) –

        The Amazon Web Services account ID associated with the usage for this line item.

      • estimatedUsageQuantity (dict) –

        The estimated usage quantity for this line item.

        • amount (float) –

          The numeric value of the usage quantity result.

        • unit (string) –

          The unit of measurement for the usage quantity result.

      • estimatedCost (dict) –

        The estimated cost for this line item.

        • amount (float) –

          The numeric value of the cost.

        • currency (string) –

          The currency code for the cost amount.

      • historicalUsageQuantity (dict) –

        The historical usage quantity for this line item.

        • amount (float) –

          The numeric value of the usage quantity result.

        • unit (string) –

          The unit of measurement for the usage quantity result.

      • historicalCost (dict) –

        The historical cost for this line item.

        • amount (float) –

          The numeric value of the cost.

        • currency (string) –

          The currency code for the cost amount.

      • savingsPlanArns (list) –

        The Amazon Resource Names (ARNs) of any Savings Plans applied to this line item.

        • (string) –

  • NextToken (string) –

    A token to resume pagination.