MarketplaceDiscovery / Client / list_fulfillment_options
list_fulfillment_options¶
- MarketplaceDiscovery.Client.list_fulfillment_options(**kwargs)¶
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
Request Syntax
response = client.list_fulfillment_options( productId='string', maxResults=123, nextToken='string' )
- Parameters:
productId (string) –
[REQUIRED]
The unique identifier of the product for which to list fulfillment options.
maxResults (integer) – The maximum number of results that are returned per call. You can use
nextTokento get more results.nextToken (string) – If
nextTokenis returned, there are more results available. Make the call again using the returned token to retrieve the next page.
- Return type:
dict
- Returns:
Response Syntax
{ 'fulfillmentOptions': [ { 'amazonMachineImageFulfillmentOption': { 'fulfillmentOptionId': 'string', 'fulfillmentOptionName': 'string', 'fulfillmentOptionVersion': 'string', 'fulfillmentOptionType': 'AMAZON_MACHINE_IMAGE'|'API'|'CLOUDFORMATION_TEMPLATE'|'CONTAINER'|'HELM'|'EKS_ADD_ON'|'EC2_IMAGE_BUILDER_COMPONENT'|'DATA_EXCHANGE'|'PROFESSIONAL_SERVICES'|'SAAS'|'SAGEMAKER_ALGORITHM'|'SAGEMAKER_MODEL', 'fulfillmentOptionDisplayName': 'string', 'operatingSystems': [ { 'operatingSystemFamilyName': 'string', 'operatingSystemName': 'string', 'operatingSystemVersion': 'string' }, ], 'recommendation': { 'instanceType': 'string' }, 'releaseNotes': 'string', 'usageInstructions': 'string' }, 'apiFulfillmentOption': { 'fulfillmentOptionId': 'string', 'fulfillmentOptionType': 'AMAZON_MACHINE_IMAGE'|'API'|'CLOUDFORMATION_TEMPLATE'|'CONTAINER'|'HELM'|'EKS_ADD_ON'|'EC2_IMAGE_BUILDER_COMPONENT'|'DATA_EXCHANGE'|'PROFESSIONAL_SERVICES'|'SAAS'|'SAGEMAKER_ALGORITHM'|'SAGEMAKER_MODEL', 'fulfillmentOptionDisplayName': 'string', 'usageInstructions': 'string', 'awsSupportedServices': [ { 'supportedServiceType': 'string', 'displayName': 'string', 'description': 'string' }, ] }, 'cloudFormationFulfillmentOption': { 'fulfillmentOptionId': 'string', 'fulfillmentOptionName': 'string', 'fulfillmentOptionType': 'AMAZON_MACHINE_IMAGE'|'API'|'CLOUDFORMATION_TEMPLATE'|'CONTAINER'|'HELM'|'EKS_ADD_ON'|'EC2_IMAGE_BUILDER_COMPONENT'|'DATA_EXCHANGE'|'PROFESSIONAL_SERVICES'|'SAAS'|'SAGEMAKER_ALGORITHM'|'SAGEMAKER_MODEL', 'fulfillmentOptionDisplayName': 'string', 'fulfillmentOptionVersion': 'string', 'releaseNotes': 'string', 'usageInstructions': 'string' }, 'containerFulfillmentOption': { 'fulfillmentOptionId': 'string', 'fulfillmentOptionName': 'string', 'fulfillmentOptionType': 'AMAZON_MACHINE_IMAGE'|'API'|'CLOUDFORMATION_TEMPLATE'|'CONTAINER'|'HELM'|'EKS_ADD_ON'|'EC2_IMAGE_BUILDER_COMPONENT'|'DATA_EXCHANGE'|'PROFESSIONAL_SERVICES'|'SAAS'|'SAGEMAKER_ALGORITHM'|'SAGEMAKER_MODEL', 'fulfillmentOptionDisplayName': 'string', 'fulfillmentOptionVersion': 'string', 'operatingSystems': [ { 'operatingSystemFamilyName': 'string', 'operatingSystemName': 'string' }, ], 'awsSupportedServices': [ { 'supportedServiceType': 'string', 'displayName': 'string', 'description': 'string' }, ], 'releaseNotes': 'string', 'usageInstructions': 'string' }, 'helmFulfillmentOption': { 'fulfillmentOptionId': 'string', 'fulfillmentOptionName': 'string', 'fulfillmentOptionType': 'AMAZON_MACHINE_IMAGE'|'API'|'CLOUDFORMATION_TEMPLATE'|'CONTAINER'|'HELM'|'EKS_ADD_ON'|'EC2_IMAGE_BUILDER_COMPONENT'|'DATA_EXCHANGE'|'PROFESSIONAL_SERVICES'|'SAAS'|'SAGEMAKER_ALGORITHM'|'SAGEMAKER_MODEL', 'fulfillmentOptionDisplayName': 'string', 'fulfillmentOptionVersion': 'string', 'operatingSystems': [ { 'operatingSystemFamilyName': 'string', 'operatingSystemName': 'string' }, ], 'releaseNotes': 'string', 'awsSupportedServices': [ { 'supportedServiceType': 'string', 'displayName': 'string', 'description': 'string' }, ], 'usageInstructions': 'string' }, 'eksAddOnFulfillmentOption': { 'fulfillmentOptionId': 'string', 'fulfillmentOptionName': 'string', 'fulfillmentOptionType': 'AMAZON_MACHINE_IMAGE'|'API'|'CLOUDFORMATION_TEMPLATE'|'CONTAINER'|'HELM'|'EKS_ADD_ON'|'EC2_IMAGE_BUILDER_COMPONENT'|'DATA_EXCHANGE'|'PROFESSIONAL_SERVICES'|'SAAS'|'SAGEMAKER_ALGORITHM'|'SAGEMAKER_MODEL', 'fulfillmentOptionDisplayName': 'string', 'fulfillmentOptionVersion': 'string', 'operatingSystems': [ { 'operatingSystemFamilyName': 'string', 'operatingSystemName': 'string' }, ], 'releaseNotes': 'string', 'usageInstructions': 'string', 'awsSupportedServices': [ { 'supportedServiceType': 'string', 'displayName': 'string', 'description': 'string' }, ] }, 'ec2ImageBuilderComponentFulfillmentOption': { 'fulfillmentOptionId': 'string', 'fulfillmentOptionName': 'string', 'fulfillmentOptionType': 'AMAZON_MACHINE_IMAGE'|'API'|'CLOUDFORMATION_TEMPLATE'|'CONTAINER'|'HELM'|'EKS_ADD_ON'|'EC2_IMAGE_BUILDER_COMPONENT'|'DATA_EXCHANGE'|'PROFESSIONAL_SERVICES'|'SAAS'|'SAGEMAKER_ALGORITHM'|'SAGEMAKER_MODEL', 'fulfillmentOptionDisplayName': 'string', 'fulfillmentOptionVersion': 'string', 'operatingSystems': [ { 'operatingSystemFamilyName': 'string', 'operatingSystemName': 'string' }, ], 'awsSupportedServices': [ { 'supportedServiceType': 'string', 'displayName': 'string', 'description': 'string' }, ], 'releaseNotes': 'string', 'usageInstructions': 'string' }, 'dataExchangeFulfillmentOption': { 'fulfillmentOptionId': 'string', 'fulfillmentOptionType': 'AMAZON_MACHINE_IMAGE'|'API'|'CLOUDFORMATION_TEMPLATE'|'CONTAINER'|'HELM'|'EKS_ADD_ON'|'EC2_IMAGE_BUILDER_COMPONENT'|'DATA_EXCHANGE'|'PROFESSIONAL_SERVICES'|'SAAS'|'SAGEMAKER_ALGORITHM'|'SAGEMAKER_MODEL', 'fulfillmentOptionDisplayName': 'string', 'dataArtifacts': [ { 'description': 'string', 'resourceArn': 'string', 'resourceType': 'string', 'dataClassification': 'string' }, ] }, 'professionalServicesFulfillmentOption': { 'fulfillmentOptionId': 'string', 'fulfillmentOptionType': 'AMAZON_MACHINE_IMAGE'|'API'|'CLOUDFORMATION_TEMPLATE'|'CONTAINER'|'HELM'|'EKS_ADD_ON'|'EC2_IMAGE_BUILDER_COMPONENT'|'DATA_EXCHANGE'|'PROFESSIONAL_SERVICES'|'SAAS'|'SAGEMAKER_ALGORITHM'|'SAGEMAKER_MODEL', 'fulfillmentOptionDisplayName': 'string' }, 'saasFulfillmentOption': { 'fulfillmentOptionId': 'string', 'fulfillmentOptionType': 'AMAZON_MACHINE_IMAGE'|'API'|'CLOUDFORMATION_TEMPLATE'|'CONTAINER'|'HELM'|'EKS_ADD_ON'|'EC2_IMAGE_BUILDER_COMPONENT'|'DATA_EXCHANGE'|'PROFESSIONAL_SERVICES'|'SAAS'|'SAGEMAKER_ALGORITHM'|'SAGEMAKER_MODEL', 'fulfillmentOptionDisplayName': 'string', 'fulfillmentUrl': 'string', 'usageInstructions': 'string' }, 'sageMakerAlgorithmFulfillmentOption': { 'fulfillmentOptionId': 'string', 'fulfillmentOptionType': 'AMAZON_MACHINE_IMAGE'|'API'|'CLOUDFORMATION_TEMPLATE'|'CONTAINER'|'HELM'|'EKS_ADD_ON'|'EC2_IMAGE_BUILDER_COMPONENT'|'DATA_EXCHANGE'|'PROFESSIONAL_SERVICES'|'SAAS'|'SAGEMAKER_ALGORITHM'|'SAGEMAKER_MODEL', 'fulfillmentOptionDisplayName': 'string', 'fulfillmentOptionVersion': 'string', 'releaseNotes': 'string', 'usageInstructions': 'string', 'recommendation': { 'recommendedBatchTransformInstanceType': 'string', 'recommendedRealtimeInferenceInstanceType': 'string', 'recommendedTrainingInstanceType': 'string' } }, 'sageMakerModelFulfillmentOption': { 'fulfillmentOptionId': 'string', 'fulfillmentOptionType': 'AMAZON_MACHINE_IMAGE'|'API'|'CLOUDFORMATION_TEMPLATE'|'CONTAINER'|'HELM'|'EKS_ADD_ON'|'EC2_IMAGE_BUILDER_COMPONENT'|'DATA_EXCHANGE'|'PROFESSIONAL_SERVICES'|'SAAS'|'SAGEMAKER_ALGORITHM'|'SAGEMAKER_MODEL', 'fulfillmentOptionDisplayName': 'string', 'fulfillmentOptionVersion': 'string', 'releaseNotes': 'string', 'usageInstructions': 'string', 'recommendation': { 'recommendedBatchTransformInstanceType': 'string', 'recommendedRealtimeInferenceInstanceType': 'string' } } }, ], 'nextToken': 'string' }
Response Structure
(dict) –
fulfillmentOptions (list) –
The fulfillment options available for the product. Each option describes how the buyer can deploy or access the product.
(dict) –
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 will be set:
amazonMachineImageFulfillmentOption,apiFulfillmentOption,cloudFormationFulfillmentOption,containerFulfillmentOption,helmFulfillmentOption,eksAddOnFulfillmentOption,ec2ImageBuilderComponentFulfillmentOption,dataExchangeFulfillmentOption,professionalServicesFulfillmentOption,saasFulfillmentOption,sageMakerAlgorithmFulfillmentOption,sageMakerModelFulfillmentOption. If a client receives an unknown member it will setSDK_UNKNOWN_MEMBERas the top level key, which maps to the name or tag of the unknown member. The structure ofSDK_UNKNOWN_MEMBERis as follows:'SDK_UNKNOWN_MEMBER': {'name': 'UnknownMemberName'}
amazonMachineImageFulfillmentOption (dict) –
An Amazon Machine Image (AMI) fulfillment option for EC2 deployment.
fulfillmentOptionId (string) –
The unique identifier of the fulfillment option.
fulfillmentOptionName (string) –
The display name of the fulfillment option version.
fulfillmentOptionVersion (string) –
The version identifier of the fulfillment option.
fulfillmentOptionType (string) –
The category of the fulfillment option.
fulfillmentOptionDisplayName (string) –
A human-readable name for the fulfillment option type.
operatingSystems (list) –
The operating systems supported by this AMI.
(dict) –
Describes an operating system supported by an AMI fulfillment option.
operatingSystemFamilyName (string) –
The operating system family, such as Linux or Windows.
operatingSystemName (string) –
The specific operating system name, such as Amazon Linux 2 or Windows Server 2022.
operatingSystemVersion (string) –
The version of the operating system.
recommendation (dict) –
Recommended instance types for running this AMI.
instanceType (string) –
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 (dict) –
An API-based fulfillment option for programmatic integration.
fulfillmentOptionId (string) –
The unique identifier of the fulfillment option.
fulfillmentOptionType (string) –
The category of the fulfillment option.
fulfillmentOptionDisplayName (string) –
A human-readable name for the fulfillment option type.
usageInstructions (string) –
Instructions on how to integrate with and use this API.
awsSupportedServices (list) –
The AWS services supported by this API integration.
(dict) –
Describes an AWS service supported by a fulfillment option.
supportedServiceType (string) –
The machine-readable identifier of the supported service.
displayName (string) –
The human-readable name of the supported service.
description (string) –
A description of the supported service.
cloudFormationFulfillmentOption (dict) –
An AWS CloudFormation template fulfillment option for infrastructure deployment.
fulfillmentOptionId (string) –
The unique identifier of the fulfillment option.
fulfillmentOptionName (string) –
The display name of the fulfillment option version.
fulfillmentOptionType (string) –
The category of the fulfillment option.
fulfillmentOptionDisplayName (string) –
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 (dict) –
A container image fulfillment option for container-based deployment.
fulfillmentOptionId (string) –
The unique identifier of the fulfillment option.
fulfillmentOptionName (string) –
The display name of the fulfillment option version.
fulfillmentOptionType (string) –
The category of the fulfillment option.
fulfillmentOptionDisplayName (string) –
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.
(dict) –
Describes an operating system supported by a container fulfillment option.
operatingSystemFamilyName (string) –
The operating system family, such as Linux.
operatingSystemName (string) –
The specific operating system name.
awsSupportedServices (list) –
The AWS services supported by this container deployment.
(dict) –
Describes an AWS service supported by a fulfillment option.
supportedServiceType (string) –
The machine-readable identifier of the supported service.
displayName (string) –
The human-readable name of the supported service.
description (string) –
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 (dict) –
A Helm chart fulfillment option for Kubernetes deployment.
fulfillmentOptionId (string) –
The unique identifier of the fulfillment option.
fulfillmentOptionName (string) –
The display name of the fulfillment option version.
fulfillmentOptionType (string) –
The category of the fulfillment option.
fulfillmentOptionDisplayName (string) –
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.
(dict) –
Describes an operating system supported by a Helm chart fulfillment option.
operatingSystemFamilyName (string) –
The operating system family, such as Linux.
operatingSystemName (string) –
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.
(dict) –
Describes an AWS service supported by a fulfillment option.
supportedServiceType (string) –
The machine-readable identifier of the supported service.
displayName (string) –
The human-readable name of the supported service.
description (string) –
A description of the supported service.
usageInstructions (string) –
Instructions on how to deploy and use this Helm chart.
eksAddOnFulfillmentOption (dict) –
An Amazon EKS add-on fulfillment option.
fulfillmentOptionId (string) –
The unique identifier of the fulfillment option.
fulfillmentOptionName (string) –
The display name of the fulfillment option version.
fulfillmentOptionType (string) –
The category of the fulfillment option.
fulfillmentOptionDisplayName (string) –
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.
(dict) –
Describes an operating system supported by an EKS add-on fulfillment option.
operatingSystemFamilyName (string) –
The operating system family, such as Linux.
operatingSystemName (string) –
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.
(dict) –
Describes an AWS service supported by a fulfillment option.
supportedServiceType (string) –
The machine-readable identifier of the supported service.
displayName (string) –
The human-readable name of the supported service.
description (string) –
A description of the supported service.
ec2ImageBuilderComponentFulfillmentOption (dict) –
An EC2 Image Builder component fulfillment option.
fulfillmentOptionId (string) –
The unique identifier of the fulfillment option.
fulfillmentOptionName (string) –
The display name of the fulfillment option version.
fulfillmentOptionType (string) –
The category of the fulfillment option.
fulfillmentOptionDisplayName (string) –
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.
(dict) –
Describes an operating system supported by a container fulfillment option.
operatingSystemFamilyName (string) –
The operating system family, such as Linux.
operatingSystemName (string) –
The specific operating system name.
awsSupportedServices (list) –
The AWS services supported by this EC2 Image Builder component.
(dict) –
Describes an AWS service supported by a fulfillment option.
supportedServiceType (string) –
The machine-readable identifier of the supported service.
displayName (string) –
The human-readable name of the supported service.
description (string) –
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 (dict) –
An AWS Data Exchange fulfillment option for data set delivery.
fulfillmentOptionId (string) –
The unique identifier of the fulfillment option.
fulfillmentOptionType (string) –
The category of the fulfillment option.
fulfillmentOptionDisplayName (string) –
A human-readable name for the fulfillment option type.
dataArtifacts (list) –
The data artifacts included in this Data Exchange fulfillment option.
(dict) –
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) –
The type of the data artifact resource.
dataClassification (string) –
The classification of sensitive data contained in the dataset.
professionalServicesFulfillmentOption (dict) –
A professional services fulfillment option.
fulfillmentOptionId (string) –
The unique identifier of the fulfillment option.
fulfillmentOptionType (string) –
The category of the fulfillment option.
fulfillmentOptionDisplayName (string) –
A human-readable name for the fulfillment option type.
saasFulfillmentOption (dict) –
A Software as a Service (SaaS) fulfillment option.
fulfillmentOptionId (string) –
The unique identifier of the fulfillment option.
fulfillmentOptionType (string) –
The category of the fulfillment option.
fulfillmentOptionDisplayName (string) –
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 (dict) –
An Amazon SageMaker algorithm fulfillment option.
fulfillmentOptionId (string) –
The unique identifier of the fulfillment option.
fulfillmentOptionType (string) –
The category of the fulfillment option.
fulfillmentOptionDisplayName (string) –
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 (dict) –
Recommended instance types for training and inference with this algorithm.
recommendedBatchTransformInstanceType (string) –
The recommended instance type for batch inference.
recommendedRealtimeInferenceInstanceType (string) –
The recommended instance type for real-time inference.
recommendedTrainingInstanceType (string) –
The recommended instance type for training.
sageMakerModelFulfillmentOption (dict) –
An Amazon SageMaker model fulfillment option.
fulfillmentOptionId (string) –
The unique identifier of the fulfillment option.
fulfillmentOptionType (string) –
The category of the fulfillment option.
fulfillmentOptionDisplayName (string) –
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 (dict) –
Recommended instance types for inference with this model.
recommendedBatchTransformInstanceType (string) –
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.
Exceptions
MarketplaceDiscovery.Client.exceptions.ThrottlingExceptionMarketplaceDiscovery.Client.exceptions.AccessDeniedExceptionMarketplaceDiscovery.Client.exceptions.ValidationExceptionMarketplaceDiscovery.Client.exceptions.ResourceNotFoundExceptionMarketplaceDiscovery.Client.exceptions.InternalServerException