MarketplaceDiscovery / Paginator / GetOfferTerms

GetOfferTerms¶

class MarketplaceDiscovery.Paginator.GetOfferTerms¶

paginator = client.get_paginator('get_offer_terms')

paginate(**kwargs)¶

Creates an iterator that will paginate through responses from MarketplaceDiscovery.Client.get_offer_terms().

Request Syntax

response_iterator = paginator.paginate(
    offerId='string',
    PaginationConfig={
        'MaxItems': 123,
        'PageSize': 123,
        'StartingToken': 'string'
    }
)

Parameters:

offerId (string) –
[REQUIRED]

The unique identifier of the offer whose terms to retrieve.
PaginationConfig (dict) –
A dictionary that provides parameters to control pagination.
- MaxItems (integer) –
  
  The total number of items to return. If the total number of items available is more than the value specified in max-items then a NextToken will be provided in the output that you can use to resume pagination.
- PageSize (integer) –
  
  The size of each page.
- StartingToken (string) –
  
  A token to specify where to start paginating. This is the NextToken from a previous response.

Return type:

dict

Returns:

Response Syntax

{
    'offerTerms': [
        {
            'byolPricingTerm': {
                'id': 'string',
                'type': 'ByolPricingTerm'|'ConfigurableUpfrontPricingTerm'|'FixedUpfrontPricingTerm'|'UsageBasedPricingTerm'|'FreeTrialPricingTerm'|'LegalTerm'|'PaymentScheduleTerm'|'RecurringPaymentTerm'|'RenewalTerm'|'SupportTerm'|'ValidityTerm'|'VariablePaymentTerm'
            },
            'configurableUpfrontPricingTerm': {
                'id': 'string',
                'type': 'ByolPricingTerm'|'ConfigurableUpfrontPricingTerm'|'FixedUpfrontPricingTerm'|'UsageBasedPricingTerm'|'FreeTrialPricingTerm'|'LegalTerm'|'PaymentScheduleTerm'|'RecurringPaymentTerm'|'RenewalTerm'|'SupportTerm'|'ValidityTerm'|'VariablePaymentTerm',
                'currencyCode': 'string',
                'rateCards': [
                    {
                        'selector': {
                            'type': 'Duration',
                            'value': 'string'
                        },
                        'constraints': {
                            'multipleDimensionSelection': 'Allowed'|'Disallowed',
                            'quantityConfiguration': 'Allowed'|'Disallowed'
                        },
                        'rateCard': [
                            {
                                'dimensionKey': 'string',
                                'displayName': 'string',
                                'description': 'string',
                                'dimensionLabels': [
                                    {
                                        'labelType': 'Region'|'SagemakerOption',
                                        'labelValue': 'string',
                                        'displayName': 'string'
                                    },
                                ],
                                'unit': 'string',
                                'price': 'string'
                            },
                        ]
                    },
                ]
            },
            'fixedUpfrontPricingTerm': {
                'id': 'string',
                'type': 'ByolPricingTerm'|'ConfigurableUpfrontPricingTerm'|'FixedUpfrontPricingTerm'|'UsageBasedPricingTerm'|'FreeTrialPricingTerm'|'LegalTerm'|'PaymentScheduleTerm'|'RecurringPaymentTerm'|'RenewalTerm'|'SupportTerm'|'ValidityTerm'|'VariablePaymentTerm',
                'currencyCode': 'string',
                'duration': 'string',
                'price': 'string',
                'grants': [
                    {
                        'dimensionKey': 'string',
                        'displayName': 'string',
                        'description': 'string',
                        'dimensionLabels': [
                            {
                                'labelType': 'Region'|'SagemakerOption',
                                'labelValue': 'string',
                                'displayName': 'string'
                            },
                        ],
                        'unit': 'string',
                        'maxQuantity': 123
                    },
                ]
            },
            'freeTrialPricingTerm': {
                'id': 'string',
                'type': 'ByolPricingTerm'|'ConfigurableUpfrontPricingTerm'|'FixedUpfrontPricingTerm'|'UsageBasedPricingTerm'|'FreeTrialPricingTerm'|'LegalTerm'|'PaymentScheduleTerm'|'RecurringPaymentTerm'|'RenewalTerm'|'SupportTerm'|'ValidityTerm'|'VariablePaymentTerm',
                'duration': 'string',
                'grants': [
                    {
                        'dimensionKey': 'string',
                        'displayName': 'string',
                        'description': 'string',
                        'dimensionLabels': [
                            {
                                'labelType': 'Region'|'SagemakerOption',
                                'labelValue': 'string',
                                'displayName': 'string'
                            },
                        ],
                        'unit': 'string',
                        'maxQuantity': 123
                    },
                ]
            },
            'legalTerm': {
                'id': 'string',
                'type': 'ByolPricingTerm'|'ConfigurableUpfrontPricingTerm'|'FixedUpfrontPricingTerm'|'UsageBasedPricingTerm'|'FreeTrialPricingTerm'|'LegalTerm'|'PaymentScheduleTerm'|'RecurringPaymentTerm'|'RenewalTerm'|'SupportTerm'|'ValidityTerm'|'VariablePaymentTerm',
                'documents': [
                    {
                        'type': 'CustomEula'|'CustomDsa'|'EnterpriseEula'|'StandardEula'|'StandardDsa',
                        'url': 'string',
                        'version': 'string'
                    },
                ]
            },
            'paymentScheduleTerm': {
                'id': 'string',
                'type': 'ByolPricingTerm'|'ConfigurableUpfrontPricingTerm'|'FixedUpfrontPricingTerm'|'UsageBasedPricingTerm'|'FreeTrialPricingTerm'|'LegalTerm'|'PaymentScheduleTerm'|'RecurringPaymentTerm'|'RenewalTerm'|'SupportTerm'|'ValidityTerm'|'VariablePaymentTerm',
                'currencyCode': 'string',
                'schedule': [
                    {
                        'chargeDate': datetime(2015, 1, 1),
                        'chargeAmount': 'string'
                    },
                ]
            },
            'recurringPaymentTerm': {
                'id': 'string',
                'type': 'ByolPricingTerm'|'ConfigurableUpfrontPricingTerm'|'FixedUpfrontPricingTerm'|'UsageBasedPricingTerm'|'FreeTrialPricingTerm'|'LegalTerm'|'PaymentScheduleTerm'|'RecurringPaymentTerm'|'RenewalTerm'|'SupportTerm'|'ValidityTerm'|'VariablePaymentTerm',
                'currencyCode': 'string',
                'billingPeriod': 'Monthly',
                'price': 'string'
            },
            'renewalTerm': {
                'id': 'string',
                'type': 'ByolPricingTerm'|'ConfigurableUpfrontPricingTerm'|'FixedUpfrontPricingTerm'|'UsageBasedPricingTerm'|'FreeTrialPricingTerm'|'LegalTerm'|'PaymentScheduleTerm'|'RecurringPaymentTerm'|'RenewalTerm'|'SupportTerm'|'ValidityTerm'|'VariablePaymentTerm'
            },
            'supportTerm': {
                'id': 'string',
                'type': 'ByolPricingTerm'|'ConfigurableUpfrontPricingTerm'|'FixedUpfrontPricingTerm'|'UsageBasedPricingTerm'|'FreeTrialPricingTerm'|'LegalTerm'|'PaymentScheduleTerm'|'RecurringPaymentTerm'|'RenewalTerm'|'SupportTerm'|'ValidityTerm'|'VariablePaymentTerm',
                'refundPolicy': 'string'
            },
            'usageBasedPricingTerm': {
                'id': 'string',
                'type': 'ByolPricingTerm'|'ConfigurableUpfrontPricingTerm'|'FixedUpfrontPricingTerm'|'UsageBasedPricingTerm'|'FreeTrialPricingTerm'|'LegalTerm'|'PaymentScheduleTerm'|'RecurringPaymentTerm'|'RenewalTerm'|'SupportTerm'|'ValidityTerm'|'VariablePaymentTerm',
                'currencyCode': 'string',
                'rateCards': [
                    {
                        'rateCard': [
                            {
                                'dimensionKey': 'string',
                                'displayName': 'string',
                                'description': 'string',
                                'dimensionLabels': [
                                    {
                                        'labelType': 'Region'|'SagemakerOption',
                                        'labelValue': 'string',
                                        'displayName': 'string'
                                    },
                                ],
                                'unit': 'string',
                                'price': 'string'
                            },
                        ]
                    },
                ]
            },
            'validityTerm': {
                'id': 'string',
                'type': 'ByolPricingTerm'|'ConfigurableUpfrontPricingTerm'|'FixedUpfrontPricingTerm'|'UsageBasedPricingTerm'|'FreeTrialPricingTerm'|'LegalTerm'|'PaymentScheduleTerm'|'RecurringPaymentTerm'|'RenewalTerm'|'SupportTerm'|'ValidityTerm'|'VariablePaymentTerm',
                'agreementDuration': 'string',
                'agreementEndDate': datetime(2015, 1, 1),
                'agreementStartDate': datetime(2015, 1, 1)
            },
            'variablePaymentTerm': {
                'id': 'string',
                'type': 'ByolPricingTerm'|'ConfigurableUpfrontPricingTerm'|'FixedUpfrontPricingTerm'|'UsageBasedPricingTerm'|'FreeTrialPricingTerm'|'LegalTerm'|'PaymentScheduleTerm'|'RecurringPaymentTerm'|'RenewalTerm'|'SupportTerm'|'ValidityTerm'|'VariablePaymentTerm',
                'currencyCode': 'string',
                'maxTotalChargeAmount': 'string'
            }
        },
    ],
    'NextToken': 'string'
}

Response Structure

(dict) –
- offerTerms (list) –
  
  The terms attached to the offer. Each element contains exactly one term type.
  - (dict) –
    
    A term attached to an offer. Each element contains exactly one term type, such as a pricing term, legal term, or payment schedule term.
    Note
    This is a Tagged Union structure. Only one of the following top level keys will be set: byolPricingTerm, configurableUpfrontPricingTerm, fixedUpfrontPricingTerm, freeTrialPricingTerm, legalTerm, paymentScheduleTerm, recurringPaymentTerm, renewalTerm, supportTerm, usageBasedPricingTerm, validityTerm, variablePaymentTerm. If a client receives an unknown member it will set SDK_UNKNOWN_MEMBER as the top level key, which maps to the name or tag of the unknown member. The structure of SDK_UNKNOWN_MEMBER is as follows:
    'SDK_UNKNOWN_MEMBER': {'name': 'UnknownMemberName'}
    - byolPricingTerm (dict) –
      
      Defines a Bring Your Own License (BYOL) pricing term, where buyers use their existing license for the product.
      - id (string) –
        
        The unique identifier of the term.
      - type (string) –
        
        The category of the term.
    - configurableUpfrontPricingTerm (dict) –
      
      Defines a configurable upfront pricing term with selectable rate cards, where buyers choose from predefined pricing configurations.
      - id (string) –
        
        The unique identifier of the term.
      - type (string) –
        
        The category of the term.
      - currencyCode (string) –
        
        Defines the currency for the prices in this term.
      - rateCards (list) –
        
        The rate cards available for selection, each with a selector, constraints, and per-unit rates.
        
        (dict) –
        
        A rate card item within a configurable upfront pricing term, including a selector for choosing the configuration and per-unit rates.
        
        selector (dict) –
        
        The selector criteria for this rate card, such as duration.
        
        type (string) –
        
        The category of the selector, such as Duration.
        
        value (string) –
        
        The value of the selector.
        
        constraints (dict) –
        
        Constraints on how the buyer can configure this rate card, such as whether multiple dimensions can be selected.
        
        multipleDimensionSelection (string) –
        
        Whether the buyer can select multiple dimensions. Values are Allowed or Disallowed.
        
        quantityConfiguration (string) –
        
        Whether the buyer can configure quantities. Values are Allowed or Disallowed.
        
        rateCard (list) –
        
        The per-unit rates for this configuration.
        
        (dict) –
        
        A per-unit rate within a rate card, defining the price for a specific dimension.
        
        dimensionKey (string) –
        
        The machine-readable key identifying the dimension being priced.
        
        displayName (string) –
        
        The human-readable name of the dimension.
        
        description (string) –
        
        A description of the dimension being priced.
        
        dimensionLabels (list) –
        
        Labels used to categorize this dimension, such as by region.
        
        (dict) –
        
        A label used to group or categorize pricing dimensions, such as by region or SageMaker option.
        
        labelType (string) –
        
        The type of the dimension label, such as Region or SagemakerOption.
        
        labelValue (string) –
        
        The value used to group dimensions together.
        
        displayName (string) –
        
        The human-readable display name of the label.
        
        unit (string) –
        
        The unit of measurement for the dimension.
        
        price (string) –
        
        The price per unit for the dimension.
    - fixedUpfrontPricingTerm (dict) –
      
      Defines a fixed upfront pricing term with a pre-paid amount and granted entitlements.
      - id (string) –
        
        The unique identifier of the term.
      - type (string) –
        
        The category of the term.
      - currencyCode (string) –
        
        Defines the currency for the prices in this term.
      - duration (string) –
        
        The duration of the fixed pricing term, in ISO 8601 format.
      - price (string) –
        
        The price charged upfront for this term.
      - grants (list) –
        
        The entitlements granted to the buyer as part of this term.
        
        (dict) –
        
        An entitlement granted to the buyer as part of a pricing term.
        
        dimensionKey (string) –
        
        The machine-readable key identifying the entitlement dimension.
        
        displayName (string) –
        
        The human-readable name of the entitlement dimension.
        
        description (string) –
        
        A description of the entitlement.
        
        dimensionLabels (list) –
        
        Labels used to categorize this entitlement, such as by region.
        
        (dict) –
        
        A label used to group or categorize pricing dimensions, such as by region or SageMaker option.
        
        labelType (string) –
        
        The type of the dimension label, such as Region or SagemakerOption.
        
        labelValue (string) –
        
        The value used to group dimensions together.
        
        displayName (string) –
        
        The human-readable display name of the label.
        
        unit (string) –
        
        The unit of measurement for the entitlement.
        
        maxQuantity (integer) –
        
        The maximum quantity of the entitlement that can be granted.
    - freeTrialPricingTerm (dict) –
      
      Defines a free trial pricing term that enables customers to try the product before purchasing.
      - id (string) –
        
        The unique identifier of the term.
      - type (string) –
        
        The category of the term.
      - duration (string) –
        
        The duration of the free trial period.
      - grants (list) –
        
        The entitlements granted to the buyer during the free trial.
        
        (dict) –
        
        An entitlement granted to the buyer as part of a pricing term.
        
        dimensionKey (string) –
        
        The machine-readable key identifying the entitlement dimension.
        
        displayName (string) –
        
        The human-readable name of the entitlement dimension.
        
        description (string) –
        
        A description of the entitlement.
        
        dimensionLabels (list) –
        
        Labels used to categorize this entitlement, such as by region.
        
        (dict) –
        
        A label used to group or categorize pricing dimensions, such as by region or SageMaker option.
        
        labelType (string) –
        
        The type of the dimension label, such as Region or SagemakerOption.
        
        labelValue (string) –
        
        The value used to group dimensions together.
        
        displayName (string) –
        
        The human-readable display name of the label.
        
        unit (string) –
        
        The unit of measurement for the entitlement.
        
        maxQuantity (integer) –
        
        The maximum quantity of the entitlement that can be granted.
    - legalTerm (dict) –
      
      Defines a legal term containing documents proposed to buyers, such as EULAs and data subscription agreements.
      - id (string) –
        
        The unique identifier of the term.
      - type (string) –
        
        The category of the term.
      - documents (list) –
        
        The legal documents proposed to the buyer as part of this term.
        
        (dict) –
        
        A legal document associated with a legal term, such as a EULA or data subscription agreement.
        
        type (string) –
        
        The category of the legal document, such as StandardEula or CustomEula.
        
        url (string) –
        
        The URL where the legal document can be accessed.
        
        version (string) –
        
        The version of the standard contract, if applicable.
    - paymentScheduleTerm (dict) –
      
      Defines a payment schedule term with installment payments at specified dates.
      - id (string) –
        
        The unique identifier of the term.
      - type (string) –
        
        The category of the term.
      - currencyCode (string) –
        
        Defines the currency for the prices in this term.
      - schedule (list) –
        
        The payment schedule installments, each with a charge date and amount.
        
        (dict) –
        
        A payment installment within a payment schedule term.
        
        chargeDate (datetime) –
        
        The date when the payment is due.
        
        chargeAmount (string) –
        
        The amount to be charged on the charge date.
    - recurringPaymentTerm (dict) –
      
      Defines a recurring payment term with fixed charges at regular billing intervals.
      - id (string) –
        
        The unique identifier of the term.
      - type (string) –
        
        The category of the term.
      - currencyCode (string) –
        
        Defines the currency for the prices in this term.
      - billingPeriod (string) –
        
        The billing period frequency, such as Monthly.
      - price (string) –
        
        The amount charged each billing period.
    - renewalTerm (dict) –
      
      Defines a renewal term that enables automatic agreement renewal.
      - id (string) –
        
        The unique identifier of the term.
      - type (string) –
        
        The category of the term.
    - supportTerm (dict) –
      
      Defines a support term that includes the refund policy for the offer.
      - id (string) –
        
        The unique identifier of the term.
      - type (string) –
        
        The category of the term.
      - refundPolicy (string) –
        
        The refund policy description for the offer.
    - usageBasedPricingTerm (dict) –
      
      Defines a usage-based pricing term (typically pay-as-you-go), where buyers are charged based on product usage.
      - id (string) –
        
        The unique identifier of the term.
      - type (string) –
        
        The category of the term.
      - currencyCode (string) –
        
        Defines the currency for the prices in this term.
      - rateCards (list) –
        
        The rate cards containing per-unit rates for usage-based pricing.
        
        (dict) –
        
        A rate card within a usage-based pricing term, containing per-unit rates.
        
        rateCard (list) –
        
        The per-unit rates for this usage-based rate card.
        
        (dict) –
        
        A per-unit rate within a rate card, defining the price for a specific dimension.
        
        dimensionKey (string) –
        
        The machine-readable key identifying the dimension being priced.
        
        displayName (string) –
        
        The human-readable name of the dimension.
        
        description (string) –
        
        A description of the dimension being priced.
        
        dimensionLabels (list) –
        
        Labels used to categorize this dimension, such as by region.
        
        (dict) –
        
        A label used to group or categorize pricing dimensions, such as by region or SageMaker option.
        
        labelType (string) –
        
        The type of the dimension label, such as Region or SagemakerOption.
        
        labelValue (string) –
        
        The value used to group dimensions together.
        
        displayName (string) –
        
        The human-readable display name of the label.
        
        unit (string) –
        
        The unit of measurement for the dimension.
        
        price (string) –
        
        The price per unit for the dimension.
    - validityTerm (dict) –
      
      Defines a validity term that specifies the duration or date range of an agreement.
      - id (string) –
        
        The unique identifier of the term.
      - type (string) –
        
        The category of the term.
      - agreementDuration (string) –
        
        The duration of the agreement, in ISO 8601 format.
      - agreementEndDate (datetime) –
        
        The date when the agreement ends.
      - agreementStartDate (datetime) –
        
        The date when the agreement starts.
    - variablePaymentTerm (dict) –
      
      Defines a variable payment term with a maximum total charge amount.
      - id (string) –
        
        The unique identifier of the term.
      - type (string) –
        
        The category of the term.
      - currencyCode (string) –
        
        Defines the currency for the prices in this term.
      - maxTotalChargeAmount (string) –
        
        The maximum total amount that can be charged under this term.
- NextToken (string) –
  
  A token to resume pagination.

GetOfferTerms¶

Request Syntax

Response Syntax

Response Structure

Note