Request Syntax URI Request Parameters Request Body Response Syntax Response Elements Errors See Also

CreateApplication

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

In environments created with a CreateEnvironment:NetworkFabricType of NONE you need to configure VPC to VPC connectivity 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 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

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

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

Type: ApiGatewayProxyInput object

Required: No

ClientToken

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

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

The proxy type of the proxy created within the application.

Type: String

Valid Values: API_GATEWAY

Required: Yes

Tags

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

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

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

Type: ApiGatewayProxyInput object

ApplicationId

The unique identifier of the application.

Type: String

Length Constraints: Fixed length of 14.

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

Arn

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

Type: String

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

The AWS account ID of application creator.

Type: String

Length Constraints: Fixed length of 12.

Pattern: ^\d{12}$

CreatedTime

A timestamp that indicates when the application is created.

Type: Timestamp

EnvironmentId

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

A timestamp that indicates when the application was last updated.

Type: Timestamp

Name

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

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

The proxy type of the proxy created within the application.

Type: String

Valid Values: API_GATEWAY

State

The current state of the application.

Type: String

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

Tags

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

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

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.

HTTP Status Code: 409

InternalServerException

An unexpected error occurred while processing the request.

HTTP Status Code: 500

ResourceNotFoundException

The request references a resource that does not exist.

HTTP Status Code: 404

ServiceQuotaExceededException

The request would cause a service quota to be exceeded.

HTTP Status Code: 402

ThrottlingException

Request was denied because the request was throttled.

HTTP Status Code: 429

ValidationException

The input does not satisfy the constraints specified by an AWS service.

HTTP Status Code: 400