AWS Marketplace Agreement Service

2026/11/17 - AWS Marketplace Agreement Service - 11 new 2 updated api methods

Changes  Adds buyer agreement request and approval APIs. Buyers can get, list and cancel agreement requests and start approvals, which organization administrators approve or reject. Buyers can share a contact when they create an agreement request, and sellers can retrieve it with GetAgreementContacts.

GetAgreementRequestApprovalPlans (new) Link ¶

Retrieves the approval plans that apply to an agreement request. Only the acceptor of the agreement request can call this operation. Each approval plan lists its approval levels and the approvers at each level. Pass the planReference of an approval plan to StartAgreementApprovals to start an agreement approval for it.

See also: AWS API Documentation

Request Syntax

client.get_agreement_request_approval_plans(
    agreementRequestId='string',
    maxResults=123,
    nextToken='string'
)
type agreementRequestId:

string

param agreementRequestId:

[REQUIRED]

The unique identifier of the agreement request to retrieve the approval plans for.

type maxResults:

integer

param maxResults:

The maximum number of approval plans to return in a single response (1-50). Default is 10.

type nextToken:

string

param nextToken:

A token to specify where to start pagination.

rtype:

dict

returns:

Response Syntax

{
    'items': [
        {
            'buyerAgreementApprovalPlan': {
                'planReference': 'string',
                'name': 'string',
                'levels': [
                    {
                        'name': 'string',
                        'groups': [
                            {
                                'approvalCriteria': {
                                    'requiredApprovalCount': 123
                                },
                                'approvers': [
                                    {
                                        'emailApprover': {
                                            'emailAddress': 'string',
                                            'name': 'string'
                                        },
                                        'procurementToolApprover': {
                                            'name': 'string'
                                        },
                                        'awsOrganizationAdminApprover': {
                                            'organizationId': 'string'
                                        }
                                    },
                                ]
                            },
                        ]
                    },
                ]
            }
        },
    ],
    'nextToken': 'string'
}

Response Structure

  • (dict) --

    • items (list) --

      An array of AgreementApprovalPlan objects, one for each approval plan that applies to the agreement request.

      • (dict) --

        An approval plan that applies to an agreement request.

        • buyerAgreementApprovalPlan (dict) --

          An approval plan that the buyer's organization requires.

          • planReference (string) --

            The identifier of the approval plan. Pass it in StartAgreementApprovals to start an agreement approval for this plan.

          • name (string) --

            The name of the approval plan.

          • levels (list) --

            The approval levels of the plan, in the order they are evaluated. Approvers at a level can act only after the previous level is approved.

            • (dict) --

              A level of an approval plan.

              • name (string) --

                The name of the level.

              • groups (list) --

                The group of approvers at this level.

                • (dict) --

                  A group of approvers and the number of approvals the group requires.

                  • approvalCriteria (dict) --

                    The number of approvers in the group who must approve.

                    • requiredApprovalCount (integer) --

                      The number of approvers in the group who must approve before the level is approved.

                  • approvers (list) --

                    The approvers in the group.

                    • (dict) --

                      An approver in an approval plan.

                      • emailApprover (dict) --

                        An approver who is identified by an email address.

                        • emailAddress (string) --

                          The email address of the approver.

                        • name (string) --

                          The name of the approver.

                      • procurementToolApprover (dict) --

                        A procurement system that approves through the buyer's procurement integration.

                        • name (string) --

                          The name of the procurement system.

                      • awsOrganizationAdminApprover (dict) --

                        The administrators of the buyer's AWS organization.

                        • organizationId (string) --

                          The ID of the AWS organization.

    • nextToken (string) --

      The token used for pagination. The field is null if there are no more results.

ListAgreementApprovals (new) Link ¶

Lists agreement approvals available to you as a buyer. Use REQUESTER as the partyType to list the agreement approvals that your account started. Use AWS_ORGANIZATION_ADMIN to list the agreement approvals in your AWS organization, if your account is the management account or a delegated administrator of the organization. You can filter the results by agreement request, approval type, and status.

See also: AWS API Documentation

Request Syntax

client.list_agreement_approvals(
    catalog='string',
    partyType='REQUESTER'|'AWS_ORGANIZATION_ADMIN',
    agreementRequestId='string',
    approvalType='BUYER_AGREEMENT_APPROVAL',
    status='PENDING_APPROVAL'|'APPROVED'|'REJECTED'|'EXPIRED'|'CANCELLED',
    maxResults=123,
    nextToken='string'
)
type catalog:

string

param catalog:

An optional parameter to filter agreement approvals by catalog (for example, AWSMarketplace).

type partyType:

string

param partyType:

[REQUIRED]

The party type for the agreement approvals. Required parameter. Use REQUESTER to list agreement approvals for agreement requests that you created, or AWS_ORGANIZATION_ADMIN to list agreement approvals as an AWS Organizations administrator.

type agreementRequestId:

string

param agreementRequestId:

An optional parameter to filter agreement approvals for a specific agreement request.

type approvalType:

string

param approvalType:

An optional parameter to filter agreement approvals by type. The only valid value is BUYER_AGREEMENT_APPROVAL.

type status:

string

param status:

An optional parameter to filter agreement approvals by status. Valid values include PENDING_APPROVAL, APPROVED, REJECTED, EXPIRED, and CANCELLED. If you don't specify a status, agreement approvals of all statuses are returned.

type maxResults:

integer

param maxResults:

The maximum number of agreement approvals to return in a single response (1-50). Default is 20.

type nextToken:

string

param nextToken:

A token to specify where to start pagination.

rtype:

dict

returns:

Response Syntax

{
    'items': [
        {
            'approvalType': 'BUYER_AGREEMENT_APPROVAL',
            'agreementRequestId': 'string',
            'agreementApprovalId': 'string',
            'name': 'string',
            'status': 'PENDING_APPROVAL'|'APPROVED'|'REJECTED'|'EXPIRED'|'CANCELLED',
            'createdAt': datetime(2015, 1, 1),
            'updatedAt': datetime(2015, 1, 1),
            'startedAt': datetime(2015, 1, 1),
            'expiresAt': datetime(2015, 1, 1),
            'approvalNeededBy': datetime(2015, 1, 1)
        },
    ],
    'nextToken': 'string'
}

Response Structure

  • (dict) --

    • items (list) --

      An array of AgreementApprovalSummary objects containing summary information about each agreement approval.

      • (dict) --

        Summary view of an agreement approval.

        • approvalType (string) --

          The type of the agreement approval. The only value is BUYER_AGREEMENT_APPROVAL, an approval that the buyer's organization requires before the agreement request can be accepted.

        • agreementRequestId (string) --

          The unique identifier of the agreement request that the agreement approval is for.

        • agreementApprovalId (string) --

          The unique identifier of the agreement approval.

        • name (string) --

          The descriptive name of the agreement approval.

        • status (string) --

          The current status of the agreement approval. Possible values include PENDING_APPROVAL, APPROVED, REJECTED, EXPIRED, and CANCELLED.

        • createdAt (datetime) --

          The date and time when the agreement approval was created.

        • updatedAt (datetime) --

          The date and time when the agreement approval was last updated.

        • startedAt (datetime) --

          The date and time when approvers could start acting on the agreement approval.

        • expiresAt (datetime) --

          The date and time when the agreement approval expires if it isn't approved or rejected.

        • approvalNeededBy (datetime) --

          The date and time by which the agreement approval must be completed.

    • nextToken (string) --

      The token used for pagination. The field is null if there are no more results.

CancelAgreementRequest (new) Link ¶

Allows buyers (acceptors) to cancel an agreement request that is in PENDING_APPROVAL status, or in APPROVED status when no agreement has been created from it. Once cancelled, the agreement request transitions to CANCELLED status and its open agreement approvals are cancelled.

See also: AWS API Documentation

Request Syntax

client.cancel_agreement_request(
    agreementRequestId='string'
)
type agreementRequestId:

string

param agreementRequestId:

[REQUIRED]

The unique identifier of the agreement request to cancel.

rtype:

dict

returns:

Response Syntax

{}

Response Structure

  • (dict) --

AcceptAgreementApproval (new) Link ¶

Allows the management account or a delegated administrator of the buyer's AWS organization to approve an agreement approval that is in PENDING_APPROVAL status, as the organization administrator approver or on behalf of another approver. Once every level is approved, the agreement approval transitions to APPROVED status. You can optionally provide purchase order references and a note.

See also: AWS API Documentation

Request Syntax

client.accept_agreement_approval(
    buyerAgreementApprovalApproverInput={
        'agreementApprovalId': 'string',
        'purchaseOrders': [
            {
                'chargeId': 'string',
                'purchaseOrderReference': 'string'
            },
        ],
        'note': 'string',
        'approverOutcomeIdToOverride': 'string'
    }
)
type buyerAgreementApprovalApproverInput:

dict

param buyerAgreementApprovalApproverInput:

The approval decision for an agreement approval that the buyer's organization requires.

  • agreementApprovalId (string) -- [REQUIRED]

    The unique identifier of the agreement approval to approve.

  • purchaseOrders (list) --

    An optional list of purchase order references to associate with charges on the agreement request.

    • (dict) --

      A purchase order reference for a charge on the agreement request.

      • chargeId (string) -- [REQUIRED]

        The unique identifier of the charge to associate the purchase order with. Use GetAgreementRequest to retrieve the charges of the agreement request.

      • purchaseOrderReference (string) --

        The purchase order reference to associate with the charge.

  • note (string) --

    An optional note that explains the decision (1-1000 characters).

  • approverOutcomeIdToOverride (string) --

    The approverOutcomeId of the approver to decide on behalf of. You must be the management account or a delegated administrator of your AWS organization to set this field. Use GetAgreementApproval to retrieve the approverOutcomeId of each approver.

rtype:

dict

returns:

Response Syntax

{}

Response Structure

  • (dict) --

ListAgreementRequests (new) Link ¶

Lists agreement requests available to you as a buyer (acceptor). You can filter the results by catalog, status, and resourceId.

See also: AWS API Documentation

Request Syntax

client.list_agreement_requests(
    catalog='string',
    status='DRAFT'|'PENDING_APPROVAL'|'APPROVED'|'ACCEPTED'|'REJECTED'|'CANCELLED',
    resourceId='string',
    maxResults=123,
    nextToken='string'
)
type catalog:

string

param catalog:

An optional parameter to list agreement requests by catalog (for example, AWSMarketplace).

type status:

string

param status:

An optional parameter to list agreement requests by status. Valid values include DRAFT, PENDING_APPROVAL, APPROVED, ACCEPTED, REJECTED, and CANCELLED. If you don't specify a status, agreement requests of all statuses are returned.

type resourceId:

string

param resourceId:

An optional parameter to list agreement requests for a specific resource, such as a product.

type maxResults:

integer

param maxResults:

The maximum number of agreement requests to return in a single response (1-50). Default is 20.

type nextToken:

string

param nextToken:

A token to specify where to start pagination.

rtype:

dict

returns:

Response Syntax

{
    'items': [
        {
            'agreementRequestId': 'string',
            'agreementType': 'string',
            'status': 'DRAFT'|'PENDING_APPROVAL'|'APPROVED'|'ACCEPTED'|'REJECTED'|'CANCELLED',
            'agreementId': 'string',
            'proposalSummary': {
                'resources': [
                    {
                        'id': 'string',
                        'type': 'string'
                    },
                ],
                'offerId': 'string',
                'offerSetId': 'string'
            }
        },
    ],
    'nextToken': 'string'
}

Response Structure

  • (dict) --

    • items (list) --

      An array of AgreementRequestSummary objects containing summary information about each agreement request.

      • (dict) --

        Summary view of an agreement request.

        • agreementRequestId (string) --

          The unique identifier of the agreement request.

        • agreementType (string) --

          The type of agreement (for example, PurchaseAgreement).

        • status (string) --

          The current status of the agreement request. Possible values include DRAFT, PENDING_APPROVAL, APPROVED, ACCEPTED, REJECTED, and CANCELLED.

        • agreementId (string) --

          The unique identifier of the agreement that the agreement request is for.

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

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

    • nextToken (string) --

      The token used for pagination. The field is null if there are no more results.

StartAgreementApprovals (new) Link ¶

Allows buyers (acceptors) to start the approvals that their organization requires for an agreement request. You start one agreement approval for each approval plan that you specify. Use GetAgreementRequestApprovalPlans to retrieve the approval plans of the agreement request. Once the agreement approvals start, the agreement request transitions to PENDING_APPROVAL status.

See also: AWS API Documentation

Request Syntax

client.start_agreement_approvals(
    agreementRequestId='string',
    planInputs=[
        {
            'buyerAgreementApprovalPlanInput': {
                'planReference': 'string',
                'requesterNote': 'string'
            }
        },
    ],
    purchaseOrders=[
        {
            'chargeId': 'string',
            'purchaseOrderReference': 'string'
        },
    ]
)
type agreementRequestId:

string

param agreementRequestId:

[REQUIRED]

The unique identifier of the agreement request to start approvals for.

type planInputs:

list

param planInputs:

[REQUIRED]

The approval plans to start agreement approvals for.

  • (dict) --

    The approval plan to start an agreement approval for.

    • buyerAgreementApprovalPlanInput (dict) --

      An approval plan that the buyer's organization requires.

      • planReference (string) -- [REQUIRED]

        The identifier of the approval plan. Use GetAgreementRequestApprovalPlans to retrieve the approval plans of the agreement request.

      • requesterNote (string) --

        An optional note for the approvers, such as the business reason for the purchase (1-1000 characters).

type purchaseOrders:

list

param purchaseOrders:

An optional list of purchase order references to associate with charges on the agreement request.

  • (dict) --

    A purchase order reference for a charge on the agreement request.

    • chargeId (string) -- [REQUIRED]

      The unique identifier of the charge to associate the purchase order with. Use GetAgreementRequest to retrieve the charges of the agreement request.

    • purchaseOrderReference (string) --

      The purchase order reference to associate with the charge.

rtype:

dict

returns:

Response Syntax

{
    'approvalSummaries': [
        {
            'approvalType': 'BUYER_AGREEMENT_APPROVAL',
            'agreementRequestId': 'string',
            'agreementApprovalId': 'string',
            'name': 'string',
            'status': 'PENDING_APPROVAL'|'APPROVED'|'REJECTED'|'EXPIRED'|'CANCELLED',
            'createdAt': datetime(2015, 1, 1),
            'updatedAt': datetime(2015, 1, 1),
            'startedAt': datetime(2015, 1, 1),
            'expiresAt': datetime(2015, 1, 1),
            'approvalNeededBy': datetime(2015, 1, 1)
        },
    ]
}

Response Structure

  • (dict) --

    • approvalSummaries (list) --

      An array of AgreementApprovalSummary objects, one for each agreement approval that was started.

      • (dict) --

        Summary view of an agreement approval.

        • approvalType (string) --

          The type of the agreement approval. The only value is BUYER_AGREEMENT_APPROVAL, an approval that the buyer's organization requires before the agreement request can be accepted.

        • agreementRequestId (string) --

          The unique identifier of the agreement request that the agreement approval is for.

        • agreementApprovalId (string) --

          The unique identifier of the agreement approval.

        • name (string) --

          The descriptive name of the agreement approval.

        • status (string) --

          The current status of the agreement approval. Possible values include PENDING_APPROVAL, APPROVED, REJECTED, EXPIRED, and CANCELLED.

        • createdAt (datetime) --

          The date and time when the agreement approval was created.

        • updatedAt (datetime) --

          The date and time when the agreement approval was last updated.

        • startedAt (datetime) --

          The date and time when approvers could start acting on the agreement approval.

        • expiresAt (datetime) --

          The date and time when the agreement approval expires if it isn't approved or rejected.

        • approvalNeededBy (datetime) --

          The date and time by which the agreement approval must be completed.

RejectAgreementApproval (new) Link ¶

Allows the management account or a delegated administrator of the buyer's AWS organization to reject an agreement approval that is in PENDING_APPROVAL status, as the organization administrator approver or on behalf of another approver. Once rejected, the agreement approval and its agreement request transition to REJECTED status. You must provide a reason for the rejection.

See also: AWS API Documentation

Request Syntax

client.reject_agreement_approval(
    buyerAgreementApprovalRejectionInput={
        'agreementApprovalId': 'string',
        'note': 'string',
        'approverOutcomeIdToOverride': 'string'
    }
)
type buyerAgreementApprovalRejectionInput:

dict

param buyerAgreementApprovalRejectionInput:

The rejection decision for an agreement approval that the buyer's organization requires.

  • agreementApprovalId (string) -- [REQUIRED]

    The unique identifier of the agreement approval to reject.

  • note (string) -- [REQUIRED]

    The reason for the rejection.

  • approverOutcomeIdToOverride (string) --

    The approverOutcomeId of the approver to decide on behalf of. You must be the management account or a delegated administrator of your AWS organization to set this field. Use GetAgreementApproval to retrieve the approverOutcomeId of each approver.

rtype:

dict

returns:

Response Syntax

{}

Response Structure

  • (dict) --

GetAgreementRequestTerms (new) Link ¶

Retrieves the terms proposed for an agreement request, such as pricing, legal, and renewal terms. The acceptor, or the management account or a delegated administrator of the acceptor's AWS organization, can call this operation. This operation is similar to GetAgreementTerms, but it takes an agreementRequestId instead of an agreementId.

See also: AWS API Documentation

Request Syntax

client.get_agreement_request_terms(
    agreementRequestId='string',
    maxResults=123,
    nextToken='string'
)
type agreementRequestId:

string

param agreementRequestId:

[REQUIRED]

The unique identifier of the agreement request.

type maxResults:

integer

param maxResults:

The maximum number of terms to return in the response.

type nextToken:

string

param nextToken:

A token to specify where to start pagination.

rtype:

dict

returns:

Response Syntax

{
    'terms': [
        {
            'legalTerm': {
                'type': 'string',
                'id': 'string',
                'documents': [
                    {
                        'type': 'string',
                        'url': 'string',
                        'version': 'string'
                    },
                ]
            },
            'supportTerm': {
                'type': 'string',
                'id': 'string',
                'refundPolicy': 'string'
            },
            'renewalTerm': {
                'type': 'string',
                'id': 'string',
                'configuration': {
                    'enableAutoRenew': True|False
                },
                'lockoutPeriod': 'string',
                'maxRenewals': 123,
                'adjustmentDeadline': 'string',
                'priceIncrease': {
                    'fixedPercentage': {
                        'value': 'string'
                    },
                    'percentageRange': {
                        'minValue': 'string',
                        'maxValue': 'string',
                        'defaultValue': 'string'
                    }
                },
                'termTemplates': [
                    {
                        'paymentScheduleTermTemplate': {
                            'schedule': [
                                {
                                    'chargeDateOffset': 'string',
                                    'chargePercentage': 'string',
                                    'dayOfMonth': 123
                                },
                            ]
                        }
                    },
                ]
            },
            'usageBasedPricingTerm': {
                'type': 'string',
                'id': 'string',
                'currencyCode': 'string',
                'rateCards': [
                    {
                        'rateCard': [
                            {
                                'dimensionKey': 'string',
                                'price': 'string'
                            },
                        ]
                    },
                ]
            },
            'configurableUpfrontPricingTerm': {
                'type': 'string',
                'id': 'string',
                'currencyCode': 'string',
                'rateCards': [
                    {
                        'selector': {
                            'type': 'string',
                            'value': 'string'
                        },
                        'constraints': {
                            'multipleDimensionSelection': 'string',
                            'quantityConfiguration': 'string'
                        },
                        'rateCard': [
                            {
                                'dimensionKey': 'string',
                                'price': 'string'
                            },
                        ]
                    },
                ],
                'configuration': {
                    'selectorValue': 'string',
                    'dimensions': [
                        {
                            'dimensionKey': 'string',
                            'dimensionValue': 123
                        },
                    ]
                }
            },
            'byolPricingTerm': {
                'type': 'string',
                'id': 'string'
            },
            'recurringPaymentTerm': {
                'type': 'string',
                'id': 'string',
                'currencyCode': 'string',
                'billingPeriod': 'string',
                'price': 'string'
            },
            'validityTerm': {
                'type': 'string',
                'id': 'string',
                'agreementDuration': 'string',
                'agreementStartDate': datetime(2015, 1, 1),
                'agreementEndDate': datetime(2015, 1, 1)
            },
            'paymentScheduleTerm': {
                'type': 'string',
                'id': 'string',
                'currencyCode': 'string',
                'schedule': [
                    {
                        'chargeDate': datetime(2015, 1, 1),
                        'chargeAmount': 'string'
                    },
                ]
            },
            'freeTrialPricingTerm': {
                'type': 'string',
                'id': 'string',
                'duration': 'string',
                'grants': [
                    {
                        'dimensionKey': 'string',
                        'maxQuantity': 123
                    },
                ]
            },
            'fixedUpfrontPricingTerm': {
                'type': 'string',
                'id': 'string',
                'currencyCode': 'string',
                'duration': 'string',
                'price': 'string',
                'grants': [
                    {
                        'dimensionKey': 'string',
                        'maxQuantity': 123
                    },
                ]
            },
            'variablePaymentTerm': {
                'type': 'string',
                'id': 'string',
                'currencyCode': 'string',
                'maxTotalChargeAmount': 'string',
                'configuration': {
                    'paymentRequestApprovalStrategy': 'AUTO_APPROVE_ON_EXPIRATION'|'WAIT_FOR_APPROVAL',
                    'expirationDuration': 'string'
                }
            },
            'netPaymentTerm': {
                'type': 'string',
                'id': 'string',
                'paymentDuePeriod': 'string'
            }
        },
    ],
    'nextToken': 'string'
}

Response Structure

  • (dict) --

    • terms (list) --

      The terms proposed for the agreement request. The terms are fixed when the agreement request is created.

      • (dict) --

        A subset of terms proposed by the proposer, which have been requested by the acceptor as part of the agreement request.

        • legalTerm (dict) --

          Defines the list of text agreements proposed to the acceptors. An example is the end user license agreement (EULA).

          • type (string) --

            Category of the term being updated.

          • id (string) --

            The unique identifier for the term.

          • documents (list) --

            List of references to legal resources proposed to the buyers. An example is the EULA.

            • (dict) --

              Includes the list of references to legal resources proposed by the proposer to the acceptor. Each DocumentItem refers to an individual reference.

              • type (string) --

                Category of the document. Document types include:

                • CustomEula – A custom EULA provided by you as seller. A URL for a EULA stored in an accessible Amazon S3 bucket is required for this document type.

                • CustomDsa – A custom Data Subscription Agreement (DSA) provided by you as seller. A URL for a DSA stored in an accessible Amazon S3 bucket is required for this document type.

                • StandardEula – The Standard Contract for AWS Marketplace (SCMP). For more information about SCMP, see the AWS Marketplace Seller Guide. You don't provide a URL for this type because it's managed by AWS Marketplace.

                • StandardDsa – DSA for AWS Marketplace. For more information about the DSA, see the AWS Data Exchange User Guide. You don't provide a URL for this type because it's managed by AWS Marketplace.

              • url (string) --

                A URL to the legal document for buyers to read. Required when Type is CustomEula.

              • version (string) --

                Version of standard contracts provided by AWS Marketplace. Required when Type is StandardEula or StandardDsa.

        • supportTerm (dict) --

          Defines the customer support available for the acceptors when they purchase the software.

          • type (string) --

            Category of the term being updated.

          • id (string) --

            The unique identifier for the term.

          • refundPolicy (string) --

            Free-text field about the refund policy description that will be shown to customers as is on the website and console.

        • renewalTerm (dict) --

          Defines that on graceful expiration of the agreement (when the agreement ends on its pre-defined end date), a new agreement will be created using the accepted terms on the existing agreement. In other words, the agreement will be renewed. Presence of RenewalTerm in the offer document means that auto-renewal is allowed. The acceptor will have the option to accept or decline auto-renewal at the offer acceptance/agreement creation. The acceptor can also change this flag from True to False or False to True, within the limits set by LockoutPeriod and MaxRenewals. Setting the flag to True doesn't by itself guarantee that the agreement renews, because the proposer can also opt out.

          • type (string) --

            Category of the term being updated.

          • id (string) --

            The unique identifier for the term.

          • configuration (dict) --

            Additional parameters specified by the acceptor while accepting the term.

            • enableAutoRenew (boolean) --

              Defines whether the acceptor has chosen to auto-renew the agreement when it reaches its end date. Can be set to True or False. The acceptor can change this value within the limits set by LockoutPeriod and MaxRenewals.

          • lockoutPeriod (string) --

            The renewal decision deadline, measured back from the end date of the agreement. This is the last day either party can opt in to or opt out of the renewal. The duration is represented in the ISO 8601 format in whole days (for example, P30D for 30 days or P60D for 60 days).

            The field is null when no renewal decision deadline is set. In that case, either party can change the auto-renewal decision up to the end date of the agreement.

          • maxRenewals (integer) --

            The maximum number of times the agreement can be renewed. The field is null when the number of renewals is unlimited.

            After the agreement reaches this limit, it expires on its end date instead of renewing.

          • adjustmentDeadline (string) --

            The date by which the proposer must finalize the price increase for the next renewal, measured back from the end date of the agreement. The duration is represented in the ISO 8601 format in whole days (for example, P30D for 30 days or P60D for 60 days).

            This field applies only when PriceIncrease is a PercentageRange. The field is null when PriceIncrease is a FixedPercentage, because the price increase is already fixed and there is nothing for the proposer to finalize. If the proposer doesn't finalize a value by the adjustment deadline, the DefaultValue of the range applies.

            AdjustmentDeadline must be greater than LockoutPeriod.

          • priceIncrease (dict) --

            The price increase that is applied each time the agreement renews. The field is null when the price doesn't change at renewal.

            • fixedPercentage (dict) --

              A fixed price increase percentage that is applied at each renewal.

              • value (string) --

                The percentage by which the price increases at each renewal, from 0.00 to 100.00 with up to two decimal places. A value of 0.00 means that the agreement renews at the same price.

            • percentageRange (dict) --

              A range of price increase percentages that the proposer can choose from before the adjustment deadline of the agreement.

              • minValue (string) --

                The lowest percentage that the proposer can choose, from 0.00 to 100.00 with up to two decimal places.

              • maxValue (string) --

                The highest percentage that the proposer can choose, from 0.00 to 100.00 with up to two decimal places.

              • defaultValue (string) --

                The percentage that is applied if the proposer doesn't choose a value before the adjustment deadline. Valid values range from 0.00 to 100.00, with up to two decimal places.

          • termTemplates (list) --

            Defines how specific terms change each time the agreement renews. The field is null when no terms change at renewal.

            • (dict) --

              Defines how a specific type of term changes each time the agreement renews. Exactly one of the following fields is set.

              • paymentScheduleTermTemplate (dict) --

                Defines the payment schedule that is applied to the renewed agreement.

                • schedule (list) --

                  The installments that make up the payment schedule of the renewed agreement. The ChargePercentage values of all installments add up to 100.

                  • (dict) --

                    A single installment in a payment schedule template. Because the start date of the renewed agreement isn't known when the offer is created, the charge date of each installment is expressed as an offset from that start date rather than as an absolute date.

                    • chargeDateOffset (string) --

                      The time between the start date of the renewed agreement and the date this installment is charged. The duration is represented in the ISO 8601 format in either whole months or whole days (for example, P1M for 1 month or P30D for 30 days). All installments in a schedule use the same unit.

                    • chargePercentage (string) --

                      The percentage of the total contract value of the renewed agreement that is charged in this installment. Valid values range from 0.01 to 100.00, with up to two decimal places.

                    • dayOfMonth (integer) --

                      The day of the month on which this installment is charged, from 1 to 31. Use this field to anchor the charge to a specific calendar day within the month identified by ChargeDateOffset. This field is supported only when ChargeDateOffset is expressed in months.

        • usageBasedPricingTerm (dict) --

          Defines a usage-based pricing model (typically, pay-as-you-go pricing), where the customers are charged based on product usage.

          • type (string) --

            Category of the term.

          • id (string) --

            The unique identifier for the term.

          • currencyCode (string) --

            Defines the currency for the prices mentioned in the term.

          • rateCards (list) --

            List of rate cards.

            • (dict) --

              Within the pay-as-you-go model defined under UsageBasedPricingTerm, the UsageBasedRateCardItem defines an individual rate for a product dimension.

              • rateCard (list) --

                Defines the per unit rates for product dimensions.

                • (dict) --

                  Defines the per unit rates for each individual product dimension.

                  • dimensionKey (string) --

                    Dimension for which the given entitlement applies. Dimensions represent categories of capacity in a product and are specified when the product is listed in AWS Marketplace.

                  • price (string) --

                    Per unit price for the product dimension that's used for calculating the amount to be charged.

        • configurableUpfrontPricingTerm (dict) --

          Defines a prepaid payment model that allows buyers to configure the entitlements they want to purchase and the duration.

          • type (string) --

            Category of the term.

          • id (string) --

            The unique identifier of the term.

          • currencyCode (string) --

            Defines the currency for the prices mentioned in the term.

          • rateCards (list) --

            A rate card defines the per unit rates for product dimensions.

            • (dict) --

              Within the prepaid payment model defined under ConfigurableUpfrontPricingTerm, the RateCardItem defines all the various rate cards (including pricing and dimensions) that have been proposed.

              • selector (dict) --

                Differentiates between the mutually exclusive rate cards in the same pricing term to be selected by the buyer.

                • type (string) --

                  Category of selector.

                • value (string) --

                  Contract duration. This field supports the ISO 8601 format.

              • constraints (dict) --

                Defines limits on how the term can be configured by acceptors.

                • multipleDimensionSelection (string) --

                  Determines if buyers are allowed to select multiple dimensions in the rate card. The possible values are Allowed and Disallowed. The default value is Allowed.

                • quantityConfiguration (string) --

                  Determines if acceptors are allowed to configure quantity for each dimension in rate card. The possible values are Allowed and Disallowed. The default value is Allowed.

              • rateCard (list) --

                Defines the per unit rates for product dimensions.

                • (dict) --

                  Defines the per unit rates for each individual product dimension.

                  • dimensionKey (string) --

                    Dimension for which the given entitlement applies. Dimensions represent categories of capacity in a product and are specified when the product is listed in AWS Marketplace.

                  • price (string) --

                    Per unit price for the product dimension that's used for calculating the amount to be charged.

          • configuration (dict) --

            Additional parameters specified by the acceptor while accepting the term.

            • selectorValue (string) --

              Defines the length of time for which the particular pricing/dimension is being purchased by the acceptor.

            • dimensions (list) --

              Defines the dimensions that the acceptor has purchased from the overall set of dimensions presented in the rate card.

              • (dict) --

                Defines the dimensions that the acceptor has purchased from the overall set of dimensions presented in the rate card.

                • dimensionKey (string) --

                  The name of key value of the dimension.

                • dimensionValue (integer) --

                  The number of units of the dimension the acceptor has purchased.

        • byolPricingTerm (dict) --

          Enables you and your customers to move your existing agreements to AWS Marketplace. The customer won't be charged for product usage in AWS Marketplace because they already paid for the product outside of AWS Marketplace.

          • type (string) --

            Type of the term being updated.

          • id (string) --

            The unique identifier for the term.

        • recurringPaymentTerm (dict) --

          Defines a pricing model where customers are charged a fixed recurring price at the end of each billing period.

          • type (string) --

            Type of the term being updated.

          • id (string) --

            The unique identifier for the term.

          • currencyCode (string) --

            Defines the currency for the prices mentioned in this term.

          • billingPeriod (string) --

            Defines the recurrence at which buyers are charged.

          • price (string) --

            Amount charged to the buyer every billing period.

        • validityTerm (dict) --

          Defines the conditions that will keep an agreement created from this offer valid.

          • type (string) --

            Category of the term being updated.

          • id (string) --

            The unique identifier for the term.

          • agreementDuration (string) --

            Defines the duration that the agreement remains active. If AgreementStartDate isn't provided, the agreement duration is relative to the agreement signature time. The duration is represented in the ISO_8601 format.

          • agreementStartDate (datetime) --

            Defines the date when agreement starts. The agreement starts at 00:00:00.000 UTC on the date provided. If AgreementStartDate isn't provided, the agreement start date is determined based on agreement signature time.

          • agreementEndDate (datetime) --

            Defines the date when the agreement ends. The agreement ends at 23:59:59.999 UTC on the date provided. If AgreementEndDate isn't provided, the agreement end date is determined by the validity of individual terms.

        • paymentScheduleTerm (dict) --

          Defines an installment-based pricing model where customers are charged a fixed price on different dates during the agreement validity period. This is used most commonly for flexible payment schedule pricing.

          • type (string) --

            Type of the term.

          • id (string) --

            The unique identifier for the term.

          • currencyCode (string) --

            Defines the currency for the prices mentioned in the term.

          • schedule (list) --

            List of the payment schedule where each element defines one installment of payment. It contains the information necessary for calculating the price.

            • (dict) --

              An individual installment of the payment that includes the date and amount of the charge.

              • chargeDate (datetime) --

                The date that the customer would pay the price defined in this payment schedule term. Invoices are generated on the date provided.

              • chargeAmount (string) --

                The price that the customer would pay on the scheduled date (chargeDate).

        • freeTrialPricingTerm (dict) --

          Defines a short-term free pricing model where the buyers aren't charged anything within a specified limit.

          • type (string) --

            Category of the term.

          • id (string) --

            The unique identifier for the terms.

          • duration (string) --

            Duration of the free trial period. The allowed duration depends on the product type. For SaaS products, the free trial lasts 7 to 90 days.

          • grants (list) --

            Entitlements granted to the acceptor of a free trial as part of an agreement execution.

            • (dict) --

              Entitlements granted to the acceptor of fixed upfront as part of agreement execution.

              • dimensionKey (string) --

                Unique dimension key defined in the product document. Dimensions represent categories of capacity in a product and are specified when the product is listed in AWS Marketplace.

              • maxQuantity (integer) --

                Maximum amount of capacity that the buyer can be entitled to the given dimension of the product. If MaxQuantity is not provided, the buyer will be able to use an unlimited amount of the given dimension.

        • fixedUpfrontPricingTerm (dict) --

          Defines a pre-paid pricing model where the customers are charged a fixed upfront amount.

          • type (string) --

            Category of the term being updated.

          • id (string) --

            The unique identifier for the term.

          • currencyCode (string) --

            Defines the currency for the prices mentioned in this term.

          • duration (string) --

            Contract duration for the terms.

          • price (string) --

            Fixed amount to be charged to the customer when this term is accepted.

          • grants (list) --

            Entitlements granted to the acceptor of fixed upfront as part of agreement execution.

            • (dict) --

              Entitlements granted to the acceptor of fixed upfront as part of agreement execution.

              • dimensionKey (string) --

                Unique dimension key defined in the product document. Dimensions represent categories of capacity in a product and are specified when the product is listed in AWS Marketplace.

              • maxQuantity (integer) --

                Maximum amount of capacity that the buyer can be entitled to the given dimension of the product. If MaxQuantity is not provided, the buyer will be able to use an unlimited amount of the given dimension.

        • variablePaymentTerm (dict) --

          Defines a payment model where sellers can submit variable payment requests up to a maximum charge amount, with configurable approval strategies and expiration timelines.

          • type (string) --

            Type of the term.

          • id (string) --

            The unique identifier for the term.

          • currencyCode (string) --

            Defines the currency for the prices mentioned in the term.

          • maxTotalChargeAmount (string) --

            The maximum total amount that can be charged to the customer through variable payment requests under this term.

          • configuration (dict) --

            Additional parameters specified by the acceptor while accepting the term.

            • paymentRequestApprovalStrategy (string) --

              Defines the strategy for approving payment requests. Values include AUTO_APPROVE_ON_EXPIRATION and WAIT_FOR_APPROVAL

            • expirationDuration (string) --

              Defines the duration after which a payment request is automatically approved if no further action is taken. This only applies when the payment request approval strategy is set to AUTO_APPROVE_ON_EXPIRATION. The duration is represented in the ISO_8601 format (for example, P10D for 10 days).

        • netPaymentTerm (dict) --

          Defines the net payment due period for the agreement, specifying when payment is due after an invoice is issued.

          • type (string) --

            Type of the term being updated.

          • id (string) --

            The unique identifier for the term.

          • paymentDuePeriod (string) --

            The duration after an invoice is issued within which the payment is due. The duration is represented in the ISO 8601 format (for example, P30D for 30 days or P60D for 60 days).

    • nextToken (string) --

      The token used for pagination. The field is null if there are no more results.

GetAgreementApproval (new) Link ¶

Retrieves detailed information about a specific agreement approval, including its approval levels, the approvers at each level, and the decision of each approver. The acceptor, or the management account or a delegated administrator of the acceptor's AWS organization, can call this operation.

See also: AWS API Documentation

Request Syntax

client.get_agreement_approval(
    agreementApprovalId='string'
)
type agreementApprovalId:

string

param agreementApprovalId:

[REQUIRED]

The unique identifier of the agreement approval to retrieve.

rtype:

dict

returns:

Response Syntax

{
    'buyerAgreementApproval': {
        'approvalType': 'BUYER_AGREEMENT_APPROVAL',
        'agreementApprovalId': 'string',
        'name': 'string',
        'agreementRequestId': 'string',
        'status': 'PENDING_APPROVAL'|'APPROVED'|'REJECTED'|'EXPIRED'|'CANCELLED',
        'requester': {
            'accountId': 'string'
        },
        'createdAt': datetime(2015, 1, 1),
        'updatedAt': datetime(2015, 1, 1),
        'startedAt': datetime(2015, 1, 1),
        'expiresAt': datetime(2015, 1, 1),
        'approvalNeededBy': datetime(2015, 1, 1),
        'levels': [
            {
                'name': 'string',
                'groups': [
                    {
                        'approvalCriteria': {
                            'requiredApprovalCount': 123
                        },
                        'approvers': [
                            {
                                'emailApproverOutcome': {
                                    'note': 'string',
                                    'status': 'QUEUED'|'PENDING_APPROVAL'|'APPROVED'|'REJECTED'|'EXPIRED'|'SKIPPED',
                                    'updatedAt': datetime(2015, 1, 1),
                                    'approverOutcomeId': 'string',
                                    'emailAddress': 'string',
                                    'name': 'string',
                                    'purchaseOrders': [
                                        {
                                            'chargeId': 'string',
                                            'purchaseOrderReference': 'string'
                                        },
                                    ],
                                    'overriddenBy': {
                                        'principalArn': 'string'
                                    }
                                },
                                'procurementToolApproverOutcome': {
                                    'note': 'string',
                                    'status': 'QUEUED'|'PENDING_APPROVAL'|'APPROVED'|'REJECTED'|'EXPIRED'|'SKIPPED',
                                    'updatedAt': datetime(2015, 1, 1),
                                    'approverOutcomeId': 'string',
                                    'name': 'string',
                                    'purchaseOrders': [
                                        {
                                            'chargeId': 'string',
                                            'purchaseOrderReference': 'string'
                                        },
                                    ],
                                    'overriddenBy': {
                                        'principalArn': 'string'
                                    }
                                },
                                'awsOrganizationApproverOutcome': {
                                    'note': 'string',
                                    'status': 'QUEUED'|'PENDING_APPROVAL'|'APPROVED'|'REJECTED'|'EXPIRED'|'SKIPPED',
                                    'updatedAt': datetime(2015, 1, 1),
                                    'approverOutcomeId': 'string',
                                    'purchaseOrders': [
                                        {
                                            'chargeId': 'string',
                                            'purchaseOrderReference': 'string'
                                        },
                                    ]
                                }
                            },
                        ]
                    },
                ]
            },
        ],
        'planInput': {
            'planReference': 'string',
            'requesterNote': 'string'
        },
        'proposer': {
            'accountId': 'string',
            'legalName': 'string'
        },
        'proposalSummary': {
            'offerId': 'string',
            'offerSetId': 'string',
            'resources': [
                {
                    'id': 'string',
                    'type': 'string',
                    'name': 'string',
                    'deployedOnAws': 'string'
                },
            ],
            'visibilityScope': 'PUBLIC'|'PRIVATE'
        }
    }
}

Response Structure

  • (dict) --

    • buyerAgreementApproval (dict) --

      The details of the agreement approval, when it is a BUYER_AGREEMENT_APPROVAL.

      • approvalType (string) --

        The type of the agreement approval, which is BUYER_AGREEMENT_APPROVAL.

      • agreementApprovalId (string) --

        The unique identifier of the agreement approval.

      • name (string) --

        The descriptive name of the agreement approval.

      • agreementRequestId (string) --

        The unique identifier of the agreement request that the agreement approval is for. Use GetAgreementRequest to retrieve the agreement request details.

      • status (string) --

        The current status of the agreement approval. Possible values include PENDING_APPROVAL, APPROVED, REJECTED, EXPIRED, and CANCELLED.

      • requester (dict) --

        The account that started the agreement approval.

        • accountId (string) --

          The AWS account ID of the requester, which is the buyer of the agreement request.

      • createdAt (datetime) --

        The date and time when the agreement approval was created.

      • updatedAt (datetime) --

        The date and time when the agreement approval was last updated.

      • startedAt (datetime) --

        The date and time when approvers could start acting on the agreement approval.

      • expiresAt (datetime) --

        The date and time when the agreement approval expires if it isn't approved or rejected.

      • approvalNeededBy (datetime) --

        The date and time by which the agreement approval must be completed.

      • levels (list) --

        The approval levels, in the order they are evaluated. Approvers at a level can act only after the previous level is approved. Each level lists its approvers and the decision of each one.

        • (dict) --

          A level of an agreement approval, with the decision of each approver.

          • name (string) --

            The name of the level.

          • groups (list) --

            The group of approvers at this level.

            • (dict) --

              A group of approvers, the number of approvals the group requires, and the decision of each approver.

              • approvalCriteria (dict) --

                The number of approvers in the group who must approve.

                • requiredApprovalCount (integer) --

                  The number of approvers in the group who must approve before the level is approved.

              • approvers (list) --

                The approvers in the group and the decision of each one.

                • (dict) --

                  An approver in an agreement approval and the approver's decision.

                  • emailApproverOutcome (dict) --

                    The decision of an approver who is identified by an email address.

                    • note (string) --

                      The note that the approver provided with the decision.

                    • status (string) --

                      The decision status of the approver. Possible values include QUEUED, PENDING_APPROVAL, APPROVED, REJECTED, EXPIRED, and SKIPPED.

                    • updatedAt (datetime) --

                      The date and time when the decision was last updated.

                    • approverOutcomeId (string) --

                      The unique identifier of this approver in the agreement approval. An administrator of the buyer's AWS organization passes it as approverOutcomeIdToOverride to decide on the approver's behalf.

                    • emailAddress (string) --

                      The email address of the approver.

                    • name (string) --

                      The name of the approver.

                    • purchaseOrders (list) --

                      The purchase order references that the approver provided with the decision.

                      • (dict) --

                        A purchase order reference for a charge on the agreement request.

                        • chargeId (string) --

                          The unique identifier of the charge to associate the purchase order with. Use GetAgreementRequest to retrieve the charges of the agreement request.

                        • purchaseOrderReference (string) --

                          The purchase order reference to associate with the charge.

                    • overriddenBy (dict) --

                      The identity that decided on the approver's behalf. This field is empty unless an administrator of the buyer's AWS organization decided for the approver.

                      • principalArn (string) --

                        The ARN of the IAM principal that made the call.

                  • procurementToolApproverOutcome (dict) --

                    The decision of a procurement system.

                    • note (string) --

                      The note that the approver provided with the decision.

                    • status (string) --

                      The decision status of the approver. Possible values include QUEUED, PENDING_APPROVAL, APPROVED, REJECTED, EXPIRED, and SKIPPED.

                    • updatedAt (datetime) --

                      The date and time when the decision was last updated.

                    • approverOutcomeId (string) --

                      The unique identifier of this approver in the agreement approval. An administrator of the buyer's AWS organization passes it as approverOutcomeIdToOverride to decide on the approver's behalf.

                    • name (string) --

                      The name of the procurement system.

                    • purchaseOrders (list) --

                      The purchase order references that the approver provided with the decision.

                      • (dict) --

                        A purchase order reference for a charge on the agreement request.

                        • chargeId (string) --

                          The unique identifier of the charge to associate the purchase order with. Use GetAgreementRequest to retrieve the charges of the agreement request.

                        • purchaseOrderReference (string) --

                          The purchase order reference to associate with the charge.

                    • overriddenBy (dict) --

                      The identity that decided on the procurement system's behalf. This field is empty unless an administrator of the buyer's AWS organization decided for the procurement system.

                      • principalArn (string) --

                        The ARN of the IAM principal that made the call.

                  • awsOrganizationApproverOutcome (dict) --

                    The decision of the administrators of the buyer's AWS organization.

                    • note (string) --

                      The note that the approver provided with the decision.

                    • status (string) --

                      The decision status of the approver. Possible values include QUEUED, PENDING_APPROVAL, APPROVED, REJECTED, EXPIRED, and SKIPPED.

                    • updatedAt (datetime) --

                      The date and time when the decision was last updated.

                    • approverOutcomeId (string) --

                      The unique identifier of this approver in the agreement approval.

                    • purchaseOrders (list) --

                      The purchase order references that the approver provided with the decision.

                      • (dict) --

                        A purchase order reference for a charge on the agreement request.

                        • chargeId (string) --

                          The unique identifier of the charge to associate the purchase order with. Use GetAgreementRequest to retrieve the charges of the agreement request.

                        • purchaseOrderReference (string) --

                          The purchase order reference to associate with the charge.

      • planInput (dict) --

        The approval plan and the note that the requester provided in StartAgreementApprovals.

        • planReference (string) --

          The identifier of the approval plan. Use GetAgreementRequestApprovalPlans to retrieve the approval plans of the agreement request.

        • requesterNote (string) --

          An optional note for the approvers, such as the business reason for the purchase (1-1000 characters).

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

        • legalName (string) --

          The legal name of the proposer.

      • proposalSummary (dict) --

        A summary of the proposal received from the proposer.

        • offerId (string) --

          The unique identifier of the offer in AWS Marketplace.

        • offerSetId (string) --

          A unique identifier for the offer set containing this offer.

        • resources (list) --

          The list of resources involved in the agreement.

          • (dict) --

            A resource involved in the agreement, such as a product.

            • id (string) --

              The unique identifier of the resource.

            • type (string) --

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

            • name (string) --

              The name of the product.

            • deployedOnAws (string) --

              Whether the product is deployed on AWS (for example, DEPLOYED).

        • visibilityScope (string) --

          The visibility of the offer. Valid values are PUBLIC and PRIVATE.

GetAgreementRequest (new) Link ¶

Retrieves detailed information about a specific agreement request, including its status, intent, approval requirement, and charges. The acceptor, or the management account or a delegated administrator of the acceptor's AWS organization, can call this operation.

See also: AWS API Documentation

Request Syntax

client.get_agreement_request(
    agreementRequestId='string'
)
type agreementRequestId:

string

param agreementRequestId:

[REQUIRED]

The unique identifier of the agreement request.

rtype:

dict

returns:

Response Syntax

{
    'agreementRequestId': 'string',
    'agreementType': 'string',
    'status': 'DRAFT'|'PENDING_APPROVAL'|'APPROVED'|'ACCEPTED'|'REJECTED'|'CANCELLED',
    'approvalRequirement': 'REQUIRED'|'NOT_REQUIRED',
    'agreementId': 'string',
    'intent': 'NEW'|'AMEND'|'REPLACE',
    'createdAt': datetime(2015, 1, 1),
    'chargeSummary': {
        'currencyCode': 'string',
        'newAgreementValue': 'string',
        'newAgreementValueAfterTax': 'string',
        'expectedCharges': [
            {
                'id': 'string',
                'time': datetime(2015, 1, 1),
                'amount': 'string',
                'amountAfterTax': 'string',
                'timing': 'ON_ACCEPTANCE'|'SCHEDULED'|'BILLING_PERIOD'|'NOT_APPLICABLE',
                'estimatedTaxes': {
                    'breakdown': [
                        {
                            'amount': 'string',
                            'rate': 'string',
                            'type': 'string'
                        },
                    ],
                    'totalAmount': 'string'
                },
                'purchaseOrderReference': 'string'
            },
        ],
        'estimatedTaxes': {
            'breakdown': [
                {
                    'amount': 'string',
                    'rate': 'string',
                    'type': 'string'
                },
            ],
            'totalAmount': 'string'
        },
        'itemizedCharges': [
            {
                'dimensionKey': 'string',
                'newQuantity': 123,
                'oldQuantity': 123,
                'chargeReference': 'string',
                'incrementalChargeAmount': 'string'
            },
        ],
        'invoicingEntity': {
            'legalName': 'string',
            'branchName': 'string'
        }
    },
    'proposer': {
        'accountId': 'string'
    },
    'proposalSummary': {
        'resources': [
            {
                'id': 'string',
                'type': 'string'
            },
        ],
        'offerId': 'string',
        'offerSetId': 'string'
    }
}

Response Structure

  • (dict) --

    • agreementRequestId (string) --

      The unique identifier of the agreement request.

    • agreementType (string) --

      The type of agreement (for example, PurchaseAgreement).

    • status (string) --

      The current status of the agreement request. Possible values include:

      • DRAFT – The agreement request has been created but not yet submitted for approval.

      • PENDING_APPROVAL – The agreement request is waiting for one or more approvers to decide.

      • APPROVED – All required approvals have been granted, but the agreement request wasn't accepted automatically. Call AcceptAgreementRequest to accept it. If the call fails, its error explains why.

      • ACCEPTED – The agreement request has been accepted and the resulting agreement has been created.

      • REJECTED – At least one approver rejected the agreement request. It won't proceed.

      • CANCELLED – The agreement request was cancelled before completion, by the acceptor or because the acceptor's account left its AWS organization.

    • approvalRequirement (string) --

      Indicates whether the agreement request requires approval before it can be accepted. Values are REQUIRED and NOT_REQUIRED.

    • agreementId (string) --

      The unique identifier of the agreement that the agreement request is for.

    • intent (string) --

      The purpose and desired outcome of the agreement request.

      • NEW – Creates a new agreement for terms in the request.

      • AMEND – Modifies an existing agreement with terms that are accepted in the request.

      • REPLACE – Creates a new agreement with accepted terms and replaces the existing agreement.

    • createdAt (datetime) --

      The date and time when the agreement request was created.

    • chargeSummary (dict) --

      Provides details of the charges associated with the agreement request. This is only applicable when a request is created for PurchaseAgreement.

      • currencyCode (string) --

        The three-letter currency code for all charges (for example, USD).

      • newAgreementValue (string) --

        The total value of the agreement, which includes any amendments.

      • newAgreementValueAfterTax (string) --

        Expected new agreement value after estimated taxes are applied.

      • expectedCharges (list) --

        A list of expected charges for the agreement request.

        • (dict) --

          Estimated charge for the request.

          • id (string) --

            Unique identifier of the charge for a given agreement.

          • time (datetime) --

            The date and time when the charge is due to be invoiced. This is available only when the charge date is known.

          • amount (string) --

            The tax-exclusive amount of the charge. Only available when the charge amount is known.

          • amountAfterTax (string) --

            The tax-inclusive amount the acceptor has to pay. The amount is only present for fixed charges.

          • timing (string) --

            Indicates when the charge amount will be incurred. Values include ON_ACCEPTANCE (charged immediately when the agreement request is accepted), BILLING_PERIOD (charged on each billing period), and SCHEDULED (charged at a predetermined future date).

          • estimatedTaxes (dict) --

            Provides an aggregated view of estimated tax information for this specific charge.

            • breakdown (list) --

              A list of tax breakdown information.

              • (dict) --

                Represents a single tax breakdown entry with amount, rate, and type.

                • amount (string) --

                  The estimated tax amount.

                • rate (string) --

                  The tax rate, in decimals.

                • type (string) --

                  The type of tax (for example, VAT, ST, or GST).

            • totalAmount (string) --

              The total amount of tax aggregated from the tax breakdown.

          • purchaseOrderReference (string) --

            The purchase order reference associated with the charge, if any.

      • estimatedTaxes (dict) --

        Provides an aggregated view of estimated tax information for the agreement.

        • breakdown (list) --

          A list of tax breakdown information.

          • (dict) --

            Represents a single tax breakdown entry with amount, rate, and type.

            • amount (string) --

              The estimated tax amount.

            • rate (string) --

              The tax rate, in decimals.

            • type (string) --

              The type of tax (for example, VAT, ST, or GST).

        • totalAmount (string) --

          The total amount of tax aggregated from the tax breakdown.

      • itemizedCharges (list) --

        An itemized list of charges for the agreement request.

        • (dict) --

          A breakdown of individual charges or line items within a billing or pricing context.

          • dimensionKey (string) --

            The dimension key as specified in the accepted term.

          • newQuantity (integer) --

            The requested quantity for this dimension.

          • oldQuantity (integer) --

            The existing quantity for this dimension from the source agreement. This value is 0 for NEW intent.

          • chargeReference (string) --

            The identifier of the expected charge that this itemized charge contributes to.

          • incrementalChargeAmount (string) --

            The total incremental charge amount for this dimension.

      • invoicingEntity (dict) --

        The entity responsible for issuing the invoice.

        • legalName (string) --

          Legal name of the entity issuing the invoice.

        • branchName (string) --

          The branch where the issuing entity is operating from.

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

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

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

GetAgreementContacts (new) Link ¶

Obtains details about the acceptor's contact information for an active agreement that you participate in as the proposer, acceptor, or manufacturer.

See also: AWS API Documentation

Request Syntax

client.get_agreement_contacts(
    agreementId='string'
)
type agreementId:

string

param agreementId:

[REQUIRED]

The unique identifier of the agreement.

rtype:

dict

returns:

Response Syntax

{
    'acceptorContact': {
        'firstName': 'string',
        'lastName': 'string',
        'emailAddress': 'string',
        'companyName': 'string',
        'countryCode': 'string'
    }
}

Response Structure

  • (dict) --

    • acceptorContact (dict) --

      The contact information that the acceptor provided when creating the agreement.

      • firstName (string) --

        The first name of the acceptor contact.

      • lastName (string) --

        The last name of the acceptor contact.

      • emailAddress (string) --

        The email address of the acceptor contact.

      • companyName (string) --

        The name of the company that the acceptor contact represents.

      • countryCode (string) --

        The ISO-3166 two-letter country code for the acceptor contact.

CreateAgreementRequest (updated) Link ¶
Changes (request, response)
Request
{'acceptorContact': {'companyName': 'string',
                     'countryCode': 'string',
                     'emailAddress': 'string',
                     'firstName': 'string',
                     'lastName': 'string'}}
Response
{'agreementType': 'string',
 'approvalRequirement': 'REQUIRED | NOT_REQUIRED',
 'chargeSummary': {'expectedCharges': {'purchaseOrderReference': 'string',
                                       'timing': {'NOT_APPLICABLE'}}},
 'createdAt': 'timestamp',
 'status': 'DRAFT | PENDING_APPROVAL | APPROVED | ACCEPTED | REJECTED | '
           'CANCELLED'}

Creates an agreement request that acts as a quote for the terms you want to accept. The agreement request captures the requested terms, calculates charges, and returns a summary. Use AcceptAgreementRequest with the returned agreementRequestId to finalize the agreement.

See also: AWS API Documentation

Request Syntax

client.create_agreement_request(
    clientToken='string',
    intent='NEW'|'AMEND'|'REPLACE',
    requestedTerms=[
        {
            'id': 'string',
            'configuration': {
                'configurableUpfrontPricingTermConfiguration': {
                    'selectorValue': 'string',
                    'dimensions': [
                        {
                            'dimensionKey': 'string',
                            'dimensionValue': 123
                        },
                    ]
                },
                'renewalTermConfiguration': {
                    'enableAutoRenew': True|False
                },
                'variablePaymentTermConfiguration': {
                    'paymentRequestApprovalStrategy': 'AUTO_APPROVE_ON_EXPIRATION'|'WAIT_FOR_APPROVAL',
                    'expirationDuration': 'string'
                }
            }
        },
    ],
    sourceAgreementIdentifier='string',
    agreementProposalIdentifier='string',
    taxConfiguration={
        'taxEstimation': 'DISABLED'|'ENABLED'
    },
    acceptorContact={
        'firstName': 'string',
        'lastName': 'string',
        'emailAddress': 'string',
        'companyName': 'string',
        'countryCode': 'string'
    }
)
type clientToken:

string

param clientToken:

A unique, case-sensitive identifier that you provide to ensure the idempotency of the request.

This field is autopopulated if not provided.

type intent:

string

param intent:

[REQUIRED]

The purpose and desired outcome of the agreement request. This is a required parameter that determines how the agreement request is processed.

  • NEW – Creates a new agreement for terms in the request.

  • AMEND – Modifies an existing agreement with terms that are accepted in the request.

  • REPLACE – Creates a new agreement with accepted terms and replaces the existing agreement.

type requestedTerms:

list

param requestedTerms:

[REQUIRED]

A list of terms that define what is being accepted as part of the agreement. Some terms require configuration.

  • (dict) --

    Defines what is being accepted as part of the agreement creation or update request, and it includes their configurations.

    • id (string) -- [REQUIRED]

      The unique identifier of the term in the agreement proposal.

    • configuration (dict) --

      Additional configuration for the requested terms. This configuration is applicable only to the terms that accept a customer-provided configuration, such as ConfigurableUpfrontPricingTerm.

      • configurableUpfrontPricingTermConfiguration (dict) --

        Defines a prepaid payment model that allows buyers to configure the entitlements they want to purchase and the duration.

        • selectorValue (string) -- [REQUIRED]

          Defines the length of time for which the particular pricing/dimension is being purchased by the acceptor.

        • dimensions (list) -- [REQUIRED]

          Defines the dimensions that the acceptor has purchased from the overall set of dimensions presented in the rate card.

          • (dict) --

            Defines the dimensions that the acceptor has purchased from the overall set of dimensions presented in the rate card.

            • dimensionKey (string) -- [REQUIRED]

              The name of key value of the dimension.

            • dimensionValue (integer) -- [REQUIRED]

              The number of units of the dimension the acceptor has purchased.

      • renewalTermConfiguration (dict) --

        Additional parameters specified by the acceptor while accepting the term.

        • enableAutoRenew (boolean) -- [REQUIRED]

          Defines whether the acceptor has chosen to auto-renew the agreement when it reaches its end date. Can be set to True or False. The acceptor can change this value within the limits set by LockoutPeriod and MaxRenewals.

      • variablePaymentTermConfiguration (dict) --

        Additional parameters specified by the acceptor while accepting the variable payment term.

        • paymentRequestApprovalStrategy (string) -- [REQUIRED]

          Defines the strategy for approving payment requests. Values include AUTO_APPROVE_ON_EXPIRATION and WAIT_FOR_APPROVAL

        • expirationDuration (string) --

          Defines the duration after which a payment request is automatically approved if no further action is taken. This only applies when the payment request approval strategy is set to AUTO_APPROVE_ON_EXPIRATION. The duration is represented in the ISO_8601 format (for example, P10D for 10 days).

type sourceAgreementIdentifier:

string

param sourceAgreementIdentifier:

The agreement's identifier that the request acts upon.

type agreementProposalIdentifier:

string

param agreementProposalIdentifier:

The agreement proposal signed by the proposer. The proposal includes the requested resources and the terms that outline an agreement outcome.

type taxConfiguration:

dict

param taxConfiguration:

Configuration for tax estimation in the agreement request response.

  • taxEstimation (string) --

    Toggle to estimate tax as part of the response. Values include ENABLED and DISABLED. Default is DISABLED.

type acceptorContact:

dict

param acceptorContact:

The contact information of the acceptor.

  • firstName (string) -- [REQUIRED]

    The first name of the acceptor contact.

  • lastName (string) -- [REQUIRED]

    The last name of the acceptor contact.

  • emailAddress (string) -- [REQUIRED]

    The email address of the acceptor contact.

  • companyName (string) -- [REQUIRED]

    The name of the company that the acceptor contact represents.

  • countryCode (string) -- [REQUIRED]

    The ISO-3166 two-letter country code for the acceptor contact.

rtype:

dict

returns:

Response Syntax

{
    'agreementRequestId': 'string',
    'agreementType': 'string',
    'chargeSummary': {
        'currencyCode': 'string',
        'newAgreementValue': 'string',
        'newAgreementValueAfterTax': 'string',
        'expectedCharges': [
            {
                'id': 'string',
                'time': datetime(2015, 1, 1),
                'amount': 'string',
                'amountAfterTax': 'string',
                'timing': 'ON_ACCEPTANCE'|'SCHEDULED'|'BILLING_PERIOD'|'NOT_APPLICABLE',
                'estimatedTaxes': {
                    'breakdown': [
                        {
                            'amount': 'string',
                            'rate': 'string',
                            'type': 'string'
                        },
                    ],
                    'totalAmount': 'string'
                },
                'purchaseOrderReference': 'string'
            },
        ],
        'estimatedTaxes': {
            'breakdown': [
                {
                    'amount': 'string',
                    'rate': 'string',
                    'type': 'string'
                },
            ],
            'totalAmount': 'string'
        },
        'itemizedCharges': [
            {
                'dimensionKey': 'string',
                'newQuantity': 123,
                'oldQuantity': 123,
                'chargeReference': 'string',
                'incrementalChargeAmount': 'string'
            },
        ],
        'invoicingEntity': {
            'legalName': 'string',
            'branchName': 'string'
        }
    },
    'status': 'DRAFT'|'PENDING_APPROVAL'|'APPROVED'|'ACCEPTED'|'REJECTED'|'CANCELLED',
    'approvalRequirement': 'REQUIRED'|'NOT_REQUIRED',
    'createdAt': datetime(2015, 1, 1)
}

Response Structure

  • (dict) --

    • agreementRequestId (string) --

      The unique identifier of the agreement request created. Use this identifier with AcceptAgreementRequest to accept the agreement.

    • agreementType (string) --

      The type of agreement (for example, PurchaseAgreement).

    • chargeSummary (dict) --

      Provides details of the charges associated with the agreement request. This is only applicable when a request is created for PurchaseAgreement.

      • currencyCode (string) --

        The three-letter currency code for all charges (for example, USD).

      • newAgreementValue (string) --

        The total value of the agreement, which includes any amendments.

      • newAgreementValueAfterTax (string) --

        Expected new agreement value after estimated taxes are applied.

      • expectedCharges (list) --

        A list of expected charges for the agreement request.

        • (dict) --

          Estimated charge for the request.

          • id (string) --

            Unique identifier of the charge for a given agreement.

          • time (datetime) --

            The date and time when the charge is due to be invoiced. This is available only when the charge date is known.

          • amount (string) --

            The tax-exclusive amount of the charge. Only available when the charge amount is known.

          • amountAfterTax (string) --

            The tax-inclusive amount the acceptor has to pay. The amount is only present for fixed charges.

          • timing (string) --

            Indicates when the charge amount will be incurred. Values include ON_ACCEPTANCE (charged immediately when the agreement request is accepted), BILLING_PERIOD (charged on each billing period), and SCHEDULED (charged at a predetermined future date).

          • estimatedTaxes (dict) --

            Provides an aggregated view of estimated tax information for this specific charge.

            • breakdown (list) --

              A list of tax breakdown information.

              • (dict) --

                Represents a single tax breakdown entry with amount, rate, and type.

                • amount (string) --

                  The estimated tax amount.

                • rate (string) --

                  The tax rate, in decimals.

                • type (string) --

                  The type of tax (for example, VAT, ST, or GST).

            • totalAmount (string) --

              The total amount of tax aggregated from the tax breakdown.

          • purchaseOrderReference (string) --

            The purchase order reference associated with the charge, if any.

      • estimatedTaxes (dict) --

        Provides an aggregated view of estimated tax information for the agreement.

        • breakdown (list) --

          A list of tax breakdown information.

          • (dict) --

            Represents a single tax breakdown entry with amount, rate, and type.

            • amount (string) --

              The estimated tax amount.

            • rate (string) --

              The tax rate, in decimals.

            • type (string) --

              The type of tax (for example, VAT, ST, or GST).

        • totalAmount (string) --

          The total amount of tax aggregated from the tax breakdown.

      • itemizedCharges (list) --

        An itemized list of charges for the agreement request.

        • (dict) --

          A breakdown of individual charges or line items within a billing or pricing context.

          • dimensionKey (string) --

            The dimension key as specified in the accepted term.

          • newQuantity (integer) --

            The requested quantity for this dimension.

          • oldQuantity (integer) --

            The existing quantity for this dimension from the source agreement. This value is 0 for NEW intent.

          • chargeReference (string) --

            The identifier of the expected charge that this itemized charge contributes to.

          • incrementalChargeAmount (string) --

            The total incremental charge amount for this dimension.

      • invoicingEntity (dict) --

        The entity responsible for issuing the invoice.

        • legalName (string) --

          Legal name of the entity issuing the invoice.

        • branchName (string) --

          The branch where the issuing entity is operating from.

    • status (string) --

      The current status of the agreement request. Possible values include:

      • DRAFT – The agreement request has been created but not yet submitted for approval.

      • PENDING_APPROVAL – The agreement request is waiting for one or more approvers to decide.

      • APPROVED – All required approvals have been granted, but the agreement request wasn't accepted automatically. Call AcceptAgreementRequest to accept it. If the call fails, its error explains why.

      • ACCEPTED – The agreement request has been accepted and the resulting agreement has been created.

      • REJECTED – At least one approver rejected the agreement request. It won't proceed.

      • CANCELLED – The agreement request was cancelled before completion, by the acceptor or because the acceptor's account left its AWS organization.

    • approvalRequirement (string) --

      Indicates whether the agreement request requires approval before it can be accepted. Values are REQUIRED and NOT_REQUIRED.

    • createdAt (datetime) --

      The date and time when the agreement request was created.

SearchAgreements (updated) Link ¶
Changes (response)
{'agreementViewSummaries': {'includesContactOfType': ['ACCEPTOR']}}

Searches across all agreements that a proposer or an acceptor has in AWS Marketplace. The search returns a list of agreements with basic agreement information.

See also: AWS API Documentation

Request Syntax

client.search_agreements(
    catalog='string',
    filters=[
        {
            'name': 'string',
            'values': [
                'string',
            ]
        },
    ],
    sort={
        'sortBy': 'string',
        'sortOrder': 'ASCENDING'|'DESCENDING'
    },
    maxResults=123,
    nextToken='string'
)
type catalog:

string

param catalog:

The catalog in which the agreement was created.

type filters:

list

param filters:

The filter name and value pair used to return a specific list of results.

The following filters are supported:

  • ResourceIdentifier – The unique identifier of the resource.

  • ResourceType – Type of the resource, which is the product ( AmiProduct, ContainerProduct, SaaSProduct, ProfessionalServicesProduct, or MachineLearningProduct).

  • PartyType – The party type of the caller. Use Proposer or Acceptor.

  • AcceptorAccountId – The AWS account ID of the party accepting the agreement terms.

  • OfferId – The unique identifier of the offer in which the terms are registered in the agreement token.

  • Status – The current status of the agreement. Values include ACTIVE, CANCELLED, EXPIRED, RENEWED, REPLACED, and TERMINATED.

  • BeforeEndTime – A date used to filter agreements with a date before the endTime of an agreement.

  • AfterEndTime – A date used to filter agreements with a date after the endTime of an agreement.

  • BeforeStartTime – A date used to filter agreements with a date before the startTime of an agreement.

  • AfterStartTime – A date used to filter agreements with a date after the startTime of an agreement.

  • BeforeLastUpdateTime – A date used to filter agreements with a date before the lastUpdateTime of an agreement.

  • AfterLastUpdateTime – A date used to filter agreements with a date after the lastUpdateTime of an agreement.

  • AgreementType – The type of agreement. Supported value includes PurchaseAgreement.

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

  • EndTimeBehaviorType – What happens to the agreement when it reaches its end date. Values include RENEW, REPLACE, and EXPIRE.

  • EndTimeBehaviorReasonCode – The reason why the agreement doesn't renew at its end date. Values include PROPOSER_RENEW_OPTED_OUT, ACCEPTOR_RENEW_OPTED_OUT, NO_RENEWAL_TERM, and RENEWAL_LIMIT_EXHAUSTED.

  • InitialAgreementId – The unique identifier of the very first agreement in a chain of related agreements. Use this filter to return every agreement in the same chain.

  • LicenseArn – The Amazon Resource Name (ARN) of the AWS License Manager license associated with an entitlement granted by the agreement.

  • IncludesContactOfType – The type of contact information on file for the agreement. Supported value includes ACCEPTOR.

A proposer can use any combination of the preceding filters along with AgreementType, which is required.

The following filter combinations are supported when the PartyType is Acceptor:

  • AgreementType

  • AgreementType + Status

  • AgreementType + EndTime

  • AgreementType + Status + EndTime

  • AgreementType + ResourceIdentifier

  • AgreementType + ResourceIdentifier + EndTime

  • AgreementType + ResourceIdentifier + Status

  • AgreementType + ResourceIdentifier + Status + EndTime

  • AgreementType + ResourceType

  • AgreementType + ResourceType + EndTime

  • AgreementType + OfferId

  • AgreementType + OfferId + EndTime

  • AgreementType + OfferId + Status

  • AgreementType + OfferId + Status + EndTime

  • AgreementType + OfferSetId

  • AgreementType + OfferSetId + EndTime

  • AgreementType + OfferSetId + Status

  • AgreementType + OfferSetId + Status + EndTime

  • (dict) --

    The filter name and value pair that is used to return a more specific list of results. Filters can be used to match a set of resources by various criteria, such as offerId or productId.

    • name (string) --

      The name of the filter.

    • values (list) --

      The filter value.

      • (string) --

type sort:

dict

param sort:

An object that contains the SortBy and SortOrder attributes. For SearchAgreements, SortBy supports EndTime for both party types, and StartTime and LastUpdateTime only when PartyType is Proposer. The default SortBy value is EndTime.

  • sortBy (string) --

    The attribute on which the data is grouped, which can be EndTime, StartTime, or LastUpdateTime. StartTime and LastUpdateTime are supported only when PartyType is Proposer. The default value is EndTime.

  • sortOrder (string) --

    The sorting order, which can be ASCENDING or DESCENDING. The default value is ASCENDING.

type maxResults:

integer

param maxResults:

The maximum number of agreements to return in the response.

type nextToken:

string

param nextToken:

A token to specify where to start pagination.

rtype:

dict

returns:

Response Syntax

{
    'agreementViewSummaries': [
        {
            'agreementId': 'string',
            'acceptanceTime': datetime(2015, 1, 1),
            'startTime': datetime(2015, 1, 1),
            'endTime': datetime(2015, 1, 1),
            'lastUpdateTime': datetime(2015, 1, 1),
            'agreementType': 'string',
            'acceptor': {
                'accountId': 'string'
            },
            'proposer': {
                'accountId': 'string'
            },
            'proposalSummary': {
                'resources': [
                    {
                        'id': 'string',
                        'type': 'string'
                    },
                ],
                'offerId': 'string',
                'offerSetId': 'string'
            },
            'status': 'ACTIVE'|'ARCHIVED'|'CANCELLED'|'EXPIRED'|'RENEWED'|'REPLACED'|'ROLLED_BACK'|'SUPERSEDED'|'TERMINATED',
            'entitlements': [
                {
                    'licenseArn': 'string'
                },
            ],
            'initialAgreementId': 'string',
            'endTimeBehaviorType': 'RENEW'|'REPLACE'|'EXPIRE',
            'endTimeBehaviorReasonCode': 'PROPOSER_RENEW_OPTED_OUT'|'ACCEPTOR_RENEW_OPTED_OUT'|'NO_RENEWAL_TERM'|'RENEWAL_LIMIT_EXHAUSTED',
            'freeTrialEndTime': datetime(2015, 1, 1),
            'includesContactOfType': [
                'ACCEPTOR',
            ]
        },
    ],
    'nextToken': 'string'
}

Response Structure

  • (dict) --

    • agreementViewSummaries (list) --

      A summary of the agreement, including top-level attributes (for example, the agreement ID, proposer, and acceptor).

      • (dict) --

        A summary of the agreement, including top-level attributes (for example, the agreement ID, proposer, and acceptor).

        • agreementId (string) --

          The unique identifier of the agreement.

        • acceptanceTime (datetime) --

          The date and time that the agreement was accepted.

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

        • lastUpdateTime (datetime) --

          The date and time when the agreement was last updated. An agreement is updated when any of its attributes or accepted terms change. Amendments, renewals, and a party changing whether the agreement renews are all examples.

          Use the BeforeLastUpdateTime and AfterLastUpdateTime filters to search on this value, and LastUpdateTime as the SortBy value to sort by it. Sorting by LastUpdateTime is supported only when PartyType is Proposer.

        • agreementType (string) --

          The type of agreement.

        • acceptor (dict) --

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

          Details of the party proposing the agreement terms, most commonly the seller for PurchaseAgreement.

          • accountId (string) --

            The AWS account ID of the proposer.

        • proposalSummary (dict) --

          A summary of the proposal

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

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

        • entitlements (list) --

          A list of entitlements associated with the agreement.

          • (dict) --

            Represents an entitlement associated with an agreement.

            • licenseArn (string) --

              The Amazon Resource Name (ARN) of the AWS License Manager license associated with the entitlement.

        • 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. You can also use it as the InitialAgreementId filter value to return every agreement in the same chain.

        • endTimeBehaviorType (string) --

          The behavior of the agreement when it reaches its end date. The field is null for agreements that have no end date, because those agreements never reach an end time.

          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.

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

        • freeTrialEndTime (datetime) --

          The date and time when the free trial of the agreement ends. This field is present only when the agreement includes a free trial.

          For an agreement that includes both a free trial and usage-based pricing, the agreement converts to paid usage at this time.

        • includesContactOfType (list) --

          The types of contact information on file for the agreement. For example, ACCEPTOR indicates that the acceptor's contact information is on file, which you can retrieve with GetAgreementContacts.

          • (string) --

    • nextToken (string) --

      The token used for pagination. The field is null if there are no more results.