You are viewing the documentation for an older major version of the AWS SDK for JavaScript.
The modular AWS SDK for JavaScript (v3), the latest major version of AWS SDK for JavaScript, is now stable and recommended for general use. For more information, see the Migration Guide and API Reference.

Class: AWS.MigrationHubRefactorSpaces

Inherits:
AWS.Service show all
Identifier:
migrationhubrefactorspaces
API Version:
2021-10-26
Defined in:
(unknown)

Overview

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

Service Description

 <p>This API reference provides descriptions, syntax, and other details about each of the actions and data types for Amazon Web Services Migration Hub Refactor Spaces (Refactor Spaces). The topic for each action shows the API request parameters and the response. Alternatively, you can use one of the Amazon Web Services SDKs to access an API that is tailored to the programming language or platform that you're using. For more information, see <a href="https://aws.amazon.com/tools/#SDKs&quot;&gt;Amazon Web Services SDKs</a>.</p> <p>To share Refactor Spaces environments with other Amazon Web Services accounts or with Organizations and their OUs, use Resource Access Manager's <code>CreateResourceShare</code> API. See <a href="https://docs.aws.amazon.com/ram/latest/APIReference/API&#95;CreateResourceShare.html&quot;&gt;CreateResourceShare&lt;/a&gt; in the <i>Amazon Web Services RAM API Reference</i>.</p> 

Sending a Request Using MigrationHubRefactorSpaces

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

var migrationhubrefactorspaces = new AWS.MigrationHubRefactorSpaces({apiVersion: '2021-10-26'});

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

AWS.config.apiVersions = {
  migrationhubrefactorspaces: '2021-10-26',
  // other service API versions
};

var migrationhubrefactorspaces = new AWS.MigrationHubRefactorSpaces();

Version:

  • 2021-10-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.MigrationHubRefactorSpaces(options = {}) ⇒ Object

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

Examples:

Constructing a MigrationHubRefactorSpaces object

var migrationhubrefactorspaces = new AWS.MigrationHubRefactorSpaces({apiVersion: '2021-10-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.MigrationHubRefactorSpaces.region for more information.

  • maxRetries (Integer)

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

  • maxRedirects (Integer)

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

  • sslEnabled (Boolean)

    whether to enable SSL for requests.

  • paramValidation (Boolean|map)

    whether input parameters should be validated against the operation description before sending the request. Defaults to true. Pass a map to enable any of the following specific validation features:

    • min [Boolean] — Validates that a value meets the min constraint. This is enabled by default when paramValidation is set to true.
    • max [Boolean] — Validates that a value meets the max constraint.
    • pattern [Boolean] — Validates that a string value matches a regular expression.
    • enum [Boolean] — Validates that a string value matches one of the allowable enum values.
  • computeChecksums (Boolean)

    whether to compute checksums for payload bodies when the service accepts it (currently supported in S3 only)

  • convertResponseTypes (Boolean)

    whether types are converted when parsing response data. Currently only supported for JSON based services. Turning this off may improve performance on large response payloads. Defaults to true.

  • correctClockSkew (Boolean)

    whether to apply a clock skew correction and retry requests that fail because of an skewed client clock. Defaults to false.

  • s3ForcePathStyle (Boolean)

    whether to force path style URLs for S3 objects.

  • s3BucketEndpoint (Boolean)

    whether the provided endpoint addresses an individual bucket (false if it addresses the root API endpoint). Note that setting this configuration option requires an endpoint to be provided explicitly to the service constructor.

  • s3DisableBodySigning (Boolean)

    whether S3 body signing should be disabled when using signature version v4. Body signing can only be disabled when using https. Defaults to true.

  • s3UsEast1RegionalEndpoint ('legacy'|'regional')

    when region is set to 'us-east-1', whether to send s3 request to global endpoints or 'us-east-1' regional endpoints. This config is only applicable to S3 client. Defaults to legacy

  • s3UseArnRegion (Boolean)

    whether to override the request region with the region inferred from requested resource's ARN. Only available for S3 buckets Defaults to true

  • retryDelayOptions (map)

    A set of options to configure the retry delay on retryable errors. Currently supported options are:

    • base [Integer] — The base number of milliseconds to use in the exponential backoff for operation retries. Defaults to 100 ms for all services except DynamoDB, where it defaults to 50ms.
    • customBackoff [function] — A custom function that accepts a retry count and error and returns the amount of time to delay in milliseconds. If the result is a non-zero negative value, no further retry attempts will be made. The base option will be ignored if this option is supplied. The function is only called for retryable errors.
  • httpOptions (map)

    A set of options to pass to the low-level HTTP request. Currently supported options are:

    • proxy [String] — the URL to proxy requests through
    • agent [http.Agent, https.Agent] — the Agent object to perform HTTP requests with. Used for connection pooling. Defaults to the global agent (http.globalAgent) for non-SSL connections. Note that for SSL connections, a special Agent object is used in order to enable peer certificate verification. This feature is only available in the Node.js environment.
    • connectTimeout [Integer] — Sets the socket to timeout after failing to establish a connection with the server after connectTimeout milliseconds. This timeout has no effect once a socket connection has been established.
    • timeout [Integer] — Sets the socket to timeout after timeout milliseconds of inactivity on the socket. Defaults to two minutes (120000).
    • xhrAsync [Boolean] — Whether the SDK will send asynchronous HTTP requests. Used in the browser environment only. Set to false to send requests synchronously. Defaults to true (async on).
    • xhrWithCredentials [Boolean] — Sets the "withCredentials" property of an XMLHttpRequest object. Used in the browser environment only. Defaults to false.
  • apiVersion (String, Date)

    a String in YYYY-MM-DD format (or a date) that represents the latest possible API version that can be used in all services (unless overridden by apiVersions). Specify 'latest' to use the latest possible version.

  • apiVersions (map<String, String|Date>)

    a map of service identifiers (the lowercase service class name) with the API version to use when instantiating a service. Specify 'latest' for each individual that can use the latest available version.

  • logger (#write, #log)

    an object that responds to .write() (like a stream) or .log() (like the console object) in order to log information about requests

  • systemClockOffset (Number)

    an offset value in milliseconds to apply to all signing times. Use this to compensate for clock skew when your system may be out of sync with the service time. Note that this configuration option can only be applied to the global AWS.config object and cannot be overridden in service-specific configuration. Defaults to 0 milliseconds.

  • signatureVersion (String)

    the signature version to sign requests with (overriding the API configuration). Possible values are: 'v2', 'v3', 'v4'.

  • signatureCache (Boolean)

    whether the signature to sign requests with (overriding the API configuration) is cached. Only applies to the signature version 'v4'. Defaults to true.

  • dynamoDbCrc32 (Boolean)

    whether to validate the CRC32 checksum of HTTP response bodies returned by DynamoDB. Default: true.

  • useAccelerateEndpoint (Boolean)

    Whether to use the S3 Transfer Acceleration endpoint with the S3 service. Default: false.

  • clientSideMonitoring (Boolean)

    whether to collect and publish this client's performance metrics of all its API requests.

  • endpointDiscoveryEnabled (Boolean|undefined)

    whether to call operations with endpoints given by service dynamically. Setting this

  • endpointCacheSize (Number)

    the size of the global cache storing endpoints from endpoint discovery operations. Once endpoint cache is created, updating this setting cannot change existing cache size. Defaults to 1000

  • hostPrefixEnabled (Boolean)

    whether to marshal request parameters to the prefix of hostname. Defaults to true.

  • stsRegionalEndpoints ('legacy'|'regional')

    whether to send sts request to global endpoints or regional endpoints. Defaults to 'legacy'.

  • useFipsEndpoint (Boolean)

    Enables FIPS compatible endpoints. Defaults to false.

  • useDualstackEndpoint (Boolean)

    Enables IPv6 dualstack endpoint. Defaults to false.

Property Details

endpointAWS.Endpoint (readwrite)

Returns an Endpoint object representing the endpoint URL for service requests.

Returns:

  • (AWS.Endpoint)

    an Endpoint object representing the endpoint URL for service requests.

Method Details

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

Creates an Amazon Web Services Migration Hub Refactor Spaces application. The account that owns the environment also owns the applications created inside the environment, regardless of the account that creates the application. Refactor Spaces provisions an Amazon API Gateway, API Gateway VPC link, and Network Load Balancer for the application proxy inside your account.

Service Reference:

Examples:

Calling the createApplication operation

var params = {
  EnvironmentIdentifier: 'STRING_VALUE', /* required */
  Name: 'STRING_VALUE', /* required */
  ProxyType: API_GATEWAY, /* required */
  VpcId: 'STRING_VALUE', /* required */
  ApiGatewayProxy: {
    EndpointType: REGIONAL | PRIVATE,
    StageName: 'STRING_VALUE'
  },
  ClientToken: 'STRING_VALUE',
  Tags: {
    '<TagMapKeyString>': 'STRING_VALUE',
    /* '<TagMapKeyString>': ... */
  }
};
migrationhubrefactorspaces.createApplication(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: {})
    • ApiGatewayProxy — (map)

      A wrapper object holding the API Gateway endpoint type and stage name for the proxy.

      • EndpointType — (String)

        The type of endpoint to use for the API Gateway proxy. If no value is specified in the request, the value is set to REGIONAL by default.

        If the value is set to PRIVATE in the request, this creates a private API endpoint that is isolated from the public internet. The private endpoint can only be accessed by using Amazon Virtual Private Cloud (Amazon VPC) endpoints for Amazon API Gateway that have been granted access.

        Possible values include:
        • "REGIONAL"
        • "PRIVATE"
      • StageName — (String)

        The name of the API Gateway stage. The name defaults to prod.

    • ClientToken — (String)

      A unique, case-sensitive identifier that you provide to ensure the idempotency of the request.

      If a token is not provided, the SDK will use a version 4 UUID.
    • EnvironmentIdentifier — (String)

      The unique identifier of the environment.

    • Name — (String)

      The name to use for the application.

    • ProxyType — (String)

      The proxy type of the proxy created within the application.

      Possible values include:
      • "API_GATEWAY"
    • Tags — (map<String>)

      The tags to assign to the application. A tag is a label that you assign to an Amazon Web Services resource. Each tag consists of a key-value pair.

    • VpcId — (String)

      The ID of the virtual private cloud (VPC).

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:

      • ApiGatewayProxy — (map)

        A wrapper object holding the API Gateway endpoint type and stage name for the proxy.

        • EndpointType — (String)

          The type of endpoint to use for the API Gateway proxy. If no value is specified in the request, the value is set to REGIONAL by default.

          If the value is set to PRIVATE in the request, this creates a private API endpoint that is isolated from the public internet. The private endpoint can only be accessed by using Amazon Virtual Private Cloud (Amazon VPC) endpoints for Amazon API Gateway that have been granted access.

          Possible values include:
          • "REGIONAL"
          • "PRIVATE"
        • StageName — (String)

          The name of the API Gateway stage. The name defaults to prod.

      • ApplicationId — (String)

        The unique identifier of the application.

      • Arn — (String)

        The Amazon Resource Name (ARN) of the application. The format for this ARN is arn:aws:refactor-spaces:region:account-id:resource-type/resource-id . For more information about ARNs, see Amazon Resource Names (ARNs) in the Amazon Web Services General Reference.

      • CreatedByAccountId — (String)

        The Amazon Web Services account ID of application creator.

      • CreatedTime — (Date)

        A timestamp that indicates when the application is created.

      • EnvironmentId — (String)

        The ID of the environment in which the application is created.

      • LastUpdatedTime — (Date)

        A timestamp that indicates when the application was last updated.

      • Name — (String)

        The name of the application.

      • OwnerAccountId — (String)

        The Amazon Web Services account ID of the application owner (which is always the same as the environment owner account ID).

      • ProxyType — (String)

        The proxy type of the proxy created within the application.

        Possible values include:
        • "API_GATEWAY"
      • State — (String)

        The current state of the application.

        Possible values include:
        • "CREATING"
        • "ACTIVE"
        • "DELETING"
        • "FAILED"
        • "UPDATING"
      • Tags — (map<String>)

        The tags assigned to the application. A tag is a label that you assign to an Amazon Web Services resource. Each tag consists of a key-value pair.

      • VpcId — (String)

        The ID of the Amazon VPC.

Returns:

  • (AWS.Request)

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

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

Creates an Amazon Web Services Migration Hub Refactor Spaces environment. The caller owns the environment resource, and all Refactor Spaces applications, services, and routes created within the environment. They are referred to as the environment owner. The environment owner has cross-account visibility and control of Refactor Spaces resources that are added to the environment by other accounts that the environment is shared with. When creating an environment, Refactor Spaces provisions a transit gateway in your account.

Service Reference:

Examples:

Calling the createEnvironment operation

var params = {
  Name: 'STRING_VALUE', /* required */
  NetworkFabricType: TRANSIT_GATEWAY, /* required */
  ClientToken: 'STRING_VALUE',
  Description: 'STRING_VALUE',
  Tags: {
    '<TagMapKeyString>': 'STRING_VALUE',
    /* '<TagMapKeyString>': ... */
  }
};
migrationhubrefactorspaces.createEnvironment(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: {})
    • ClientToken — (String)

      A unique, case-sensitive identifier that you provide to ensure the idempotency of the request.

      If a token is not provided, the SDK will use a version 4 UUID.
    • Description — (String)

      The description of the environment.

    • Name — (String)

      The name of the environment.

    • NetworkFabricType — (String)

      The network fabric type of the environment.

      Possible values include:
      • "TRANSIT_GATEWAY"
    • Tags — (map<String>)

      The tags to assign to the environment. A tag is a label that you assign to an Amazon Web Services resource. Each tag consists of a key-value pair.

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:

      • Arn — (String)

        The Amazon Resource Name (ARN) of the environment.

      • CreatedTime — (Date)

        A timestamp that indicates when the environment is created.

      • Description — (String)

        A description of the environment.

      • EnvironmentId — (String)

        The unique identifier of the environment.

      • LastUpdatedTime — (Date)

        A timestamp that indicates when the environment was last updated.

      • Name — (String)

        The name of the environment.

      • NetworkFabricType — (String)

        The network fabric type of the environment.

        Possible values include:
        • "TRANSIT_GATEWAY"
      • OwnerAccountId — (String)

        The Amazon Web Services account ID of environment owner.

      • State — (String)

        The current state of the environment.

        Possible values include:
        • "CREATING"
        • "ACTIVE"
        • "DELETING"
        • "FAILED"
      • Tags — (map<String>)

        The tags assigned to the created environment. A tag is a label that you assign to an Amazon Web Services resource. Each tag consists of a key-value pair..

Returns:

  • (AWS.Request)

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

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

Creates an Amazon Web Services Migration Hub Refactor Spaces route. The account owner of the service resource is always the environment owner, regardless of which account creates the route. Routes target a service in the application. If an application does not have any routes, then the first route must be created as a DEFAULT RouteType.

When created, the default route defaults to an active state so state is not a required input. However, like all other state values the state of the default route can be updated after creation, but only when all other routes are also inactive. Conversely, no route can be active without the default route also being active.

When you create a route, Refactor Spaces configures the Amazon API Gateway to send traffic to the target service as follows:

  • If the service has a URL endpoint, and the endpoint resolves to a private IP address, Refactor Spaces routes traffic using the API Gateway VPC link.

  • If the service has a URL endpoint, and the endpoint resolves to a public IP address, Refactor Spaces routes traffic over the public internet.

  • If the service has an Lambda function endpoint, then Refactor Spaces configures the Lambda function's resource policy to allow the application's API Gateway to invoke the function.

A one-time health check is performed on the service when either the route is updated from inactive to active, or when it is created with an active state. If the health check fails, the route transitions the route state to FAILED, an error code of SERVICE_ENDPOINT_HEALTH_CHECK_FAILURE is provided, and no traffic is sent to the service.

For Lambda functions, the Lambda function state is checked. If the function is not active, the function configuration is updated so that Lambda resources are provisioned. If the Lambda state is Failed, then the route creation fails. For more information, see the GetFunctionConfiguration's State response parameter in the Lambda Developer Guide.

For Lambda endpoints, a check is performed to determine that a Lambda function with the specified ARN exists. If it does not exist, the health check fails. For public URLs, a connection is opened to the public endpoint. If the URL is not reachable, the health check fails.

For private URLS, a target group is created on the Elastic Load Balancing and the target group health check is run. The HealthCheckProtocol, HealthCheckPort, and HealthCheckPath are the same protocol, port, and path specified in the URL or health URL, if used. All other settings use the default values, as described in Health checks for your target groups. The health check is considered successful if at least one target within the target group transitions to a healthy state.

Services can have HTTP or HTTPS URL endpoints. For HTTPS URLs, publicly-signed certificates are supported. Private Certificate Authorities (CAs) are permitted only if the CA's domain is also publicly resolvable.

Service Reference:

Examples:

Calling the createRoute operation

var params = {
  ApplicationIdentifier: 'STRING_VALUE', /* required */
  EnvironmentIdentifier: 'STRING_VALUE', /* required */
  RouteType: DEFAULT | URI_PATH, /* required */
  ServiceIdentifier: 'STRING_VALUE', /* required */
  ClientToken: 'STRING_VALUE',
  DefaultRoute: {
    ActivationState: ACTIVE | INACTIVE
  },
  Tags: {
    '<TagMapKeyString>': 'STRING_VALUE',
    /* '<TagMapKeyString>': ... */
  },
  UriPathRoute: {
    ActivationState: ACTIVE | INACTIVE, /* required */
    SourcePath: 'STRING_VALUE', /* required */
    IncludeChildPaths: true || false,
    Methods: [
      DELETE | GET | HEAD | OPTIONS | PATCH | POST | PUT,
      /* more items */
    ]
  }
};
migrationhubrefactorspaces.createRoute(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: {})
    • ApplicationIdentifier — (String)

      The ID of the application within which the route is being created.

    • ClientToken — (String)

      A unique, case-sensitive identifier that you provide to ensure the idempotency of the request.

      If a token is not provided, the SDK will use a version 4 UUID.
    • DefaultRoute — (map)

      Configuration for the default route type.

      • ActivationState — (String)

        If set to ACTIVE, traffic is forwarded to this route’s service after the route is created.

        Possible values include:
        • "ACTIVE"
        • "INACTIVE"
    • EnvironmentIdentifier — (String)

      The ID of the environment in which the route is created.

    • RouteType — (String)

      The route type of the route. DEFAULT indicates that all traffic that does not match another route is forwarded to the default route. Applications must have a default route before any other routes can be created. URI_PATH indicates a route that is based on a URI path.

      Possible values include:
      • "DEFAULT"
      • "URI_PATH"
    • ServiceIdentifier — (String)

      The ID of the service in which the route is created. Traffic that matches this route is forwarded to this service.

    • Tags — (map<String>)

      The tags to assign to the route. A tag is a label that you assign to an Amazon Web Services resource. Each tag consists of a key-value pair..

    • UriPathRoute — (map)

      The configuration for the URI path route type.

      • ActivationStaterequired — (String)

        If set to ACTIVE, traffic is forwarded to this route’s service after the route is created.

        Possible values include:
        • "ACTIVE"
        • "INACTIVE"
      • IncludeChildPaths — (Boolean)

        Indicates whether to match all subpaths of the given source path. If this value is false, requests must match the source path exactly before they are forwarded to this route's service.

      • Methods — (Array<String>)

        A list of HTTP methods to match. An empty list matches all values. If a method is present, only HTTP requests using that method are forwarded to this route’s service.

      • SourcePathrequired — (String)

        The path to use to match traffic. Paths must start with / and are relative to the base of the application.

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:

      • ApplicationId — (String)

        The ID of the application in which the route is created.

      • Arn — (String)

        The Amazon Resource Name (ARN) of the route. The format for this ARN is arn:aws:refactor-spaces:region:account-id:resource-type/resource-id . For more information about ARNs, see Amazon Resource Names (ARNs) in the Amazon Web Services General Reference.

      • CreatedByAccountId — (String)

        The Amazon Web Services account ID of the route creator.

      • CreatedTime — (Date)

        A timestamp that indicates when the route is created.

      • LastUpdatedTime — (Date)

        A timestamp that indicates when the route was last updated.

      • OwnerAccountId — (String)

        The Amazon Web Services account ID of the route owner.

      • RouteId — (String)

        The unique identifier of the route.

      • RouteType — (String)

        The route type of the route.

        Possible values include:
        • "DEFAULT"
        • "URI_PATH"
      • ServiceId — (String)

        The ID of service in which the route is created. Traffic that matches this route is forwarded to this service.

      • State — (String)

        The current state of the route. Activation state only allows ACTIVE or INACTIVE as user inputs. FAILED is a route state that is system generated.

        Possible values include:
        • "CREATING"
        • "ACTIVE"
        • "DELETING"
        • "FAILED"
        • "UPDATING"
        • "INACTIVE"
      • Tags — (map<String>)

        The tags assigned to the created route. A tag is a label that you assign to an Amazon Web Services resource. Each tag consists of a key-value pair.

      • UriPathRoute — (map)

        Configuration for the URI path route type.

        • ActivationStaterequired — (String)

          If set to ACTIVE, traffic is forwarded to this route’s service after the route is created.

          Possible values include:
          • "ACTIVE"
          • "INACTIVE"
        • IncludeChildPaths — (Boolean)

          Indicates whether to match all subpaths of the given source path. If this value is false, requests must match the source path exactly before they are forwarded to this route's service.

        • Methods — (Array<String>)

          A list of HTTP methods to match. An empty list matches all values. If a method is present, only HTTP requests using that method are forwarded to this route’s service.

        • SourcePathrequired — (String)

          The path to use to match traffic. Paths must start with / and are relative to the base of the application.

Returns:

  • (AWS.Request)

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

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

Creates an Amazon Web Services Migration Hub Refactor Spaces service. The account owner of the service is always the environment owner, regardless of which account in the environment creates the service. Services have either a URL endpoint in a virtual private cloud (VPC), or a Lambda function endpoint.

If an Amazon Web Services resource is launched in a service VPC, and you want it to be accessible to all of an environment’s services with VPCs and routes, apply the RefactorSpacesSecurityGroup to the resource. Alternatively, to add more cross-account constraints, apply your own security group.

Service Reference:

Examples:

Calling the createService operation

var params = {
  ApplicationIdentifier: 'STRING_VALUE', /* required */
  EndpointType: LAMBDA | URL, /* required */
  EnvironmentIdentifier: 'STRING_VALUE', /* required */
  Name: 'STRING_VALUE', /* required */
  ClientToken: 'STRING_VALUE',
  Description: 'STRING_VALUE',
  LambdaEndpoint: {
    Arn: 'STRING_VALUE' /* required */
  },
  Tags: {
    '<TagMapKeyString>': 'STRING_VALUE',
    /* '<TagMapKeyString>': ... */
  },
  UrlEndpoint: {
    Url: 'STRING_VALUE', /* required */
    HealthUrl: 'STRING_VALUE'
  },
  VpcId: 'STRING_VALUE'
};
migrationhubrefactorspaces.createService(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: {})
    • ApplicationIdentifier — (String)

      The ID of the application which the service is created.

    • ClientToken — (String)

      A unique, case-sensitive identifier that you provide to ensure the idempotency of the request.

      If a token is not provided, the SDK will use a version 4 UUID.
    • Description — (String)

      The description of the service.

    • EndpointType — (String)

      The type of endpoint to use for the service. The type can be a URL in a VPC or an Lambda function.

      Possible values include:
      • "LAMBDA"
      • "URL"
    • EnvironmentIdentifier — (String)

      The ID of the environment in which the service is created.

    • LambdaEndpoint — (map)

      The configuration for the Lambda endpoint type.

      • Arnrequired — (String)

        The Amazon Resource Name (ARN) of the Lambda endpoint.

    • Name — (String)

      The name of the service.

    • Tags — (map<String>)

      The tags to assign to the service. A tag is a label that you assign to an Amazon Web Services resource. Each tag consists of a key-value pair..

    • UrlEndpoint — (map)

      The configuration for the URL endpoint type.

      • HealthUrl — (String)

        The health check URL of the URL endpoint type. If the URL is a public endpoint, the HealthUrl must also be a public endpoint. If the URL is a private endpoint inside a virtual private cloud (VPC), the health URL must also be a private endpoint, and the host must be the same as the URL.

      • Urlrequired — (String)

        The URL to route traffic to. The URL must be an rfc3986-formatted URL. If the host is a domain name, the name must be resolvable over the public internet. If the scheme is https, the top level domain of the host must be listed in the IANA root zone database.

    • VpcId — (String)

      The ID of the VPC.

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:

      • ApplicationId — (String)

        The ID of the application that the created service belongs to.

      • Arn — (String)

        The Amazon Resource Name (ARN) of the service.

      • CreatedByAccountId — (String)

        The Amazon Web Services account ID of the service creator.

      • CreatedTime — (Date)

        A timestamp that indicates when the service is created.

      • Description — (String)

        The description of the created service.

      • EndpointType — (String)

        The endpoint type of the service.

        Possible values include:
        • "LAMBDA"
        • "URL"
      • EnvironmentId — (String)

        The unique identifier of the environment.

      • LambdaEndpoint — (map)

        The configuration for the Lambda endpoint type.

        • Arnrequired — (String)

          The Amazon Resource Name (ARN) of the Lambda endpoint.

      • LastUpdatedTime — (Date)

        A timestamp that indicates when the service was last updated.

      • Name — (String)

        The name of the service.

      • OwnerAccountId — (String)

        The Amazon Web Services account ID of the service owner.

      • ServiceId — (String)

        The unique identifier of the service.

      • State — (String)

        The current state of the service.

        Possible values include:
        • "CREATING"
        • "ACTIVE"
        • "DELETING"
        • "FAILED"
      • Tags — (map<String>)

        The tags assigned to the created service. A tag is a label that you assign to an Amazon Web Services resource. Each tag consists of a key-value pair..

      • UrlEndpoint — (map)

        The configuration for the URL endpoint type.

        • HealthUrl — (String)

          The health check URL of the URL endpoint type. If the URL is a public endpoint, the HealthUrl must also be a public endpoint. If the URL is a private endpoint inside a virtual private cloud (VPC), the health URL must also be a private endpoint, and the host must be the same as the URL.

        • Urlrequired — (String)

          The URL to route traffic to. The URL must be an rfc3986-formatted URL. If the host is a domain name, the name must be resolvable over the public internet. If the scheme is https, the top level domain of the host must be listed in the IANA root zone database.

      • VpcId — (String)

        The ID of the VPC.

Returns:

  • (AWS.Request)

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

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

Deletes an Amazon Web Services Migration Hub Refactor Spaces application. Before you can delete an application, you must first delete any services or routes within the application.

Service Reference:

Examples:

Calling the deleteApplication operation

var params = {
  ApplicationIdentifier: 'STRING_VALUE', /* required */
  EnvironmentIdentifier: 'STRING_VALUE' /* required */
};
migrationhubrefactorspaces.deleteApplication(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: {})
    • ApplicationIdentifier — (String)

      The ID of the application.

    • EnvironmentIdentifier — (String)

      The ID of the environment.

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:

      • ApplicationId — (String)

        The ID of the application.

      • Arn — (String)

        The Amazon Resource Name (ARN) of the application.

      • EnvironmentId — (String)

        The unique identifier of the application’s environment.

      • LastUpdatedTime — (Date)

        A timestamp that indicates when the environment was last updated.

      • Name — (String)

        The name of the application.

      • State — (String)

        The current state of the application.

        Possible values include:
        • "CREATING"
        • "ACTIVE"
        • "DELETING"
        • "FAILED"
        • "UPDATING"

Returns:

  • (AWS.Request)

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

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

Deletes an Amazon Web Services Migration Hub Refactor Spaces environment. Before you can delete an environment, you must first delete any applications and services within the environment.

Service Reference:

Examples:

Calling the deleteEnvironment operation

var params = {
  EnvironmentIdentifier: 'STRING_VALUE' /* required */
};
migrationhubrefactorspaces.deleteEnvironment(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: {})
    • EnvironmentIdentifier — (String)

      The ID of the environment.

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:

      • Arn — (String)

        The Amazon Resource Name (ARN) of the environment.

      • EnvironmentId — (String)

        The unique identifier of the environment.

      • LastUpdatedTime — (Date)

        A timestamp that indicates when the environment was last updated.

      • Name — (String)

        The name of the environment.

      • State — (String)

        The current state of the environment.

        Possible values include:
        • "CREATING"
        • "ACTIVE"
        • "DELETING"
        • "FAILED"

Returns:

  • (AWS.Request)

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

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

Deletes the resource policy set for the environment.

Service Reference:

Examples:

Calling the deleteResourcePolicy operation

var params = {
  Identifier: 'STRING_VALUE' /* required */
};
migrationhubrefactorspaces.deleteResourcePolicy(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: {})
    • Identifier — (String)

      Amazon Resource Name (ARN) of the resource associated with the policy.

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.

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

Deletes an Amazon Web Services Migration Hub Refactor Spaces route.

Service Reference:

Examples:

Calling the deleteRoute operation

var params = {
  ApplicationIdentifier: 'STRING_VALUE', /* required */
  EnvironmentIdentifier: 'STRING_VALUE', /* required */
  RouteIdentifier: 'STRING_VALUE' /* required */
};
migrationhubrefactorspaces.deleteRoute(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: {})
    • ApplicationIdentifier — (String)

      The ID of the application to delete the route from.

    • EnvironmentIdentifier — (String)

      The ID of the environment to delete the route from.

    • RouteIdentifier — (String)

      The ID of the route to delete.

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:

      • ApplicationId — (String)

        The ID of the application that the route belongs to.

      • Arn — (String)

        The Amazon Resource Name (ARN) of the route.

      • LastUpdatedTime — (Date)

        A timestamp that indicates when the route was last updated.

      • RouteId — (String)

        The ID of the route to delete.

      • ServiceId — (String)

        The ID of the service that the route belongs to.

      • State — (String)

        The current state of the route.

        Possible values include:
        • "CREATING"
        • "ACTIVE"
        • "DELETING"
        • "FAILED"
        • "UPDATING"
        • "INACTIVE"

Returns:

  • (AWS.Request)

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

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

Deletes an Amazon Web Services Migration Hub Refactor Spaces service.

Service Reference:

Examples:

Calling the deleteService operation

var params = {
  ApplicationIdentifier: 'STRING_VALUE', /* required */
  EnvironmentIdentifier: 'STRING_VALUE', /* required */
  ServiceIdentifier: 'STRING_VALUE' /* required */
};
migrationhubrefactorspaces.deleteService(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: {})
    • ApplicationIdentifier — (String)

      Deletes a Refactor Spaces service.

      Note: The RefactorSpacesSecurityGroup security group must be removed from all Amazon Web Services resources in the virtual private cloud (VPC) prior to deleting a service with a URL endpoint in a VPC.
    • EnvironmentIdentifier — (String)

      The ID of the environment that the service is in.

    • ServiceIdentifier — (String)

      The ID of the service to delete.

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:

      • ApplicationId — (String)

        The ID of the application that the service is in.

      • Arn — (String)

        The Amazon Resource Name (ARN) of the service.

      • EnvironmentId — (String)

        The unique identifier of the environment.

      • LastUpdatedTime — (Date)

        A timestamp that indicates when the service was last updated.

      • Name — (String)

        The name of the service.

      • ServiceId — (String)

        The unique identifier of the service.

      • State — (String)

        The current state of the service.

        Possible values include:
        • "CREATING"
        • "ACTIVE"
        • "DELETING"
        • "FAILED"

Returns:

  • (AWS.Request)

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

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

Gets an Amazon Web Services Migration Hub Refactor Spaces application.

Service Reference:

Examples:

Calling the getApplication operation

var params = {
  ApplicationIdentifier: 'STRING_VALUE', /* required */
  EnvironmentIdentifier: 'STRING_VALUE' /* required */
};
migrationhubrefactorspaces.getApplication(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: {})
    • ApplicationIdentifier — (String)

      The ID of the application.

    • EnvironmentIdentifier — (String)

      The ID of the environment.

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:

      • ApiGatewayProxy — (map)

        The endpoint URL of the API Gateway proxy.

        • ApiGatewayId — (String)

          The resource ID of the API Gateway for the proxy.

        • EndpointType — (String)

          The type of API Gateway endpoint created.

          Possible values include:
          • "REGIONAL"
          • "PRIVATE"
        • NlbArn — (String)

          The Amazon Resource Name (ARN) of the Network Load Balancer configured by the API Gateway proxy.

        • NlbName — (String)

          The name of the Network Load Balancer that is configured by the API Gateway proxy.

        • ProxyUrl — (String)

          The endpoint URL of the API Gateway proxy.

        • StageName — (String)

          The name of the API Gateway stage. The name defaults to prod.

        • VpcLinkId — (String)

          The VpcLink ID of the API Gateway proxy.

      • ApplicationId — (String)

        The unique identifier of the application.

      • Arn — (String)

        The Amazon Resource Name (ARN) of the application.

      • CreatedByAccountId — (String)

        The Amazon Web Services account ID of the application creator.

      • CreatedTime — (Date)

        A timestamp that indicates when the application is created.

      • EnvironmentId — (String)

        The unique identifier of the environment.

      • Error — (map)

        Any error associated with the application resource.

        • AccountId — (String)

          The Amazon Web Services account ID of the resource owner.

        • AdditionalDetails — (map<String>)

          Additional details about the error.

        • Code — (String)

          The error code associated with the error.

          Possible values include:
          • "INVALID_RESOURCE_STATE"
          • "RESOURCE_LIMIT_EXCEEDED"
          • "RESOURCE_CREATION_FAILURE"
          • "RESOURCE_UPDATE_FAILURE"
          • "SERVICE_ENDPOINT_HEALTH_CHECK_FAILURE"
          • "RESOURCE_DELETION_FAILURE"
          • "RESOURCE_RETRIEVAL_FAILURE"
          • "RESOURCE_IN_USE"
          • "RESOURCE_NOT_FOUND"
          • "STATE_TRANSITION_FAILURE"
          • "REQUEST_LIMIT_EXCEEDED"
          • "NOT_AUTHORIZED"
        • Message — (String)

          The message associated with the error.

        • ResourceIdentifier — (String)

          The ID of the resource.

        • ResourceType — (String)

          The type of resource.

          Possible values include:
          • "ENVIRONMENT"
          • "APPLICATION"
          • "ROUTE"
          • "SERVICE"
          • "TRANSIT_GATEWAY"
          • "TRANSIT_GATEWAY_ATTACHMENT"
          • "API_GATEWAY"
          • "NLB"
          • "TARGET_GROUP"
          • "LOAD_BALANCER_LISTENER"
          • "VPC_LINK"
          • "LAMBDA"
          • "VPC"
          • "SUBNET"
          • "ROUTE_TABLE"
          • "SECURITY_GROUP"
          • "VPC_ENDPOINT_SERVICE_CONFIGURATION"
          • "RESOURCE_SHARE"
          • "IAM_ROLE"
      • LastUpdatedTime — (Date)

        A timestamp that indicates when the application was last updated.

      • Name — (String)

        The name of the application.

      • OwnerAccountId — (String)

        The Amazon Web Services account ID of the application owner (which is always the same as the environment owner account ID).

      • ProxyType — (String)

        The proxy type of the proxy created within the application.

        Possible values include:
        • "API_GATEWAY"
      • State — (String)

        The current state of the application.

        Possible values include:
        • "CREATING"
        • "ACTIVE"
        • "DELETING"
        • "FAILED"
        • "UPDATING"
      • Tags — (map<String>)

        The tags assigned to the application. A tag is a label that you assign to an Amazon Web Services resource. Each tag consists of a key-value pair.

      • VpcId — (String)

        The ID of the virtual private cloud (VPC).

Returns:

  • (AWS.Request)

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

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

Gets an Amazon Web Services Migration Hub Refactor Spaces environment.

Service Reference:

Examples:

Calling the getEnvironment operation

var params = {
  EnvironmentIdentifier: 'STRING_VALUE' /* required */
};
migrationhubrefactorspaces.getEnvironment(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: {})
    • EnvironmentIdentifier — (String)

      The ID of the environment.

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:

      • Arn — (String)

        The Amazon Resource Name (ARN) of the environment.

      • CreatedTime — (Date)

        A timestamp that indicates when the environment is created.

      • Description — (String)

        The description of the environment.

      • EnvironmentId — (String)

        The unique identifier of the environment.

      • Error — (map)

        Any error associated with the environment resource.

        • AccountId — (String)

          The Amazon Web Services account ID of the resource owner.

        • AdditionalDetails — (map<String>)

          Additional details about the error.

        • Code — (String)

          The error code associated with the error.

          Possible values include:
          • "INVALID_RESOURCE_STATE"
          • "RESOURCE_LIMIT_EXCEEDED"
          • "RESOURCE_CREATION_FAILURE"
          • "RESOURCE_UPDATE_FAILURE"
          • "SERVICE_ENDPOINT_HEALTH_CHECK_FAILURE"
          • "RESOURCE_DELETION_FAILURE"
          • "RESOURCE_RETRIEVAL_FAILURE"
          • "RESOURCE_IN_USE"
          • "RESOURCE_NOT_FOUND"
          • "STATE_TRANSITION_FAILURE"
          • "REQUEST_LIMIT_EXCEEDED"
          • "NOT_AUTHORIZED"
        • Message — (String)

          The message associated with the error.

        • ResourceIdentifier — (String)

          The ID of the resource.

        • ResourceType — (String)

          The type of resource.

          Possible values include:
          • "ENVIRONMENT"
          • "APPLICATION"
          • "ROUTE"
          • "SERVICE"
          • "TRANSIT_GATEWAY"
          • "TRANSIT_GATEWAY_ATTACHMENT"
          • "API_GATEWAY"
          • "NLB"
          • "TARGET_GROUP"
          • "LOAD_BALANCER_LISTENER"
          • "VPC_LINK"
          • "LAMBDA"
          • "VPC"
          • "SUBNET"
          • "ROUTE_TABLE"
          • "SECURITY_GROUP"
          • "VPC_ENDPOINT_SERVICE_CONFIGURATION"
          • "RESOURCE_SHARE"
          • "IAM_ROLE"
      • LastUpdatedTime — (Date)

        A timestamp that indicates when the environment was last updated.

      • Name — (String)

        The name of the environment.

      • NetworkFabricType — (String)

        The network fabric type of the environment.

        Possible values include:
        • "TRANSIT_GATEWAY"
      • OwnerAccountId — (String)

        The Amazon Web Services account ID of the environment owner.

      • State — (String)

        The current state of the environment.

        Possible values include:
        • "CREATING"
        • "ACTIVE"
        • "DELETING"
        • "FAILED"
      • Tags — (map<String>)

        The tags to assign to the environment. A tag is a label that you assign to an Amazon Web Services resource. Each tag consists of a key-value pair.

      • TransitGatewayId — (String)

        The ID of the transit gateway set up by the environment.

Returns:

  • (AWS.Request)

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

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

Gets the resource-based permission policy that is set for the given environment.

Service Reference:

Examples:

Calling the getResourcePolicy operation

var params = {
  Identifier: 'STRING_VALUE' /* required */
};
migrationhubrefactorspaces.getResourcePolicy(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: {})
    • Identifier — (String)

      The Amazon Resource Name (ARN) of the resource associated with the policy.

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:

      • Policy — (String)

        A JSON-formatted string for an Amazon Web Services resource-based policy.

Returns:

  • (AWS.Request)

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

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

Gets an Amazon Web Services Migration Hub Refactor Spaces route.

Service Reference:

Examples:

Calling the getRoute operation

var params = {
  ApplicationIdentifier: 'STRING_VALUE', /* required */
  EnvironmentIdentifier: 'STRING_VALUE', /* required */
  RouteIdentifier: 'STRING_VALUE' /* required */
};
migrationhubrefactorspaces.getRoute(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: {})
    • ApplicationIdentifier — (String)

      The ID of the application.

    • EnvironmentIdentifier — (String)

      The ID of the environment.

    • RouteIdentifier — (String)

      The ID of the route.

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:

      • ApplicationId — (String)

        The ID of the application that the route belongs to.

      • Arn — (String)

        The Amazon Resource Name (ARN) of the route.

      • CreatedByAccountId — (String)

        The Amazon Web Services account ID of the route creator.

      • CreatedTime — (Date)

        The timestamp of when the route is created.

      • EnvironmentId — (String)

        Unique identifier of the environment.

      • Error — (map)

        Any error associated with the route resource.

        • AccountId — (String)

          The Amazon Web Services account ID of the resource owner.

        • AdditionalDetails — (map<String>)

          Additional details about the error.

        • Code — (String)

          The error code associated with the error.

          Possible values include:
          • "INVALID_RESOURCE_STATE"
          • "RESOURCE_LIMIT_EXCEEDED"
          • "RESOURCE_CREATION_FAILURE"
          • "RESOURCE_UPDATE_FAILURE"
          • "SERVICE_ENDPOINT_HEALTH_CHECK_FAILURE"
          • "RESOURCE_DELETION_FAILURE"
          • "RESOURCE_RETRIEVAL_FAILURE"
          • "RESOURCE_IN_USE"
          • "RESOURCE_NOT_FOUND"
          • "STATE_TRANSITION_FAILURE"
          • "REQUEST_LIMIT_EXCEEDED"
          • "NOT_AUTHORIZED"
        • Message — (String)

          The message associated with the error.

        • ResourceIdentifier — (String)

          The ID of the resource.

        • ResourceType — (String)

          The type of resource.

          Possible values include:
          • "ENVIRONMENT"
          • "APPLICATION"
          • "ROUTE"
          • "SERVICE"
          • "TRANSIT_GATEWAY"
          • "TRANSIT_GATEWAY_ATTACHMENT"
          • "API_GATEWAY"
          • "NLB"
          • "TARGET_GROUP"
          • "LOAD_BALANCER_LISTENER"
          • "VPC_LINK"
          • "LAMBDA"
          • "VPC"
          • "SUBNET"
          • "ROUTE_TABLE"
          • "SECURITY_GROUP"
          • "VPC_ENDPOINT_SERVICE_CONFIGURATION"
          • "RESOURCE_SHARE"
          • "IAM_ROLE"
      • IncludeChildPaths — (Boolean)

        Indicates whether to match all subpaths of the given source path. If this value is false, requests must match the source path exactly before they are forwarded to this route's service.

      • LastUpdatedTime — (Date)

        A timestamp that indicates when the route was last updated.

      • Methods — (Array<String>)

        A list of HTTP methods to match. An empty list matches all values. If a method is present, only HTTP requests using that method are forwarded to this route’s service.

      • OwnerAccountId — (String)

        The Amazon Web Services account ID of the route owner.

      • PathResourceToId — (map<String>)

        A mapping of Amazon API Gateway path resources to resource IDs.

      • RouteId — (String)

        The unique identifier of the route.

        DEFAULT: All traffic that does not match another route is forwarded to the default route. Applications must have a default route before any other routes can be created.

        URI_PATH: A route that is based on a URI path.

      • RouteType — (String)

        The type of route.

        Possible values include:
        • "DEFAULT"
        • "URI_PATH"
      • ServiceId — (String)

        The unique identifier of the service.

      • SourcePath — (String)

        The path to use to match traffic. Paths must start with / and are relative to the base of the application.

      • State — (String)

        The current state of the route.

        Possible values include:
        • "CREATING"
        • "ACTIVE"
        • "DELETING"
        • "FAILED"
        • "UPDATING"
        • "INACTIVE"
      • Tags — (map<String>)

        The tags assigned to the route. A tag is a label that you assign to an Amazon Web Services resource. Each tag consists of a key-value pair.

Returns:

  • (AWS.Request)

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

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

Gets an Amazon Web Services Migration Hub Refactor Spaces service.

Service Reference:

Examples:

Calling the getService operation

var params = {
  ApplicationIdentifier: 'STRING_VALUE', /* required */
  EnvironmentIdentifier: 'STRING_VALUE', /* required */
  ServiceIdentifier: 'STRING_VALUE' /* required */
};
migrationhubrefactorspaces.getService(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: {})
    • ApplicationIdentifier — (String)

      The ID of the application.

    • EnvironmentIdentifier — (String)

      The ID of the environment.

    • ServiceIdentifier — (String)

      The ID of the service.

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:

      • ApplicationId — (String)

        The ID of the application.

      • Arn — (String)

        The Amazon Resource Name (ARN) of the service.

      • CreatedByAccountId — (String)

        The Amazon Web Services account ID of the service creator.

      • CreatedTime — (Date)

        The timestamp of when the service is created.

      • Description — (String)

        The description of the service.

      • EndpointType — (String)

        The endpoint type of the service.

        Possible values include:
        • "LAMBDA"
        • "URL"
      • EnvironmentId — (String)

        The unique identifier of the environment.

      • Error — (map)

        Any error associated with the service resource.

        • AccountId — (String)

          The Amazon Web Services account ID of the resource owner.

        • AdditionalDetails — (map<String>)

          Additional details about the error.

        • Code — (String)

          The error code associated with the error.

          Possible values include:
          • "INVALID_RESOURCE_STATE"
          • "RESOURCE_LIMIT_EXCEEDED"
          • "RESOURCE_CREATION_FAILURE"
          • "RESOURCE_UPDATE_FAILURE"
          • "SERVICE_ENDPOINT_HEALTH_CHECK_FAILURE"
          • "RESOURCE_DELETION_FAILURE"
          • "RESOURCE_RETRIEVAL_FAILURE"
          • "RESOURCE_IN_USE"
          • "RESOURCE_NOT_FOUND"
          • "STATE_TRANSITION_FAILURE"
          • "REQUEST_LIMIT_EXCEEDED"
          • "NOT_AUTHORIZED"
        • Message — (String)

          The message associated with the error.

        • ResourceIdentifier — (String)

          The ID of the resource.

        • ResourceType — (String)

          The type of resource.

          Possible values include:
          • "ENVIRONMENT"
          • "APPLICATION"
          • "ROUTE"
          • "SERVICE"
          • "TRANSIT_GATEWAY"
          • "TRANSIT_GATEWAY_ATTACHMENT"
          • "API_GATEWAY"
          • "NLB"
          • "TARGET_GROUP"
          • "LOAD_BALANCER_LISTENER"
          • "VPC_LINK"
          • "LAMBDA"
          • "VPC"
          • "SUBNET"
          • "ROUTE_TABLE"
          • "SECURITY_GROUP"
          • "VPC_ENDPOINT_SERVICE_CONFIGURATION"
          • "RESOURCE_SHARE"
          • "IAM_ROLE"
      • LambdaEndpoint — (map)

        The configuration for the Lambda endpoint type.

        The Arn is the Amazon Resource Name (ARN) of the Lambda function associated with this service.

        • Arn — (String)

          The Amazon Resource Name (ARN) of the Lambda endpoint.

      • LastUpdatedTime — (Date)

        A timestamp that indicates when the service was last updated.

      • Name — (String)

        The name of the service.

      • OwnerAccountId — (String)

        The Amazon Web Services account ID of the service owner.

      • ServiceId — (String)

        The unique identifier of the service.

      • State — (String)

        The current state of the service.

        Possible values include:
        • "CREATING"
        • "ACTIVE"
        • "DELETING"
        • "FAILED"
      • Tags — (map<String>)

        The tags assigned to the service. A tag is a label that you assign to an Amazon Web Services resource. Each tag consists of a key-value pair.

      • UrlEndpoint — (map)

        The configuration for the URL endpoint type.

        The Url isthe URL of the endpoint type.

        The HealthUrl is the health check URL of the endpoint type.

        • HealthUrl — (String)

          The health check URL of the URL endpoint type.

        • Url — (String)

          The HTTP URL endpoint.

      • VpcId — (String)

        The ID of the virtual private cloud (VPC).

Returns:

  • (AWS.Request)

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

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

Lists all the Amazon Web Services Migration Hub Refactor Spaces applications within an environment.

Service Reference:

Examples:

Calling the listApplications operation

var params = {
  EnvironmentIdentifier: 'STRING_VALUE', /* required */
  MaxResults: 'NUMBER_VALUE',
  NextToken: 'STRING_VALUE'
};
migrationhubrefactorspaces.listApplications(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: {})
    • EnvironmentIdentifier — (String)

      The ID of the environment.

    • MaxResults — (Integer)

      The maximum number of results to return with a single call. To retrieve the remaining results, make another call with the returned nextToken value.

    • NextToken — (String)

      The token for the next page of results.

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:

      • ApplicationSummaryList — (Array<map>)

        The list of ApplicationSummary objects.

        • ApiGatewayProxy — (map)

          The endpoint URL of the Amazon API Gateway proxy.

          • ApiGatewayId — (String)

            The resource ID of the API Gateway for the proxy.

          • EndpointType — (String)

            The type of API Gateway endpoint created.

            Possible values include:
            • "REGIONAL"
            • "PRIVATE"
          • NlbArn — (String)

            The Amazon Resource Name (ARN) of the Network Load Balancer configured by the API Gateway proxy.

          • NlbName — (String)

            The name of the Network Load Balancer that is configured by the API Gateway proxy.

          • ProxyUrl — (String)

            The endpoint URL of the API Gateway proxy.

          • StageName — (String)

            The name of the API Gateway stage. The name defaults to prod.

          • VpcLinkId — (String)

            The VpcLink ID of the API Gateway proxy.

        • ApplicationId — (String)

          The unique identifier of the application.

        • Arn — (String)

          The Amazon Resource Name (ARN) of the application.

        • CreatedByAccountId — (String)

          The Amazon Web Services account ID of the application creator.

        • CreatedTime — (Date)

          A timestamp that indicates when the application is created.

        • EnvironmentId — (String)

          The unique identifier of the environment.

        • Error — (map)

          Any error associated with the application resource.

          • AccountId — (String)

            The Amazon Web Services account ID of the resource owner.

          • AdditionalDetails — (map<String>)

            Additional details about the error.

          • Code — (String)

            The error code associated with the error.

            Possible values include:
            • "INVALID_RESOURCE_STATE"
            • "RESOURCE_LIMIT_EXCEEDED"
            • "RESOURCE_CREATION_FAILURE"
            • "RESOURCE_UPDATE_FAILURE"
            • "SERVICE_ENDPOINT_HEALTH_CHECK_FAILURE"
            • "RESOURCE_DELETION_FAILURE"
            • "RESOURCE_RETRIEVAL_FAILURE"
            • "RESOURCE_IN_USE"
            • "RESOURCE_NOT_FOUND"
            • "STATE_TRANSITION_FAILURE"
            • "REQUEST_LIMIT_EXCEEDED"
            • "NOT_AUTHORIZED"
          • Message — (String)

            The message associated with the error.

          • ResourceIdentifier — (String)

            The ID of the resource.

          • ResourceType — (String)

            The type of resource.

            Possible values include:
            • "ENVIRONMENT"
            • "APPLICATION"
            • "ROUTE"
            • "SERVICE"
            • "TRANSIT_GATEWAY"
            • "TRANSIT_GATEWAY_ATTACHMENT"
            • "API_GATEWAY"
            • "NLB"
            • "TARGET_GROUP"
            • "LOAD_BALANCER_LISTENER"
            • "VPC_LINK"
            • "LAMBDA"
            • "VPC"
            • "SUBNET"
            • "ROUTE_TABLE"
            • "SECURITY_GROUP"
            • "VPC_ENDPOINT_SERVICE_CONFIGURATION"
            • "RESOURCE_SHARE"
            • "IAM_ROLE"
        • LastUpdatedTime — (Date)

          A timestamp that indicates when the application was last updated.

        • Name — (String)

          The name of the application.

        • OwnerAccountId — (String)

          The Amazon Web Services account ID of the application owner (which is always the same as the environment owner account ID).

        • ProxyType — (String)

          The proxy type of the proxy created within the application.

          Possible values include:
          • "API_GATEWAY"
        • State — (String)

          The current state of the application.

          Possible values include:
          • "CREATING"
          • "ACTIVE"
          • "DELETING"
          • "FAILED"
          • "UPDATING"
        • Tags — (map<String>)

          The tags assigned to the application.

        • VpcId — (String)

          The ID of the virtual private cloud (VPC).

      • NextToken — (String)

        The token for the next page of results.

Returns:

  • (AWS.Request)

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

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

Lists Amazon Web Services Migration Hub Refactor Spaces environments owned by a caller account or shared with the caller account.

Service Reference:

Examples:

Calling the listEnvironments operation

var params = {
  MaxResults: 'NUMBER_VALUE',
  NextToken: 'STRING_VALUE'
};
migrationhubrefactorspaces.listEnvironments(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 results to return with a single call. To retrieve the remaining results, make another call with the returned nextToken value.

    • NextToken — (String)

      The token for the next page of results.

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:

      • EnvironmentSummaryList — (Array<map>)

        The list of EnvironmentSummary objects.

        • Arn — (String)

          The Amazon Resource Name (ARN) of the environment.

        • CreatedTime — (Date)

          A timestamp that indicates when the environment is created.

        • Description — (String)

          A description of the environment.

        • EnvironmentId — (String)

          The unique identifier of the environment.

        • Error — (map)

          Any error associated with the environment resource.

          • AccountId — (String)

            The Amazon Web Services account ID of the resource owner.

          • AdditionalDetails — (map<String>)

            Additional details about the error.

          • Code — (String)

            The error code associated with the error.

            Possible values include:
            • "INVALID_RESOURCE_STATE"
            • "RESOURCE_LIMIT_EXCEEDED"
            • "RESOURCE_CREATION_FAILURE"
            • "RESOURCE_UPDATE_FAILURE"
            • "SERVICE_ENDPOINT_HEALTH_CHECK_FAILURE"
            • "RESOURCE_DELETION_FAILURE"
            • "RESOURCE_RETRIEVAL_FAILURE"
            • "RESOURCE_IN_USE"
            • "RESOURCE_NOT_FOUND"
            • "STATE_TRANSITION_FAILURE"
            • "REQUEST_LIMIT_EXCEEDED"
            • "NOT_AUTHORIZED"
          • Message — (String)

            The message associated with the error.

          • ResourceIdentifier — (String)

            The ID of the resource.

          • ResourceType — (String)

            The type of resource.

            Possible values include:
            • "ENVIRONMENT"
            • "APPLICATION"
            • "ROUTE"
            • "SERVICE"
            • "TRANSIT_GATEWAY"
            • "TRANSIT_GATEWAY_ATTACHMENT"
            • "API_GATEWAY"
            • "NLB"
            • "TARGET_GROUP"
            • "LOAD_BALANCER_LISTENER"
            • "VPC_LINK"
            • "LAMBDA"
            • "VPC"
            • "SUBNET"
            • "ROUTE_TABLE"
            • "SECURITY_GROUP"
            • "VPC_ENDPOINT_SERVICE_CONFIGURATION"
            • "RESOURCE_SHARE"
            • "IAM_ROLE"
        • LastUpdatedTime — (Date)

          A timestamp that indicates when the environment was last updated.

        • Name — (String)

          The name of the environment.

        • NetworkFabricType — (String)

          The network fabric type of the environment.

          Possible values include:
          • "TRANSIT_GATEWAY"
        • OwnerAccountId — (String)

          The Amazon Web Services account ID of the environment owner.

        • State — (String)

          The current state of the environment.

          Possible values include:
          • "CREATING"
          • "ACTIVE"
          • "DELETING"
          • "FAILED"
        • Tags — (map<String>)

          The tags assigned to the environment.

        • TransitGatewayId — (String)

          The ID of the transit gateway set up by the environment.

      • NextToken — (String)

        The token for the next page of results.

Returns:

  • (AWS.Request)

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

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

Lists all Amazon Web Services Migration Hub Refactor Spaces service virtual private clouds (VPCs) that are part of the environment.

Service Reference:

Examples:

Calling the listEnvironmentVpcs operation

var params = {
  EnvironmentIdentifier: 'STRING_VALUE', /* required */
  MaxResults: 'NUMBER_VALUE',
  NextToken: 'STRING_VALUE'
};
migrationhubrefactorspaces.listEnvironmentVpcs(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: {})
    • EnvironmentIdentifier — (String)

      The ID of the environment.

    • MaxResults — (Integer)

      The maximum number of results to return with a single call. To retrieve the remaining results, make another call with the returned nextToken value.

    • NextToken — (String)

      The token for the next page of results.

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:

      • EnvironmentVpcList — (Array<map>)

        The list of EnvironmentVpc objects.

        • AccountId — (String)

          The Amazon Web Services account ID of the virtual private cloud (VPC) owner.

        • CidrBlocks — (Array<String>)

          The list of Amazon Virtual Private Cloud (Amazon VPC) CIDR blocks.

        • CreatedTime — (Date)

          A timestamp that indicates when the VPC is first added to the environment.

        • EnvironmentId — (String)

          The unique identifier of the environment.

        • LastUpdatedTime — (Date)

          A timestamp that indicates when the VPC was last updated by the environment.

        • VpcId — (String)

          The ID of the VPC.

        • VpcName — (String)

          The name of the VPC at the time it is added to the environment.

      • NextToken — (String)

        The token for the next page of results.

Returns:

  • (AWS.Request)

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

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

Lists all the Amazon Web Services Migration Hub Refactor Spaces routes within an application.

Service Reference:

Examples:

Calling the listRoutes operation

var params = {
  ApplicationIdentifier: 'STRING_VALUE', /* required */
  EnvironmentIdentifier: 'STRING_VALUE', /* required */
  MaxResults: 'NUMBER_VALUE',
  NextToken: 'STRING_VALUE'
};
migrationhubrefactorspaces.listRoutes(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: {})
    • ApplicationIdentifier — (String)

      The ID of the application.

    • EnvironmentIdentifier — (String)

      The ID of the environment.

    • MaxResults — (Integer)

      The maximum number of results to return with a single call. To retrieve the remaining results, make another call with the returned nextToken value.

    • NextToken — (String)

      The token for the next page of results.

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 for the next page of results.

      • RouteSummaryList — (Array<map>)

        The list of RouteSummary objects.

        • ApplicationId — (String)

          The unique identifier of the application.

        • Arn — (String)

          The Amazon Resource Name (ARN) of the route.

        • CreatedByAccountId — (String)

          The Amazon Web Services account ID of the route creator.

        • CreatedTime — (Date)

          A timestamp that indicates when the route is created.

        • EnvironmentId — (String)

          The unique identifier of the environment.

        • Error — (map)

          Any error associated with the route resource.

          • AccountId — (String)

            The Amazon Web Services account ID of the resource owner.

          • AdditionalDetails — (map<String>)

            Additional details about the error.

          • Code — (String)

            The error code associated with the error.

            Possible values include:
            • "INVALID_RESOURCE_STATE"
            • "RESOURCE_LIMIT_EXCEEDED"
            • "RESOURCE_CREATION_FAILURE"
            • "RESOURCE_UPDATE_FAILURE"
            • "SERVICE_ENDPOINT_HEALTH_CHECK_FAILURE"
            • "RESOURCE_DELETION_FAILURE"
            • "RESOURCE_RETRIEVAL_FAILURE"
            • "RESOURCE_IN_USE"
            • "RESOURCE_NOT_FOUND"
            • "STATE_TRANSITION_FAILURE"
            • "REQUEST_LIMIT_EXCEEDED"
            • "NOT_AUTHORIZED"
          • Message — (String)

            The message associated with the error.

          • ResourceIdentifier — (String)

            The ID of the resource.

          • ResourceType — (String)

            The type of resource.

            Possible values include:
            • "ENVIRONMENT"
            • "APPLICATION"
            • "ROUTE"
            • "SERVICE"
            • "TRANSIT_GATEWAY"
            • "TRANSIT_GATEWAY_ATTACHMENT"
            • "API_GATEWAY"
            • "NLB"
            • "TARGET_GROUP"
            • "LOAD_BALANCER_LISTENER"
            • "VPC_LINK"
            • "LAMBDA"
            • "VPC"
            • "SUBNET"
            • "ROUTE_TABLE"
            • "SECURITY_GROUP"
            • "VPC_ENDPOINT_SERVICE_CONFIGURATION"
            • "RESOURCE_SHARE"
            • "IAM_ROLE"
        • IncludeChildPaths — (Boolean)

          Indicates whether to match all subpaths of the given source path. If this value is false, requests must match the source path exactly before they are forwarded to this route's service.

        • LastUpdatedTime — (Date)

          A timestamp that indicates when the route was last updated.

        • Methods — (Array<String>)

          A list of HTTP methods to match. An empty list matches all values. If a method is present, only HTTP requests using that method are forwarded to this route’s service.

        • OwnerAccountId — (String)

          The Amazon Web Services account ID of the route owner.

        • PathResourceToId — (map<String>)

          A mapping of Amazon API Gateway path resources to resource IDs.

        • RouteId — (String)

          The unique identifier of the route.

        • RouteType — (String)

          The route type of the route.

          Possible values include:
          • "DEFAULT"
          • "URI_PATH"
        • ServiceId — (String)

          The unique identifier of the service.

        • SourcePath — (String)

          The path to use to match traffic. Paths must start with / and are relative to the base of the application.

        • State — (String)

          The current state of the route.

          Possible values include:
          • "CREATING"
          • "ACTIVE"
          • "DELETING"
          • "FAILED"
          • "UPDATING"
          • "INACTIVE"
        • Tags — (map<String>)

          The tags assigned to the route.

Returns:

  • (AWS.Request)

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

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

Lists all the Amazon Web Services Migration Hub Refactor Spaces services within an application.

Service Reference:

Examples:

Calling the listServices operation

var params = {
  ApplicationIdentifier: 'STRING_VALUE', /* required */
  EnvironmentIdentifier: 'STRING_VALUE', /* required */
  MaxResults: 'NUMBER_VALUE',
  NextToken: 'STRING_VALUE'
};
migrationhubrefactorspaces.listServices(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: {})
    • ApplicationIdentifier — (String)

      The ID of the application.

    • EnvironmentIdentifier — (String)

      The ID of the environment.

    • MaxResults — (Integer)

      The maximum number of results to return with a single call. To retrieve the remaining results, make another call with the returned nextToken value.

    • NextToken — (String)

      The token for the next page of results.

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 for the next page of results.

      • ServiceSummaryList — (Array<map>)

        The list of ServiceSummary objects.

        • ApplicationId — (String)

          The unique identifier of the application.

        • Arn — (String)

          The Amazon Resource Name (ARN) of the service.

        • CreatedByAccountId — (String)

          The Amazon Web Services account ID of the service creator.

        • CreatedTime — (Date)

          A timestamp that indicates when the service is created.

        • Description — (String)

          A description of the service.

        • EndpointType — (String)

          The endpoint type of the service.

          Possible values include:
          • "LAMBDA"
          • "URL"
        • EnvironmentId — (String)

          The unique identifier of the environment.

        • Error — (map)

          Any error associated with the service resource.

          • AccountId — (String)

            The Amazon Web Services account ID of the resource owner.

          • AdditionalDetails — (map<String>)

            Additional details about the error.

          • Code — (String)

            The error code associated with the error.

            Possible values include:
            • "INVALID_RESOURCE_STATE"
            • "RESOURCE_LIMIT_EXCEEDED"
            • "RESOURCE_CREATION_FAILURE"
            • "RESOURCE_UPDATE_FAILURE"
            • "SERVICE_ENDPOINT_HEALTH_CHECK_FAILURE"
            • "RESOURCE_DELETION_FAILURE"
            • "RESOURCE_RETRIEVAL_FAILURE"
            • "RESOURCE_IN_USE"
            • "RESOURCE_NOT_FOUND"
            • "STATE_TRANSITION_FAILURE"
            • "REQUEST_LIMIT_EXCEEDED"
            • "NOT_AUTHORIZED"
          • Message — (String)

            The message associated with the error.

          • ResourceIdentifier — (String)

            The ID of the resource.

          • ResourceType — (String)

            The type of resource.

            Possible values include:
            • "ENVIRONMENT"
            • "APPLICATION"
            • "ROUTE"
            • "SERVICE"
            • "TRANSIT_GATEWAY"
            • "TRANSIT_GATEWAY_ATTACHMENT"
            • "API_GATEWAY"
            • "NLB"
            • "TARGET_GROUP"
            • "LOAD_BALANCER_LISTENER"
            • "VPC_LINK"
            • "LAMBDA"
            • "VPC"
            • "SUBNET"
            • "ROUTE_TABLE"
            • "SECURITY_GROUP"
            • "VPC_ENDPOINT_SERVICE_CONFIGURATION"
            • "RESOURCE_SHARE"
            • "IAM_ROLE"
        • LambdaEndpoint — (map)

          A summary of the configuration for the Lambda endpoint type.

          • Arn — (String)

            The Amazon Resource Name (ARN) of the Lambda endpoint.

        • LastUpdatedTime — (Date)

          A timestamp that indicates when the service was last updated.

        • Name — (String)

          The name of the service.

        • OwnerAccountId — (String)

          The Amazon Web Services account ID of the service owner.

        • ServiceId — (String)

          The unique identifier of the service.

        • State — (String)

          The current state of the service.

          Possible values include:
          • "CREATING"
          • "ACTIVE"
          • "DELETING"
          • "FAILED"
        • Tags — (map<String>)

          The tags assigned to the service.

        • UrlEndpoint — (map)

          The summary of the configuration for the URL endpoint type.

          • HealthUrl — (String)

            The health check URL of the URL endpoint type. If the URL is a public endpoint, the HealthUrl must also be a public endpoint. If the URL is a private endpoint inside a virtual private cloud (VPC), the health URL must also be a private endpoint, and the host must be the same as the URL.

          • Url — (String)

            The URL to route traffic to. The URL must be an rfc3986-formatted URL. If the host is a domain name, the name must be resolvable over the public internet. If the scheme is https, the top level domain of the host must be listed in the IANA root zone database.

        • VpcId — (String)

          The ID of the virtual private cloud (VPC).

Returns:

  • (AWS.Request)

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

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

Lists the tags of a resource. The caller account must be the same as the resource’s OwnerAccountId. Listing tags in other accounts is not supported.

Service Reference:

Examples:

Calling the listTagsForResource operation

var params = {
  ResourceArn: 'STRING_VALUE' /* required */
};
migrationhubrefactorspaces.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>)

        The list of tags assigned to the resource.

Returns:

  • (AWS.Request)

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

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

Attaches a resource-based permission policy to the Amazon Web Services Migration Hub Refactor Spaces environment. The policy must contain the same actions and condition statements as the arn:aws:ram::aws:permission/AWSRAMDefaultPermissionRefactorSpacesEnvironment permission in Resource Access Manager. The policy must not contain new lines or blank lines.

Service Reference:

Examples:

Calling the putResourcePolicy operation

var params = {
  Policy: 'STRING_VALUE', /* required */
  ResourceArn: 'STRING_VALUE' /* required */
};
migrationhubrefactorspaces.putResourcePolicy(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: {})
    • Policy — (String)

      A JSON-formatted string for an Amazon Web Services resource-based policy.

    • ResourceArn — (String)

      The Amazon Resource Name (ARN) of the resource to which the policy is being attached.

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.

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

Removes the tags of a given resource. Tags are metadata which can be used to manage a resource. To tag a resource, the caller account must be the same as the resource’s OwnerAccountId. Tagging resources in other accounts is not supported.

Note: Amazon Web Services Migration Hub Refactor Spaces does not propagate tags to orchestrated resources, such as an environment’s transit gateway.

Service Reference:

Examples:

Calling the tagResource operation

var params = {
  ResourceArn: 'STRING_VALUE', /* required */
  Tags: { /* required */
    '<TagMapKeyString>': 'STRING_VALUE',
    /* '<TagMapKeyString>': ... */
  }
};
migrationhubrefactorspaces.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>)

      The new or modified tags for 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.

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

Adds to or modifies the tags of the given resource. Tags are metadata which can be used to manage a resource. To untag a resource, the caller account must be the same as the resource’s OwnerAccountId. Untagging resources across accounts is not supported.

Service Reference:

Examples:

Calling the untagResource operation

var params = {
  ResourceArn: 'STRING_VALUE', /* required */
  TagKeys: [ /* required */
    'STRING_VALUE',
    /* more items */
  ]
};
migrationhubrefactorspaces.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>)

      The list of keys of the tags to be removed from 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.

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

Updates an Amazon Web Services Migration Hub Refactor Spaces route.

Service Reference:

Examples:

Calling the updateRoute operation

var params = {
  ActivationState: ACTIVE | INACTIVE, /* required */
  ApplicationIdentifier: 'STRING_VALUE', /* required */
  EnvironmentIdentifier: 'STRING_VALUE', /* required */
  RouteIdentifier: 'STRING_VALUE' /* required */
};
migrationhubrefactorspaces.updateRoute(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: {})
    • ActivationState — (String)

      If set to ACTIVE, traffic is forwarded to this route’s service after the route is updated.

      Possible values include:
      • "ACTIVE"
      • "INACTIVE"
    • ApplicationIdentifier — (String)

      The ID of the application within which the route is being updated.

    • EnvironmentIdentifier — (String)

      The ID of the environment in which the route is being updated.

    • RouteIdentifier — (String)

      The unique identifier of the route to update.

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:

      • ApplicationId — (String)

        The ID of the application in which the route is being updated.

      • Arn — (String)

        The Amazon Resource Name (ARN) of the route. The format for this ARN is arn:aws:refactor-spaces:region:account-id:resource-type/resource-id . For more information about ARNs, see Amazon Resource Names (ARNs) in the Amazon Web Services General Reference.

      • LastUpdatedTime — (Date)

        A timestamp that indicates when the route was last updated.

      • RouteId — (String)

        The unique identifier of the route.

      • ServiceId — (String)

        The ID of service in which the route was created. Traffic that matches this route is forwarded to this service.

      • State — (String)

        The current state of the route.

        Possible values include:
        • "CREATING"
        • "ACTIVE"
        • "DELETING"
        • "FAILED"
        • "UPDATING"
        • "INACTIVE"

Returns:

  • (AWS.Request)

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