AWS CLI Command Reference

Note:

You are viewing the documentation for an older major version of the AWS CLI (version 1). To view this page for the AWS CLI version 2, click here.

We announced the upcoming end-of-support for the AWS CLI v1. For dates, additional details, and information on how to migrate, please refer to the linked announcement. For more information see the AWS CLI version 2 installation instructions and migration guide.

[ aws . marketplace-discovery ]

get-offer-set

Description

Provides details about an offer set, which is a bundle of offers across multiple products. Includes the seller, availability dates, buyer notes, and associated product-offer pairs.

See also: AWS API Documentation

Synopsis

  get-offer-set
--offer-set-id <value>
[--cli-input-json <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>]
[--v2-debug]

Options

--offer-set-id (string)

The unique identifier of the offer set to retrieve.

--cli-input-json (string) Performs service operation based on the JSON string provided. The JSON string follows the format provided by --generate-cli-skeleton. If other arguments are provided on the command line, the CLI 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.

--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. If provided with the value output, it validates the command inputs and returns a sample output JSON for that command.

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

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

--v2-debug (boolean)

Enable AWS CLI v2 migration assistance. Prints warnings if the command would face a breaking change after swapping AWS CLI v1 for AWS CLI v2 in the current environment. Prints one warning for each breaking change detected.

Output

offerSetId -> (string)

The unique identifier of the offer set.

catalog -> (string)

The name of the catalog that the offer set belongs to.

offerSetName -> (string)

The display name of the offer set.

availableFromTime -> (timestamp)

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

expirationTime -> (timestamp)

The date and time when the offer set expires and is no longer available for procurement.

buyerNotes -> (string)

Detailed information about the offer set that helps buyers understand its purpose and contents.

sellerOfRecord -> (structure)

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

sellerProfileId -> (string)

The unique identifier of the seller profile.

displayName -> (string)

The human-readable name of the seller.

badges -> (list)

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

(structure)

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

displayName -> (string)

The human-readable name of the badge.

badgeType -> (string)

The machine-readable type of the badge.

associatedEntities -> (list)

The products and offers included in this offer set.

(structure)

A product and offer associated with an offer set.

product -> (structure)

Information about the product associated with the offer set.

productId -> (string)

The unique identifier of the product.

productName -> (string)

The human-readable display name of the product.

manufacturer -> (structure)

The entity who manufactured the product.

sellerProfileId -> (string)

The unique identifier of the seller profile.

displayName -> (string)

The human-readable name of the seller.

offer -> (structure)

Information about the offer associated with the offer set.

offerId -> (string)

The unique identifier of the offer.

offerName -> (string)

The display name of the offer.

sellerOfRecord -> (structure)

The entity responsible for selling the product under this offer.

sellerProfileId -> (string)

The unique identifier of the seller profile.

displayName -> (string)

The human-readable name of the seller.