Billing / Client / get_contract_information

get_contract_information

Billing.Client.get_contract_information(**kwargs)

Returns information about a specific private pricing contract, including its term (duration), eligible payer accounts, investment accounts, and legal entities. This operation is read-only.

See also: AWS API Documentation

Request Syntax

response = client.get_contract_information(
    contractArn='string'
)
Parameters:

contractArn (string) –

[REQUIRED]

The Amazon Resource Name (ARN) of the contract to retrieve information about.

Return type:

dict

Returns:

Response Syntax

{
    'contract': {
        'privatePricingAddendum': {
            'contractArn': 'string',
            'contractTerm': {
                'startDateInclusive': datetime(2015, 1, 1),
                'endDateInclusive': datetime(2015, 1, 1)
            },
            'eligiblePayerAccounts': [
                'string',
            ],
            'investmentAccounts': [
                'string',
            ],
            'legalEntities': [
                {
                    'legalEntityName': 'string'
                },
            ],
            'contractRestrictions': [
                'ATTESTATION_SELF_SERVICE_BLOCKED',
            ]
        }
    }
}

Response Structure

  • (dict) –

    • contract (dict) –

      The contract details such as term (duration), eligible payer accounts, investment accounts, and legal entities.

      Note

      This is a Tagged Union structure. Only one of the following top level keys will be set: privatePricingAddendum. 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'}

      • privatePricingAddendum (dict) –

        The details of a private pricing addendum contract. This member is set when the contract is a private pricing addendum.

        • contractArn (string) –

          The Amazon Resource Name (ARN) of the private pricing addendum.

        • contractTerm (dict) –

          The contract term period of the private pricing addendum, 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.

        • eligiblePayerAccounts (list) –

          The payer accounts that are eligible under the private pricing addendum. The list contains at most 100 account IDs.

          • (string) –

        • investmentAccounts (list) –

          The accounts that are eligible to receive investments under the private pricing addendum. An InvestmentDistribution must target one of these accounts. The list contains at most 100 account IDs.

          • (string) –

        • legalEntities (list) –

          The legal entities on the private pricing addendum. The list contains at most 10 legal entities.

          • (dict) –

            A legal entity on a private pricing contract. It can be found on your contract’s signature page.

            • legalEntityName (string) –

              The name of the legal entity as it appears on the contract document. This value can be up to 256 characters.

        • contractRestrictions (list) –

          The restrictions that limit the self-service actions you can take on the private pricing addendum. An empty or absent value indicates that no restrictions apply. The list contains at most 10 restrictions.

          • (string) –

            A restriction that limits the self-service actions you can take on a contract. A contract with no restrictions supports all self-service actions.

Exceptions