@ThreadSafe @Generated(value="com.amazonaws:aws-java-sdk-code-generator") public class AWSMigrationHubRefactorSpacesClient extends AmazonWebServiceClient implements AWSMigrationHubRefactorSpaces
This API reference provides descriptions, syntax, and other details about each of the actions and data types for Amazon Web Services Migration Hub Refactor Spaces (Refactor Spaces). The topic for each action shows the API request parameters and the response. Alternatively, you can use one of the Amazon Web Services SDKs to access an API that is tailored to the programming language or platform that you're using. For more information, see Amazon Web Services SDKs.
To share Refactor Spaces environments with other Amazon Web Services accounts or with Organizations and their OUs,
use Resource Access Manager's CreateResourceShare API. See CreateResourceShare in
the Amazon Web Services RAM API Reference.
LOGGING_AWS_REQUEST_METRICENDPOINT_PREFIX| Modifier and Type | Method and Description |
|---|---|
static AWSMigrationHubRefactorSpacesClientBuilder |
builder() |
CreateApplicationResult |
createApplication(CreateApplicationRequest request)
Creates an Amazon Web Services Migration Hub Refactor Spaces application.
|
CreateEnvironmentResult |
createEnvironment(CreateEnvironmentRequest request)
Creates an Amazon Web Services Migration Hub Refactor Spaces environment.
|
CreateRouteResult |
createRoute(CreateRouteRequest request)
Creates an Amazon Web Services Migration Hub Refactor Spaces route.
|
CreateServiceResult |
createService(CreateServiceRequest request)
Creates an Amazon Web Services Migration Hub Refactor Spaces service.
|
DeleteApplicationResult |
deleteApplication(DeleteApplicationRequest request)
Deletes an Amazon Web Services Migration Hub Refactor Spaces application.
|
DeleteEnvironmentResult |
deleteEnvironment(DeleteEnvironmentRequest request)
Deletes an Amazon Web Services Migration Hub Refactor Spaces environment.
|
DeleteResourcePolicyResult |
deleteResourcePolicy(DeleteResourcePolicyRequest request)
Deletes the resource policy set for the environment.
|
DeleteRouteResult |
deleteRoute(DeleteRouteRequest request)
Deletes an Amazon Web Services Migration Hub Refactor Spaces route.
|
DeleteServiceResult |
deleteService(DeleteServiceRequest request)
Deletes an Amazon Web Services Migration Hub Refactor Spaces service.
|
GetApplicationResult |
getApplication(GetApplicationRequest request)
Gets an Amazon Web Services Migration Hub Refactor Spaces application.
|
ResponseMetadata |
getCachedResponseMetadata(AmazonWebServiceRequest request)
Returns additional metadata for a previously executed successful, request, typically used for debugging issues
where a service isn't acting as expected.
|
GetEnvironmentResult |
getEnvironment(GetEnvironmentRequest request)
Gets an Amazon Web Services Migration Hub Refactor Spaces environment.
|
GetResourcePolicyResult |
getResourcePolicy(GetResourcePolicyRequest request)
Gets the resource-based permission policy that is set for the given environment.
|
GetRouteResult |
getRoute(GetRouteRequest request)
Gets an Amazon Web Services Migration Hub Refactor Spaces route.
|
GetServiceResult |
getService(GetServiceRequest request)
Gets an Amazon Web Services Migration Hub Refactor Spaces service.
|
ListApplicationsResult |
listApplications(ListApplicationsRequest request)
Lists all the Amazon Web Services Migration Hub Refactor Spaces applications within an environment.
|
ListEnvironmentsResult |
listEnvironments(ListEnvironmentsRequest request)
Lists Amazon Web Services Migration Hub Refactor Spaces environments owned by a caller account or shared with the
caller account.
|
ListEnvironmentVpcsResult |
listEnvironmentVpcs(ListEnvironmentVpcsRequest request)
Lists all Amazon Web Services Migration Hub Refactor Spaces service virtual private clouds (VPCs) that are part
of the environment.
|
ListRoutesResult |
listRoutes(ListRoutesRequest request)
Lists all the Amazon Web Services Migration Hub Refactor Spaces routes within an application.
|
ListServicesResult |
listServices(ListServicesRequest request)
Lists all the Amazon Web Services Migration Hub Refactor Spaces services within an application.
|
ListTagsForResourceResult |
listTagsForResource(ListTagsForResourceRequest request)
Lists the tags of a resource.
|
PutResourcePolicyResult |
putResourcePolicy(PutResourcePolicyRequest request)
Attaches a resource-based permission policy to the Amazon Web Services Migration Hub Refactor Spaces environment.
|
void |
shutdown()
Shuts down this client object, releasing any resources that might be held
open.
|
TagResourceResult |
tagResource(TagResourceRequest request)
Removes the tags of a given resource.
|
UntagResourceResult |
untagResource(UntagResourceRequest request)
Adds to or modifies the tags of the given resource.
|
UpdateRouteResult |
updateRoute(UpdateRouteRequest request)
Updates an Amazon Web Services Migration Hub Refactor Spaces route.
|
addRequestHandler, addRequestHandler, configureRegion, getClientConfiguration, getEndpointPrefix, getMonitoringListeners, getRequestMetricsCollector, getServiceName, getSignerByURI, getSignerOverride, getSignerRegionOverride, getTimeOffset, makeImmutable, removeRequestHandler, removeRequestHandler, setEndpoint, setEndpoint, setRegion, setServiceNameIntern, setSignerRegionOverride, setTimeOffset, withEndpoint, withRegion, withRegion, withTimeOffsetpublic static AWSMigrationHubRefactorSpacesClientBuilder builder()
public CreateApplicationResult createApplication(CreateApplicationRequest request)
Creates an Amazon Web Services 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.
createApplication in interface AWSMigrationHubRefactorSpacescreateApplicationRequest - ResourceNotFoundException - The request references a resource that does not exist.InternalServerException - An unexpected error occurred while processing the request.ConflictException - Updating or deleting a resource can cause an inconsistent state.ServiceQuotaExceededException - The request would cause a service quota to be exceeded.ValidationException - The input does not satisfy the constraints specified by an Amazon Web Service.ThrottlingException - Request was denied because the request was throttled.AccessDeniedException - The user does not have sufficient access to perform this action.public CreateEnvironmentResult createEnvironment(CreateEnvironmentRequest request)
Creates an Amazon Web Services 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 of TRANSIT_GATEWAY, Refactor Spaces provisions a transit
gateway to enable services in VPCs to communicate directly across accounts. If CreateEnvironment: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.
createEnvironment in interface AWSMigrationHubRefactorSpacescreateEnvironmentRequest - ResourceNotFoundException - The request references a resource that does not exist.InternalServerException - An unexpected error occurred while processing the request.ConflictException - Updating or deleting a resource can cause an inconsistent state.ServiceQuotaExceededException - The request would cause a service quota to be exceeded.ValidationException - The input does not satisfy the constraints specified by an Amazon Web Service.ThrottlingException - Request was denied because the request was throttled.AccessDeniedException - The user does not have sufficient access to perform this action.public CreateRouteResult createRoute(CreateRouteRequest request)
Creates an Amazon Web Services 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 so 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.
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.
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 parameter. All other health check settings for the load balancer use the default values described in the Health checks for your target groups 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.
Lambda function endpoints
If the service has an 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 in the Lambda Developer Guide.
A check is performed to determine that a 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.
Environments without a network bridge
When you create environments without a network bridge (CreateEnvironment:NetworkFabricType is NONE) and you use your own networking infrastructure,
you need to configure VPC to VPC connectivity 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 in the Refactor Spaces User Guide.
createRoute in interface AWSMigrationHubRefactorSpacescreateRouteRequest - ResourceNotFoundException - The request references a resource that does not exist.InternalServerException - An unexpected error occurred while processing the request.ConflictException - Updating or deleting a resource can cause an inconsistent state.ServiceQuotaExceededException - The request would cause a service quota to be exceeded.ValidationException - The input does not satisfy the constraints specified by an Amazon Web Service.ThrottlingException - Request was denied because the request was throttled.AccessDeniedException - The user does not have sufficient access to perform this action.public CreateServiceResult createService(CreateServiceRequest request)
Creates an Amazon Web Services 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.
If an Amazon Web Services 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.
createService in interface AWSMigrationHubRefactorSpacescreateServiceRequest - ResourceNotFoundException - The request references a resource that does not exist.InternalServerException - An unexpected error occurred while processing the request.ConflictException - Updating or deleting a resource can cause an inconsistent state.ServiceQuotaExceededException - The request would cause a service quota to be exceeded.ValidationException - The input does not satisfy the constraints specified by an Amazon Web Service.ThrottlingException - Request was denied because the request was throttled.AccessDeniedException - The user does not have sufficient access to perform this action.public DeleteApplicationResult deleteApplication(DeleteApplicationRequest request)
Deletes an Amazon Web Services Migration Hub Refactor Spaces application. Before you can delete an application, you must first delete any services or routes within the application.
deleteApplication in interface AWSMigrationHubRefactorSpacesdeleteApplicationRequest - ResourceNotFoundException - The request references a resource that does not exist.InternalServerException - An unexpected error occurred while processing the request.ConflictException - Updating or deleting a resource can cause an inconsistent state.ValidationException - The input does not satisfy the constraints specified by an Amazon Web Service.ThrottlingException - Request was denied because the request was throttled.AccessDeniedException - The user does not have sufficient access to perform this action.public DeleteEnvironmentResult deleteEnvironment(DeleteEnvironmentRequest request)
Deletes an Amazon Web Services Migration Hub Refactor Spaces environment. Before you can delete an environment, you must first delete any applications and services within the environment.
deleteEnvironment in interface AWSMigrationHubRefactorSpacesdeleteEnvironmentRequest - ResourceNotFoundException - The request references a resource that does not exist.InternalServerException - An unexpected error occurred while processing the request.ConflictException - Updating or deleting a resource can cause an inconsistent state.ValidationException - The input does not satisfy the constraints specified by an Amazon Web Service.ThrottlingException - Request was denied because the request was throttled.AccessDeniedException - The user does not have sufficient access to perform this action.public DeleteResourcePolicyResult deleteResourcePolicy(DeleteResourcePolicyRequest request)
Deletes the resource policy set for the environment.
deleteResourcePolicy in interface AWSMigrationHubRefactorSpacesdeleteResourcePolicyRequest - ResourceNotFoundException - The request references a resource that does not exist.InternalServerException - An unexpected error occurred while processing the request.ValidationException - The input does not satisfy the constraints specified by an Amazon Web Service.ThrottlingException - Request was denied because the request was throttled.AccessDeniedException - The user does not have sufficient access to perform this action.public DeleteRouteResult deleteRoute(DeleteRouteRequest request)
Deletes an Amazon Web Services Migration Hub Refactor Spaces route.
deleteRoute in interface AWSMigrationHubRefactorSpacesdeleteRouteRequest - ResourceNotFoundException - The request references a resource that does not exist.InternalServerException - An unexpected error occurred while processing the request.ConflictException - Updating or deleting a resource can cause an inconsistent state.ValidationException - The input does not satisfy the constraints specified by an Amazon Web Service.ThrottlingException - Request was denied because the request was throttled.AccessDeniedException - The user does not have sufficient access to perform this action.public DeleteServiceResult deleteService(DeleteServiceRequest request)
Deletes an Amazon Web Services Migration Hub Refactor Spaces service.
deleteService in interface AWSMigrationHubRefactorSpacesdeleteServiceRequest - ResourceNotFoundException - The request references a resource that does not exist.InternalServerException - An unexpected error occurred while processing the request.ConflictException - Updating or deleting a resource can cause an inconsistent state.ValidationException - The input does not satisfy the constraints specified by an Amazon Web Service.ThrottlingException - Request was denied because the request was throttled.AccessDeniedException - The user does not have sufficient access to perform this action.public GetApplicationResult getApplication(GetApplicationRequest request)
Gets an Amazon Web Services Migration Hub Refactor Spaces application.
getApplication in interface AWSMigrationHubRefactorSpacesgetApplicationRequest - ResourceNotFoundException - The request references a resource that does not exist.InternalServerException - An unexpected error occurred while processing the request.ValidationException - The input does not satisfy the constraints specified by an Amazon Web Service.ThrottlingException - Request was denied because the request was throttled.AccessDeniedException - The user does not have sufficient access to perform this action.public GetEnvironmentResult getEnvironment(GetEnvironmentRequest request)
Gets an Amazon Web Services Migration Hub Refactor Spaces environment.
getEnvironment in interface AWSMigrationHubRefactorSpacesgetEnvironmentRequest - ResourceNotFoundException - The request references a resource that does not exist.InternalServerException - An unexpected error occurred while processing the request.ValidationException - The input does not satisfy the constraints specified by an Amazon Web Service.ThrottlingException - Request was denied because the request was throttled.AccessDeniedException - The user does not have sufficient access to perform this action.public GetResourcePolicyResult getResourcePolicy(GetResourcePolicyRequest request)
Gets the resource-based permission policy that is set for the given environment.
getResourcePolicy in interface AWSMigrationHubRefactorSpacesgetResourcePolicyRequest - ResourceNotFoundException - The request references a resource that does not exist.InternalServerException - An unexpected error occurred while processing the request.ValidationException - The input does not satisfy the constraints specified by an Amazon Web Service.ThrottlingException - Request was denied because the request was throttled.AccessDeniedException - The user does not have sufficient access to perform this action.public GetRouteResult getRoute(GetRouteRequest request)
Gets an Amazon Web Services Migration Hub Refactor Spaces route.
getRoute in interface AWSMigrationHubRefactorSpacesgetRouteRequest - ResourceNotFoundException - The request references a resource that does not exist.InternalServerException - An unexpected error occurred while processing the request.ValidationException - The input does not satisfy the constraints specified by an Amazon Web Service.ThrottlingException - Request was denied because the request was throttled.AccessDeniedException - The user does not have sufficient access to perform this action.public GetServiceResult getService(GetServiceRequest request)
Gets an Amazon Web Services Migration Hub Refactor Spaces service.
getService in interface AWSMigrationHubRefactorSpacesgetServiceRequest - ResourceNotFoundException - The request references a resource that does not exist.InternalServerException - An unexpected error occurred while processing the request.ValidationException - The input does not satisfy the constraints specified by an Amazon Web Service.ThrottlingException - Request was denied because the request was throttled.AccessDeniedException - The user does not have sufficient access to perform this action.public ListApplicationsResult listApplications(ListApplicationsRequest request)
Lists all the Amazon Web Services Migration Hub Refactor Spaces applications within an environment.
listApplications in interface AWSMigrationHubRefactorSpaceslistApplicationsRequest - ResourceNotFoundException - The request references a resource that does not exist.InternalServerException - An unexpected error occurred while processing the request.ConflictException - Updating or deleting a resource can cause an inconsistent state.ServiceQuotaExceededException - The request would cause a service quota to be exceeded.ValidationException - The input does not satisfy the constraints specified by an Amazon Web Service.ThrottlingException - Request was denied because the request was throttled.AccessDeniedException - The user does not have sufficient access to perform this action.public ListEnvironmentVpcsResult listEnvironmentVpcs(ListEnvironmentVpcsRequest request)
Lists all Amazon Web Services Migration Hub Refactor Spaces service virtual private clouds (VPCs) that are part of the environment.
listEnvironmentVpcs in interface AWSMigrationHubRefactorSpaceslistEnvironmentVpcsRequest - ResourceNotFoundException - The request references a resource that does not exist.InternalServerException - An unexpected error occurred while processing the request.ValidationException - The input does not satisfy the constraints specified by an Amazon Web Service.ThrottlingException - Request was denied because the request was throttled.AccessDeniedException - The user does not have sufficient access to perform this action.public ListEnvironmentsResult listEnvironments(ListEnvironmentsRequest request)
Lists Amazon Web Services Migration Hub Refactor Spaces environments owned by a caller account or shared with the caller account.
listEnvironments in interface AWSMigrationHubRefactorSpaceslistEnvironmentsRequest - ResourceNotFoundException - The request references a resource that does not exist.InternalServerException - An unexpected error occurred while processing the request.ValidationException - The input does not satisfy the constraints specified by an Amazon Web Service.ThrottlingException - Request was denied because the request was throttled.AccessDeniedException - The user does not have sufficient access to perform this action.public ListRoutesResult listRoutes(ListRoutesRequest request)
Lists all the Amazon Web Services Migration Hub Refactor Spaces routes within an application.
listRoutes in interface AWSMigrationHubRefactorSpaceslistRoutesRequest - ResourceNotFoundException - The request references a resource that does not exist.InternalServerException - An unexpected error occurred while processing the request.ConflictException - Updating or deleting a resource can cause an inconsistent state.ServiceQuotaExceededException - The request would cause a service quota to be exceeded.ValidationException - The input does not satisfy the constraints specified by an Amazon Web Service.ThrottlingException - Request was denied because the request was throttled.AccessDeniedException - The user does not have sufficient access to perform this action.public ListServicesResult listServices(ListServicesRequest request)
Lists all the Amazon Web Services Migration Hub Refactor Spaces services within an application.
listServices in interface AWSMigrationHubRefactorSpaceslistServicesRequest - ResourceNotFoundException - The request references a resource that does not exist.InternalServerException - An unexpected error occurred while processing the request.ConflictException - Updating or deleting a resource can cause an inconsistent state.ServiceQuotaExceededException - The request would cause a service quota to be exceeded.ValidationException - The input does not satisfy the constraints specified by an Amazon Web Service.ThrottlingException - Request was denied because the request was throttled.AccessDeniedException - The user does not have sufficient access to perform this action.public ListTagsForResourceResult listTagsForResource(ListTagsForResourceRequest request)
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.
listTagsForResource in interface AWSMigrationHubRefactorSpaceslistTagsForResourceRequest - ResourceNotFoundException - The request references a resource that does not exist.InternalServerException - An unexpected error occurred while processing the request.ValidationException - The input does not satisfy the constraints specified by an Amazon Web Service.public PutResourcePolicyResult putResourcePolicy(PutResourcePolicyRequest request)
Attaches a resource-based permission policy to the Amazon Web Services 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 Resource
Access Manager. The policy must not contain new lines or blank lines.
putResourcePolicy in interface AWSMigrationHubRefactorSpacesputResourcePolicyRequest - ResourceNotFoundException - The request references a resource that does not exist.InternalServerException - An unexpected error occurred while processing the request.InvalidResourcePolicyException - The resource policy is not valid.ValidationException - The input does not satisfy the constraints specified by an Amazon Web Service.ThrottlingException - Request was denied because the request was throttled.AccessDeniedException - The user does not have sufficient access to perform this action.public TagResourceResult tagResource(TagResourceRequest request)
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.
Amazon Web Services Migration Hub Refactor Spaces does not propagate tags to orchestrated resources, such as an environment’s transit gateway.
tagResource in interface AWSMigrationHubRefactorSpacestagResourceRequest - ResourceNotFoundException - The request references a resource that does not exist.InternalServerException - An unexpected error occurred while processing the request.ValidationException - The input does not satisfy the constraints specified by an Amazon Web Service.public UntagResourceResult untagResource(UntagResourceRequest request)
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.
untagResource in interface AWSMigrationHubRefactorSpacesuntagResourceRequest - ResourceNotFoundException - The request references a resource that does not exist.InternalServerException - An unexpected error occurred while processing the request.ValidationException - The input does not satisfy the constraints specified by an Amazon Web Service.public UpdateRouteResult updateRoute(UpdateRouteRequest request)
Updates an Amazon Web Services Migration Hub Refactor Spaces route.
updateRoute in interface AWSMigrationHubRefactorSpacesupdateRouteRequest - ResourceNotFoundException - The request references a resource that does not exist.InternalServerException - An unexpected error occurred while processing the request.ValidationException - The input does not satisfy the constraints specified by an Amazon Web Service.ThrottlingException - Request was denied because the request was throttled.AccessDeniedException - The user does not have sufficient access to perform this action.public ResponseMetadata getCachedResponseMetadata(AmazonWebServiceRequest request)
Response metadata is only cached for a limited period of time, so if you need to access this extra diagnostic information for an executed request, you should use this method to retrieve it as soon as possible after executing the request.
getCachedResponseMetadata in interface AWSMigrationHubRefactorSpacesrequest - The originally executed requestpublic void shutdown()
AmazonWebServiceClientshutdown in interface AWSMigrationHubRefactorSpacesshutdown in class AmazonWebServiceClient