Amazon Mainframe Modernization Mainframe Modernization Operations API

openapi: 3.2.0
info:
  title: AWSMainframeModernization Operations API
  version: '2021-04-28'
  description: Generated from AWS's published Smithy model for AWSMainframeModernization. 4 operation(s).
  contact:
    name: Amazon Web Services
    url: https://aws.amazon.com/contact-us/
  license:
    name: Apache 2.0
    identifier: Apache-2.0
    url: https://github.com/aws/api-models-aws/blob/main/LICENSE
servers:
- url: https://m2.{region}.amazonaws.com
  variables:
    region:
      default: us-east-1
security:
- sigv4: []
tags:
- name: Operations
paths:
  /applications/{applicationId}/dataset-export-task:
    post:
      operationId: CreateDataSetExportTask
      summary: Create Data Set Export Task
      description: Starts a data set export task for a specific application.
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CreateDataSetExportTaskResponse'
        '403':
          description: AccessDeniedException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AccessDeniedException'
        '409':
          description: ConflictException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ConflictException'
        '500':
          description: InternalServerException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/InternalServerException'
        '404':
          description: ResourceNotFoundException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ResourceNotFoundException'
        '402':
          description: ServiceQuotaExceededException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ServiceQuotaExceededException'
        '429':
          description: ThrottlingException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ThrottlingException'
        '400':
          description: ValidationException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ValidationException'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/CreateDataSetExportTaskRequest'
      tags:
      - Operations
  /applications/{applicationId}/dataset-export-tasks/{taskId}:
    get:
      operationId: GetDataSetExportTask
      summary: Get Data Set Export Task
      description: Gets the status of a data set import task initiated with the CreateDataSetExportTask operation.
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GetDataSetExportTaskResponse'
        '403':
          description: AccessDeniedException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AccessDeniedException'
        '500':
          description: InternalServerException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/InternalServerException'
        '404':
          description: ResourceNotFoundException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ResourceNotFoundException'
        '429':
          description: ThrottlingException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ThrottlingException'
        '400':
          description: ValidationException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ValidationException'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/GetDataSetExportTaskRequest'
      tags:
      - Operations
  /applications/{applicationId}/dataset-export-tasks:
    get:
      operationId: ListDataSetExportHistory
      summary: List Data Set Export History
      description: Lists the data set exports for the specified application.
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ListDataSetExportHistoryResponse'
        '403':
          description: AccessDeniedException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AccessDeniedException'
        '500':
          description: InternalServerException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/InternalServerException'
        '404':
          description: ResourceNotFoundException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ResourceNotFoundException'
        '429':
          description: ThrottlingException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ThrottlingException'
        '400':
          description: ValidationException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ValidationException'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/ListDataSetExportHistoryRequest'
      tags:
      - Operations
  /applications/{applicationId}/batch-job-executions/{executionId}/steps:
    get:
      operationId: ListBatchJobRestartPoints
      summary: List Batch Job Restart Points
      description: 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.
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ListBatchJobRestartPointsResponse'
        '403':
          description: AccessDeniedException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AccessDeniedException'
        '409':
          description: ConflictException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ConflictException'
        '500':
          description: InternalServerException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/InternalServerException'
        '404':
          description: ResourceNotFoundException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ResourceNotFoundException'
        '429':
          description: ThrottlingException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ThrottlingException'
        '400':
          description: ValidationException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ValidationException'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/ListBatchJobRestartPointsRequest'
      tags:
      - Operations
components:
  schemas:
    ExternalLocation:
      type: object
      properties:
        s3Location:
          type: string
          description: The URI of the Amazon S3 bucket.
      description: Exactly one member is set.
    ConflictException:
      type: object
      properties:
        message:
          type: string
        resourceId:
          type: string
          description: The ID of the conflicting resource.
        resourceType:
          type: string
          description: The type of the conflicting resource.
      required:
      - message
    ListBatchJobRestartPointsRequest:
      type: object
      properties:
        applicationId:
          type: string
          description: The unique identifier of the application.
        executionId:
          type: string
          description: The unique identifier of the batch job execution.
        authSecretsManagerArn:
          type: string
          description: The Amazon Web Services Secrets Manager containing user's credentials for authentication and authorization for List Batch Job Restart Points operation.
      required:
      - applicationId
      - executionId
    DataSetExportTask:
      type: object
      properties:
        taskId:
          type: string
          description: The identifier of the data set export task.
        status:
          type: string
          description: The status of the data set export task.
        summary:
          $ref: '#/components/schemas/DataSetExportSummary'
        statusReason:
          type: string
          description: If dataset exports failed, the failure reason will show here.
      required:
      - taskId
      - status
      - summary
    ValidationException:
      type: object
      properties:
        message:
          type: string
        reason:
          type: string
          description: The reason why it failed service validation.
        fieldList:
          type: array
          items:
            $ref: '#/components/schemas/ValidationExceptionField'
          description: The list of fields that failed service validation.
      required:
      - message
    DataSetExportConfig:
      type: object
      properties:
        s3Location:
          type: string
          description: The Amazon S3 location of the data sets.
        dataSets:
          type: array
          items:
            $ref: '#/components/schemas/DataSetExportItem'
          description: The data sets.
      description: Exactly one member is set.
    ListBatchJobRestartPointsResponse:
      type: object
      properties:
        batchJobSteps:
          type: array
          items:
            $ref: '#/components/schemas/JobStep'
          description: Returns all the batch job steps and related information for a batch job that previously ran.
    AccessDeniedException:
      type: object
      properties:
        message:
          type: string
      required:
      - message
    DataSetExportSummary:
      type: object
      properties:
        total:
          type: integer
          description: The total number of data set exports.
        succeeded:
          type: integer
          description: The number of data set exports that have succeeded.
        failed:
          type: integer
          description: The number of data set exports that have failed.
        pending:
          type: integer
          description: The number of data set exports that are pending.
        inProgress:
          type: integer
          description: The number of data set exports that are in progress.
      required:
      - total
      - succeeded
      - failed
      - pending
      - inProgress
    CreateDataSetExportTaskResponse:
      type: object
      properties:
        taskId:
          type: string
          description: The task identifier. This operation is asynchronous. Use this identifier with the GetDataSetExportTask operation to obtain the status of this task.
      required:
      - taskId
    ListDataSetExportHistoryRequest:
      type: object
      properties:
        nextToken:
          type: string
          description: A pagination token returned from a previous call to this operation. This specifies the next item to return. To return to the beginning of the list, exclude this parameter.
        maxResults:
          type: integer
          description: The maximum number of objects to return.
        applicationId:
          type: string
          description: The unique identifier of the application.
      required:
      - applicationId
    DataSetExportItem:
      type: object
      properties:
        datasetName:
          type: string
          description: The data set.
        externalLocation:
          $ref: '#/components/schemas/ExternalLocation'
      required:
      - datasetName
      - externalLocation
    InternalServerException:
      type: object
      properties:
        message:
          type: string
        retryAfterSeconds:
          type: integer
          description: The number of seconds to wait before retrying the request.
      required:
      - message
    JobStep:
      type: object
      properties:
        stepNumber:
          type: integer
          description: The number of a step.
        stepName:
          type: string
          description: The name of a step.
        procStepNumber:
          type: integer
          description: The number of a procedure step.
        procStepName:
          type: string
          description: The name of a procedure step.
        stepCondCode:
          type: string
          description: The condition code of a step.
        stepRestartable:
          type: boolean
          description: Specifies if a step can be restarted or not.
        stepCheckpoint:
          type: integer
          description: A registered step-level checkpoint identifier that can be used for restarting an Amazon Web Services Blu Age application batch job.
        stepCheckpointStatus:
          type: string
          description: The step-level checkpoint status for an Amazon Web Services Blu Age application batch job.
        stepCheckpointTime:
          type: string
          format: date-time
          description: The step-level checkpoint status for an Amazon Web Services Blu Age application batch job.
    ServiceQuotaExceededException:
      type: object
      properties:
        message:
          type: string
        resourceId:
          type: string
          description: The ID of the resource that is exceeding the quota limit.
        resourceType:
          type: string
          description: The type of resource that is exceeding the quota limit for Amazon Web Services Mainframe Modernization.
        serviceCode:
          type: string
          description: A code that identifies the service that the exceeded quota belongs to.
        quotaCode:
          type: string
          description: The identifier of the exceeded quota.
      required:
      - message
    GetDataSetExportTaskResponse:
      type: object
      properties:
        taskId:
          type: string
          description: The task identifier.
        status:
          type: string
          description: The status of the task.
        summary:
          $ref: '#/components/schemas/DataSetExportSummary'
        statusReason:
          type: string
          description: If dataset export failed, the failure reason will show here.
        kmsKeyArn:
          type: string
          description: The identifier of a customer managed key used for exported data set encryption.
      required:
      - taskId
      - status
    CreateDataSetExportTaskRequest:
      type: object
      properties:
        applicationId:
          type: string
          description: The unique identifier of the application for which you want to export data sets.
        exportConfig:
          $ref: '#/components/schemas/DataSetExportConfig'
        clientToken:
          type: string
          description: Unique, case-sensitive identifier you provide to ensure the idempotency of the request to create a data set export. The service generates the clientToken when the API call is triggered. The token expires after one hour, so if you retry the API within this timeframe with the same clientToken, you will get the same response. The service also handles deleting the clientToken after it expires.
        kmsKeyId:
          type: string
          description: The identifier of a customer managed key.
      required:
      - applicationId
      - exportConfig
    GetDataSetExportTaskRequest:
      type: object
      properties:
        applicationId:
          type: string
          description: The application identifier.
        taskId:
          type: string
          description: The task identifier returned by the CreateDataSetExportTask operation.
      required:
      - applicationId
      - taskId
    ThrottlingException:
      type: object
      properties:
        message:
          type: string
        serviceCode:
          type: string
          description: The identifier of the service that the throttled request was made to.
        quotaCode:
          type: string
          description: The identifier of the throttled request.
        retryAfterSeconds:
          type: integer
          description: The number of seconds to wait before retrying the request.
      required:
      - message
    ResourceNotFoundException:
      type: object
      properties:
        message:
          type: string
        resourceId:
          type: string
          description: The ID of the missing resource.
        resourceType:
          type: string
          description: The type of the missing resource.
      required:
      - message
    ListDataSetExportHistoryResponse:
      type: object
      properties:
        dataSetExportTasks:
          type: array
          items:
            $ref: '#/components/schemas/DataSetExportTask'
          description: The data set export tasks.
        nextToken:
          type: string
          description: If there are more items to return, this contains a token that is passed to a subsequent call to this operation to retrieve the next set of items.
      required:
      - dataSetExportTasks
    ValidationExceptionField:
      type: object
      properties:
        name:
          type: string
          description: The name of the exception field.
        message:
          type: string
          description: The message of the exception field.
      required:
      - name
      - message
  securitySchemes:
    sigv4:
      type: apiKey
      in: header
      name: Authorization
      description: AWS Signature Version 4. The Authorization header carries an AWS4-HMAC-SHA256 signature over the canonical request, with X-Amz-Date (and X-Amz-Security-Token for temporary credentials). Not a bearer token.
      x-aws-sigv4:
        signingName: m2
x-provenance:
  method: harvested
  publisher: Amazon Web Services
  source: https://raw.githubusercontent.com/aws/api-models-aws/582e55931c45b944739742a2c1620b6026dd2d13/models/m2/service/2021-04-28/m2-2021-04-28.json
  note: converted by smithy-to-openapi.py from AWS's Smithy model (roadmap#1001)