Amazon Web Services, Inc.

AWSMainframeModernization

Amazon Web Services Mainframe Modernization provides tools and resources to help you plan and implement migration and modernization from mainframes to Amazon…

Developer tools#openapi

Fork copies the collection into your workspace, without the publisher's secrets, so you can add your own key and send requests. Star saves it to your starred APIs (Account › Marketplace) and helps others find it.

Overview

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.

Endpoints 37

Application

  • POSTCancel batch job execution/applications/:applicationId/batch-job-executions/:executionId/cancelCancels the running of a specific batch job execution.
  • GETList applications/applications?nextToken=string&maxResults=0&names=&environmentId=stringLists the applications associated with a specific Amazon Web Services account. You can provide the unique identifier of a specific runtime environment in a…
  • POSTCreate application/applicationsCreates a new application with given parameters. Requires an existing runtime environment and application definition file.
  • POSTCreate data set export task/applications/:applicationId/dataset-export-taskStarts a data set export task for a specific application.
  • POSTCreate data set import task/applications/:applicationId/dataset-import-taskStarts a data set import task for a specific application.
  • GETList deployments/applications/:applicationId/deployments?nextToken=string&maxResults=0Returns a list of all deployments of a specific application. A deployment is a combination of a specific application and a specific version of that…
  • POSTCreate deployment/applications/:applicationId/deploymentsCreates and starts a deployment to deploy an application into a runtime environment.
  • GETGet application/applications/:applicationIdDescribes the details of a specific application.
  • DELETEDelete application/applications/:applicationIdDeletes a specific application. You cannot delete a running application.
  • PATCHUpdate application/applications/:applicationIdUpdates an application and creates a new version.
  • DELETEDelete application from environment/applications/:applicationId/environment/:environmentIdDeletes a specific application from the specific runtime environment where it was previously deployed. You cannot delete a runtime environment using…
  • GETGet application version/applications/:applicationId/versions/:applicationVersionReturns details about a specific version of a specific application.
  • GETGet batch job execution/applications/:applicationId/batch-job-executions/:executionIdGets the details of a specific batch job execution for a specific application.
  • GETGet data set details/applications/:applicationId/datasets/:dataSetNameGets the details of a specific data set.
  • GETGet data set export task/applications/:applicationId/dataset-export-tasks/:taskIdGets the status of a data set import task initiated with the CreateDataSetExportTask operation.
  • GETGet data set import task/applications/:applicationId/dataset-import-tasks/:taskIdGets the status of a data set import task initiated with the CreateDataSetImportTask operation.
  • GETGet deployment/applications/:applicationId/deployments/:deploymentIdGets details of a specific deployment with a given deployment identifier.
  • GETList application versions/applications/:applicationId/versions?nextToken=string&maxResults=0Returns a list of the application versions for a specific application.
  • GETList batch job definitions/applications/:applicationId/batch-job-definitions?nextToken=string&maxResults=0&prefix=stringLists all the available batch job definitions based on the batch job resources uploaded during the application creation. You can use the batch job definitions…
  • GETList batch job executions/applications/:applicationId/batch-job-executions?nextToken=string&maxResults=0&executionIds=&jobName=string&status=string&startedAfter=string&startedBefore=stringLists historical, current, and scheduled batch job executions for a specific application.
  • GETList batch job restart points/applications/:applicationId/batch-job-executions/:executionId/steps?authSecretsManagerArn=stringLists 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.
  • GETList data set export history/applications/:applicationId/dataset-export-tasks?nextToken=string&maxResults=0Lists the data set exports for the specified application.
  • GETList data set import history/applications/:applicationId/dataset-import-tasks?nextToken=string&maxResults=0Lists the data set imports for the specified application.
  • GETList data sets/applications/:applicationId/datasets?nextToken=string&maxResults=0&prefix=string&nameFilter=stringLists the data sets imported for a specific application. In Amazon Web Services Mainframe Modernization, data sets are associated with applications deployed…
  • POSTStart application/applications/:applicationId/startStarts an application that is currently stopped.
  • POSTStart batch job/applications/:applicationId/batch-jobStarts 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…
  • POSTStop application/applications/:applicationId/stopStops a running application.

Environment

  • GETList environments/environments?nextToken=string&maxResults=0&names=&engineType=stringLists the runtime environments.
  • POSTCreate environment/environmentsCreates a runtime environment for a given runtime engine.
  • GETGet environment/environments/:environmentIdDescribes a specific runtime environment.
  • DELETEDelete environment/environments/:environmentIdDeletes a specific runtime environment. The environment cannot contain deployed applications. If it does, you must delete those applications before you delete…
  • PATCHUpdate environment/environments/:environmentIdUpdates the configuration details for a specific runtime environment.
  • GETGet signed bluinsights url/signed-bi-urlGets a single sign-on URL that can be used to connect to AWS Blu Insights.
  • GETList engine versions/engine-versions?engineType=string&nextToken=string&maxResults=0Lists the available engine versions.
  • GETList tags for resource/tags/:resourceArnLists the tags for the specified resource.
  • POSTTag resource/tags/:resourceArnAdds one or more tags to the specified resource.
  • DELETEUntag resource/tags/:resourceArn?tagKeys=Removes one or more tags from the specified resource.

API details

Base URL
https://m2.{region}.amazonaws.com
Authentication
AWS Signature Version 4 (requests signed with your AWS access key)
Operations
37 operations on 28 pathsGET 21POST 10DELETE 4PATCH 2
Main resources
Application 27Environment 5
Description format
AWS Smithy model, API version 2021-04-28

How to test the AWSMainframeModernization in Swastik Codes

  1. Open the APISelect “Fork & run in Swastik Codes” on this page. Sign in or create a free account if asked.
  2. Fork it into your workspaceChoose a workspace. You get your own copy of the AWSMainframeModernization collection, without the publisher's secrets.
  3. Add your credentialsThis API uses AWS Signature Version 4 (requests signed with your AWS access key). Add yours in the collection's variables or an environment; the requests already reference it.
  4. Send a requestPick an endpoint, for example “Cancel batch job execution” (POST /applications/:applicationId/batch-job-executions/:executionId/cancel), and press Send. Check the response, add tests and run the whole collection with the runner.

Frequently asked questions

What is the AWSMainframeModernization?

Amazon Web Services Mainframe Modernization provides tools and resources to help you plan and implement migration and modernization from mainframes to Amazon… It is listed under Developer tools and has 37 endpoints.

Who publishes the AWSMainframeModernization?

It is listed from Amazon Web Services, Inc.'s public API description (an OpenAPI document), not published by Amazon Web Services, Inc. on Swastik Codes. Anyone who controls amazonaws.com can claim the profile by adding a DNS TXT record.

What is the base URL of the AWSMainframeModernization?

Requests go to https://m2.{region}.amazonaws.com. Endpoint paths are added to this base URL.

How do I authenticate with the AWSMainframeModernization?

With AWS Signature Version 4 (requests signed with your AWS access key).

How many endpoints does the AWSMainframeModernization have?

37 operations on 28 paths (21 GET, 10 POST, 4 DELETE, 2 PATCH). The largest groups are Application, Environment.

Is forking the AWSMainframeModernization free?

Yes. Forking copies the collection into your workspace for free. It has been starred 0 times and forked 0 times.

Suggest an API

Tell us which public API is missing. We check it, then add it here with its endpoints when it has an OpenAPI (Swagger) description.