AWS Migration Hub provides a single location to track the progress of application migrations across multiple AWS and partner solutions, giving visibility into migration progress and enabling the use of other AWS migration tools.
openapi: 3.0.0
info:
version: 2017-05-31
x-release: v4
title: AWS Migration Hub
description: <p>The AWS Migration Hub API methods help to obtain server and application migration status and integrate your resource-specific migration tool by providing a programmatic interface to
Migration Hub.</p> <p>Remember that you must set your AWS Migration Hub home region before you call any of these APIs, or a <code>HomeRegionNotSetException</code> error will be returned. Also, you
must make the API calls while in your home region.</p>
x-logo:
url: https://api.apis.guru/v2/cache/logo/https_twitter.com_awscloud_profile_image.png
backgroundColor: "#FFFFFF"
termsOfService: https://aws.amazon.com/service-terms/
contact:
name: Mike Ralphson
email: [email protected]
url: https://github.com/mermade/aws2openapi
x-twitter: PermittedSoc
license:
name: Apache 2.0 License
url: http://www.apache.org/licenses/
x-providerName: amazonaws.com
x-serviceName: AWSMigrationHub
x-origin:
- contentType: application/json
url: https://raw.githubusercontent.com/aws/aws-sdk-js/master/apis/AWSMigrationHub-2017-05-31.normal.json
converter:
url: https://github.com/mermade/aws2openapi
version: 1.0.0
x-apisguru-driver: external
x-apiClientRegistration:
url: https://portal.aws.amazon.com/gp/aws/developer/registration/index.html?nc2=h_ct
x-apisguru-categories:
- cloud
x-preferred: true
externalDocs:
description: Amazon Web Services documentation
url: https://docs.aws.amazon.com/mgh/
servers:
- url: http://mgh.{region}.amazonaws.com
variables:
region:
description: The AWS region
enum:
- us-east-1
- us-east-2
- us-west-1
- us-west-2
- us-gov-west-1
- us-gov-east-1
- ca-central-1
- eu-north-1
- eu-west-1
- eu-west-2
- eu-west-3
- eu-central-1
- eu-south-1
- af-south-1
- ap-northeast-1
- ap-northeast-2
- ap-northeast-3
- ap-southeast-1
- ap-southeast-2
- ap-east-1
- ap-south-1
- sa-east-1
- me-south-1
default: us-east-1
description: The AWS Migration Hub multi-region endpoint
- url: https://mgh.{region}.amazonaws.com
variables:
region:
description: The AWS region
enum:
- us-east-1
- us-east-2
- us-west-1
- us-west-2
- us-gov-west-1
- us-gov-east-1
- ca-central-1
- eu-north-1
- eu-west-1
- eu-west-2
- eu-west-3
- eu-central-1
- eu-south-1
- af-south-1
- ap-northeast-1
- ap-northeast-2
- ap-northeast-3
- ap-southeast-1
- ap-southeast-2
- ap-east-1
- ap-south-1
- sa-east-1
- me-south-1
default: us-east-1
description: The AWS Migration Hub multi-region endpoint
- url: http://mgh.{region}.amazonaws.com.cn
variables:
region:
description: The AWS region
enum:
- cn-north-1
- cn-northwest-1
default: cn-north-1
description: The AWS Migration Hub endpoint for China (Beijing) and China (Ningxia)
- url: https://mgh.{region}.amazonaws.com.cn
variables:
region:
description: The AWS region
enum:
- cn-north-1
- cn-northwest-1
default: cn-north-1
description: The AWS Migration Hub endpoint for China (Beijing) and China (Ningxia)
x-hasEquivalentPaths: true
paths:
/#X-Amz-Target=AWSMigrationHub.AssociateCreatedArtifact:
post:
operationId: AssociateCreatedArtifact
description: "<p>Associates a created artifact of an AWS cloud resource, the target receiving the migration, with the migration task performed by a migration tool. This API has the following traits:</p>
<ul> <li> <p>Migration tools can call the <code>AssociateCreatedArtifact</code> operation to indicate which AWS artifact is associated with a migration task.</p> </li> <li> <p>The created artifact
name must be provided in ARN (Amazon Resource Name) format which will contain information about type and region; for example: <code>arn:aws:ec2:us-east-1:488216288981:image/ami-6d0ba87b</code>.</p>
</li> <li> <p>Examples of the AWS resource behind the created artifact are, AMI's, EC2 instance, or DMS endpoint, etc.</p> </li> </ul>"
responses:
"200":
description: Success
content:
application/json:
schema:
$ref: "#/components/schemas/AssociateCreatedArtifactResult"
examples:
AssociateCreatedArtifact200Example:
summary: Default AssociateCreatedArtifact 200 response
x-microcks-default: true
value: {}
"480":
description: AccessDeniedException
content:
application/json:
schema:
$ref: "#/components/schemas/AccessDeniedException"
examples:
AssociateCreatedArtifact480Example:
summary: Default AssociateCreatedArtifact 480 response
x-microcks-default: true
value: {}
"481":
description: ThrottlingException
content:
application/json:
schema:
$ref: "#/components/schemas/ThrottlingException"
examples:
AssociateCreatedArtifact481Example:
summary: Default AssociateCreatedArtifact 481 response
x-microcks-default: true
value: {}
"482":
description: InternalServerError
content:
application/json:
schema:
$ref: "#/components/schemas/InternalServerError"
examples:
AssociateCreatedArtifact482Example:
summary: Default AssociateCreatedArtifact 482 response
x-microcks-default: true
value: {}
"483":
description: ServiceUnavailableException
content:
application/json:
schema:
$ref: "#/components/schemas/ServiceUnavailableException"
examples:
AssociateCreatedArtifact483Example:
summary: Default AssociateCreatedArtifact 483 response
x-microcks-default: true
value: {}
"484":
description: DryRunOperation
content:
application/json:
schema:
$ref: "#/components/schemas/DryRunOperation"
examples:
AssociateCreatedArtifact484Example:
summary: Default AssociateCreatedArtifact 484 response
x-microcks-default: true
value: {}
"485":
description: UnauthorizedOperation
content:
application/json:
schema:
$ref: "#/components/schemas/UnauthorizedOperation"
examples:
AssociateCreatedArtifact485Example:
summary: Default AssociateCreatedArtifact 485 response
x-microcks-default: true
value: {}
"486":
description: InvalidInputException
content:
application/json:
schema:
$ref: "#/components/schemas/InvalidInputException"
examples:
AssociateCreatedArtifact486Example:
summary: Default AssociateCreatedArtifact 486 response
x-microcks-default: true
value: {}
"487":
description: ResourceNotFoundException
content:
application/json:
schema:
$ref: "#/components/schemas/ResourceNotFoundException"
examples:
AssociateCreatedArtifact487Example:
summary: Default AssociateCreatedArtifact 487 response
x-microcks-default: true
value: {}
"488":
description: HomeRegionNotSetException
content:
application/json:
schema:
$ref: "#/components/schemas/HomeRegionNotSetException"
examples:
AssociateCreatedArtifact488Example:
summary: Default AssociateCreatedArtifact 488 response
x-microcks-default: true
value: {}
requestBody:
required: true
content:
application/json:
schema:
$ref: "#/components/schemas/AssociateCreatedArtifactRequest"
parameters:
- name: X-Amz-Target
in: header
required: true
schema:
type: string
enum:
- AWSMigrationHub.AssociateCreatedArtifact
summary: Amazon Migration Hub Associate Created Artifact
x-microcks-operation:
delay: 0
dispatcher: FALLBACK
parameters:
- $ref: "#/components/parameters/X-Amz-Content-Sha256"
- $ref: "#/components/parameters/X-Amz-Date"
- $ref: "#/components/parameters/X-Amz-Algorithm"
- $ref: "#/components/parameters/X-Amz-Credential"
- $ref: "#/components/parameters/X-Amz-Security-Token"
- $ref: "#/components/parameters/X-Amz-Signature"
- $ref: "#/components/parameters/X-Amz-SignedHeaders"
/#X-Amz-Target=AWSMigrationHub.AssociateDiscoveredResource:
post:
operationId: AssociateDiscoveredResource
description: Associates a discovered resource ID from Application Discovery Service with a migration task.
responses:
"200":
description: Success
content:
application/json:
schema:
$ref: "#/components/schemas/AssociateDiscoveredResourceResult"
examples:
AssociateDiscoveredResource200Example:
summary: Default AssociateDiscoveredResource 200 response
x-microcks-default: true
value: {}
"480":
description: AccessDeniedException
content:
application/json:
schema:
$ref: "#/components/schemas/AccessDeniedException"
examples:
AssociateDiscoveredResource480Example:
summary: Default AssociateDiscoveredResource 480 response
x-microcks-default: true
value: {}
"481":
description: ThrottlingException
content:
application/json:
schema:
$ref: "#/components/schemas/ThrottlingException"
examples:
AssociateDiscoveredResource481Example:
summary: Default AssociateDiscoveredResource 481 response
x-microcks-default: true
value: {}
"482":
description: InternalServerError
content:
application/json:
schema:
$ref: "#/components/schemas/InternalServerError"
examples:
AssociateDiscoveredResource482Example:
summary: Default AssociateDiscoveredResource 482 response
x-microcks-default: true
value: {}
"483":
description: ServiceUnavailableException
content:
application/json:
schema:
$ref: "#/components/schemas/ServiceUnavailableException"
examples:
AssociateDiscoveredResource483Example:
summary: Default AssociateDiscoveredResource 483 response
x-microcks-default: true
value: {}
"484":
description: DryRunOperation
content:
application/json:
schema:
$ref: "#/components/schemas/DryRunOperation"
examples:
AssociateDiscoveredResource484Example:
summary: Default AssociateDiscoveredResource 484 response
x-microcks-default: true
value: {}
"485":
description: UnauthorizedOperation
content:
application/json:
schema:
$ref: "#/components/schemas/UnauthorizedOperation"
examples:
AssociateDiscoveredResource485Example:
summary: Default AssociateDiscoveredResource 485 response
x-microcks-default: true
value: {}
"486":
description: InvalidInputException
content:
application/json:
schema:
$ref: "#/components/schemas/InvalidInputException"
examples:
AssociateDiscoveredResource486Example:
summary: Default AssociateDiscoveredResource 486 response
x-microcks-default: true
value: {}
"487":
description: PolicyErrorException
content:
application/json:
schema:
$ref: "#/components/schemas/PolicyErrorException"
examples:
AssociateDiscoveredResource487Example:
summary: Default AssociateDiscoveredResource 487 response
x-microcks-default: true
value: {}
"488":
description: ResourceNotFoundException
content:
application/json:
schema:
$ref: "#/components/schemas/ResourceNotFoundException"
examples:
AssociateDiscoveredResource488Example:
summary: Default AssociateDiscoveredResource 488 response
x-microcks-default: true
value: {}
"489":
description: HomeRegionNotSetException
content:
application/json:
schema:
$ref: "#/components/schemas/HomeRegionNotSetException"
examples:
AssociateDiscoveredResource489Example:
summary: Default AssociateDiscoveredResource 489 response
x-microcks-default: true
value: {}
requestBody:
required: true
content:
application/json:
schema:
$ref: "#/components/schemas/AssociateDiscoveredResourceRequest"
parameters:
- name: X-Amz-Target
in: header
required: true
schema:
type: string
enum:
- AWSMigrationHub.AssociateDiscoveredResource
summary: Amazon Migration Hub Associate Discovered Resource
x-microcks-operation:
delay: 0
dispatcher: FALLBACK
parameters:
- $ref: "#/components/parameters/X-Amz-Content-Sha256"
- $ref: "#/components/parameters/X-Amz-Date"
- $ref: "#/components/parameters/X-Amz-Algorithm"
- $ref: "#/components/parameters/X-Amz-Credential"
- $ref: "#/components/parameters/X-Amz-Security-Token"
- $ref: "#/components/parameters/X-Amz-Signature"
- $ref: "#/components/parameters/X-Amz-SignedHeaders"
/#X-Amz-Target=AWSMigrationHub.CreateProgressUpdateStream:
post:
operationId: CreateProgressUpdateStream
description: Creates a progress update stream which is an AWS resource used for access control as well as a namespace for migration task names that is implicitly linked to your AWS account. It
must uniquely identify the migration tool as it is used for all updates made by the tool; however, it does not need to be unique for each AWS account because it is scoped to the AWS account.
responses:
"200":
description: Success
content:
application/json:
schema:
$ref: "#/components/schemas/CreateProgressUpdateStreamResult"
examples:
CreateProgressUpdateStream200Example:
summary: Default CreateProgressUpdateStream 200 response
x-microcks-default: true
value: {}
"480":
description: AccessDeniedException
content:
application/json:
schema:
$ref: "#/components/schemas/AccessDeniedException"
examples:
CreateProgressUpdateStream480Example:
summary: Default CreateProgressUpdateStream 480 response
x-microcks-default: true
value: {}
"481":
description: ThrottlingException
content:
application/json:
schema:
$ref: "#/components/schemas/ThrottlingException"
examples:
CreateProgressUpdateStream481Example:
summary: Default CreateProgressUpdateStream 481 response
x-microcks-default: true
value: {}
"482":
description: InternalServerError
content:
application/json:
schema:
$ref: "#/components/schemas/InternalServerError"
examples:
CreateProgressUpdateStream482Example:
summary: Default CreateProgressUpdateStream 482 response
x-microcks-default: true
value: {}
"483":
description: ServiceUnavailableException
content:
application/json:
schema:
$ref: "#/components/schemas/ServiceUnavailableException"
examples:
CreateProgressUpdateStream483Example:
summary: Default CreateProgressUpdateStream 483 response
x-microcks-default: true
value: {}
"484":
description: DryRunOperation
content:
application/json:
schema:
$ref: "#/components/schemas/DryRunOperation"
examples:
CreateProgressUpdateStream484Example:
summary: Default CreateProgressUpdateStream 484 response
x-microcks-default: true
value: {}
"485":
description: UnauthorizedOperation
content:
application/json:
schema:
$ref: "#/components/schemas/UnauthorizedOperation"
examples:
CreateProgressUpdateStream485Example:
summary: Default CreateProgressUpdateStream 485 response
x-microcks-default: true
value: {}
"486":
description: InvalidInputException
content:
application/json:
schema:
$ref: "#/components/schemas/InvalidInputException"
examples:
CreateProgressUpdateStream486Example:
summary: Default CreateProgressUpdateStream 486 response
x-microcks-default: true
value: {}
"487":
description: HomeRegionNotSetException
content:
application/json:
schema:
$ref: "#/components/schemas/HomeRegionNotSetException"
examples:
CreateProgressUpdateStream487Example:
summary: Default CreateProgressUpdateStream 487 response
x-microcks-default: true
value: {}
requestBody:
required: true
content:
application/json:
schema:
$ref: "#/components/schemas/CreateProgressUpdateStreamRequest"
parameters:
- name: X-Amz-Target
in: header
required: true
schema:
type: string
enum:
- AWSMigrationHub.CreateProgressUpdateStream
summary: Amazon Migration Hub Create Progress Update Stream
x-microcks-operation:
delay: 0
dispatcher: FALLBACK
parameters:
- $ref: "#/components/parameters/X-Amz-Content-Sha256"
- $ref: "#/components/parameters/X-Amz-Date"
- $ref: "#/components/parameters/X-Amz-Algorithm"
- $ref: "#/components/parameters/X-Amz-Credential"
- $ref: "#/components/parameters/X-Amz-Security-Token"
- $ref: "#/components/parameters/X-Amz-Signature"
- $ref: "#/components/parameters/X-Amz-SignedHeaders"
/#X-Amz-Target=AWSMigrationHub.DeleteProgressUpdateStream:
post:
operationId: DeleteProgressUpdateStream
description: <p>Deletes a progress update stream, including all of its tasks, which was previously created as an AWS resource used for access control. This API has the following traits:</p> <ul>
<li> <p>The only parameter needed for <code>DeleteProgressUpdateStream</code> is the stream name (same as a <code>CreateProgressUpdateStream</code> call).</p> </li> <li> <p>The call will
return, and a background process will asynchronously delete the stream and all of its resources (tasks, associated resources, resource attributes, created artifacts).</p> </li> <li> <p>If the
stream takes time to be deleted, it might still show up on a <code>ListProgressUpdateStreams</code> call.</p> </li> <li> <p> <code>CreateProgressUpdateStream</code>,
<code>ImportMigrationTask</code>, <code>NotifyMigrationTaskState</code>, and all Associate[*] APIs related to the tasks belonging to the stream will throw "InvalidInputException" if the stream
of the same name is in the process of being deleted.</p> </li> <li> <p>Once the stream and all of its resources are deleted, <code>CreateProgressUpdateStream</code> for a stream of the same
name will succeed, and that stream will be an entirely new logical resource (without any resources associated with the old stream).</p> </li> </ul>
responses:
"200":
description: Success
content:
application/json:
schema:
$ref: "#/components/schemas/DeleteProgressUpdateStreamResult"
examples:
DeleteProgressUpdateStream200Example:
summary: Default DeleteProgressUpdateStream 200 response
x-microcks-default: true
value: {}
"480":
description: AccessDeniedException
content:
application/json:
schema:
$ref: "#/components/schemas/AccessDeniedException"
examples:
DeleteProgressUpdateStream480Example:
summary: Default DeleteProgressUpdateStream 480 response
x-microcks-default: true
value: {}
"481":
description: ThrottlingException
content:
application/json:
schema:
$ref: "#/components/schemas/ThrottlingException"
examples:
DeleteProgressUpdateStream481Example:
summary: Default DeleteProgressUpdateStream 481 response
x-microcks-default: true
value: {}
"482":
description: InternalServerError
content:
application/json:
schema:
$ref: "#/components/schemas/InternalServerError"
examples:
DeleteProgressUpdateStream482Example:
summary: Default DeleteProgressUpdateStream 482 response
x-microcks-default: true
value: {}
"483":
description: ServiceUnavailableException
content:
application/json:
schema:
$ref: "#/components/schemas/ServiceUnavailableException"
examples:
DeleteProgressUpdateStream483Example:
summary: Default DeleteProgressUpdateStream 483 response
x-microcks-default: true
value: {}
"484":
description: DryRunOperation
content:
application/json:
schema:
$ref: "#/components/schemas/DryRunOperation"
examples:
DeleteProgressUpdateStream484Example:
summary: Default DeleteProgressUpdateStream 484 response
x-microcks-default: true
value: {}
"485":
description: UnauthorizedOperation
content:
application/json:
schema:
$ref: "#/components/schemas/UnauthorizedOperation"
examples:
DeleteProgressUpdateStream485Example:
summary: Default DeleteProgressUpdateStream 485 response
x-microcks-default: true
value: {}
"486":
description: InvalidInputException
content:
application/json:
schema:
$ref: "#/components/schemas/InvalidInputException"
examples:
DeleteProgressUpdateStream486Example:
summary: Default DeleteProgressUpdateStream 486 response
x-microcks-default: true
value: {}
"487":
description: ResourceNotFoundException
content:
application/json:
schema:
$ref: "#/components/schemas/ResourceNotFoundException"
examples:
DeleteProgressUpdateStream487Example:
summary: Default DeleteProgressUpdateStream 487 response
x-microcks-default: true
value: {}
"488":
description: HomeRegionNotSetException
content:
application/json:
schema:
$ref: "#/components/schemas/HomeRegionNotSetException"
examples:
DeleteProgressUpdateStream488Example:
summary: Default DeleteProgressUpdateStream 488 response
x-microcks-default: true
value: {}
requestBody:
required: true
content:
application/json:
schema:
$ref: "#/components/schemas/DeleteProgressUpdateStreamRequest"
parameters:
- name: X-Amz-Target
in: header
required: true
schema:
type: string
enum:
- AWSMigrationHub.DeleteProgressUpdateStream
summary: Amazon Migration Hub Delete Progress Update Stream
x-microcks-operation:
delay: 0
dispatcher: FALLBACK
parameters:
- $ref: "#/components/parameters/X-Amz-Content-Sha256"
- $ref: "#/components/parameters/X-Amz-Date"
- $ref: "#/components/parameters/X-Amz-Algorithm"
- $ref: "#/components/parameters/X-Amz-Credential"
- $ref: "#/components/parameters/X-Amz-Security-Token"
- $ref: "#/components/parameters/X-Amz-Signature"
- $ref: "#/components/parameters/X-Amz-SignedHeaders"
/#X-Amz-Target=AWSMigrationHub.DescribeApplicationState:
post:
operationId: DescribeApplicationState
description: Gets the migration status of an application.
responses:
"200":
description: Success
content:
application/json:
schema:
$ref: "#/components/schemas/DescribeApplicationStateResult"
examples:
DescribeApplicationState200Example:
summary: Default DescribeApplicationState 200 response
x-microcks-default: true
value:
ApplicationStatus: ACTIVE
LastUpdatedTime: example-value
"480":
description: AccessDeniedException
content:
application/json:
schema:
$ref: "#/components/schemas/AccessDeniedException"
examples:
DescribeApplicationState480Example:
summary: Default DescribeApplicationState 480 response
x-microcks-default: true
value: {}
"481":
description: ThrottlingException
content:
application/json:
schema:
$ref: "#/components/schemas/ThrottlingException"
examples:
DescribeApplicationState481Example:
summary: Default DescribeApplicationState 481 response
x-microcks-default: true
value: {}
"482":
description: InternalServerError
content:
application/json:
schema:
$ref: "#/components/schemas/InternalServerError"
examples:
DescribeApplicationState482Example:
summary: Default DescribeApplicationState 482 response
x-microcks-default: true
value: {}
"483":
description: ServiceUnavailableException
content:
application/json:
schema:
$ref: "#/components/schemas/ServiceUnavailableException"
examples:
DescribeApplicationState483Example:
summary: Default DescribeApplicationState 483 response
x-microcks-default: true
value: {}
"484":
description: InvalidInputException
content:
application/json:
schema:
$ref: "#/components/schemas/InvalidInputException"
examples:
DescribeApplicationState484Example:
summary: Default DescribeApplicationState 484 response
x-microcks-default: true
value: {}
"485":
description: PolicyErrorException
content:
application/json:
schema:
$ref: "#/components/schemas/PolicyErrorException"
examples:
DescribeApplicationState485Example:
summary: Default DescribeApplicationState 485 response
x-microcks-default: true
value: {}
"486":
description: ResourceNotFoundException
content:
application/json:
schema:
$ref: "#/components/schemas/ResourceNotFoundException"
examples:
DescribeApplicationState486Example:
summary: Default DescribeApplicationState 486 response
x-microcks-default: true
value: {}
"487":
description: HomeRegionNotSetException
content:
application/json:
schema:
$ref: "#/components/schemas/HomeRegionNotSetException"
examples:
DescribeApplicationState487Example:
summary: Default DescribeApplicationState 487 response
x-microcks-default: true
value: {}
requestBody:
required: true
content:
application/json:
schema:
$ref: "#/components/schemas/DescribeApplicationStateRequest"
parameters:
- name: X-Amz-Target
in: header
required: true
schema:
type: string
enum:
- AWSMigrationHub.DescribeApplicationState
summary: Amazon Migration Hub Describe Application State
x-microcks-operation:
delay: 0
dispatcher: FALLBACK
parameters:
- $ref: "#/components/parameters/X-Amz-Content-Sha256"
- $ref: "#/components/parameters/X-Amz-Date"
- $ref: "#/components/parameters/X-Amz-Algorithm"
- $ref: "#/components/parameters/X-Amz-Credential"
- $ref: "#/components/parameters/X-Amz-Security-Token"
- $ref: "#/components/parameters/X-Amz-Signature"
- $ref: "#/components/parameters/X-Amz-SignedHeaders"
/#X-Amz-Target=AWSMigrationHub.DescribeMigrationTask:
post:
operationId: DescribeMigrationTask
description: Retrieves a list of all attributes associated with a specific migration task.
responses:
"200":
description: Success
content:
application/json:
schema:
$ref: "#/components/schemas/DescribeMigrationTaskResult"
examples:
DescribeMigrationTask200Example:
summary: Default DescribeMigrationTask 200 response
x-microcks-default: true
val
# --- truncated at 32 KB (126 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/amazon-migration-hub/refs/heads/main/openapi/amazon-migration-hub-openapi-original.yml