Billing / Client / list_contractual_investment_attestations

list_contractual_investment_attestations

Billing.Client.list_contractual_investment_attestations(**kwargs)

Lists the investment attestations submitted under a specific private pricing contract. Use this operation to track attestation status, including the terminal statuses DISBURSED, REJECTED, and CANCELLED. This operation is read-only and paginated.

See also: AWS API Documentation

Request Syntax

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

  • contractArn (string) –

    [REQUIRED]

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

  • investmentSummaryId (string) – The identifier of a specific investment summary to filter the attestations by. If omitted, attestations for all investment summaries in the contract are returned.

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

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

Return type:

dict

Returns:

Response Syntax

{
    'items': [
        {
            'attestationId': 'string',
            'investmentName': 'string',
            'outcomeDescription': 'string',
            'investmentSummaryId': 'string',
            'investmentId': 'string',
            'attestedAt': datetime(2015, 1, 1),
            'updatedAt': datetime(2015, 1, 1),
            'attestationStatus': 'PENDING_REVIEW'|'PENDING_C_LEVEL_APPROVAL'|'PENDING_CANCELLATION'|'REJECTED'|'CANCELLED'|'DISBURSED',
            'investmentDisbursedAt': datetime(2015, 1, 1),
            'attestedValue': {
                'currencyCode': 'string',
                'currencyAmount': 'string'
            },
            'investmentDistributions': [
                {
                    'accountId': 'string',
                    'investmentAmount': {
                        'currencyCode': 'string',
                        'currencyAmount': 'string'
                    }
                },
            ],
            'rejectionReasons': [
                'string',
            ],
            'isCancellable': True|False
        },
    ],
    'nextToken': 'string'
}

Response Structure

  • (dict) –

    • items (list) –

      The list of investment attestations submitted under the contract.

      • (dict) –

        A summary of a submitted investment attestation, as returned by ListContractualInvestmentAttestations.

        • attestationId (string) –

          The identifier of the attestation. This value is returned by CreateContractualInvestmentAttestation and is used to cancel the attestation with CancelContractualInvestmentAttestation. This value is 1–36 characters.

        • investmentName (string) –

          The name of the investment summary that contains the attested outcome. This value is 1–400 characters.

        • outcomeDescription (string) –

          The description of the attested outcome. This value is 1–2048 characters.

        • investmentSummaryId (string) –

          The identifier of the investment summary that was attested, as returned by ListContractualInvestmentSummaries.

        • investmentId (string) –

          The identifier of the investment that was attested, as returned by ListContractualInvestments.

        • attestedAt (datetime) –

          The date on which the attestation was submitted.

        • updatedAt (datetime) –

          The date on which the attestation was last updated.

        • attestationStatus (string) –

          The current status of the attestation. Valid values are PENDING_REVIEW, PENDING_C_LEVEL_APPROVAL, PENDING_CANCELLATION, REJECTED, CANCELLED, and DISBURSED. The values DISBURSED, REJECTED, and CANCELLED are terminal. The other values indicate the attestation is still in progress.

        • investmentDisbursedAt (datetime) –

          The start date on which the investment is disbursed to the investment accounts. This is not the same as the time of disbursement, but reflects the date you submitted with the attestation.

        • attestedValue (dict) –

          The monetary value attested.

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

        • investmentDistributions (list) –

          The distribution of the attested investment across the eligible investment accounts. The list contains at most 200 distributions.

          • (dict) –

            An allocation of an investment disbursement to a specific recipient account. The account is the target account that receives the investment, not your account.

            • accountId (string) –

              The recipient Amazon Web Services account ID that receives this portion of the investment. This must be one of the eligible investment accounts on the contract.

            • investmentAmount (dict) –

              The monetary value allocated to the recipient account.

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

        • rejectionReasons (list) –

          The reasons the attestation was rejected. This value is present only when attestationStatus is REJECTED. The list contains at most 30 reasons.

          • (string) –

            A single reason an attestation was rejected. This value is 1–300 characters.

        • isCancellable (boolean) –

          Indicates whether the attestation can be canceled with CancelContractualInvestmentAttestation.

    • nextToken (string) –

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

Exceptions