Billing / Paginator / ListContracts

ListContracts

class Billing.Paginator.ListContracts

paginator = client.get_paginator('list_contracts')

paginate(**kwargs)

Creates an iterator that will paginate through responses from Billing.Client.list_contracts().

See also: AWS API Documentation

Request Syntax

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

Parameters:

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': [
        {
            'contractArn': 'string',
            'contractTerm': {
                'startDateInclusive': datetime(2015, 1, 1),
                'endDateInclusive': datetime(2015, 1, 1)
            },
            'contractType': 'Cross-Service'|'Service-Specific'|'Other',
            'associationStatus': 'ASSOCIATED'|'NOT_ASSOCIATED',
            'lastUpdatedAt': datetime(2015, 1, 1)
        },
    ],
    'NextToken': 'string'
}

Response Structure

• (dict) –

  • items (list) –

    The list of contracts that your Amazon Web Services account is an eligible payer account of.

    • (dict) –

      A summary of a private pricing contract visible to your account. ListContracts returns these summaries.

      • contractArn (string) –

        The Amazon Resource Name (ARN) of the contract. Pass this value to operations such as GetContractInformation, ListContractualInvestmentSummaries, and AssociateContract.

      • contractTerm (dict) –

        The contract term period of the contract, expressed as an interval with an inclusive start date and an inclusive end date.

        • startDateInclusive (datetime) –

          The start date of the interval. This date is included in the interval.

        • endDateInclusive (datetime) –

          The end date of the interval. This date is included in the interval.

      • contractType (string) –

        The classification of the contract. Valid values are Cross-Service, Service-Specific, and Other. Cross-Service applies across multiple Amazon Web Services services. Service-Specific applies to a specific Amazon Web Services service. Other applies to other arrangements.

      • associationStatus (string) –

        Indicates whether the contract is currently associated with your account. Valid values are ASSOCIATED and NOT_ASSOCIATED. ASSOCIATED means the contract is associated with your account. NOT_ASSOCIATED means the contract is not associated with your account.

      • lastUpdatedAt (datetime) –

        The time when the contract was last associated with your account.

  • NextToken (string) –

    A token to resume pagination.