# CreateService
<a name="API_CreateService"></a>

**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
<a name="API_CreateService_RequestSyntax"></a>

```
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
<a name="API_CreateService_RequestParameters"></a>

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
<a name="API_CreateService_RequestBody"></a>

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
<a name="API_CreateService_ResponseSyntax"></a>

```
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
<a name="API_CreateService_ResponseElements"></a>

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
<a name="API_CreateService_Errors"></a>

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
<a name="API_CreateService_SeeAlso"></a>

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)