AWS.LaunchWizard — 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.

Overview

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

Service Description

Launch Wizard offers a guided way of sizing, configuring, and deploying Amazon Web Services resources for third party applications, such as Microsoft SQL Server Always On and HANA based SAP systems, without the need to manually identify and provision individual Amazon Web Services resources.

Sending a Request Using LaunchWizard

var launchwizard = new AWS.LaunchWizard();
launchwizard.createDeployment(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 LaunchWizard object uses this specific API, you can construct the object by passing the apiVersion option to the constructor:

var launchwizard = new AWS.LaunchWizard({apiVersion: '2018-05-10'});

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

AWS.config.apiVersions = {
  launchwizard: '2018-05-10',
  // other service API versions
};

var launchwizard = new AWS.LaunchWizard();

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.LaunchWizard(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

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

Creates a deployment for the given workload. Deployments created by this operation are not available in the Launch Wizard console to use the Clone deployment action on.

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

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

Returns information about the deployment.

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

Returns information about a workload.

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

Returns details for a given workload and deployment pattern, including the available specifications. You can use the ListWorkloads operation to discover the available workload names and the ListWorkloadDeploymentPatterns operation to discover the available deployment pattern names of a given workload.

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

Lists the events of a deployment.

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

Lists the deployments that have been created.

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

Lists the tags associated with a specified resource.

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

Lists the workload deployment patterns for a given workload name. You can use the ListWorkloads operation to discover the available workload names.

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

Lists the available workload names. You can use the ListWorkloadDeploymentPatterns operation to discover the available deployment patterns for a given workload.

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

Adds the specified tags to the given resource.

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

Removes the specified tags from the given resource.