AWS Marketplace Deployment Service

2026/11/19 - AWS Marketplace Deployment Service - 4 new api methods

Changes  Add support for deployment configurations for Data as a Service products in AWS Marketplace

GetDeploymentConfigurationJob (new) Link ¶

Returns the details of a deployment configuration job. Only the seller that started the job can call this operation.

If the job doesn't belong to the product and delivery option in the request path, the operation returns a ResourceNotFoundException.

See also: AWS API Documentation

Request Syntax

client.get_deployment_configuration_job(
    catalog='string',
    productId='string',
    deliveryOptionType='data-as-a-service',
    jobId='string'
)
type catalog:

string

param catalog:

[REQUIRED]

The catalog related to the request. Fixed value: AWSMarketplace

type productId:

string

param productId:

[REQUIRED]

The ID of the AWS Marketplace product, for example prod-1234567890abc.

type deliveryOptionType:

string

param deliveryOptionType:

[REQUIRED]

The delivery option type of the deployment configuration.

type jobId:

string

param jobId:

[REQUIRED]

The unique identifier of the deployment configuration job.

rtype:

dict

returns:

Response Syntax

{
    'jobId': 'string',
    'configuration': {
        'dataAsAService': {
            'fulfillmentUrl': 'string'
        }
    },
    'status': 'IN_PROGRESS'|'SUCCEEDED'|'FAILED',
    'createdAt': datetime(2015, 1, 1),
    'configurationArn': 'string',
    'endedAt': datetime(2015, 1, 1),
    'errorCode': 'FULFILLMENT_URL_UNREACHABLE'|'INTERNAL_ERROR'|'ENDPOINT_INVALID',
    'message': 'string'
}

Response Structure

  • (dict) --

    • jobId (string) --

      The unique identifier of the deployment configuration job.

    • configuration (dict) --

      The deployment configuration submitted with the job.

      • dataAsAService (dict) --

        The deployment configuration settings for the Data as a Service delivery option, including the fulfillment URL that AWS Marketplace redirects buyers to after they subscribe.

        • fulfillmentUrl (string) --

          The HTTPS URL that AWS Marketplace redirects buyers to after they subscribe to the product. The value must be a valid URI that uses the HTTPS scheme. Maximum length: 2,048 characters.

    • status (string) --

      The status of the deployment configuration job.

    • createdAt (datetime) --

      The date and time when the job was created.

    • configurationArn (string) --

      The Amazon Resource Name (ARN) of the deployment configuration. This field is present only when the job status is SUCCEEDED.

    • endedAt (datetime) --

      The date and time when the job reached the SUCCEEDED or FAILED status.

    • errorCode (string) --

      The error code that describes why the job failed. This field is present only when the job status is FAILED.

    • message (string) --

      A message that describes why the job failed. This field is present only when the job status is FAILED.

ListDeploymentConfigurationJobs (new) Link ¶

Lists the deployment configuration jobs that you started for a product and delivery option, ordered from newest to oldest. Results are paginated. Use the nextToken parameter to retrieve additional results.

If you haven't started any jobs for the product and delivery option, the operation returns an empty jobs list.

See also: AWS API Documentation

Request Syntax

client.list_deployment_configuration_jobs(
    catalog='string',
    productId='string',
    deliveryOptionType='data-as-a-service',
    maxResults=123,
    nextToken='string'
)
type catalog:

string

param catalog:

[REQUIRED]

The catalog related to the request. Fixed value: AWSMarketplace

type productId:

string

param productId:

[REQUIRED]

The ID of the AWS Marketplace product, for example prod-1234567890abc.

type deliveryOptionType:

string

param deliveryOptionType:

[REQUIRED]

The delivery option type of the deployment configuration.

type maxResults:

integer

param maxResults:

The maximum number of jobs to return in a single page. Valid values are 1 through 100. The default is 20.

type nextToken:

string

param nextToken:

The token for the next page of results. Use the value returned in the previous response.

rtype:

dict

returns:

Response Syntax

{
    'jobs': [
        {
            'jobId': 'string',
            'status': 'IN_PROGRESS'|'SUCCEEDED'|'FAILED',
            'configuration': {
                'dataAsAService': {
                    'fulfillmentUrl': 'string'
                }
            },
            'createdAt': datetime(2015, 1, 1)
        },
    ],
    'nextToken': 'string'
}

Response Structure

  • (dict) --

    • jobs (list) --

      A list of deployment configuration job summaries, ordered from newest to oldest.

      • (dict) --

        Contains summary information about a deployment configuration job, including its identifier, status, configuration, and creation time.

        • jobId (string) --

          The unique identifier of the deployment configuration job.

        • status (string) --

          The status of the deployment configuration job.

        • configuration (dict) --

          The deployment configuration submitted with the job.

          • dataAsAService (dict) --

            The deployment configuration settings for the Data as a Service delivery option, including the fulfillment URL that AWS Marketplace redirects buyers to after they subscribe.

            • fulfillmentUrl (string) --

              The HTTPS URL that AWS Marketplace redirects buyers to after they subscribe to the product. The value must be a valid URI that uses the HTTPS scheme. Maximum length: 2,048 characters.

        • createdAt (datetime) --

          The date and time when the job was created.

    • nextToken (string) --

      The token for the next page of results. This value is absent when there are no more results.

StartDeploymentConfigurationJob (new) Link ¶

Starts a job that publishes a deployment configuration for a product and delivery option. The job runs asynchronously. Use GetDeploymentConfigurationJob to track its status. When the job reaches the SUCCEEDED status, its configuration becomes the active deployment configuration for the product and delivery option.

The populated member of configuration must match the deliveryOptionType in the request path.

See also: AWS API Documentation

Request Syntax

client.start_deployment_configuration_job(
    catalog='string',
    productId='string',
    deliveryOptionType='data-as-a-service',
    configuration={
        'dataAsAService': {
            'fulfillmentUrl': 'string'
        }
    },
    tags={
        'string': 'string'
    },
    clientToken='string'
)
type catalog:

string

param catalog:

[REQUIRED]

The catalog related to the request. Fixed value: AWSMarketplace

type productId:

string

param productId:

[REQUIRED]

The ID of the AWS Marketplace product, for example prod-1234567890abc.

type deliveryOptionType:

string

param deliveryOptionType:

[REQUIRED]

The delivery option type of the deployment configuration.

type configuration:

dict

param configuration:

[REQUIRED]

The deployment configuration to publish.

  • dataAsAService (dict) --

    The deployment configuration settings for the Data as a Service delivery option, including the fulfillment URL that AWS Marketplace redirects buyers to after they subscribe.

    • fulfillmentUrl (string) -- [REQUIRED]

      The HTTPS URL that AWS Marketplace redirects buyers to after they subscribe to the product. The value must be a valid URI that uses the HTTPS scheme. Maximum length: 2,048 characters.

type tags:

dict

param tags:

A map of key-value pairs, where each pair represents a tag to apply to the deployment configuration. Only the request that creates the deployment configuration can apply tags. If the deployment configuration already exists, a request that includes one or more tags fails with a ValidationException. To change tags on an existing deployment configuration, use TagResource and UntagResource.

  • (string) --

    • (string) --

type clientToken:

string

param clientToken:

A unique, case-sensitive identifier that you provide to ensure that the operation completes no more than one time. If you retry a request with the same token and the same input, the service returns the original job instead of starting a new one. If you reuse a token with different input, the request fails with a ConflictException.

This field is autopopulated if not provided.

rtype:

dict

returns:

Response Syntax

{
    'jobId': 'string',
    'configuration': {
        'dataAsAService': {
            'fulfillmentUrl': 'string'
        }
    },
    'status': 'IN_PROGRESS'|'SUCCEEDED'|'FAILED',
    'createdAt': datetime(2015, 1, 1)
}

Response Structure

  • (dict) --

    • jobId (string) --

      The unique identifier of the deployment configuration job.

    • configuration (dict) --

      The deployment configuration submitted with the job.

      • dataAsAService (dict) --

        The deployment configuration settings for the Data as a Service delivery option, including the fulfillment URL that AWS Marketplace redirects buyers to after they subscribe.

        • fulfillmentUrl (string) --

          The HTTPS URL that AWS Marketplace redirects buyers to after they subscribe to the product. The value must be a valid URI that uses the HTTPS scheme. Maximum length: 2,048 characters.

    • status (string) --

      The status of the deployment configuration job. The value is IN_PROGRESS.

    • createdAt (datetime) --

      The date and time when the job was created.

GetDeploymentConfiguration (new) Link ¶

Returns the active deployment configuration for a product and delivery option. The active deployment configuration is the configuration from the most recent successful deployment configuration job. The seller that owns the product and buyers entitled to the product can call this operation.

If the product and delivery option have no active deployment configuration, the operation returns a ResourceNotFoundException.

See also: AWS API Documentation

Request Syntax

client.get_deployment_configuration(
    catalog='string',
    productId='string',
    deliveryOptionType='data-as-a-service'
)
type catalog:

string

param catalog:

[REQUIRED]

The catalog related to the request. Fixed value: AWSMarketplace

type productId:

string

param productId:

[REQUIRED]

The ID of the AWS Marketplace product, for example prod-1234567890abc.

type deliveryOptionType:

string

param deliveryOptionType:

[REQUIRED]

The delivery option type of the deployment configuration.

rtype:

dict

returns:

Response Syntax

{
    'configuration': {
        'dataAsAService': {
            'fulfillmentUrl': 'string'
        }
    }
}

Response Structure

  • (dict) --

    • configuration (dict) --

      The active deployment configuration.

      • dataAsAService (dict) --

        The deployment configuration settings for the Data as a Service delivery option, including the fulfillment URL that AWS Marketplace redirects buyers to after they subscribe.

        • fulfillmentUrl (string) --

          The HTTPS URL that AWS Marketplace redirects buyers to after they subscribe to the product. The value must be a valid URI that uses the HTTPS scheme. Maximum length: 2,048 characters.