get-offer¶

Description¶

Provides details about an offer, such as the pricing model, seller of record, availability dates, badges, and associated products.

Synopsis¶

  get-offer
--offer-id <value>
[--cli-input-json | --cli-input-yaml]
[--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 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.

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

offerId -> (string)

The unique identifier of the offer.

Constraints:

min: 1

max: 255

pattern: [\w\-]+

catalog -> (string)

The name of the catalog that the offer belongs to.

Constraints:

min: 1

max: 255

pattern: [\w\-]+

offerName -> (string)

The display name of the offer. This is free-form text provided by the seller.

Constraints:

min: 0

max: 255

agreementProposalId -> (string)

An encoded string to be passed by the acceptor of the terms when creating an agreement.

Constraints:

min: 1

max: 64

pattern: [A-Za-z0-9_/-]+

expirationTime -> (timestamp)

The date and time until when the offer can be procured. This value is null for offers that never expire.

availableFromTime -> (timestamp)

The date and time when the offer became available to the buyer.

sellerOfRecord -> (structure)

The entity responsible for selling the product under this offer.

sellerProfileId -> (string) [required]

The unique identifier of the seller profile.

Constraints:

min: 1

max: 255

pattern: [\w\-]+

displayName -> (string) [required]

The human-readable name of the seller.

Constraints:

min: 1

max: 1024

pattern: .*\S.*

replacementAgreementId -> (string)

The identifier of the existing agreement that this offer would replace. Enables agreement-based offer functionality.

Constraints:

min: 1

max: 64

pattern: [A-Za-z0-9_/-]+

pricingModel -> (structure)

The pricing model that determines how buyers are charged, such as usage-based, contract, BYOL, or free.

pricingModelType -> (string) [required]

The machine-readable type of the pricing model.

Possible values:

USAGE

CONTRACT

BYOL

FREE

displayName -> (string) [required]

The human-readable name of the pricing model.

Constraints:

min: 1

max: 1024

pattern: .*\S.*

badges -> (list)

Badges indicating special attributes of the offer, such as private pricing, future dated, or replacement offer.

Constraints:

min: 0

max: 20

(structure)

A badge indicating a special attribute of a purchase option, such as private pricing or future dated.

displayName -> (string) [required]

The human-readable name of the badge.

Constraints:

min: 1

max: 1024

pattern: .*\S.*

badgeType -> (string) [required]

The machine-readable type of the badge.

Possible values:

PRIVATE_PRICING

FUTURE_DATED

REPLACEMENT_OFFER

associatedEntities -> (list)

The products and offer sets associated with this offer.

Constraints:

min: 0

max: 100

(structure)

A product and optional offer set associated with an offer.

product -> (structure) [required]

Information about the product associated with the offer.

productId -> (string) [required]

The unique identifier of the product.

Constraints:

min: 1

max: 255

pattern: [\w\-]+

productName -> (string) [required]

The human-readable display name of the product.

Constraints:

min: 1

max: 1024

pattern: .*\S.*

manufacturer -> (structure) [required]

The entity who manufactured the product.

sellerProfileId -> (string) [required]

The unique identifier of the seller profile.

Constraints:

min: 1

max: 255

pattern: [\w\-]+

displayName -> (string) [required]

The human-readable name of the seller.

Constraints:

min: 1

max: 1024

pattern: .*\S.*

offerSet -> (structure)

Information about the offer set, if the offer is part of a bundled offer set.

offerSetId -> (string) [required]

The unique identifier of the offer set.

Constraints:

min: 1

max: 255

pattern: [\w\-]+

sellerOfRecord -> (structure) [required]

The entity responsible for selling the products under this offer set.

sellerProfileId -> (string) [required]

The unique identifier of the seller profile.

Constraints:

min: 1

max: 255

pattern: [\w\-]+

displayName -> (string) [required]

The human-readable name of the seller.

Constraints:

min: 1

max: 1024

pattern: .*\S.*

Table of Contents

Feedback

User Guide