# AWSMainframeModernization API

> AWSMainframeModernization API on Apizie: 33 endpoints (Cancels the running of a specific batch job execution., Lists the applications associated with a specific Amazon Web Services account. You can provide the unique…, Creates a new application with given parameters. Requires an existing runtime environment and application…, Starts a data set import task for a specific application., …) returned as clean JSON through one API key. Send your own provider key in the x-upstream-key header. Call it over REST at https://zieapi.vercel.app/v1/cloud:amazonaws-m2/{endpoint} or from Claude, ChatGPT and Cursor through the Apizie MCP server. Free plan: 1,000 requests a month.

- Project key: `cloud:amazonaws-m2`
- Category: Cloud
- Status: byok
- Source: https://github.com/mermade/aws2openapi
- Page: https://zieapi.vercel.app/api/cloud/amazonaws-m2
- OpenAPI: https://zieapi.vercel.app/api/cloud/amazonaws-m2/openapi.json

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…

## Endpoints

### Cancels the running of a specific batch job execution.
`POST https://zieapi.vercel.app/v1/cloud:amazonaws-m2/cancel-batch-job-execution` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| region | string | no | The AWS region |
| applicationId | string | yes | The unique identifier of the application. |
| executionId | string | yes | The unique identifier of the batch job execution. |

### Lists the applications associated with a specific Amazon Web Services account. You can provide the unique…
`GET https://zieapi.vercel.app/v1/cloud:amazonaws-m2/list-applications` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| region | string | no | The AWS region |
| environmentId | string | no | The unique identifier of the runtime environment where the applications are deployed. |
| maxResults | integer | no | The maximum number of applications to return. |
| names | array | no | The names of the applications. |
| nextToken | string | no | A pagination token to control the number of applications displayed in the list. |

### Creates a new application with given parameters. Requires an existing runtime environment and application…
`POST https://zieapi.vercel.app/v1/cloud:amazonaws-m2/create-application` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| region | string | no | The AWS region |
| body | object | yes | JSON request body |

### Starts a data set import task for a specific application.
`POST https://zieapi.vercel.app/v1/cloud:amazonaws-m2/create-data-set-import-task` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| region | string | no | The AWS region |
| applicationId | string | yes | The unique identifier of the application for which you want to import data sets. |
| body | object | yes | JSON request body |

### Returns a list of all deployments of a specific application. A deployment is a combination of a specific…
`GET https://zieapi.vercel.app/v1/cloud:amazonaws-m2/list-deployments` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| region | string | no | The AWS region |
| applicationId | string | yes | The application identifier. |
| maxResults | integer | no | The maximum number of objects to return. |
| nextToken | string | no | A pagination token returned from a previous call to this operation. This specifies the next item to return. To return to the beginning of… |

### Creates and starts a deployment to deploy an application into a runtime environment.
`POST https://zieapi.vercel.app/v1/cloud:amazonaws-m2/create-deployment` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| region | string | no | The AWS region |
| applicationId | string | yes | The application identifier. |
| body | object | yes | JSON request body |

### Lists the runtime environments.
`GET https://zieapi.vercel.app/v1/cloud:amazonaws-m2/list-environments` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| region | string | no | The AWS region |
| engineType | string | no | The engine type for the runtime environment. |
| maxResults | integer | no | The maximum number of runtime environments to return. |
| names | array | no | The names of the runtime environments. Must be unique within the account. |
| nextToken | string | no | A pagination token to control the number of runtime environments displayed in the list. |

### Creates a runtime environment for a given runtime engine.
`POST https://zieapi.vercel.app/v1/cloud:amazonaws-m2/create-environment` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| region | string | no | The AWS region |
| body | object | yes | JSON request body |

### Describes the details of a specific application.
`GET https://zieapi.vercel.app/v1/cloud:amazonaws-m2/get-application` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| region | string | no | The AWS region |
| applicationId | string | yes | The identifier of the application. |

### Updates an application and creates a new version.
`POST https://zieapi.vercel.app/v1/cloud:amazonaws-m2/update-application` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| region | string | no | The AWS region |
| applicationId | string | yes | The unique identifier of the application you want to update. |
| body | object | yes | JSON request body |

### Deletes a specific application. You cannot delete a running application.
`POST https://zieapi.vercel.app/v1/cloud:amazonaws-m2/delete-application` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| region | string | no | The AWS region |
| applicationId | string | yes | The unique identifier of the application you want to delete. |

### Deletes a specific application from the specific runtime environment where it was previously deployed. You…
`POST https://zieapi.vercel.app/v1/cloud:amazonaws-m2/delete-application-from-environment` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| region | string | no | The AWS region |
| applicationId | string | yes | The unique identifier of the application you want to delete. |
| environmentId | string | yes | The unique identifier of the runtime environment where the application was previously deployed. |

### Describes a specific runtime environment.
`GET https://zieapi.vercel.app/v1/cloud:amazonaws-m2/get-environment` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| region | string | no | The AWS region |
| environmentId | string | yes | The unique identifier of the runtime environment. |

### Updates the configuration details for a specific runtime environment.
`POST https://zieapi.vercel.app/v1/cloud:amazonaws-m2/update-environment` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| region | string | no | The AWS region |
| environmentId | string | yes | The unique identifier of the runtime environment that you want to update. |
| body | object | yes | JSON request body |

### Deletes a specific runtime environment. The environment cannot contain deployed applications. If it does,…
`POST https://zieapi.vercel.app/v1/cloud:amazonaws-m2/delete-environment` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| region | string | no | The AWS region |
| environmentId | string | yes | The unique identifier of the runtime environment you want to delete. |

### Returns details about a specific version of a specific application.
`GET https://zieapi.vercel.app/v1/cloud:amazonaws-m2/get-application-version` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| region | string | no | The AWS region |
| applicationId | string | yes | The unique identifier of the application. |
| applicationVersion | integer | yes | The specific version of the application. |

### Gets the details of a specific batch job execution for a specific application.
`GET https://zieapi.vercel.app/v1/cloud:amazonaws-m2/get-batch-job-execution` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| region | string | no | The AWS region |
| applicationId | string | yes | The identifier of the application. |
| executionId | string | yes | The unique identifier of the batch job execution. |

### Gets the details of a specific data set.
`GET https://zieapi.vercel.app/v1/cloud:amazonaws-m2/get-data-set-details` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| region | string | no | The AWS region |
| applicationId | string | yes | The unique identifier of the application that this data set is associated with. |
| dataSetName | string | yes | The name of the data set. |

### Gets the status of a data set import task initiated with the CreateDataSetImportTask operation.
`GET https://zieapi.vercel.app/v1/cloud:amazonaws-m2/get-data-set-import-task` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| region | string | no | The AWS region |
| applicationId | string | yes | The application identifier. |
| taskId | string | yes | The task identifier returned by the CreateDataSetImportTask operation. |

### Gets details of a specific deployment with a given deployment identifier.
`GET https://zieapi.vercel.app/v1/cloud:amazonaws-m2/get-deployment` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| region | string | no | The AWS region |
| applicationId | string | yes | The unique identifier of the application. |
| deploymentId | string | yes | The unique identifier for the deployment. |

### Gets a single sign-on URL that can be used to connect to AWS Blu Insights.
`GET https://zieapi.vercel.app/v1/cloud:amazonaws-m2/get-signed-bluinsights-url` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| region | string | no | The AWS region |

### Returns a list of the application versions for a specific application.
`GET https://zieapi.vercel.app/v1/cloud:amazonaws-m2/list-application-versions` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| region | string | no | The AWS region |
| applicationId | string | yes | The unique identifier of the application. |
| maxResults | integer | no | The maximum number of application versions to return. |
| nextToken | string | no | A pagination token returned from a previous call to this operation. This specifies the next item to return. To return to the beginning of… |

### Lists all the available batch job definitions based on the batch job resources uploaded during the…
`GET https://zieapi.vercel.app/v1/cloud:amazonaws-m2/list-batch-job-definitions` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| region | string | no | The AWS region |
| applicationId | string | yes | The identifier of the application. |
| maxResults | integer | no | The maximum number of batch job definitions to return. |
| nextToken | string | no | A pagination token returned from a previous call to this operation. This specifies the next item to return. To return to the beginning of… |
| prefix | string | no | If the batch job definition is a FileBatchJobDefinition, the prefix allows you to search on the file names of FileBatchJobDefinitions. |

### Lists historical, current, and scheduled batch job executions for a specific application.
`GET https://zieapi.vercel.app/v1/cloud:amazonaws-m2/list-batch-job-executions` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| region | string | no | The AWS region |
| applicationId | string | yes | The unique identifier of the application. |
| executionIds | array | no | The unique identifier of each batch job execution. |
| jobName | string | no | The name of each batch job execution. |
| maxResults | integer | no | The maximum number of batch job executions to return. |
| nextToken | string | no | A pagination token to control the number of batch job executions displayed in the list. |
| startedAfter | string | no | The time after which the batch job executions started. |
| startedBefore | string | no | The time before the batch job executions started. |
| status | string | no | The status of the batch job executions. |

### Lists the data set imports for the specified application.
`GET https://zieapi.vercel.app/v1/cloud:amazonaws-m2/list-data-set-import-history` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| region | string | no | The AWS region |
| applicationId | string | yes | The unique identifier of the application. |
| maxResults | integer | no | The maximum number of objects to return. |
| nextToken | string | no | A pagination token returned from a previous call to this operation. This specifies the next item to return. To return to the beginning of… |

### Lists the data sets imported for a specific application. In Amazon Web Services Mainframe Modernization,…
`GET https://zieapi.vercel.app/v1/cloud:amazonaws-m2/list-data-sets` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| region | string | no | The AWS region |
| applicationId | string | yes | The unique identifier of the application for which you want to list the associated data sets. |
| maxResults | integer | no | The maximum number of objects to return. |
| nextToken | string | no | A pagination token returned from a previous call to this operation. This specifies the next item to return. To return to the beginning of… |
| prefix | string | no | The prefix of the data set name, which you can use to filter the list of data sets. |

### Lists the available engine versions.
`GET https://zieapi.vercel.app/v1/cloud:amazonaws-m2/list-engine-versions` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| region | string | no | The AWS region |
| engineType | string | no | The type of target platform. |
| maxResults | integer | no | The maximum number of objects to return. |
| nextToken | string | no | A pagination token returned from a previous call to this operation. This specifies the next item to return. To return to the beginning of… |

### Lists the tags for the specified resource.
`GET https://zieapi.vercel.app/v1/cloud:amazonaws-m2/list-tags-for-resource` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| region | string | no | The AWS region |
| resourceArn | string | yes | The Amazon Resource Name (ARN) of the resource. |

### Adds one or more tags to the specified resource.
`POST https://zieapi.vercel.app/v1/cloud:amazonaws-m2/tag-resource` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| region | string | no | The AWS region |
| resourceArn | string | yes | The Amazon Resource Name (ARN) of the resource. |
| body | object | yes | JSON request body |

### Starts an application that is currently stopped.
`POST https://zieapi.vercel.app/v1/cloud:amazonaws-m2/start-application` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| region | string | no | The AWS region |
| applicationId | string | yes | The unique identifier of the application you want to start. |

### Starts a batch job and returns the unique identifier of this execution of the batch job. The associated…
`POST https://zieapi.vercel.app/v1/cloud:amazonaws-m2/start-batch-job` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| region | string | no | The AWS region |
| applicationId | string | yes | The unique identifier of the application associated with this batch job. |
| body | object | yes | JSON request body |

### Stops a running application.
`POST https://zieapi.vercel.app/v1/cloud:amazonaws-m2/stop-application` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| region | string | no | The AWS region |
| applicationId | string | yes | The unique identifier of the application you want to stop. |
| body | object | yes | JSON request body |

### Removes one or more tags from the specified resource.
`POST https://zieapi.vercel.app/v1/cloud:amazonaws-m2/untag-resource` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| region | string | no | The AWS region |
| resourceArn | string | yes | The Amazon Resource Name (ARN) of the resource. |
| tagKeys | array | yes | The keys of the tags to remove. |

## Example
```
curl "https://zieapi.vercel.app/v1/cloud:amazonaws-m2/cancel-batch-job-execution" \
  -H "x-api-key: $APIZIE_KEY" \
  -H "x-upstream-key: $PROVIDER_KEY"
```

## FAQ

### How do I call the AWSMainframeModernization API?
Create a free Apizie key, then send POST https://zieapi.vercel.app/v1/cloud:amazonaws-m2/cancel-batch-job-execution with the header x-api-key. Every endpoint returns { project, data, timestamp }.

### Is the AWSMainframeModernization API free on Apizie?
Yes. The Free plan includes 1,000 requests a month at 100 requests a minute, no credit card. AWSMainframeModernization itself also needs your own key from amazonaws.com.

### Can AI agents use the AWSMainframeModernization API?
Yes. Add the Apizie MCP server (https://zieapi.vercel.app/mcp) to Claude, ChatGPT, Cursor or VS Code, then ask in plain language. The agent calls run_scraper with project key cloud:amazonaws-m2.

### What is the status of the AWSMainframeModernization API?
Needs your own provider key (bring your own key)