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

The AWS Migration Hub home region APIs are available specifically for working with your Migration Hub home region. You can use these APIs to determine a home region, as well as to create and work with controls that describe the home region.

• You must make API calls for write actions (create, notify, associate, disassociate, import, or put) while in your home region, or a HomeRegionNotSetException error is returned.
• API calls for read actions (list, describe, stop, and delete) are permitted outside of your home region.
• If you call a write API outside the home region, an InvalidInputException is returned.
• You can call GetHomeRegion action to obtain the account's Migration Hub home region.

For specific API usage, see the sections that follow in this AWS Migration Hub Home Region API reference.

Sending a Request Using MigrationHubConfig

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

var migrationhubconfig = new AWS.MigrationHubConfig({apiVersion: '2019-06-30'});

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

AWS.config.apiVersions = {
  migrationhubconfig: '2019-06-30',
  // other service API versions
};

var migrationhubconfig = new AWS.MigrationHubConfig();

Constructor Summarycollapse

• new AWS.MigrationHubConfig(options = {}) ⇒ Object constructor
  Constructs a service object.

Property Summarycollapse

• endpoint ⇒ AWS.Endpoint readwrite
  An Endpoint object representing the endpoint URL for service requests.

Properties inherited from AWS.Service

apiVersions

Method Summarycollapse

• createHomeRegionControl(params = {}, callback) ⇒ AWS.Request
  This API sets up the home region for the calling account only.
  .
• deleteHomeRegionControl(params = {}, callback) ⇒ AWS.Request
  This operation deletes the home region configuration for the calling account.
• describeHomeRegionControls(params = {}, callback) ⇒ AWS.Request
  This API permits filtering on the ControlId and HomeRegion fields.
  .
• getHomeRegion(params = {}, callback) ⇒ AWS.Request
  Returns the calling account’s home region, if configured.

Methods inherited from AWS.Service

makeRequest, makeUnauthenticatedRequest, waitFor, setupRequestListeners, defineService

Constructor Details

new AWS.MigrationHubConfig(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

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

This API sets up the home region for the calling account only.

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

This operation deletes the home region configuration for the calling account. The operation does not delete discovery or migration tracking data in the home region.

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

This API permits filtering on the ControlId and HomeRegion fields.

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

Returns the calling account’s home region, if configured. This API is used by other AWS services to determine the regional endpoint for calling AWS Application Discovery Service and Migration Hub. You must call GetHomeRegion at least once before you call any other AWS Application Discovery Service and AWS Migration Hub APIs, to obtain the account's Migration Hub home region.