AWS Migration Hub Refactor Spaces API Reference Version latest

(1)

AWS Migration Hub Refactor Spaces

API Reference

Version latest

(2)

AWS Migration Hub Refactor Spaces: API Reference

Amazon's trademarks and trade dress may not be used in connection with any product or service that is not Amazon's, in any manner that is likely to cause confusion among customers, or in any manner that disparages or discredits Amazon. All other trademarks not owned by Amazon are the property of their respective owners, who may or may not be aﬃliated with, connected to, or sponsored by Amazon.

(3)

Welcome

This API reference provides descriptions, syntax, and other details about each of the actions and data types for AWS 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 AWS SDKs to access an API that is tailored to the programming language or platform that you're using. For more information, see AWS SDKs.

To share Refactor Spaces environments with other AWS accounts or with AWS Organizations and their OUs, use AWS Resource Access Manager's CreateResourceShare API. See CreateResourceShare in the AWS RAM API Reference.

This document was last published on March 6, 2022.

(9)

Actions

The following actions are supported:

• CreateApplication (p. 3)

• CreateEnvironment (p. 9)

• CreateRoute (p. 14)

• CreateService (p. 20)

• DeleteApplication (p. 27)

• DeleteEnvironment (p. 30)

• DeleteResourcePolicy (p. 33)

• DeleteRoute (p. 35)

• DeleteService (p. 38)

• GetApplication (p. 42)

• GetEnvironment (p. 47)

• GetResourcePolicy (p. 51)

• GetRoute (p. 53)

• GetService (p. 58)

• ListApplications (p. 63)

• ListEnvironments (p. 66)

• ListEnvironmentVpcs (p. 69)

• ListRoutes (p. 72)

• ListServices (p. 75)

• ListTagsForResource (p. 78)

• PutResourcePolicy (p. 80)

• TagResource (p. 82)

• UntagResource (p. 84)

(10)

CreateApplication

Creates an AWS 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.

Request Syntax

POST /environments/EnvironmentIdentifier/applications HTTP/1.1 Content-type: application/json

{ "ApiGatewayProxy": { "EndpointType": "string", "StageName": "string"

},

"ClientToken": "string", "Name": "string",

"ProxyType": "string", "Tags": {

"string" : "string"

},

"VpcId": "string"

}

URI Request Parameters

The request uses the following URI parameters.

EnvironmentIdentiﬁer (p. 3)

The unique identiﬁer of the environment.

Length Constraints: Fixed length of 14.

Pattern: ^env-[0-9A-Za-z]{10}$

Required: Yes

Request Body

The request accepts the following data in JSON format.

ApiGatewayProxy (p. 3)

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

Type: ApiGatewayProxyInput (p. 89) object Required: No

ClientToken (p. 3)

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

Type: String

(11)

Response Syntax

Length Constraints: Minimum length of 1. Maximum length of 64.

Pattern: ^[\x20-\x7E]{1,64}$

Required: No Name (p. 3)

The name to use for the application.

Type: String

Pattern: ^(?!app-)[a-zA-Z0-9]+[a-zA-Z0-9-_ ]+$

Required: Yes ProxyType (p. 3)

The proxy type of the proxy created within the application.

Type: String

Valid Values: API_GATEWAY Required: Yes

Tags (p. 3)

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

Type: String to string map

Map Entries: Minimum number of 0 items. Maximum number of 50 items.

Key Length Constraints: Minimum length of 1. Maximum length of 128.

Key Pattern: ^(?!aws:).+

Value Length Constraints: Minimum length of 0. Maximum length of 256.

Required: No VpcId (p. 3)

The ID of the virtual private cloud (VPC).

Type: String

Pattern: ^vpc-[-a-f0-9]{8}([-a-f0-9]{9})?$

Required: Yes

Response Syntax

HTTP/1.1 200

Content-type: application/json

(12)

Response Elements

{

"ApiGatewayProxy": { "EndpointType": "string", "StageName": "string"

},

"ApplicationId": "string", "Arn": "string",

"CreatedByAccountId": "string", "CreatedTime": number,

"EnvironmentId": "string", "LastUpdatedTime": number, "Name": "string",

"OwnerAccountId": "string", "ProxyType": "string", "State": "string", "Tags": {

"string" : "string"

},

"VpcId": "string"

}

Response Elements

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

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

Type: ApiGatewayProxyInput (p. 89) object ApplicationId (p. 4)

The unique identiﬁer of the application.

Type: String

Pattern: ^app-[0-9A-Za-z]{10}$

Arn (p. 4)

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 AWS General Reference.

Type: String

Pattern: ^arn:aws:refactor-spaces:[a-zA-Z0-9\-]+:\w{12}:[a-zA-Z_0-9+=,.@\-_/]+

$

CreatedByAccountId (p. 4)

The AWS account ID of application creator.

Type: String

(13)

Response Elements

Pattern: ^\d{12}$

CreatedTime (p. 4)

A timestamp that indicates when the application is created.

Type: Timestamp EnvironmentId (p. 4)

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

Type: String

LastUpdatedTime (p. 4)

A timestamp that indicates when the application was last updated.

Type: Timestamp Name (p. 4)

The name of the application.

Type: String

OwnerAccountId (p. 4)

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

Type: String

Pattern: ^\d{12}$

ProxyType (p. 4)

Type: String

Valid Values: API_GATEWAY State (p. 4)

The current state of the application.

Type: String

Valid Values: CREATING | ACTIVE | DELETING | FAILED | UPDATING Tags (p. 4)

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

(14)

Errors

VpcId (p. 4)

The ID of the Amazon VPC.

Type: String

Pattern: ^vpc-[-a-f0-9]{8}([-a-f0-9]{9})?$

Errors

For information about the errors that are common to all actions, see Common Errors (p. 119).

AccessDeniedException

The user does not have suﬃcient access to perform this action.

HTTP Status Code: 403 ConﬂictException

Updating or deleting a resource can cause an inconsistent state.

HTTP Status Code: 409 InternalServerException

An unexpected error occurred while processing the request.

HTTP Status Code: 500 ResourceNotFoundException

The request references a resource that does not exist.

HTTP Status Code: 404 ServiceQuotaExceededException

The request would cause a service quota to be exceeded.

HTTP Status Code: 402 ThrottlingException

Request was denied because the request was throttled.

HTTP Status Code: 429 ValidationException

The input does not satisfy the constraints speciﬁed by an AWS service.

HTTP Status Code: 400

(15)

See Also

CreateEnvironment

Creates an AWS 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.

Request Syntax

POST /environments HTTP/1.1 Content-type: application/json { "ClientToken": "string", "Description": "string", "Name": "string",

"NetworkFabricType": "string", "Tags": {

"string" : "string"

} }

URI Request Parameters

The request does not use any URI parameters.

Request Body

Type: String

Pattern: ^[\x20-\x7E]{1,64}$

Required: No Description (p. 9)

The description of the environment.

Type: String

Pattern: ^[a-zA-Z0-9-_\s\.\!\*\#\@\']+$

Required: No Name (p. 9)

The name of the environment.

(17)

Response Syntax

Type: String

Pattern: ^(?!env-)[a-zA-Z0-9]+[a-zA-Z0-9-_ ]+$

Required: Yes

NetworkFabricType (p. 9)

The network fabric type of the environment.

Type: String

Valid Values: TRANSIT_GATEWAY Required: Yes

Tags (p. 9)

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

Required: No

Response Syntax

HTTP/1.1 200

Content-type: application/json {

"Arn": "string", "CreatedTime": number, "Description": "string", "EnvironmentId": "string", "LastUpdatedTime": number, "Name": "string",

"NetworkFabricType": "string", "OwnerAccountId": "string", "State": "string",

"Tags": {

}}

Response Elements

(18)

Response Elements

Arn (p. 10)

The Amazon Resource Name (ARN) of the environment.

Type: String

$

A timestamp that indicates when the environment is created.

Type: Timestamp Description (p. 10)

A description of the environment.

Type: String

Pattern: ^[a-zA-Z0-9-_\s\.\!\*\#\@\']+$

EnvironmentId (p. 10)

Type: String

A timestamp that indicates when the environment was last updated.

Type: String

NetworkFabricType (p. 10)

The network fabric type of the environment.

Type: String

Valid Values: TRANSIT_GATEWAY OwnerAccountId (p. 10)

The AWS account ID of environment owner.

Type: String

(19)

Errors

Pattern: ^\d{12}$

State (p. 10)

The current state of the environment.

Type: String

Valid Values: CREATING | ACTIVE | DELETING | FAILED Tags (p. 10)

The tags assigned to the created environment. A tag is a label that you assign to an AWS resource.

Each tag consists of a key-value pair..

Errors

(20)

See Also

CreateRoute

Creates an AWS 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 ﬁrst route must be created as a DEFAULT RouteType.

When you create a route, Refactor Spaces conﬁgures the Amazon API Gateway to send traﬃc 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 traﬃc 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 traﬃc over the public internet.

• If the service has an AWS Lambda function endpoint, then Refactor Spaces conﬁgures 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 the route is created. If the health check fails, the route transitions to FAILED, and no traﬃc is sent to the service.

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

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 and the target group health check is run.

The HealthCheckProtocol, HealthCheckPort, and HealthCheckPath are the same protocol, port, and path speciﬁed 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 certiﬁcates are supported. Private Certiﬁcate Authorities (CAs) are permitted only if the CA's domain is publicly resolvable.

Request Syntax

POST /environments/EnvironmentIdentifier/applications/ApplicationIdentifier/routes HTTP/1.1 Content-type: application/json

{

"ClientToken": "string", "RouteType": "string",

"ServiceIdentifier": "string", "Tags": {

"string" : "string"

},

"UriPathRoute": {

"ActivationState": "string", "IncludeChildPaths": boolean, "Methods": [ "string" ], "SourcePath": "string"

}}

(22)

URI Request Parameters

ApplicationIdentiﬁer (p. 14)

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

Required: Yes

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

Required: Yes

Request Body

Type: String

Pattern: ^[\x20-\x7E]{1,64}$

Required: No RouteType (p. 14)

The route type of the route. DEFAULT indicates that all traﬃc 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.

Type: String

Valid Values: DEFAULT | URI_PATH Required: Yes

ServiceIdentiﬁer (p. 14)

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

Type: String

(23)

Response Syntax

Pattern: ^svc-[0-9A-Za-z]{10}$

Required: Yes Tags (p. 14)

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

Required: No UriPathRoute (p. 14)

The conﬁguration for the URI path route type.

Type: UriPathRouteInput (p. 113) object Required: No

Response Syntax

HTTP/1.1 200

Content-type: application/json { "ApplicationId": "string", "Arn": "string",

"LastUpdatedTime": number, "OwnerAccountId": "string", "RouteId": "string", "RouteType": "string", "ServiceId": "string", "State": "string", "Tags": {

},

"UriPathRoute": {

"ActivationState": "string", "IncludeChildPaths": boolean, "Methods": [ "string" ], "SourcePath": "string"

}}

Response Elements

(24)

Response Elements

ApplicationId (p. 16)

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

Type: String

Arn (p. 16)

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 AWS General Reference.

Type: String

$

The AWS account ID of the route creator.

Type: String

Pattern: ^\d{12}$

A timestamp that indicates when the route is created.

Type: Timestamp LastUpdatedTime (p. 16)

A timestamp that indicates when the route was last updated.

Type: Timestamp OwnerAccountId (p. 16)

The AWS account ID of the route owner.

Type: String

Pattern: ^\d{12}$

RouteId (p. 16)

The unique identiﬁer of the route.

Type: String

Pattern: ^rte-[0-9A-Za-z]{10}$

RouteType (p. 16)

The route type of the route.

(25)

Errors

Type: String

Valid Values: DEFAULT | URI_PATH ServiceId (p. 16)

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

Type: String

State (p. 16)

The current state of the route.

Type: String

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

UriPathRoute (p. 16)

onﬁguration for the URI path route type.

Type: UriPathRouteInput (p. 113) object

Errors

(26)

See Also

ResourceNotFoundException

CreateService

Creates an AWS 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.

Important

If an AWS 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.

Request Syntax

POST /environments/EnvironmentIdentifier/applications/ApplicationIdentifier/services HTTP/1.1

Content-type: application/json { "ClientToken": "string", "Description": "string", "EndpointType": "string", "LambdaEndpoint": { "Arn": "string"

},

"Name": "string", "Tags": {

"string" : "string"

},

"UrlEndpoint": {

"HealthUrl": "string", "Url": "string"

},

"VpcId": "string"

}

URI Request Parameters

The ID of the application which the service is created.

Required: Yes

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

Required: Yes

(28)

Request Body

Type: String

Pattern: ^[\x20-\x7E]{1,64}$

Required: No Description (p. 20)

The description of the service.

Type: String

Pattern: ^[a-zA-Z0-9-_\s\.\!\*\#\@\']+$

Required: No EndpointType (p. 20)

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

Type: String

Valid Values: LAMBDA | URL Required: Yes

LambdaEndpoint (p. 20)

The conﬁguration for the Lambda endpoint type.

Type: LambdaEndpointInput (p. 103) object Required: No

Name (p. 20)

The name of the service.

Type: String

Pattern: ^(?!svc-)[a-zA-Z0-9]+[a-zA-Z0-9-_ ]+$

Required: Yes Tags (p. 20)

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

(29)

Response Syntax

Required: No UrlEndpoint (p. 20)

The conﬁguration for the URL endpoint type.

Type: UrlEndpointInput (p. 115) object Required: No

VpcId (p. 20)

The ID of the VPC.

Type: String

Pattern: ^vpc-[-a-f0-9]{8}([-a-f0-9]{9})?$

Required: No

Response Syntax

HTTP/1.1 200

"Description": "string", "EndpointType": "string", "EnvironmentId": "string", "LambdaEndpoint": { "Arn": "string"

},

"LastUpdatedTime": number, "Name": "string",

"OwnerAccountId": "string", "ServiceId": "string", "State": "string", "Tags": {

},

"UrlEndpoint": {

"HealthUrl": "string", "Url": "string"

},

"VpcId": "string"

}

(30)

Response Elements

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

Type: String

Arn (p. 22)

The Amazon Resource Name (ARN) of the service.

Type: String

$

The AWS account ID of the service creator.

Type: String

Pattern: ^\d{12}$

A timestamp that indicates when the service is created.

The description of the created service.

Type: String

Pattern: ^[a-zA-Z0-9-_\s\.\!\*\#\@\']+$

EndpointType (p. 22)

The endpoint type of the service.

Type: String

Valid Values: LAMBDA | URL EnvironmentId (p. 22)

(31)

Response Elements

Type: String

LambdaEndpoint (p. 22)

The conﬁguration for the Lambda endpoint type.

Type: LambdaEndpointInput (p. 103) object LastUpdatedTime (p. 22)

A timestamp that indicates when the service was last updated.

Type: String

The AWS account ID of the service owner.

Type: String

Pattern: ^\d{12}$

ServiceId (p. 22)

The unique identiﬁer of the service.

Type: String

State (p. 22)

The current state of the service.

Type: String

Valid Values: CREATING | ACTIVE | DELETING | FAILED Tags (p. 22)

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

(32)

Errors

UrlEndpoint (p. 22)

The conﬁguration for the URL endpoint type.

Type: UrlEndpointInput (p. 115) object VpcId (p. 22)

The ID of the VPC.

Type: String

Pattern: ^vpc-[-a-f0-9]{8}([-a-f0-9]{9})?$

Errors

(33)

See Also

DeleteApplication

Deletes an AWS Migration Hub Refactor Spaces application. Before you can delete an application, you must ﬁrst delete any services or routes within the application.

Request Syntax

DELETE /environments/EnvironmentIdentifier/applications/ApplicationIdentifier HTTP/1.1

URI Request Parameters

ApplicationIdentiﬁer (p. 27) The ID of the application.

Required: Yes

EnvironmentIdentiﬁer (p. 27) The ID of the environment.

Required: Yes

Request Body

The request does not have a request body.

Response Syntax

HTTP/1.1 200

"State": "string"

}

Response Elements

(35)

Errors

The ID of the application.

Type: String

Arn (p. 27)

The Amazon Resource Name (ARN) of the application.

Type: String

$

The unique identiﬁer of the application’s environment.

Type: String

State (p. 27)

Type: String

Valid Values: CREATING | ACTIVE | DELETING | FAILED | UPDATING

Errors

(36)

See Also

DeleteEnvironment

Deletes an AWS Migration Hub Refactor Spaces environment. Before you can delete an environment, you must ﬁrst delete any applications and services within the environment.

Request Syntax

DELETE /environments/EnvironmentIdentifier HTTP/1.1

URI Request Parameters

Required: Yes

Request Body

Response Syntax

HTTP/1.1 200

Content-type: application/json { "Arn": "string",

"State": "string"

}

Response Elements

Arn (p. 30)

Type: String

(38)

Errors

$

Type: String

State (p. 30)

The current state of the environment.

Type: String

Valid Values: CREATING | ACTIVE | DELETING | FAILED

Errors

(39)

See Also

ThrottlingException

DeleteResourcePolicy

Deletes the resource policy set for the environment.

Request Syntax

DELETE /resourcepolicy/Identifier HTTP/1.1

URI Request Parameters

Identiﬁer (p. 33)

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

$

Required: Yes

Request Body

Response Syntax

HTTP/1.1 200

Response Elements

If the action is successful, the service sends back an HTTP 200 response with an empty HTTP body.

Errors

(41)

See Also

DeleteRoute

Deletes an AWS Migration Hub Refactor Spaces route.

Request Syntax

DELETE /environments/EnvironmentIdentifier/applications/ApplicationIdentifier/

routes/RouteIdentifier HTTP/1.1

URI Request Parameters

The ID of the application to delete the route from.

Required: Yes

The ID of the environment to delete the route from.

Required: Yes RouteIdentiﬁer (p. 35)

The ID of the route to delete.

Required: Yes

Request Body

Response Syntax

HTTP/1.1 200

"LastUpdatedTime": number,

(43)

Response Elements

"RouteId": "string", "ServiceId": "string", "State": "string"

}

Response Elements

The ID of the application that the route belongs to.

Type: String

Arn (p. 35)

The Amazon Resource Name (ARN) of the route.

Type: String

$

A timestamp that indicates when the route was last updated.

Type: Timestamp RouteId (p. 35)

The ID of the route to delete.

Type: String

The ID of the service that the route belongs to.

Type: String

State (p. 35)

The current state of the route.

Type: String

(44)

Errors

DeleteService

Deletes an AWS Migration Hub Refactor Spaces service.

Request Syntax

DELETE /environments/EnvironmentIdentifier/applications/ApplicationIdentifier/

services/ServiceIdentifier HTTP/1.1

URI Request Parameters

Deletes a Refactor Spaces service.

NoteThe RefactorSpacesSecurityGroup security group must be removed from all AWS resources in the virtual private cloud (VPC) prior to deleting a service with a URL endpoint in a VPC.

Required: Yes

The ID of the environment that the service is in.

Required: Yes ServiceIdentiﬁer (p. 38)

The ID of the service to delete.

Required: Yes

Request Body

Response Syntax

HTTP/1.1 200

Content-type: application/json

(46)

Response Elements

{ "ApplicationId": "string", "Arn": "string",

"ServiceId": "string", "State": "string"

}

Response Elements

The ID of the application that the service is in.

Type: String

Arn (p. 38)

The Amazon Resource Name (ARN) of the service.

Type: String

$

Type: String

A timestamp that indicates when the service was last updated.

Type: String

(47)

Errors

The unique identiﬁer of the service.

Type: String

State (p. 38)

The current state of the service.

Type: String

Valid Values: CREATING | ACTIVE | DELETING | FAILED

Errors

GetApplication

Gets an AWS Migration Hub Refactor Spaces application.

Request Syntax

GET /environments/EnvironmentIdentifier/applications/ApplicationIdentifier HTTP/1.1

URI Request Parameters

ApplicationIdentiﬁer (p. 42) The ID of the application.

Required: Yes

Request Body

Response Syntax

HTTP/1.1 200

Content-type: application/json { "ApiGatewayProxy": { "ApiGatewayId": "string", "EndpointType": "string", "NlbArn": "string", "NlbName": "string", "ProxyUrl": "string", "StageName": "string", "VpcLinkId": "string"

},

"ApplicationId": "string", "Arn": "string",

"EnvironmentId": "string",

(50)

Response Elements

"Error": {

"AccountId": "string", "AdditionalDetails": { "string" : "string"

},

"Code": "string", "Message": "string",

"ResourceIdentifier": "string", "ResourceType": "string"

},

"OwnerAccountId": "string", "ProxyType": "string", "State": "string", "Tags": {

},

"VpcId": "string"

}

Response Elements

The endpoint URL of the API Gateway proxy.

Type: ApiGatewayProxyConﬁg (p. 87) object ApplicationId (p. 42)

The unique identiﬁer of the application.

Type: String

Arn (p. 42)

The Amazon Resource Name (ARN) of the application.

Type: String

$

The AWS account ID of the application creator.

Type: String

Pattern: ^\d{12}$

(51)

Response Elements

A timestamp that indicates when the application is created.

Type: Timestamp EnvironmentId (p. 42)

Type: String

Error (p. 42)

Any error associated with the application resource.

Type: ErrorResponse (p. 100) object LastUpdatedTime (p. 42)

A timestamp that indicates when the application was last updated.

Type: String

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

Type: String

Pattern: ^\d{12}$

ProxyType (p. 42)

Type: String

Valid Values: API_GATEWAY State (p. 42)

Type: String

Valid Values: CREATING | ACTIVE | DELETING | FAILED | UPDATING Tags (p. 42)

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

(52)

Errors

VpcId (p. 42)

The ID of the virtual private cloud (VPC).

Type: String

Pattern: ^vpc-[-a-f0-9]{8}([-a-f0-9]{9})?$

Errors

GetEnvironment

Gets an AWS Migration Hub Refactor Spaces environment.

Request Syntax

GET /environments/EnvironmentIdentifier HTTP/1.1

URI Request Parameters

Required: Yes

Request Body

Response Syntax

HTTP/1.1 200

Content-type: application/json { "Arn": "string",

"CreatedTime": number, "Description": "string", "EnvironmentId": "string", "Error": {

"AccountId": "string", "AdditionalDetails": { "string" : "string"

},

"Code": "string", "Message": "string",

"ResourceIdentifier": "string", "ResourceType": "string"

},

"NetworkFabricType": "string", "OwnerAccountId": "string", "State": "string",

"Tags": {

},

"TransitGatewayId": "string"

}

(55)

Response Elements

Arn (p. 47)

Type: String

$

A timestamp that indicates when the environment is created.

The description of the environment.

Type: String

Pattern: ^[a-zA-Z0-9-_\s\.\!\*\#\@\']+$

Type: String

Error (p. 47)

Any error associated with the environment resource.

Type: ErrorResponse (p. 100) object LastUpdatedTime (p. 47)

Type: String

AWS Migration Hub Refactor Spaces API Reference Version latest

AWS Migration Hub Refactor Spaces

API Reference

Version latest

AWS Migration Hub Refactor Spaces: API Reference

Table of Contents

Welcome

Actions

CreateApplication

Request Syntax

URI Request Parameters

Request Body

Response Syntax

Response Elements

Errors

See Also

CreateEnvironment

Request Syntax

URI Request Parameters

Request Body

Response Syntax

Response Elements

Errors

See Also

CreateRoute

Request Syntax

URI Request Parameters

Request Body

Response Syntax

Response Elements

Errors

See Also

CreateService

Request Syntax

URI Request Parameters

Request Body

Response Syntax

Response Elements

Errors

See Also

DeleteApplication

Request Syntax

URI Request Parameters

Request Body

Response Syntax

Response Elements

Errors

See Also

DeleteEnvironment

Request Syntax

URI Request Parameters

Request Body

Response Syntax

Response Elements

Errors

See Also

DeleteResourcePolicy

Request Syntax

URI Request Parameters

Request Body

Response Syntax

Response Elements

Errors

See Also

DeleteRoute

Request Syntax

URI Request Parameters

Request Body

Response Syntax

Response Elements

Errors

See Also

DeleteService

Request Syntax

URI Request Parameters

Request Body

Response Syntax

Response Elements

Errors

See Also