[ aws . marketplace-discovery ]
list-fulfillment-options¶
Description¶
Returns the fulfillment options available for a product, including deployment details such as version information, operating systems, usage instructions, and release notes.
See also: AWS API Documentation
list-fulfillment-options 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: fulfillmentOptions
Synopsis¶
list-fulfillment-options
--product-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¶
--product-id (string) [required]
The unique identifier of the product for which to list fulfillment options.
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¶
fulfillmentOptions -> (list)
The fulfillment options available for the product. Each option describes how the buyer can deploy or access the product.
(tagged union structure)
Describes a fulfillment option for a product. Each element contains exactly one fulfillment option type.
Note
This is a Tagged Union structure. Only one of the following top level keys can be set:amazonMachineImageFulfillmentOption,apiFulfillmentOption,cloudFormationFulfillmentOption,containerFulfillmentOption,helmFulfillmentOption,eksAddOnFulfillmentOption,ec2ImageBuilderComponentFulfillmentOption,dataExchangeFulfillmentOption,professionalServicesFulfillmentOption,saasFulfillmentOption,sageMakerAlgorithmFulfillmentOption,sageMakerModelFulfillmentOption.amazonMachineImageFulfillmentOption -> (structure)
An Amazon Machine Image (AMI) fulfillment option for EC2 deployment.
fulfillmentOptionId -> (string) [required]
The unique identifier of the fulfillment option.fulfillmentOptionName -> (string) [required]
The display name of the fulfillment option version.fulfillmentOptionVersion -> (string)
The version identifier of the fulfillment option.fulfillmentOptionType -> (string) [required]
The category of the fulfillment option.
Possible values:
AMAZON_MACHINE_IMAGEAPICLOUDFORMATION_TEMPLATECONTAINERHELMEKS_ADD_ONEC2_IMAGE_BUILDER_COMPONENTDATA_EXCHANGEPROFESSIONAL_SERVICESSAASSAGEMAKER_ALGORITHMSAGEMAKER_MODELfulfillmentOptionDisplayName -> (string) [required]
A human-readable name for the fulfillment option type.operatingSystems -> (list) [required]
The operating systems supported by this AMI.
(structure)
Describes an operating system supported by an AMI fulfillment option.
operatingSystemFamilyName -> (string) [required]
The operating system family, such as Linux or Windows.operatingSystemName -> (string) [required]
The specific operating system name, such as Amazon Linux 2 or Windows Server 2022.operatingSystemVersion -> (string)
The version of the operating system.recommendation -> (structure)
Recommended instance types for running this AMI.
instanceType -> (string) [required]
The recommended EC2 instance type for this AMI.releaseNotes -> (string)
Release notes describing changes in this version of the fulfillment option.usageInstructions -> (string)
Instructions on how to deploy and use this fulfillment option.apiFulfillmentOption -> (structure)
An API-based fulfillment option for programmatic integration.
fulfillmentOptionId -> (string) [required]
The unique identifier of the fulfillment option.fulfillmentOptionType -> (string) [required]
The category of the fulfillment option.
Possible values:
AMAZON_MACHINE_IMAGEAPICLOUDFORMATION_TEMPLATECONTAINERHELMEKS_ADD_ONEC2_IMAGE_BUILDER_COMPONENTDATA_EXCHANGEPROFESSIONAL_SERVICESSAASSAGEMAKER_ALGORITHMSAGEMAKER_MODELfulfillmentOptionDisplayName -> (string) [required]
A human-readable name for the fulfillment option type.usageInstructions -> (string)
Instructions on how to integrate with and use this API.awsSupportedServices -> (list) [required]
The AWS services supported by this API integration.
(structure)
Describes an AWS service supported by a fulfillment option.
supportedServiceType -> (string) [required]
The machine-readable identifier of the supported service.displayName -> (string) [required]
The human-readable name of the supported service.description -> (string) [required]
A description of the supported service.cloudFormationFulfillmentOption -> (structure)
An AWS CloudFormation template fulfillment option for infrastructure deployment.
fulfillmentOptionId -> (string) [required]
The unique identifier of the fulfillment option.fulfillmentOptionName -> (string) [required]
The display name of the fulfillment option version.fulfillmentOptionType -> (string) [required]
The category of the fulfillment option.
Possible values:
AMAZON_MACHINE_IMAGEAPICLOUDFORMATION_TEMPLATECONTAINERHELMEKS_ADD_ONEC2_IMAGE_BUILDER_COMPONENTDATA_EXCHANGEPROFESSIONAL_SERVICESSAASSAGEMAKER_ALGORITHMSAGEMAKER_MODELfulfillmentOptionDisplayName -> (string) [required]
A human-readable name for the fulfillment option type.fulfillmentOptionVersion -> (string)
The version identifier of the fulfillment option.releaseNotes -> (string)
Release notes describing changes in this version of the fulfillment option.usageInstructions -> (string)
Instructions on how to deploy and use this CloudFormation template.containerFulfillmentOption -> (structure)
A container image fulfillment option for container-based deployment.
fulfillmentOptionId -> (string) [required]
The unique identifier of the fulfillment option.fulfillmentOptionName -> (string) [required]
The display name of the fulfillment option version.fulfillmentOptionType -> (string) [required]
The category of the fulfillment option.
Possible values:
AMAZON_MACHINE_IMAGEAPICLOUDFORMATION_TEMPLATECONTAINERHELMEKS_ADD_ONEC2_IMAGE_BUILDER_COMPONENTDATA_EXCHANGEPROFESSIONAL_SERVICESSAASSAGEMAKER_ALGORITHMSAGEMAKER_MODELfulfillmentOptionDisplayName -> (string) [required]
A human-readable name for the fulfillment option type.fulfillmentOptionVersion -> (string)
The version identifier of the fulfillment option.operatingSystems -> (list)
The operating systems supported by this container image.
(structure)
Describes an operating system supported by a container fulfillment option.
operatingSystemFamilyName -> (string) [required]
The operating system family, such as Linux.operatingSystemName -> (string) [required]
The specific operating system name.awsSupportedServices -> (list)
The AWS services supported by this container deployment.
(structure)
Describes an AWS service supported by a fulfillment option.
supportedServiceType -> (string) [required]
The machine-readable identifier of the supported service.displayName -> (string) [required]
The human-readable name of the supported service.description -> (string) [required]
A description of the supported service.releaseNotes -> (string)
Release notes describing changes in this version of the fulfillment option.usageInstructions -> (string)
Instructions on how to deploy and use this container image.helmFulfillmentOption -> (structure)
A Helm chart fulfillment option for Kubernetes deployment.
fulfillmentOptionId -> (string) [required]
The unique identifier of the fulfillment option.fulfillmentOptionName -> (string) [required]
The display name of the fulfillment option version.fulfillmentOptionType -> (string) [required]
The category of the fulfillment option.
Possible values:
AMAZON_MACHINE_IMAGEAPICLOUDFORMATION_TEMPLATECONTAINERHELMEKS_ADD_ONEC2_IMAGE_BUILDER_COMPONENTDATA_EXCHANGEPROFESSIONAL_SERVICESSAASSAGEMAKER_ALGORITHMSAGEMAKER_MODELfulfillmentOptionDisplayName -> (string) [required]
A human-readable name for the fulfillment option type.fulfillmentOptionVersion -> (string)
The version identifier of the fulfillment option.operatingSystems -> (list)
The operating systems supported by this Helm chart.
(structure)
Describes an operating system supported by a Helm chart fulfillment option.
operatingSystemFamilyName -> (string) [required]
The operating system family, such as Linux.operatingSystemName -> (string) [required]
The specific operating system name.releaseNotes -> (string)
Release notes describing changes in this version of the fulfillment option.awsSupportedServices -> (list)
The AWS services supported by this Helm chart deployment.
(structure)
Describes an AWS service supported by a fulfillment option.
supportedServiceType -> (string) [required]
The machine-readable identifier of the supported service.displayName -> (string) [required]
The human-readable name of the supported service.description -> (string) [required]
A description of the supported service.usageInstructions -> (string)
Instructions on how to deploy and use this Helm chart.eksAddOnFulfillmentOption -> (structure)
An Amazon EKS add-on fulfillment option.
fulfillmentOptionId -> (string) [required]
The unique identifier of the fulfillment option.fulfillmentOptionName -> (string) [required]
The display name of the fulfillment option version.fulfillmentOptionType -> (string) [required]
The category of the fulfillment option.
Possible values:
AMAZON_MACHINE_IMAGEAPICLOUDFORMATION_TEMPLATECONTAINERHELMEKS_ADD_ONEC2_IMAGE_BUILDER_COMPONENTDATA_EXCHANGEPROFESSIONAL_SERVICESSAASSAGEMAKER_ALGORITHMSAGEMAKER_MODELfulfillmentOptionDisplayName -> (string) [required]
A human-readable name for the fulfillment option type.fulfillmentOptionVersion -> (string)
The version identifier of the fulfillment option.operatingSystems -> (list)
The operating systems supported by this EKS add-on.
(structure)
Describes an operating system supported by an EKS add-on fulfillment option.
operatingSystemFamilyName -> (string) [required]
The operating system family, such as Linux.operatingSystemName -> (string) [required]
The specific operating system name.releaseNotes -> (string)
Release notes describing changes in this version of the fulfillment option.usageInstructions -> (string)
Instructions on how to deploy and use this EKS add-on.awsSupportedServices -> (list)
The AWS services supported by this EKS add-on.
(structure)
Describes an AWS service supported by a fulfillment option.
supportedServiceType -> (string) [required]
The machine-readable identifier of the supported service.displayName -> (string) [required]
The human-readable name of the supported service.description -> (string) [required]
A description of the supported service.ec2ImageBuilderComponentFulfillmentOption -> (structure)
An EC2 Image Builder component fulfillment option.
fulfillmentOptionId -> (string) [required]
The unique identifier of the fulfillment option.fulfillmentOptionName -> (string) [required]
The display name of the fulfillment option version.fulfillmentOptionType -> (string) [required]
The category of the fulfillment option.
Possible values:
AMAZON_MACHINE_IMAGEAPICLOUDFORMATION_TEMPLATECONTAINERHELMEKS_ADD_ONEC2_IMAGE_BUILDER_COMPONENTDATA_EXCHANGEPROFESSIONAL_SERVICESSAASSAGEMAKER_ALGORITHMSAGEMAKER_MODELfulfillmentOptionDisplayName -> (string) [required]
A human-readable name for the fulfillment option type.fulfillmentOptionVersion -> (string)
The version identifier of the fulfillment option.operatingSystems -> (list)
The operating systems supported by this EC2 Image Builder component.
(structure)
Describes an operating system supported by a container fulfillment option.
operatingSystemFamilyName -> (string) [required]
The operating system family, such as Linux.operatingSystemName -> (string) [required]
The specific operating system name.awsSupportedServices -> (list)
The AWS services supported by this EC2 Image Builder component.
(structure)
Describes an AWS service supported by a fulfillment option.
supportedServiceType -> (string) [required]
The machine-readable identifier of the supported service.displayName -> (string) [required]
The human-readable name of the supported service.description -> (string) [required]
A description of the supported service.releaseNotes -> (string)
Release notes describing changes in this version of the fulfillment option.usageInstructions -> (string)
Instructions on how to deploy and use this EC2 Image Builder component.dataExchangeFulfillmentOption -> (structure)
An AWS Data Exchange fulfillment option for data set delivery.
fulfillmentOptionId -> (string) [required]
The unique identifier of the fulfillment option.fulfillmentOptionType -> (string) [required]
The category of the fulfillment option.
Possible values:
AMAZON_MACHINE_IMAGEAPICLOUDFORMATION_TEMPLATECONTAINERHELMEKS_ADD_ONEC2_IMAGE_BUILDER_COMPONENTDATA_EXCHANGEPROFESSIONAL_SERVICESSAASSAGEMAKER_ALGORITHMSAGEMAKER_MODELfulfillmentOptionDisplayName -> (string) [required]
A human-readable name for the fulfillment option type.dataArtifacts -> (list)
The data artifacts included in this Data Exchange fulfillment option.
(structure)
Describes a data artifact within a Data Exchange fulfillment option.
description -> (string)
A description of the data artifact.resourceArn -> (string)
The Amazon Resource Name (ARN) of the data artifact.resourceType -> (string) [required]
The type of the data artifact resource.dataClassification -> (string) [required]
The classification of sensitive data contained in the dataset.professionalServicesFulfillmentOption -> (structure)
A professional services fulfillment option.
fulfillmentOptionId -> (string) [required]
The unique identifier of the fulfillment option.fulfillmentOptionType -> (string) [required]
The category of the fulfillment option.
Possible values:
AMAZON_MACHINE_IMAGEAPICLOUDFORMATION_TEMPLATECONTAINERHELMEKS_ADD_ONEC2_IMAGE_BUILDER_COMPONENTDATA_EXCHANGEPROFESSIONAL_SERVICESSAASSAGEMAKER_ALGORITHMSAGEMAKER_MODELfulfillmentOptionDisplayName -> (string) [required]
A human-readable name for the fulfillment option type.saasFulfillmentOption -> (structure)
A Software as a Service (SaaS) fulfillment option.
fulfillmentOptionId -> (string) [required]
The unique identifier of the fulfillment option.fulfillmentOptionType -> (string) [required]
The category of the fulfillment option.
Possible values:
AMAZON_MACHINE_IMAGEAPICLOUDFORMATION_TEMPLATECONTAINERHELMEKS_ADD_ONEC2_IMAGE_BUILDER_COMPONENTDATA_EXCHANGEPROFESSIONAL_SERVICESSAASSAGEMAKER_ALGORITHMSAGEMAKER_MODELfulfillmentOptionDisplayName -> (string) [required]
A human-readable name for the fulfillment option type.fulfillmentUrl -> (string)
The URL of the seller’s software registration landing page.usageInstructions -> (string)
Instructions on how to access and use this SaaS product.sageMakerAlgorithmFulfillmentOption -> (structure)
An Amazon SageMaker algorithm fulfillment option.
fulfillmentOptionId -> (string) [required]
The unique identifier of the fulfillment option.fulfillmentOptionType -> (string) [required]
The category of the fulfillment option.
Possible values:
AMAZON_MACHINE_IMAGEAPICLOUDFORMATION_TEMPLATECONTAINERHELMEKS_ADD_ONEC2_IMAGE_BUILDER_COMPONENTDATA_EXCHANGEPROFESSIONAL_SERVICESSAASSAGEMAKER_ALGORITHMSAGEMAKER_MODELfulfillmentOptionDisplayName -> (string) [required]
A human-readable name for the fulfillment option type.fulfillmentOptionVersion -> (string)
The version identifier of the fulfillment option.releaseNotes -> (string)
Release notes describing changes in this version of the fulfillment option.usageInstructions -> (string)
Instructions on how to use this SageMaker algorithm.recommendation -> (structure)
Recommended instance types for training and inference with this algorithm.
recommendedBatchTransformInstanceType -> (string) [required]
The recommended instance type for batch inference.recommendedRealtimeInferenceInstanceType -> (string)
The recommended instance type for real-time inference.recommendedTrainingInstanceType -> (string) [required]
The recommended instance type for training.sageMakerModelFulfillmentOption -> (structure)
An Amazon SageMaker model fulfillment option.
fulfillmentOptionId -> (string) [required]
The unique identifier of the fulfillment option.fulfillmentOptionType -> (string) [required]
The category of the fulfillment option.
Possible values:
AMAZON_MACHINE_IMAGEAPICLOUDFORMATION_TEMPLATECONTAINERHELMEKS_ADD_ONEC2_IMAGE_BUILDER_COMPONENTDATA_EXCHANGEPROFESSIONAL_SERVICESSAASSAGEMAKER_ALGORITHMSAGEMAKER_MODELfulfillmentOptionDisplayName -> (string) [required]
A human-readable name for the fulfillment option type.fulfillmentOptionVersion -> (string)
The version identifier of the fulfillment option.releaseNotes -> (string)
Release notes describing changes in this version of the fulfillment option.usageInstructions -> (string)
Instructions on how to use this SageMaker model.recommendation -> (structure)
Recommended instance types for inference with this model.
recommendedBatchTransformInstanceType -> (string) [required]
The recommended instance type for batch inference.recommendedRealtimeInferenceInstanceType -> (string)
The recommended instance type for real-time inference.
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+/=]+