- Navigation GuideYou are on a Client landing page. Commands (operations) are listed on this page. The Client constructor type is linked at the bottom.
M2Client
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.
Installation
npm install @aws-sdk/client-m2
yarn add @aws-sdk/client-m2
pnpm add @aws-sdk/client-m2
M2Client Operations
Command | Summary |
---|
Command | Summary |
---|---|
CancelBatchJobExecutionCommand | Cancels the running of a specific batch job execution. |
CreateApplicationCommand | Creates a new application with given parameters. Requires an existing runtime environment and application definition file. |
CreateDataSetImportTaskCommand | Starts a data set import task for a specific application. |
CreateDeploymentCommand | Creates and starts a deployment to deploy an application into a runtime environment. |
CreateEnvironmentCommand | Creates a runtime environment for a given runtime engine. |
DeleteApplicationCommand | Deletes a specific application. You cannot delete a running application. |
DeleteApplicationFromEnvironmentCommand | Deletes a specific application from the specific runtime environment where it was previously deployed. You cannot delete a runtime environment using DeleteEnvironment if any application has ever been deployed to it. This API removes the association of the application with the runtime environment so you can delete the environment smoothly. |
DeleteEnvironmentCommand | Deletes a specific runtime environment. The environment cannot contain deployed applications. If it does, you must delete those applications before you delete the environment. |
GetApplicationCommand | Describes the details of a specific application. |
GetApplicationVersionCommand | Returns details about a specific version of a specific application. |
GetBatchJobExecutionCommand | Gets the details of a specific batch job execution for a specific application. |
GetDataSetDetailsCommand | Gets the details of a specific data set. |
GetDataSetImportTaskCommand | Gets the status of a data set import task initiated with the CreateDataSetImportTask operation. |
GetDeploymentCommand | Gets details of a specific deployment with a given deployment identifier. |
GetEnvironmentCommand | Describes a specific runtime environment. |
GetSignedBluinsightsUrlCommand | Gets a single sign-on URL that can be used to connect to AWS Blu Insights. |
ListApplicationVersionsCommand | Returns a list of the application versions for a specific application. |
ListApplicationsCommand | Lists the applications associated with a specific Amazon Web Services account. You can provide the unique identifier of a specific runtime environment in a query parameter to see all applications associated with that environment. |
ListBatchJobDefinitionsCommand | Lists all the available batch job definitions based on the batch job resources uploaded during the application creation. You can use the batch job definitions in the list to start a batch job. |
ListBatchJobExecutionsCommand | Lists historical, current, and scheduled batch job executions for a specific application. |
ListBatchJobRestartPointsCommand | Lists all the job steps for a JCL file to restart a batch job. This is only applicable for Micro Focus engine with versions 8.0.6 and above. |
ListDataSetImportHistoryCommand | Lists the data set imports for the specified application. |
ListDataSetsCommand | Lists the data sets imported for a specific application. In Amazon Web Services Mainframe Modernization, data sets are associated with applications deployed on runtime environments. This is known as importing data sets. Currently, Amazon Web Services Mainframe Modernization can import data sets into catalogs using CreateDataSetImportTask . |
ListDeploymentsCommand | Returns a list of all deployments of a specific application. A deployment is a combination of a specific application and a specific version of that application. Each deployment is mapped to a particular application version. |
ListEngineVersionsCommand | Lists the available engine versions. |
ListEnvironmentsCommand | Lists the runtime environments. |
ListTagsForResourceCommand | Lists the tags for the specified resource. |
StartApplicationCommand | Starts an application that is currently stopped. |
StartBatchJobCommand | Starts a batch job and returns the unique identifier of this execution of the batch job. The associated application must be running in order to start the batch job. |
StopApplicationCommand | Stops a running application. |
TagResourceCommand | Adds one or more tags to the specified resource. |
UntagResourceCommand | Removes one or more tags from the specified resource. |
UpdateApplicationCommand | Updates an application and creates a new version. |
UpdateEnvironmentCommand | Updates the configuration details for a specific runtime environment. |
M2Client 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: M2ClientConfig