Billing / Client / create_contractual_investment_attestation

create_contractual_investment_attestation¶

Billing.Client.create_contractual_investment_attestation(**kwargs)¶

Creates an attestation that claims an investment award for a completed milestone or outcome within a private pricing contract. Supply a clientToken to make the request idempotent so a safe retry does not create a duplicate attestation. This operation starts an asynchronous review and returns an attestationId while the attestation is pending.

Request Syntax

response = client.create_contractual_investment_attestation(
    contractArn='string',
    investmentSummaryId='string',
    investmentId='string',
    contractDocumentId='string',
    approverDetails={
        'name': 'string',
        'title': 'string',
        'email': 'string'
    },
    investmentDisbursedAt=datetime(2015, 1, 1),
    attestationDetails={
        'attestationValue': {
            'attestationAmount': {
                'currencyCode': 'string',
                'currencyAmount': 'string'
            },
            'attestationQuantities': [
                {
                    'attestationVolume': 'string',
                    'attestationUnit': 'string'
                },
            ]
        },
        'investmentDistributions': [
            {
                'accountId': 'string',
                'investmentAmount': {
                    'currencyCode': 'string',
                    'currencyAmount': 'string'
                }
            },
        ]
    },
    additionalRecipients=[
        {
            'email': 'string'
        },
    ],
    clientToken='string'
)

Parameters:

contractArn (string) –
[REQUIRED]

The Amazon Resource Name (ARN) of the contract that contains the investment being attested.
investmentSummaryId (string) –
[REQUIRED]

The identifier of the investment summary being attested. This is the parent to the investmentId.
investmentId (string) –
[REQUIRED]

The identifier of the investment (outcome) being attested.
contractDocumentId (string) –
[REQUIRED]

The contract ID from the contract document, located in the top-right corner of the private pricing contract pages. This value confirms that you have access to the contract.
approverDetails (dict) –
[REQUIRED]

The details of the executive who authorized the attestation, under the terms of the private pricing contract. The executive receives a click-to-accept email to confirm the attestation.
- name (string) – [REQUIRED]
  
  The name of the approver as it appears on the contract. This value can be up to 256 characters.
- title (string) – [REQUIRED]
  
  The title of the approver, such as Chief Financial Officer. This value can be up to 256 characters.
- email (string) – [REQUIRED]
  
  The email address of the approver. This value is 3–256 characters and must be a valid email address.
investmentDisbursedAt (datetime) – The date on which the investment is disbursed to the investment accounts. The disbursement date is subject to review timelines.
attestationDetails (dict) –
[REQUIRED]

The details of the attestation, including the value being claimed and how the resulting investment is distributed across investment accounts.
- attestationValue (dict) – [REQUIRED]
  
  The value being attested, expressed as either a monetary amount or one or more quantities. Exactly one form is set.
  
  Note
  This is a Tagged Union structure. Only one of the following top level keys can be set: attestationAmount, attestationQuantities.
  - attestationAmount (dict) –
    
    The value attested as a monetary amount. This form is valid only when the investment has no multiplier.
    - currencyCode (string) – [REQUIRED]
      
      The ISO 4217 currency code for the amount (for example, USD).
    - currencyAmount (string) – [REQUIRED]
      
      The amount as a decimal string (for example, "743.21"). Negative values represent credits that reduce a bill.
  - attestationQuantities (list) –
    
    The value attested as one or more quantities, each with its own unit. The list contains at most 50 quantities.
    - (dict) –
      
      A quantity-based attestation value, such as a count of workloads migrated.
      - attestationVolume (string) – [REQUIRED]
        
        The number of units being attested, expressed as a decimal string to preserve precision. The value is digits with an optional decimal point and is 1–1000 characters.
      - attestationUnit (string) – [REQUIRED]
        
        The unit of the attestation, such as workloads migrated. This value is 1–1000 characters.
- investmentDistributions (list) –
  
  The distribution of the resulting investment across the eligible investment accounts on the contract. If you omit this value, the full investment is allocated to the single eligible investment account on the contract. This value is required when multiple investment accounts are eligible. When you provide this value, the sum of all distributions must equal the resulting monetary investment value (the attested amount, or the value computed from the attested quantities using the investment multipliers). 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) – [REQUIRED]
      
      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) – [REQUIRED]
      
      The monetary value allocated to the recipient account.
      - currencyCode (string) – [REQUIRED]
        
        The ISO 4217 currency code for the amount (for example, USD).
      - currencyAmount (string) – [REQUIRED]
        
        The amount as a decimal string (for example, "743.21"). Negative values represent credits that reduce a bill.
additionalRecipients (list) –
The email addresses to copy as viewers on the executive approval request.
- (dict) –
  
  A recipient copied as a viewer on the executive approval request, in addition to the approver.
  - email (string) – [REQUIRED]
    
    The email address of the recipient. This value is 3–256 characters and must be a valid email address.
clientToken (string) –
A unique, case-sensitive identifier that you provide to ensure the idempotency of the request. If you retry a request that completed successfully using the same client token and parameters, the retry completes without performing any further actions.

This field is autopopulated if not provided.

Return type:

dict

Returns:

Response Syntax

{
    'attestationId': 'string'
}

Response Structure

(dict) –
- attestationId (string) –
  
  The identifier of the submitted attestation.

create_contractual_investment_attestation¶

Request Syntax

Note

Response Syntax

Response Structure

Exceptions