# Data Types
<a name="API_Types"></a>

The AWS Migration Hub Refactor Spaces API contains several data types that various actions use. This section describes each data type in detail.

**Note**  
The order of each element in a data type structure is not guaranteed. Applications should not assume a particular order.

The following data types are supported:
+  [ApiGatewayProxyConfig](API_ApiGatewayProxyConfig.md) 
+  [ApiGatewayProxyInput](API_ApiGatewayProxyInput.md) 
+  [ApiGatewayProxySummary](API_ApiGatewayProxySummary.md) 
+  [ApplicationSummary](API_ApplicationSummary.md) 
+  [DefaultRouteInput](API_DefaultRouteInput.md) 
+  [EnvironmentSummary](API_EnvironmentSummary.md) 
+  [EnvironmentVpc](API_EnvironmentVpc.md) 
+  [ErrorResponse](API_ErrorResponse.md) 
+  [LambdaEndpointConfig](API_LambdaEndpointConfig.md) 
+  [LambdaEndpointInput](API_LambdaEndpointInput.md) 
+  [LambdaEndpointSummary](API_LambdaEndpointSummary.md) 
+  [RouteSummary](API_RouteSummary.md) 
+  [ServiceSummary](API_ServiceSummary.md) 
+  [UriPathRouteInput](API_UriPathRouteInput.md) 
+  [UrlEndpointConfig](API_UrlEndpointConfig.md) 
+  [UrlEndpointInput](API_UrlEndpointInput.md) 
+  [UrlEndpointSummary](API_UrlEndpointSummary.md) 

# ApiGatewayProxyConfig
<a name="API_ApiGatewayProxyConfig"></a>

A wrapper object holding the Amazon API Gateway proxy configuration. 

## Contents
<a name="API_ApiGatewayProxyConfig_Contents"></a>

 ** ApiGatewayId **   <a name="migrationhubrefactorspaces-Type-ApiGatewayProxyConfig-ApiGatewayId"></a>
The resource ID of the API Gateway for the proxy.   
Type: String  
Length Constraints: Fixed length of 10.  
Pattern: `[a-z0-9]{10}`   
Required: No

 ** EndpointType **   <a name="migrationhubrefactorspaces-Type-ApiGatewayProxyConfig-EndpointType"></a>
The type of API Gateway endpoint created.   
Type: String  
Valid Values: `REGIONAL | PRIVATE`   
Required: No

 ** NlbArn **   <a name="migrationhubrefactorspaces-Type-ApiGatewayProxyConfig-NlbArn"></a>
The Amazon Resource Name (ARN) of the Network Load Balancer configured by the API Gateway proxy.   
Type: String  
Length Constraints: Minimum length of 20. Maximum length of 2048.  
Pattern: `arn:aws:elasticloadbalancing:[a-zA-Z0-9\-]+:\w{12}:[a-zA-Z_0-9+=,.@\-_/]+`   
Required: No

 ** NlbName **   <a name="migrationhubrefactorspaces-Type-ApiGatewayProxyConfig-NlbName"></a>
The name of the Network Load Balancer that is configured by the API Gateway proxy.   
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 32.  
Pattern: `(?!internal-)[a-zA-Z0-9]+[a-zA-Z0-9-_ ]+.*[^-]`   
Required: No

 ** ProxyUrl **   <a name="migrationhubrefactorspaces-Type-ApiGatewayProxyConfig-ProxyUrl"></a>
The endpoint URL of the API Gateway proxy.   
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 2048.  
Pattern: `https?://[-a-zA-Z0-9+\x38@#/%?=~_|!:,.;]*[-a-zA-Z0-9+\x38@#/%=~_|]`   
Required: No

 ** StageName **   <a name="migrationhubrefactorspaces-Type-ApiGatewayProxyConfig-StageName"></a>
The name of the API Gateway stage. The name defaults to `prod`.   
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 128.  
Pattern: `[-a-zA-Z0-9_]*`   
Required: No

 ** VpcLinkId **   <a name="migrationhubrefactorspaces-Type-ApiGatewayProxyConfig-VpcLinkId"></a>
The `VpcLink` ID of the API Gateway proxy.   
Type: String  
Length Constraints: Fixed length of 10.  
Pattern: `[a-z0-9]{10}`   
Required: No

## See Also
<a name="API_ApiGatewayProxyConfig_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/migration-hub-refactor-spaces-2021-10-26/ApiGatewayProxyConfig) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/migration-hub-refactor-spaces-2021-10-26/ApiGatewayProxyConfig) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/migration-hub-refactor-spaces-2021-10-26/ApiGatewayProxyConfig) 

# ApiGatewayProxyInput
<a name="API_ApiGatewayProxyInput"></a>

A wrapper object holding the Amazon API Gateway endpoint input. 

## Contents
<a name="API_ApiGatewayProxyInput_Contents"></a>

 ** EndpointType **   <a name="migrationhubrefactorspaces-Type-ApiGatewayProxyInput-EndpointType"></a>
The type of endpoint to use for the API Gateway proxy. If no value is specified in the request, the value is set to `REGIONAL` by default.  
If the value is set to `PRIVATE` in the request, this creates a private API endpoint that is isolated from the public internet. The private endpoint can only be accessed by using Amazon Virtual Private Cloud (Amazon VPC) interface endpoints for the Amazon API Gateway that has been granted access. For more information about creating a private connection with Refactor Spaces and interface endpoint (AWS PrivateLink) availability, see [Access Refactor Spaces using an interface endpoint (AWS PrivateLink)](https://docs.aws.amazon.com/migrationhub-refactor-spaces/latest/userguide/vpc-interface-endpoints.html).  
Type: String  
Valid Values: `REGIONAL | PRIVATE`   
Required: No

 ** StageName **   <a name="migrationhubrefactorspaces-Type-ApiGatewayProxyInput-StageName"></a>
The name of the API Gateway stage. The name defaults to `prod`.   
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 128.  
Pattern: `[-a-zA-Z0-9_]*`   
Required: No

## See Also
<a name="API_ApiGatewayProxyInput_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/migration-hub-refactor-spaces-2021-10-26/ApiGatewayProxyInput) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/migration-hub-refactor-spaces-2021-10-26/ApiGatewayProxyInput) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/migration-hub-refactor-spaces-2021-10-26/ApiGatewayProxyInput) 

# ApiGatewayProxySummary
<a name="API_ApiGatewayProxySummary"></a>

A wrapper object holding the Amazon API Gateway proxy summary. 

## Contents
<a name="API_ApiGatewayProxySummary_Contents"></a>

 ** ApiGatewayId **   <a name="migrationhubrefactorspaces-Type-ApiGatewayProxySummary-ApiGatewayId"></a>
The resource ID of the API Gateway for the proxy.   
Type: String  
Length Constraints: Fixed length of 10.  
Pattern: `[a-z0-9]{10}`   
Required: No

 ** EndpointType **   <a name="migrationhubrefactorspaces-Type-ApiGatewayProxySummary-EndpointType"></a>
The type of API Gateway endpoint created.   
Type: String  
Valid Values: `REGIONAL | PRIVATE`   
Required: No

 ** NlbArn **   <a name="migrationhubrefactorspaces-Type-ApiGatewayProxySummary-NlbArn"></a>
The Amazon Resource Name (ARN) of the Network Load Balancer configured by the API Gateway proxy.   
Type: String  
Length Constraints: Minimum length of 20. Maximum length of 2048.  
Pattern: `arn:aws:elasticloadbalancing:[a-zA-Z0-9\-]+:\w{12}:[a-zA-Z_0-9+=,.@\-_/]+`   
Required: No

 ** NlbName **   <a name="migrationhubrefactorspaces-Type-ApiGatewayProxySummary-NlbName"></a>
The name of the Network Load Balancer that is configured by the API Gateway proxy.   
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 32.  
Pattern: `(?!internal-)[a-zA-Z0-9]+[a-zA-Z0-9-_ ]+.*[^-]`   
Required: No

 ** ProxyUrl **   <a name="migrationhubrefactorspaces-Type-ApiGatewayProxySummary-ProxyUrl"></a>
The endpoint URL of the API Gateway proxy.   
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 2048.  
Pattern: `https?://[-a-zA-Z0-9+\x38@#/%?=~_|!:,.;]*[-a-zA-Z0-9+\x38@#/%=~_|]`   
Required: No

 ** StageName **   <a name="migrationhubrefactorspaces-Type-ApiGatewayProxySummary-StageName"></a>
The name of the API Gateway stage. The name defaults to `prod`.   
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 128.  
Pattern: `[-a-zA-Z0-9_]*`   
Required: No

 ** VpcLinkId **   <a name="migrationhubrefactorspaces-Type-ApiGatewayProxySummary-VpcLinkId"></a>
The `VpcLink` ID of the API Gateway proxy.   
Type: String  
Length Constraints: Fixed length of 10.  
Pattern: `[a-z0-9]{10}`   
Required: No

## See Also
<a name="API_ApiGatewayProxySummary_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/migration-hub-refactor-spaces-2021-10-26/ApiGatewayProxySummary) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/migration-hub-refactor-spaces-2021-10-26/ApiGatewayProxySummary) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/migration-hub-refactor-spaces-2021-10-26/ApiGatewayProxySummary) 

# ApplicationSummary
<a name="API_ApplicationSummary"></a>

The list of `ApplicationSummary` objects. 

## Contents
<a name="API_ApplicationSummary_Contents"></a>

 ** ApiGatewayProxy **   <a name="migrationhubrefactorspaces-Type-ApplicationSummary-ApiGatewayProxy"></a>
The endpoint URL of the Amazon API Gateway proxy.   
Type: [ApiGatewayProxySummary](API_ApiGatewayProxySummary.md) object  
Required: No

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

 ** Arn **   <a name="migrationhubrefactorspaces-Type-ApplicationSummary-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+=,.@\-_/]+`   
Required: No

 ** CreatedByAccountId **   <a name="migrationhubrefactorspaces-Type-ApplicationSummary-CreatedByAccountId"></a>
The AWS account ID of the application creator.   
Type: String  
Length Constraints: Fixed length of 12.  
Pattern: `\d{12}`   
Required: No

 ** CreatedTime **   <a name="migrationhubrefactorspaces-Type-ApplicationSummary-CreatedTime"></a>
A timestamp that indicates when the application is created.   
Type: Timestamp  
Required: No

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

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

 ** LastUpdatedTime **   <a name="migrationhubrefactorspaces-Type-ApplicationSummary-LastUpdatedTime"></a>
A timestamp that indicates when the application was last updated.   
Type: Timestamp  
Required: No

 ** Name **   <a name="migrationhubrefactorspaces-Type-ApplicationSummary-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-_ ]+`   
Required: No

 ** OwnerAccountId **   <a name="migrationhubrefactorspaces-Type-ApplicationSummary-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}`   
Required: No

 ** ProxyType **   <a name="migrationhubrefactorspaces-Type-ApplicationSummary-ProxyType"></a>
The proxy type of the proxy created within the application.   
Type: String  
Valid Values: `API_GATEWAY`   
Required: No

 ** State **   <a name="migrationhubrefactorspaces-Type-ApplicationSummary-State"></a>
The current state of the application.   
Type: String  
Valid Values: `CREATING | ACTIVE | DELETING | FAILED | UPDATING`   
Required: No

 ** Tags **   <a name="migrationhubrefactorspaces-Type-ApplicationSummary-Tags"></a>
The tags assigned to the application.   
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 **   <a name="migrationhubrefactorspaces-Type-ApplicationSummary-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: No

## See Also
<a name="API_ApplicationSummary_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/migration-hub-refactor-spaces-2021-10-26/ApplicationSummary) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/migration-hub-refactor-spaces-2021-10-26/ApplicationSummary) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/migration-hub-refactor-spaces-2021-10-26/ApplicationSummary) 

# DefaultRouteInput
<a name="API_DefaultRouteInput"></a>

 The configuration for the default route type. 

## Contents
<a name="API_DefaultRouteInput_Contents"></a>

 ** ActivationState **   <a name="migrationhubrefactorspaces-Type-DefaultRouteInput-ActivationState"></a>
If set to `ACTIVE`, traffic is forwarded to this route’s service after the route is created.   
Type: String  
Valid Values: `ACTIVE | INACTIVE`   
Required: No

## See Also
<a name="API_DefaultRouteInput_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/migration-hub-refactor-spaces-2021-10-26/DefaultRouteInput) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/migration-hub-refactor-spaces-2021-10-26/DefaultRouteInput) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/migration-hub-refactor-spaces-2021-10-26/DefaultRouteInput) 

# EnvironmentSummary
<a name="API_EnvironmentSummary"></a>

The summary information for environments as a response to `ListEnvironments`. 

## Contents
<a name="API_EnvironmentSummary_Contents"></a>

 ** Arn **   <a name="migrationhubrefactorspaces-Type-EnvironmentSummary-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+=,.@\-_/]+`   
Required: No

 ** CreatedTime **   <a name="migrationhubrefactorspaces-Type-EnvironmentSummary-CreatedTime"></a>
A timestamp that indicates when the environment is created.   
Type: Timestamp  
Required: No

 ** Description **   <a name="migrationhubrefactorspaces-Type-EnvironmentSummary-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\.\!\*\#\@\']+`   
Required: No

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

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

 ** LastUpdatedTime **   <a name="migrationhubrefactorspaces-Type-EnvironmentSummary-LastUpdatedTime"></a>
A timestamp that indicates when the environment was last updated.   
Type: Timestamp  
Required: No

 ** Name **   <a name="migrationhubrefactorspaces-Type-EnvironmentSummary-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: No

 ** NetworkFabricType **   <a name="migrationhubrefactorspaces-Type-EnvironmentSummary-NetworkFabricType"></a>
The network fabric type of the environment.   
Type: String  
Valid Values: `TRANSIT_GATEWAY | NONE`   
Required: No

 ** OwnerAccountId **   <a name="migrationhubrefactorspaces-Type-EnvironmentSummary-OwnerAccountId"></a>
The AWS account ID of the environment owner.  
Type: String  
Length Constraints: Fixed length of 12.  
Pattern: `\d{12}`   
Required: No

 ** State **   <a name="migrationhubrefactorspaces-Type-EnvironmentSummary-State"></a>
The current state of the environment.   
Type: String  
Valid Values: `CREATING | ACTIVE | DELETING | FAILED`   
Required: No

 ** Tags **   <a name="migrationhubrefactorspaces-Type-EnvironmentSummary-Tags"></a>
The tags assigned to the environment.   
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

 ** TransitGatewayId **   <a name="migrationhubrefactorspaces-Type-EnvironmentSummary-TransitGatewayId"></a>
The ID of the AWS Transit Gateway set up by the environment.   
Type: String  
Length Constraints: Fixed length of 21.  
Pattern: `tgw-[-a-f0-9]{17}`   
Required: No

## See Also
<a name="API_EnvironmentSummary_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/migration-hub-refactor-spaces-2021-10-26/EnvironmentSummary) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/migration-hub-refactor-spaces-2021-10-26/EnvironmentSummary) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/migration-hub-refactor-spaces-2021-10-26/EnvironmentSummary) 

# EnvironmentVpc
<a name="API_EnvironmentVpc"></a>

Provides summary information for the `EnvironmentVpc` resource as a response to `ListEnvironmentVpc`.

## Contents
<a name="API_EnvironmentVpc_Contents"></a>

 ** AccountId **   <a name="migrationhubrefactorspaces-Type-EnvironmentVpc-AccountId"></a>
The AWS account ID of the virtual private cloud (VPC) owner.   
Type: String  
Length Constraints: Fixed length of 12.  
Pattern: `\d{12}`   
Required: No

 ** CidrBlocks **   <a name="migrationhubrefactorspaces-Type-EnvironmentVpc-CidrBlocks"></a>
The list of Amazon Virtual Private Cloud (Amazon VPC) CIDR blocks.   
Type: Array of strings  
Array Members: Minimum number of 1 item.  
Required: No

 ** CreatedTime **   <a name="migrationhubrefactorspaces-Type-EnvironmentVpc-CreatedTime"></a>
A timestamp that indicates when the VPC is first added to the environment.   
Type: Timestamp  
Required: No

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

 ** LastUpdatedTime **   <a name="migrationhubrefactorspaces-Type-EnvironmentVpc-LastUpdatedTime"></a>
A timestamp that indicates when the VPC was last updated by the environment.   
Type: Timestamp  
Required: No

 ** VpcId **   <a name="migrationhubrefactorspaces-Type-EnvironmentVpc-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

 ** VpcName **   <a name="migrationhubrefactorspaces-Type-EnvironmentVpc-VpcName"></a>
The name of the VPC at the time it is added to the environment.   
Type: String  
Length Constraints: Minimum length of 0. Maximum length of 255.  
Pattern: `.*`   
Required: No

## See Also
<a name="API_EnvironmentVpc_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/migration-hub-refactor-spaces-2021-10-26/EnvironmentVpc) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/migration-hub-refactor-spaces-2021-10-26/EnvironmentVpc) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/migration-hub-refactor-spaces-2021-10-26/EnvironmentVpc) 

# ErrorResponse
<a name="API_ErrorResponse"></a>

Error associated with a resource returned for a Get or List resource response. 

## Contents
<a name="API_ErrorResponse_Contents"></a>

 ** AccountId **   <a name="migrationhubrefactorspaces-Type-ErrorResponse-AccountId"></a>
The AWS account ID of the resource owner.   
Type: String  
Length Constraints: Fixed length of 12.  
Pattern: `\d{12}`   
Required: No

 ** AdditionalDetails **   <a name="migrationhubrefactorspaces-Type-ErrorResponse-AdditionalDetails"></a>
Additional details about the error.   
Type: String to string map  
Key Length Constraints: Minimum length of 1. Maximum length of 50.  
Value Length Constraints: Minimum length of 1. Maximum length of 2048.  
Required: No

 ** Code **   <a name="migrationhubrefactorspaces-Type-ErrorResponse-Code"></a>
The error code associated with the error.   
Type: String  
Valid Values: `INVALID_RESOURCE_STATE | RESOURCE_LIMIT_EXCEEDED | RESOURCE_CREATION_FAILURE | RESOURCE_UPDATE_FAILURE | SERVICE_ENDPOINT_HEALTH_CHECK_FAILURE | RESOURCE_DELETION_FAILURE | RESOURCE_RETRIEVAL_FAILURE | RESOURCE_IN_USE | RESOURCE_NOT_FOUND | STATE_TRANSITION_FAILURE | REQUEST_LIMIT_EXCEEDED | NOT_AUTHORIZED`   
Required: No

 ** Message **   <a name="migrationhubrefactorspaces-Type-ErrorResponse-Message"></a>
The message associated with the error.   
Type: String  
Length Constraints: Minimum length of 0. Maximum length of 255.  
Pattern: `[\p{Alnum}\p{Punct}\p{Blank}]*`   
Required: No

 ** ResourceIdentifier **   <a name="migrationhubrefactorspaces-Type-ErrorResponse-ResourceIdentifier"></a>
The ID of the resource.   
Type: String  
Length Constraints: Minimum length of 3. Maximum length of 63.  
Pattern: `.*(^(env|svc|pxy|rte|app)-([0-9A-Za-z]{10}$)).*`   
Required: No

 ** ResourceType **   <a name="migrationhubrefactorspaces-Type-ErrorResponse-ResourceType"></a>
The type of resource.   
Type: String  
Valid Values: `ENVIRONMENT | APPLICATION | ROUTE | SERVICE | TRANSIT_GATEWAY | TRANSIT_GATEWAY_ATTACHMENT | API_GATEWAY | NLB | TARGET_GROUP | LOAD_BALANCER_LISTENER | VPC_LINK | LAMBDA | VPC | SUBNET | ROUTE_TABLE | SECURITY_GROUP | VPC_ENDPOINT_SERVICE_CONFIGURATION | RESOURCE_SHARE | IAM_ROLE`   
Required: No

## See Also
<a name="API_ErrorResponse_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/migration-hub-refactor-spaces-2021-10-26/ErrorResponse) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/migration-hub-refactor-spaces-2021-10-26/ErrorResponse) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/migration-hub-refactor-spaces-2021-10-26/ErrorResponse) 

# LambdaEndpointConfig
<a name="API_LambdaEndpointConfig"></a>

The configuration for the AWS Lambda endpoint type. 

## Contents
<a name="API_LambdaEndpointConfig_Contents"></a>

 ** Arn **   <a name="migrationhubrefactorspaces-Type-LambdaEndpointConfig-Arn"></a>
The Amazon Resource Name (ARN) of the Lambda endpoint.   
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 2048.  
Pattern: `arn:(aws[a-zA-Z-]*)?:lambda:[a-z]{2}((-gov)|(-iso(b?)))?-[a-z]+-\d{1}:\d{12}:function:[a-zA-Z0-9-_]+(:(\$LATEST|[a-zA-Z0-9-_]+))?`   
Required: No

## See Also
<a name="API_LambdaEndpointConfig_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/migration-hub-refactor-spaces-2021-10-26/LambdaEndpointConfig) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/migration-hub-refactor-spaces-2021-10-26/LambdaEndpointConfig) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/migration-hub-refactor-spaces-2021-10-26/LambdaEndpointConfig) 

# LambdaEndpointInput
<a name="API_LambdaEndpointInput"></a>

The input for the AWS Lambda endpoint type. 

## Contents
<a name="API_LambdaEndpointInput_Contents"></a>

 ** Arn **   <a name="migrationhubrefactorspaces-Type-LambdaEndpointInput-Arn"></a>
The Amazon Resource Name (ARN) of the Lambda function or alias.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 2048.  
Pattern: `arn:(aws[a-zA-Z-]*)?:lambda:[a-z]{2}((-gov)|(-iso(b?)))?-[a-z]+-\d{1}:\d{12}:function:[a-zA-Z0-9-_]+(:(\$LATEST|[a-zA-Z0-9-_]+))?`   
Required: Yes

## See Also
<a name="API_LambdaEndpointInput_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/migration-hub-refactor-spaces-2021-10-26/LambdaEndpointInput) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/migration-hub-refactor-spaces-2021-10-26/LambdaEndpointInput) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/migration-hub-refactor-spaces-2021-10-26/LambdaEndpointInput) 

# LambdaEndpointSummary
<a name="API_LambdaEndpointSummary"></a>

The summary for the AWS Lambda endpoint type. 

## Contents
<a name="API_LambdaEndpointSummary_Contents"></a>

 ** Arn **   <a name="migrationhubrefactorspaces-Type-LambdaEndpointSummary-Arn"></a>
The Amazon Resource Name (ARN) of the Lambda endpoint.   
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 2048.  
Pattern: `arn:(aws[a-zA-Z-]*)?:lambda:[a-z]{2}((-gov)|(-iso(b?)))?-[a-z]+-\d{1}:\d{12}:function:[a-zA-Z0-9-_]+(:(\$LATEST|[a-zA-Z0-9-_]+))?`   
Required: No

## See Also
<a name="API_LambdaEndpointSummary_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/migration-hub-refactor-spaces-2021-10-26/LambdaEndpointSummary) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/migration-hub-refactor-spaces-2021-10-26/LambdaEndpointSummary) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/migration-hub-refactor-spaces-2021-10-26/LambdaEndpointSummary) 

# RouteSummary
<a name="API_RouteSummary"></a>

The summary information for the routes as a response to `ListRoutes`. 

## Contents
<a name="API_RouteSummary_Contents"></a>

 ** AppendSourcePath **   <a name="migrationhubrefactorspaces-Type-RouteSummary-AppendSourcePath"></a>
If set to `true`, this option appends the source path to the service URL endpoint.  
Type: Boolean  
Required: No

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

 ** Arn **   <a name="migrationhubrefactorspaces-Type-RouteSummary-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+=,.@\-_/]+`   
Required: No

 ** CreatedByAccountId **   <a name="migrationhubrefactorspaces-Type-RouteSummary-CreatedByAccountId"></a>
The AWS account ID of the route creator.   
Type: String  
Length Constraints: Fixed length of 12.  
Pattern: `\d{12}`   
Required: No

 ** CreatedTime **   <a name="migrationhubrefactorspaces-Type-RouteSummary-CreatedTime"></a>
A timestamp that indicates when the route is created.   
Type: Timestamp  
Required: No

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

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

 ** IncludeChildPaths **   <a name="migrationhubrefactorspaces-Type-RouteSummary-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  
Required: No

 ** LastUpdatedTime **   <a name="migrationhubrefactorspaces-Type-RouteSummary-LastUpdatedTime"></a>
A timestamp that indicates when the route was last updated.   
Type: Timestamp  
Required: No

 ** Methods **   <a name="migrationhubrefactorspaces-Type-RouteSummary-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`   
Required: No

 ** OwnerAccountId **   <a name="migrationhubrefactorspaces-Type-RouteSummary-OwnerAccountId"></a>
The AWS account ID of the route owner.  
Type: String  
Length Constraints: Fixed length of 12.  
Pattern: `\d{12}`   
Required: No

 ** PathResourceToId **   <a name="migrationhubrefactorspaces-Type-RouteSummary-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}`   
Required: No

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

 ** RouteType **   <a name="migrationhubrefactorspaces-Type-RouteSummary-RouteType"></a>
The route type of the route.   
Type: String  
Valid Values: `DEFAULT | URI_PATH`   
Required: No

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

 ** SourcePath **   <a name="migrationhubrefactorspaces-Type-RouteSummary-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._:-]+\}))+`   
Required: No

 ** State **   <a name="migrationhubrefactorspaces-Type-RouteSummary-State"></a>
The current state of the route.   
Type: String  
Valid Values: `CREATING | ACTIVE | DELETING | FAILED | UPDATING | INACTIVE`   
Required: No

 ** Tags **   <a name="migrationhubrefactorspaces-Type-RouteSummary-Tags"></a>
The tags assigned to the route.   
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

## See Also
<a name="API_RouteSummary_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/migration-hub-refactor-spaces-2021-10-26/RouteSummary) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/migration-hub-refactor-spaces-2021-10-26/RouteSummary) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/migration-hub-refactor-spaces-2021-10-26/RouteSummary) 

# ServiceSummary
<a name="API_ServiceSummary"></a>

A summary for the service as a response to `ListServices`. 

## Contents
<a name="API_ServiceSummary_Contents"></a>

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

 ** Arn **   <a name="migrationhubrefactorspaces-Type-ServiceSummary-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+=,.@\-_/]+`   
Required: No

 ** CreatedByAccountId **   <a name="migrationhubrefactorspaces-Type-ServiceSummary-CreatedByAccountId"></a>
The AWS account ID of the service creator.   
Type: String  
Length Constraints: Fixed length of 12.  
Pattern: `\d{12}`   
Required: No

 ** CreatedTime **   <a name="migrationhubrefactorspaces-Type-ServiceSummary-CreatedTime"></a>
A timestamp that indicates when the service is created.   
Type: Timestamp  
Required: No

 ** Description **   <a name="migrationhubrefactorspaces-Type-ServiceSummary-Description"></a>
A 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 **   <a name="migrationhubrefactorspaces-Type-ServiceSummary-EndpointType"></a>
The endpoint type of the service.   
Type: String  
Valid Values: `LAMBDA | URL`   
Required: No

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

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

 ** LambdaEndpoint **   <a name="migrationhubrefactorspaces-Type-ServiceSummary-LambdaEndpoint"></a>
A summary of the configuration for the AWS Lambda endpoint type.   
Type: [LambdaEndpointSummary](API_LambdaEndpointSummary.md) object  
Required: No

 ** LastUpdatedTime **   <a name="migrationhubrefactorspaces-Type-ServiceSummary-LastUpdatedTime"></a>
A timestamp that indicates when the service was last updated.   
Type: Timestamp  
Required: No

 ** Name **   <a name="migrationhubrefactorspaces-Type-ServiceSummary-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: No

 ** OwnerAccountId **   <a name="migrationhubrefactorspaces-Type-ServiceSummary-OwnerAccountId"></a>
The AWS account ID of the service owner.  
Type: String  
Length Constraints: Fixed length of 12.  
Pattern: `\d{12}`   
Required: No

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

 ** State **   <a name="migrationhubrefactorspaces-Type-ServiceSummary-State"></a>
The current state of the service.   
Type: String  
Valid Values: `CREATING | ACTIVE | DELETING | FAILED`   
Required: No

 ** Tags **   <a name="migrationhubrefactorspaces-Type-ServiceSummary-Tags"></a>
The tags assigned to the service.   
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 **   <a name="migrationhubrefactorspaces-Type-ServiceSummary-UrlEndpoint"></a>
The summary of the configuration for the URL endpoint type.   
Type: [UrlEndpointSummary](API_UrlEndpointSummary.md) object  
Required: No

 ** VpcId **   <a name="migrationhubrefactorspaces-Type-ServiceSummary-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: No

## See Also
<a name="API_ServiceSummary_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/migration-hub-refactor-spaces-2021-10-26/ServiceSummary) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/migration-hub-refactor-spaces-2021-10-26/ServiceSummary) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/migration-hub-refactor-spaces-2021-10-26/ServiceSummary) 

# UriPathRouteInput
<a name="API_UriPathRouteInput"></a>

The configuration for the URI path route type. 

## Contents
<a name="API_UriPathRouteInput_Contents"></a>

 ** ActivationState **   <a name="migrationhubrefactorspaces-Type-UriPathRouteInput-ActivationState"></a>
If set to `ACTIVE`, traffic is forwarded to this route’s service after the route is created.   
Type: String  
Valid Values: `ACTIVE | INACTIVE`   
Required: Yes

 ** SourcePath **   <a name="migrationhubrefactorspaces-Type-UriPathRouteInput-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._:-]+\}))+`   
Required: Yes

 ** AppendSourcePath **   <a name="migrationhubrefactorspaces-Type-UriPathRouteInput-AppendSourcePath"></a>
If set to `true`, this option appends the source path to the service URL endpoint.  
Type: Boolean  
Required: No

 ** IncludeChildPaths **   <a name="migrationhubrefactorspaces-Type-UriPathRouteInput-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  
Required: No

 ** Methods **   <a name="migrationhubrefactorspaces-Type-UriPathRouteInput-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`   
Required: No

## See Also
<a name="API_UriPathRouteInput_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/migration-hub-refactor-spaces-2021-10-26/UriPathRouteInput) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/migration-hub-refactor-spaces-2021-10-26/UriPathRouteInput) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/migration-hub-refactor-spaces-2021-10-26/UriPathRouteInput) 

# UrlEndpointConfig
<a name="API_UrlEndpointConfig"></a>

The configuration for the URL endpoint type. 

## Contents
<a name="API_UrlEndpointConfig_Contents"></a>

 ** HealthUrl **   <a name="migrationhubrefactorspaces-Type-UrlEndpointConfig-HealthUrl"></a>
The health check URL of the URL endpoint type.   
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 2048.  
Pattern: `https?://[-a-zA-Z0-9+\x38@#/%?=~_|!:,.;]*[-a-zA-Z0-9+\x38@#/%=~_|]`   
Required: No

 ** Url **   <a name="migrationhubrefactorspaces-Type-UrlEndpointConfig-Url"></a>
The HTTP URL endpoint.   
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 2048.  
Pattern: `https?://[-a-zA-Z0-9+\x38@#/%?=~_|!:,.;]*[-a-zA-Z0-9+\x38@#/%=~_|]`   
Required: No

## See Also
<a name="API_UrlEndpointConfig_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/migration-hub-refactor-spaces-2021-10-26/UrlEndpointConfig) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/migration-hub-refactor-spaces-2021-10-26/UrlEndpointConfig) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/migration-hub-refactor-spaces-2021-10-26/UrlEndpointConfig) 

# UrlEndpointInput
<a name="API_UrlEndpointInput"></a>

The configuration for the URL endpoint type. 

## Contents
<a name="API_UrlEndpointInput_Contents"></a>

 ** Url **   <a name="migrationhubrefactorspaces-Type-UrlEndpointInput-Url"></a>
The URL to route traffic to. The URL must be an [rfc3986-formatted URL](https://datatracker.ietf.org/doc/html/rfc3986). If the host is a domain name, the name must be resolvable over the public internet. If the scheme is `https`, the top level domain of the host must be listed in the [IANA root zone database](https://www.iana.org/domains/root/db).   
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 2048.  
Pattern: `https?://[-a-zA-Z0-9+\x38@#/%?=~_|!:,.;]*[-a-zA-Z0-9+\x38@#/%=~_|]`   
Required: Yes

 ** HealthUrl **   <a name="migrationhubrefactorspaces-Type-UrlEndpointInput-HealthUrl"></a>
The health check URL of the URL endpoint type. If the URL is a public endpoint, the `HealthUrl` must also be a public endpoint. If the URL is a private endpoint inside a virtual private cloud (VPC), the health URL must also be a private endpoint, and the host must be the same as the URL.   
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 2048.  
Pattern: `https?://[-a-zA-Z0-9+\x38@#/%?=~_|!:,.;]*[-a-zA-Z0-9+\x38@#/%=~_|]`   
Required: No

## See Also
<a name="API_UrlEndpointInput_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/migration-hub-refactor-spaces-2021-10-26/UrlEndpointInput) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/migration-hub-refactor-spaces-2021-10-26/UrlEndpointInput) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/migration-hub-refactor-spaces-2021-10-26/UrlEndpointInput) 

# UrlEndpointSummary
<a name="API_UrlEndpointSummary"></a>

The summary of the configuration for the URL endpoint type. 

## Contents
<a name="API_UrlEndpointSummary_Contents"></a>

 ** HealthUrl **   <a name="migrationhubrefactorspaces-Type-UrlEndpointSummary-HealthUrl"></a>
The health check URL of the URL endpoint type. If the URL is a public endpoint, the `HealthUrl` must also be a public endpoint. If the URL is a private endpoint inside a virtual private cloud (VPC), the health URL must also be a private endpoint, and the host must be the same as the URL.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 2048.  
Pattern: `https?://[-a-zA-Z0-9+\x38@#/%?=~_|!:,.;]*[-a-zA-Z0-9+\x38@#/%=~_|]`   
Required: No

 ** Url **   <a name="migrationhubrefactorspaces-Type-UrlEndpointSummary-Url"></a>
 The URL to route traffic to. The URL must be an [rfc3986-formatted URL](https://datatracker.ietf.org/doc/html/rfc3986). If the host is a domain name, the name must be resolvable over the public internet. If the scheme is `https`, the top level domain of the host must be listed in the [IANA root zone database](https://www.iana.org/domains/root/db).   
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 2048.  
Pattern: `https?://[-a-zA-Z0-9+\x38@#/%?=~_|!:,.;]*[-a-zA-Z0-9+\x38@#/%=~_|]`   
Required: No

## See Also
<a name="API_UrlEndpointSummary_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/migration-hub-refactor-spaces-2021-10-26/UrlEndpointSummary) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/migration-hub-refactor-spaces-2021-10-26/UrlEndpointSummary) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/migration-hub-refactor-spaces-2021-10-26/UrlEndpointSummary)