AWS SDK for JavaScript M2 Client for Node.js, Browser and React Native
npm install @aws-sdk/client-m2AWS SDK for JavaScript M2 Client for Node.js, Browser and React Native.
Amazon Web Services Mainframe Modernization provides tools and resources to help you plan and implement migration and
modernization from mainframes to Amazon Web Services managed runtime environments. It provides tools for
analyzing existing mainframe applications, developing or updating mainframe applications
using COBOL or PL/I, and implementing an automated pipeline for continuous integration and
continuous delivery (CI/CD) of the applications.
npm install @aws-sdk/client-m2yarn add @aws-sdk/client-m2pnpm add @aws-sdk/client-m2The AWS SDK is modulized by clients and commands.
To send a request, you only need to import the M2Client and
the commands you need, for example ListApplicationsCommand:
``js`
// ES5 example
const { M2Client, ListApplicationsCommand } = require("@aws-sdk/client-m2");
`ts`
// ES6+ example
import { M2Client, ListApplicationsCommand } from "@aws-sdk/client-m2";
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 M2Client({ region: "REGION" });
const params = { /* input parameters / };
const command = new ListApplicationsCommand(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-m2";
const client = new AWS.M2({ region: "REGION" });
// async/await.
try {
const data = await client.listApplications(params);
// process data.
} catch (error) {
// error handling.
}
// Promises.
client
.listApplications(params)
.then((data) => {
// process data.
})
.catch((error) => {
// error handling.
});
// callbacks.
client.listApplications(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-m2` 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.
CancelBatchJobExecution
Command API Reference / Input / Output
CreateApplication
Command API Reference / Input / Output
CreateDataSetExportTask
Command API Reference / Input / Output
CreateDataSetImportTask
Command API Reference / Input / Output
CreateDeployment
Command API Reference / Input / Output
CreateEnvironment
Command API Reference / Input / Output
DeleteApplication
Command API Reference / Input / Output
DeleteApplicationFromEnvironment
Command API Reference / Input / Output
DeleteEnvironment
Command API Reference / Input / Output
GetApplication
Command API Reference / Input / Output
GetApplicationVersion
Command API Reference / Input / Output
GetBatchJobExecution
Command API Reference / Input / Output
GetDataSetDetails
Command API Reference / Input / Output
GetDataSetExportTask
Command API Reference / Input / Output
GetDataSetImportTask
Command API Reference / Input / Output
GetDeployment
Command API Reference / Input / Output
GetEnvironment
Command API Reference / Input / Output
GetSignedBluinsightsUrl
Command API Reference / Input / Output
ListApplications
Command API Reference / Input / Output
ListApplicationVersions
Command API Reference / Input / Output
ListBatchJobDefinitions
Command API Reference / Input / Output
ListBatchJobExecutions
Command API Reference / Input / Output
ListBatchJobRestartPoints
Command API Reference / Input / Output
ListDataSetExportHistory
Command API Reference / Input / Output
ListDataSetImportHistory
Command API Reference / Input / Output
ListDataSets
Command API Reference / Input / Output
ListDeployments
Command API Reference / Input / Output
ListEngineVersions
Command API Reference / Input / Output
ListEnvironments
Command API Reference / Input / Output
ListTagsForResource
Command API Reference / Input / Output
StartApplication
Command API Reference / Input / Output
StartBatchJob
Command API Reference / Input / Output
StopApplication
Command API Reference / Input / Output
TagResource
Command API Reference / Input / Output
UntagResource
Command API Reference / Input / Output
UpdateApplication
Command API Reference / Input / Output
UpdateEnvironment