Class: AWS.LaunchWizard

var params = {
  deploymentId: 'STRING_VALUE' /* required */
};
launchwizard.deleteDeployment(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

• params (Object) (defaults to: {}) —
  • deploymentId — (String)

    The ID of the deployment.

Callback (callback):

• function(err, data) { ... }

  Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

  Context (this):

  • (AWS.Response) —

    the response object containing error, data properties, and the original request object.

  Parameters:

  • err (Error) —

    the error object returned from the request. Set to null if the request is successful.

  • data (Object) —

    the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

    • status — (String)

      The status of the deployment.

      Possible values include:
      • "COMPLETED"
      • "CREATING"
      • "DELETE_IN_PROGRESS"
      • "DELETE_INITIATING"
      • "DELETE_FAILED"
      • "DELETED"
      • "FAILED"
      • "IN_PROGRESS"
      • "VALIDATING"
    • statusReason — (String)

      The reason for the deployment status.

Returns:

• (AWS.Request) —

  a handle to the operation request for subsequent event callback registration.

var params = {
  deploymentId: 'STRING_VALUE' /* required */
};
launchwizard.getDeployment(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

• params (Object) (defaults to: {}) —
  • deploymentId — (String)

    The ID of the deployment.

Callback (callback):

• function(err, data) { ... }

  Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

  Context (this):

  • (AWS.Response) —

    the response object containing error, data properties, and the original request object.

  Parameters:

  • err (Error) —

    the error object returned from the request. Set to null if the request is successful.

  • data (Object) —

    the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

    • deployment — (map)

      An object that details the deployment.

      • createdAt — (Date)

        The time the deployment was created.

      • deletedAt — (Date)

        The time the deployment was deleted.

      • deploymentArn — (String)

        The Amazon Resource Name (ARN) of the deployment.

      • id — (String)

        The ID of the deployment.

      • name — (String)

        The name of the deployment.

      • patternName — (String)

        The pattern name of the deployment.

      • resourceGroup — (String)

        The resource group of the deployment.

      • specifications — (map<String>)

        The settings specified for the deployment. These settings define how to deploy and configure your resources created by the deployment. For more information about the specifications required for creating a deployment for a SAP workload, see SAP deployment specifications. To retrieve the specifications required to create a deployment for other workloads, use the GetWorkloadDeploymentPattern operation.

      • status — (String)

        The status of the deployment.

        Possible values include:
        • "COMPLETED"
        • "CREATING"
        • "DELETE_IN_PROGRESS"
        • "DELETE_INITIATING"
        • "DELETE_FAILED"
        • "DELETED"
        • "FAILED"
        • "IN_PROGRESS"
        • "VALIDATING"
      • tags — (map<String>)

        Information about the tags attached to a deployment.

      • workloadName — (String)

        The name of the workload.

Returns:

• (AWS.Request) —

  a handle to the operation request for subsequent event callback registration.

var params = {
  workloadName: 'STRING_VALUE' /* required */
};
launchwizard.getWorkload(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

• params (Object) (defaults to: {}) —
  • workloadName — (String)

    The name of the workload.

Callback (callback):

• function(err, data) { ... }

  Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

  Context (this):

  • (AWS.Response) —

    the response object containing error, data properties, and the original request object.

  Parameters:

  • err (Error) —

    the error object returned from the request. Set to null if the request is successful.

  • data (Object) —

    the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

    • workload — (map)

      Information about the workload.

      • description — (String)

        The description of a workload.

      • displayName — (String)

        The display name of a workload.

      • documentationUrl — (String)

        The URL of a workload document.

      • iconUrl — (String)

        The URL of a workload icon.

      • status — (String)

        The status of a workload.

        Possible values include:
        • "ACTIVE"
        • "INACTIVE"
        • "DISABLED"
        • "DELETED"
      • statusMessage — (String)

        The message about a workload's status.

      • workloadName — (String)

        The name of the workload.

Returns:

• (AWS.Request) —

  a handle to the operation request for subsequent event callback registration.

var params = {
  deploymentPatternName: 'STRING_VALUE', /* required */
  workloadName: 'STRING_VALUE' /* required */
};
launchwizard.getWorkloadDeploymentPattern(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

• params (Object) (defaults to: {}) —
  • deploymentPatternName — (String)

    The name of the deployment pattern.

  • workloadName — (String)

    The name of the workload.

Callback (callback):

• function(err, data) { ... }

  Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

  Context (this):

  • (AWS.Response) —

    the response object containing error, data properties, and the original request object.

  Parameters:

  • err (Error) —

    the error object returned from the request. Set to null if the request is successful.

  • data (Object) —

    the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

    • workloadDeploymentPattern — (map)

      Details about the workload deployment pattern.

      • deploymentPatternName — (String)

        The name of the deployment pattern.

      • description — (String)

        The description of the deployment pattern.

      • displayName — (String)

        The display name of the deployment pattern.

      • specifications — (Array<map>)

        The settings specified for the deployment. These settings define how to deploy and configure your resources created by the deployment. For more information about the specifications required for creating a deployment for a SAP workload, see SAP deployment specifications. To retrieve the specifications required to create a deployment for other workloads, use the GetWorkloadDeploymentPattern operation.

        • allowedValues — (Array<String>)

          The allowed values of the deployment specification.

        • conditionals — (Array<map>)

          The conditionals used for the deployment specification.

          • comparator — (String)

            The comparator of the condition.

            Valid values: Equal | NotEqual

          • name — (String)

            The name of the deployment condition.

          • value — (String)

            The value of the condition.

        • description — (String)

          The description of the deployment specification.

        • name — (String)

          The name of the deployment specification.

        • required — (String)

          Indicates if the deployment specification is required.

      • status — (String)

        The status of the deployment pattern.

        Possible values include:
        • "ACTIVE"
        • "INACTIVE"
        • "DISABLED"
        • "DELETED"
      • statusMessage — (String)

        The status message of the deployment pattern.

      • workloadName — (String)

        The workload name of the deployment pattern.

      • workloadVersionName — (String)

        The workload version name of the deployment pattern.

Returns:

• (AWS.Request) —

  a handle to the operation request for subsequent event callback registration.

var params = {
  deploymentId: 'STRING_VALUE', /* required */
  maxResults: 'NUMBER_VALUE',
  nextToken: 'STRING_VALUE'
};
launchwizard.listDeploymentEvents(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

• params (Object) (defaults to: {}) —
  • deploymentId — (String)

    The ID of the deployment.

  • maxResults — (Integer)

    The maximum number of items to return for this request. To get the next page of items, make another request with the token returned in the output.

  • nextToken — (String)

    The token returned from a previous paginated request. Pagination continues from the end of the items returned by the previous request.

Callback (callback):

• function(err, data) { ... }

  Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

  Context (this):

  • (AWS.Response) —

    the response object containing error, data properties, and the original request object.

  Parameters:

  • err (Error) —

    the error object returned from the request. Set to null if the request is successful.

  • data (Object) —

    the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

    • deploymentEvents — (Array<map>)

      Lists the deployment events.

      • description — (String)

        The description of the deployment event.

      • name — (String)

        The name of the deployment event.

      • status — (String)

        The status of the deployment event.

        Possible values include:
        • "CANCELED"
        • "CANCELING"
        • "COMPLETED"
        • "CREATED"
        • "FAILED"
        • "IN_PROGRESS"
        • "PENDING"
        • "TIMED_OUT"
      • statusReason — (String)

        The reason of the deployment event status.

      • timestamp — (Date)

        The timestamp of the deployment event.

    • nextToken — (String)

      The token to include in another request to get the next page of items. This value is null when there are no more items to return.

Returns:

• (AWS.Request) —

  a handle to the operation request for subsequent event callback registration.

var params = {
  filters: [
    {
      name: WORKLOAD_NAME | DEPLOYMENT_STATUS,
      values: [
        'STRING_VALUE',
        /* more items */
      ]
    },
    /* more items */
  ],
  maxResults: 'NUMBER_VALUE',
  nextToken: 'STRING_VALUE'
};
launchwizard.listDeployments(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

• params (Object) (defaults to: {}) —
  • filters — (Array<map>)

    Filters to scope the results. The following filters are supported:

    • WORKLOAD_NAME - The name used in deployments.

    • DEPLOYMENT_STATUS - COMPLETED | CREATING | DELETE_IN_PROGRESS | DELETE_INITIATING | DELETE_FAILED | DELETED | FAILED | IN_PROGRESS | VALIDATING

    • name — (String)

      The name of the filter. Filter names are case-sensitive.

      Possible values include:
      • "WORKLOAD_NAME"
      • "DEPLOYMENT_STATUS"
    • values — (Array<String>)

      The filter values. Filter values are case-sensitive. If you specify multiple values for a filter, the values are joined with an OR, and the request returns all results that match any of the specified values.

  • maxResults — (Integer)

    The maximum number of items to return for this request. To get the next page of items, make another request with the token returned in the output.

  • nextToken — (String)

    The token returned from a previous paginated request. Pagination continues from the end of the items returned by the previous request.

Callback (callback):

• function(err, data) { ... }

  Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

  Context (this):

  • (AWS.Response) —

    the response object containing error, data properties, and the original request object.

  Parameters:

  • err (Error) —

    the error object returned from the request. Set to null if the request is successful.

  • data (Object) —

    the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

    • deployments — (Array<map>)

      Lists the deployments.

      • createdAt — (Date)

        The time the deployment was created.

      • id — (String)

        The ID of the deployment.

      • name — (String)

        The name of the deployment

      • patternName — (String)

        The name of the workload deployment pattern.

      • status — (String)

        The status of the deployment.

        Possible values include:
        • "COMPLETED"
        • "CREATING"
        • "DELETE_IN_PROGRESS"
        • "DELETE_INITIATING"
        • "DELETE_FAILED"
        • "DELETED"
        • "FAILED"
        • "IN_PROGRESS"
        • "VALIDATING"
      • workloadName — (String)

        The name of the workload.

    • nextToken — (String)

      The token to include in another request to get the next page of items. This value is null when there are no more items to return.

Returns:

• (AWS.Request) —

  a handle to the operation request for subsequent event callback registration.

var params = {
  resourceArn: 'STRING_VALUE' /* required */
};
launchwizard.listTagsForResource(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

• params (Object) (defaults to: {}) —
  • resourceArn — (String)

    The Amazon Resource Name (ARN) of the resource.

Callback (callback):

• function(err, data) { ... }

  Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

  Context (this):

  • (AWS.Response) —

    the response object containing error, data properties, and the original request object.

  Parameters:

  • err (Error) —

    the error object returned from the request. Set to null if the request is successful.

  • data (Object) —

    the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

    • tags — (map<String>)

      Information about the tags.

Returns:

• (AWS.Request) —

  a handle to the operation request for subsequent event callback registration.

var params = {
  workloadName: 'STRING_VALUE', /* required */
  maxResults: 'NUMBER_VALUE',
  nextToken: 'STRING_VALUE'
};
launchwizard.listWorkloadDeploymentPatterns(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

• params (Object) (defaults to: {}) —
  • maxResults — (Integer)

    The maximum number of items to return for this request. To get the next page of items, make another request with the token returned in the output.

  • nextToken — (String)

    The token returned from a previous paginated request. Pagination continues from the end of the items returned by the previous request.

  • workloadName — (String)

    The name of the workload.

Callback (callback):

• function(err, data) { ... }

  Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

  Context (this):

  • (AWS.Response) —

    the response object containing error, data properties, and the original request object.

  Parameters:

  • err (Error) —

    the error object returned from the request. Set to null if the request is successful.

  • data (Object) —

    the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

    • nextToken — (String)

      The token to include in another request to get the next page of items. This value is null when there are no more items to return.

    • workloadDeploymentPatterns — (Array<map>)

      Describes the workload deployment patterns.

      • deploymentPatternName — (String)

        The name of a workload deployment pattern.

      • description — (String)

        The description of a workload deployment pattern.

      • displayName — (String)

        The display name of a workload deployment pattern.

      • status — (String)

        The status of a workload deployment pattern.

        Possible values include:
        • "ACTIVE"
        • "INACTIVE"
        • "DISABLED"
        • "DELETED"
      • statusMessage — (String)

        A message about a workload deployment pattern's status.

      • workloadName — (String)

        The name of the workload.

      • workloadVersionName — (String)

        The name of the workload deployment pattern version.

Returns:

• (AWS.Request) —

  a handle to the operation request for subsequent event callback registration.

var params = {
  maxResults: 'NUMBER_VALUE',
  nextToken: 'STRING_VALUE'
};
launchwizard.listWorkloads(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

• params (Object) (defaults to: {}) —
  • maxResults — (Integer)

    The maximum number of items to return for this request. To get the next page of items, make another request with the token returned in the output.

  • nextToken — (String)

    The token returned from a previous paginated request. Pagination continues from the end of the items returned by the previous request.

Callback (callback):

• function(err, data) { ... }

  Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

  Context (this):

  • (AWS.Response) —

    the response object containing error, data properties, and the original request object.

  Parameters:

  • err (Error) —

    the error object returned from the request. Set to null if the request is successful.

  • data (Object) —

    the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

    • nextToken — (String)

      The token to include in another request to get the next page of items. This value is null when there are no more items to return.

    • workloads — (Array<map>)

      Information about the workloads.

      • displayName — (String)

        The display name of the workload data.

      • workloadName — (String)

        The name of the workload.

Returns:

• (AWS.Request) —

  a handle to the operation request for subsequent event callback registration.

var params = {
  resourceArn: 'STRING_VALUE', /* required */
  tags: { /* required */
    '<TagKey>': 'STRING_VALUE',
    /* '<TagKey>': ... */
  }
};
launchwizard.tagResource(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

• params (Object) (defaults to: {}) —
  • resourceArn — (String)

    The Amazon Resource Name (ARN) of the resource.

  • tags — (map<String>)

    One or more tags to attach to the resource.

Callback (callback):

• function(err, data) { ... }

  Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

  Context (this):

  • (AWS.Response) —

    the response object containing error, data properties, and the original request object.

  Parameters:

  • err (Error) —

    the error object returned from the request. Set to null if the request is successful.

  • data (Object) —

    the de-serialized data returned from the request. Set to null if a request error occurs.

Returns:

• (AWS.Request) —

  a handle to the operation request for subsequent event callback registration.

var params = {
  resourceArn: 'STRING_VALUE', /* required */
  tagKeys: [ /* required */
    'STRING_VALUE',
    /* more items */
  ]
};
launchwizard.untagResource(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

• params (Object) (defaults to: {}) —
  • resourceArn — (String)

    The Amazon Resource Name (ARN) of the resource.

  • tagKeys — (Array<String>)

    Keys identifying the tags to remove.

Callback (callback):

• function(err, data) { ... }

  Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

  Context (this):

  • (AWS.Response) —

    the response object containing error, data properties, and the original request object.

  Parameters:

  • err (Error) —

    the error object returned from the request. Set to null if the request is successful.

  • data (Object) —

    the de-serialized data returned from the request. Set to null if a request error occurs.

Returns:

• (AWS.Request) —

  a handle to the operation request for subsequent event callback registration.