get-product¶

Description¶

Provides details about a product, such as descriptions, highlights, categories, fulfillment option summaries, promotional media, and seller engagement options.

Synopsis¶

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

--product-id (string) [required]

The unique identifier of the product 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¶

productId -> (string)

The unique identifier of the product.

Constraints:

min: 1

max: 255

pattern: [\w\-]+

catalog -> (string)

The name of the catalog that the product belongs to.

Constraints:

min: 1

max: 255

pattern: [\w\-]+

productName -> (string)

The human-readable display name of the product.

Constraints:

min: 1

max: 1024

pattern: .*\S.*

deployedOnAws -> (string)

Indicates whether the product is deployed on AWS infrastructure.

Possible values:

DEPLOYED

NOT_DEPLOYED

NOT_APPLICABLE

shortDescription -> (string)

A 1–3 sentence summary describing the key aspects of the product.

Constraints:

min: 1

max: 1024

pattern: .*\S.*

longDescription -> (string)

A detailed description of what the product does, in paragraph format.

Constraints:

min: 0

max: 32768

pattern: .*\S.*

manufacturer -> (structure)

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

logoThumbnailUrl -> (string)

The URL of the logo thumbnail image for the product.

Constraints:

min: 1

max: 2048

pattern: https?://.*

fulfillmentOptionSummaries -> (list)

A summary of fulfillment options available for deploying or accessing the product, such as AMI, SaaS, or Container.

Constraints:

min: 0

max: 20

(structure)

A summary of a fulfillment option available for deploying or accessing a listing or product.

fulfillmentOptionType -> (string) [required]

The machine-readable type of the fulfillment option, such as SAAS or AMAZON_MACHINE_IMAGE .

Possible values:

AMAZON_MACHINE_IMAGE

API

CLOUDFORMATION_TEMPLATE

CONTAINER

HELM

EKS_ADD_ON

EC2_IMAGE_BUILDER_COMPONENT

DATA_EXCHANGE

PROFESSIONAL_SERVICES

SAAS

SAGEMAKER_ALGORITHM

SAGEMAKER_MODEL

displayName -> (string) [required]

The human-readable name of the fulfillment option type.

Constraints:

min: 1

max: 1024

pattern: .*\S.*

categories -> (list)

The categories used to classify this product into logical groups.

Constraints:

min: 0

max: 30

(structure)

A category used to classify a listing or product into a logical group.

categoryId -> (string) [required]

The machine-readable identifier of the category.

Constraints:

min: 1

max: 1024

pattern: .*\S.*

displayName -> (string) [required]

The human-readable name of the category.

Constraints:

min: 1

max: 1024

pattern: .*\S.*

highlights -> (list)

A list of key features that the product offers to customers.

Constraints:

min: 0

max: 10

(string)

Constraints:

min: 1

max: 1024

pattern: .*\S.*

promotionalMedia -> (list)

Embedded promotional media provided by the creator of the product, such as images and videos.

Constraints:

min: 0

max: 100

(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) [required]

The title displayed when hovering over the image.

Constraints:

min: 1

max: 1024

pattern: .*\S.*

url -> (string) [required]

The URL of the image file.

Constraints:

min: 1

max: 2048

pattern: https?://.*

description -> (string)

An optional description of the image.

Constraints:

min: 0

max: 255

embeddedVideo -> (structure)

An embedded promotional video for a product.

title -> (string) [required]

The title displayed when hovering over the video.

Constraints:

min: 1

max: 1024

pattern: .*\S.*

url -> (string) [required]

The URL of the video file.

Constraints:

min: 1

max: 2048

pattern: https?://.*

preview -> (string) [required]

The URL of the high-resolution preview image for the video.

Constraints:

min: 1

max: 2048

pattern: https?://.*

thumbnail -> (string) [required]

The URL of the thumbnail image for the video.

Constraints:

min: 1

max: 2048

pattern: https?://.*

description -> (string)

An optional description of the video.

Constraints:

min: 0

max: 255

resources -> (list)

Resources that provide further information about using the product or requesting support, such as documentation links, support contacts, and usage instructions.

Constraints:

min: 0

max: 100

(structure)

A resource that provides supplementary information about a product, such as documentation links, support contacts, or usage instructions.

resourceType -> (string) [required]

The category of the resource, such as manufacturer support or usage instructions.

Possible values:

MANUFACTURER_SUPPORT

MANUFACTURER_INSTRUCTIONS

contentType -> (string) [required]

The format of the resource content, such as a URL, email address, or text.

Possible values:

EMAIL

PHONE_NUMBER

LINK

OTHER

value -> (string) [required]

The resource content. Interpretation depends on the content type.

Constraints:

min: 1

max: 1024

pattern: .*\S.*

displayName -> (string)

An optional human-readable label for the resource.

Constraints:

min: 0

max: 255

sellerEngagements -> (list)

Engagement options available to potential buyers, such as requesting a private offer or requesting a demo.

Constraints:

min: 0

max: 100

(structure)

An engagement option available to potential buyers of a product, such as requesting a private offer or a demo.

engagementType -> (string) [required]

The type of engagement, such as REQUEST_FOR_PRIVATE_OFFER or REQUEST_FOR_DEMO .

Possible values:

REQUEST_FOR_PRIVATE_OFFER

REQUEST_FOR_DEMO

contentType -> (string) [required]

The format of the engagement value, such as a URL.

Possible values:

LINK

value -> (string) [required]

The engagement value, such as a URL to the engagement form.

Constraints:

min: 1

max: 1024

pattern: .*\S.*

Table of Contents

Feedback

User Guide