Class: AWS.MigrationHubRefactorSpaces

var params = {
  Name: 'STRING_VALUE', /* required */
  NetworkFabricType: TRANSIT_GATEWAY | NONE, /* 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"
    • "NONE"
  • 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"
      • "NONE"
    • 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.

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 */
    AppendSourcePath: true || false,
    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.

    • ActivationState — required — (String)

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

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

      If set to true, this option appends the source path to the service URL endpoint.

    • 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.

    • SourcePath — required — (String)

      This is the path that Refactor Spaces uses to match traffic. Paths must start with / and are relative to the base of the application. To use path parameters in the source path, add a variable in curly braces. For example, the resource path {user} represents a path parameter called 'user'.

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.

      • ActivationState — required — (String)

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

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

        If set to true, this option appends the source path to the service URL endpoint.

      • 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.

      • SourcePath — required — (String)

        This is the path that Refactor Spaces uses to match traffic. Paths must start with / and are relative to the base of the application. To use path parameters in the source path, add a variable in curly braces. For example, the resource path {user} represents a path parameter called 'user'.

Returns:

• (AWS.Request) —

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

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.

    • Arn — required — (String)

      The Amazon Resource Name (ARN) of the Lambda function or alias.

  • 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. When creating a route to a service, Refactor Spaces automatically resolves the address in the UrlEndpointInput object URL when the Domain Name System (DNS) time-to-live (TTL) expires, or every 60 seconds for TTLs less than 60 seconds.

    • 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 — required — (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.

      • Arn — required — (String)

        The Amazon Resource Name (ARN) of the Lambda function or alias.

    • 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.

      • Url — required — (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.

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.

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.

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.

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.

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.

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.

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"
      • "NONE"
    • 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, if applicable.

Returns:

• (AWS.Request) —

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

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.

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:

    • AppendSourcePath — (Boolean)

      If set to true, this option appends the source path to the service URL endpoint.

    • 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)

      This is the path that Refactor Spaces uses to match traffic. Paths must start with / and are relative to the base of the application. To use path parameters in the source path, add a variable in curly braces. For example, the resource path {user} represents a path parameter called 'user'.

    • 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.

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.

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.

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"
        • "NONE"
      • 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.

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.

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.

      • AppendSourcePath — (Boolean)

        If set to true, this option appends the source path to the service URL endpoint.

      • 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)

        This is the path that Refactor Spaces uses to match traffic. Paths must start with / and are relative to the base of the application. To use path parameters in the source path, add a variable in curly braces. For example, the resource path {user} represents a path parameter called 'user'.

      • 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.

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.

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.

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.

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.

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.

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.