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

Quick Setup helps you quickly configure frequently used services and features with recommended best practices. Quick Setup simplifies setting up services, including Systems Manager, by automating common or recommended tasks.

Sending a Request Using SSMQuickSetup

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

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

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

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

var ssmquicksetup = new AWS.SSMQuickSetup();

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

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

Creates a Quick Setup configuration manager resource. This object is a collection of desired state configurations for multiple configuration definitions and summaries describing the deployments of those definitions.

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

Deletes a configuration manager.

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

Returns a configuration manager.

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

Returns settings configured for Quick Setup in the requesting Amazon Web Services account and Amazon Web Services Region.

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

Returns Quick Setup configuration managers.

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

Returns the available Quick Setup types.

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

Returns tags assigned to the resource.

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

Assigns key-value pairs of metadata to Amazon Web Services resources.

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

Removes tags from the specified resource.

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

Updates a Quick Setup configuration definition.

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

Updates a Quick Setup configuration manager.

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

Updates settings configured for Quick Setup.