[ aws . marketplace-discovery ]
get-offer-terms¶
Description¶
Returns the terms attached to an offer, such as pricing terms (usage-based, contract, BYOL, free trial), legal terms, payment schedules, validity terms, support terms, and renewal terms.
See also: AWS API Documentation
get-offer-terms is a paginated operation. Multiple API calls may be issued in order to retrieve the entire data set of results. You can disable pagination by providing the --no-paginate argument.
When using --output text and the --query argument on a paginated response, the --query argument must extract data from the results of the following query expressions: offerTerms
Synopsis¶
get-offer-terms
--offer-id <value>
[--cli-input-json | --cli-input-yaml]
[--starting-token <value>]
[--page-size <value>]
[--max-items <value>]
[--generate-cli-skeleton <value>]
[--debug]
[--endpoint-url <value>]
[--no-verify-ssl]
[--no-paginate]
[--output <value>]
[--query <value>]
[--profile <value>]
[--region <value>]
[--version <value>]
[--color <value>]
[--no-sign-request]
[--ca-bundle <value>]
[--cli-read-timeout <value>]
[--cli-connect-timeout <value>]
[--cli-binary-format <value>]
[--no-cli-pager]
[--cli-auto-prompt]
[--no-cli-auto-prompt]
[--cli-error-format <value>]
Options¶
--offer-id (string) [required]
The unique identifier of the offer whose terms to retrieve.
Constraints:
- min:
1- max:
255- pattern:
[\w\-]+
--cli-input-json | --cli-input-yaml (string)
Reads arguments from the JSON string provided. The JSON string follows the format provided by --generate-cli-skeleton. If other arguments are provided on the command line, those values will override the JSON-provided values. It is not possible to pass arbitrary binary values using a JSON-provided value as the string will be taken literally. This may not be specified along with --cli-input-yaml.
--starting-token (string)
A token to specify where to start paginating. This is the
NextTokenfrom a previously truncated response.For usage examples, see Pagination in the AWS Command Line Interface User Guide .
--page-size (integer)
The size of each page to get in the AWS service call. This does not affect the number of items returned in the command’s output. Setting a smaller page size results in more calls to the AWS service, retrieving fewer items in each call. This can help prevent the AWS service calls from timing out.
For usage examples, see Pagination in the AWS Command Line Interface User Guide .
--max-items (integer)
The total number of items to return in the command’s output. If the total number of items available is more than the value specified, a
NextTokenis provided in the command’s output. To resume pagination, provide theNextTokenvalue in thestarting-tokenargument of a subsequent command. Do not use theNextTokenresponse element directly outside of the AWS CLI.For usage examples, see Pagination in the AWS Command Line Interface User Guide .
--generate-cli-skeleton (string)
Prints a JSON skeleton to standard output without sending an API request. If provided with no value or the value input, prints a sample input JSON that can be used as an argument for --cli-input-json. Similarly, if provided yaml-input it will print a sample input YAML that can be used with --cli-input-yaml. If provided with the value output, it validates the command inputs and returns a sample output JSON for that command. The generated JSON skeleton is not stable between versions of the AWS CLI and there are no backwards compatibility guarantees in the JSON skeleton generated.
Global Options¶
--debug (boolean)
Turn on debug logging.
--endpoint-url (string)
Override command’s default URL with the given URL.
--no-verify-ssl (boolean)
By default, the AWS CLI uses SSL when communicating with AWS services. For each SSL connection, the AWS CLI will verify SSL certificates. This option overrides the default behavior of verifying SSL certificates.
--no-paginate (boolean)
Disable automatic pagination. If automatic pagination is disabled, the AWS CLI will only make one call, for the first page of results.
--output (string)
The formatting style for command output.
- json
- text
- table
- yaml
- yaml-stream
- off
--query (string)
A JMESPath query to use in filtering the response data.
--profile (string)
Use a specific profile from your credential file.
--region (string)
The region to use. Overrides config/env settings.
--version (string)
Display the version of this tool.
--color (string)
Turn on/off color output.
- on
- off
- auto
--no-sign-request (boolean)
Do not sign requests. Credentials will not be loaded if this argument is provided.
--ca-bundle (string)
The CA certificate bundle to use when verifying SSL certificates. Overrides config/env settings.
--cli-read-timeout (int)
The maximum socket read time in seconds. If the value is set to 0, the socket read will be blocking and not timeout. The default value is 60 seconds.
--cli-connect-timeout (int)
The maximum socket connect time in seconds. If the value is set to 0, the socket connect will be blocking and not timeout. The default value is 60 seconds.
--cli-binary-format (string)
The formatting style to be used for binary blobs. The default format is base64. The base64 format expects binary blobs to be provided as a base64 encoded string. The raw-in-base64-out format preserves compatibility with AWS CLI V1 behavior and binary values must be passed literally. When providing contents from a file that map to a binary blob fileb:// will always be treated as binary and use the file contents directly regardless of the cli-binary-format setting. When using file:// the file contents will need to properly formatted for the configured cli-binary-format.
- base64
- raw-in-base64-out
--no-cli-pager (boolean)
Disable cli pager for output.
--cli-auto-prompt (boolean)
Automatically prompt for CLI input parameters.
--no-cli-auto-prompt (boolean)
Disable automatically prompt for CLI input parameters.
--cli-error-format (string)
The formatting style for error output. By default, errors are displayed in enhanced format.
- legacy
- json
- yaml
- text
- table
- enhanced
Output¶
offerTerms -> (list)
The terms attached to the offer. Each element contains exactly one term type.
(tagged union structure)
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 can be set:byolPricingTerm,configurableUpfrontPricingTerm,fixedUpfrontPricingTerm,freeTrialPricingTerm,legalTerm,paymentScheduleTerm,recurringPaymentTerm,renewalTerm,supportTerm,usageBasedPricingTerm,validityTerm,variablePaymentTerm.byolPricingTerm -> (structure)
Defines a Bring Your Own License (BYOL) pricing term, where buyers use their existing license for the product.
id -> (string) [required]
The unique identifier of the term.
Constraints:
- min:
1- max:
256- pattern:
[A-Za-z0-9+=;,.@\-_]+type -> (string) [required]
The category of the term.
Possible values:
ByolPricingTermConfigurableUpfrontPricingTermFixedUpfrontPricingTermUsageBasedPricingTermFreeTrialPricingTermLegalTermPaymentScheduleTermRecurringPaymentTermRenewalTermSupportTermValidityTermVariablePaymentTermconfigurableUpfrontPricingTerm -> (structure)
Defines a configurable upfront pricing term with selectable rate cards, where buyers choose from predefined pricing configurations.
id -> (string) [required]
The unique identifier of the term.
Constraints:
- min:
1- max:
256- pattern:
[A-Za-z0-9+=;,.@\-_]+type -> (string) [required]
The category of the term.
Possible values:
ByolPricingTermConfigurableUpfrontPricingTermFixedUpfrontPricingTermUsageBasedPricingTermFreeTrialPricingTermLegalTermPaymentScheduleTermRecurringPaymentTermRenewalTermSupportTermValidityTermVariablePaymentTermcurrencyCode -> (string) [required]
Defines the currency for the prices in this term.
Constraints:
- min:
3- max:
3- pattern:
[A-Z]+rateCards -> (list)
The rate cards available for selection, each with a selector, constraints, and per-unit rates.
(structure)
A rate card item within a configurable upfront pricing term, including a selector for choosing the configuration and per-unit rates.
selector -> (structure) [required]
The selector criteria for this rate card, such as duration.
type -> (string) [required]
The category of the selector, such as
Duration.Possible values:
Durationvalue -> (string) [required]
The value of the selector.
Constraints:
- min:
1- max:
4096- pattern:
(.)+constraints -> (structure) [required]
Constraints on how the buyer can configure this rate card, such as whether multiple dimensions can be selected.
multipleDimensionSelection -> (string) [required]
Whether the buyer can select multiple dimensions. Values are
AllowedorDisallowed.Possible values:
AllowedDisallowedquantityConfiguration -> (string) [required]
Whether the buyer can configure quantities. Values are
AllowedorDisallowed.Possible values:
AllowedDisallowedrateCard -> (list) [required]
The per-unit rates for this configuration.
(structure)
A per-unit rate within a rate card, defining the price for a specific dimension.
dimensionKey -> (string) [required]
The machine-readable key identifying the dimension being priced.
Constraints:
- min:
1- max:
4096- pattern:
(.)+displayName -> (string) [required]
The human-readable name of the dimension.
Constraints:
- min:
1- max:
4096- pattern:
(.)+description -> (string)
A description of the dimension being priced.
Constraints:
- min:
1- max:
4096- pattern:
(.)+dimensionLabels -> (list)
Labels used to categorize this dimension, such as by region.
(structure)
A label used to group or categorize pricing dimensions, such as by region or SageMaker option.
labelType -> (string) [required]
The type of the dimension label, such as
RegionorSagemakerOption.Possible values:
RegionSagemakerOptionlabelValue -> (string) [required]
The value used to group dimensions together.
Constraints:
- min:
1- max:
4096- pattern:
(.)+displayName -> (string)
The human-readable display name of the label.
Constraints:
- min:
1- max:
4096- pattern:
(.)+unit -> (string) [required]
The unit of measurement for the dimension.
Constraints:
- min:
1- max:
4096- pattern:
(.)+price -> (string) [required]
The price per unit for the dimension.
Constraints:
- min:
1- max:
4096- pattern:
(.)+fixedUpfrontPricingTerm -> (structure)
Defines a fixed upfront pricing term with a pre-paid amount and granted entitlements.
id -> (string) [required]
The unique identifier of the term.
Constraints:
- min:
1- max:
256- pattern:
[A-Za-z0-9+=;,.@\-_]+type -> (string) [required]
The category of the term.
Possible values:
ByolPricingTermConfigurableUpfrontPricingTermFixedUpfrontPricingTermUsageBasedPricingTermFreeTrialPricingTermLegalTermPaymentScheduleTermRecurringPaymentTermRenewalTermSupportTermValidityTermVariablePaymentTermcurrencyCode -> (string) [required]
Defines the currency for the prices in this term.
Constraints:
- min:
3- max:
3- pattern:
[A-Z]+duration -> (string)
The duration of the fixed pricing term, in ISO 8601 format.
Constraints:
- min:
1- max:
4096- pattern:
(.)+price -> (string) [required]
The price charged upfront for this term.
Constraints:
- min:
1- max:
4096- pattern:
(.)+grants -> (list) [required]
The entitlements granted to the buyer as part of this term.
(structure)
An entitlement granted to the buyer as part of a pricing term.
dimensionKey -> (string) [required]
The machine-readable key identifying the entitlement dimension.
Constraints:
- min:
1- max:
4096- pattern:
(.)+displayName -> (string) [required]
The human-readable name of the entitlement dimension.
Constraints:
- min:
1- max:
4096- pattern:
(.)+description -> (string)
A description of the entitlement.
Constraints:
- min:
1- max:
4096- pattern:
(.)+dimensionLabels -> (list)
Labels used to categorize this entitlement, such as by region.
(structure)
A label used to group or categorize pricing dimensions, such as by region or SageMaker option.
labelType -> (string) [required]
The type of the dimension label, such as
RegionorSagemakerOption.Possible values:
RegionSagemakerOptionlabelValue -> (string) [required]
The value used to group dimensions together.
Constraints:
- min:
1- max:
4096- pattern:
(.)+displayName -> (string)
The human-readable display name of the label.
Constraints:
- min:
1- max:
4096- pattern:
(.)+unit -> (string) [required]
The unit of measurement for the entitlement.
Constraints:
- min:
1- max:
4096- pattern:
(.)+maxQuantity -> (integer)
The maximum quantity of the entitlement that can be granted.freeTrialPricingTerm -> (structure)
Defines a free trial pricing term that enables customers to try the product before purchasing.
id -> (string) [required]
The unique identifier of the term.
Constraints:
- min:
1- max:
256- pattern:
[A-Za-z0-9+=;,.@\-_]+type -> (string) [required]
The category of the term.
Possible values:
ByolPricingTermConfigurableUpfrontPricingTermFixedUpfrontPricingTermUsageBasedPricingTermFreeTrialPricingTermLegalTermPaymentScheduleTermRecurringPaymentTermRenewalTermSupportTermValidityTermVariablePaymentTermduration -> (string)
The duration of the free trial period.
Constraints:
- min:
1- max:
4096- pattern:
(.)+grants -> (list) [required]
The entitlements granted to the buyer during the free trial.
(structure)
An entitlement granted to the buyer as part of a pricing term.
dimensionKey -> (string) [required]
The machine-readable key identifying the entitlement dimension.
Constraints:
- min:
1- max:
4096- pattern:
(.)+displayName -> (string) [required]
The human-readable name of the entitlement dimension.
Constraints:
- min:
1- max:
4096- pattern:
(.)+description -> (string)
A description of the entitlement.
Constraints:
- min:
1- max:
4096- pattern:
(.)+dimensionLabels -> (list)
Labels used to categorize this entitlement, such as by region.
(structure)
A label used to group or categorize pricing dimensions, such as by region or SageMaker option.
labelType -> (string) [required]
The type of the dimension label, such as
RegionorSagemakerOption.Possible values:
RegionSagemakerOptionlabelValue -> (string) [required]
The value used to group dimensions together.
Constraints:
- min:
1- max:
4096- pattern:
(.)+displayName -> (string)
The human-readable display name of the label.
Constraints:
- min:
1- max:
4096- pattern:
(.)+unit -> (string) [required]
The unit of measurement for the entitlement.
Constraints:
- min:
1- max:
4096- pattern:
(.)+maxQuantity -> (integer)
The maximum quantity of the entitlement that can be granted.legalTerm -> (structure)
Defines a legal term containing documents proposed to buyers, such as EULAs and data subscription agreements.
id -> (string) [required]
The unique identifier of the term.
Constraints:
- min:
1- max:
256- pattern:
[A-Za-z0-9+=;,.@\-_]+type -> (string) [required]
The category of the term.
Possible values:
ByolPricingTermConfigurableUpfrontPricingTermFixedUpfrontPricingTermUsageBasedPricingTermFreeTrialPricingTermLegalTermPaymentScheduleTermRecurringPaymentTermRenewalTermSupportTermValidityTermVariablePaymentTermdocuments -> (list) [required]
The legal documents proposed to the buyer as part of this term.
(structure)
A legal document associated with a legal term, such as a EULA or data subscription agreement.
type -> (string) [required]
The category of the legal document, such as
StandardEulaorCustomEula.Possible values:
CustomEulaCustomDsaEnterpriseEulaStandardEulaStandardDsaurl -> (string) [required]
The URL where the legal document can be accessed.
Constraints:
- min:
1- max:
2048- pattern:
https?://.*version -> (string)
The version of the standard contract, if applicable.paymentScheduleTerm -> (structure)
Defines a payment schedule term with installment payments at specified dates.
id -> (string) [required]
The unique identifier of the term.
Constraints:
- min:
1- max:
256- pattern:
[A-Za-z0-9+=;,.@\-_]+type -> (string) [required]
The category of the term.
Possible values:
ByolPricingTermConfigurableUpfrontPricingTermFixedUpfrontPricingTermUsageBasedPricingTermFreeTrialPricingTermLegalTermPaymentScheduleTermRecurringPaymentTermRenewalTermSupportTermValidityTermVariablePaymentTermcurrencyCode -> (string) [required]
Defines the currency for the prices in this term.
Constraints:
- min:
3- max:
3- pattern:
[A-Z]+schedule -> (list) [required]
The payment schedule installments, each with a charge date and amount.
(structure)
A payment installment within a payment schedule term.
chargeDate -> (timestamp) [required]
The date when the payment is due.chargeAmount -> (string) [required]
The amount to be charged on the charge date.
Constraints:
- min:
1- max:
4096- pattern:
(.)+recurringPaymentTerm -> (structure)
Defines a recurring payment term with fixed charges at regular billing intervals.
id -> (string) [required]
The unique identifier of the term.
Constraints:
- min:
1- max:
256- pattern:
[A-Za-z0-9+=;,.@\-_]+type -> (string) [required]
The category of the term.
Possible values:
ByolPricingTermConfigurableUpfrontPricingTermFixedUpfrontPricingTermUsageBasedPricingTermFreeTrialPricingTermLegalTermPaymentScheduleTermRecurringPaymentTermRenewalTermSupportTermValidityTermVariablePaymentTermcurrencyCode -> (string) [required]
Defines the currency for the prices in this term.
Constraints:
- min:
3- max:
3- pattern:
[A-Z]+billingPeriod -> (string) [required]
The billing period frequency, such as
Monthly.Possible values:
Monthlyprice -> (string) [required]
The amount charged each billing period.
Constraints:
- min:
1- max:
4096- pattern:
(.)+renewalTerm -> (structure)
Defines a renewal term that enables automatic agreement renewal.
id -> (string) [required]
The unique identifier of the term.
Constraints:
- min:
1- max:
256- pattern:
[A-Za-z0-9+=;,.@\-_]+type -> (string) [required]
The category of the term.
Possible values:
ByolPricingTermConfigurableUpfrontPricingTermFixedUpfrontPricingTermUsageBasedPricingTermFreeTrialPricingTermLegalTermPaymentScheduleTermRecurringPaymentTermRenewalTermSupportTermValidityTermVariablePaymentTermsupportTerm -> (structure)
Defines a support term that includes the refund policy for the offer.
id -> (string) [required]
The unique identifier of the term.
Constraints:
- min:
1- max:
256- pattern:
[A-Za-z0-9+=;,.@\-_]+type -> (string) [required]
The category of the term.
Possible values:
ByolPricingTermConfigurableUpfrontPricingTermFixedUpfrontPricingTermUsageBasedPricingTermFreeTrialPricingTermLegalTermPaymentScheduleTermRecurringPaymentTermRenewalTermSupportTermValidityTermVariablePaymentTermrefundPolicy -> (string) [required]
The refund policy description for the offer.
Constraints:
- min:
1- max:
4096- pattern:
(.)+usageBasedPricingTerm -> (structure)
Defines a usage-based pricing term (typically pay-as-you-go), where buyers are charged based on product usage.
id -> (string) [required]
The unique identifier of the term.
Constraints:
- min:
1- max:
256- pattern:
[A-Za-z0-9+=;,.@\-_]+type -> (string) [required]
The category of the term.
Possible values:
ByolPricingTermConfigurableUpfrontPricingTermFixedUpfrontPricingTermUsageBasedPricingTermFreeTrialPricingTermLegalTermPaymentScheduleTermRecurringPaymentTermRenewalTermSupportTermValidityTermVariablePaymentTermcurrencyCode -> (string) [required]
Defines the currency for the prices in this term.
Constraints:
- min:
3- max:
3- pattern:
[A-Z]+rateCards -> (list) [required]
The rate cards containing per-unit rates for usage-based pricing.
(structure)
A rate card within a usage-based pricing term, containing per-unit rates.
rateCard -> (list) [required]
The per-unit rates for this usage-based rate card.
(structure)
A per-unit rate within a rate card, defining the price for a specific dimension.
dimensionKey -> (string) [required]
The machine-readable key identifying the dimension being priced.
Constraints:
- min:
1- max:
4096- pattern:
(.)+displayName -> (string) [required]
The human-readable name of the dimension.
Constraints:
- min:
1- max:
4096- pattern:
(.)+description -> (string)
A description of the dimension being priced.
Constraints:
- min:
1- max:
4096- pattern:
(.)+dimensionLabels -> (list)
Labels used to categorize this dimension, such as by region.
(structure)
A label used to group or categorize pricing dimensions, such as by region or SageMaker option.
labelType -> (string) [required]
The type of the dimension label, such as
RegionorSagemakerOption.Possible values:
RegionSagemakerOptionlabelValue -> (string) [required]
The value used to group dimensions together.
Constraints:
- min:
1- max:
4096- pattern:
(.)+displayName -> (string)
The human-readable display name of the label.
Constraints:
- min:
1- max:
4096- pattern:
(.)+unit -> (string) [required]
The unit of measurement for the dimension.
Constraints:
- min:
1- max:
4096- pattern:
(.)+price -> (string) [required]
The price per unit for the dimension.
Constraints:
- min:
1- max:
4096- pattern:
(.)+validityTerm -> (structure)
Defines a validity term that specifies the duration or date range of an agreement.
id -> (string) [required]
The unique identifier of the term.
Constraints:
- min:
1- max:
256- pattern:
[A-Za-z0-9+=;,.@\-_]+type -> (string) [required]
The category of the term.
Possible values:
ByolPricingTermConfigurableUpfrontPricingTermFixedUpfrontPricingTermUsageBasedPricingTermFreeTrialPricingTermLegalTermPaymentScheduleTermRecurringPaymentTermRenewalTermSupportTermValidityTermVariablePaymentTermagreementDuration -> (string)
The duration of the agreement, in ISO 8601 format.
Constraints:
- min:
1- max:
4096- pattern:
(.)+agreementEndDate -> (timestamp)
The date when the agreement ends.agreementStartDate -> (timestamp)
The date when the agreement starts.variablePaymentTerm -> (structure)
Defines a variable payment term with a maximum total charge amount.
id -> (string) [required]
The unique identifier of the term.
Constraints:
- min:
1- max:
256- pattern:
[A-Za-z0-9+=;,.@\-_]+type -> (string) [required]
The category of the term.
Possible values:
ByolPricingTermConfigurableUpfrontPricingTermFixedUpfrontPricingTermUsageBasedPricingTermFreeTrialPricingTermLegalTermPaymentScheduleTermRecurringPaymentTermRenewalTermSupportTermValidityTermVariablePaymentTermcurrencyCode -> (string) [required]
Defines the currency for the prices in this term.
Constraints:
- min:
3- max:
3- pattern:
[A-Z]+maxTotalChargeAmount -> (string) [required]
The maximum total amount that can be charged under this term.
Constraints:
- min:
1- max:
4096- pattern:
(.)+
nextToken -> (string)
If
nextTokenis returned, there are more results available. Make the call again using the returned token to retrieve the next page.Constraints:
- min:
0- max:
8192- pattern:
[a-zA-Z0-9+/=]+