How AI is applied across API Evangelist and APIs.io. Read my AI disclosure →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

Amazon Mainframe Modernization Applications API

The Applications API from Amazon Mainframe Modernization — 19 operation(s) for applications.

Amazon Mainframe Modernization Applications API is one of 5 APIs that Amazon Mainframe Modernization publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

This API exposes 2 JSON Schema definitions.

Tagged areas include Application. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, a getting-started guide, pricing, a JSON-LD context, and 2 JSON Schemas.

This API exposes 23 operations across 19 paths, and defines 102 schemas. It is described by OpenAPI 3.2.0, at version 1.0.0.

Requests are made against 4 base URLs: http://m2.{region}.amazonaws.com, https://m2.{region}.amazonaws.com, http://m2.{region}.amazonaws.com.cn, https://m2.{region}.amazonaws.com.cn.

23 operations 19 paths 102 schemas 2 DELETE13 GET1 PATCH7 POST

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.2.0
API Version
1.0.0
Base URL
https://m2.amazonaws.com
Authentication
API Key
Terms of Service
Resource Areas
1

Authentication & Security 1

Amazon Mainframe Modernization Applications API declares 1 security scheme for authenticating requests. An API key is passed in the header as Authorization (hmac). By default, every request must be authenticated.

  • hmac — Amazon Signature authorization v4

Paths & Operations 23

Across 19 paths, the API surfaces 23 operations — 2 DELETE, 13 GET, 1 PATCH, 7 POST. Each is listed below with its method, path, parameters, and response codes.

Applications 23
POST
/applications/{applicationId}/batch-job-executions/{executionId}/cancel
Amazon Mainframe Modernization Cancel Batch Job Execution
CancelBatchJobExecution 9 params → 200480481482483484485
POST
/applications
Amazon Mainframe Modernization Create Application
CreateApplication 7 params body → 200480481482483484485
GET
/applications
Amazon Mainframe Modernization List Applications
ListApplications 11 params → 200480481482483
POST
/applications/{applicationId}/dataset-import-task
Amazon Mainframe Modernization Create Data Set Import Task
CreateDataSetImportTask 8 params body → 200480481482483484485486
POST
/applications/{applicationId}/deployments
Amazon Mainframe Modernization Create Deployment
CreateDeployment 8 params body → 200480481482483484485486
GET
/applications/{applicationId}/deployments
Amazon Mainframe Modernization List Deployments
ListDeployments 10 params → 200480481482483484
DELETE
/applications/{applicationId}
Amazon Mainframe Modernization Delete Application
DeleteApplication 8 params → 200480481482483484
GET
/applications/{applicationId}
Amazon Mainframe Modernization Get Application
GetApplication 8 params → 200480481482483484
PATCH
/applications/{applicationId}
Amazon Mainframe Modernization Update Application
UpdateApplication 8 params body → 200480481482483484485
DELETE
/applications/{applicationId}/environment/{environmentId}
Amazon Mainframe Modernization Delete Application from Environment
DeleteApplicationFromEnvironment 9 params → 200480481482483484485
GET
/applications/{applicationId}/versions/{applicationVersion}
Amazon Mainframe Modernization Get Application Version
GetApplicationVersion 9 params → 200480481482483484
GET
/applications/{applicationId}/batch-job-executions/{executionId}
Amazon Mainframe Modernization Get Batch Job Execution
GetBatchJobExecution 9 params → 200480481482483484
GET
/applications/{applicationId}/datasets/{dataSetName}
Amazon Mainframe Modernization Get Data Set Details
GetDataSetDetails 9 params → 200480481482483484
GET
/applications/{applicationId}/dataset-import-tasks/{taskId}
Amazon Mainframe Modernization Get Data Set Import Task
GetDataSetImportTask 9 params → 200480481482483484
GET
/applications/{applicationId}/deployments/{deploymentId}
Amazon Mainframe Modernization Get Deployment
GetDeployment 9 params → 200480481482483484
GET
/applications/{applicationId}/versions
Amazon Mainframe Modernization List Application Versions
ListApplicationVersions 10 params → 200480481482483484
GET
/applications/{applicationId}/batch-job-definitions
Amazon Mainframe Modernization List Batch Job Definitions
ListBatchJobDefinitions 11 params → 200480481482483484
GET
/applications/{applicationId}/batch-job-executions
Amazon Mainframe Modernization List Batch Job Executions
ListBatchJobExecutions 15 params → 200480481482483484
GET
/applications/{applicationId}/dataset-import-tasks
Amazon Mainframe Modernization List Data Set Import History
ListDataSetImportHistory 10 params → 200480481482483484
GET
/applications/{applicationId}/datasets
Amazon Mainframe Modernization List Data Sets
ListDataSets 11 params → 200480481482483484
POST
/applications/{applicationId}/start
Amazon Mainframe Modernization Start Application
StartApplication 8 params → 200480481482483484485
POST
/applications/{applicationId}/batch-job
Amazon Mainframe Modernization Start Batch Job
StartBatchJob 8 params body → 200480481482483484485
POST
/applications/{applicationId}/stop
Amazon Mainframe Modernization Stop Application
StopApplication 8 params body → 200480481482483484485

Schemas 102

The contract defines 102 schemas that model the data the API accepts and returns. The most detailed are GetApplicationResponse (20 properties), ApplicationSummary (13 properties), GetBatchJobExecutionResponse (12 properties), BatchJobExecutionSummary (10 properties). Each schema is shown below with its type and property counts.

ListBatchJobExecutionsResponse
object
2 properties 1 required
ApplicationVersionSummaryList
array
BatchJobExecutionStatus
string
DataSetSummary
object
A subset of the possible data set attributes.
6 properties 1 required
ExternalLocation
object
Defines an external storage location.
1 property
BatchJobIdentifier
object
Identifies a specific batch job.
2 properties
ApplicationLifecycle
string
PsDetailAttributes
object
The supported properties for a PS type data set.
2 properties 2 required
StringFree65000
string
ListDataSetsResponse
object
2 properties 1 required
ScriptBatchJobDefinition
object
A batch job definition contained in a script.
1 property 1 required
String20
string
DataSet
object
Defines a data set.
5 properties 3 required
BatchJobDefinitions
array
DeleteApplicationFromEnvironmentResponse
object
DeploymentSummary
object
A subset of information about a specific deployment.
7 properties 6 required
String2000
string
CreateDataSetImportTaskResponse
object
1 property 1 required
DataSetImportTask
object
Contains information about a data set import task.
3 properties 3 required
NextToken
string
ListApplicationVersionsResponse
object
2 properties 1 required
GetDataSetDetailsResponse
object
8 properties 1 required
GetBatchJobExecutionResponse
object
12 properties 4 required
RecordLength
object
The length of the records in the data set.
2 properties 2 required
StartApplicationResponse
object
EntityDescription
string
DataSetImportSummary
object
Represents a summary of data set imports.
5 properties 5 required
GetDataSetImportTaskResponse
object
3 properties 2 required
PortList
array
UpdateApplicationResponse
object
1 property 1 required
AccessDeniedException
ServiceQuotaExceededException
StartBatchJobResponse
object
1 property 1 required
ScriptBatchJobIdentifier
object
A batch job identifier in which the batch job to run is identified by the script name.
1 property 1 required
ApplicationDeploymentLifecycle
string
PoDetailAttributes
object
The supported properties for a PO type data set.
2 properties 2 required
String200
string
BatchJobExecutionSummaryList
array
GdgAttributes
object
The required attributes for a generation data group data set. A generation data set is one of a collection of successive, historically related, catalogued data…
2 properties
DatasetOrgAttributes
object
Additional details about the data set. Different attributes correspond to different data set organizations. The values are populated based on datasetOrg, stora…
4 properties
String
string
DeploymentLifecycle
string
DeleteApplicationResponse
object
DeployedVersionSummary
object
Contains a summary of a deployed application.
3 properties 2 required
Identifier
string
ApplicationVersionLifecycle
string
EngineType
string
DataSetsSummaryList
array
BatchJobExecutionSummary
object
A subset of the possible batch job attributes. Used in the batch job list.
10 properties 4 required
ListDataSetImportHistoryResponse
object
2 properties 1 required
LogGroupSummary
object
A subset of the attributes that describe a log group. In CloudWatch a log group is a group of log streams that share the same retention, monitoring, and access…
2 properties 2 required
LogGroupIdentifier
string
ResourceNotFoundException
VsamDetailAttributes
object
The attributes of a VSAM type data set.
6 properties
PoAttributes
object
The supported properties for a PO type data set.
3 properties 2 required
Version
integer
LogGroupSummaries
array
FileBatchJobDefinition
object
A file containing a batch job definition.
2 properties 1 required
DataSetImportList
array
DataSetImportItem
object
Identifies a specific data set to import from an external location.
2 properties 2 required
BatchJobDefinition
object
Defines the details of a batch job.
2 properties
Boolean
boolean
ApplicationVersionSummary
object
Defines an application version summary.
4 properties 3 required
ListBatchJobDefinitionsResponse
object
2 properties 1 required
InternalServerException
ConflictException
ValidationException
BatchParamValue
string
Parameter value can be of up to 44 alphanumeric characters.
FileBatchJobIdentifier
object
A batch job identifier in which the batch job to run is identified by the file name and the relative path to the file name.
2 properties 1 required
TagValue
string
PrimaryKey
object
The primary key for a KSDS data set.
3 properties 2 required
ArnList
array
ApplicationSummaryList
array
Arn
string
CreateApplicationResponse
object
3 properties 3 required
TagMap
object
DatasetDetailOrgAttributes
object
Additional details about the data set. Different attributes correspond to different data set organizations. The values are populated based on datasetOrg, stora…
4 properties
GdgDetailAttributes
object
The required attributes for a generation data group data set. A generation data set is one of a collection of successive, historically related, catalogued data…
2 properties
String20List
array
CreateDeploymentResponse
object
1 property 1 required
GetDeploymentResponse
object
7 properties 6 required
ThrottlingException
StopApplicationResponse
object
BatchJobType
string
Integer
integer
String50
string
CancelBatchJobExecutionResponse
object
EntityName
string
DataSetImportTaskList
array
DataSetTaskLifecycle
string
GetApplicationVersionResponse
object
7 properties 5 required
ListApplicationsResponse
object
2 properties 1 required
GetApplicationResponse
object
20 properties 7 required
ListDeploymentsResponse
object
2 properties 1 required
AlternateKey
object
Defines an alternate key. This value is optional. A legacy data set might not have any alternate key defined but if those alternate keys definitions exist, pro…
4 properties 2 required
DeploymentList
array
ApplicationSummary
object
A subset of the possible application attributes. Used in the application list.
13 properties 7 required
Timestamp
string
String100
string
VsamAttributes
object
The attributes of a VSAM type data set.
5 properties 1 required
PsAttributes
object
The supported properties for a PS type data set.
2 properties 1 required
AlternateKeyList
array

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

amazon-mainframe-modernization-applications-api-openapi.yml Raw ↑

Other APIs Amazon Mainframe Modernization publishes across the network.

Amazon Mainframe Modernization Engine Versions API
Amazon Mainframe Modernization Environments API
Amazon Mainframe Modernization Signed Bi Url API
Amazon Mainframe Modernization Tags API
Where this information came from

This is an independent, third-party profile of Amazon Mainframe Modernization Applications API, published by API Evangelist. We do not operate, host, resell, or support these APIs, and we are not affiliated with or endorsed by the company unless stated above. Everything here is built from publicly available information — the company's own site, developer portal, documentation, public repositories, and the specifications it publishes for public use. Nothing is obtained by breaching a system, defeating an access control, or using credentials.

The Kin Score and Agent Readiness rating are independently calculated assessments of a company's public API artifacts, scored against a published rubric. They are not certifications, endorsements, security assessments, or audits.

Corrections, re-scores, and removal are free — no partnership or purchase required, and you do not need to justify the request. A removed company is recorded as unrated, never scored zero for having asked. Acknowledgement within one business day; removal within two.

info@apievangelist.com · Read the full data-sourcing policy →
On a security or compliance team? Put security in the subject line and you will get a person, not a form — we will tell you exactly which public URLs this profile was built from.