AWS SDK for JavaScript Migration Hub Refactor Spaces Client for Node.js, Browser and React Native
npm install @aws-sdk/client-migration-hub-refactor-spacesAWS SDK for JavaScript MigrationHubRefactorSpaces Client for Node.js, Browser and React Native.
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.
npm install @aws-sdk/client-migration-hub-refactor-spacesyarn add @aws-sdk/client-migration-hub-refactor-spacespnpm add @aws-sdk/client-migration-hub-refactor-spacesThe AWS SDK is modulized by clients and commands.
To send a request, you only need to import the MigrationHubRefactorSpacesClient and
the commands you need, for example ListEnvironmentsCommand:
``js`
// ES5 example
const { MigrationHubRefactorSpacesClient, ListEnvironmentsCommand } = require("@aws-sdk/client-migration-hub-refactor-spaces");
`ts`
// ES6+ example
import { MigrationHubRefactorSpacesClient, ListEnvironmentsCommand } from "@aws-sdk/client-migration-hub-refactor-spaces";
To send a request, you:
- Initiate client with configuration (e.g. credentials, region).
- Initiate command with input parameters.
- Call send operation on client with command object as input.destroy()
- If you are using a custom http handler, you may call to close open connections.
`js
// a client can be shared by different commands.
const client = new MigrationHubRefactorSpacesClient({ region: "REGION" });
const params = { /* input parameters / };
const command = new ListEnvironmentsCommand(params);
`
#### Async/await
We recommend using await
operator to wait for the promise returned by send operation as follows:
`js`
// async/await.
try {
const data = await client.send(command);
// process data.
} catch (error) {
// error handling.
} finally {
// finally.
}
Async-await is clean, concise, intuitive, easy to debug and has better error handling
as compared to using Promise chains or callbacks.
#### Promises
You can also use Promise chaining
to execute send operation.
`js`
client.send(command).then(
(data) => {
// process data.
},
(error) => {
// error handling.
}
);
Promises can also be called using .catch() and .finally() as follows:
`js`
client
.send(command)
.then((data) => {
// process data.
})
.catch((error) => {
// error handling.
})
.finally(() => {
// finally.
});
#### Callbacks
We do not recommend using callbacks because of callback hell,
but they are supported by the send operation.
`js`
// callbacks.
client.send(command, (err, data) => {
// process err and data.
});
#### v2 compatible style
The client can also send requests using v2 compatible style.
However, it results in a bigger bundle size and may be dropped in next major version. More details in the blog post
on modular packages in AWS SDK for JavaScript
`ts
import * as AWS from "@aws-sdk/client-migration-hub-refactor-spaces";
const client = new AWS.MigrationHubRefactorSpaces({ region: "REGION" });
// async/await.
try {
const data = await client.listEnvironments(params);
// process data.
} catch (error) {
// error handling.
}
// Promises.
client
.listEnvironments(params)
.then((data) => {
// process data.
})
.catch((error) => {
// error handling.
});
// callbacks.
client.listEnvironments(params, (err, data) => {
// process err and data.
});
`
When the service returns an exception, the error will include the exception information,
as well as response metadata (e.g. request id).
`js`
try {
const data = await client.send(command);
// process data.
} catch (error) {
const { requestId, cfId, extendedRequestId } = error.$metadata;
console.log({ requestId, cfId, extendedRequestId });
/**
* The keys within exceptions are also parsed.
* You can access them by specifying exception names:
* if (error.name === 'SomeServiceException') {
* const value = error.specialKeyInException;
* }
*/
}
Please use these community resources for getting help.
We use the GitHub issues for tracking bugs and feature requests, but have limited bandwidth to address them.
- Visit Developer Guide
or API Reference.
- Check out the blog posts tagged with aws-sdk-js
on AWS Developer Blog.
- Ask a question on StackOverflow and tag it with aws-sdk-js.
- Join the AWS JavaScript community on gitter.
- If it turns out that you may have found a bug, please open an issue.
To test your universal JavaScript code in Node.js, browser and react-native environments,
visit our code samples repo.
This client code is generated automatically. Any modifications will be overwritten the next time the @aws-sdk/client-migration-hub-refactor-spaces` package is updated.
To contribute to client you can check our generate clients scripts.
This SDK is distributed under the
Apache License, Version 2.0,
see LICENSE for more information.
CreateApplication
Command API Reference / Input / Output
CreateEnvironment
Command API Reference / Input / Output
CreateRoute
Command API Reference / Input / Output
CreateService
Command API Reference / Input / Output
DeleteApplication
Command API Reference / Input / Output
DeleteEnvironment
Command API Reference / Input / Output
DeleteResourcePolicy
Command API Reference / Input / Output
DeleteRoute
Command API Reference / Input / Output
DeleteService
Command API Reference / Input / Output
GetApplication
Command API Reference / Input / Output
GetEnvironment
Command API Reference / Input / Output
GetResourcePolicy
Command API Reference / Input / Output
GetRoute
Command API Reference / Input / Output
GetService
Command API Reference / Input / Output
ListApplications
Command API Reference / Input / Output
ListEnvironments
Command API Reference / Input / Output
ListEnvironmentVpcs
Command API Reference / Input / Output
ListRoutes
Command API Reference / Input / Output
ListServices
Command API Reference / Input / Output
ListTagsForResource
Command API Reference / Input / Output
PutResourcePolicy
Command API Reference / Input / Output
TagResource
Command API Reference / Input / Output
UntagResource
Command API Reference / Input / Output
UpdateRoute