AgreementService / Client / describe_agreement

describe_agreement

AgreementService.Client.describe_agreement(**kwargs)

Provides details about an agreement, such as the proposer, acceptor, start date, and end date.

See also: AWS API Documentation

Request Syntax

response = client.describe_agreement(
    agreementId='string'
)
Parameters:

agreementId (string) –

[REQUIRED]

The unique identifier of the agreement.

Return type:

dict

Returns:

Response Syntax

{
    'agreementId': 'string',
    'acceptor': {
        'accountId': 'string'
    },
    'proposer': {
        'accountId': 'string'
    },
    'startTime': datetime(2015, 1, 1),
    'endTime': datetime(2015, 1, 1),
    'acceptanceTime': datetime(2015, 1, 1),
    'agreementType': 'string',
    'estimatedCharges': {
        'currencyCode': 'string',
        'agreementValue': 'string'
    },
    'proposalSummary': {
        'resources': [
            {
                'id': 'string',
                'type': 'string'
            },
        ],
        'offerId': 'string',
        'offerSetId': 'string'
    },
    'status': 'ACTIVE'|'ARCHIVED'|'CANCELLED'|'EXPIRED'|'RENEWED'|'REPLACED'|'ROLLED_BACK'|'SUPERSEDED'|'TERMINATED',
    'initialAgreementId': 'string',
    'endTimeBehavior': {
        'type': 'RENEW'|'REPLACE'|'EXPIRE',
        'reasonCode': 'PROPOSER_RENEW_OPTED_OUT'|'ACCEPTOR_RENEW_OPTED_OUT'|'NO_RENEWAL_TERM'|'RENEWAL_LIMIT_EXHAUSTED',
        'renewalSummary': {
            'offerId': 'string'
        }
    }
}

Response Structure

  • (dict) –

    • agreementId (string) –

      The unique identifier of the agreement.

    • acceptor (dict) –

      The details of the party accepting the agreement terms. This is commonly the buyer for PurchaseAgreement.

      • accountId (string) –

        The AWS account ID of the acceptor.

    • proposer (dict) –

      The details of the party proposing the agreement terms. This is commonly the seller for PurchaseAgreement.

      • accountId (string) –

        The AWS account ID of the proposer.

    • startTime (datetime) –

      The date and time when the agreement starts.

    • endTime (datetime) –

      The date and time when the agreement ends. The field is null for pay-as-you-go agreements, which don’t have end dates.

    • acceptanceTime (datetime) –

      The date and time the offer was accepted or the agreement was created.

      Note

      AcceptanceTime and StartTime can differ for future dated agreements (FDAs).

    • agreementType (string) –

      The type of agreement. Values are PurchaseAgreement or VendorInsightsAgreement.

    • estimatedCharges (dict) –

      The estimated cost of the agreement.

      • currencyCode (string) –

        Defines the currency code for the charge.

      • agreementValue (string) –

        The total known amount customer has to pay across the lifecycle of the agreement.

        Note

        This is the total contract value if accepted terms contain ConfigurableUpfrontPricingTerm or FixedUpfrontPricingTerm. In the case of pure contract pricing, this will be the total value of the contract. In the case of contracts with consumption pricing, this will only include the committed value and not include any overages that occur.

        If the accepted terms contain PaymentScheduleTerm, it will be the total payment schedule amount. This occurs when flexible payment schedule is used, and is the sum of all invoice charges in the payment schedule.

        In case a customer has amended an agreement, by purchasing more units of any dimension, this will include both the original cost as well as the added cost incurred due to addition of new units.

        This is 0 if the accepted terms contain UsageBasedPricingTerm without ConfigurableUpfrontPricingTerm or RecurringPaymentTerm. This occurs for usage-based pricing (such as SaaS metered or AMI/container hourly or monthly), because the exact usage is not known upfront.

    • proposalSummary (dict) –

      A summary of the proposal received from the proposer.

      • resources (list) –

        The list of resources involved in the agreement.

        • (dict) –

          The list of resources involved in the agreement.

          • id (string) –

            The unique identifier of the resource.

            Note

            We mention the term resource, which is most commonly a product, so a resourceId is also a productId.

          • type (string) –

            Type of the resource, which is the product (for example, SaaSProduct, AmiProduct, ContainerProduct).

      • offerId (string) –

        The unique identifier of the offer in AWS Marketplace.

      • offerSetId (string) –

        A unique identifier for the offer set containing this offer. All agreements created from offers in this set include this identifier as context.

    • status (string) –

      The current status of the agreement.

      Statuses include:

      • ACTIVE – The terms of the agreement are active.

      • CANCELLED – The acceptor ended the agreement before the defined end date.

      • EXPIRED – The agreement ended on the defined end date.

      • RENEWED – The agreement was renewed into a new agreement (for example, an auto-renewal).

      • REPLACED – The agreement was replaced using an agreement replacement offer.

      • TERMINATED – The agreement ended before the defined end date because of an AWS termination (for example, a payment failure).

    • initialAgreementId (string) –

      The unique identifier of the very first agreement in a chain of related agreements, such as renewals or replacements. It stays the same across all agreements in that chain, which lets you trace an agreement back to the original. When an agreement isn’t derived from another agreement, its InitialAgreementId is its own AgreementId.

    • endTimeBehavior (dict) –

      The behavior of the agreement when it reaches its end date. For example, whether the agreement renews, and if it doesn’t, the reason why.

      This field is present for every active agreement that has an end date. It is not present for an agreement that has no end date, because such an agreement never reaches an end time. Pay-as-you-go agreements are the most common example. It is also not present for an agreement that is no longer active.

      • type (string) –

        The behavior of the agreement when it reaches its end date.

        Types include:

        • RENEW – A new agreement is created from the accepted terms of this agreement.

        • REPLACE – A new agreement is created from a different offer than the one this agreement was created from. This happens, for example, when a private offer reaches its end date and the acceptor transitions to the public offer for the product.

        • EXPIRE – The agreement ends and isn’t renewed or replaced.

      • reasonCode (string) –

        The reason why the agreement doesn’t renew at its end date. The field is null when the agreement renews.

        More than one reason can apply to the same agreement. When that happens, the operation returns only one reason code, and PROPOSER_RENEW_OPTED_OUT takes precedence over all others.

        The EnableAutoRenew field reflects only the acceptor’s preference, and doesn’t reflect the other reasons an agreement might not renew.

        Reason codes include:

        • PROPOSER_RENEW_OPTED_OUT – The proposer opted out of renewing the agreement.

        • ACCEPTOR_RENEW_OPTED_OUT – The acceptor opted out of renewing the agreement.

        • NO_RENEWAL_TERM – The accepted terms of the agreement don’t include a renewal term, which is required for an agreement to renew.

        • RENEWAL_LIMIT_EXHAUSTED – The agreement reached the maximum number of renewals allowed by its renewal term.

      • renewalSummary (dict) –

        The details of the renewal that applies at the end date of the agreement. This field is present when Type is RENEW. It is also present when ReasonCode is PROPOSER_RENEW_OPTED_OUT or ACCEPTOR_RENEW_OPTED_OUT. In those cases, it identifies the offer that the agreement would otherwise have renewed from. The field is null in all other cases.

        • offerId (string) –

          The unique identifier of the offer that provides the terms for the next renewal cycle. For most renewals, this is the same offer that the agreement was created from.

Exceptions