# Actions


The following actions are supported:
+  [CreateApplication](API_CreateApplication.md) 
+  [CreateEnvironment](API_CreateEnvironment.md) 
+  [CreateRoute](API_CreateRoute.md) 
+  [CreateService](API_CreateService.md) 
+  [DeleteApplication](API_DeleteApplication.md) 
+  [DeleteEnvironment](API_DeleteEnvironment.md) 
+  [DeleteResourcePolicy](API_DeleteResourcePolicy.md) 
+  [DeleteRoute](API_DeleteRoute.md) 
+  [DeleteService](API_DeleteService.md) 
+  [GetApplication](API_GetApplication.md) 
+  [GetEnvironment](API_GetEnvironment.md) 
+  [GetResourcePolicy](API_GetResourcePolicy.md) 
+  [GetRoute](API_GetRoute.md) 
+  [GetService](API_GetService.md) 
+  [ListApplications](API_ListApplications.md) 
+  [ListEnvironments](API_ListEnvironments.md) 
+  [ListEnvironmentVpcs](API_ListEnvironmentVpcs.md) 
+  [ListRoutes](API_ListRoutes.md) 
+  [ListServices](API_ListServices.md) 
+  [ListTagsForResource](API_ListTagsForResource.md) 
+  [PutResourcePolicy](API_PutResourcePolicy.md) 
+  [TagResource](API_TagResource.md) 
+  [UntagResource](API_UntagResource.md) 
+  [UpdateRoute](API_UpdateRoute.md) 

# CreateApplication


**Note**  
 AWS Migration Hub is no longer open to new customers as of November 7, 2025. For capabilities similar to AWS Migration Hub, explore [AWS Migration Hub](https://aws.amazon.com/transform).

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.

In environments created with a [CreateEnvironment:NetworkFabricType](https://docs.aws.amazon.com/migrationhub-refactor-spaces/latest/APIReference/API_CreateEnvironment.html#migrationhubrefactorspaces-CreateEnvironment-request-NetworkFabricType) of `NONE` you need to configure [ VPC to VPC connectivity](https://docs.aws.amazon.com/whitepapers/latest/aws-vpc-connectivity-options/amazon-vpc-to-amazon-vpc-connectivity-options.html) between your service VPC and the application proxy VPC to route traffic through the application proxy to a service with a private URL endpoint. For more information, see [ Create an application](https://docs.aws.amazon.com/migrationhub-refactor-spaces/latest/userguide/getting-started-create-application.html) in the *Refactor Spaces User Guide*. 

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

 ** [EnvironmentIdentifier](#API_CreateApplication_RequestSyntax) **   <a name="migrationhubrefactorspaces-CreateApplication-request-uri-EnvironmentIdentifier"></a>
The unique identifier 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](#API_CreateApplication_RequestSyntax) **   <a name="migrationhubrefactorspaces-CreateApplication-request-ApiGatewayProxy"></a>
A wrapper object holding the API Gateway endpoint type and stage name for the proxy.   
Type: [ApiGatewayProxyInput](API_ApiGatewayProxyInput.md) object  
Required: No

 ** [ClientToken](#API_CreateApplication_RequestSyntax) **   <a name="migrationhubrefactorspaces-CreateApplication-request-ClientToken"></a>
A unique, case-sensitive identifier that you provide to ensure the idempotency of the request.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 64.  
Pattern: `[\x20-\x7E]{1,64}`   
Required: No

 ** [Name](#API_CreateApplication_RequestSyntax) **   <a name="migrationhubrefactorspaces-CreateApplication-request-Name"></a>
The name to use for the application.   
Type: String  
Length Constraints: Minimum length of 3. Maximum length of 63.  
Pattern: `(?!app-)[a-zA-Z0-9]+[a-zA-Z0-9-_ ]+`   
Required: Yes

 ** [ProxyType](#API_CreateApplication_RequestSyntax) **   <a name="migrationhubrefactorspaces-CreateApplication-request-ProxyType"></a>
The proxy type of the proxy created within the application.   
Type: String  
Valid Values: `API_GATEWAY`   
Required: Yes

 ** [Tags](#API_CreateApplication_RequestSyntax) **   <a name="migrationhubrefactorspaces-CreateApplication-request-Tags"></a>
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](#API_CreateApplication_RequestSyntax) **   <a name="migrationhubrefactorspaces-CreateApplication-request-VpcId"></a>
The ID of the virtual private cloud (VPC).  
Type: String  
Length Constraints: Minimum length of 12. Maximum length of 21.  
Pattern: `vpc-[-a-f0-9]{8}([-a-f0-9]{9})?`   
Required: Yes

## Response Syntax


```
HTTP/1.1 200
Content-type: application/json

{
   "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.

 ** [ApiGatewayProxy](#API_CreateApplication_ResponseSyntax) **   <a name="migrationhubrefactorspaces-CreateApplication-response-ApiGatewayProxy"></a>
A wrapper object holding the API Gateway endpoint type and stage name for the proxy.   
Type: [ApiGatewayProxyInput](API_ApiGatewayProxyInput.md) object

 ** [ApplicationId](#API_CreateApplication_ResponseSyntax) **   <a name="migrationhubrefactorspaces-CreateApplication-response-ApplicationId"></a>
The unique identifier of the application.  
Type: String  
Length Constraints: Fixed length of 14.  
Pattern: `app-[0-9A-Za-z]{10}` 

 ** [Arn](#API_CreateApplication_ResponseSyntax) **   <a name="migrationhubrefactorspaces-CreateApplication-response-Arn"></a>
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)](https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html) in the * AWS General Reference*.  
Type: String  
Length Constraints: Minimum length of 20. Maximum length of 2048.  
Pattern: `arn:aws:refactor-spaces:[a-zA-Z0-9\-]+:\w{12}:[a-zA-Z_0-9+=,.@\-_/]+` 

 ** [CreatedByAccountId](#API_CreateApplication_ResponseSyntax) **   <a name="migrationhubrefactorspaces-CreateApplication-response-CreatedByAccountId"></a>
The AWS account ID of application creator.  
Type: String  
Length Constraints: Fixed length of 12.  
Pattern: `\d{12}` 

 ** [CreatedTime](#API_CreateApplication_ResponseSyntax) **   <a name="migrationhubrefactorspaces-CreateApplication-response-CreatedTime"></a>
A timestamp that indicates when the application is created.  
Type: Timestamp

 ** [EnvironmentId](#API_CreateApplication_ResponseSyntax) **   <a name="migrationhubrefactorspaces-CreateApplication-response-EnvironmentId"></a>
The ID of the environment in which the application is created.  
Type: String  
Length Constraints: Fixed length of 14.  
Pattern: `env-[0-9A-Za-z]{10}` 

 ** [LastUpdatedTime](#API_CreateApplication_ResponseSyntax) **   <a name="migrationhubrefactorspaces-CreateApplication-response-LastUpdatedTime"></a>
A timestamp that indicates when the application was last updated.   
Type: Timestamp

 ** [Name](#API_CreateApplication_ResponseSyntax) **   <a name="migrationhubrefactorspaces-CreateApplication-response-Name"></a>
The name of the application.  
Type: String  
Length Constraints: Minimum length of 3. Maximum length of 63.  
Pattern: `(?!app-)[a-zA-Z0-9]+[a-zA-Z0-9-_ ]+` 

 ** [OwnerAccountId](#API_CreateApplication_ResponseSyntax) **   <a name="migrationhubrefactorspaces-CreateApplication-response-OwnerAccountId"></a>
The AWS account ID of the application owner (which is always the same as the environment owner account ID).  
Type: String  
Length Constraints: Fixed length of 12.  
Pattern: `\d{12}` 

 ** [ProxyType](#API_CreateApplication_ResponseSyntax) **   <a name="migrationhubrefactorspaces-CreateApplication-response-ProxyType"></a>
The proxy type of the proxy created within the application.   
Type: String  
Valid Values: `API_GATEWAY` 

 ** [State](#API_CreateApplication_ResponseSyntax) **   <a name="migrationhubrefactorspaces-CreateApplication-response-State"></a>
The current state of the application.   
Type: String  
Valid Values: `CREATING | ACTIVE | DELETING | FAILED | UPDATING` 

 ** [Tags](#API_CreateApplication_ResponseSyntax) **   <a name="migrationhubrefactorspaces-CreateApplication-response-Tags"></a>
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.   
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.

 ** [VpcId](#API_CreateApplication_ResponseSyntax) **   <a name="migrationhubrefactorspaces-CreateApplication-response-VpcId"></a>
The ID of the Amazon VPC.   
Type: String  
Length Constraints: Minimum length of 12. Maximum length of 21.  
Pattern: `vpc-[-a-f0-9]{8}([-a-f0-9]{9})?` 

## Errors


For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

 ** AccessDeniedException **   
The user does not have sufficient access to perform this action.   
HTTP Status Code: 403

 ** ConflictException **   
Updating or deleting a resource can cause an inconsistent state.    
 ** ResourceId **   
The ID of the resource.   
 ** ResourceType **   
The type of resource. 
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.     
 ** ResourceId **   
The ID of the resource.   
 ** ResourceType **   
The type of resource. 
HTTP Status Code: 404

 ** ServiceQuotaExceededException **   
The request would cause a service quota to be exceeded.     
 ** QuotaCode **   
Service quota requirement to identify originating quota. Reached throttling quota exception.   
 ** ResourceId **   
The ID of the resource.   
 ** ResourceType **   
The type of resource.   
 ** ServiceCode **   
Service quota requirement to identify originating service. Reached throttling quota exception service code. 
HTTP Status Code: 402

 ** ThrottlingException **   
Request was denied because the request was throttled.     
 ** QuotaCode **   
Service quota requirement to identify originating quota. Reached throttling quota exception.   
 ** RetryAfterSeconds **   
The number of seconds to wait before retrying.   
 ** ServiceCode **   
Service quota requirement to identify originating service. Reached throttling quota exception service code. 
HTTP Status Code: 429

 ** ValidationException **   
The input does not satisfy the constraints specified by an AWS service.   
HTTP Status Code: 400

## See Also


For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/migration-hub-refactor-spaces-2021-10-26/CreateApplication) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/migration-hub-refactor-spaces-2021-10-26/CreateApplication) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/migration-hub-refactor-spaces-2021-10-26/CreateApplication) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/migration-hub-refactor-spaces-2021-10-26/CreateApplication) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/migration-hub-refactor-spaces-2021-10-26/CreateApplication) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/migration-hub-refactor-spaces-2021-10-26/CreateApplication) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/migration-hub-refactor-spaces-2021-10-26/CreateApplication) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/migration-hub-refactor-spaces-2021-10-26/CreateApplication) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/migration-hub-refactor-spaces-2021-10-26/CreateApplication) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/migration-hub-refactor-spaces-2021-10-26/CreateApplication) 

# CreateEnvironment


**Note**  
 AWS Migration Hub is no longer open to new customers as of November 7, 2025. For capabilities similar to AWS Migration Hub, explore [AWS Migration Hub](https://aws.amazon.com/transform).

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 with a [CreateEnvironment:NetworkFabricType](https://docs.aws.amazon.com/migrationhub-refactor-spaces/latest/APIReference/API_CreateEnvironment.html#migrationhubrefactorspaces-CreateEnvironment-request-NetworkFabricType) of `TRANSIT_GATEWAY`, Refactor Spaces provisions a transit gateway to enable services in VPCs to communicate directly across accounts. If [CreateEnvironment:NetworkFabricType](https://docs.aws.amazon.com/migrationhub-refactor-spaces/latest/APIReference/API_CreateEnvironment.html#migrationhubrefactorspaces-CreateEnvironment-request-NetworkFabricType) is `NONE`, Refactor Spaces does not create a transit gateway and you must use your network infrastructure to route traffic to services with private URL endpoints.

## 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


The request accepts the following data in JSON format.

 ** [ClientToken](#API_CreateEnvironment_RequestSyntax) **   <a name="migrationhubrefactorspaces-CreateEnvironment-request-ClientToken"></a>
A unique, case-sensitive identifier that you provide to ensure the idempotency of the request.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 64.  
Pattern: `[\x20-\x7E]{1,64}`   
Required: No

 ** [Description](#API_CreateEnvironment_RequestSyntax) **   <a name="migrationhubrefactorspaces-CreateEnvironment-request-Description"></a>
The description of the environment.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 256.  
Pattern: `[a-zA-Z0-9-_\s\.\!\*\#\@\']+`   
Required: No

 ** [Name](#API_CreateEnvironment_RequestSyntax) **   <a name="migrationhubrefactorspaces-CreateEnvironment-request-Name"></a>
The name of the environment.  
Type: String  
Length Constraints: Minimum length of 3. Maximum length of 63.  
Pattern: `(?!env-)[a-zA-Z0-9]+[a-zA-Z0-9-_ ]+`   
Required: Yes

 ** [NetworkFabricType](#API_CreateEnvironment_RequestSyntax) **   <a name="migrationhubrefactorspaces-CreateEnvironment-request-NetworkFabricType"></a>
The network fabric type of the environment.  
Type: String  
Valid Values: `TRANSIT_GATEWAY | NONE`   
Required: Yes

 ** [Tags](#API_CreateEnvironment_RequestSyntax) **   <a name="migrationhubrefactorspaces-CreateEnvironment-request-Tags"></a>
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.  
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

## 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": { 
      "string" : "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.

 ** [Arn](#API_CreateEnvironment_ResponseSyntax) **   <a name="migrationhubrefactorspaces-CreateEnvironment-response-Arn"></a>
The Amazon Resource Name (ARN) of the environment.  
Type: String  
Length Constraints: Minimum length of 20. Maximum length of 2048.  
Pattern: `arn:aws:refactor-spaces:[a-zA-Z0-9\-]+:\w{12}:[a-zA-Z_0-9+=,.@\-_/]+` 

 ** [CreatedTime](#API_CreateEnvironment_ResponseSyntax) **   <a name="migrationhubrefactorspaces-CreateEnvironment-response-CreatedTime"></a>
A timestamp that indicates when the environment is created.  
Type: Timestamp

 ** [Description](#API_CreateEnvironment_ResponseSyntax) **   <a name="migrationhubrefactorspaces-CreateEnvironment-response-Description"></a>
A description of the environment.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 256.  
Pattern: `[a-zA-Z0-9-_\s\.\!\*\#\@\']+` 

 ** [EnvironmentId](#API_CreateEnvironment_ResponseSyntax) **   <a name="migrationhubrefactorspaces-CreateEnvironment-response-EnvironmentId"></a>
The unique identifier of the environment.  
Type: String  
Length Constraints: Fixed length of 14.  
Pattern: `env-[0-9A-Za-z]{10}` 

 ** [LastUpdatedTime](#API_CreateEnvironment_ResponseSyntax) **   <a name="migrationhubrefactorspaces-CreateEnvironment-response-LastUpdatedTime"></a>
A timestamp that indicates when the environment was last updated.  
Type: Timestamp

 ** [Name](#API_CreateEnvironment_ResponseSyntax) **   <a name="migrationhubrefactorspaces-CreateEnvironment-response-Name"></a>
The name of the environment.  
Type: String  
Length Constraints: Minimum length of 3. Maximum length of 63.  
Pattern: `(?!env-)[a-zA-Z0-9]+[a-zA-Z0-9-_ ]+` 

 ** [NetworkFabricType](#API_CreateEnvironment_ResponseSyntax) **   <a name="migrationhubrefactorspaces-CreateEnvironment-response-NetworkFabricType"></a>
The network fabric type of the environment.  
Type: String  
Valid Values: `TRANSIT_GATEWAY | NONE` 

 ** [OwnerAccountId](#API_CreateEnvironment_ResponseSyntax) **   <a name="migrationhubrefactorspaces-CreateEnvironment-response-OwnerAccountId"></a>
The AWS account ID of environment owner.  
Type: String  
Length Constraints: Fixed length of 12.  
Pattern: `\d{12}` 

 ** [State](#API_CreateEnvironment_ResponseSyntax) **   <a name="migrationhubrefactorspaces-CreateEnvironment-response-State"></a>
The current state of the environment.   
Type: String  
Valid Values: `CREATING | ACTIVE | DELETING | FAILED` 

 ** [Tags](#API_CreateEnvironment_ResponseSyntax) **   <a name="migrationhubrefactorspaces-CreateEnvironment-response-Tags"></a>
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..  
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.

## Errors


For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

 ** AccessDeniedException **   
The user does not have sufficient access to perform this action.   
HTTP Status Code: 403

 ** ConflictException **   
Updating or deleting a resource can cause an inconsistent state.    
 ** ResourceId **   
The ID of the resource.   
 ** ResourceType **   
The type of resource. 
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.     
 ** ResourceId **   
The ID of the resource.   
 ** ResourceType **   
The type of resource. 
HTTP Status Code: 404

 ** ServiceQuotaExceededException **   
The request would cause a service quota to be exceeded.     
 ** QuotaCode **   
Service quota requirement to identify originating quota. Reached throttling quota exception.   
 ** ResourceId **   
The ID of the resource.   
 ** ResourceType **   
The type of resource.   
 ** ServiceCode **   
Service quota requirement to identify originating service. Reached throttling quota exception service code. 
HTTP Status Code: 402

 ** ThrottlingException **   
Request was denied because the request was throttled.     
 ** QuotaCode **   
Service quota requirement to identify originating quota. Reached throttling quota exception.   
 ** RetryAfterSeconds **   
The number of seconds to wait before retrying.   
 ** ServiceCode **   
Service quota requirement to identify originating service. Reached throttling quota exception service code. 
HTTP Status Code: 429

 ** ValidationException **   
The input does not satisfy the constraints specified by an AWS service.   
HTTP Status Code: 400

## See Also


For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/migration-hub-refactor-spaces-2021-10-26/CreateEnvironment) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/migration-hub-refactor-spaces-2021-10-26/CreateEnvironment) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/migration-hub-refactor-spaces-2021-10-26/CreateEnvironment) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/migration-hub-refactor-spaces-2021-10-26/CreateEnvironment) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/migration-hub-refactor-spaces-2021-10-26/CreateEnvironment) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/migration-hub-refactor-spaces-2021-10-26/CreateEnvironment) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/migration-hub-refactor-spaces-2021-10-26/CreateEnvironment) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/migration-hub-refactor-spaces-2021-10-26/CreateEnvironment) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/migration-hub-refactor-spaces-2021-10-26/CreateEnvironment) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/migration-hub-refactor-spaces-2021-10-26/CreateEnvironment) 

# CreateRoute


**Note**  
 AWS Migration Hub is no longer open to new customers as of November 7, 2025. For capabilities similar to AWS Migration Hub, explore [AWS Migration Hub](https://aws.amazon.com/transform).

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 first route must be created as a `DEFAULT` `RouteType`.

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

Refactor Spaces supports routes with [path parameters](https://docs.aws.amazon.com/apigateway/latest/developerguide/http-api-develop-routes.html). Path parameters are contained in curly braces. For example: `/users/{id}`, where `{id}` represents the parameter that is forwarded to the service. When using path parameters with Lambda services, the path parameters are parsed by API Gateway and are added to the Lambda [event object](https://docs.aws.amazon.com/apigateway/latest/developerguide/set-up-lambda-proxy-integrations.html#api-gateway-simple-proxy-for-lambda-input-format).

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

  If the service has a URL endpoint, and the endpoint resolves to a private IP address, Refactor Spaces routes traffic using the API Gateway VPC link. If a service endpoint resolves to a public IP address, Refactor Spaces routes traffic over the public internet. Services can have HTTP or HTTPS URL endpoints. For HTTPS URLs, publicly-signed certificates are supported. Private Certificate Authorities (CAs) are permitted only if the CA's domain is also publicly resolvable. 

  Refactor Spaces automatically resolves the public Domain Name System (DNS) names that are set in `CreateService:UrlEndpoint `when you create a service. The DNS names resolve when the DNS time-to-live (TTL) expires, or every 60 seconds for TTLs less than 60 seconds. This periodic DNS resolution ensures that the route configuration remains up-to-date. 

  When using path parameters for URL endpoints, you must set AppendSourcePath to TRUE for Refactor Spaces to append the source path to the destination service URL endpoint. For example, given a service endpoint URL of `http://pets-svc/petclinic/api` and a route source path of `/pets/{id}`, Refactor Spaces appends the source path to the service endpoint URL. The path routed to the service will be `http://pets-svc/petclinic/api/pets/{id}`.For URL endpoints, your service must parse the parameters.

  
+  **One-time health check** 

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

  For private URLs, a target group is created on the Network Load Balancer and the load balancer target group runs default target health checks. By default, the health check is run against the service endpoint URL. Optionally, the health check can be performed against a different protocol, port, and/or path using the [CreateService:UrlEndpoint](https://docs.aws.amazon.com/migrationhub-refactor-spaces/latest/APIReference/API_CreateService.html#migrationhubrefactorspaces-CreateService-request-UrlEndpoint) parameter. All other health check settings for the load balancer use the default values described in the [Health checks for your target groups](https://docs.aws.amazon.com/elasticloadbalancing/latest/application/target-group-health-checks.html) in the *Elastic Load Balancing guide*. The health check is considered successful if at least one target within the target group transitions to a healthy state.

  
+  ** AWS Lambda function endpoints** 

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

  The Lambda function state is checked. If the function is not active, the function configuration is updated so that Lambda resources are provisioned. If the Lambda state is `Failed`, then the route creation fails. For more information, see the [GetFunctionConfiguration's State response parameter](https://docs.aws.amazon.com/lambda/latest/dg/API_GetFunctionConfiguration.html#SSS-GetFunctionConfiguration-response-State) in the * AWS Lambda Developer Guide*.

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

  When using path parameters with AWS Lambda function endpoints, the path parameters are parsed by API Gateway and are added to the Lambda event object.

 **Environments without a network bridge** 

When you create environments without a network bridge ([CreateEnvironment:NetworkFabricType](https://docs.aws.amazon.com/migrationhub-refactor-spaces/latest/APIReference/API_CreateEnvironment.html#migrationhubrefactorspaces-CreateEnvironment-request-NetworkFabricType) is `NONE)` and you use your own networking infrastructure, you need to configure [VPC to VPC connectivity](https://docs.aws.amazon.com/whitepapers/latest/aws-vpc-connectivity-options/amazon-vpc-to-amazon-vpc-connectivity-options.html) between your network and the application proxy VPC. Route creation from the application proxy to service endpoints will fail if your network is not configured to connect to the application proxy VPC. For more information, see [ Create a route](https://docs.aws.amazon.com/migrationhub-refactor-spaces/latest/userguide/getting-started-create-role.html) in the *Refactor Spaces User Guide*.



## Request Syntax


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

{
   "ClientToken": "string",
   "DefaultRoute": { 
      "ActivationState": "string"
   },
   "RouteType": "string",
   "ServiceIdentifier": "string",
   "Tags": { 
      "string" : "string" 
   },
   "UriPathRoute": { 
      "ActivationState": "string",
      "AppendSourcePath": boolean,
      "IncludeChildPaths": boolean,
      "Methods": [ "string" ],
      "SourcePath": "string"
   }
}
```

## URI Request Parameters


The request uses the following URI parameters.

 ** [ApplicationIdentifier](#API_CreateRoute_RequestSyntax) **   <a name="migrationhubrefactorspaces-CreateRoute-request-uri-ApplicationIdentifier"></a>
The ID of the application within which the route is being created.  
Length Constraints: Fixed length of 14.  
Pattern: `app-[0-9A-Za-z]{10}`   
Required: Yes

 ** [EnvironmentIdentifier](#API_CreateRoute_RequestSyntax) **   <a name="migrationhubrefactorspaces-CreateRoute-request-uri-EnvironmentIdentifier"></a>
The ID of the environment in which the route is created.  
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.

 ** [ClientToken](#API_CreateRoute_RequestSyntax) **   <a name="migrationhubrefactorspaces-CreateRoute-request-ClientToken"></a>
A unique, case-sensitive identifier that you provide to ensure the idempotency of the request.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 64.  
Pattern: `[\x20-\x7E]{1,64}`   
Required: No

 ** [DefaultRoute](#API_CreateRoute_RequestSyntax) **   <a name="migrationhubrefactorspaces-CreateRoute-request-DefaultRoute"></a>
 Configuration for the default route type.   
Type: [DefaultRouteInput](API_DefaultRouteInput.md) object  
Required: No

 ** [RouteType](#API_CreateRoute_RequestSyntax) **   <a name="migrationhubrefactorspaces-CreateRoute-request-RouteType"></a>
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.  
Type: String  
Valid Values: `DEFAULT | URI_PATH`   
Required: Yes

 ** [ServiceIdentifier](#API_CreateRoute_RequestSyntax) **   <a name="migrationhubrefactorspaces-CreateRoute-request-ServiceIdentifier"></a>
The ID of the service in which the route is created. Traffic that matches this route is forwarded to this service.  
Type: String  
Length Constraints: Fixed length of 14.  
Pattern: `svc-[0-9A-Za-z]{10}`   
Required: Yes

 ** [Tags](#API_CreateRoute_RequestSyntax) **   <a name="migrationhubrefactorspaces-CreateRoute-request-Tags"></a>
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..   
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

 ** [UriPathRoute](#API_CreateRoute_RequestSyntax) **   <a name="migrationhubrefactorspaces-CreateRoute-request-UriPathRoute"></a>
The configuration for the URI path route type.   
Type: [UriPathRouteInput](API_UriPathRouteInput.md) object  
Required: No

## Response Syntax


```
HTTP/1.1 200
Content-type: application/json

{
   "ApplicationId": "string",
   "Arn": "string",
   "CreatedByAccountId": "string",
   "CreatedTime": number,
   "LastUpdatedTime": number,
   "OwnerAccountId": "string",
   "RouteId": "string",
   "RouteType": "string",
   "ServiceId": "string",
   "State": "string",
   "Tags": { 
      "string" : "string" 
   },
   "UriPathRoute": { 
      "ActivationState": "string",
      "AppendSourcePath": boolean,
      "IncludeChildPaths": boolean,
      "Methods": [ "string" ],
      "SourcePath": "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.

 ** [ApplicationId](#API_CreateRoute_ResponseSyntax) **   <a name="migrationhubrefactorspaces-CreateRoute-response-ApplicationId"></a>
The ID of the application in which the route is created.  
Type: String  
Length Constraints: Fixed length of 14.  
Pattern: `app-[0-9A-Za-z]{10}` 

 ** [Arn](#API_CreateRoute_ResponseSyntax) **   <a name="migrationhubrefactorspaces-CreateRoute-response-Arn"></a>
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)](https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html) in the * AWS General Reference*.  
Type: String  
Length Constraints: Minimum length of 20. Maximum length of 2048.  
Pattern: `arn:aws:refactor-spaces:[a-zA-Z0-9\-]+:\w{12}:[a-zA-Z_0-9+=,.@\-_/]+` 

 ** [CreatedByAccountId](#API_CreateRoute_ResponseSyntax) **   <a name="migrationhubrefactorspaces-CreateRoute-response-CreatedByAccountId"></a>
The AWS account ID of the route creator.  
Type: String  
Length Constraints: Fixed length of 12.  
Pattern: `\d{12}` 

 ** [CreatedTime](#API_CreateRoute_ResponseSyntax) **   <a name="migrationhubrefactorspaces-CreateRoute-response-CreatedTime"></a>
A timestamp that indicates when the route is created.  
Type: Timestamp

 ** [LastUpdatedTime](#API_CreateRoute_ResponseSyntax) **   <a name="migrationhubrefactorspaces-CreateRoute-response-LastUpdatedTime"></a>
A timestamp that indicates when the route was last updated.   
Type: Timestamp

 ** [OwnerAccountId](#API_CreateRoute_ResponseSyntax) **   <a name="migrationhubrefactorspaces-CreateRoute-response-OwnerAccountId"></a>
The AWS account ID of the route owner.  
Type: String  
Length Constraints: Fixed length of 12.  
Pattern: `\d{12}` 

 ** [RouteId](#API_CreateRoute_ResponseSyntax) **   <a name="migrationhubrefactorspaces-CreateRoute-response-RouteId"></a>
The unique identifier of the route.  
Type: String  
Length Constraints: Fixed length of 14.  
Pattern: `rte-[0-9A-Za-z]{10}` 

 ** [RouteType](#API_CreateRoute_ResponseSyntax) **   <a name="migrationhubrefactorspaces-CreateRoute-response-RouteType"></a>
The route type of the route.  
Type: String  
Valid Values: `DEFAULT | URI_PATH` 

 ** [ServiceId](#API_CreateRoute_ResponseSyntax) **   <a name="migrationhubrefactorspaces-CreateRoute-response-ServiceId"></a>
The ID of service in which the route is created. Traffic that matches this route is forwarded to this service.  
Type: String  
Length Constraints: Fixed length of 14.  
Pattern: `svc-[0-9A-Za-z]{10}` 

 ** [State](#API_CreateRoute_ResponseSyntax) **   <a name="migrationhubrefactorspaces-CreateRoute-response-State"></a>
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.  
Type: String  
Valid Values: `CREATING | ACTIVE | DELETING | FAILED | UPDATING | INACTIVE` 

 ** [Tags](#API_CreateRoute_ResponseSyntax) **   <a name="migrationhubrefactorspaces-CreateRoute-response-Tags"></a>
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.   
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.

 ** [UriPathRoute](#API_CreateRoute_ResponseSyntax) **   <a name="migrationhubrefactorspaces-CreateRoute-response-UriPathRoute"></a>
Configuration for the URI path route type.   
Type: [UriPathRouteInput](API_UriPathRouteInput.md) object

## Errors


For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

 ** AccessDeniedException **   
The user does not have sufficient access to perform this action.   
HTTP Status Code: 403

 ** ConflictException **   
Updating or deleting a resource can cause an inconsistent state.    
 ** ResourceId **   
The ID of the resource.   
 ** ResourceType **   
The type of resource. 
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.     
 ** ResourceId **   
The ID of the resource.   
 ** ResourceType **   
The type of resource. 
HTTP Status Code: 404

 ** ServiceQuotaExceededException **   
The request would cause a service quota to be exceeded.     
 ** QuotaCode **   
Service quota requirement to identify originating quota. Reached throttling quota exception.   
 ** ResourceId **   
The ID of the resource.   
 ** ResourceType **   
The type of resource.   
 ** ServiceCode **   
Service quota requirement to identify originating service. Reached throttling quota exception service code. 
HTTP Status Code: 402

 ** ThrottlingException **   
Request was denied because the request was throttled.     
 ** QuotaCode **   
Service quota requirement to identify originating quota. Reached throttling quota exception.   
 ** RetryAfterSeconds **   
The number of seconds to wait before retrying.   
 ** ServiceCode **   
Service quota requirement to identify originating service. Reached throttling quota exception service code. 
HTTP Status Code: 429

 ** ValidationException **   
The input does not satisfy the constraints specified by an AWS service.   
HTTP Status Code: 400

## See Also


For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/migration-hub-refactor-spaces-2021-10-26/CreateRoute) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/migration-hub-refactor-spaces-2021-10-26/CreateRoute) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/migration-hub-refactor-spaces-2021-10-26/CreateRoute) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/migration-hub-refactor-spaces-2021-10-26/CreateRoute) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/migration-hub-refactor-spaces-2021-10-26/CreateRoute) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/migration-hub-refactor-spaces-2021-10-26/CreateRoute) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/migration-hub-refactor-spaces-2021-10-26/CreateRoute) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/migration-hub-refactor-spaces-2021-10-26/CreateRoute) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/migration-hub-refactor-spaces-2021-10-26/CreateRoute) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/migration-hub-refactor-spaces-2021-10-26/CreateRoute) 

# CreateService


**Note**  
 AWS Migration Hub is no longer open to new customers as of November 7, 2025. For capabilities similar to AWS Migration Hub, explore [AWS Migration Hub](https://aws.amazon.com/transform).

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 request uses the following URI parameters.

 ** [ApplicationIdentifier](#API_CreateService_RequestSyntax) **   <a name="migrationhubrefactorspaces-CreateService-request-uri-ApplicationIdentifier"></a>
The ID of the application which the service is created.  
Length Constraints: Fixed length of 14.  
Pattern: `app-[0-9A-Za-z]{10}`   
Required: Yes

 ** [EnvironmentIdentifier](#API_CreateService_RequestSyntax) **   <a name="migrationhubrefactorspaces-CreateService-request-uri-EnvironmentIdentifier"></a>
The ID of the environment in which the service is created.  
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.

 ** [ClientToken](#API_CreateService_RequestSyntax) **   <a name="migrationhubrefactorspaces-CreateService-request-ClientToken"></a>
A unique, case-sensitive identifier that you provide to ensure the idempotency of the request.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 64.  
Pattern: `[\x20-\x7E]{1,64}`   
Required: No

 ** [Description](#API_CreateService_RequestSyntax) **   <a name="migrationhubrefactorspaces-CreateService-request-Description"></a>
The description of the service.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 256.  
Pattern: `[a-zA-Z0-9-_\s\.\!\*\#\@\']+`   
Required: No

 ** [EndpointType](#API_CreateService_RequestSyntax) **   <a name="migrationhubrefactorspaces-CreateService-request-EndpointType"></a>
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](#API_CreateService_RequestSyntax) **   <a name="migrationhubrefactorspaces-CreateService-request-LambdaEndpoint"></a>
The configuration for the Lambda endpoint type.  
Type: [LambdaEndpointInput](API_LambdaEndpointInput.md) object  
Required: No

 ** [Name](#API_CreateService_RequestSyntax) **   <a name="migrationhubrefactorspaces-CreateService-request-Name"></a>
The name of the service.  
Type: String  
Length Constraints: Minimum length of 3. Maximum length of 63.  
Pattern: `(?!svc-)[a-zA-Z0-9]+[a-zA-Z0-9-_ ]+`   
Required: Yes

 ** [Tags](#API_CreateService_RequestSyntax) **   <a name="migrationhubrefactorspaces-CreateService-request-Tags"></a>
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..   
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

 ** [UrlEndpoint](#API_CreateService_RequestSyntax) **   <a name="migrationhubrefactorspaces-CreateService-request-UrlEndpoint"></a>
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.  
Type: [UrlEndpointInput](API_UrlEndpointInput.md) object  
Required: No

 ** [VpcId](#API_CreateService_RequestSyntax) **   <a name="migrationhubrefactorspaces-CreateService-request-VpcId"></a>
The ID of the VPC.  
Type: String  
Length Constraints: Minimum length of 12. Maximum length of 21.  
Pattern: `vpc-[-a-f0-9]{8}([-a-f0-9]{9})?`   
Required: No

## Response Syntax


```
HTTP/1.1 200
Content-type: application/json

{
   "ApplicationId": "string",
   "Arn": "string",
   "CreatedByAccountId": "string",
   "CreatedTime": number,
   "Description": "string",
   "EndpointType": "string",
   "EnvironmentId": "string",
   "LambdaEndpoint": { 
      "Arn": "string"
   },
   "LastUpdatedTime": number,
   "Name": "string",
   "OwnerAccountId": "string",
   "ServiceId": "string",
   "State": "string",
   "Tags": { 
      "string" : "string" 
   },
   "UrlEndpoint": { 
      "HealthUrl": "string",
      "Url": "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.

 ** [ApplicationId](#API_CreateService_ResponseSyntax) **   <a name="migrationhubrefactorspaces-CreateService-response-ApplicationId"></a>
The ID of the application that the created service belongs to.   
Type: String  
Length Constraints: Fixed length of 14.  
Pattern: `app-[0-9A-Za-z]{10}` 

 ** [Arn](#API_CreateService_ResponseSyntax) **   <a name="migrationhubrefactorspaces-CreateService-response-Arn"></a>
The Amazon Resource Name (ARN) of the service.  
Type: String  
Length Constraints: Minimum length of 20. Maximum length of 2048.  
Pattern: `arn:aws:refactor-spaces:[a-zA-Z0-9\-]+:\w{12}:[a-zA-Z_0-9+=,.@\-_/]+` 

 ** [CreatedByAccountId](#API_CreateService_ResponseSyntax) **   <a name="migrationhubrefactorspaces-CreateService-response-CreatedByAccountId"></a>
The AWS account ID of the service creator.  
Type: String  
Length Constraints: Fixed length of 12.  
Pattern: `\d{12}` 

 ** [CreatedTime](#API_CreateService_ResponseSyntax) **   <a name="migrationhubrefactorspaces-CreateService-response-CreatedTime"></a>
A timestamp that indicates when the service is created.  
Type: Timestamp

 ** [Description](#API_CreateService_ResponseSyntax) **   <a name="migrationhubrefactorspaces-CreateService-response-Description"></a>
The description of the created service.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 256.  
Pattern: `[a-zA-Z0-9-_\s\.\!\*\#\@\']+` 

 ** [EndpointType](#API_CreateService_ResponseSyntax) **   <a name="migrationhubrefactorspaces-CreateService-response-EndpointType"></a>
The endpoint type of the service.  
Type: String  
Valid Values: `LAMBDA | URL` 

 ** [EnvironmentId](#API_CreateService_ResponseSyntax) **   <a name="migrationhubrefactorspaces-CreateService-response-EnvironmentId"></a>
The unique identifier of the environment.  
Type: String  
Length Constraints: Fixed length of 14.  
Pattern: `env-[0-9A-Za-z]{10}` 

 ** [LambdaEndpoint](#API_CreateService_ResponseSyntax) **   <a name="migrationhubrefactorspaces-CreateService-response-LambdaEndpoint"></a>
The configuration for the Lambda endpoint type.  
Type: [LambdaEndpointInput](API_LambdaEndpointInput.md) object

 ** [LastUpdatedTime](#API_CreateService_ResponseSyntax) **   <a name="migrationhubrefactorspaces-CreateService-response-LastUpdatedTime"></a>
A timestamp that indicates when the service was last updated.   
Type: Timestamp

 ** [Name](#API_CreateService_ResponseSyntax) **   <a name="migrationhubrefactorspaces-CreateService-response-Name"></a>
The name of the service.  
Type: String  
Length Constraints: Minimum length of 3. Maximum length of 63.  
Pattern: `(?!svc-)[a-zA-Z0-9]+[a-zA-Z0-9-_ ]+` 

 ** [OwnerAccountId](#API_CreateService_ResponseSyntax) **   <a name="migrationhubrefactorspaces-CreateService-response-OwnerAccountId"></a>
The AWS account ID of the service owner.  
Type: String  
Length Constraints: Fixed length of 12.  
Pattern: `\d{12}` 

 ** [ServiceId](#API_CreateService_ResponseSyntax) **   <a name="migrationhubrefactorspaces-CreateService-response-ServiceId"></a>
The unique identifier of the service.  
Type: String  
Length Constraints: Fixed length of 14.  
Pattern: `svc-[0-9A-Za-z]{10}` 

 ** [State](#API_CreateService_ResponseSyntax) **   <a name="migrationhubrefactorspaces-CreateService-response-State"></a>
The current state of the service.   
Type: String  
Valid Values: `CREATING | ACTIVE | DELETING | FAILED` 

 ** [Tags](#API_CreateService_ResponseSyntax) **   <a name="migrationhubrefactorspaces-CreateService-response-Tags"></a>
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..   
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.

 ** [UrlEndpoint](#API_CreateService_ResponseSyntax) **   <a name="migrationhubrefactorspaces-CreateService-response-UrlEndpoint"></a>
The configuration for the URL endpoint type.   
Type: [UrlEndpointInput](API_UrlEndpointInput.md) object

 ** [VpcId](#API_CreateService_ResponseSyntax) **   <a name="migrationhubrefactorspaces-CreateService-response-VpcId"></a>
The ID of the VPC.   
Type: String  
Length Constraints: Minimum length of 12. Maximum length of 21.  
Pattern: `vpc-[-a-f0-9]{8}([-a-f0-9]{9})?` 

## Errors


For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

 ** AccessDeniedException **   
The user does not have sufficient access to perform this action.   
HTTP Status Code: 403

 ** ConflictException **   
Updating or deleting a resource can cause an inconsistent state.    
 ** ResourceId **   
The ID of the resource.   
 ** ResourceType **   
The type of resource. 
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.     
 ** ResourceId **   
The ID of the resource.   
 ** ResourceType **   
The type of resource. 
HTTP Status Code: 404

 ** ServiceQuotaExceededException **   
The request would cause a service quota to be exceeded.     
 ** QuotaCode **   
Service quota requirement to identify originating quota. Reached throttling quota exception.   
 ** ResourceId **   
The ID of the resource.   
 ** ResourceType **   
The type of resource.   
 ** ServiceCode **   
Service quota requirement to identify originating service. Reached throttling quota exception service code. 
HTTP Status Code: 402

 ** ThrottlingException **   
Request was denied because the request was throttled.     
 ** QuotaCode **   
Service quota requirement to identify originating quota. Reached throttling quota exception.   
 ** RetryAfterSeconds **   
The number of seconds to wait before retrying.   
 ** ServiceCode **   
Service quota requirement to identify originating service. Reached throttling quota exception service code. 
HTTP Status Code: 429

 ** ValidationException **   
The input does not satisfy the constraints specified by an AWS service.   
HTTP Status Code: 400

## See Also


For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/migration-hub-refactor-spaces-2021-10-26/CreateService) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/migration-hub-refactor-spaces-2021-10-26/CreateService) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/migration-hub-refactor-spaces-2021-10-26/CreateService) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/migration-hub-refactor-spaces-2021-10-26/CreateService) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/migration-hub-refactor-spaces-2021-10-26/CreateService) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/migration-hub-refactor-spaces-2021-10-26/CreateService) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/migration-hub-refactor-spaces-2021-10-26/CreateService) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/migration-hub-refactor-spaces-2021-10-26/CreateService) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/migration-hub-refactor-spaces-2021-10-26/CreateService) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/migration-hub-refactor-spaces-2021-10-26/CreateService) 

# DeleteApplication


**Note**  
 AWS Migration Hub is no longer open to new customers as of November 7, 2025. For capabilities similar to AWS Migration Hub, explore [AWS Migration Hub](https://aws.amazon.com/transform).

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

## Request Syntax


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

## URI Request Parameters


The request uses the following URI parameters.

 ** [ApplicationIdentifier](#API_DeleteApplication_RequestSyntax) **   <a name="migrationhubrefactorspaces-DeleteApplication-request-uri-ApplicationIdentifier"></a>
The ID of the application.  
Length Constraints: Fixed length of 14.  
Pattern: `app-[0-9A-Za-z]{10}`   
Required: Yes

 ** [EnvironmentIdentifier](#API_DeleteApplication_RequestSyntax) **   <a name="migrationhubrefactorspaces-DeleteApplication-request-uri-EnvironmentIdentifier"></a>
The ID of the environment.   
Length Constraints: Fixed length of 14.  
Pattern: `env-[0-9A-Za-z]{10}`   
Required: Yes

## Request Body


The request does not have a request body.

## Response Syntax


```
HTTP/1.1 200
Content-type: application/json

{
   "ApplicationId": "string",
   "Arn": "string",
   "EnvironmentId": "string",
   "LastUpdatedTime": number,
   "Name": "string",
   "State": "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.

 ** [ApplicationId](#API_DeleteApplication_ResponseSyntax) **   <a name="migrationhubrefactorspaces-DeleteApplication-response-ApplicationId"></a>
The ID of the application.  
Type: String  
Length Constraints: Fixed length of 14.  
Pattern: `app-[0-9A-Za-z]{10}` 

 ** [Arn](#API_DeleteApplication_ResponseSyntax) **   <a name="migrationhubrefactorspaces-DeleteApplication-response-Arn"></a>
The Amazon Resource Name (ARN) of the application.  
Type: String  
Length Constraints: Minimum length of 20. Maximum length of 2048.  
Pattern: `arn:aws:refactor-spaces:[a-zA-Z0-9\-]+:\w{12}:[a-zA-Z_0-9+=,.@\-_/]+` 

 ** [EnvironmentId](#API_DeleteApplication_ResponseSyntax) **   <a name="migrationhubrefactorspaces-DeleteApplication-response-EnvironmentId"></a>
The unique identifier of the application’s environment.  
Type: String  
Length Constraints: Fixed length of 14.  
Pattern: `env-[0-9A-Za-z]{10}` 

 ** [LastUpdatedTime](#API_DeleteApplication_ResponseSyntax) **   <a name="migrationhubrefactorspaces-DeleteApplication-response-LastUpdatedTime"></a>
A timestamp that indicates when the environment was last updated.   
Type: Timestamp

 ** [Name](#API_DeleteApplication_ResponseSyntax) **   <a name="migrationhubrefactorspaces-DeleteApplication-response-Name"></a>
The name of the application.  
Type: String  
Length Constraints: Minimum length of 3. Maximum length of 63.  
Pattern: `(?!app-)[a-zA-Z0-9]+[a-zA-Z0-9-_ ]+` 

 ** [State](#API_DeleteApplication_ResponseSyntax) **   <a name="migrationhubrefactorspaces-DeleteApplication-response-State"></a>
The current state of the application.   
Type: String  
Valid Values: `CREATING | ACTIVE | DELETING | FAILED | UPDATING` 

## Errors


For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

 ** AccessDeniedException **   
The user does not have sufficient access to perform this action.   
HTTP Status Code: 403

 ** ConflictException **   
Updating or deleting a resource can cause an inconsistent state.    
 ** ResourceId **   
The ID of the resource.   
 ** ResourceType **   
The type of resource. 
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.     
 ** ResourceId **   
The ID of the resource.   
 ** ResourceType **   
The type of resource. 
HTTP Status Code: 404

 ** ThrottlingException **   
Request was denied because the request was throttled.     
 ** QuotaCode **   
Service quota requirement to identify originating quota. Reached throttling quota exception.   
 ** RetryAfterSeconds **   
The number of seconds to wait before retrying.   
 ** ServiceCode **   
Service quota requirement to identify originating service. Reached throttling quota exception service code. 
HTTP Status Code: 429

 ** ValidationException **   
The input does not satisfy the constraints specified by an AWS service.   
HTTP Status Code: 400

## See Also


For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/migration-hub-refactor-spaces-2021-10-26/DeleteApplication) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/migration-hub-refactor-spaces-2021-10-26/DeleteApplication) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/migration-hub-refactor-spaces-2021-10-26/DeleteApplication) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/migration-hub-refactor-spaces-2021-10-26/DeleteApplication) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/migration-hub-refactor-spaces-2021-10-26/DeleteApplication) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/migration-hub-refactor-spaces-2021-10-26/DeleteApplication) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/migration-hub-refactor-spaces-2021-10-26/DeleteApplication) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/migration-hub-refactor-spaces-2021-10-26/DeleteApplication) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/migration-hub-refactor-spaces-2021-10-26/DeleteApplication) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/migration-hub-refactor-spaces-2021-10-26/DeleteApplication) 

# DeleteEnvironment


**Note**  
 AWS Migration Hub is no longer open to new customers as of November 7, 2025. For capabilities similar to AWS Migration Hub, explore [AWS Migration Hub](https://aws.amazon.com/transform).

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

## Request Syntax


```
DELETE /environments/EnvironmentIdentifier HTTP/1.1
```

## URI Request Parameters


The request uses the following URI parameters.

 ** [EnvironmentIdentifier](#API_DeleteEnvironment_RequestSyntax) **   <a name="migrationhubrefactorspaces-DeleteEnvironment-request-uri-EnvironmentIdentifier"></a>
The ID of the environment.   
Length Constraints: Fixed length of 14.  
Pattern: `env-[0-9A-Za-z]{10}`   
Required: Yes

## Request Body


The request does not have a request body.

## Response Syntax


```
HTTP/1.1 200
Content-type: application/json

{
   "Arn": "string",
   "EnvironmentId": "string",
   "LastUpdatedTime": number,
   "Name": "string",
   "State": "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.

 ** [Arn](#API_DeleteEnvironment_ResponseSyntax) **   <a name="migrationhubrefactorspaces-DeleteEnvironment-response-Arn"></a>
The Amazon Resource Name (ARN) of the environment.  
Type: String  
Length Constraints: Minimum length of 20. Maximum length of 2048.  
Pattern: `arn:aws:refactor-spaces:[a-zA-Z0-9\-]+:\w{12}:[a-zA-Z_0-9+=,.@\-_/]+` 

 ** [EnvironmentId](#API_DeleteEnvironment_ResponseSyntax) **   <a name="migrationhubrefactorspaces-DeleteEnvironment-response-EnvironmentId"></a>
The unique identifier of the environment.  
Type: String  
Length Constraints: Fixed length of 14.  
Pattern: `env-[0-9A-Za-z]{10}` 

 ** [LastUpdatedTime](#API_DeleteEnvironment_ResponseSyntax) **   <a name="migrationhubrefactorspaces-DeleteEnvironment-response-LastUpdatedTime"></a>
A timestamp that indicates when the environment was last updated.   
Type: Timestamp

 ** [Name](#API_DeleteEnvironment_ResponseSyntax) **   <a name="migrationhubrefactorspaces-DeleteEnvironment-response-Name"></a>
The name of the environment.  
Type: String  
Length Constraints: Minimum length of 3. Maximum length of 63.  
Pattern: `(?!env-)[a-zA-Z0-9]+[a-zA-Z0-9-_ ]+` 

 ** [State](#API_DeleteEnvironment_ResponseSyntax) **   <a name="migrationhubrefactorspaces-DeleteEnvironment-response-State"></a>
The current state of the environment.   
Type: String  
Valid Values: `CREATING | ACTIVE | DELETING | FAILED` 

## Errors


For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

 ** AccessDeniedException **   
The user does not have sufficient access to perform this action.   
HTTP Status Code: 403

 ** ConflictException **   
Updating or deleting a resource can cause an inconsistent state.    
 ** ResourceId **   
The ID of the resource.   
 ** ResourceType **   
The type of resource. 
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.     
 ** ResourceId **   
The ID of the resource.   
 ** ResourceType **   
The type of resource. 
HTTP Status Code: 404

 ** ThrottlingException **   
Request was denied because the request was throttled.     
 ** QuotaCode **   
Service quota requirement to identify originating quota. Reached throttling quota exception.   
 ** RetryAfterSeconds **   
The number of seconds to wait before retrying.   
 ** ServiceCode **   
Service quota requirement to identify originating service. Reached throttling quota exception service code. 
HTTP Status Code: 429

 ** ValidationException **   
The input does not satisfy the constraints specified by an AWS service.   
HTTP Status Code: 400

## See Also


For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/migration-hub-refactor-spaces-2021-10-26/DeleteEnvironment) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/migration-hub-refactor-spaces-2021-10-26/DeleteEnvironment) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/migration-hub-refactor-spaces-2021-10-26/DeleteEnvironment) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/migration-hub-refactor-spaces-2021-10-26/DeleteEnvironment) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/migration-hub-refactor-spaces-2021-10-26/DeleteEnvironment) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/migration-hub-refactor-spaces-2021-10-26/DeleteEnvironment) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/migration-hub-refactor-spaces-2021-10-26/DeleteEnvironment) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/migration-hub-refactor-spaces-2021-10-26/DeleteEnvironment) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/migration-hub-refactor-spaces-2021-10-26/DeleteEnvironment) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/migration-hub-refactor-spaces-2021-10-26/DeleteEnvironment) 

# DeleteResourcePolicy


**Note**  
 AWS Migration Hub is no longer open to new customers as of November 7, 2025. For capabilities similar to AWS Migration Hub, explore [AWS Migration Hub](https://aws.amazon.com/transform).

Deletes the resource policy set for the environment. 

## Request Syntax


```
DELETE /resourcepolicy/Identifier HTTP/1.1
```

## URI Request Parameters


The request uses the following URI parameters.

 ** [Identifier](#API_DeleteResourcePolicy_RequestSyntax) **   <a name="migrationhubrefactorspaces-DeleteResourcePolicy-request-uri-Identifier"></a>
Amazon Resource Name (ARN) of the resource associated with the policy.   
Length Constraints: Minimum length of 20. Maximum length of 2048.  
Pattern: `arn:aws:refactor-spaces:[a-zA-Z0-9\-]+:\w{12}:[a-zA-Z_0-9+=,.@\-_/]+`   
Required: Yes

## Request Body


The request does not have a 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


For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

 ** AccessDeniedException **   
The user does not have sufficient access to perform this action.   
HTTP Status Code: 403

 ** InternalServerException **   
An unexpected error occurred while processing the request.  
HTTP Status Code: 500

 ** ResourceNotFoundException **   
The request references a resource that does not exist.     
 ** ResourceId **   
The ID of the resource.   
 ** ResourceType **   
The type of resource. 
HTTP Status Code: 404

 ** ThrottlingException **   
Request was denied because the request was throttled.     
 ** QuotaCode **   
Service quota requirement to identify originating quota. Reached throttling quota exception.   
 ** RetryAfterSeconds **   
The number of seconds to wait before retrying.   
 ** ServiceCode **   
Service quota requirement to identify originating service. Reached throttling quota exception service code. 
HTTP Status Code: 429

 ** ValidationException **   
The input does not satisfy the constraints specified by an AWS service.   
HTTP Status Code: 400

## See Also


For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/migration-hub-refactor-spaces-2021-10-26/DeleteResourcePolicy) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/migration-hub-refactor-spaces-2021-10-26/DeleteResourcePolicy) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/migration-hub-refactor-spaces-2021-10-26/DeleteResourcePolicy) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/migration-hub-refactor-spaces-2021-10-26/DeleteResourcePolicy) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/migration-hub-refactor-spaces-2021-10-26/DeleteResourcePolicy) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/migration-hub-refactor-spaces-2021-10-26/DeleteResourcePolicy) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/migration-hub-refactor-spaces-2021-10-26/DeleteResourcePolicy) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/migration-hub-refactor-spaces-2021-10-26/DeleteResourcePolicy) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/migration-hub-refactor-spaces-2021-10-26/DeleteResourcePolicy) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/migration-hub-refactor-spaces-2021-10-26/DeleteResourcePolicy) 

# DeleteRoute


**Note**  
 AWS Migration Hub is no longer open to new customers as of November 7, 2025. For capabilities similar to AWS Migration Hub, explore [AWS Migration Hub](https://aws.amazon.com/transform).

Deletes an AWS Migration Hub Refactor Spaces route.

## Request Syntax


```
DELETE /environments/EnvironmentIdentifier/applications/ApplicationIdentifier/routes/RouteIdentifier HTTP/1.1
```

## URI Request Parameters


The request uses the following URI parameters.

 ** [ApplicationIdentifier](#API_DeleteRoute_RequestSyntax) **   <a name="migrationhubrefactorspaces-DeleteRoute-request-uri-ApplicationIdentifier"></a>
The ID of the application to delete the route from.  
Length Constraints: Fixed length of 14.  
Pattern: `app-[0-9A-Za-z]{10}`   
Required: Yes

 ** [EnvironmentIdentifier](#API_DeleteRoute_RequestSyntax) **   <a name="migrationhubrefactorspaces-DeleteRoute-request-uri-EnvironmentIdentifier"></a>
The ID of the environment to delete the route from.  
Length Constraints: Fixed length of 14.  
Pattern: `env-[0-9A-Za-z]{10}`   
Required: Yes

 ** [RouteIdentifier](#API_DeleteRoute_RequestSyntax) **   <a name="migrationhubrefactorspaces-DeleteRoute-request-uri-RouteIdentifier"></a>
The ID of the route to delete.  
Length Constraints: Fixed length of 14.  
Pattern: `rte-[0-9A-Za-z]{10}`   
Required: Yes

## Request Body


The request does not have a request body.

## Response Syntax


```
HTTP/1.1 200
Content-type: application/json

{
   "ApplicationId": "string",
   "Arn": "string",
   "LastUpdatedTime": number,
   "RouteId": "string",
   "ServiceId": "string",
   "State": "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.

 ** [ApplicationId](#API_DeleteRoute_ResponseSyntax) **   <a name="migrationhubrefactorspaces-DeleteRoute-response-ApplicationId"></a>
The ID of the application that the route belongs to.  
Type: String  
Length Constraints: Fixed length of 14.  
Pattern: `app-[0-9A-Za-z]{10}` 

 ** [Arn](#API_DeleteRoute_ResponseSyntax) **   <a name="migrationhubrefactorspaces-DeleteRoute-response-Arn"></a>
The Amazon Resource Name (ARN) of the route.  
Type: String  
Length Constraints: Minimum length of 20. Maximum length of 2048.  
Pattern: `arn:aws:refactor-spaces:[a-zA-Z0-9\-]+:\w{12}:[a-zA-Z_0-9+=,.@\-_/]+` 

 ** [LastUpdatedTime](#API_DeleteRoute_ResponseSyntax) **   <a name="migrationhubrefactorspaces-DeleteRoute-response-LastUpdatedTime"></a>
A timestamp that indicates when the route was last updated.   
Type: Timestamp

 ** [RouteId](#API_DeleteRoute_ResponseSyntax) **   <a name="migrationhubrefactorspaces-DeleteRoute-response-RouteId"></a>
The ID of the route to delete.  
Type: String  
Length Constraints: Fixed length of 14.  
Pattern: `rte-[0-9A-Za-z]{10}` 

 ** [ServiceId](#API_DeleteRoute_ResponseSyntax) **   <a name="migrationhubrefactorspaces-DeleteRoute-response-ServiceId"></a>
The ID of the service that the route belongs to.  
Type: String  
Length Constraints: Fixed length of 14.  
Pattern: `svc-[0-9A-Za-z]{10}` 

 ** [State](#API_DeleteRoute_ResponseSyntax) **   <a name="migrationhubrefactorspaces-DeleteRoute-response-State"></a>
The current state of the route.   
Type: String  
Valid Values: `CREATING | ACTIVE | DELETING | FAILED | UPDATING | INACTIVE` 

## Errors


For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

 ** AccessDeniedException **   
The user does not have sufficient access to perform this action.   
HTTP Status Code: 403

 ** ConflictException **   
Updating or deleting a resource can cause an inconsistent state.    
 ** ResourceId **   
The ID of the resource.   
 ** ResourceType **   
The type of resource. 
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.     
 ** ResourceId **   
The ID of the resource.   
 ** ResourceType **   
The type of resource. 
HTTP Status Code: 404

 ** ThrottlingException **   
Request was denied because the request was throttled.     
 ** QuotaCode **   
Service quota requirement to identify originating quota. Reached throttling quota exception.   
 ** RetryAfterSeconds **   
The number of seconds to wait before retrying.   
 ** ServiceCode **   
Service quota requirement to identify originating service. Reached throttling quota exception service code. 
HTTP Status Code: 429

 ** ValidationException **   
The input does not satisfy the constraints specified by an AWS service.   
HTTP Status Code: 400

## See Also


For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/migration-hub-refactor-spaces-2021-10-26/DeleteRoute) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/migration-hub-refactor-spaces-2021-10-26/DeleteRoute) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/migration-hub-refactor-spaces-2021-10-26/DeleteRoute) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/migration-hub-refactor-spaces-2021-10-26/DeleteRoute) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/migration-hub-refactor-spaces-2021-10-26/DeleteRoute) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/migration-hub-refactor-spaces-2021-10-26/DeleteRoute) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/migration-hub-refactor-spaces-2021-10-26/DeleteRoute) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/migration-hub-refactor-spaces-2021-10-26/DeleteRoute) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/migration-hub-refactor-spaces-2021-10-26/DeleteRoute) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/migration-hub-refactor-spaces-2021-10-26/DeleteRoute) 

# DeleteService


**Note**  
 AWS Migration Hub is no longer open to new customers as of November 7, 2025. For capabilities similar to AWS Migration Hub, explore [AWS Migration Hub](https://aws.amazon.com/transform).

Deletes an AWS Migration Hub Refactor Spaces service. 

## Request Syntax


```
DELETE /environments/EnvironmentIdentifier/applications/ApplicationIdentifier/services/ServiceIdentifier HTTP/1.1
```

## URI Request Parameters


The request uses the following URI parameters.

 ** [ApplicationIdentifier](#API_DeleteService_RequestSyntax) **   <a name="migrationhubrefactorspaces-DeleteService-request-uri-ApplicationIdentifier"></a>
Deletes a Refactor Spaces service.  
The `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.
Length Constraints: Fixed length of 14.  
Pattern: `app-[0-9A-Za-z]{10}`   
Required: Yes

 ** [EnvironmentIdentifier](#API_DeleteService_RequestSyntax) **   <a name="migrationhubrefactorspaces-DeleteService-request-uri-EnvironmentIdentifier"></a>
The ID of the environment that the service is in.  
Length Constraints: Fixed length of 14.  
Pattern: `env-[0-9A-Za-z]{10}`   
Required: Yes

 ** [ServiceIdentifier](#API_DeleteService_RequestSyntax) **   <a name="migrationhubrefactorspaces-DeleteService-request-uri-ServiceIdentifier"></a>
The ID of the service to delete.  
Length Constraints: Fixed length of 14.  
Pattern: `svc-[0-9A-Za-z]{10}`   
Required: Yes

## Request Body


The request does not have a request body.

## Response Syntax


```
HTTP/1.1 200
Content-type: application/json

{
   "ApplicationId": "string",
   "Arn": "string",
   "EnvironmentId": "string",
   "LastUpdatedTime": number,
   "Name": "string",
   "ServiceId": "string",
   "State": "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.

 ** [ApplicationId](#API_DeleteService_ResponseSyntax) **   <a name="migrationhubrefactorspaces-DeleteService-response-ApplicationId"></a>
The ID of the application that the service is in.  
Type: String  
Length Constraints: Fixed length of 14.  
Pattern: `app-[0-9A-Za-z]{10}` 

 ** [Arn](#API_DeleteService_ResponseSyntax) **   <a name="migrationhubrefactorspaces-DeleteService-response-Arn"></a>
The Amazon Resource Name (ARN) of the service.  
Type: String  
Length Constraints: Minimum length of 20. Maximum length of 2048.  
Pattern: `arn:aws:refactor-spaces:[a-zA-Z0-9\-]+:\w{12}:[a-zA-Z_0-9+=,.@\-_/]+` 

 ** [EnvironmentId](#API_DeleteService_ResponseSyntax) **   <a name="migrationhubrefactorspaces-DeleteService-response-EnvironmentId"></a>
The unique identifier of the environment.  
Type: String  
Length Constraints: Fixed length of 14.  
Pattern: `env-[0-9A-Za-z]{10}` 

 ** [LastUpdatedTime](#API_DeleteService_ResponseSyntax) **   <a name="migrationhubrefactorspaces-DeleteService-response-LastUpdatedTime"></a>
A timestamp that indicates when the service was last updated.   
Type: Timestamp

 ** [Name](#API_DeleteService_ResponseSyntax) **   <a name="migrationhubrefactorspaces-DeleteService-response-Name"></a>
The name of the service.  
Type: String  
Length Constraints: Minimum length of 3. Maximum length of 63.  
Pattern: `(?!svc-)[a-zA-Z0-9]+[a-zA-Z0-9-_ ]+` 

 ** [ServiceId](#API_DeleteService_ResponseSyntax) **   <a name="migrationhubrefactorspaces-DeleteService-response-ServiceId"></a>
The unique identifier of the service.  
Type: String  
Length Constraints: Fixed length of 14.  
Pattern: `svc-[0-9A-Za-z]{10}` 

 ** [State](#API_DeleteService_ResponseSyntax) **   <a name="migrationhubrefactorspaces-DeleteService-response-State"></a>
The current state of the service.   
Type: String  
Valid Values: `CREATING | ACTIVE | DELETING | FAILED` 

## Errors


For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

 ** AccessDeniedException **   
The user does not have sufficient access to perform this action.   
HTTP Status Code: 403

 ** ConflictException **   
Updating or deleting a resource can cause an inconsistent state.    
 ** ResourceId **   
The ID of the resource.   
 ** ResourceType **   
The type of resource. 
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.     
 ** ResourceId **   
The ID of the resource.   
 ** ResourceType **   
The type of resource. 
HTTP Status Code: 404

 ** ThrottlingException **   
Request was denied because the request was throttled.     
 ** QuotaCode **   
Service quota requirement to identify originating quota. Reached throttling quota exception.   
 ** RetryAfterSeconds **   
The number of seconds to wait before retrying.   
 ** ServiceCode **   
Service quota requirement to identify originating service. Reached throttling quota exception service code. 
HTTP Status Code: 429

 ** ValidationException **   
The input does not satisfy the constraints specified by an AWS service.   
HTTP Status Code: 400

## See Also


For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/migration-hub-refactor-spaces-2021-10-26/DeleteService) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/migration-hub-refactor-spaces-2021-10-26/DeleteService) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/migration-hub-refactor-spaces-2021-10-26/DeleteService) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/migration-hub-refactor-spaces-2021-10-26/DeleteService) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/migration-hub-refactor-spaces-2021-10-26/DeleteService) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/migration-hub-refactor-spaces-2021-10-26/DeleteService) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/migration-hub-refactor-spaces-2021-10-26/DeleteService) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/migration-hub-refactor-spaces-2021-10-26/DeleteService) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/migration-hub-refactor-spaces-2021-10-26/DeleteService) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/migration-hub-refactor-spaces-2021-10-26/DeleteService) 

# GetApplication


**Note**  
 AWS Migration Hub is no longer open to new customers as of November 7, 2025. For capabilities similar to AWS Migration Hub, explore [AWS Migration Hub](https://aws.amazon.com/transform).

Gets an AWS Migration Hub Refactor Spaces application.

## Request Syntax


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

## URI Request Parameters


The request uses the following URI parameters.

 ** [ApplicationIdentifier](#API_GetApplication_RequestSyntax) **   <a name="migrationhubrefactorspaces-GetApplication-request-uri-ApplicationIdentifier"></a>
The ID of the application.  
Length Constraints: Fixed length of 14.  
Pattern: `app-[0-9A-Za-z]{10}`   
Required: Yes

 ** [EnvironmentIdentifier](#API_GetApplication_RequestSyntax) **   <a name="migrationhubrefactorspaces-GetApplication-request-uri-EnvironmentIdentifier"></a>
The ID of the environment.   
Length Constraints: Fixed length of 14.  
Pattern: `env-[0-9A-Za-z]{10}`   
Required: Yes

## Request Body


The request does not have a 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",
   "CreatedByAccountId": "string",
   "CreatedTime": number,
   "EnvironmentId": "string",
   "Error": { 
      "AccountId": "string",
      "AdditionalDetails": { 
         "string" : "string" 
      },
      "Code": "string",
      "Message": "string",
      "ResourceIdentifier": "string",
      "ResourceType": "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.

 ** [ApiGatewayProxy](#API_GetApplication_ResponseSyntax) **   <a name="migrationhubrefactorspaces-GetApplication-response-ApiGatewayProxy"></a>
The endpoint URL of the API Gateway proxy.   
Type: [ApiGatewayProxyConfig](API_ApiGatewayProxyConfig.md) object

 ** [ApplicationId](#API_GetApplication_ResponseSyntax) **   <a name="migrationhubrefactorspaces-GetApplication-response-ApplicationId"></a>
The unique identifier of the application.  
Type: String  
Length Constraints: Fixed length of 14.  
Pattern: `app-[0-9A-Za-z]{10}` 

 ** [Arn](#API_GetApplication_ResponseSyntax) **   <a name="migrationhubrefactorspaces-GetApplication-response-Arn"></a>
The Amazon Resource Name (ARN) of the application.  
Type: String  
Length Constraints: Minimum length of 20. Maximum length of 2048.  
Pattern: `arn:aws:refactor-spaces:[a-zA-Z0-9\-]+:\w{12}:[a-zA-Z_0-9+=,.@\-_/]+` 

 ** [CreatedByAccountId](#API_GetApplication_ResponseSyntax) **   <a name="migrationhubrefactorspaces-GetApplication-response-CreatedByAccountId"></a>
The AWS account ID of the application creator.   
Type: String  
Length Constraints: Fixed length of 12.  
Pattern: `\d{12}` 

 ** [CreatedTime](#API_GetApplication_ResponseSyntax) **   <a name="migrationhubrefactorspaces-GetApplication-response-CreatedTime"></a>
A timestamp that indicates when the application is created.   
Type: Timestamp

 ** [EnvironmentId](#API_GetApplication_ResponseSyntax) **   <a name="migrationhubrefactorspaces-GetApplication-response-EnvironmentId"></a>
The unique identifier of the environment.  
Type: String  
Length Constraints: Fixed length of 14.  
Pattern: `env-[0-9A-Za-z]{10}` 

 ** [Error](#API_GetApplication_ResponseSyntax) **   <a name="migrationhubrefactorspaces-GetApplication-response-Error"></a>
Any error associated with the application resource.   
Type: [ErrorResponse](API_ErrorResponse.md) object

 ** [LastUpdatedTime](#API_GetApplication_ResponseSyntax) **   <a name="migrationhubrefactorspaces-GetApplication-response-LastUpdatedTime"></a>
A timestamp that indicates when the application was last updated.   
Type: Timestamp

 ** [Name](#API_GetApplication_ResponseSyntax) **   <a name="migrationhubrefactorspaces-GetApplication-response-Name"></a>
The name of the application.  
Type: String  
Length Constraints: Minimum length of 3. Maximum length of 63.  
Pattern: `(?!app-)[a-zA-Z0-9]+[a-zA-Z0-9-_ ]+` 

 ** [OwnerAccountId](#API_GetApplication_ResponseSyntax) **   <a name="migrationhubrefactorspaces-GetApplication-response-OwnerAccountId"></a>
The AWS account ID of the application owner (which is always the same as the environment owner account ID).  
Type: String  
Length Constraints: Fixed length of 12.  
Pattern: `\d{12}` 

 ** [ProxyType](#API_GetApplication_ResponseSyntax) **   <a name="migrationhubrefactorspaces-GetApplication-response-ProxyType"></a>
The proxy type of the proxy created within the application.   
Type: String  
Valid Values: `API_GATEWAY` 

 ** [State](#API_GetApplication_ResponseSyntax) **   <a name="migrationhubrefactorspaces-GetApplication-response-State"></a>
The current state of the application.   
Type: String  
Valid Values: `CREATING | ACTIVE | DELETING | FAILED | UPDATING` 

 ** [Tags](#API_GetApplication_ResponseSyntax) **   <a name="migrationhubrefactorspaces-GetApplication-response-Tags"></a>
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.   
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.

 ** [VpcId](#API_GetApplication_ResponseSyntax) **   <a name="migrationhubrefactorspaces-GetApplication-response-VpcId"></a>
The ID of the virtual private cloud (VPC).   
Type: String  
Length Constraints: Minimum length of 12. Maximum length of 21.  
Pattern: `vpc-[-a-f0-9]{8}([-a-f0-9]{9})?` 

## Errors


For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

 ** AccessDeniedException **   
The user does not have sufficient access to perform this action.   
HTTP Status Code: 403

 ** InternalServerException **   
An unexpected error occurred while processing the request.  
HTTP Status Code: 500

 ** ResourceNotFoundException **   
The request references a resource that does not exist.     
 ** ResourceId **   
The ID of the resource.   
 ** ResourceType **   
The type of resource. 
HTTP Status Code: 404

 ** ThrottlingException **   
Request was denied because the request was throttled.     
 ** QuotaCode **   
Service quota requirement to identify originating quota. Reached throttling quota exception.   
 ** RetryAfterSeconds **   
The number of seconds to wait before retrying.   
 ** ServiceCode **   
Service quota requirement to identify originating service. Reached throttling quota exception service code. 
HTTP Status Code: 429

 ** ValidationException **   
The input does not satisfy the constraints specified by an AWS service.   
HTTP Status Code: 400

## See Also


For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/migration-hub-refactor-spaces-2021-10-26/GetApplication) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/migration-hub-refactor-spaces-2021-10-26/GetApplication) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/migration-hub-refactor-spaces-2021-10-26/GetApplication) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/migration-hub-refactor-spaces-2021-10-26/GetApplication) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/migration-hub-refactor-spaces-2021-10-26/GetApplication) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/migration-hub-refactor-spaces-2021-10-26/GetApplication) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/migration-hub-refactor-spaces-2021-10-26/GetApplication) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/migration-hub-refactor-spaces-2021-10-26/GetApplication) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/migration-hub-refactor-spaces-2021-10-26/GetApplication) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/migration-hub-refactor-spaces-2021-10-26/GetApplication) 

# GetEnvironment


**Note**  
 AWS Migration Hub is no longer open to new customers as of November 7, 2025. For capabilities similar to AWS Migration Hub, explore [AWS Migration Hub](https://aws.amazon.com/transform).

Gets an AWS Migration Hub Refactor Spaces environment.

## Request Syntax


```
GET /environments/EnvironmentIdentifier HTTP/1.1
```

## URI Request Parameters


The request uses the following URI parameters.

 ** [EnvironmentIdentifier](#API_GetEnvironment_RequestSyntax) **   <a name="migrationhubrefactorspaces-GetEnvironment-request-uri-EnvironmentIdentifier"></a>
The ID of the environment.  
Length Constraints: Fixed length of 14.  
Pattern: `env-[0-9A-Za-z]{10}`   
Required: Yes

## Request Body


The request does not have a 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"
   },
   "LastUpdatedTime": number,
   "Name": "string",
   "NetworkFabricType": "string",
   "OwnerAccountId": "string",
   "State": "string",
   "Tags": { 
      "string" : "string" 
   },
   "TransitGatewayId": "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.

 ** [Arn](#API_GetEnvironment_ResponseSyntax) **   <a name="migrationhubrefactorspaces-GetEnvironment-response-Arn"></a>
The Amazon Resource Name (ARN) of the environment.  
Type: String  
Length Constraints: Minimum length of 20. Maximum length of 2048.  
Pattern: `arn:aws:refactor-spaces:[a-zA-Z0-9\-]+:\w{12}:[a-zA-Z_0-9+=,.@\-_/]+` 

 ** [CreatedTime](#API_GetEnvironment_ResponseSyntax) **   <a name="migrationhubrefactorspaces-GetEnvironment-response-CreatedTime"></a>
A timestamp that indicates when the environment is created.   
Type: Timestamp

 ** [Description](#API_GetEnvironment_ResponseSyntax) **   <a name="migrationhubrefactorspaces-GetEnvironment-response-Description"></a>
The description of the environment.   
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 256.  
Pattern: `[a-zA-Z0-9-_\s\.\!\*\#\@\']+` 

 ** [EnvironmentId](#API_GetEnvironment_ResponseSyntax) **   <a name="migrationhubrefactorspaces-GetEnvironment-response-EnvironmentId"></a>
The unique identifier of the environment.   
Type: String  
Length Constraints: Fixed length of 14.  
Pattern: `env-[0-9A-Za-z]{10}` 

 ** [Error](#API_GetEnvironment_ResponseSyntax) **   <a name="migrationhubrefactorspaces-GetEnvironment-response-Error"></a>
Any error associated with the environment resource.   
Type: [ErrorResponse](API_ErrorResponse.md) object

 ** [LastUpdatedTime](#API_GetEnvironment_ResponseSyntax) **   <a name="migrationhubrefactorspaces-GetEnvironment-response-LastUpdatedTime"></a>
A timestamp that indicates when the environment was last updated.   
Type: Timestamp

 ** [Name](#API_GetEnvironment_ResponseSyntax) **   <a name="migrationhubrefactorspaces-GetEnvironment-response-Name"></a>
The name of the environment.  
Type: String  
Length Constraints: Minimum length of 3. Maximum length of 63.  
Pattern: `(?!env-)[a-zA-Z0-9]+[a-zA-Z0-9-_ ]+` 

 ** [NetworkFabricType](#API_GetEnvironment_ResponseSyntax) **   <a name="migrationhubrefactorspaces-GetEnvironment-response-NetworkFabricType"></a>
The network fabric type of the environment.   
Type: String  
Valid Values: `TRANSIT_GATEWAY | NONE` 

 ** [OwnerAccountId](#API_GetEnvironment_ResponseSyntax) **   <a name="migrationhubrefactorspaces-GetEnvironment-response-OwnerAccountId"></a>
The AWS account ID of the environment owner.  
Type: String  
Length Constraints: Fixed length of 12.  
Pattern: `\d{12}` 

 ** [State](#API_GetEnvironment_ResponseSyntax) **   <a name="migrationhubrefactorspaces-GetEnvironment-response-State"></a>
The current state of the environment.   
Type: String  
Valid Values: `CREATING | ACTIVE | DELETING | FAILED` 

 ** [Tags](#API_GetEnvironment_ResponseSyntax) **   <a name="migrationhubrefactorspaces-GetEnvironment-response-Tags"></a>
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.   
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.

 ** [TransitGatewayId](#API_GetEnvironment_ResponseSyntax) **   <a name="migrationhubrefactorspaces-GetEnvironment-response-TransitGatewayId"></a>
The ID of the AWS Transit Gateway set up by the environment, if applicable.  
Type: String  
Length Constraints: Fixed length of 21.  
Pattern: `tgw-[-a-f0-9]{17}` 

## Errors


For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

 ** AccessDeniedException **   
The user does not have sufficient access to perform this action.   
HTTP Status Code: 403

 ** InternalServerException **   
An unexpected error occurred while processing the request.  
HTTP Status Code: 500

 ** ResourceNotFoundException **   
The request references a resource that does not exist.     
 ** ResourceId **   
The ID of the resource.   
 ** ResourceType **   
The type of resource. 
HTTP Status Code: 404

 ** ThrottlingException **   
Request was denied because the request was throttled.     
 ** QuotaCode **   
Service quota requirement to identify originating quota. Reached throttling quota exception.   
 ** RetryAfterSeconds **   
The number of seconds to wait before retrying.   
 ** ServiceCode **   
Service quota requirement to identify originating service. Reached throttling quota exception service code. 
HTTP Status Code: 429

 ** ValidationException **   
The input does not satisfy the constraints specified by an AWS service.   
HTTP Status Code: 400

## See Also


For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/migration-hub-refactor-spaces-2021-10-26/GetEnvironment) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/migration-hub-refactor-spaces-2021-10-26/GetEnvironment) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/migration-hub-refactor-spaces-2021-10-26/GetEnvironment) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/migration-hub-refactor-spaces-2021-10-26/GetEnvironment) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/migration-hub-refactor-spaces-2021-10-26/GetEnvironment) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/migration-hub-refactor-spaces-2021-10-26/GetEnvironment) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/migration-hub-refactor-spaces-2021-10-26/GetEnvironment) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/migration-hub-refactor-spaces-2021-10-26/GetEnvironment) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/migration-hub-refactor-spaces-2021-10-26/GetEnvironment) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/migration-hub-refactor-spaces-2021-10-26/GetEnvironment) 

# GetResourcePolicy


**Note**  
 AWS Migration Hub is no longer open to new customers as of November 7, 2025. For capabilities similar to AWS Migration Hub, explore [AWS Migration Hub](https://aws.amazon.com/transform).

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

## Request Syntax


```
GET /resourcepolicy/Identifier HTTP/1.1
```

## URI Request Parameters


The request uses the following URI parameters.

 ** [Identifier](#API_GetResourcePolicy_RequestSyntax) **   <a name="migrationhubrefactorspaces-GetResourcePolicy-request-uri-Identifier"></a>
The Amazon Resource Name (ARN) of the resource associated with the policy.   
Length Constraints: Minimum length of 20. Maximum length of 2048.  
Pattern: `arn:aws:refactor-spaces:[a-zA-Z0-9\-]+:\w{12}:[a-zA-Z_0-9+=,.@\-_/]+`   
Required: Yes

## Request Body


The request does not have a request body.

## Response Syntax


```
HTTP/1.1 200
Content-type: application/json

{
   "Policy": "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.

 ** [Policy](#API_GetResourcePolicy_ResponseSyntax) **   <a name="migrationhubrefactorspaces-GetResourcePolicy-response-Policy"></a>
A JSON-formatted string for an AWS resource-based policy.   
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 300000.  
Pattern: `.*\S.*` 

## Errors


For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

 ** AccessDeniedException **   
The user does not have sufficient access to perform this action.   
HTTP Status Code: 403

 ** InternalServerException **   
An unexpected error occurred while processing the request.  
HTTP Status Code: 500

 ** ResourceNotFoundException **   
The request references a resource that does not exist.     
 ** ResourceId **   
The ID of the resource.   
 ** ResourceType **   
The type of resource. 
HTTP Status Code: 404

 ** ThrottlingException **   
Request was denied because the request was throttled.     
 ** QuotaCode **   
Service quota requirement to identify originating quota. Reached throttling quota exception.   
 ** RetryAfterSeconds **   
The number of seconds to wait before retrying.   
 ** ServiceCode **   
Service quota requirement to identify originating service. Reached throttling quota exception service code. 
HTTP Status Code: 429

 ** ValidationException **   
The input does not satisfy the constraints specified by an AWS service.   
HTTP Status Code: 400

## See Also


For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/migration-hub-refactor-spaces-2021-10-26/GetResourcePolicy) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/migration-hub-refactor-spaces-2021-10-26/GetResourcePolicy) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/migration-hub-refactor-spaces-2021-10-26/GetResourcePolicy) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/migration-hub-refactor-spaces-2021-10-26/GetResourcePolicy) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/migration-hub-refactor-spaces-2021-10-26/GetResourcePolicy) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/migration-hub-refactor-spaces-2021-10-26/GetResourcePolicy) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/migration-hub-refactor-spaces-2021-10-26/GetResourcePolicy) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/migration-hub-refactor-spaces-2021-10-26/GetResourcePolicy) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/migration-hub-refactor-spaces-2021-10-26/GetResourcePolicy) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/migration-hub-refactor-spaces-2021-10-26/GetResourcePolicy) 

# GetRoute


**Note**  
 AWS Migration Hub is no longer open to new customers as of November 7, 2025. For capabilities similar to AWS Migration Hub, explore [AWS Migration Hub](https://aws.amazon.com/transform).

Gets an AWS Migration Hub Refactor Spaces route.

## Request Syntax


```
GET /environments/EnvironmentIdentifier/applications/ApplicationIdentifier/routes/RouteIdentifier HTTP/1.1
```

## URI Request Parameters


The request uses the following URI parameters.

 ** [ApplicationIdentifier](#API_GetRoute_RequestSyntax) **   <a name="migrationhubrefactorspaces-GetRoute-request-uri-ApplicationIdentifier"></a>
The ID of the application.   
Length Constraints: Fixed length of 14.  
Pattern: `app-[0-9A-Za-z]{10}`   
Required: Yes

 ** [EnvironmentIdentifier](#API_GetRoute_RequestSyntax) **   <a name="migrationhubrefactorspaces-GetRoute-request-uri-EnvironmentIdentifier"></a>
The ID of the environment.  
Length Constraints: Fixed length of 14.  
Pattern: `env-[0-9A-Za-z]{10}`   
Required: Yes

 ** [RouteIdentifier](#API_GetRoute_RequestSyntax) **   <a name="migrationhubrefactorspaces-GetRoute-request-uri-RouteIdentifier"></a>
The ID of the route.  
Length Constraints: Fixed length of 14.  
Pattern: `rte-[0-9A-Za-z]{10}`   
Required: Yes

## Request Body


The request does not have a request body.

## Response Syntax


```
HTTP/1.1 200
Content-type: application/json

{
   "AppendSourcePath": boolean,
   "ApplicationId": "string",
   "Arn": "string",
   "CreatedByAccountId": "string",
   "CreatedTime": number,
   "EnvironmentId": "string",
   "Error": { 
      "AccountId": "string",
      "AdditionalDetails": { 
         "string" : "string" 
      },
      "Code": "string",
      "Message": "string",
      "ResourceIdentifier": "string",
      "ResourceType": "string"
   },
   "IncludeChildPaths": boolean,
   "LastUpdatedTime": number,
   "Methods": [ "string" ],
   "OwnerAccountId": "string",
   "PathResourceToId": { 
      "string" : "string" 
   },
   "RouteId": "string",
   "RouteType": "string",
   "ServiceId": "string",
   "SourcePath": "string",
   "State": "string",
   "Tags": { 
      "string" : "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.

 ** [AppendSourcePath](#API_GetRoute_ResponseSyntax) **   <a name="migrationhubrefactorspaces-GetRoute-response-AppendSourcePath"></a>
If set to `true`, this option appends the source path to the service URL endpoint.  
Type: Boolean

 ** [ApplicationId](#API_GetRoute_ResponseSyntax) **   <a name="migrationhubrefactorspaces-GetRoute-response-ApplicationId"></a>
The ID of the application that the route belongs to.   
Type: String  
Length Constraints: Fixed length of 14.  
Pattern: `app-[0-9A-Za-z]{10}` 

 ** [Arn](#API_GetRoute_ResponseSyntax) **   <a name="migrationhubrefactorspaces-GetRoute-response-Arn"></a>
The Amazon Resource Name (ARN) of the route.  
Type: String  
Length Constraints: Minimum length of 20. Maximum length of 2048.  
Pattern: `arn:aws:refactor-spaces:[a-zA-Z0-9\-]+:\w{12}:[a-zA-Z_0-9+=,.@\-_/]+` 

 ** [CreatedByAccountId](#API_GetRoute_ResponseSyntax) **   <a name="migrationhubrefactorspaces-GetRoute-response-CreatedByAccountId"></a>
The AWS account ID of the route creator.  
Type: String  
Length Constraints: Fixed length of 12.  
Pattern: `\d{12}` 

 ** [CreatedTime](#API_GetRoute_ResponseSyntax) **   <a name="migrationhubrefactorspaces-GetRoute-response-CreatedTime"></a>
The timestamp of when the route is created.   
Type: Timestamp

 ** [EnvironmentId](#API_GetRoute_ResponseSyntax) **   <a name="migrationhubrefactorspaces-GetRoute-response-EnvironmentId"></a>
Unique identifier of the environment.  
Type: String  
Length Constraints: Fixed length of 14.  
Pattern: `env-[0-9A-Za-z]{10}` 

 ** [Error](#API_GetRoute_ResponseSyntax) **   <a name="migrationhubrefactorspaces-GetRoute-response-Error"></a>
Any error associated with the route resource.   
Type: [ErrorResponse](API_ErrorResponse.md) object

 ** [IncludeChildPaths](#API_GetRoute_ResponseSyntax) **   <a name="migrationhubrefactorspaces-GetRoute-response-IncludeChildPaths"></a>
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.   
Type: Boolean

 ** [LastUpdatedTime](#API_GetRoute_ResponseSyntax) **   <a name="migrationhubrefactorspaces-GetRoute-response-LastUpdatedTime"></a>
A timestamp that indicates when the route was last updated.   
Type: Timestamp

 ** [Methods](#API_GetRoute_ResponseSyntax) **   <a name="migrationhubrefactorspaces-GetRoute-response-Methods"></a>
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.   
Type: Array of strings  
Valid Values: `DELETE | GET | HEAD | OPTIONS | PATCH | POST | PUT` 

 ** [OwnerAccountId](#API_GetRoute_ResponseSyntax) **   <a name="migrationhubrefactorspaces-GetRoute-response-OwnerAccountId"></a>
The AWS account ID of the route owner.  
Type: String  
Length Constraints: Fixed length of 12.  
Pattern: `\d{12}` 

 ** [PathResourceToId](#API_GetRoute_ResponseSyntax) **   <a name="migrationhubrefactorspaces-GetRoute-response-PathResourceToId"></a>
A mapping of Amazon API Gateway path resources to resource IDs.   
Type: String to string map  
Key Length Constraints: Minimum length of 1. Maximum length of 2048.  
Value Length Constraints: Fixed length of 10.  
Value Pattern: `[a-z0-9]{10}` 

 ** [RouteId](#API_GetRoute_ResponseSyntax) **   <a name="migrationhubrefactorspaces-GetRoute-response-RouteId"></a>
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\$1PATH**: A route that is based on a URI path.  
Type: String  
Length Constraints: Fixed length of 14.  
Pattern: `rte-[0-9A-Za-z]{10}` 

 ** [RouteType](#API_GetRoute_ResponseSyntax) **   <a name="migrationhubrefactorspaces-GetRoute-response-RouteType"></a>
The type of route.  
Type: String  
Valid Values: `DEFAULT | URI_PATH` 

 ** [ServiceId](#API_GetRoute_ResponseSyntax) **   <a name="migrationhubrefactorspaces-GetRoute-response-ServiceId"></a>
The unique identifier of the service.  
Type: String  
Length Constraints: Fixed length of 14.  
Pattern: `svc-[0-9A-Za-z]{10}` 

 ** [SourcePath](#API_GetRoute_ResponseSyntax) **   <a name="migrationhubrefactorspaces-GetRoute-response-SourcePath"></a>
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 \$1user\$1 represents a path parameter called 'user'.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 2048.  
Pattern: `(/([a-zA-Z0-9._:-]+|\{[a-zA-Z0-9._:-]+\}))+` 

 ** [State](#API_GetRoute_ResponseSyntax) **   <a name="migrationhubrefactorspaces-GetRoute-response-State"></a>
The current state of the route.   
Type: String  
Valid Values: `CREATING | ACTIVE | DELETING | FAILED | UPDATING | INACTIVE` 

 ** [Tags](#API_GetRoute_ResponseSyntax) **   <a name="migrationhubrefactorspaces-GetRoute-response-Tags"></a>
The tags assigned to the route. 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.

## Errors


For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

 ** AccessDeniedException **   
The user does not have sufficient access to perform this action.   
HTTP Status Code: 403

 ** InternalServerException **   
An unexpected error occurred while processing the request.  
HTTP Status Code: 500

 ** ResourceNotFoundException **   
The request references a resource that does not exist.     
 ** ResourceId **   
The ID of the resource.   
 ** ResourceType **   
The type of resource. 
HTTP Status Code: 404

 ** ThrottlingException **   
Request was denied because the request was throttled.     
 ** QuotaCode **   
Service quota requirement to identify originating quota. Reached throttling quota exception.   
 ** RetryAfterSeconds **   
The number of seconds to wait before retrying.   
 ** ServiceCode **   
Service quota requirement to identify originating service. Reached throttling quota exception service code. 
HTTP Status Code: 429

 ** ValidationException **   
The input does not satisfy the constraints specified by an AWS service.   
HTTP Status Code: 400

## See Also


For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/migration-hub-refactor-spaces-2021-10-26/GetRoute) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/migration-hub-refactor-spaces-2021-10-26/GetRoute) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/migration-hub-refactor-spaces-2021-10-26/GetRoute) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/migration-hub-refactor-spaces-2021-10-26/GetRoute) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/migration-hub-refactor-spaces-2021-10-26/GetRoute) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/migration-hub-refactor-spaces-2021-10-26/GetRoute) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/migration-hub-refactor-spaces-2021-10-26/GetRoute) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/migration-hub-refactor-spaces-2021-10-26/GetRoute) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/migration-hub-refactor-spaces-2021-10-26/GetRoute) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/migration-hub-refactor-spaces-2021-10-26/GetRoute) 

# GetService


**Note**  
 AWS Migration Hub is no longer open to new customers as of November 7, 2025. For capabilities similar to AWS Migration Hub, explore [AWS Migration Hub](https://aws.amazon.com/transform).

Gets an AWS Migration Hub Refactor Spaces service. 

## Request Syntax


```
GET /environments/EnvironmentIdentifier/applications/ApplicationIdentifier/services/ServiceIdentifier HTTP/1.1
```

## URI Request Parameters


The request uses the following URI parameters.

 ** [ApplicationIdentifier](#API_GetService_RequestSyntax) **   <a name="migrationhubrefactorspaces-GetService-request-uri-ApplicationIdentifier"></a>
The ID of the application.  
Length Constraints: Fixed length of 14.  
Pattern: `app-[0-9A-Za-z]{10}`   
Required: Yes

 ** [EnvironmentIdentifier](#API_GetService_RequestSyntax) **   <a name="migrationhubrefactorspaces-GetService-request-uri-EnvironmentIdentifier"></a>
The ID of the environment.  
Length Constraints: Fixed length of 14.  
Pattern: `env-[0-9A-Za-z]{10}`   
Required: Yes

 ** [ServiceIdentifier](#API_GetService_RequestSyntax) **   <a name="migrationhubrefactorspaces-GetService-request-uri-ServiceIdentifier"></a>
The ID of the service.  
Length Constraints: Fixed length of 14.  
Pattern: `svc-[0-9A-Za-z]{10}`   
Required: Yes

## Request Body


The request does not have a request body.

## Response Syntax


```
HTTP/1.1 200
Content-type: application/json

{
   "ApplicationId": "string",
   "Arn": "string",
   "CreatedByAccountId": "string",
   "CreatedTime": number,
   "Description": "string",
   "EndpointType": "string",
   "EnvironmentId": "string",
   "Error": { 
      "AccountId": "string",
      "AdditionalDetails": { 
         "string" : "string" 
      },
      "Code": "string",
      "Message": "string",
      "ResourceIdentifier": "string",
      "ResourceType": "string"
   },
   "LambdaEndpoint": { 
      "Arn": "string"
   },
   "LastUpdatedTime": number,
   "Name": "string",
   "OwnerAccountId": "string",
   "ServiceId": "string",
   "State": "string",
   "Tags": { 
      "string" : "string" 
   },
   "UrlEndpoint": { 
      "HealthUrl": "string",
      "Url": "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.

 ** [ApplicationId](#API_GetService_ResponseSyntax) **   <a name="migrationhubrefactorspaces-GetService-response-ApplicationId"></a>
The ID of the application.  
Type: String  
Length Constraints: Fixed length of 14.  
Pattern: `app-[0-9A-Za-z]{10}` 

 ** [Arn](#API_GetService_ResponseSyntax) **   <a name="migrationhubrefactorspaces-GetService-response-Arn"></a>
The Amazon Resource Name (ARN) of the service.  
Type: String  
Length Constraints: Minimum length of 20. Maximum length of 2048.  
Pattern: `arn:aws:refactor-spaces:[a-zA-Z0-9\-]+:\w{12}:[a-zA-Z_0-9+=,.@\-_/]+` 

 ** [CreatedByAccountId](#API_GetService_ResponseSyntax) **   <a name="migrationhubrefactorspaces-GetService-response-CreatedByAccountId"></a>
The AWS account ID of the service creator.  
Type: String  
Length Constraints: Fixed length of 12.  
Pattern: `\d{12}` 

 ** [CreatedTime](#API_GetService_ResponseSyntax) **   <a name="migrationhubrefactorspaces-GetService-response-CreatedTime"></a>
The timestamp of when the service is created.  
Type: Timestamp

 ** [Description](#API_GetService_ResponseSyntax) **   <a name="migrationhubrefactorspaces-GetService-response-Description"></a>
The description of the service.   
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 256.  
Pattern: `[a-zA-Z0-9-_\s\.\!\*\#\@\']+` 

 ** [EndpointType](#API_GetService_ResponseSyntax) **   <a name="migrationhubrefactorspaces-GetService-response-EndpointType"></a>
The endpoint type of the service.  
Type: String  
Valid Values: `LAMBDA | URL` 

 ** [EnvironmentId](#API_GetService_ResponseSyntax) **   <a name="migrationhubrefactorspaces-GetService-response-EnvironmentId"></a>
The unique identifier of the environment.  
Type: String  
Length Constraints: Fixed length of 14.  
Pattern: `env-[0-9A-Za-z]{10}` 

 ** [Error](#API_GetService_ResponseSyntax) **   <a name="migrationhubrefactorspaces-GetService-response-Error"></a>
Any error associated with the service resource.   
Type: [ErrorResponse](API_ErrorResponse.md) object

 ** [LambdaEndpoint](#API_GetService_ResponseSyntax) **   <a name="migrationhubrefactorspaces-GetService-response-LambdaEndpoint"></a>
The configuration for the AWS Lambda endpoint type.  
The **Arn** is the Amazon Resource Name (ARN) of the Lambda function associated with this service.   
Type: [LambdaEndpointConfig](API_LambdaEndpointConfig.md) object

 ** [LastUpdatedTime](#API_GetService_ResponseSyntax) **   <a name="migrationhubrefactorspaces-GetService-response-LastUpdatedTime"></a>
A timestamp that indicates when the service was last updated.   
Type: Timestamp

 ** [Name](#API_GetService_ResponseSyntax) **   <a name="migrationhubrefactorspaces-GetService-response-Name"></a>
The name of the service.  
Type: String  
Length Constraints: Minimum length of 3. Maximum length of 63.  
Pattern: `(?!svc-)[a-zA-Z0-9]+[a-zA-Z0-9-_ ]+` 

 ** [OwnerAccountId](#API_GetService_ResponseSyntax) **   <a name="migrationhubrefactorspaces-GetService-response-OwnerAccountId"></a>
The AWS account ID of the service owner.  
Type: String  
Length Constraints: Fixed length of 12.  
Pattern: `\d{12}` 

 ** [ServiceId](#API_GetService_ResponseSyntax) **   <a name="migrationhubrefactorspaces-GetService-response-ServiceId"></a>
The unique identifier of the service.  
Type: String  
Length Constraints: Fixed length of 14.  
Pattern: `svc-[0-9A-Za-z]{10}` 

 ** [State](#API_GetService_ResponseSyntax) **   <a name="migrationhubrefactorspaces-GetService-response-State"></a>
The current state of the service.   
Type: String  
Valid Values: `CREATING | ACTIVE | DELETING | FAILED` 

 ** [Tags](#API_GetService_ResponseSyntax) **   <a name="migrationhubrefactorspaces-GetService-response-Tags"></a>
The tags assigned to the service. 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.

 ** [UrlEndpoint](#API_GetService_ResponseSyntax) **   <a name="migrationhubrefactorspaces-GetService-response-UrlEndpoint"></a>
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.   
Type: [UrlEndpointConfig](API_UrlEndpointConfig.md) object

 ** [VpcId](#API_GetService_ResponseSyntax) **   <a name="migrationhubrefactorspaces-GetService-response-VpcId"></a>
The ID of the virtual private cloud (VPC).   
Type: String  
Length Constraints: Minimum length of 12. Maximum length of 21.  
Pattern: `vpc-[-a-f0-9]{8}([-a-f0-9]{9})?` 

## Errors


For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

 ** AccessDeniedException **   
The user does not have sufficient access to perform this action.   
HTTP Status Code: 403

 ** InternalServerException **   
An unexpected error occurred while processing the request.  
HTTP Status Code: 500

 ** ResourceNotFoundException **   
The request references a resource that does not exist.     
 ** ResourceId **   
The ID of the resource.   
 ** ResourceType **   
The type of resource. 
HTTP Status Code: 404

 ** ThrottlingException **   
Request was denied because the request was throttled.     
 ** QuotaCode **   
Service quota requirement to identify originating quota. Reached throttling quota exception.   
 ** RetryAfterSeconds **   
The number of seconds to wait before retrying.   
 ** ServiceCode **   
Service quota requirement to identify originating service. Reached throttling quota exception service code. 
HTTP Status Code: 429

 ** ValidationException **   
The input does not satisfy the constraints specified by an AWS service.   
HTTP Status Code: 400

## See Also


For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/migration-hub-refactor-spaces-2021-10-26/GetService) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/migration-hub-refactor-spaces-2021-10-26/GetService) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/migration-hub-refactor-spaces-2021-10-26/GetService) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/migration-hub-refactor-spaces-2021-10-26/GetService) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/migration-hub-refactor-spaces-2021-10-26/GetService) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/migration-hub-refactor-spaces-2021-10-26/GetService) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/migration-hub-refactor-spaces-2021-10-26/GetService) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/migration-hub-refactor-spaces-2021-10-26/GetService) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/migration-hub-refactor-spaces-2021-10-26/GetService) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/migration-hub-refactor-spaces-2021-10-26/GetService) 

# ListApplications


**Note**  
 AWS Migration Hub is no longer open to new customers as of November 7, 2025. For capabilities similar to AWS Migration Hub, explore [AWS Migration Hub](https://aws.amazon.com/transform).

Lists all the AWS Migration Hub Refactor Spaces applications within an environment. 

## Request Syntax


```
GET /environments/EnvironmentIdentifier/applications?maxResults=MaxResults&nextToken=NextToken HTTP/1.1
```

## URI Request Parameters


The request uses the following URI parameters.

 ** [EnvironmentIdentifier](#API_ListApplications_RequestSyntax) **   <a name="migrationhubrefactorspaces-ListApplications-request-uri-EnvironmentIdentifier"></a>
The ID of the environment.   
Length Constraints: Fixed length of 14.  
Pattern: `env-[0-9A-Za-z]{10}`   
Required: Yes

 ** [MaxResults](#API_ListApplications_RequestSyntax) **   <a name="migrationhubrefactorspaces-ListApplications-request-uri-MaxResults"></a>
The maximum number of results to return with a single call. To retrieve the remaining results, make another call with the returned `nextToken` value.  
Valid Range: Minimum value of 1. Maximum value of 100.

 ** [NextToken](#API_ListApplications_RequestSyntax) **   <a name="migrationhubrefactorspaces-ListApplications-request-uri-NextToken"></a>
The token for the next page of results.  
Length Constraints: Minimum length of 1. Maximum length of 2048.  
Pattern: `[a-zA-Z0-9/\+\=]{0,2048}` 

## Request Body


The request does not have a request body.

## Response Syntax


```
HTTP/1.1 200
Content-type: application/json

{
   "ApplicationSummaryList": [ 
      { 
         "ApiGatewayProxy": { 
            "ApiGatewayId": "string",
            "EndpointType": "string",
            "NlbArn": "string",
            "NlbName": "string",
            "ProxyUrl": "string",
            "StageName": "string",
            "VpcLinkId": "string"
         },
         "ApplicationId": "string",
         "Arn": "string",
         "CreatedByAccountId": "string",
         "CreatedTime": number,
         "EnvironmentId": "string",
         "Error": { 
            "AccountId": "string",
            "AdditionalDetails": { 
               "string" : "string" 
            },
            "Code": "string",
            "Message": "string",
            "ResourceIdentifier": "string",
            "ResourceType": "string"
         },
         "LastUpdatedTime": number,
         "Name": "string",
         "OwnerAccountId": "string",
         "ProxyType": "string",
         "State": "string",
         "Tags": { 
            "string" : "string" 
         },
         "VpcId": "string"
      }
   ],
   "NextToken": "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.

 ** [ApplicationSummaryList](#API_ListApplications_ResponseSyntax) **   <a name="migrationhubrefactorspaces-ListApplications-response-ApplicationSummaryList"></a>
The list of `ApplicationSummary` objects.   
Type: Array of [ApplicationSummary](API_ApplicationSummary.md) objects

 ** [NextToken](#API_ListApplications_ResponseSyntax) **   <a name="migrationhubrefactorspaces-ListApplications-response-NextToken"></a>
The token for the next page of results.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 2048.  
Pattern: `[a-zA-Z0-9/\+\=]{0,2048}` 

## Errors


For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

 ** AccessDeniedException **   
The user does not have sufficient access to perform this action.   
HTTP Status Code: 403

 ** ConflictException **   
Updating or deleting a resource can cause an inconsistent state.    
 ** ResourceId **   
The ID of the resource.   
 ** ResourceType **   
The type of resource. 
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.     
 ** ResourceId **   
The ID of the resource.   
 ** ResourceType **   
The type of resource. 
HTTP Status Code: 404

 ** ServiceQuotaExceededException **   
The request would cause a service quota to be exceeded.     
 ** QuotaCode **   
Service quota requirement to identify originating quota. Reached throttling quota exception.   
 ** ResourceId **   
The ID of the resource.   
 ** ResourceType **   
The type of resource.   
 ** ServiceCode **   
Service quota requirement to identify originating service. Reached throttling quota exception service code. 
HTTP Status Code: 402

 ** ThrottlingException **   
Request was denied because the request was throttled.     
 ** QuotaCode **   
Service quota requirement to identify originating quota. Reached throttling quota exception.   
 ** RetryAfterSeconds **   
The number of seconds to wait before retrying.   
 ** ServiceCode **   
Service quota requirement to identify originating service. Reached throttling quota exception service code. 
HTTP Status Code: 429

 ** ValidationException **   
The input does not satisfy the constraints specified by an AWS service.   
HTTP Status Code: 400

## See Also


For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/migration-hub-refactor-spaces-2021-10-26/ListApplications) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/migration-hub-refactor-spaces-2021-10-26/ListApplications) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/migration-hub-refactor-spaces-2021-10-26/ListApplications) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/migration-hub-refactor-spaces-2021-10-26/ListApplications) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/migration-hub-refactor-spaces-2021-10-26/ListApplications) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/migration-hub-refactor-spaces-2021-10-26/ListApplications) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/migration-hub-refactor-spaces-2021-10-26/ListApplications) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/migration-hub-refactor-spaces-2021-10-26/ListApplications) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/migration-hub-refactor-spaces-2021-10-26/ListApplications) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/migration-hub-refactor-spaces-2021-10-26/ListApplications) 

# ListEnvironments


**Note**  
 AWS Migration Hub is no longer open to new customers as of November 7, 2025. For capabilities similar to AWS Migration Hub, explore [AWS Migration Hub](https://aws.amazon.com/transform).

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

## Request Syntax


```
GET /environments?maxResults=MaxResults&nextToken=NextToken HTTP/1.1
```

## URI Request Parameters


The request uses the following URI parameters.

 ** [MaxResults](#API_ListEnvironments_RequestSyntax) **   <a name="migrationhubrefactorspaces-ListEnvironments-request-uri-MaxResults"></a>
The maximum number of results to return with a single call. To retrieve the remaining results, make another call with the returned `nextToken` value.  
Valid Range: Minimum value of 1. Maximum value of 100.

 ** [NextToken](#API_ListEnvironments_RequestSyntax) **   <a name="migrationhubrefactorspaces-ListEnvironments-request-uri-NextToken"></a>
The token for the next page of results.  
Length Constraints: Minimum length of 1. Maximum length of 2048.  
Pattern: `[a-zA-Z0-9/\+\=]{0,2048}` 

## Request Body


The request does not have a request body.

## Response Syntax


```
HTTP/1.1 200
Content-type: application/json

{
   "EnvironmentSummaryList": [ 
      { 
         "Arn": "string",
         "CreatedTime": number,
         "Description": "string",
         "EnvironmentId": "string",
         "Error": { 
            "AccountId": "string",
            "AdditionalDetails": { 
               "string" : "string" 
            },
            "Code": "string",
            "Message": "string",
            "ResourceIdentifier": "string",
            "ResourceType": "string"
         },
         "LastUpdatedTime": number,
         "Name": "string",
         "NetworkFabricType": "string",
         "OwnerAccountId": "string",
         "State": "string",
         "Tags": { 
            "string" : "string" 
         },
         "TransitGatewayId": "string"
      }
   ],
   "NextToken": "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.

 ** [EnvironmentSummaryList](#API_ListEnvironments_ResponseSyntax) **   <a name="migrationhubrefactorspaces-ListEnvironments-response-EnvironmentSummaryList"></a>
The list of `EnvironmentSummary` objects.   
Type: Array of [EnvironmentSummary](API_EnvironmentSummary.md) objects

 ** [NextToken](#API_ListEnvironments_ResponseSyntax) **   <a name="migrationhubrefactorspaces-ListEnvironments-response-NextToken"></a>
The token for the next page of results.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 2048.  
Pattern: `[a-zA-Z0-9/\+\=]{0,2048}` 

## Errors


For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

 ** AccessDeniedException **   
The user does not have sufficient access to perform this action.   
HTTP Status Code: 403

 ** InternalServerException **   
An unexpected error occurred while processing the request.  
HTTP Status Code: 500

 ** ResourceNotFoundException **   
The request references a resource that does not exist.     
 ** ResourceId **   
The ID of the resource.   
 ** ResourceType **   
The type of resource. 
HTTP Status Code: 404

 ** ThrottlingException **   
Request was denied because the request was throttled.     
 ** QuotaCode **   
Service quota requirement to identify originating quota. Reached throttling quota exception.   
 ** RetryAfterSeconds **   
The number of seconds to wait before retrying.   
 ** ServiceCode **   
Service quota requirement to identify originating service. Reached throttling quota exception service code. 
HTTP Status Code: 429

 ** ValidationException **   
The input does not satisfy the constraints specified by an AWS service.   
HTTP Status Code: 400

## See Also


For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/migration-hub-refactor-spaces-2021-10-26/ListEnvironments) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/migration-hub-refactor-spaces-2021-10-26/ListEnvironments) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/migration-hub-refactor-spaces-2021-10-26/ListEnvironments) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/migration-hub-refactor-spaces-2021-10-26/ListEnvironments) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/migration-hub-refactor-spaces-2021-10-26/ListEnvironments) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/migration-hub-refactor-spaces-2021-10-26/ListEnvironments) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/migration-hub-refactor-spaces-2021-10-26/ListEnvironments) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/migration-hub-refactor-spaces-2021-10-26/ListEnvironments) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/migration-hub-refactor-spaces-2021-10-26/ListEnvironments) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/migration-hub-refactor-spaces-2021-10-26/ListEnvironments) 

# ListEnvironmentVpcs


**Note**  
 AWS Migration Hub is no longer open to new customers as of November 7, 2025. For capabilities similar to AWS Migration Hub, explore [AWS Migration Hub](https://aws.amazon.com/transform).

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

## Request Syntax


```
GET /environments/EnvironmentIdentifier/vpcs?maxResults=MaxResults&nextToken=NextToken HTTP/1.1
```

## URI Request Parameters


The request uses the following URI parameters.

 ** [EnvironmentIdentifier](#API_ListEnvironmentVpcs_RequestSyntax) **   <a name="migrationhubrefactorspaces-ListEnvironmentVpcs-request-uri-EnvironmentIdentifier"></a>
The ID of the environment.   
Length Constraints: Fixed length of 14.  
Pattern: `env-[0-9A-Za-z]{10}`   
Required: Yes

 ** [MaxResults](#API_ListEnvironmentVpcs_RequestSyntax) **   <a name="migrationhubrefactorspaces-ListEnvironmentVpcs-request-uri-MaxResults"></a>
The maximum number of results to return with a single call. To retrieve the remaining results, make another call with the returned `nextToken` value.  
Valid Range: Minimum value of 1. Maximum value of 100.

 ** [NextToken](#API_ListEnvironmentVpcs_RequestSyntax) **   <a name="migrationhubrefactorspaces-ListEnvironmentVpcs-request-uri-NextToken"></a>
The token for the next page of results.  
Length Constraints: Minimum length of 1. Maximum length of 2048.  
Pattern: `[a-zA-Z0-9/\+\=]{0,2048}` 

## Request Body


The request does not have a request body.

## Response Syntax


```
HTTP/1.1 200
Content-type: application/json

{
   "EnvironmentVpcList": [ 
      { 
         "AccountId": "string",
         "CidrBlocks": [ "string" ],
         "CreatedTime": number,
         "EnvironmentId": "string",
         "LastUpdatedTime": number,
         "VpcId": "string",
         "VpcName": "string"
      }
   ],
   "NextToken": "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.

 ** [EnvironmentVpcList](#API_ListEnvironmentVpcs_ResponseSyntax) **   <a name="migrationhubrefactorspaces-ListEnvironmentVpcs-response-EnvironmentVpcList"></a>
The list of `EnvironmentVpc` objects.   
Type: Array of [EnvironmentVpc](API_EnvironmentVpc.md) objects

 ** [NextToken](#API_ListEnvironmentVpcs_ResponseSyntax) **   <a name="migrationhubrefactorspaces-ListEnvironmentVpcs-response-NextToken"></a>
The token for the next page of results.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 2048.  
Pattern: `[a-zA-Z0-9/\+\=]{0,2048}` 

## Errors


For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

 ** AccessDeniedException **   
The user does not have sufficient access to perform this action.   
HTTP Status Code: 403

 ** InternalServerException **   
An unexpected error occurred while processing the request.  
HTTP Status Code: 500

 ** ResourceNotFoundException **   
The request references a resource that does not exist.     
 ** ResourceId **   
The ID of the resource.   
 ** ResourceType **   
The type of resource. 
HTTP Status Code: 404

 ** ThrottlingException **   
Request was denied because the request was throttled.     
 ** QuotaCode **   
Service quota requirement to identify originating quota. Reached throttling quota exception.   
 ** RetryAfterSeconds **   
The number of seconds to wait before retrying.   
 ** ServiceCode **   
Service quota requirement to identify originating service. Reached throttling quota exception service code. 
HTTP Status Code: 429

 ** ValidationException **   
The input does not satisfy the constraints specified by an AWS service.   
HTTP Status Code: 400

## See Also


For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/migration-hub-refactor-spaces-2021-10-26/ListEnvironmentVpcs) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/migration-hub-refactor-spaces-2021-10-26/ListEnvironmentVpcs) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/migration-hub-refactor-spaces-2021-10-26/ListEnvironmentVpcs) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/migration-hub-refactor-spaces-2021-10-26/ListEnvironmentVpcs) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/migration-hub-refactor-spaces-2021-10-26/ListEnvironmentVpcs) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/migration-hub-refactor-spaces-2021-10-26/ListEnvironmentVpcs) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/migration-hub-refactor-spaces-2021-10-26/ListEnvironmentVpcs) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/migration-hub-refactor-spaces-2021-10-26/ListEnvironmentVpcs) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/migration-hub-refactor-spaces-2021-10-26/ListEnvironmentVpcs) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/migration-hub-refactor-spaces-2021-10-26/ListEnvironmentVpcs) 

# ListRoutes


**Note**  
 AWS Migration Hub is no longer open to new customers as of November 7, 2025. For capabilities similar to AWS Migration Hub, explore [AWS Migration Hub](https://aws.amazon.com/transform).

Lists all the AWS Migration Hub Refactor Spaces routes within an application. 

## Request Syntax


```
GET /environments/EnvironmentIdentifier/applications/ApplicationIdentifier/routes?maxResults=MaxResults&nextToken=NextToken HTTP/1.1
```

## URI Request Parameters


The request uses the following URI parameters.

 ** [ApplicationIdentifier](#API_ListRoutes_RequestSyntax) **   <a name="migrationhubrefactorspaces-ListRoutes-request-uri-ApplicationIdentifier"></a>
The ID of the application.   
Length Constraints: Fixed length of 14.  
Pattern: `app-[0-9A-Za-z]{10}`   
Required: Yes

 ** [EnvironmentIdentifier](#API_ListRoutes_RequestSyntax) **   <a name="migrationhubrefactorspaces-ListRoutes-request-uri-EnvironmentIdentifier"></a>
The ID of the environment.   
Length Constraints: Fixed length of 14.  
Pattern: `env-[0-9A-Za-z]{10}`   
Required: Yes

 ** [MaxResults](#API_ListRoutes_RequestSyntax) **   <a name="migrationhubrefactorspaces-ListRoutes-request-uri-MaxResults"></a>
The maximum number of results to return with a single call. To retrieve the remaining results, make another call with the returned `nextToken` value.  
Valid Range: Minimum value of 1. Maximum value of 100.

 ** [NextToken](#API_ListRoutes_RequestSyntax) **   <a name="migrationhubrefactorspaces-ListRoutes-request-uri-NextToken"></a>
The token for the next page of results.  
Length Constraints: Minimum length of 1. Maximum length of 2048.  
Pattern: `[a-zA-Z0-9/\+\=]{0,2048}` 

## Request Body


The request does not have a request body.

## Response Syntax


```
HTTP/1.1 200
Content-type: application/json

{
   "NextToken": "string",
   "RouteSummaryList": [ 
      { 
         "AppendSourcePath": boolean,
         "ApplicationId": "string",
         "Arn": "string",
         "CreatedByAccountId": "string",
         "CreatedTime": number,
         "EnvironmentId": "string",
         "Error": { 
            "AccountId": "string",
            "AdditionalDetails": { 
               "string" : "string" 
            },
            "Code": "string",
            "Message": "string",
            "ResourceIdentifier": "string",
            "ResourceType": "string"
         },
         "IncludeChildPaths": boolean,
         "LastUpdatedTime": number,
         "Methods": [ "string" ],
         "OwnerAccountId": "string",
         "PathResourceToId": { 
            "string" : "string" 
         },
         "RouteId": "string",
         "RouteType": "string",
         "ServiceId": "string",
         "SourcePath": "string",
         "State": "string",
         "Tags": { 
            "string" : "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.

 ** [NextToken](#API_ListRoutes_ResponseSyntax) **   <a name="migrationhubrefactorspaces-ListRoutes-response-NextToken"></a>
The token for the next page of results.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 2048.  
Pattern: `[a-zA-Z0-9/\+\=]{0,2048}` 

 ** [RouteSummaryList](#API_ListRoutes_ResponseSyntax) **   <a name="migrationhubrefactorspaces-ListRoutes-response-RouteSummaryList"></a>
The list of `RouteSummary` objects.   
Type: Array of [RouteSummary](API_RouteSummary.md) objects

## Errors


For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

 ** AccessDeniedException **   
The user does not have sufficient access to perform this action.   
HTTP Status Code: 403

 ** ConflictException **   
Updating or deleting a resource can cause an inconsistent state.    
 ** ResourceId **   
The ID of the resource.   
 ** ResourceType **   
The type of resource. 
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.     
 ** ResourceId **   
The ID of the resource.   
 ** ResourceType **   
The type of resource. 
HTTP Status Code: 404

 ** ServiceQuotaExceededException **   
The request would cause a service quota to be exceeded.     
 ** QuotaCode **   
Service quota requirement to identify originating quota. Reached throttling quota exception.   
 ** ResourceId **   
The ID of the resource.   
 ** ResourceType **   
The type of resource.   
 ** ServiceCode **   
Service quota requirement to identify originating service. Reached throttling quota exception service code. 
HTTP Status Code: 402

 ** ThrottlingException **   
Request was denied because the request was throttled.     
 ** QuotaCode **   
Service quota requirement to identify originating quota. Reached throttling quota exception.   
 ** RetryAfterSeconds **   
The number of seconds to wait before retrying.   
 ** ServiceCode **   
Service quota requirement to identify originating service. Reached throttling quota exception service code. 
HTTP Status Code: 429

 ** ValidationException **   
The input does not satisfy the constraints specified by an AWS service.   
HTTP Status Code: 400

## See Also


For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/migration-hub-refactor-spaces-2021-10-26/ListRoutes) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/migration-hub-refactor-spaces-2021-10-26/ListRoutes) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/migration-hub-refactor-spaces-2021-10-26/ListRoutes) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/migration-hub-refactor-spaces-2021-10-26/ListRoutes) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/migration-hub-refactor-spaces-2021-10-26/ListRoutes) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/migration-hub-refactor-spaces-2021-10-26/ListRoutes) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/migration-hub-refactor-spaces-2021-10-26/ListRoutes) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/migration-hub-refactor-spaces-2021-10-26/ListRoutes) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/migration-hub-refactor-spaces-2021-10-26/ListRoutes) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/migration-hub-refactor-spaces-2021-10-26/ListRoutes) 

# ListServices


**Note**  
 AWS Migration Hub is no longer open to new customers as of November 7, 2025. For capabilities similar to AWS Migration Hub, explore [AWS Migration Hub](https://aws.amazon.com/transform).

Lists all the AWS Migration Hub Refactor Spaces services within an application. 

## Request Syntax


```
GET /environments/EnvironmentIdentifier/applications/ApplicationIdentifier/services?maxResults=MaxResults&nextToken=NextToken HTTP/1.1
```

## URI Request Parameters


The request uses the following URI parameters.

 ** [ApplicationIdentifier](#API_ListServices_RequestSyntax) **   <a name="migrationhubrefactorspaces-ListServices-request-uri-ApplicationIdentifier"></a>
The ID of the application.   
Length Constraints: Fixed length of 14.  
Pattern: `app-[0-9A-Za-z]{10}`   
Required: Yes

 ** [EnvironmentIdentifier](#API_ListServices_RequestSyntax) **   <a name="migrationhubrefactorspaces-ListServices-request-uri-EnvironmentIdentifier"></a>
The ID of the environment.   
Length Constraints: Fixed length of 14.  
Pattern: `env-[0-9A-Za-z]{10}`   
Required: Yes

 ** [MaxResults](#API_ListServices_RequestSyntax) **   <a name="migrationhubrefactorspaces-ListServices-request-uri-MaxResults"></a>
The maximum number of results to return with a single call. To retrieve the remaining results, make another call with the returned `nextToken` value.  
Valid Range: Minimum value of 1. Maximum value of 100.

 ** [NextToken](#API_ListServices_RequestSyntax) **   <a name="migrationhubrefactorspaces-ListServices-request-uri-NextToken"></a>
The token for the next page of results.  
Length Constraints: Minimum length of 1. Maximum length of 2048.  
Pattern: `[a-zA-Z0-9/\+\=]{0,2048}` 

## Request Body


The request does not have a request body.

## Response Syntax


```
HTTP/1.1 200
Content-type: application/json

{
   "NextToken": "string",
   "ServiceSummaryList": [ 
      { 
         "ApplicationId": "string",
         "Arn": "string",
         "CreatedByAccountId": "string",
         "CreatedTime": number,
         "Description": "string",
         "EndpointType": "string",
         "EnvironmentId": "string",
         "Error": { 
            "AccountId": "string",
            "AdditionalDetails": { 
               "string" : "string" 
            },
            "Code": "string",
            "Message": "string",
            "ResourceIdentifier": "string",
            "ResourceType": "string"
         },
         "LambdaEndpoint": { 
            "Arn": "string"
         },
         "LastUpdatedTime": number,
         "Name": "string",
         "OwnerAccountId": "string",
         "ServiceId": "string",
         "State": "string",
         "Tags": { 
            "string" : "string" 
         },
         "UrlEndpoint": { 
            "HealthUrl": "string",
            "Url": "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.

 ** [NextToken](#API_ListServices_ResponseSyntax) **   <a name="migrationhubrefactorspaces-ListServices-response-NextToken"></a>
The token for the next page of results.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 2048.  
Pattern: `[a-zA-Z0-9/\+\=]{0,2048}` 

 ** [ServiceSummaryList](#API_ListServices_ResponseSyntax) **   <a name="migrationhubrefactorspaces-ListServices-response-ServiceSummaryList"></a>
 The list of `ServiceSummary` objects.   
Type: Array of [ServiceSummary](API_ServiceSummary.md) objects

## Errors


For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

 ** AccessDeniedException **   
The user does not have sufficient access to perform this action.   
HTTP Status Code: 403

 ** ConflictException **   
Updating or deleting a resource can cause an inconsistent state.    
 ** ResourceId **   
The ID of the resource.   
 ** ResourceType **   
The type of resource. 
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.     
 ** ResourceId **   
The ID of the resource.   
 ** ResourceType **   
The type of resource. 
HTTP Status Code: 404

 ** ServiceQuotaExceededException **   
The request would cause a service quota to be exceeded.     
 ** QuotaCode **   
Service quota requirement to identify originating quota. Reached throttling quota exception.   
 ** ResourceId **   
The ID of the resource.   
 ** ResourceType **   
The type of resource.   
 ** ServiceCode **   
Service quota requirement to identify originating service. Reached throttling quota exception service code. 
HTTP Status Code: 402

 ** ThrottlingException **   
Request was denied because the request was throttled.     
 ** QuotaCode **   
Service quota requirement to identify originating quota. Reached throttling quota exception.   
 ** RetryAfterSeconds **   
The number of seconds to wait before retrying.   
 ** ServiceCode **   
Service quota requirement to identify originating service. Reached throttling quota exception service code. 
HTTP Status Code: 429

 ** ValidationException **   
The input does not satisfy the constraints specified by an AWS service.   
HTTP Status Code: 400

## See Also


For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/migration-hub-refactor-spaces-2021-10-26/ListServices) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/migration-hub-refactor-spaces-2021-10-26/ListServices) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/migration-hub-refactor-spaces-2021-10-26/ListServices) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/migration-hub-refactor-spaces-2021-10-26/ListServices) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/migration-hub-refactor-spaces-2021-10-26/ListServices) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/migration-hub-refactor-spaces-2021-10-26/ListServices) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/migration-hub-refactor-spaces-2021-10-26/ListServices) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/migration-hub-refactor-spaces-2021-10-26/ListServices) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/migration-hub-refactor-spaces-2021-10-26/ListServices) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/migration-hub-refactor-spaces-2021-10-26/ListServices) 

# ListTagsForResource


**Note**  
 AWS Migration Hub is no longer open to new customers as of November 7, 2025. For capabilities similar to AWS Migration Hub, explore [AWS Migration Hub](https://aws.amazon.com/transform).

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

## Request Syntax


```
GET /tags/ResourceArn HTTP/1.1
```

## URI Request Parameters


The request uses the following URI parameters.

 ** [ResourceArn](#API_ListTagsForResource_RequestSyntax) **   <a name="migrationhubrefactorspaces-ListTagsForResource-request-uri-ResourceArn"></a>
The Amazon Resource Name (ARN) of the resource.   
Required: Yes

## Request Body


The request does not have a request body.

## Response Syntax


```
HTTP/1.1 200
Content-type: application/json

{
   "Tags": { 
      "string" : "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.

 ** [Tags](#API_ListTagsForResource_ResponseSyntax) **   <a name="migrationhubrefactorspaces-ListTagsForResource-response-Tags"></a>
The list of tags assigned to the resource.   
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.

## Errors


For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

 ** InternalServerException **   
An unexpected error occurred while processing the request.  
HTTP Status Code: 500

 ** ResourceNotFoundException **   
The request references a resource that does not exist.     
 ** ResourceId **   
The ID of the resource.   
 ** ResourceType **   
The type of resource. 
HTTP Status Code: 404

 ** ValidationException **   
The input does not satisfy the constraints specified by an AWS service.   
HTTP Status Code: 400

## See Also


For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/migration-hub-refactor-spaces-2021-10-26/ListTagsForResource) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/migration-hub-refactor-spaces-2021-10-26/ListTagsForResource) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/migration-hub-refactor-spaces-2021-10-26/ListTagsForResource) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/migration-hub-refactor-spaces-2021-10-26/ListTagsForResource) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/migration-hub-refactor-spaces-2021-10-26/ListTagsForResource) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/migration-hub-refactor-spaces-2021-10-26/ListTagsForResource) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/migration-hub-refactor-spaces-2021-10-26/ListTagsForResource) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/migration-hub-refactor-spaces-2021-10-26/ListTagsForResource) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/migration-hub-refactor-spaces-2021-10-26/ListTagsForResource) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/migration-hub-refactor-spaces-2021-10-26/ListTagsForResource) 

# PutResourcePolicy


**Note**  
 AWS Migration Hub is no longer open to new customers as of November 7, 2025. For capabilities similar to AWS Migration Hub, explore [AWS Migration Hub](https://aws.amazon.com/transform).

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

## Request Syntax


```
PUT /resourcepolicy HTTP/1.1
Content-type: application/json

{
   "Policy": "string",
   "ResourceArn": "string"
}
```

## URI Request Parameters


The request does not use any URI parameters.

## Request Body


The request accepts the following data in JSON format.

 ** [Policy](#API_PutResourcePolicy_RequestSyntax) **   <a name="migrationhubrefactorspaces-PutResourcePolicy-request-Policy"></a>
A JSON-formatted string for an AWS resource-based policy.   
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 300000.  
Pattern: `.*\S.*`   
Required: Yes

 ** [ResourceArn](#API_PutResourcePolicy_RequestSyntax) **   <a name="migrationhubrefactorspaces-PutResourcePolicy-request-ResourceArn"></a>
The Amazon Resource Name (ARN) of the resource to which the policy is being attached.   
Type: String  
Length Constraints: Minimum length of 20. Maximum length of 2048.  
Pattern: `arn:aws:refactor-spaces:[a-zA-Z0-9\-]+:\w{12}:[a-zA-Z_0-9+=,.@\-_/]+`   
Required: Yes

## 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


For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

 ** AccessDeniedException **   
The user does not have sufficient access to perform this action.   
HTTP Status Code: 403

 ** InternalServerException **   
An unexpected error occurred while processing the request.  
HTTP Status Code: 500

 ** InvalidResourcePolicyException **   
The resource policy is not valid.  
HTTP Status Code: 400

 ** ResourceNotFoundException **   
The request references a resource that does not exist.     
 ** ResourceId **   
The ID of the resource.   
 ** ResourceType **   
The type of resource. 
HTTP Status Code: 404

 ** ThrottlingException **   
Request was denied because the request was throttled.     
 ** QuotaCode **   
Service quota requirement to identify originating quota. Reached throttling quota exception.   
 ** RetryAfterSeconds **   
The number of seconds to wait before retrying.   
 ** ServiceCode **   
Service quota requirement to identify originating service. Reached throttling quota exception service code. 
HTTP Status Code: 429

 ** ValidationException **   
The input does not satisfy the constraints specified by an AWS service.   
HTTP Status Code: 400

## See Also


For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/migration-hub-refactor-spaces-2021-10-26/PutResourcePolicy) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/migration-hub-refactor-spaces-2021-10-26/PutResourcePolicy) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/migration-hub-refactor-spaces-2021-10-26/PutResourcePolicy) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/migration-hub-refactor-spaces-2021-10-26/PutResourcePolicy) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/migration-hub-refactor-spaces-2021-10-26/PutResourcePolicy) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/migration-hub-refactor-spaces-2021-10-26/PutResourcePolicy) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/migration-hub-refactor-spaces-2021-10-26/PutResourcePolicy) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/migration-hub-refactor-spaces-2021-10-26/PutResourcePolicy) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/migration-hub-refactor-spaces-2021-10-26/PutResourcePolicy) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/migration-hub-refactor-spaces-2021-10-26/PutResourcePolicy) 

# TagResource


**Note**  
 AWS Migration Hub is no longer open to new customers as of November 7, 2025. For capabilities similar to AWS Migration Hub, explore [AWS Migration Hub](https://aws.amazon.com/transform).

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

**Note**  
 AWS Migration Hub Refactor Spaces does not propagate tags to orchestrated resources, such as an environment’s transit gateway.

## Request Syntax


```
POST /tags/ResourceArn HTTP/1.1
Content-type: application/json

{
   "Tags": { 
      "string" : "string" 
   }
}
```

## URI Request Parameters


The request uses the following URI parameters.

 ** [ResourceArn](#API_TagResource_RequestSyntax) **   <a name="migrationhubrefactorspaces-TagResource-request-uri-ResourceArn"></a>
The Amazon Resource Name (ARN) of the resource.  
Required: Yes

## Request Body


The request accepts the following data in JSON format.

 ** [Tags](#API_TagResource_RequestSyntax) **   <a name="migrationhubrefactorspaces-TagResource-request-Tags"></a>
The new or modified tags for the resource.  
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: Yes

## 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


For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

 ** InternalServerException **   
An unexpected error occurred while processing the request.  
HTTP Status Code: 500

 ** ResourceNotFoundException **   
The request references a resource that does not exist.     
 ** ResourceId **   
The ID of the resource.   
 ** ResourceType **   
The type of resource. 
HTTP Status Code: 404

 ** ValidationException **   
The input does not satisfy the constraints specified by an AWS service.   
HTTP Status Code: 400

## See Also


For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/migration-hub-refactor-spaces-2021-10-26/TagResource) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/migration-hub-refactor-spaces-2021-10-26/TagResource) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/migration-hub-refactor-spaces-2021-10-26/TagResource) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/migration-hub-refactor-spaces-2021-10-26/TagResource) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/migration-hub-refactor-spaces-2021-10-26/TagResource) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/migration-hub-refactor-spaces-2021-10-26/TagResource) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/migration-hub-refactor-spaces-2021-10-26/TagResource) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/migration-hub-refactor-spaces-2021-10-26/TagResource) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/migration-hub-refactor-spaces-2021-10-26/TagResource) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/migration-hub-refactor-spaces-2021-10-26/TagResource) 

# UntagResource


**Note**  
 AWS Migration Hub is no longer open to new customers as of November 7, 2025. For capabilities similar to AWS Migration Hub, explore [AWS Migration Hub](https://aws.amazon.com/transform).

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

## Request Syntax


```
DELETE /tags/ResourceArn?tagKeys=TagKeys HTTP/1.1
```

## URI Request Parameters


The request uses the following URI parameters.

 ** [ResourceArn](#API_UntagResource_RequestSyntax) **   <a name="migrationhubrefactorspaces-UntagResource-request-uri-ResourceArn"></a>
The Amazon Resource Name (ARN) of the resource.   
Required: Yes

 ** [TagKeys](#API_UntagResource_RequestSyntax) **   <a name="migrationhubrefactorspaces-UntagResource-request-uri-TagKeys"></a>
The list of keys of the tags to be removed from the resource.   
Required: Yes

## Request Body


The request does not have a 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


For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

 ** InternalServerException **   
An unexpected error occurred while processing the request.  
HTTP Status Code: 500

 ** ResourceNotFoundException **   
The request references a resource that does not exist.     
 ** ResourceId **   
The ID of the resource.   
 ** ResourceType **   
The type of resource. 
HTTP Status Code: 404

 ** ValidationException **   
The input does not satisfy the constraints specified by an AWS service.   
HTTP Status Code: 400

## See Also


For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/migration-hub-refactor-spaces-2021-10-26/UntagResource) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/migration-hub-refactor-spaces-2021-10-26/UntagResource) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/migration-hub-refactor-spaces-2021-10-26/UntagResource) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/migration-hub-refactor-spaces-2021-10-26/UntagResource) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/migration-hub-refactor-spaces-2021-10-26/UntagResource) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/migration-hub-refactor-spaces-2021-10-26/UntagResource) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/migration-hub-refactor-spaces-2021-10-26/UntagResource) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/migration-hub-refactor-spaces-2021-10-26/UntagResource) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/migration-hub-refactor-spaces-2021-10-26/UntagResource) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/migration-hub-refactor-spaces-2021-10-26/UntagResource) 

# UpdateRoute


**Note**  
 AWS Migration Hub is no longer open to new customers as of November 7, 2025. For capabilities similar to AWS Migration Hub, explore [AWS Migration Hub](https://aws.amazon.com/transform).

 Updates an AWS Migration Hub Refactor Spaces route. 

## Request Syntax


```
PATCH /environments/EnvironmentIdentifier/applications/ApplicationIdentifier/routes/RouteIdentifier HTTP/1.1
Content-type: application/json

{
   "ActivationState": "string"
}
```

## URI Request Parameters


The request uses the following URI parameters.

 ** [ApplicationIdentifier](#API_UpdateRoute_RequestSyntax) **   <a name="migrationhubrefactorspaces-UpdateRoute-request-uri-ApplicationIdentifier"></a>
 The ID of the application within which the route is being updated.   
Length Constraints: Fixed length of 14.  
Pattern: `app-[0-9A-Za-z]{10}`   
Required: Yes

 ** [EnvironmentIdentifier](#API_UpdateRoute_RequestSyntax) **   <a name="migrationhubrefactorspaces-UpdateRoute-request-uri-EnvironmentIdentifier"></a>
 The ID of the environment in which the route is being updated.   
Length Constraints: Fixed length of 14.  
Pattern: `env-[0-9A-Za-z]{10}`   
Required: Yes

 ** [RouteIdentifier](#API_UpdateRoute_RequestSyntax) **   <a name="migrationhubrefactorspaces-UpdateRoute-request-uri-RouteIdentifier"></a>
 The unique identifier of the route to update.   
Length Constraints: Fixed length of 14.  
Pattern: `rte-[0-9A-Za-z]{10}`   
Required: Yes

## Request Body


The request accepts the following data in JSON format.

 ** [ActivationState](#API_UpdateRoute_RequestSyntax) **   <a name="migrationhubrefactorspaces-UpdateRoute-request-ActivationState"></a>
 If set to `ACTIVE`, traffic is forwarded to this route’s service after the route is updated.   
Type: String  
Valid Values: `ACTIVE | INACTIVE`   
Required: Yes

## Response Syntax


```
HTTP/1.1 200
Content-type: application/json

{
   "ApplicationId": "string",
   "Arn": "string",
   "LastUpdatedTime": number,
   "RouteId": "string",
   "ServiceId": "string",
   "State": "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.

 ** [ApplicationId](#API_UpdateRoute_ResponseSyntax) **   <a name="migrationhubrefactorspaces-UpdateRoute-response-ApplicationId"></a>
 The ID of the application in which the route is being updated.   
Type: String  
Length Constraints: Fixed length of 14.  
Pattern: `app-[0-9A-Za-z]{10}` 

 ** [Arn](#API_UpdateRoute_ResponseSyntax) **   <a name="migrationhubrefactorspaces-UpdateRoute-response-Arn"></a>
 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)](https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html) in the * AWS General Reference*.   
Type: String  
Length Constraints: Minimum length of 20. Maximum length of 2048.  
Pattern: `arn:aws:refactor-spaces:[a-zA-Z0-9\-]+:\w{12}:[a-zA-Z_0-9+=,.@\-_/]+` 

 ** [LastUpdatedTime](#API_UpdateRoute_ResponseSyntax) **   <a name="migrationhubrefactorspaces-UpdateRoute-response-LastUpdatedTime"></a>
 A timestamp that indicates when the route was last updated.   
Type: Timestamp

 ** [RouteId](#API_UpdateRoute_ResponseSyntax) **   <a name="migrationhubrefactorspaces-UpdateRoute-response-RouteId"></a>
 The unique identifier of the route.   
Type: String  
Length Constraints: Fixed length of 14.  
Pattern: `rte-[0-9A-Za-z]{10}` 

 ** [ServiceId](#API_UpdateRoute_ResponseSyntax) **   <a name="migrationhubrefactorspaces-UpdateRoute-response-ServiceId"></a>
 The ID of service in which the route was created. Traffic that matches this route is forwarded to this service.   
Type: String  
Length Constraints: Fixed length of 14.  
Pattern: `svc-[0-9A-Za-z]{10}` 

 ** [State](#API_UpdateRoute_ResponseSyntax) **   <a name="migrationhubrefactorspaces-UpdateRoute-response-State"></a>
 The current state of the route.   
Type: String  
Valid Values: `CREATING | ACTIVE | DELETING | FAILED | UPDATING | INACTIVE` 

## Errors


For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

 ** AccessDeniedException **   
The user does not have sufficient access to perform this action.   
HTTP Status Code: 403

 ** InternalServerException **   
An unexpected error occurred while processing the request.  
HTTP Status Code: 500

 ** ResourceNotFoundException **   
The request references a resource that does not exist.     
 ** ResourceId **   
The ID of the resource.   
 ** ResourceType **   
The type of resource. 
HTTP Status Code: 404

 ** ThrottlingException **   
Request was denied because the request was throttled.     
 ** QuotaCode **   
Service quota requirement to identify originating quota. Reached throttling quota exception.   
 ** RetryAfterSeconds **   
The number of seconds to wait before retrying.   
 ** ServiceCode **   
Service quota requirement to identify originating service. Reached throttling quota exception service code. 
HTTP Status Code: 429

 ** ValidationException **   
The input does not satisfy the constraints specified by an AWS service.   
HTTP Status Code: 400

## See Also


For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/migration-hub-refactor-spaces-2021-10-26/UpdateRoute) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/migration-hub-refactor-spaces-2021-10-26/UpdateRoute) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/migration-hub-refactor-spaces-2021-10-26/UpdateRoute) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/migration-hub-refactor-spaces-2021-10-26/UpdateRoute) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/migration-hub-refactor-spaces-2021-10-26/UpdateRoute) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/migration-hub-refactor-spaces-2021-10-26/UpdateRoute) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/migration-hub-refactor-spaces-2021-10-26/UpdateRoute) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/migration-hub-refactor-spaces-2021-10-26/UpdateRoute) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/migration-hub-refactor-spaces-2021-10-26/UpdateRoute) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/migration-hub-refactor-spaces-2021-10-26/UpdateRoute)