Skip to content
AWS for Query.Farm

aws.marketplace_agreement.get_agreement_terms

Example SQL Queries

SELECT * FROM
aws.marketplace_agreement.get_agreement_terms
WHERE
"agreement_id" = 'VALUE';

Description

Obtains details about the terms in an agreement that you participated in as proposer or acceptor.

The details include:

  • TermType – The type of term, such as LegalTerm, RenewalTerm, or ConfigurableUpfrontPricingTerm.

  • TermID – The ID of the particular term, which is common between offer and agreement.

  • TermPayload – The key information contained in the term, such as the EULA for LegalTerm or pricing and dimensions for various pricing terms, such as ConfigurableUpfrontPricingTerm or UsageBasedPricingTerm.

  • Configuration – The buyer/acceptor's selection at the time of agreement creation, such as the number of units purchased for a dimension or setting the EnableAutoRenew flag.

Table Definition

Column NameColumn Data Type
agreement_id Required Input Column

The unique identifier of the agreement.

VARCHAR
max_results Input Column

The maximum number of agreements to return in the response.

BIGINT
next_token Input Column

A token to specify where to start pagination

VARCHAR
_aws_profile Input Column

The AWS profile defines the AWS identity used. It can be defined via credentials or by assuming a IAM role.

STRUCT(
    "type" VARCHAR,
    "name" VARCHAR,
    "account_id" VARCHAR,
    "via_profile_name" VARCHAR,
    "assumed_role_arn" VARCHAR,
    "organization" STRUCT(
        "account_name" VARCHAR,
        "id" VARCHAR,
        "tags" STRUCT(
            "key" VARCHAR,
            "value" VARCHAR
        )[],
        "master_account" STRUCT(
            "id" VARCHAR,
            "email" VARCHAR
        ),
        "parents" STRUCT(
            "type" VARCHAR,
            "id" VARCHAR,
            "name" VARCHAR,
            "tags" STRUCT(
                "key" VARCHAR,
                "value" VARCHAR
            )[]
        )[]
    )
)
Show child fields
_aws_profile.account_id

The AWS account id

_aws_profile.assumed_role_arn

The ARN of the assumed role

_aws_profile.name

The unique name of the profile.

_aws_profile.organization

Information about this profile's membership in the AWS organization.

Show child fields
_aws_profile.organization.account_name

The name of account speciifed by the organization

_aws_profile.organization.id

The organization id

_aws_profile.organization.master_account
Show child fields
_aws_profile.organization.master_account.email

The organization master account email address

_aws_profile.organization.master_account.id

The organization master account id

_aws_profile.organization.parents[]
Show child fields
_aws_profile.organization.parents[].id

The id of the parent

_aws_profile.organization.parents[].name

The name of the parent

_aws_profile.organization.parents[].tags[]
Show child fields
_aws_profile.organization.parents[].tags[].key
_aws_profile.organization.parents[].tags[].value
_aws_profile.organization.parents[].type

The type of parent can be an organization unit or a root

_aws_profile.organization.tags[]
Show child fields
_aws_profile.organization.tags[].key
_aws_profile.organization.tags[].value
_aws_profile.type

The type of profile, either 'credentials' or 'assumed_role'

_aws_profile.via_profile_name

This IAM role for this profile is assumed by first utilizing another profile with this name to obtain credentials.

accepted_terms

A subset of terms proposed by the proposer that have been accepted by the acceptor as part of the agreement creation.

STRUCT(
    "byol_pricing_term" STRUCT(
        "type" VARCHAR
    ),
    "configurable_upfront_pricing_term" STRUCT(
        "configuration" STRUCT(
            "dimensions" STRUCT(
                "dimension_key" VARCHAR,
                "dimension_value" BIGINT
            )[],
            "selector_value" VARCHAR
        ),
        "currency_code" VARCHAR,
        "rate_cards" STRUCT(
            "constraints" STRUCT(
                "multiple_dimension_selection" VARCHAR,
                "quantity_configuration" VARCHAR
            ),
            "rate_card" STRUCT(
                "dimension_key" VARCHAR,
                "price" VARCHAR
            )[],
            "selector" STRUCT(
                "type" VARCHAR,
                "value" VARCHAR
            )
        )[],
        "type" VARCHAR
    ),
    "fixed_upfront_pricing_term" STRUCT(
        "currency_code" VARCHAR,
        "duration" VARCHAR,
        "grants" STRUCT(
            "dimension_key" VARCHAR,
            "max_quantity" BIGINT
        )[],
        "price" VARCHAR,
        "type" VARCHAR
    ),
    "free_trial_pricing_term" STRUCT(
        "duration" VARCHAR,
        "grants" STRUCT(
            "dimension_key" VARCHAR,
            "max_quantity" BIGINT
        )[],
        "type" VARCHAR
    ),
    "legal_term" STRUCT(
        "documents" STRUCT(
            "type" VARCHAR,
            "url" VARCHAR,
            "version" VARCHAR
        )[],
        "type" VARCHAR
    ),
    "payment_schedule_term" STRUCT(
        "currency_code" VARCHAR,
        "schedule" STRUCT(
            "charge_amount" VARCHAR,
            "charge_date" TIMESTAMP_S
        )[],
        "type" VARCHAR
    ),
    "recurring_payment_term" STRUCT(
        "billing_period" VARCHAR,
        "currency_code" VARCHAR,
        "price" VARCHAR,
        "type" VARCHAR
    ),
    "renewal_term" STRUCT(
        "configuration" STRUCT(
            "enable_auto_renew" BOOLEAN
        ),
        "type" VARCHAR
    ),
    "support_term" STRUCT(
        "refund_policy" VARCHAR,
        "type" VARCHAR
    ),
    "usage_based_pricing_term" STRUCT(
        "currency_code" VARCHAR,
        "rate_cards" STRUCT(
            "rate_card" STRUCT(
                "dimension_key" VARCHAR,
                "price" VARCHAR
            )[]
        )[],
        "type" VARCHAR
    ),
    "validity_term" STRUCT(
        "agreement_duration" VARCHAR,
        "agreement_end_date" TIMESTAMP_S,
        "agreement_start_date" TIMESTAMP_S,
        "type" VARCHAR
    )
)[]
Show child fields
accepted_terms[]
Show child fields
accepted_terms[].byol_pricing_term

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.

Show child fields
accepted_terms[].byol_pricing_term.type

Type of the term being updated.

accepted_terms[].configurable_upfront_pricing_term

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

Show child fields
accepted_terms[].configurable_upfront_pricing_term.configuration

Additional parameters specified by the acceptor while accepting the term.

Show child fields
accepted_terms[].configurable_upfront_pricing_term.configuration.dimensions[]
Show child fields
accepted_terms[].configurable_upfront_pricing_term.configuration.dimensions[].dimension_key

The name of key value of the dimension.

accepted_terms[].configurable_upfront_pricing_term.configuration.dimensions[].dimension_value

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

For Agreements with ConfigurableUpfrontPricingTerm, the RateCard section will define the prices and dimensions defined by the seller (proposer), whereas the Configuration section will define the actual dimensions, prices, and units the buyer has chosen to accept.

accepted_terms[].configurable_upfront_pricing_term.configuration.selector_value

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

accepted_terms[].configurable_upfront_pricing_term.currency_code

Defines the currency for the prices mentioned in the term.

accepted_terms[].configurable_upfront_pricing_term.rate_cards[]
Show child fields
accepted_terms[].configurable_upfront_pricing_term.rate_cards[].constraints

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

Show child fields
accepted_terms[].configurable_upfront_pricing_term.rate_cards[].constraints.multiple_dimension_selection

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.

accepted_terms[].configurable_upfront_pricing_term.rate_cards[].constraints.quantity_configuration

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.

accepted_terms[].configurable_upfront_pricing_term.rate_cards[].rate_card[]
Show child fields
accepted_terms[].configurable_upfront_pricing_term.rate_cards[].rate_card[].dimension_key

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.

accepted_terms[].configurable_upfront_pricing_term.rate_cards[].rate_card[].price

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

accepted_terms[].configurable_upfront_pricing_term.rate_cards[].selector

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

Show child fields
accepted_terms[].configurable_upfront_pricing_term.rate_cards[].selector.type

Category of selector.

accepted_terms[].configurable_upfront_pricing_term.rate_cards[].selector.value

Contract duration. This field supports the ISO 8601 format.

accepted_terms[].configurable_upfront_pricing_term.type

Category of selector.

accepted_terms[].fixed_upfront_pricing_term

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

Show child fields
accepted_terms[].fixed_upfront_pricing_term.currency_code

Defines the currency for the prices mentioned in this term.

accepted_terms[].fixed_upfront_pricing_term.duration

Contract duration for the terms.

accepted_terms[].fixed_upfront_pricing_term.grants[]
Show child fields
accepted_terms[].fixed_upfront_pricing_term.grants[].dimension_key

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.

accepted_terms[].fixed_upfront_pricing_term.grants[].max_quantity

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.

accepted_terms[].fixed_upfront_pricing_term.price

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

accepted_terms[].fixed_upfront_pricing_term.type

Category of the term being updated.

accepted_terms[].free_trial_pricing_term

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

Show child fields
accepted_terms[].free_trial_pricing_term.duration

Duration of the free trial period (5–31 days).

accepted_terms[].free_trial_pricing_term.grants[]
Show child fields
accepted_terms[].free_trial_pricing_term.grants[].dimension_key

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.

accepted_terms[].free_trial_pricing_term.grants[].max_quantity

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.

accepted_terms[].free_trial_pricing_term.type

Category of the term.

accepted_terms[].legal_term

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

Show child fields
accepted_terms[].legal_term.documents[]
Show child fields
accepted_terms[].legal_term.documents[].type

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.

accepted_terms[].legal_term.documents[].url

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

accepted_terms[].legal_term.documents[].version

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

accepted_terms[].legal_term.type

Category of the term being updated.

accepted_terms[].payment_schedule_term

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.

Show child fields
accepted_terms[].payment_schedule_term.currency_code

Defines the currency for the prices mentioned in the term.

accepted_terms[].payment_schedule_term.schedule[]
Show child fields
accepted_terms[].payment_schedule_term.schedule[].charge_amount

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

accepted_terms[].payment_schedule_term.schedule[].charge_date

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

accepted_terms[].payment_schedule_term.type

Type of the term.

accepted_terms[].recurring_payment_term

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

Show child fields
accepted_terms[].recurring_payment_term.billing_period

Defines the recurrence at which buyers are charged.

accepted_terms[].recurring_payment_term.currency_code

Defines the currency for the prices mentioned in this term.

accepted_terms[].recurring_payment_term.price

Amount charged to the buyer every billing period.

accepted_terms[].recurring_payment_term.type

Type of the term being updated.

accepted_terms[].renewal_term

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. Buyers will have the option to accept or decline auto-renewal at the offer acceptance/agreement creation. Buyers can also change this flag from True to False or False to True at anytime during the agreement's lifecycle.

Show child fields
accepted_terms[].renewal_term.configuration

Additional parameters specified by the acceptor while accepting the term.

Show child fields
accepted_terms[].renewal_term.configuration.enable_auto_renew

Defines whether the acceptor has chosen to auto-renew the agreement at the end of its lifecycle. Can be set to True or False.

accepted_terms[].renewal_term.type

Category of the term being updated.

accepted_terms[].support_term

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

Show child fields
accepted_terms[].support_term.refund_policy

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

accepted_terms[].support_term.type

Category of the term being updated.

accepted_terms[].usage_based_pricing_term

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

Show child fields
accepted_terms[].usage_based_pricing_term.currency_code

Defines the currency for the prices mentioned in the term.

accepted_terms[].usage_based_pricing_term.rate_cards[]
Show child fields
accepted_terms[].usage_based_pricing_term.rate_cards[].rate_card[]
Show child fields
accepted_terms[].usage_based_pricing_term.rate_cards[].rate_card[].dimension_key

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.

accepted_terms[].usage_based_pricing_term.rate_cards[].rate_card[].price

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

accepted_terms[].usage_based_pricing_term.type

Category of the term.

accepted_terms[].validity_term

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

Show child fields
accepted_terms[].validity_term.agreement_duration

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.

accepted_terms[].validity_term.agreement_end_date

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.

accepted_terms[].validity_term.agreement_start_date

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.

accepted_terms[].validity_term.type

Category of the term being updated.