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-product¶
Description¶
Provides details about a product, such as descriptions, highlights, categories, fulfillment option summaries, promotional media, and seller engagement options.
See also: AWS API Documentation
Synopsis¶
get-product
--product-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¶
--product-id (string)
The unique identifier of the product 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¶
productId -> (string)
The unique identifier of the product.
catalog -> (string)
The name of the catalog that the product belongs to.
productName -> (string)
The human-readable display name of the product.
deployedOnAws -> (string)
Indicates whether the product is deployed on AWS infrastructure.
shortDescription -> (string)
A 1–3 sentence summary describing the key aspects of the product.
longDescription -> (string)
A detailed description of what the product does, in paragraph format.
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.
logoThumbnailUrl -> (string)
The URL of the logo thumbnail image for the product.
fulfillmentOptionSummaries -> (list)
A summary of fulfillment options available for deploying or accessing the product, such as AMI, SaaS, or Container.
(structure)
A summary of a fulfillment option available for deploying or accessing a listing or product.
fulfillmentOptionType -> (string)
The machine-readable type of the fulfillment option, such asSAASorAMAZON_MACHINE_IMAGE.displayName -> (string)
The human-readable name of the fulfillment option type.
categories -> (list)
The categories used to classify this product into logical groups.
(structure)
A category used to classify a listing or product into a logical group.
categoryId -> (string)
The machine-readable identifier of the category.displayName -> (string)
The human-readable name of the category.
highlights -> (list)
A list of key features that the product offers to customers.
(string)
promotionalMedia -> (list)
Embedded promotional media provided by the creator of the product, such as images and videos.
(tagged union structure)
Embedded promotional media for a product, such as images or videos. Each element contains exactly one media type.
Note
This is a Tagged Union structure. Only one of the following top level keys can be set:embeddedImage,embeddedVideo.embeddedImage -> (structure)
An embedded promotional image for a product.
title -> (string)
The title displayed when hovering over the image.url -> (string)
The URL of the image file.description -> (string)
An optional description of the image.embeddedVideo -> (structure)
An embedded promotional video for a product.
title -> (string)
The title displayed when hovering over the video.url -> (string)
The URL of the video file.preview -> (string)
The URL of the high-resolution preview image for the video.thumbnail -> (string)
The URL of the thumbnail image for the video.description -> (string)
An optional description of the video.
resources -> (list)
Resources that provide further information about using the product or requesting support, such as documentation links, support contacts, and usage instructions.
(structure)
A resource that provides supplementary information about a product, such as documentation links, support contacts, or usage instructions.
resourceType -> (string)
The category of the resource, such as manufacturer support or usage instructions.contentType -> (string)
The format of the resource content, such as a URL, email address, or text.value -> (string)
The resource content. Interpretation depends on the content type.displayName -> (string)
An optional human-readable label for the resource.
sellerEngagements -> (list)
Engagement options available to potential buyers, such as requesting a private offer or requesting a demo.
(structure)
An engagement option available to potential buyers of a product, such as requesting a private offer or a demo.
engagementType -> (string)
The type of engagement, such asREQUEST_FOR_PRIVATE_OFFERorREQUEST_FOR_DEMO.contentType -> (string)
The format of the engagement value, such as a URL.value -> (string)
The engagement value, such as a URL to the engagement form.