migrationhubrefactorspaces/aws.sdk.kotlin.services.migrationhubrefactorspaces/MigrationHubRefactorSpacesClient

MigrationHubRefactorSpacesClient

interface MigrationHubRefactorSpacesClient : SdkClient

Amazon Web Services Migration Hub Refactor Spaces

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.

Properties

Link copied to clipboard
abstract override val config: MigrationHubRefactorSpacesClient.Config

MigrationHubRefactorSpacesClient's configuration

Functions

Link copied to clipboard
abstract suspend fun createApplication(input: CreateApplicationRequest): CreateApplicationResponse

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.

Link copied to clipboard
abstract suspend fun createEnvironment(input: CreateEnvironmentRequest): CreateEnvironmentResponse

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.

Link copied to clipboard
abstract suspend fun createRoute(input: CreateRouteRequest): CreateRouteResponse

Creates an Amazon Web Services Migration Hub Refactor Spaces route. The account owner of the service resource is always the environment owner, regardless of which account creates the route. Routes target a service in the application. If an application does not have any routes, then the first route must be created as a DEFAULT``RouteType.

Link copied to clipboard
abstract suspend fun createService(input: CreateServiceRequest): CreateServiceResponse

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.

Link copied to clipboard
abstract suspend fun deleteApplication(input: DeleteApplicationRequest): DeleteApplicationResponse

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.

Link copied to clipboard
abstract suspend fun deleteEnvironment(input: DeleteEnvironmentRequest): DeleteEnvironmentResponse

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.

Link copied to clipboard
abstract suspend fun deleteResourcePolicy(input: DeleteResourcePolicyRequest): DeleteResourcePolicyResponse

Deletes the resource policy set for the environment.

Link copied to clipboard
abstract suspend fun deleteRoute(input: DeleteRouteRequest): DeleteRouteResponse

Deletes an Amazon Web Services Migration Hub Refactor Spaces route.

Link copied to clipboard
abstract suspend fun deleteService(input: DeleteServiceRequest): DeleteServiceResponse

Deletes an Amazon Web Services Migration Hub Refactor Spaces service.

Link copied to clipboard
abstract suspend fun getApplication(input: GetApplicationRequest): GetApplicationResponse

Gets an Amazon Web Services Migration Hub Refactor Spaces application.

Link copied to clipboard
abstract suspend fun getEnvironment(input: GetEnvironmentRequest): GetEnvironmentResponse

Gets an Amazon Web Services Migration Hub Refactor Spaces environment.

Link copied to clipboard
abstract suspend fun getResourcePolicy(input: GetResourcePolicyRequest): GetResourcePolicyResponse

Gets the resource-based permission policy that is set for the given environment.

Link copied to clipboard
abstract suspend fun getRoute(input: GetRouteRequest): GetRouteResponse

Gets an Amazon Web Services Migration Hub Refactor Spaces route.

Link copied to clipboard
abstract suspend fun getService(input: GetServiceRequest): GetServiceResponse

Gets an Amazon Web Services Migration Hub Refactor Spaces service.

Link copied to clipboard
abstract suspend fun listApplications(input: ListApplicationsRequest): ListApplicationsResponse

Lists all the Amazon Web Services Migration Hub Refactor Spaces applications within an environment.

Link copied to clipboard
abstract suspend fun listEnvironments(input: ListEnvironmentsRequest = ListEnvironmentsRequest { }): ListEnvironmentsResponse

Lists Amazon Web Services Migration Hub Refactor Spaces environments owned by a caller account or shared with the caller account.

Link copied to clipboard
abstract suspend fun listEnvironmentVpcs(input: ListEnvironmentVpcsRequest): ListEnvironmentVpcsResponse

Lists all Amazon Web Services Migration Hub Refactor Spaces service virtual private clouds (VPCs) that are part of the environment.

Link copied to clipboard
abstract suspend fun listRoutes(input: ListRoutesRequest): ListRoutesResponse

Lists all the Amazon Web Services Migration Hub Refactor Spaces routes within an application.

Link copied to clipboard
abstract suspend fun listServices(input: ListServicesRequest): ListServicesResponse

Lists all the Amazon Web Services Migration Hub Refactor Spaces services within an application.

Link copied to clipboard
abstract suspend fun listTagsForResource(input: ListTagsForResourceRequest): ListTagsForResourceResponse

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.

Link copied to clipboard
abstract suspend fun putResourcePolicy(input: PutResourcePolicyRequest): PutResourcePolicyResponse

Attaches a resource-based permission policy to the Amazon Web Services Migration Hub Refactor Spaces environment. The policy must contain the same actions and condition statements as the arn:aws:ram::aws:permission/AWSRAMDefaultPermissionRefactorSpacesEnvironment permission in Resource Access Manager. The policy must not contain new lines or blank lines.

Link copied to clipboard
abstract suspend fun tagResource(input: TagResourceRequest): TagResourceResponse

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.

Link copied to clipboard
abstract suspend fun untagResource(input: UntagResourceRequest): UntagResourceResponse

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.

Link copied to clipboard
abstract suspend fun updateRoute(input: UpdateRouteRequest): UpdateRouteResponse

Updates an Amazon Web Services Migration Hub Refactor Spaces route.

Inherited functions

Link copied to clipboard
expect abstract fun close()
Link copied to clipboard
inline suspend fun MigrationHubRefactorSpacesClient.createApplication(crossinline block: CreateApplicationRequest.Builder.() -> Unit): CreateApplicationResponse

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.

Link copied to clipboard
inline suspend fun MigrationHubRefactorSpacesClient.createEnvironment(crossinline block: CreateEnvironmentRequest.Builder.() -> Unit): CreateEnvironmentResponse

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.

Link copied to clipboard
inline suspend fun MigrationHubRefactorSpacesClient.createRoute(crossinline block: CreateRouteRequest.Builder.() -> Unit): CreateRouteResponse

Creates an Amazon Web Services Migration Hub Refactor Spaces route. The account owner of the service resource is always the environment owner, regardless of which account creates the route. Routes target a service in the application. If an application does not have any routes, then the first route must be created as a DEFAULT``RouteType.

Link copied to clipboard
inline suspend fun MigrationHubRefactorSpacesClient.createService(crossinline block: CreateServiceRequest.Builder.() -> Unit): CreateServiceResponse

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.

Link copied to clipboard
inline suspend fun MigrationHubRefactorSpacesClient.deleteApplication(crossinline block: DeleteApplicationRequest.Builder.() -> Unit): DeleteApplicationResponse

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.

Link copied to clipboard
inline suspend fun MigrationHubRefactorSpacesClient.deleteEnvironment(crossinline block: DeleteEnvironmentRequest.Builder.() -> Unit): DeleteEnvironmentResponse

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.

Link copied to clipboard
inline suspend fun MigrationHubRefactorSpacesClient.deleteResourcePolicy(crossinline block: DeleteResourcePolicyRequest.Builder.() -> Unit): DeleteResourcePolicyResponse

Deletes the resource policy set for the environment.

Link copied to clipboard
inline suspend fun MigrationHubRefactorSpacesClient.deleteRoute(crossinline block: DeleteRouteRequest.Builder.() -> Unit): DeleteRouteResponse

Deletes an Amazon Web Services Migration Hub Refactor Spaces route.

Link copied to clipboard
inline suspend fun MigrationHubRefactorSpacesClient.deleteService(crossinline block: DeleteServiceRequest.Builder.() -> Unit): DeleteServiceResponse

Deletes an Amazon Web Services Migration Hub Refactor Spaces service.

Link copied to clipboard
inline suspend fun MigrationHubRefactorSpacesClient.getApplication(crossinline block: GetApplicationRequest.Builder.() -> Unit): GetApplicationResponse

Gets an Amazon Web Services Migration Hub Refactor Spaces application.

Link copied to clipboard
inline suspend fun MigrationHubRefactorSpacesClient.getEnvironment(crossinline block: GetEnvironmentRequest.Builder.() -> Unit): GetEnvironmentResponse

Gets an Amazon Web Services Migration Hub Refactor Spaces environment.

Link copied to clipboard
inline suspend fun MigrationHubRefactorSpacesClient.getResourcePolicy(crossinline block: GetResourcePolicyRequest.Builder.() -> Unit): GetResourcePolicyResponse

Gets the resource-based permission policy that is set for the given environment.

Link copied to clipboard
inline suspend fun MigrationHubRefactorSpacesClient.getRoute(crossinline block: GetRouteRequest.Builder.() -> Unit): GetRouteResponse

Gets an Amazon Web Services Migration Hub Refactor Spaces route.

Link copied to clipboard
inline suspend fun MigrationHubRefactorSpacesClient.getService(crossinline block: GetServiceRequest.Builder.() -> Unit): GetServiceResponse

Gets an Amazon Web Services Migration Hub Refactor Spaces service.

Link copied to clipboard
inline suspend fun MigrationHubRefactorSpacesClient.listApplications(crossinline block: ListApplicationsRequest.Builder.() -> Unit): ListApplicationsResponse

Lists all the Amazon Web Services Migration Hub Refactor Spaces applications within an environment.

Link copied to clipboard
Link copied to clipboard
inline suspend fun MigrationHubRefactorSpacesClient.listEnvironments(crossinline block: ListEnvironmentsRequest.Builder.() -> Unit): ListEnvironmentsResponse

Lists Amazon Web Services Migration Hub Refactor Spaces environments owned by a caller account or shared with the caller account.

Link copied to clipboard
Link copied to clipboard
inline suspend fun MigrationHubRefactorSpacesClient.listEnvironmentVpcs(crossinline block: ListEnvironmentVpcsRequest.Builder.() -> Unit): ListEnvironmentVpcsResponse

Lists all Amazon Web Services Migration Hub Refactor Spaces service virtual private clouds (VPCs) that are part of the environment.

Link copied to clipboard
Link copied to clipboard
inline suspend fun MigrationHubRefactorSpacesClient.listRoutes(crossinline block: ListRoutesRequest.Builder.() -> Unit): ListRoutesResponse

Lists all the Amazon Web Services Migration Hub Refactor Spaces routes within an application.

Link copied to clipboard
Link copied to clipboard
inline suspend fun MigrationHubRefactorSpacesClient.listServices(crossinline block: ListServicesRequest.Builder.() -> Unit): ListServicesResponse

Lists all the Amazon Web Services Migration Hub Refactor Spaces services within an application.

Link copied to clipboard
Link copied to clipboard
inline suspend fun MigrationHubRefactorSpacesClient.listTagsForResource(crossinline block: ListTagsForResourceRequest.Builder.() -> Unit): ListTagsForResourceResponse

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.

Link copied to clipboard
inline suspend fun MigrationHubRefactorSpacesClient.putResourcePolicy(crossinline block: PutResourcePolicyRequest.Builder.() -> Unit): PutResourcePolicyResponse

Attaches a resource-based permission policy to the Amazon Web Services Migration Hub Refactor Spaces environment. The policy must contain the same actions and condition statements as the arn:aws:ram::aws:permission/AWSRAMDefaultPermissionRefactorSpacesEnvironment permission in Resource Access Manager. The policy must not contain new lines or blank lines.

Link copied to clipboard
inline suspend fun MigrationHubRefactorSpacesClient.tagResource(crossinline block: TagResourceRequest.Builder.() -> Unit): TagResourceResponse

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.

Link copied to clipboard
inline suspend fun MigrationHubRefactorSpacesClient.untagResource(crossinline block: UntagResourceRequest.Builder.() -> Unit): UntagResourceResponse

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.

Link copied to clipboard
inline suspend fun MigrationHubRefactorSpacesClient.updateRoute(crossinline block: UpdateRouteRequest.Builder.() -> Unit): UpdateRouteResponse

Updates an Amazon Web Services Migration Hub Refactor Spaces route.

Link copied to clipboard
fun MigrationHubRefactorSpacesClient.withConfig(block: MigrationHubRefactorSpacesClient.Config.Builder.() -> Unit): MigrationHubRefactorSpacesClient

Create a copy of the client with one or more configuration values overridden. This method allows the caller to perform scoped config overrides for one or more client operations.