Amazon Application Migration Service Jobs API

Migration and conversion jobs

GitHub OpenAPI

Operations 6

POST /DescribeJobLogItems Describe Job Log Items #
POST /DescribeJobs Describe Jobs #
POST /FinalizeCutover Finalize Cutover #
POST /StartCutover Start Cutover #
POST /StartTest Start Test #
POST /TerminateTargetInstances Terminate Target Instances #

Specifications

Examples

Schemas & Data

Other Resources

Work with this as data

Every API here is available over the APIs.io API and to AI agents over MCP.

MCP server

One button, every client — Claude, Cursor, VS Code and the rest.

https://apis.io/mcp

Tools for apis

7 MCP tools reach this
  • find_apisBrowse and filter every API in the catalog.
  • get_api_artifactsOne API's artifacts, grouped by type.
  • get_openapiThe primary OpenAPI for this API.
  • find_similar_apisAPIs that look like this one.
  • apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.
  • resolveTurn a domain, URL or GitHub org into the provider it belongs to.
  • find_cohortsEvery scored population of providers in the catalog.
All 92 tools →

Call it yourself

curl for this page
This API
curl "https://apis.io/api/v1/apis/amazon-application-migration-service:amazon-application-migration-service-jobs-api"
All apis
curl "https://apis.io/api/v1/apis?limit=25"

Calls without X-API-Key need no key. Calls with it need a paid plan — get a key.

Get an API key

Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. See our Privacy Policy and Terms.

A second provider on the same verified email joins the account you already have.

OpenAPI Specification

amazon-application-migration-service-jobs-api-openapi.yml Raw ↑
openapi: 3.1.0
info:
  title: Application Migration Service Jobs API
  version: '2020-02-26'
  description: Generated from AWS's published Smithy model for Application Migration Service. 6 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://mgn.{region}.amazonaws.com
  variables:
    region:
      default: us-east-1
security:
- sigv4: []
paths:
  /DescribeJobLogItems:
    post:
      operationId: DescribeJobLogItems
      summary: Describe Job Log Items
      description: Retrieves detailed job log items with paging.
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/DescribeJobLogItemsResponse'
        '400':
          description: UninitializedAccountException; ValidationException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/UninitializedAccountException'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/DescribeJobLogItemsRequest'
      tags:
      - Jobs
  /DescribeJobs:
    post:
      operationId: DescribeJobs
      summary: Describe Jobs
      description: Returns a list of Jobs. Use the jobIDs and fromDate and toDate filters to limit which jobs are returned.
        The response is sorted by creationDateTime - latest date first. Jobs are normally created by the StartTest, StartCutover,
        and TerminateTargetInstances APIs. Jobs are also created by DiagnosticLaunch and TerminateDiagnosticInstances, which
        are APIs available only to *Support* and only used in response to relevant support tickets.
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/DescribeJobsResponse'
        '400':
          description: UninitializedAccountException; ValidationException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/UninitializedAccountException'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/DescribeJobsRequest'
      tags:
      - Jobs
  /FinalizeCutover:
    post:
      operationId: FinalizeCutover
      summary: Finalize Cutover
      description: 'Finalizes the cutover immediately for specific Source Servers. All AWS resources created by Application
        Migration Service for enabling the replication of these source servers will be terminated / deleted within 90 minutes.
        Launched Test or Cutover instances will NOT be terminated. The AWS Replication Agent will receive a command to uninstall
        itself (within 10 minutes). The following properties of the SourceServer will be changed immediately: dataReplicationInfo.dataReplicationState
        will be changed to DISCONNECTED; The SourceServer.lifeCycle.state will be changed to CUTOVER; The totalStorageBytes
        property for each of dataReplicationInfo.replicatedDisks will be set to zero; dataReplicationInfo.lagDuration and
        dataReplicationInfo.etaDateTime will be nullified.'
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SourceServer'
        '409':
          description: ConflictException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ConflictException'
        '404':
          description: ResourceNotFoundException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ResourceNotFoundException'
        '400':
          description: UninitializedAccountException; ValidationException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/UninitializedAccountException'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/FinalizeCutoverRequest'
      tags:
      - Jobs
  /StartCutover:
    post:
      operationId: StartCutover
      summary: Start Cutover
      description: Launches a Cutover Instance for specific Source Servers. This command starts a LAUNCH job whose initiatedBy
        property is StartCutover and changes the SourceServer.lifeCycle.state property to CUTTING_OVER.
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/StartCutoverResponse'
        '409':
          description: ConflictException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ConflictException'
        '400':
          description: UninitializedAccountException; ValidationException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/UninitializedAccountException'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/StartCutoverRequest'
      tags:
      - Jobs
  /StartTest:
    post:
      operationId: StartTest
      summary: Start Test
      description: Launches a Test Instance for specific Source Servers. This command starts a LAUNCH job whose initiatedBy
        property is StartTest and changes the SourceServer.lifeCycle.state property to TESTING.
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/StartTestResponse'
        '409':
          description: ConflictException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ConflictException'
        '400':
          description: UninitializedAccountException; ValidationException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/UninitializedAccountException'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/StartTestRequest'
      tags:
      - Jobs
  /TerminateTargetInstances:
    post:
      operationId: TerminateTargetInstances
      summary: Terminate Target Instances
      description: Starts a job that terminates specific launched EC2 Test and Cutover instances. This command will not work
        for any Source Server with a lifecycle.state of TESTING, CUTTING_OVER, or CUTOVER.
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/TerminateTargetInstancesResponse'
        '409':
          description: ConflictException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ConflictException'
        '400':
          description: UninitializedAccountException; ValidationException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/UninitializedAccountException'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/TerminateTargetInstancesRequest'
      tags:
      - Jobs
components:
  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: mgn
  schemas:
    CPU:
      type: object
      properties:
        cores:
          type: integer
          description: The number of CPU cores on the source server.
        modelName:
          type: string
          description: The source server's CPU model name.
    ConflictException:
      type: object
      properties:
        message:
          type: string
        code:
          type: string
        resourceId:
          type: string
          description: A conflict occurred when prompting for the Resource ID.
        resourceType:
          type: string
          description: A conflict occurred when prompting for resource type.
        errors:
          type: array
          items:
            $ref: '#/components/schemas/ErrorDetails'
          description: Conflict Exception specific errors.
    DataReplicationError:
      type: object
      properties:
        error:
          type: string
          description: Error in data replication.
        rawError:
          type: string
          description: Error in data replication.
    DataReplicationInfo:
      type: object
      properties:
        lagDuration:
          type: string
          description: Request to query data replication lag duration.
        etaDateTime:
          type: string
          description: Request to query the time when data replication will be complete.
        replicatedDisks:
          type: array
          items:
            $ref: '#/components/schemas/DataReplicationInfoReplicatedDisk'
          description: Request to query disks replicated.
        dataReplicationState:
          type: string
          description: Request to query the data replication state.
        dataReplicationInitiation:
          $ref: '#/components/schemas/DataReplicationInitiation'
        dataReplicationError:
          $ref: '#/components/schemas/DataReplicationError'
        lastSnapshotDateTime:
          type: string
          description: Request to query data replication last snapshot time.
        replicatorId:
          type: string
          description: Replication server instance ID.
    DataReplicationInfoReplicatedDisk:
      type: object
      properties:
        deviceName:
          type: string
          description: Request to query device name.
        totalStorageBytes:
          type: integer
          description: Request to query total amount of data replicated in bytes.
        replicatedStorageBytes:
          type: integer
          description: Request to query amount of data replicated in bytes.
        rescannedStorageBytes:
          type: integer
          description: Request to query amount of data rescanned in bytes.
        backloggedStorageBytes:
          type: integer
          description: Request to query data replication backlog size in bytes.
    DataReplicationInitiation:
      type: object
      properties:
        startDateTime:
          type: string
          description: Request to query data initiation start date and time.
        nextAttemptDateTime:
          type: string
          description: Request to query next data initiation date and time.
        steps:
          type: array
          items:
            $ref: '#/components/schemas/DataReplicationInitiationStep'
          description: Request to query data initiation steps.
    DataReplicationInitiationStep:
      type: object
      properties:
        name:
          type: string
          description: Request to query data initiation step name.
        status:
          type: string
          description: Request to query data initiation status.
    DescribeJobLogItemsRequest:
      type: object
      properties:
        jobID:
          type: string
          description: Request to describe Job log job ID.
        maxResults:
          type: integer
          description: Request to describe Job log item maximum results.
        nextToken:
          type: string
          description: Request to describe Job log next token.
        accountID:
          type: string
          description: Request to describe Job log Account ID.
      required:
      - jobID
    DescribeJobLogItemsResponse:
      type: object
      properties:
        items:
          type: array
          items:
            $ref: '#/components/schemas/JobLog'
          description: Request to describe Job log response items.
        nextToken:
          type: string
          description: Request to describe Job log response next token.
    DescribeJobsRequest:
      type: object
      properties:
        filters:
          $ref: '#/components/schemas/DescribeJobsRequestFilters'
        maxResults:
          type: integer
          description: Request to describe job log items by max results.
        nextToken:
          type: string
          description: Request to describe job log items by next token.
        accountID:
          type: string
          description: Request to describe job log items by Account ID.
    DescribeJobsRequestFilters:
      type: object
      properties:
        jobIDs:
          type: array
          items:
            type: string
          description: Request to describe Job log filters by job ID.
        fromDate:
          type: string
          description: Request to describe Job log filters by date.
        toDate:
          type: string
          description: Request to describe job log items by last date.
    DescribeJobsResponse:
      type: object
      properties:
        items:
          type: array
          items:
            $ref: '#/components/schemas/Job'
          description: Request to describe Job log items.
        nextToken:
          type: string
          description: Request to describe Job response by next token.
    Disk:
      type: object
      properties:
        deviceName:
          type: string
          description: The disk or device name.
        bytes:
          type: integer
          description: The amount of storage on the disk in bytes.
    ErrorDetails:
      type: object
      properties:
        message:
          type: string
          description: Error details message.
        code:
          type: string
          description: Error details code.
        resourceId:
          type: string
          description: Error details resourceId.
        resourceType:
          type: string
          description: Error details resourceType.
    FinalizeCutoverRequest:
      type: object
      properties:
        sourceServerID:
          type: string
          description: Request to finalize Cutover by Source Server ID.
        accountID:
          type: string
          description: Request to finalize Cutover by Source Account ID.
      required:
      - sourceServerID
    IdentificationHints:
      type: object
      properties:
        fqdn:
          type: string
          description: FQDN address identification hint.
        hostname:
          type: string
          description: Hostname identification hint.
        vmWareUuid:
          type: string
          description: vmWare UUID identification hint.
        awsInstanceID:
          type: string
          description: AWS Instance ID identification hint.
        vmPath:
          type: string
          description: vCenter VM path identification hint.
    Job:
      type: object
      properties:
        jobID:
          type: string
          description: Job ID.
        arn:
          type: string
          description: the ARN of the specific Job.
        type:
          type: string
          description: Job type.
        initiatedBy:
          type: string
          description: Job initiated by field.
        creationDateTime:
          type: string
          description: Job creation time.
        endDateTime:
          type: string
          description: Job end time.
        status:
          type: string
          description: Job status.
        participatingServers:
          type: array
          items:
            $ref: '#/components/schemas/ParticipatingServer'
          description: Servers participating in a specific Job.
        tags:
          type: object
          additionalProperties:
            type: string
          description: Tags associated with specific Job.
      required:
      - jobID
    JobLog:
      type: object
      properties:
        logDateTime:
          type: string
          description: Job log event date and time.
        event:
          type: string
          description: Job log event.
        eventData:
          $ref: '#/components/schemas/JobLogEventData'
    JobLogEventData:
      type: object
      properties:
        sourceServerID:
          type: string
          description: Job Event Source Server ID.
        conversionServerID:
          type: string
          description: Job Event conversion Server ID.
        targetInstanceID:
          type: string
          description: Job Event Target instance ID.
        rawError:
          type: string
          description: Job error.
        attemptCount:
          type: integer
          description: Retries for this operation.
        maxAttemptsCount:
          type: integer
          description: The maximum number of retries that will be attempted if this operation failed.
    JobPostLaunchActionsLaunchStatus:
      type: object
      properties:
        ssmDocument:
          $ref: '#/components/schemas/SsmDocument'
        ssmDocumentType:
          type: string
          description: AWS Systems Manager Document type.
        executionID:
          type: string
          description: AWS Systems Manager Document's execution ID of the Job Post Launch Actions.
        executionStatus:
          type: string
          description: AWS Systems Manager Document's execution status.
        failureReason:
          type: string
          description: AWS Systems Manager Document's failure reason.
    LastKnownCheck:
      type: object
      properties:
        type:
          type: string
          description: Last known check type.
        name:
          type: string
          description: Last known check name.
        status:
          type: string
          description: Last known check status.
        error:
          type: string
          description: Last known check error.
        checkedAt:
          type: string
          description: Last known check timestamp.
    LaunchedInstance:
      type: object
      properties:
        ec2InstanceID:
          type: string
          description: Launched instance EC2 ID.
        jobID:
          type: string
          description: Launched instance Job ID.
        firstBoot:
          type: string
          description: Launched instance first boot.
        lastKnownChecks:
          type: array
          items:
            $ref: '#/components/schemas/LastKnownCheck'
          description: Launched instance last known checks.
        lastKnownFsxChecksStatus:
          type: string
          description: Launched instance last known FSx checks status.
    LifeCycle:
      type: object
      properties:
        addedToServiceDateTime:
          type: string
          description: Lifecycle added to service date and time.
        firstByteDateTime:
          type: string
          description: Lifecycle replication initiation date and time.
        elapsedReplicationDuration:
          type: string
          description: Lifecycle elapsed time and duration.
        lastSeenByServiceDateTime:
          type: string
          description: Lifecycle last seen date and time.
        lastTest:
          $ref: '#/components/schemas/LifeCycleLastTest'
        lastCutover:
          $ref: '#/components/schemas/LifeCycleLastCutover'
        state:
          type: string
          description: Lifecycle state.
    LifeCycleLastCutover:
      type: object
      properties:
        initiated:
          $ref: '#/components/schemas/LifeCycleLastCutoverInitiated'
        reverted:
          $ref: '#/components/schemas/LifeCycleLastCutoverReverted'
        finalized:
          $ref: '#/components/schemas/LifeCycleLastCutoverFinalized'
    LifeCycleLastCutoverFinalized:
      type: object
      properties:
        apiCallDateTime:
          type: string
          description: Lifecycle Cutover finalized date and time.
    LifeCycleLastCutoverInitiated:
      type: object
      properties:
        apiCallDateTime:
          type: string
        jobID:
          type: string
          description: Lifecycle last Cutover initiated by Job ID.
    LifeCycleLastCutoverReverted:
      type: object
      properties:
        apiCallDateTime:
          type: string
          description: Lifecycle last Cutover reverted API call date time.
    LifeCycleLastTest:
      type: object
      properties:
        initiated:
          $ref: '#/components/schemas/LifeCycleLastTestInitiated'
        reverted:
          $ref: '#/components/schemas/LifeCycleLastTestReverted'
        finalized:
          $ref: '#/components/schemas/LifeCycleLastTestFinalized'
    LifeCycleLastTestFinalized:
      type: object
      properties:
        apiCallDateTime:
          type: string
          description: Lifecycle Test finalized API call date and time.
    LifeCycleLastTestInitiated:
      type: object
      properties:
        apiCallDateTime:
          type: string
          description: Lifecycle last Test initiated API call date and time.
        jobID:
          type: string
          description: Lifecycle last Test initiated Job ID.
    LifeCycleLastTestReverted:
      type: object
      properties:
        apiCallDateTime:
          type: string
          description: Lifecycle last Test reverted API call date and time.
    NetworkInterface:
      type: object
      properties:
        macAddress:
          type: string
          description: Network interface Mac address.
        ips:
          type: array
          items:
            type: string
          description: Network interface IPs.
        isPrimary:
          type: boolean
          description: Network interface primary IP.
    OS:
      type: object
      properties:
        fullString:
          type: string
          description: OS full string.
    ParticipatingServer:
      type: object
      properties:
        sourceServerID:
          type: string
          description: Participating server Source Server ID.
        launchStatus:
          type: string
          description: Participating server launch status.
        launchedEc2InstanceID:
          type: string
          description: Participating server's launched ec2 instance ID.
        postLaunchActionsStatus:
          $ref: '#/components/schemas/PostLaunchActionsStatus'
      required:
      - sourceServerID
    PostLaunchActionsStatus:
      type: object
      properties:
        ssmAgentDiscoveryDatetime:
          type: string
          description: Time where the AWS Systems Manager was detected as running on the Test or Cutover instance.
        postLaunchActionsLaunchStatusList:
          type: array
          items:
            $ref: '#/components/schemas/JobPostLaunchActionsLaunchStatus'
          description: List of Post Launch Action status.
    ResourceNotFoundException:
      type: object
      properties:
        message:
          type: string
        code:
          type: string
        resourceId:
          type: string
          description: Resource ID not found error.
        resourceType:
          type: string
          description: Resource type not found error.
    SourceProperties:
      type: object
      properties:
        lastUpdatedDateTime:
          type: string
          description: Source server last update date and time.
        recommendedInstanceType:
          type: string
          description: Source server recommended instance type.
        identificationHints:
          $ref: '#/components/schemas/IdentificationHints'
        networkInterfaces:
          type: array
          items:
            $ref: '#/components/schemas/NetworkInterface'
          description: Source server network interfaces.
        disks:
          type: array
          items:
            $ref: '#/components/schemas/Disk'
          description: Source Server disks.
        cpus:
          type: array
          items:
            $ref: '#/components/schemas/CPU'
          description: Source Server CPUs.
        ramBytes:
          type: integer
          description: Source server RAM in bytes.
        os:
          $ref: '#/components/schemas/OS'
    SourceServer:
      type: object
      properties:
        sourceServerID:
          type: string
          description: Source server ID.
        arn:
          type: string
          description: Source server ARN.
        isArchived:
          type: boolean
          description: Source server archived status.
        tags:
          type: object
          additionalProperties:
            type: string
          description: Source server Tags.
        launchedInstance:
          $ref: '#/components/schemas/LaunchedInstance'
        dataReplicationInfo:
          $ref: '#/components/schemas/DataReplicationInfo'
        lifeCycle:
          $ref: '#/components/schemas/LifeCycle'
        sourceProperties:
          $ref: '#/components/schemas/SourceProperties'
        replicationType:
          type: string
          description: Source server replication type.
        vcenterClientID:
          type: string
          description: Source server vCenter client id.
        applicationID:
          type: string
          description: Source server application ID.
        userProvidedID:
          type: string
          description: Source server user provided ID.
        fqdnForActionFramework:
          type: string
          description: Source server fqdn for action framework.
        connectorAction:
          $ref: '#/components/schemas/SourceServerConnectorAction'
    SourceServerConnectorAction:
      type: object
      properties:
        credentialsSecretArn:
          type: string
          description: Source Server connector action credentials secret arn.
        connectorArn:
          type: string
          description: Source Server connector action connector arn.
    SsmDocument:
      type: object
      properties:
        actionName:
          type: string
          description: User-friendly name for the AWS Systems Manager Document.
        ssmDocumentName:
          type: string
          description: AWS Systems Manager Document name or full ARN.
        timeoutSeconds:
          type: integer
          description: AWS Systems Manager Document timeout seconds.
        mustSucceedForCutover:
          type: boolean
          description: If true, Cutover will not be enabled if the document has failed.
        parameters:
          type: object
          additionalProperties:
            type: array
            items:
              $ref: '#/components/schemas/SsmParameterStoreParameter'
          description: AWS Systems Manager Document parameters.
        externalParameters:
          type: object
          additionalProperties:
            $ref: '#/components/schemas/SsmExternalParameter'
          description: AWS Systems Manager Document external parameters.
      required:
      - actionName
      - ssmDocumentName
    SsmExternalParameter:
      type: object
      properties:
        dynamicPath:
          type: string
          description: AWS Systems Manager Document external parameters dynamic path.
      description: Exactly one member is set.
    SsmParameterStoreParameter:
      type: object
      properties:
        parameterType:
          type: string
          description: AWS Systems Manager Parameter Store parameter type.
        parameterName:
          type: string
          description: AWS Systems Manager Parameter Store parameter name.
      required:
      - parameterType
      - parameterName
    StartCutoverRequest:
      type: object
      properties:
        sourceServerIDs:
          type: array
          items:
            type: string
          description: Start Cutover by Source Server IDs.
        tags:
          type: object
          additionalProperties:
            type: string
          description: Start Cutover by Tags.
        accountID:
          type: string
          description: Start Cutover by Account IDs
      required:
      - sourceServerIDs
    StartCutoverResponse:
      type: object
      properties:
        job:
          $ref: '#/components/schemas/Job'
    StartTestRequest:
      type: object
      properties:
        sourceServerIDs:
          type: array
          items:
            type: string
          description: Start Test for Source Server IDs.
        tags:
          type: object
          additionalProperties:
            type: string
          description: Start Test by Tags.
        accountID:
          type: string
          description: Start Test for Account ID.
      required:
      - sourceServerIDs
    StartTestResponse:
      type: object
      properties:
        job:
          $ref: '#/components/schemas/Job'
    TerminateTargetInstancesRequest:
      type: object
      properties:
        sourceServerIDs:
          type: array
          items:
            type: string
          description: Terminate Target instance by Source Server IDs.
        tags:
          type: object
          additionalProperties:
            type: string
          description: Terminate Target instance by Tags.
        accountID:
          type: string
          description: Terminate Target instance by Account ID
      required:
      - sourceServerIDs
    TerminateTargetInstancesResponse:
      type: object
      properties:
        job:
          $ref: '#/components/schemas/Job'
    UninitializedAccountException:
      type: object
      properties:
        message:
          type: string
        code:
          type: string
x-provenance:
  method: harvested
  publisher: Amazon Web Services
  source: https://raw.githubusercontent.com/aws/api-models-aws/3cd98287b471c106254abd89279cc87308d38bfd/models/mgn/service/2020-02-26/mgn-2020-02-26.json
  note: converted by smithy-to-openapi.py from AWS's Smithy model (roadmap#1001)