- Navigation GuideYou are on a Client landing page. Commands (operations) are listed on this page. The Client constructor type is linked at the bottom.
MigrationHubRefactorSpacesClient
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.
Installation
npm install @aws-sdk/client-migration-hub-refactor-spaces
yarn add @aws-sdk/client-migration-hub-refactor-spaces
pnpm add @aws-sdk/client-migration-hub-refactor-spaces
MigrationHubRefactorSpacesClient Operations
Command | Summary |
---|
Command | Summary |
---|---|
CreateApplicationCommand | 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 |
CreateEnvironmentCommand | 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 |
CreateRouteCommand | 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 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:
Environments without a network bridge When you create environments without a network bridge (CreateEnvironment:NetworkFabricType is |
CreateServiceCommand | 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 |
DeleteApplicationCommand | 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. |
DeleteEnvironmentCommand | 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. |
DeleteResourcePolicyCommand | Deletes the resource policy set for the environment. |
DeleteRouteCommand | Deletes an Amazon Web Services Migration Hub Refactor Spaces route. |
DeleteServiceCommand | Deletes an Amazon Web Services Migration Hub Refactor Spaces service. |
GetApplicationCommand | Gets an Amazon Web Services Migration Hub Refactor Spaces application. |
GetEnvironmentCommand | Gets an Amazon Web Services Migration Hub Refactor Spaces environment. |
GetResourcePolicyCommand | Gets the resource-based permission policy that is set for the given environment. |
GetRouteCommand | Gets an Amazon Web Services Migration Hub Refactor Spaces route. |
GetServiceCommand | Gets an Amazon Web Services Migration Hub Refactor Spaces service. |
ListApplicationsCommand | Lists all the Amazon Web Services Migration Hub Refactor Spaces applications within an environment. |
ListEnvironmentVpcsCommand | Lists all Amazon Web Services Migration Hub Refactor Spaces service virtual private clouds (VPCs) that are part of the environment. |
ListEnvironmentsCommand | Lists Amazon Web Services Migration Hub Refactor Spaces environments owned by a caller account or shared with the caller account. |
ListRoutesCommand | Lists all the Amazon Web Services Migration Hub Refactor Spaces routes within an application. |
ListServicesCommand | Lists all the Amazon Web Services Migration Hub Refactor Spaces services within an application. |
ListTagsForResourceCommand | Lists the tags of a resource. The caller account must be the same as the resource’s |
PutResourcePolicyCommand | 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 |
TagResourceCommand | 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 Amazon Web Services Migration Hub Refactor Spaces does not propagate tags to orchestrated resources, such as an environment’s transit gateway. |
UntagResourceCommand | 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 |
UpdateRouteCommand | Updates an Amazon Web Services Migration Hub Refactor Spaces route. |
MigrationHubRefactorSpacesClient Configuration
Parameter | Type | Description |
---|
Parameter | Type | Description |
---|---|---|
defaultsMode Optional | DefaultsMode | Provider<DefaultsMode> | The @smithy/smithy-client#DefaultsMode that will be used to determine how certain default configuration options are resolved in the SDK. |
disableHostPrefix Optional | boolean | Disable dynamically changing the endpoint of the client based on the hostPrefix trait of an operation. |
extensions Optional | RuntimeExtension[] | Optional extensions |
logger Optional | Logger | Optional logger for logging debug/info/warn/error. |
maxAttempts Optional | number | Provider<number> | Value for how many times a request will be made at most in case of retry. |
profile Optional | string | Setting a client profile is similar to setting a value for the AWS_PROFILE environment variable. Setting a profile on a client in code only affects the single client instance, unlike AWS_PROFILE.When set, and only for environments where an AWS configuration file exists, fields configurable by this file will be retrieved from the specified profile within that file. Conflicting code configuration and environment variables will still have higher priority.For client credential resolution that involves checking the AWS configuration file, the client's profile (this value) will be used unless a different profile is set in the credential provider options. |
region Optional | string | Provider<string> | The AWS region to which this client will send requests |
requestHandler Optional | __HttpHandlerUserInput | The HTTP handler to use or its constructor options. Fetch in browser and Https in Nodejs. |
retryMode Optional | string | Provider<string> | Specifies which retry algorithm to use. |
useDualstackEndpoint Optional | boolean | Provider<boolean> | Enables IPv6/IPv4 dualstack endpoint. |
useFipsEndpoint Optional | boolean | Provider<boolean> | Enables FIPS compatible endpoints. |
Additional config fields are described in the full configuration type: MigrationHubRefactorSpacesClientConfig