Billing / Paginator / ListContractualInvestmentSummaries

ListContractualInvestmentSummaries

class Billing.Paginator.ListContractualInvestmentSummaries

paginator = client.get_paginator('list_contractual_investment_summaries')

paginate(**kwargs)

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

See also: AWS API Documentation

Request Syntax

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

Parameters:

• contractArn (string) –

  [REQUIRED]

  The Amazon Resource Name (ARN) of the contract whose investment summaries you want to list.

• 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': [
        {
            'investmentSummaryId': 'string',
            'investmentName': 'string',
            'investmentType': 'MILESTONE_BASED'|'OUTCOME_BASED',
            'maxAllowedInvestmentDisbursementValue': {
                'currencyCode': 'string',
                'currencyAmount': 'string'
            }
        },
    ],
    'NextToken': 'string'
}

Response Structure

• (dict) –

  • items (list) –

    The list of investment summaries under the contract. It includes the investment name, maximum investment amount, and investment type. It does not provide investment details. Use this to know if the contract has investment terms and what type.

    • (dict) –

      Detailed information about an investment summary within a contract or a private pricing addendum.

      • investmentSummaryId (string) –

        The identifier of the investment summary. Pass this value to ListContractualInvestments to list the investments within the summary, and to CreateContractualInvestmentAttestation to attest an investment. This value is 1–36 characters.

      • investmentName (string) –

        The name of the investment summary, used to reference the investment against a term in the physical contract. This value is 1–400 characters.

      • investmentType (string) –

        The type of the investment summary. Valid values are MILESTONE_BASED and OUTCOME_BASED. OUTCOME_BASED investments can be attested to, upon completion of outcomes. MILESTONE_BASED are automatically triggered by Amazon Web Services, based on the time schedule in the contract.

      • maxAllowedInvestmentDisbursementValue (dict) –

        The maximum monetary value that can be disbursed against the investment summary, inclusive of all outcomes combined under the summary.

        • currencyCode (string) –

          The ISO 4217 currency code for the amount (for example, USD).

        • currencyAmount (string) –

          The amount as a decimal string (for example, "743.21"). Negative values represent credits that reduce a bill.

  • NextToken (string) –

    A token to resume pagination.