Interface MigrationHubRefactorSpacesAsyncClient
- All Superinterfaces:
AutoCloseable,AwsClient,SdkAutoCloseable,SdkClient
builder() method.The asynchronous client performs non-blocking I/O when configured with any
SdkAsyncHttpClient supported in the SDK. However, full non-blocking is not guaranteed as the async client may
perform blocking calls in some cases such as credentials retrieval and endpoint discovery as part of the async API
call.
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.
-
Field Summary
FieldsModifier and TypeFieldDescriptionstatic final StringValue for looking up the service's metadata from theServiceMetadataProvider.static final String -
Method Summary
Modifier and TypeMethodDescriptionbuilder()Create a builder that can be used to configure and create aMigrationHubRefactorSpacesAsyncClient.create()Create aMigrationHubRefactorSpacesAsyncClientwith the region loaded from theDefaultAwsRegionProviderChainand credentials loaded from theDefaultCredentialsProvider.createApplication(Consumer<CreateApplicationRequest.Builder> createApplicationRequest) Creates an Amazon Web Services Migration Hub Refactor Spaces application.createApplication(CreateApplicationRequest createApplicationRequest) Creates an Amazon Web Services Migration Hub Refactor Spaces application.createEnvironment(Consumer<CreateEnvironmentRequest.Builder> createEnvironmentRequest) Creates an Amazon Web Services Migration Hub Refactor Spaces environment.createEnvironment(CreateEnvironmentRequest createEnvironmentRequest) Creates an Amazon Web Services Migration Hub Refactor Spaces environment.default CompletableFuture<CreateRouteResponse> createRoute(Consumer<CreateRouteRequest.Builder> createRouteRequest) Creates an Amazon Web Services Migration Hub Refactor Spaces route.default CompletableFuture<CreateRouteResponse> createRoute(CreateRouteRequest createRouteRequest) Creates an Amazon Web Services Migration Hub Refactor Spaces route.default CompletableFuture<CreateServiceResponse> createService(Consumer<CreateServiceRequest.Builder> createServiceRequest) Creates an Amazon Web Services Migration Hub Refactor Spaces service.default CompletableFuture<CreateServiceResponse> createService(CreateServiceRequest createServiceRequest) Creates an Amazon Web Services Migration Hub Refactor Spaces service.deleteApplication(Consumer<DeleteApplicationRequest.Builder> deleteApplicationRequest) Deletes an Amazon Web Services Migration Hub Refactor Spaces application.deleteApplication(DeleteApplicationRequest deleteApplicationRequest) Deletes an Amazon Web Services Migration Hub Refactor Spaces application.deleteEnvironment(Consumer<DeleteEnvironmentRequest.Builder> deleteEnvironmentRequest) Deletes an Amazon Web Services Migration Hub Refactor Spaces environment.deleteEnvironment(DeleteEnvironmentRequest deleteEnvironmentRequest) Deletes an Amazon Web Services Migration Hub Refactor Spaces environment.deleteResourcePolicy(Consumer<DeleteResourcePolicyRequest.Builder> deleteResourcePolicyRequest) Deletes the resource policy set for the environment.deleteResourcePolicy(DeleteResourcePolicyRequest deleteResourcePolicyRequest) Deletes the resource policy set for the environment.default CompletableFuture<DeleteRouteResponse> deleteRoute(Consumer<DeleteRouteRequest.Builder> deleteRouteRequest) Deletes an Amazon Web Services Migration Hub Refactor Spaces route.default CompletableFuture<DeleteRouteResponse> deleteRoute(DeleteRouteRequest deleteRouteRequest) Deletes an Amazon Web Services Migration Hub Refactor Spaces route.default CompletableFuture<DeleteServiceResponse> deleteService(Consumer<DeleteServiceRequest.Builder> deleteServiceRequest) Deletes an Amazon Web Services Migration Hub Refactor Spaces service.default CompletableFuture<DeleteServiceResponse> deleteService(DeleteServiceRequest deleteServiceRequest) Deletes an Amazon Web Services Migration Hub Refactor Spaces service.default CompletableFuture<GetApplicationResponse> getApplication(Consumer<GetApplicationRequest.Builder> getApplicationRequest) Gets an Amazon Web Services Migration Hub Refactor Spaces application.default CompletableFuture<GetApplicationResponse> getApplication(GetApplicationRequest getApplicationRequest) Gets an Amazon Web Services Migration Hub Refactor Spaces application.default CompletableFuture<GetEnvironmentResponse> getEnvironment(Consumer<GetEnvironmentRequest.Builder> getEnvironmentRequest) Gets an Amazon Web Services Migration Hub Refactor Spaces environment.default CompletableFuture<GetEnvironmentResponse> getEnvironment(GetEnvironmentRequest getEnvironmentRequest) Gets an Amazon Web Services Migration Hub Refactor Spaces environment.getResourcePolicy(Consumer<GetResourcePolicyRequest.Builder> getResourcePolicyRequest) Gets the resource-based permission policy that is set for the given environment.getResourcePolicy(GetResourcePolicyRequest getResourcePolicyRequest) Gets the resource-based permission policy that is set for the given environment.default CompletableFuture<GetRouteResponse> getRoute(Consumer<GetRouteRequest.Builder> getRouteRequest) Gets an Amazon Web Services Migration Hub Refactor Spaces route.default CompletableFuture<GetRouteResponse> getRoute(GetRouteRequest getRouteRequest) Gets an Amazon Web Services Migration Hub Refactor Spaces route.default CompletableFuture<GetServiceResponse> getService(Consumer<GetServiceRequest.Builder> getServiceRequest) Gets an Amazon Web Services Migration Hub Refactor Spaces service.default CompletableFuture<GetServiceResponse> getService(GetServiceRequest getServiceRequest) Gets an Amazon Web Services Migration Hub Refactor Spaces service.listApplications(Consumer<ListApplicationsRequest.Builder> listApplicationsRequest) Lists all the Amazon Web Services Migration Hub Refactor Spaces applications within an environment.listApplications(ListApplicationsRequest listApplicationsRequest) Lists all the Amazon Web Services Migration Hub Refactor Spaces applications within an environment.default ListApplicationsPublisherlistApplicationsPaginator(Consumer<ListApplicationsRequest.Builder> listApplicationsRequest) This is a variant oflistApplications(software.amazon.awssdk.services.migrationhubrefactorspaces.model.ListApplicationsRequest)operation.default ListApplicationsPublisherlistApplicationsPaginator(ListApplicationsRequest listApplicationsRequest) This is a variant oflistApplications(software.amazon.awssdk.services.migrationhubrefactorspaces.model.ListApplicationsRequest)operation.listEnvironments(Consumer<ListEnvironmentsRequest.Builder> listEnvironmentsRequest) Lists Amazon Web Services Migration Hub Refactor Spaces environments owned by a caller account or shared with the caller account.listEnvironments(ListEnvironmentsRequest listEnvironmentsRequest) Lists Amazon Web Services Migration Hub Refactor Spaces environments owned by a caller account or shared with the caller account.default ListEnvironmentsPublisherlistEnvironmentsPaginator(Consumer<ListEnvironmentsRequest.Builder> listEnvironmentsRequest) This is a variant oflistEnvironments(software.amazon.awssdk.services.migrationhubrefactorspaces.model.ListEnvironmentsRequest)operation.default ListEnvironmentsPublisherlistEnvironmentsPaginator(ListEnvironmentsRequest listEnvironmentsRequest) This is a variant oflistEnvironments(software.amazon.awssdk.services.migrationhubrefactorspaces.model.ListEnvironmentsRequest)operation.listEnvironmentVpcs(Consumer<ListEnvironmentVpcsRequest.Builder> listEnvironmentVpcsRequest) Lists all Amazon Web Services Migration Hub Refactor Spaces service virtual private clouds (VPCs) that are part of the environment.listEnvironmentVpcs(ListEnvironmentVpcsRequest listEnvironmentVpcsRequest) Lists all Amazon Web Services Migration Hub Refactor Spaces service virtual private clouds (VPCs) that are part of the environment.default ListEnvironmentVpcsPublisherlistEnvironmentVpcsPaginator(Consumer<ListEnvironmentVpcsRequest.Builder> listEnvironmentVpcsRequest) This is a variant oflistEnvironmentVpcs(software.amazon.awssdk.services.migrationhubrefactorspaces.model.ListEnvironmentVpcsRequest)operation.default ListEnvironmentVpcsPublisherlistEnvironmentVpcsPaginator(ListEnvironmentVpcsRequest listEnvironmentVpcsRequest) This is a variant oflistEnvironmentVpcs(software.amazon.awssdk.services.migrationhubrefactorspaces.model.ListEnvironmentVpcsRequest)operation.default CompletableFuture<ListRoutesResponse> listRoutes(Consumer<ListRoutesRequest.Builder> listRoutesRequest) Lists all the Amazon Web Services Migration Hub Refactor Spaces routes within an application.default CompletableFuture<ListRoutesResponse> listRoutes(ListRoutesRequest listRoutesRequest) Lists all the Amazon Web Services Migration Hub Refactor Spaces routes within an application.default ListRoutesPublisherlistRoutesPaginator(Consumer<ListRoutesRequest.Builder> listRoutesRequest) This is a variant oflistRoutes(software.amazon.awssdk.services.migrationhubrefactorspaces.model.ListRoutesRequest)operation.default ListRoutesPublisherlistRoutesPaginator(ListRoutesRequest listRoutesRequest) This is a variant oflistRoutes(software.amazon.awssdk.services.migrationhubrefactorspaces.model.ListRoutesRequest)operation.default CompletableFuture<ListServicesResponse> listServices(Consumer<ListServicesRequest.Builder> listServicesRequest) Lists all the Amazon Web Services Migration Hub Refactor Spaces services within an application.default CompletableFuture<ListServicesResponse> listServices(ListServicesRequest listServicesRequest) Lists all the Amazon Web Services Migration Hub Refactor Spaces services within an application.default ListServicesPublisherlistServicesPaginator(Consumer<ListServicesRequest.Builder> listServicesRequest) This is a variant oflistServices(software.amazon.awssdk.services.migrationhubrefactorspaces.model.ListServicesRequest)operation.default ListServicesPublisherlistServicesPaginator(ListServicesRequest listServicesRequest) This is a variant oflistServices(software.amazon.awssdk.services.migrationhubrefactorspaces.model.ListServicesRequest)operation.listTagsForResource(Consumer<ListTagsForResourceRequest.Builder> listTagsForResourceRequest) Lists the tags of a resource.listTagsForResource(ListTagsForResourceRequest listTagsForResourceRequest) Lists the tags of a resource.putResourcePolicy(Consumer<PutResourcePolicyRequest.Builder> putResourcePolicyRequest) Attaches a resource-based permission policy to the Amazon Web Services Migration Hub Refactor Spaces environment.putResourcePolicy(PutResourcePolicyRequest putResourcePolicyRequest) Attaches a resource-based permission policy to the Amazon Web Services Migration Hub Refactor Spaces environment.The SDK service client configuration exposes client settings to the user, e.g., ClientOverrideConfigurationdefault CompletableFuture<TagResourceResponse> tagResource(Consumer<TagResourceRequest.Builder> tagResourceRequest) Removes the tags of a given resource.default CompletableFuture<TagResourceResponse> tagResource(TagResourceRequest tagResourceRequest) Removes the tags of a given resource.default CompletableFuture<UntagResourceResponse> untagResource(Consumer<UntagResourceRequest.Builder> untagResourceRequest) Adds to or modifies the tags of the given resource.default CompletableFuture<UntagResourceResponse> untagResource(UntagResourceRequest untagResourceRequest) Adds to or modifies the tags of the given resource.default CompletableFuture<UpdateRouteResponse> updateRoute(Consumer<UpdateRouteRequest.Builder> updateRouteRequest) Updates an Amazon Web Services Migration Hub Refactor Spaces route.default CompletableFuture<UpdateRouteResponse> updateRoute(UpdateRouteRequest updateRouteRequest) Updates an Amazon Web Services Migration Hub Refactor Spaces route.Methods inherited from interface software.amazon.awssdk.utils.SdkAutoCloseable
closeMethods inherited from interface software.amazon.awssdk.core.SdkClient
serviceName
-
Field Details
-
SERVICE_NAME
- See Also:
-
SERVICE_METADATA_ID
Value for looking up the service's metadata from theServiceMetadataProvider.- See Also:
-
-
Method Details
-
createApplication
default CompletableFuture<CreateApplicationResponse> createApplication(CreateApplicationRequest createApplicationRequest) 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
NONEyou 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.- Parameters:
createApplicationRequest-- Returns:
- A Java Future containing the result of the CreateApplication operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- 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.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- MigrationHubRefactorSpacesException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
createApplication
default CompletableFuture<CreateApplicationResponse> createApplication(Consumer<CreateApplicationRequest.Builder> createApplicationRequest) 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
NONEyou 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.
This is a convenience which creates an instance of the
CreateApplicationRequest.Builderavoiding the need to create one manually viaCreateApplicationRequest.builder()- Parameters:
createApplicationRequest- AConsumerthat will call methods onCreateApplicationRequest.Builderto create a request.- Returns:
- A Java Future containing the result of the CreateApplication operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- 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.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- MigrationHubRefactorSpacesException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
createEnvironment
default CompletableFuture<CreateEnvironmentResponse> createEnvironment(CreateEnvironmentRequest createEnvironmentRequest) 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 isNONE, Refactor Spaces does not create a transit gateway and you must use your network infrastructure to route traffic to services with private URL endpoints.- Parameters:
createEnvironmentRequest-- Returns:
- A Java Future containing the result of the CreateEnvironment operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- 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.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- MigrationHubRefactorSpacesException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
createEnvironment
default CompletableFuture<CreateEnvironmentResponse> createEnvironment(Consumer<CreateEnvironmentRequest.Builder> createEnvironmentRequest) 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 isNONE, Refactor Spaces does not create a transit gateway and you must use your network infrastructure to route traffic to services with private URL endpoints.
This is a convenience which creates an instance of the
CreateEnvironmentRequest.Builderavoiding the need to create one manually viaCreateEnvironmentRequest.builder()- Parameters:
createEnvironmentRequest- AConsumerthat will call methods onCreateEnvironmentRequest.Builderto create a request.- Returns:
- A Java Future containing the result of the CreateEnvironment operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- 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.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- MigrationHubRefactorSpacesException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
createRoute
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
DEFAULTRouteType.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:UrlEndpointwhen 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 ofSERVICE_ENDPOINT_HEALTH_CHECK_FAILUREis 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.- Parameters:
createRouteRequest-- Returns:
- A Java Future containing the result of the CreateRoute operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- 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.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- MigrationHubRefactorSpacesException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
-
createRoute
default CompletableFuture<CreateRouteResponse> createRoute(Consumer<CreateRouteRequest.Builder> createRouteRequest) 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
DEFAULTRouteType.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:UrlEndpointwhen 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 ofSERVICE_ENDPOINT_HEALTH_CHECK_FAILUREis 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.
This is a convenience which creates an instance of the
CreateRouteRequest.Builderavoiding the need to create one manually viaCreateRouteRequest.builder()- Parameters:
createRouteRequest- AConsumerthat will call methods onCreateRouteRequest.Builderto create a request.- Returns:
- A Java Future containing the result of the CreateRoute operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- 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.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- MigrationHubRefactorSpacesException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
-
createService
default CompletableFuture<CreateServiceResponse> createService(CreateServiceRequest createServiceRequest) 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
RefactorSpacesSecurityGroupto the resource. Alternatively, to add more cross-account constraints, apply your own security group.- Parameters:
createServiceRequest-- Returns:
- A Java Future containing the result of the CreateService operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- 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.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- MigrationHubRefactorSpacesException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
createService
default CompletableFuture<CreateServiceResponse> createService(Consumer<CreateServiceRequest.Builder> createServiceRequest) 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
RefactorSpacesSecurityGroupto the resource. Alternatively, to add more cross-account constraints, apply your own security group.
This is a convenience which creates an instance of the
CreateServiceRequest.Builderavoiding the need to create one manually viaCreateServiceRequest.builder()- Parameters:
createServiceRequest- AConsumerthat will call methods onCreateServiceRequest.Builderto create a request.- Returns:
- A Java Future containing the result of the CreateService operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- 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.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- MigrationHubRefactorSpacesException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
deleteApplication
default CompletableFuture<DeleteApplicationResponse> deleteApplication(DeleteApplicationRequest deleteApplicationRequest) 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.
- Parameters:
deleteApplicationRequest-- Returns:
- A Java Future containing the result of the DeleteApplication operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- 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.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- MigrationHubRefactorSpacesException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
deleteApplication
default CompletableFuture<DeleteApplicationResponse> deleteApplication(Consumer<DeleteApplicationRequest.Builder> deleteApplicationRequest) 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.
This is a convenience which creates an instance of the
DeleteApplicationRequest.Builderavoiding the need to create one manually viaDeleteApplicationRequest.builder()- Parameters:
deleteApplicationRequest- AConsumerthat will call methods onDeleteApplicationRequest.Builderto create a request.- Returns:
- A Java Future containing the result of the DeleteApplication operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- 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.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- MigrationHubRefactorSpacesException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
deleteEnvironment
default CompletableFuture<DeleteEnvironmentResponse> deleteEnvironment(DeleteEnvironmentRequest deleteEnvironmentRequest) 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.
- Parameters:
deleteEnvironmentRequest-- Returns:
- A Java Future containing the result of the DeleteEnvironment operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- 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.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- MigrationHubRefactorSpacesException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
deleteEnvironment
default CompletableFuture<DeleteEnvironmentResponse> deleteEnvironment(Consumer<DeleteEnvironmentRequest.Builder> deleteEnvironmentRequest) 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.
This is a convenience which creates an instance of the
DeleteEnvironmentRequest.Builderavoiding the need to create one manually viaDeleteEnvironmentRequest.builder()- Parameters:
deleteEnvironmentRequest- AConsumerthat will call methods onDeleteEnvironmentRequest.Builderto create a request.- Returns:
- A Java Future containing the result of the DeleteEnvironment operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- 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.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- MigrationHubRefactorSpacesException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
deleteResourcePolicy
default CompletableFuture<DeleteResourcePolicyResponse> deleteResourcePolicy(DeleteResourcePolicyRequest deleteResourcePolicyRequest) Deletes the resource policy set for the environment.
- Parameters:
deleteResourcePolicyRequest-- Returns:
- A Java Future containing the result of the DeleteResourcePolicy operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- 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.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- MigrationHubRefactorSpacesException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
deleteResourcePolicy
default CompletableFuture<DeleteResourcePolicyResponse> deleteResourcePolicy(Consumer<DeleteResourcePolicyRequest.Builder> deleteResourcePolicyRequest) Deletes the resource policy set for the environment.
This is a convenience which creates an instance of the
DeleteResourcePolicyRequest.Builderavoiding the need to create one manually viaDeleteResourcePolicyRequest.builder()- Parameters:
deleteResourcePolicyRequest- AConsumerthat will call methods onDeleteResourcePolicyRequest.Builderto create a request.- Returns:
- A Java Future containing the result of the DeleteResourcePolicy operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- 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.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- MigrationHubRefactorSpacesException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
deleteRoute
Deletes an Amazon Web Services Migration Hub Refactor Spaces route.
- Parameters:
deleteRouteRequest-- Returns:
- A Java Future containing the result of the DeleteRoute operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- 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.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- MigrationHubRefactorSpacesException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
deleteRoute
default CompletableFuture<DeleteRouteResponse> deleteRoute(Consumer<DeleteRouteRequest.Builder> deleteRouteRequest) Deletes an Amazon Web Services Migration Hub Refactor Spaces route.
This is a convenience which creates an instance of the
DeleteRouteRequest.Builderavoiding the need to create one manually viaDeleteRouteRequest.builder()- Parameters:
deleteRouteRequest- AConsumerthat will call methods onDeleteRouteRequest.Builderto create a request.- Returns:
- A Java Future containing the result of the DeleteRoute operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- 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.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- MigrationHubRefactorSpacesException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
deleteService
default CompletableFuture<DeleteServiceResponse> deleteService(DeleteServiceRequest deleteServiceRequest) Deletes an Amazon Web Services Migration Hub Refactor Spaces service.
- Parameters:
deleteServiceRequest-- Returns:
- A Java Future containing the result of the DeleteService operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- 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.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- MigrationHubRefactorSpacesException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
deleteService
default CompletableFuture<DeleteServiceResponse> deleteService(Consumer<DeleteServiceRequest.Builder> deleteServiceRequest) Deletes an Amazon Web Services Migration Hub Refactor Spaces service.
This is a convenience which creates an instance of the
DeleteServiceRequest.Builderavoiding the need to create one manually viaDeleteServiceRequest.builder()- Parameters:
deleteServiceRequest- AConsumerthat will call methods onDeleteServiceRequest.Builderto create a request.- Returns:
- A Java Future containing the result of the DeleteService operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- 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.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- MigrationHubRefactorSpacesException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
getApplication
default CompletableFuture<GetApplicationResponse> getApplication(GetApplicationRequest getApplicationRequest) Gets an Amazon Web Services Migration Hub Refactor Spaces application.
- Parameters:
getApplicationRequest-- Returns:
- A Java Future containing the result of the GetApplication operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- 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.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- MigrationHubRefactorSpacesException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
getApplication
default CompletableFuture<GetApplicationResponse> getApplication(Consumer<GetApplicationRequest.Builder> getApplicationRequest) Gets an Amazon Web Services Migration Hub Refactor Spaces application.
This is a convenience which creates an instance of the
GetApplicationRequest.Builderavoiding the need to create one manually viaGetApplicationRequest.builder()- Parameters:
getApplicationRequest- AConsumerthat will call methods onGetApplicationRequest.Builderto create a request.- Returns:
- A Java Future containing the result of the GetApplication operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- 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.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- MigrationHubRefactorSpacesException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
getEnvironment
default CompletableFuture<GetEnvironmentResponse> getEnvironment(GetEnvironmentRequest getEnvironmentRequest) Gets an Amazon Web Services Migration Hub Refactor Spaces environment.
- Parameters:
getEnvironmentRequest-- Returns:
- A Java Future containing the result of the GetEnvironment operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- 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.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- MigrationHubRefactorSpacesException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
getEnvironment
default CompletableFuture<GetEnvironmentResponse> getEnvironment(Consumer<GetEnvironmentRequest.Builder> getEnvironmentRequest) Gets an Amazon Web Services Migration Hub Refactor Spaces environment.
This is a convenience which creates an instance of the
GetEnvironmentRequest.Builderavoiding the need to create one manually viaGetEnvironmentRequest.builder()- Parameters:
getEnvironmentRequest- AConsumerthat will call methods onGetEnvironmentRequest.Builderto create a request.- Returns:
- A Java Future containing the result of the GetEnvironment operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- 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.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- MigrationHubRefactorSpacesException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
getResourcePolicy
default CompletableFuture<GetResourcePolicyResponse> getResourcePolicy(GetResourcePolicyRequest getResourcePolicyRequest) Gets the resource-based permission policy that is set for the given environment.
- Parameters:
getResourcePolicyRequest-- Returns:
- A Java Future containing the result of the GetResourcePolicy operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- 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.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- MigrationHubRefactorSpacesException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
getResourcePolicy
default CompletableFuture<GetResourcePolicyResponse> getResourcePolicy(Consumer<GetResourcePolicyRequest.Builder> getResourcePolicyRequest) Gets the resource-based permission policy that is set for the given environment.
This is a convenience which creates an instance of the
GetResourcePolicyRequest.Builderavoiding the need to create one manually viaGetResourcePolicyRequest.builder()- Parameters:
getResourcePolicyRequest- AConsumerthat will call methods onGetResourcePolicyRequest.Builderto create a request.- Returns:
- A Java Future containing the result of the GetResourcePolicy operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- 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.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- MigrationHubRefactorSpacesException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
getRoute
Gets an Amazon Web Services Migration Hub Refactor Spaces route.
- Parameters:
getRouteRequest-- Returns:
- A Java Future containing the result of the GetRoute operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- 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.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- MigrationHubRefactorSpacesException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
getRoute
default CompletableFuture<GetRouteResponse> getRoute(Consumer<GetRouteRequest.Builder> getRouteRequest) Gets an Amazon Web Services Migration Hub Refactor Spaces route.
This is a convenience which creates an instance of the
GetRouteRequest.Builderavoiding the need to create one manually viaGetRouteRequest.builder()- Parameters:
getRouteRequest- AConsumerthat will call methods onGetRouteRequest.Builderto create a request.- Returns:
- A Java Future containing the result of the GetRoute operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- 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.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- MigrationHubRefactorSpacesException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
getService
Gets an Amazon Web Services Migration Hub Refactor Spaces service.
- Parameters:
getServiceRequest-- Returns:
- A Java Future containing the result of the GetService operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- 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.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- MigrationHubRefactorSpacesException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
getService
default CompletableFuture<GetServiceResponse> getService(Consumer<GetServiceRequest.Builder> getServiceRequest) Gets an Amazon Web Services Migration Hub Refactor Spaces service.
This is a convenience which creates an instance of the
GetServiceRequest.Builderavoiding the need to create one manually viaGetServiceRequest.builder()- Parameters:
getServiceRequest- AConsumerthat will call methods onGetServiceRequest.Builderto create a request.- Returns:
- A Java Future containing the result of the GetService operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- 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.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- MigrationHubRefactorSpacesException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
listApplications
default CompletableFuture<ListApplicationsResponse> listApplications(ListApplicationsRequest listApplicationsRequest) Lists all the Amazon Web Services Migration Hub Refactor Spaces applications within an environment.
- Parameters:
listApplicationsRequest-- Returns:
- A Java Future containing the result of the ListApplications operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- 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.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- MigrationHubRefactorSpacesException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
listApplications
default CompletableFuture<ListApplicationsResponse> listApplications(Consumer<ListApplicationsRequest.Builder> listApplicationsRequest) Lists all the Amazon Web Services Migration Hub Refactor Spaces applications within an environment.
This is a convenience which creates an instance of the
ListApplicationsRequest.Builderavoiding the need to create one manually viaListApplicationsRequest.builder()- Parameters:
listApplicationsRequest- AConsumerthat will call methods onListApplicationsRequest.Builderto create a request.- Returns:
- A Java Future containing the result of the ListApplications operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- 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.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- MigrationHubRefactorSpacesException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
listApplicationsPaginator
default ListApplicationsPublisher listApplicationsPaginator(ListApplicationsRequest listApplicationsRequest) This is a variant of
listApplications(software.amazon.awssdk.services.migrationhubrefactorspaces.model.ListApplicationsRequest)operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber). Each call to the subscribe method will result in a newSubscriptioni.e., a new contract to stream data from the starting request.The following are few ways to use the response class:
1) Using the subscribe helper method
2) Using a custom subscribersoftware.amazon.awssdk.services.migrationhubrefactorspaces.paginators.ListApplicationsPublisher publisher = client.listApplicationsPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.software.amazon.awssdk.services.migrationhubrefactorspaces.paginators.ListApplicationsPublisher publisher = client.listApplicationsPaginator(request); publisher.subscribe(new Subscriber<software.amazon.awssdk.services.migrationhubrefactorspaces.model.ListApplicationsResponse>() { public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... }; public void onNext(software.amazon.awssdk.services.migrationhubrefactorspaces.model.ListApplicationsResponse response) { //... }; });Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listApplications(software.amazon.awssdk.services.migrationhubrefactorspaces.model.ListApplicationsRequest)operation.- Parameters:
listApplicationsRequest-- Returns:
- A custom publisher that can be subscribed to request a stream of response pages.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- 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.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- MigrationHubRefactorSpacesException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
listApplicationsPaginator
default ListApplicationsPublisher listApplicationsPaginator(Consumer<ListApplicationsRequest.Builder> listApplicationsRequest) This is a variant of
listApplications(software.amazon.awssdk.services.migrationhubrefactorspaces.model.ListApplicationsRequest)operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber). Each call to the subscribe method will result in a newSubscriptioni.e., a new contract to stream data from the starting request.The following are few ways to use the response class:
1) Using the subscribe helper method
2) Using a custom subscribersoftware.amazon.awssdk.services.migrationhubrefactorspaces.paginators.ListApplicationsPublisher publisher = client.listApplicationsPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.software.amazon.awssdk.services.migrationhubrefactorspaces.paginators.ListApplicationsPublisher publisher = client.listApplicationsPaginator(request); publisher.subscribe(new Subscriber<software.amazon.awssdk.services.migrationhubrefactorspaces.model.ListApplicationsResponse>() { public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... }; public void onNext(software.amazon.awssdk.services.migrationhubrefactorspaces.model.ListApplicationsResponse response) { //... }; });Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listApplications(software.amazon.awssdk.services.migrationhubrefactorspaces.model.ListApplicationsRequest)operation.
This is a convenience which creates an instance of the
ListApplicationsRequest.Builderavoiding the need to create one manually viaListApplicationsRequest.builder()- Parameters:
listApplicationsRequest- AConsumerthat will call methods onListApplicationsRequest.Builderto create a request.- Returns:
- A custom publisher that can be subscribed to request a stream of response pages.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- 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.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- MigrationHubRefactorSpacesException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
listEnvironmentVpcs
default CompletableFuture<ListEnvironmentVpcsResponse> listEnvironmentVpcs(ListEnvironmentVpcsRequest listEnvironmentVpcsRequest) Lists all Amazon Web Services Migration Hub Refactor Spaces service virtual private clouds (VPCs) that are part of the environment.
- Parameters:
listEnvironmentVpcsRequest-- Returns:
- A Java Future containing the result of the ListEnvironmentVpcs operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- 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.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- MigrationHubRefactorSpacesException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
listEnvironmentVpcs
default CompletableFuture<ListEnvironmentVpcsResponse> listEnvironmentVpcs(Consumer<ListEnvironmentVpcsRequest.Builder> listEnvironmentVpcsRequest) Lists all Amazon Web Services Migration Hub Refactor Spaces service virtual private clouds (VPCs) that are part of the environment.
This is a convenience which creates an instance of the
ListEnvironmentVpcsRequest.Builderavoiding the need to create one manually viaListEnvironmentVpcsRequest.builder()- Parameters:
listEnvironmentVpcsRequest- AConsumerthat will call methods onListEnvironmentVpcsRequest.Builderto create a request.- Returns:
- A Java Future containing the result of the ListEnvironmentVpcs operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- 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.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- MigrationHubRefactorSpacesException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
listEnvironmentVpcsPaginator
default ListEnvironmentVpcsPublisher listEnvironmentVpcsPaginator(ListEnvironmentVpcsRequest listEnvironmentVpcsRequest) This is a variant of
listEnvironmentVpcs(software.amazon.awssdk.services.migrationhubrefactorspaces.model.ListEnvironmentVpcsRequest)operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber). Each call to the subscribe method will result in a newSubscriptioni.e., a new contract to stream data from the starting request.The following are few ways to use the response class:
1) Using the subscribe helper method
2) Using a custom subscribersoftware.amazon.awssdk.services.migrationhubrefactorspaces.paginators.ListEnvironmentVpcsPublisher publisher = client.listEnvironmentVpcsPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.software.amazon.awssdk.services.migrationhubrefactorspaces.paginators.ListEnvironmentVpcsPublisher publisher = client.listEnvironmentVpcsPaginator(request); publisher.subscribe(new Subscriber<software.amazon.awssdk.services.migrationhubrefactorspaces.model.ListEnvironmentVpcsResponse>() { public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... }; public void onNext(software.amazon.awssdk.services.migrationhubrefactorspaces.model.ListEnvironmentVpcsResponse response) { //... }; });Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listEnvironmentVpcs(software.amazon.awssdk.services.migrationhubrefactorspaces.model.ListEnvironmentVpcsRequest)operation.- Parameters:
listEnvironmentVpcsRequest-- Returns:
- A custom publisher that can be subscribed to request a stream of response pages.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- 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.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- MigrationHubRefactorSpacesException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
listEnvironmentVpcsPaginator
default ListEnvironmentVpcsPublisher listEnvironmentVpcsPaginator(Consumer<ListEnvironmentVpcsRequest.Builder> listEnvironmentVpcsRequest) This is a variant of
listEnvironmentVpcs(software.amazon.awssdk.services.migrationhubrefactorspaces.model.ListEnvironmentVpcsRequest)operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber). Each call to the subscribe method will result in a newSubscriptioni.e., a new contract to stream data from the starting request.The following are few ways to use the response class:
1) Using the subscribe helper method
2) Using a custom subscribersoftware.amazon.awssdk.services.migrationhubrefactorspaces.paginators.ListEnvironmentVpcsPublisher publisher = client.listEnvironmentVpcsPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.software.amazon.awssdk.services.migrationhubrefactorspaces.paginators.ListEnvironmentVpcsPublisher publisher = client.listEnvironmentVpcsPaginator(request); publisher.subscribe(new Subscriber<software.amazon.awssdk.services.migrationhubrefactorspaces.model.ListEnvironmentVpcsResponse>() { public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... }; public void onNext(software.amazon.awssdk.services.migrationhubrefactorspaces.model.ListEnvironmentVpcsResponse response) { //... }; });Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listEnvironmentVpcs(software.amazon.awssdk.services.migrationhubrefactorspaces.model.ListEnvironmentVpcsRequest)operation.
This is a convenience which creates an instance of the
ListEnvironmentVpcsRequest.Builderavoiding the need to create one manually viaListEnvironmentVpcsRequest.builder()- Parameters:
listEnvironmentVpcsRequest- AConsumerthat will call methods onListEnvironmentVpcsRequest.Builderto create a request.- Returns:
- A custom publisher that can be subscribed to request a stream of response pages.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- 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.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- MigrationHubRefactorSpacesException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
listEnvironments
default CompletableFuture<ListEnvironmentsResponse> listEnvironments(ListEnvironmentsRequest listEnvironmentsRequest) Lists Amazon Web Services Migration Hub Refactor Spaces environments owned by a caller account or shared with the caller account.
- Parameters:
listEnvironmentsRequest-- Returns:
- A Java Future containing the result of the ListEnvironments operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- 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.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- MigrationHubRefactorSpacesException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
listEnvironments
default CompletableFuture<ListEnvironmentsResponse> listEnvironments(Consumer<ListEnvironmentsRequest.Builder> listEnvironmentsRequest) Lists Amazon Web Services Migration Hub Refactor Spaces environments owned by a caller account or shared with the caller account.
This is a convenience which creates an instance of the
ListEnvironmentsRequest.Builderavoiding the need to create one manually viaListEnvironmentsRequest.builder()- Parameters:
listEnvironmentsRequest- AConsumerthat will call methods onListEnvironmentsRequest.Builderto create a request.- Returns:
- A Java Future containing the result of the ListEnvironments operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- 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.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- MigrationHubRefactorSpacesException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
listEnvironmentsPaginator
default ListEnvironmentsPublisher listEnvironmentsPaginator(ListEnvironmentsRequest listEnvironmentsRequest) This is a variant of
listEnvironments(software.amazon.awssdk.services.migrationhubrefactorspaces.model.ListEnvironmentsRequest)operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber). Each call to the subscribe method will result in a newSubscriptioni.e., a new contract to stream data from the starting request.The following are few ways to use the response class:
1) Using the subscribe helper method
2) Using a custom subscribersoftware.amazon.awssdk.services.migrationhubrefactorspaces.paginators.ListEnvironmentsPublisher publisher = client.listEnvironmentsPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.software.amazon.awssdk.services.migrationhubrefactorspaces.paginators.ListEnvironmentsPublisher publisher = client.listEnvironmentsPaginator(request); publisher.subscribe(new Subscriber<software.amazon.awssdk.services.migrationhubrefactorspaces.model.ListEnvironmentsResponse>() { public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... }; public void onNext(software.amazon.awssdk.services.migrationhubrefactorspaces.model.ListEnvironmentsResponse response) { //... }; });Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listEnvironments(software.amazon.awssdk.services.migrationhubrefactorspaces.model.ListEnvironmentsRequest)operation.- Parameters:
listEnvironmentsRequest-- Returns:
- A custom publisher that can be subscribed to request a stream of response pages.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- 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.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- MigrationHubRefactorSpacesException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
listEnvironmentsPaginator
default ListEnvironmentsPublisher listEnvironmentsPaginator(Consumer<ListEnvironmentsRequest.Builder> listEnvironmentsRequest) This is a variant of
listEnvironments(software.amazon.awssdk.services.migrationhubrefactorspaces.model.ListEnvironmentsRequest)operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber). Each call to the subscribe method will result in a newSubscriptioni.e., a new contract to stream data from the starting request.The following are few ways to use the response class:
1) Using the subscribe helper method
2) Using a custom subscribersoftware.amazon.awssdk.services.migrationhubrefactorspaces.paginators.ListEnvironmentsPublisher publisher = client.listEnvironmentsPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.software.amazon.awssdk.services.migrationhubrefactorspaces.paginators.ListEnvironmentsPublisher publisher = client.listEnvironmentsPaginator(request); publisher.subscribe(new Subscriber<software.amazon.awssdk.services.migrationhubrefactorspaces.model.ListEnvironmentsResponse>() { public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... }; public void onNext(software.amazon.awssdk.services.migrationhubrefactorspaces.model.ListEnvironmentsResponse response) { //... }; });Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listEnvironments(software.amazon.awssdk.services.migrationhubrefactorspaces.model.ListEnvironmentsRequest)operation.
This is a convenience which creates an instance of the
ListEnvironmentsRequest.Builderavoiding the need to create one manually viaListEnvironmentsRequest.builder()- Parameters:
listEnvironmentsRequest- AConsumerthat will call methods onListEnvironmentsRequest.Builderto create a request.- Returns:
- A custom publisher that can be subscribed to request a stream of response pages.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- 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.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- MigrationHubRefactorSpacesException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
listRoutes
Lists all the Amazon Web Services Migration Hub Refactor Spaces routes within an application.
- Parameters:
listRoutesRequest-- Returns:
- A Java Future containing the result of the ListRoutes operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- 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.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- MigrationHubRefactorSpacesException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
listRoutes
default CompletableFuture<ListRoutesResponse> listRoutes(Consumer<ListRoutesRequest.Builder> listRoutesRequest) Lists all the Amazon Web Services Migration Hub Refactor Spaces routes within an application.
This is a convenience which creates an instance of the
ListRoutesRequest.Builderavoiding the need to create one manually viaListRoutesRequest.builder()- Parameters:
listRoutesRequest- AConsumerthat will call methods onListRoutesRequest.Builderto create a request.- Returns:
- A Java Future containing the result of the ListRoutes operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- 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.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- MigrationHubRefactorSpacesException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
listRoutesPaginator
This is a variant of
listRoutes(software.amazon.awssdk.services.migrationhubrefactorspaces.model.ListRoutesRequest)operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber). Each call to the subscribe method will result in a newSubscriptioni.e., a new contract to stream data from the starting request.The following are few ways to use the response class:
1) Using the subscribe helper method
2) Using a custom subscribersoftware.amazon.awssdk.services.migrationhubrefactorspaces.paginators.ListRoutesPublisher publisher = client.listRoutesPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.software.amazon.awssdk.services.migrationhubrefactorspaces.paginators.ListRoutesPublisher publisher = client.listRoutesPaginator(request); publisher.subscribe(new Subscriber<software.amazon.awssdk.services.migrationhubrefactorspaces.model.ListRoutesResponse>() { public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... }; public void onNext(software.amazon.awssdk.services.migrationhubrefactorspaces.model.ListRoutesResponse response) { //... }; });Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listRoutes(software.amazon.awssdk.services.migrationhubrefactorspaces.model.ListRoutesRequest)operation.- Parameters:
listRoutesRequest-- Returns:
- A custom publisher that can be subscribed to request a stream of response pages.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- 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.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- MigrationHubRefactorSpacesException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
listRoutesPaginator
default ListRoutesPublisher listRoutesPaginator(Consumer<ListRoutesRequest.Builder> listRoutesRequest) This is a variant of
listRoutes(software.amazon.awssdk.services.migrationhubrefactorspaces.model.ListRoutesRequest)operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber). Each call to the subscribe method will result in a newSubscriptioni.e., a new contract to stream data from the starting request.The following are few ways to use the response class:
1) Using the subscribe helper method
2) Using a custom subscribersoftware.amazon.awssdk.services.migrationhubrefactorspaces.paginators.ListRoutesPublisher publisher = client.listRoutesPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.software.amazon.awssdk.services.migrationhubrefactorspaces.paginators.ListRoutesPublisher publisher = client.listRoutesPaginator(request); publisher.subscribe(new Subscriber<software.amazon.awssdk.services.migrationhubrefactorspaces.model.ListRoutesResponse>() { public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... }; public void onNext(software.amazon.awssdk.services.migrationhubrefactorspaces.model.ListRoutesResponse response) { //... }; });Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listRoutes(software.amazon.awssdk.services.migrationhubrefactorspaces.model.ListRoutesRequest)operation.
This is a convenience which creates an instance of the
ListRoutesRequest.Builderavoiding the need to create one manually viaListRoutesRequest.builder()- Parameters:
listRoutesRequest- AConsumerthat will call methods onListRoutesRequest.Builderto create a request.- Returns:
- A custom publisher that can be subscribed to request a stream of response pages.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- 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.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- MigrationHubRefactorSpacesException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
listServices
default CompletableFuture<ListServicesResponse> listServices(ListServicesRequest listServicesRequest) Lists all the Amazon Web Services Migration Hub Refactor Spaces services within an application.
- Parameters:
listServicesRequest-- Returns:
- A Java Future containing the result of the ListServices operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- 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.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- MigrationHubRefactorSpacesException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
listServices
default CompletableFuture<ListServicesResponse> listServices(Consumer<ListServicesRequest.Builder> listServicesRequest) Lists all the Amazon Web Services Migration Hub Refactor Spaces services within an application.
This is a convenience which creates an instance of the
ListServicesRequest.Builderavoiding the need to create one manually viaListServicesRequest.builder()- Parameters:
listServicesRequest- AConsumerthat will call methods onListServicesRequest.Builderto create a request.- Returns:
- A Java Future containing the result of the ListServices operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- 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.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- MigrationHubRefactorSpacesException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
listServicesPaginator
This is a variant of
listServices(software.amazon.awssdk.services.migrationhubrefactorspaces.model.ListServicesRequest)operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber). Each call to the subscribe method will result in a newSubscriptioni.e., a new contract to stream data from the starting request.The following are few ways to use the response class:
1) Using the subscribe helper method
2) Using a custom subscribersoftware.amazon.awssdk.services.migrationhubrefactorspaces.paginators.ListServicesPublisher publisher = client.listServicesPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.software.amazon.awssdk.services.migrationhubrefactorspaces.paginators.ListServicesPublisher publisher = client.listServicesPaginator(request); publisher.subscribe(new Subscriber<software.amazon.awssdk.services.migrationhubrefactorspaces.model.ListServicesResponse>() { public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... }; public void onNext(software.amazon.awssdk.services.migrationhubrefactorspaces.model.ListServicesResponse response) { //... }; });Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listServices(software.amazon.awssdk.services.migrationhubrefactorspaces.model.ListServicesRequest)operation.- Parameters:
listServicesRequest-- Returns:
- A custom publisher that can be subscribed to request a stream of response pages.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- 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.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- MigrationHubRefactorSpacesException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
listServicesPaginator
default ListServicesPublisher listServicesPaginator(Consumer<ListServicesRequest.Builder> listServicesRequest) This is a variant of
listServices(software.amazon.awssdk.services.migrationhubrefactorspaces.model.ListServicesRequest)operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber). Each call to the subscribe method will result in a newSubscriptioni.e., a new contract to stream data from the starting request.The following are few ways to use the response class:
1) Using the subscribe helper method
2) Using a custom subscribersoftware.amazon.awssdk.services.migrationhubrefactorspaces.paginators.ListServicesPublisher publisher = client.listServicesPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.software.amazon.awssdk.services.migrationhubrefactorspaces.paginators.ListServicesPublisher publisher = client.listServicesPaginator(request); publisher.subscribe(new Subscriber<software.amazon.awssdk.services.migrationhubrefactorspaces.model.ListServicesResponse>() { public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... }; public void onNext(software.amazon.awssdk.services.migrationhubrefactorspaces.model.ListServicesResponse response) { //... }; });Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listServices(software.amazon.awssdk.services.migrationhubrefactorspaces.model.ListServicesRequest)operation.
This is a convenience which creates an instance of the
ListServicesRequest.Builderavoiding the need to create one manually viaListServicesRequest.builder()- Parameters:
listServicesRequest- AConsumerthat will call methods onListServicesRequest.Builderto create a request.- Returns:
- A custom publisher that can be subscribed to request a stream of response pages.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- 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.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- MigrationHubRefactorSpacesException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
listTagsForResource
default CompletableFuture<ListTagsForResourceResponse> listTagsForResource(ListTagsForResourceRequest listTagsForResourceRequest) 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.- Parameters:
listTagsForResourceRequest-- Returns:
- A Java Future containing the result of the ListTagsForResource operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- 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.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- MigrationHubRefactorSpacesException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
listTagsForResource
default CompletableFuture<ListTagsForResourceResponse> listTagsForResource(Consumer<ListTagsForResourceRequest.Builder> listTagsForResourceRequest) 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.
This is a convenience which creates an instance of the
ListTagsForResourceRequest.Builderavoiding the need to create one manually viaListTagsForResourceRequest.builder()- Parameters:
listTagsForResourceRequest- AConsumerthat will call methods onListTagsForResourceRequest.Builderto create a request.- Returns:
- A Java Future containing the result of the ListTagsForResource operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- 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.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- MigrationHubRefactorSpacesException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
putResourcePolicy
default CompletableFuture<PutResourcePolicyResponse> putResourcePolicy(PutResourcePolicyRequest putResourcePolicyRequest) 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/AWSRAMDefaultPermissionRefactorSpacesEnvironmentpermission in Resource Access Manager. The policy must not contain new lines or blank lines.- Parameters:
putResourcePolicyRequest-- Returns:
- A Java Future containing the result of the PutResourcePolicy operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- 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.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- MigrationHubRefactorSpacesException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
putResourcePolicy
default CompletableFuture<PutResourcePolicyResponse> putResourcePolicy(Consumer<PutResourcePolicyRequest.Builder> putResourcePolicyRequest) 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/AWSRAMDefaultPermissionRefactorSpacesEnvironmentpermission in Resource Access Manager. The policy must not contain new lines or blank lines.
This is a convenience which creates an instance of the
PutResourcePolicyRequest.Builderavoiding the need to create one manually viaPutResourcePolicyRequest.builder()- Parameters:
putResourcePolicyRequest- AConsumerthat will call methods onPutResourcePolicyRequest.Builderto create a request.- Returns:
- A Java Future containing the result of the PutResourcePolicy operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- 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.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- MigrationHubRefactorSpacesException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
tagResource
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.
- Parameters:
tagResourceRequest-- Returns:
- A Java Future containing the result of the TagResource operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- 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.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- MigrationHubRefactorSpacesException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
tagResource
default CompletableFuture<TagResourceResponse> tagResource(Consumer<TagResourceRequest.Builder> tagResourceRequest) 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.
This is a convenience which creates an instance of the
TagResourceRequest.Builderavoiding the need to create one manually viaTagResourceRequest.builder()- Parameters:
tagResourceRequest- AConsumerthat will call methods onTagResourceRequest.Builderto create a request.- Returns:
- A Java Future containing the result of the TagResource operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- 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.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- MigrationHubRefactorSpacesException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
untagResource
default CompletableFuture<UntagResourceResponse> untagResource(UntagResourceRequest untagResourceRequest) 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.- Parameters:
untagResourceRequest-- Returns:
- A Java Future containing the result of the UntagResource operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- 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.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- MigrationHubRefactorSpacesException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
untagResource
default CompletableFuture<UntagResourceResponse> untagResource(Consumer<UntagResourceRequest.Builder> untagResourceRequest) 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.
This is a convenience which creates an instance of the
UntagResourceRequest.Builderavoiding the need to create one manually viaUntagResourceRequest.builder()- Parameters:
untagResourceRequest- AConsumerthat will call methods onUntagResourceRequest.Builderto create a request.- Returns:
- A Java Future containing the result of the UntagResource operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- 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.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- MigrationHubRefactorSpacesException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
updateRoute
Updates an Amazon Web Services Migration Hub Refactor Spaces route.
- Parameters:
updateRouteRequest-- Returns:
- A Java Future containing the result of the UpdateRoute operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- 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.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- MigrationHubRefactorSpacesException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
updateRoute
default CompletableFuture<UpdateRouteResponse> updateRoute(Consumer<UpdateRouteRequest.Builder> updateRouteRequest) Updates an Amazon Web Services Migration Hub Refactor Spaces route.
This is a convenience which creates an instance of the
UpdateRouteRequest.Builderavoiding the need to create one manually viaUpdateRouteRequest.builder()- Parameters:
updateRouteRequest- AConsumerthat will call methods onUpdateRouteRequest.Builderto create a request.- Returns:
- A Java Future containing the result of the UpdateRoute operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- 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.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- MigrationHubRefactorSpacesException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
serviceClientConfiguration
Description copied from interface:SdkClientThe SDK service client configuration exposes client settings to the user, e.g., ClientOverrideConfiguration- Specified by:
serviceClientConfigurationin interfaceAwsClient- Specified by:
serviceClientConfigurationin interfaceSdkClient- Returns:
- SdkServiceClientConfiguration
-
create
Create aMigrationHubRefactorSpacesAsyncClientwith the region loaded from theDefaultAwsRegionProviderChainand credentials loaded from theDefaultCredentialsProvider. -
builder
Create a builder that can be used to configure and create aMigrationHubRefactorSpacesAsyncClient.
-