Amazon Application Migration Service Source Servers API

Manage source servers being migrated

GitHub OpenAPI

Operations 5

POST /InitializeService Initialize Service #
POST /DisconnectFromService Disconnect From Service #
POST /MarkAsArchived Mark As Archived #
POST /DeleteSourceServer Delete Source Server #
POST /DescribeSourceServers Describe Source Servers #

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-source-servers-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-source-servers-api-openapi.yml Raw ↑
openapi: 3.1.0
info:
  title: Application Migration Service Source Servers API
  version: '2020-02-26'
  description: Generated from AWS's published Smithy model for Application Migration Service. 5 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:
  /InitializeService:
    post:
      operationId: InitializeService
      summary: Initialize Service
      description: Initialize Application Migration Service.
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/InitializeServiceResponse'
        '403':
          description: AccessDeniedException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AccessDeniedException'
        '400':
          description: ValidationException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ValidationException'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/InitializeServiceRequest'
      tags:
      - Source Servers
  /DisconnectFromService:
    post:
      operationId: DisconnectFromService
      summary: Disconnect From Service
      description: 'Disconnects specific Source Servers from Application Migration Service. Data replication is stopped immediately.
        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. If the agent
        on the source server has not been prevented from communicating with Application Migration Service, then it will receive
        a command to uninstall itself (within approximately 10 minutes). The following properties of the SourceServer will
        be changed immediately: dataReplicationInfo.dataReplicationState will be set to DISCONNECTED; 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
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/UninitializedAccountException'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/DisconnectFromServiceRequest'
      tags:
      - Source Servers
  /MarkAsArchived:
    post:
      operationId: MarkAsArchived
      summary: Mark As Archived
      description: Archives specific Source Servers by setting the SourceServer.isArchived property to true for specified
        SourceServers by ID. This command only works for SourceServers with a lifecycle state that equals DISCONNECTED or
        CUTOVER.
      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
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/UninitializedAccountException'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/MarkAsArchivedRequest'
      tags:
      - Source Servers
  /DeleteSourceServer:
    post:
      operationId: DeleteSourceServer
      summary: Delete Source Server
      description: Deletes a single source server by ID.
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/DeleteSourceServerResponse'
        '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
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/UninitializedAccountException'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/DeleteSourceServerRequest'
      tags:
      - Source Servers
  /DescribeSourceServers:
    post:
      operationId: DescribeSourceServers
      summary: Describe Source Servers
      description: Retrieves all SourceServers or multiple SourceServers by ID.
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/DescribeSourceServersResponse'
        '400':
          description: UninitializedAccountException; ValidationException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/UninitializedAccountException'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/DescribeSourceServersRequest'
      tags:
      - Source Servers
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:
    AccessDeniedException:
      type: object
      properties:
        message:
          type: string
        code:
          type: string
    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.
    DeleteSourceServerRequest:
      type: object
      properties:
        sourceServerID:
          type: string
          description: Request to delete Source Server from service by Server ID.
        accountID:
          type: string
          description: Request to delete Source Server from service by Account ID.
      required:
      - sourceServerID
    DeleteSourceServerResponse:
      type: object
      properties: {}
    DescribeSourceServersRequest:
      type: object
      properties:
        filters:
          $ref: '#/components/schemas/DescribeSourceServersRequestFilters'
        maxResults:
          type: integer
          description: Request to filter Source Servers list by maximum results.
        nextToken:
          type: string
          description: Request to filter Source Servers list by next token.
        accountID:
          type: string
          description: Request to filter Source Servers list by Account ID.
    DescribeSourceServersRequestFilters:
      type: object
      properties:
        sourceServerIDs:
          type: array
          items:
            type: string
          description: Request to filter Source Servers list by Source Server ID.
        isArchived:
          type: boolean
          description: Request to filter Source Servers list by archived.
        replicationTypes:
          type: array
          items:
            type: string
          description: Request to filter Source Servers list by replication type.
        lifeCycleStates:
          type: array
          items:
            type: string
          description: Request to filter Source Servers list by life cycle states.
        applicationIDs:
          type: array
          items:
            type: string
          description: Request to filter Source Servers list by application IDs.
    DescribeSourceServersResponse:
      type: object
      properties:
        items:
          type: array
          items:
            $ref: '#/components/schemas/SourceServer'
          description: The list of returned Source Servers.
        nextToken:
          type: string
          description: The token of the next Source Server to retrieve.
    DisconnectFromServiceRequest:
      type: object
      properties:
        sourceServerID:
          type: string
          description: Request to disconnect Source Server from service by Server ID.
        accountID:
          type: string
          description: Request to disconnect Source Server from service by Account ID.
      required:
      - sourceServerID
    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.
    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.
    InitializeServiceRequest:
      type: object
      properties: {}
    InitializeServiceResponse:
      type: object
      properties: {}
    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.
    MarkAsArchivedRequest:
      type: object
      properties:
        sourceServerID:
          type: string
          description: Mark as archived by Source Server ID.
        accountID:
          type: string
          description: Mark as archived by Account ID.
      required:
      - sourceServerID
    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.
    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.
    UninitializedAccountException:
      type: object
      properties:
        message:
          type: string
        code:
          type: string
    ValidationException:
      type: object
      properties:
        message:
          type: string
        code:
          type: string
        reason:
          type: string
          description: Validate exception reason.
        fieldList:
          type: array
          items:
            $ref: '#/components/schemas/ValidationExceptionField'
          description: Validate exception field list.
    ValidationExceptionField:
      type: object
      properties:
        name:
          type: string
          description: Validate exception field name.
        message:
          type: string
          description: Validate exception field message.
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)