Billing / Client / list_contractual_investments

list_contractual_investments

Billing.Client.list_contractual_investments(**kwargs)

Lists the investments within a specific investment summary. This operation is read-only and paginated.

See also: AWS API Documentation

Request Syntax

response = client.list_contractual_investments(
    contractArn='string',
    investmentSummaryId='string',
    nextToken='string',
    maxResults=123
)
Parameters:

  • contractArn (string) –

    [REQUIRED]

    The Amazon Resource Name (ARN) of the contract that contains the investment summary.

  • investmentSummaryId (string) –

    [REQUIRED]

    The identifier of the investment summary whose investments you want to list.

  • nextToken (string) – The pagination token that indicates the next set of results to retrieve.

  • maxResults (integer) – The maximum number of investments to return in a single call. Minimum value of 1, maximum value of 100.

Return type:

dict

Returns:

Response Syntax

{
    'items': [
        {
            'milestoneBasedInvestment': {
                'investmentId': 'string',
                'investmentValue': {
                    'currencyCode': 'string',
                    'currencyAmount': 'string'
                },
                'investmentDisbursedAt': datetime(2015, 1, 1)
            },
            'outcomeBasedInvestment': {
                'investmentId': 'string',
                'outcomeDescription': 'string',
                'attestationWindow': {
                    'startDateInclusive': datetime(2015, 1, 1),
                    'endDateInclusive': datetime(2015, 1, 1)
                },
                'investmentRestrictions': [
                    {
                        'amount': {
                            'currencyCode': 'string',
                            'currencyAmount': 'string'
                        }
                    },
                ],
                'investmentMultipliers': [
                    {
                        'value': 'string',
                        'investmentAttestationInputUnit': 'string',
                        'multiplierType': 'PERCENTAGE'|'CURRENCY_AMOUNT'
                    },
                ],
                'disbursedValue': {
                    'currencyCode': 'string',
                    'currencyAmount': 'string'
                }
            }
        },
    ],
    'nextToken': 'string'
}

Response Structure

  • (dict) –

    • items (list) –

      The list of investments for the investment summary.

      • (dict) –

        An investment within an investment summary. This is a union in which exactly one member is set. The milestoneBasedInvestment member represents a fixed, scheduled investment. The outcomeBasedInvestment member represents an attestable investment awarded upon completion of a defined outcome. Check which member is present to determine the investment type.

        Note

        This is a Tagged Union structure. Only one of the following top level keys will be set: milestoneBasedInvestment, outcomeBasedInvestment. If a client receives an unknown member it will set SDK_UNKNOWN_MEMBER as the top level key, which maps to the name or tag of the unknown member. The structure of SDK_UNKNOWN_MEMBER is as follows:

        'SDK_UNKNOWN_MEMBER': {'name': 'UnknownMemberName'}

        • milestoneBasedInvestment (dict) –

          An investment with a fixed value that is disbursed on a schedule. This member is set for a milestone-based investment and corresponds to the MILESTONE_BASED investment type.

          • investmentId (string) –

            The identifier of the investment, as returned by ListContractualInvestments. This value is 1–36 characters.

          • investmentValue (dict) –

            The total value of the investment, including its currency and amount.

            • 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.

          • investmentDisbursedAt (datetime) –

            The date on which the investment is disbursed to the investment accounts.

        • outcomeBasedInvestment (dict) –

          An investment that is awarded upon completion of a defined outcome. This member is set for an outcome-based (attestable) investment and corresponds to the OUTCOME_BASED investment type.

          • investmentId (string) –

            The identifier of the investment, as returned by ListContractualInvestments. This value is 1–36 characters.

          • outcomeDescription (string) –

            The description of what must be completed to attest the outcome. This value is 1–2048 characters.

          • attestationWindow (dict) –

            The time window, expressed as an interval with inclusive start and end dates, during which outcomes can be attested to.

            • 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.

          • investmentRestrictions (list) –

            The restrictions that cap the value that can be disbursed for the investment. The list contains at most 10 restrictions.

            • (dict) –

              A restriction that caps the value that can be disbursed for an investment. The cap applies for each attestation window.

              • amount (dict) –

                The maximum monetary amount allowed under the restriction.

                • 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.

          • investmentMultipliers (list) –

            The multipliers used to compute the investment value from the attestation input. The list contains at most 200 multipliers. Multipliers are derived from the terms of the private pricing contract.

            • (dict) –

              A multiplier used to convert attestation input into an investment value.

              • value (string) –

                The multiplier value, expressed as a decimal string to preserve precision. The value is digits with an optional decimal point and is 1–1000 characters. The terms of the contract define this value.

              • investmentAttestationInputUnit (string) –

                The unit of the attestation input that the multiplier applies to, such as workloads migrated. This value is 1–1000 characters. The terms of the contract define this value.

              • multiplierType (string) –

                The type of the multiplier. A value of PERCENTAGE applies a percentage of a value. A value of CURRENCY_AMOUNT applies a currency amount per unit of attestation input. The terms of the contract define this value.

          • disbursedValue (dict) –

            The total value already disbursed against the investment. This value can be distributed among the investment accounts distribution.

            • 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) –

      The pagination token to use on subsequent calls to retrieve the next set of results.

Exceptions