The AWS SDK for JavaScript v2 has reached end-of-support.
We recommend that you migrate to AWS SDK for JavaScript v3. For additional details and information on how to migrate, please refer to the announcement.

Class: AWS.Mgn

Inherits:
AWS.Service show all
Identifier:
mgn
API Version:
2020-02-26
Defined in:
(unknown)

Overview

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

Service Description

The Application Migration Service service.

Sending a Request Using Mgn

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

var mgn = new AWS.Mgn({apiVersion: '2020-02-26'});

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

AWS.config.apiVersions = {
  mgn: '2020-02-26',
  // other service API versions
};

var mgn = new AWS.Mgn();

Version:

  • 2020-02-26

Constructor Summary collapse

Property Summary collapse

Properties inherited from AWS.Service

apiVersions

Method Summary collapse

Methods inherited from AWS.Service

makeRequest, makeUnauthenticatedRequest, waitFor, setupRequestListeners, defineService

Constructor Details

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

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

Examples:

Constructing a Mgn object

var mgn = new AWS.Mgn({apiVersion: '2020-02-26'});

Options Hash (options):

  • params (map) —

    An optional map of parameters to bind to every request sent by this service object. For more information on bound parameters, see "Working with Services" in the Getting Started Guide.

  • endpoint (String|AWS.Endpoint) —

    The endpoint URI to send requests to. The default endpoint is built from the configured region. The endpoint should be a string like 'https://{service}.{region}.amazonaws.com' or an Endpoint object.

  • accessKeyId (String) —

    your AWS access key ID.

  • secretAccessKey (String) —

    your AWS secret access key.

  • sessionToken (AWS.Credentials) —

    the optional AWS session token to sign requests with.

  • credentials (AWS.Credentials) —

    the AWS credentials to sign requests with. You can either specify this object, or specify the accessKeyId and secretAccessKey options directly.

  • credentialProvider (AWS.CredentialProviderChain) —

    the provider chain used to resolve credentials if no static credentials property is set.

  • region (String) —

    the region to send service requests to. See AWS.Mgn.region for more information.

  • maxRetries (Integer) —

    the maximum amount of retries to attempt with a request. See AWS.Mgn.maxRetries for more information.

  • maxRedirects (Integer) —

    the maximum amount of redirects to follow with a request. See AWS.Mgn.maxRedirects for more information.