AWS.MarketplaceDeployment — AWS SDK for JavaScript (original) (raw)

We recommend that you migrate to AWS SDK for JavaScript v3. For dates, additional details, and information on how to migrate, please refer to the linked announcement.

Inherits:

AWS.Service

Identifier:

marketplacedeployment

API Version:

2023-01-25

Defined in:

(unknown)

Overview

Constructs a service interface object. Each API operation is exposed as a function on service.

Service Description

The AWS Marketplace Deployment Service supports the Quick Launch experience, which is a deployment option for software as a service (SaaS) products. Quick Launch simplifies and reduces the time, resources, and steps required to configure, deploy, and launch a products. The AWS Marketplace Deployment Service provides sellers with a secure method for passing deployment parameters (for example, API keys and external IDs) to buyers during the Quick Launch experience.

Sending a Request Using MarketplaceDeployment

var marketplacedeployment = new AWS.MarketplaceDeployment();
marketplacedeployment.listTagsForResource(params, function (err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Locking the API Version

In order to ensure that the MarketplaceDeployment object uses this specific API, you can construct the object by passing the apiVersion option to the constructor:

var marketplacedeployment = new AWS.MarketplaceDeployment({apiVersion: '2023-01-25'});

You can also set the API version globally in AWS.config.apiVersions using the marketplacedeployment service identifier:

AWS.config.apiVersions = {
  marketplacedeployment: '2023-01-25',
  // other service API versions
};

var marketplacedeployment = new AWS.MarketplaceDeployment();

Constructor Summarycollapse

Property Summarycollapse

Properties inherited from AWS.Service

apiVersions

Method Summarycollapse

Methods inherited from AWS.Service

makeRequest, makeUnauthenticatedRequest, waitFor, setupRequestListeners, defineService

Constructor Details

new AWS.MarketplaceDeployment(options = {}) ⇒ Object

Constructs a service object. This object has one method for each API operation.

Property Details

endpoint ⇒ AWS.Endpoint

Returns an Endpoint object representing the endpoint URL for service requests.

Method Details

listTagsForResource(params = {}, callback) ⇒ AWS.Request

Lists all tags that have been added to a deployment parameter resource.

putDeploymentParameter(params = {}, callback) ⇒ AWS.Request

Creates or updates a deployment parameter and is targeted by catalog and agreementId.

untagResource(params = {}, callback) ⇒ AWS.Request

Removes a tag or list of tags from a resource.