openapi: 3.0.0 info: version: 2017-05-31 x-release: v4 title: AWS Migration Hub description:

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.

Remember that you must set your AWS Migration Hub home region before you call any of these APIs, or a HomeRegionNotSetException error will be returned. Also, you must make the API calls while in your home region.

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: mike.ralphson@gmail.com 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: "

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:

Migration tools can call the AssociateCreatedArtifact operation to indicate which AWS artifact is associated with a migration task.
The created artifact name must be provided in ARN (Amazon Resource Name) format which will contain information about type and region; for example: arn:aws:ec2:us-east-1:488216288981:image/ami-6d0ba87b.
Examples of the AWS resource behind the created artifact are, AMI's, EC2 instance, or DMS endpoint, etc.

" 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:

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:

The only parameter needed for DeleteProgressUpdateStream is the stream name (same as a CreateProgressUpdateStream call).
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).
If the stream takes time to be deleted, it might still show up on a ListProgressUpdateStreams call.
CreateProgressUpdateStream, ImportMigrationTask, NotifyMigrationTaskState, 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.
Once the stream and all of its resources are deleted, CreateProgressUpdateStream 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).

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 value: MigrationTask: example-value "480": description: AccessDeniedException content: application/json: schema: $ref: "#/components/schemas/AccessDeniedException" examples: DescribeMigrationTask480Example: summary: Default DescribeMigrationTask 480 response x-microcks-default: true value: {} "481": description: ThrottlingException content: application/json: schema: $ref: "#/components/schemas/ThrottlingException" examples: DescribeMigrationTask481Example: summary: Default DescribeMigrationTask 481 response x-microcks-default: true value: {} "482": description: InternalServerError content: application/json: schema: $ref: "#/components/schemas/InternalServerError" examples: DescribeMigrationTask482Example: summary: Default DescribeMigrationTask 482 response x-microcks-default: true value: {} "483": description: ServiceUnavailableException content: application/json: schema: $ref: "#/components/schemas/ServiceUnavailableException" examples: DescribeMigrationTask483Example: summary: Default DescribeMigrationTask 483 response x-microcks-default: true value: {} "484": description: InvalidInputException content: application/json: schema: $ref: "#/components/schemas/InvalidInputException" examples: DescribeMigrationTask484Example: summary: Default DescribeMigrationTask 484 response x-microcks-default: true value: {} "485": description: ResourceNotFoundException content: application/json: schema: $ref: "#/components/schemas/ResourceNotFoundException" examples: DescribeMigrationTask485Example: summary: Default DescribeMigrationTask 485 response x-microcks-default: true value: {} "486": description: HomeRegionNotSetException content: application/json: schema: $ref: "#/components/schemas/HomeRegionNotSetException" examples: DescribeMigrationTask486Example: summary: Default DescribeMigrationTask 486 response x-microcks-default: true value: {} requestBody: required: true content: application/json: schema: $ref: "#/components/schemas/DescribeMigrationTaskRequest" parameters: - name: X-Amz-Target in: header required: true schema: type: string enum: - AWSMigrationHub.DescribeMigrationTask summary: Amazon Migration Hub Describe Migration Task 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.DisassociateCreatedArtifact: post: operationId: DisassociateCreatedArtifact description: "

Disassociates a created artifact of an AWS resource with a migration task performed by a migration tool that was previously associated. This API has the following traits:

A migration user can call the DisassociateCreatedArtifacts operation to disassociate a created AWS Artifact from a migration task.
The created artifact name must be provided in ARN (Amazon Resource Name) format which will contain information about type and region; for example: arn:aws:ec2:us-east-1:488216288981:image/ami-6d0ba87b.
Examples of the AWS resource behind the created artifact are, AMI's, EC2 instance, or RDS instance, etc.

" responses: "200": description: Success content: application/json: schema: $ref: "#/components/schemas/DisassociateCreatedArtifactResult" examples: DisassociateCreatedArtifact200Example: summary: Default DisassociateCreatedArtifact 200 response x-microcks-default: true value: {} "480": description: AccessDeniedException content: application/json: schema: $ref: "#/components/schemas/AccessDeniedException" examples: DisassociateCreatedArtifact480Example: summary: Default DisassociateCreatedArtifact 480 response x-microcks-default: true value: {} "481": description: ThrottlingException content: application/json: schema: $ref: "#/components/schemas/ThrottlingException" examples: DisassociateCreatedArtifact481Example: summary: Default DisassociateCreatedArtifact 481 response x-microcks-default: true value: {} "482": description: InternalServerError content: application/json: schema: $ref: "#/components/schemas/InternalServerError" examples: DisassociateCreatedArtifact482Example: summary: Default DisassociateCreatedArtifact 482 response x-microcks-default: true value: {} "483": description: ServiceUnavailableException content: application/json: schema: $ref: "#/components/schemas/ServiceUnavailableException" examples: DisassociateCreatedArtifact483Example: summary: Default DisassociateCreatedArtifact 483 response x-microcks-default: true value: {} "484": description: DryRunOperation content: application/json: schema: $ref: "#/components/schemas/DryRunOperation" examples: DisassociateCreatedArtifact484Example: summary: Default DisassociateCreatedArtifact 484 response x-microcks-default: true value: {} "485": description: UnauthorizedOperation content: application/json: schema: $ref: "#/components/schemas/UnauthorizedOperation" examples: DisassociateCreatedArtifact485Example: summary: Default DisassociateCreatedArtifact 485 response x-microcks-default: true value: {} "486": description: InvalidInputException content: application/json: schema: $ref: "#/components/schemas/InvalidInputException" examples: DisassociateCreatedArtifact486Example: summary: Default DisassociateCreatedArtifact 486 response x-microcks-default: true value: {} "487": description: ResourceNotFoundException content: application/json: schema: $ref: "#/components/schemas/ResourceNotFoundException" examples: DisassociateCreatedArtifact487Example: summary: Default DisassociateCreatedArtifact 487 response x-microcks-default: true value: {} "488": description: HomeRegionNotSetException content: application/json: schema: $ref: "#/components/schemas/HomeRegionNotSetException" examples: DisassociateCreatedArtifact488Example: summary: Default DisassociateCreatedArtifact 488 response x-microcks-default: true value: {} requestBody: required: true content: application/json: schema: $ref: "#/components/schemas/DisassociateCreatedArtifactRequest" parameters: - name: X-Amz-Target in: header required: true schema: type: string enum: - AWSMigrationHub.DisassociateCreatedArtifact summary: Amazon Migration Hub Disassociate 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.DisassociateDiscoveredResource: post: operationId: DisassociateDiscoveredResource description: Disassociate an Application Discovery Service discovered resource from a migration task. responses: "200": description: Success content: application/json: schema: $ref: "#/components/schemas/DisassociateDiscoveredResourceResult" examples: DisassociateDiscoveredResource200Example: summary: Default DisassociateDiscoveredResource 200 response x-microcks-default: true value: {} "480": description: AccessDeniedException content: application/json: schema: $ref: "#/components/schemas/AccessDeniedException" examples: DisassociateDiscoveredResource480Example: summary: Default DisassociateDiscoveredResource 480 response x-microcks-default: true value: {} "481": description: ThrottlingException content: application/json: schema: $ref: "#/components/schemas/ThrottlingException" examples: DisassociateDiscoveredResource481Example: summary: Default DisassociateDiscoveredResource 481 response x-microcks-default: true value: {} "482": description: InternalServerError content: application/json: schema: $ref: "#/components/schemas/InternalServerError" examples: DisassociateDiscoveredResource482Example: summary: Default DisassociateDiscoveredResource 482 response x-microcks-default: true value: {} "483": description: ServiceUnavailableException content: application/json: schema: $ref: "#/components/schemas/ServiceUnavailableException" examples: DisassociateDiscoveredResource483Example: summary: Default DisassociateDiscoveredResource 483 response x-microcks-default: true value: {} "484": description: DryRunOperation content: application/json: schema: $ref: "#/components/schemas/DryRunOperation" examples: DisassociateDiscoveredResource484Example: summary: Default DisassociateDiscoveredResource 484 response x-microcks-default: true value: {} "485": description: UnauthorizedOperation content: application/json: schema: $ref: "#/components/schemas/UnauthorizedOperation" examples: DisassociateDiscoveredResource485Example: summary: Default DisassociateDiscoveredResource 485 response x-microcks-default: true value: {} "486": description: InvalidInputException content: application/json: schema: $ref: "#/components/schemas/InvalidInputException" examples: DisassociateDiscoveredResource486Example: summary: Default DisassociateDiscoveredResource 486 response x-microcks-default: true value: {} "487": description: ResourceNotFoundException content: application/json: schema: $ref: "#/components/schemas/ResourceNotFoundException" examples: DisassociateDiscoveredResource487Example: summary: Default DisassociateDiscoveredResource 487 response x-microcks-default: true value: {} "488": description: HomeRegionNotSetException content: application/json: schema: $ref: "#/components/schemas/HomeRegionNotSetException" examples: DisassociateDiscoveredResource488Example: summary: Default DisassociateDiscoveredResource 488 response x-microcks-default: true value: {} requestBody: required: true content: application/json: schema: $ref: "#/components/schemas/DisassociateDiscoveredResourceRequest" parameters: - name: X-Amz-Target in: header required: true schema: type: string enum: - AWSMigrationHub.DisassociateDiscoveredResource summary: Amazon Migration Hub Disassociate 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.ImportMigrationTask: post: operationId: ImportMigrationTask description:

Registers a new migration task which represents a server, database, etc., being migrated to AWS by a migration tool.

This API is a prerequisite to calling the NotifyMigrationTaskState API as the migration tool must first register the migration task with Migration Hub.

responses: "200": description: Success content: application/json: schema: $ref: "#/components/schemas/ImportMigrationTaskResult" examples: ImportMigrationTask200Example: summary: Default ImportMigrationTask 200 response x-microcks-default: true value: {} "480": description: AccessDeniedException content: application/json: schema: $ref: "#/components/schemas/AccessDeniedException" examples: ImportMigrationTask480Example: summary: Default ImportMigrationTask 480 response x-microcks-default: true value: {} "481": description: ThrottlingException content: application/json: schema: $ref: "#/components/schemas/ThrottlingException" examples: ImportMigrationTask481Example: summary: Default ImportMigrationTask 481 response x-microcks-default: true value: {} "482": description: InternalServerError content: application/json: schema: $ref: "#/components/schemas/InternalServerError" examples: ImportMigrationTask482Example: summary: Default ImportMigrationTask 482 response x-microcks-default: true value: {} "483": description: ServiceUnavailableException content: application/json: schema: $ref: "#/components/schemas/ServiceUnavailableException" examples: ImportMigrationTask483Example: summary: Default ImportMigrationTask 483 response x-microcks-default: true value: {} "484": description: DryRunOperation content: application/json: schema: $ref: "#/components/schemas/DryRunOperation" examples: ImportMigrationTask484Example: summary: Default ImportMigrationTask 484 response x-microcks-default: true value: {} "485": description: UnauthorizedOperation content: application/json: schema: $ref: "#/components/schemas/UnauthorizedOperation" examples: ImportMigrationTask485Example: summary: Default ImportMigrationTask 485 response x-microcks-default: true value: {} "486": description: InvalidInputException content: application/json: schema: $ref: "#/components/schemas/InvalidInputException" examples: ImportMigrationTask486Example: summary: Default ImportMigrationTask 486 response x-microcks-default: true value: {} "487": description: ResourceNotFoundException content: application/json: schema: $ref: "#/components/schemas/ResourceNotFoundException" examples: ImportMigrationTask487Example: summary: Default ImportMigrationTask 487 response x-microcks-default: true value: {} "488": description: HomeRegionNotSetException content: application/json: schema: $ref: "#/components/schemas/HomeRegionNotSetException" examples: ImportMigrationTask488Example: summary: Default ImportMigrationTask 488 response x-microcks-default: true value: {} requestBody: required: true content: application/json: schema: $ref: "#/components/schemas/ImportMigrationTaskRequest" parameters: - name: X-Amz-Target in: header required: true schema: type: string enum: - AWSMigrationHub.ImportMigrationTask summary: Amazon Migration Hub Import Migration Task 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.ListApplicationStates: post: operationId: ListApplicationStates description: Lists all the migration statuses for your applications. If you use the optional ApplicationIds parameter, only the migration statuses for those applications will be returned. responses: "200": description: Success content: application/json: schema: $ref: "#/components/schemas/ListApplicationStatesResult" examples: ListApplicationStates200Example: summary: Default ListApplicationStates 200 response x-microcks-default: true value: ApplicationStateList: example-value NextToken: example-value "480": description: AccessDeniedException content: application/json: schema: $ref: "#/components/schemas/AccessDeniedException" examples: ListApplicationStates480Example: summary: Default ListApplicationStates 480 response x-microcks-default: true value: {} "481": description: ThrottlingException content: application/json: schema: $ref: "#/components/schemas/ThrottlingException" examples: ListApplicationStates481Example: summary: Default ListApplicationStates 481 response x-microcks-default: true value: {} "482": description: InternalServerError content: application/json: schema: $ref: "#/components/schemas/InternalServerError" examples: ListApplicationStates482Example: summary: Default ListApplicationStates 482 response x-microcks-default: true value: {} "483": description: ServiceUnavailableException content: application/json: schema: $ref: "#/components/schemas/ServiceUnavailableException" examples: ListApplicationStates483Example: summary: Default ListApplicationStates 483 response x-microcks-default: true value: {} "484": description: InvalidInputException content: application/json: schema: $ref: "#/components/schemas/InvalidInputException" examples: ListApplicationStates484Example: summary: Default ListApplicationStates 484 response x-microcks-default: true value: {} "485": description: HomeRegionNotSetException content: application/json: schema: $ref: "#/components/schemas/HomeRegionNotSetException" examples: ListApplicationStates485Example: summary: Default ListApplicationStates 485 response x-microcks-default: true value: {} requestBody: required: true content: application/json: schema: $ref: "#/components/schemas/ListApplicationStatesRequest" parameters: - name: MaxResults in: query schema: type: string description: Pagination limit required: false - name: NextToken in: query schema: type: string description: Pagination token required: false - name: X-Amz-Target in: header required: true schema: type: string enum: - AWSMigrationHub.ListApplicationStates summary: Amazon Migration Hub List Application States 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.ListCreatedArtifacts: post: operationId: ListCreatedArtifacts description:

Lists the created artifacts attached to a given migration task in an update stream. This API has the following traits:

Gets the list of the created artifacts while migration is taking place.
Shows the artifacts created by the migration tool that was associated by the AssociateCreatedArtifact API.
Lists created artifacts in a paginated interface.

responses: "200": description: Success content: application/json: schema: $ref: "#/components/schemas/ListCreatedArtifactsResult" examples: ListCreatedArtifacts200Example: summary: Default ListCreatedArtifacts 200 response x-microcks-default: true value: NextToken: example-value CreatedArtifactList: example-value "480": description: AccessDeniedException content: application/json: schema: $ref: "#/components/schemas/AccessDeniedException" examples: ListCreatedArtifacts480Example: summary: Default ListCreatedArtifacts 480 response x-microcks-default: true value: {} "481": description: ThrottlingException content: application/json: schema: $ref: "#/components/schemas/ThrottlingException" examples: ListCreatedArtifacts481Example: summary: Default ListCreatedArtifacts 481 response x-microcks-default: true value: {} "482": description: InternalServerError content: application/json: schema: $ref: "#/components/schemas/InternalServerError" examples: ListCreatedArtifacts482Example: summary: Default ListCreatedArtifacts 482 response x-microcks-default: true value: {} "483": description: ServiceUnavailableException content: application/json: schema: $ref: "#/components/schemas/ServiceUnavailableException" examples: ListCreatedArtifacts483Example: summary: Default ListCreatedArtifacts 483 response x-microcks-default: true value: {} "484": description: InvalidInputException content: application/json: schema: $ref: "#/components/schemas/InvalidInputException" examples: ListCreatedArtifacts484Example: summary: Default ListCreatedArtifacts 484 response x-microcks-default: true value: {} "485": description: ResourceNotFoundException content: application/json: schema: $ref: "#/components/schemas/ResourceNotFoundException" examples: ListCreatedArtifacts485Example: summary: Default ListCreatedArtifacts 485 response x-microcks-default: true value: {} "486": description: HomeRegionNotSetException content: application/json: schema: $ref: "#/components/schemas/HomeRegionNotSetException" examples: ListCreatedArtifacts486Example: summary: Default ListCreatedArtifacts 486 response x-microcks-default: true value: {} requestBody: required: true content: application/json: schema: $ref: "#/components/schemas/ListCreatedArtifactsRequest" parameters: - name: MaxResults in: query schema: type: string description: Pagination limit required: false - name: NextToken in: query schema: type: string description: Pagination token required: false - name: X-Amz-Target in: header required: true schema: type: string enum: - AWSMigrationHub.ListCreatedArtifacts summary: Amazon Migration Hub List Created Artifacts 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.ListDiscoveredResources: post: operationId: ListDiscoveredResources description: Lists discovered resources associated with the given MigrationTask. responses: "200": description: Success content: application/json: schema: $ref: "#/components/schemas/ListDiscoveredResourcesResult" examples: ListDiscoveredResources200Example: summary: Default ListDiscoveredResources 200 response x-microcks-default: true value: NextToken: example-value DiscoveredResourceList: example-value "480": description: AccessDeniedException content: application/json: schema: $ref: "#/components/schemas/AccessDeniedException" examples: ListDiscoveredResources480Example: summary: Default ListDiscoveredResources 480 response x-microcks-default: true value: {} "481": description: ThrottlingException content: application/json: schema: $ref: "#/components/schemas/ThrottlingException" examples: ListDiscoveredResources481Example: summary: Default ListDiscoveredResources 481 response x-microcks-default: true value: {} "482": description: InternalServerError content: application/json: schema: $ref: "#/components/schemas/InternalServerError" examples: ListDiscoveredResources482Example: summary: Default ListDiscoveredResources 482 response x-microcks-default: true value: {} "483": description: ServiceUnavailableException content: application/json: schema: $ref: "#/components/schemas/ServiceUnavailableException" examples: ListDiscoveredResources483Example: summary: Default ListDiscoveredResources 483 response x-microcks-default: true value: {} "484": description: InvalidInputException content: application/json: schema: $ref: "#/components/schemas/InvalidInputException" examples: ListDiscoveredResources484Example: summary: Default ListDiscoveredResources 484 response x-microcks-default: true value: {} "485": description: ResourceNotFoundException content: application/json: schema: $ref: "#/components/schemas/ResourceNotFoundException" examples: ListDiscoveredResources485Example: summary: Default ListDiscoveredResources 485 response x-microcks-default: true value: {} "486": description: HomeRegionNotSetException content: application/json: schema: $ref: "#/components/schemas/HomeRegionNotSetException" examples: ListDiscoveredResources486Example: summary: Default ListDiscoveredResources 486 response x-microcks-default: true value: {} requestBody: required: true content: application/json: schema: $ref: "#/components/schemas/ListDiscoveredResourcesRequest" parameters: - name: MaxResults in: query schema: type: string description: Pagination limit required: false - name: NextToken in: query schema: type: string description: Pagination token required: false - name: X-Amz-Target in: header required: true schema: type: string enum: - AWSMigrationHub.ListDiscoveredResources summary: Amazon Migration Hub List Discovered Resources 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.ListMigrationTasks: post: operationId: ListMigrationTasks description:

Lists all, or filtered by resource name, migration tasks associated with the user account making this call. This API has the following traits:

Can show a summary list of the most recent migration tasks.
Can show a summary list of migration tasks associated with a given discovered resource.
Lists migration tasks in a paginated interface.

responses: "200": description: Success content: application/json: schema: $ref: "#/components/schemas/ListMigrationTasksResult" examples: ListMigrationTasks200Example: summary: Default ListMigrationTasks 200 response x-microcks-default: true value: NextToken: example-value MigrationTaskSummaryList: example-value "480": description: AccessDeniedException content: application/json: schema: $ref: "#/components/schemas/AccessDeniedException" examples: ListMigrationTasks480Example: summary: Default ListMigrationTasks 480 response x-microcks-default: true value: {} "481": description: ThrottlingException content: application/json: schema: $ref: "#/components/schemas/ThrottlingException" examples: ListMigrationTasks481Example: summary: Default ListMigrationTasks 481 response x-microcks-default: true value: {} "482": description: InternalServerError content: application/json: schema: $ref: "#/components/schemas/InternalServerError" examples: ListMigrationTasks482Example: summary: Default ListMigrationTasks 482 response x-microcks-default: true value: {} "483": description: ServiceUnavailableException content: application/json: schema: $ref: "#/components/schemas/ServiceUnavailableException" examples: ListMigrationTasks483Example: summary: Default ListMigrationTasks 483 response x-microcks-default: true value: {} "484": description: InvalidInputException content: application/json: schema: $ref: "#/components/schemas/InvalidInputException" examples: ListMigrationTasks484Example: summary: Default ListMigrationTasks 484 response x-microcks-default: true value: {} "485": description: PolicyErrorException content: application/json: schema: $ref: "#/components/schemas/PolicyErrorException" examples: ListMigrationTasks485Example: summary: Default ListMigrationTasks 485 response x-microcks-default: true value: {} "486": description: ResourceNotFoundException content: application/json: schema: $ref: "#/components/schemas/ResourceNotFoundException" examples: ListMigrationTasks486Example: summary: Default ListMigrationTasks 486 response x-microcks-default: true value: {} "487": description: HomeRegionNotSetException content: application/json: schema: $ref: "#/components/schemas/HomeRegionNotSetException" examples: ListMigrationTasks487Example: summary: Default ListMigrationTasks 487 response x-microcks-default: true value: {} requestBody: required: true content: application/json: schema: $ref: "#/components/schemas/ListMigrationTasksRequest" parameters: - name: MaxResults in: query schema: type: string description: Pagination limit required: false - name: NextToken in: query schema: type: string description: Pagination token required: false - name: X-Amz-Target in: header required: true schema: type: string enum: - AWSMigrationHub.ListMigrationTasks summary: Amazon Migration Hub List Migration Tasks 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.ListProgressUpdateStreams: post: operationId: ListProgressUpdateStreams description: Lists progress update streams associated with the user account making this call. responses: "200": description: Success content: application/json: schema: $ref: "#/components/schemas/ListProgressUpdateStreamsResult" examples: ListProgressUpdateStreams200Example: summary: Default ListProgressUpdateStreams 200 response x-microcks-default: true value: ProgressUpdateStreamSummaryList: example-value NextToken: example-value "480": description: AccessDeniedException content: application/json: schema: $ref: "#/components/schemas/AccessDeniedException" examples: ListProgressUpdateStreams480Example: summary: Default ListProgressUpdateStreams 480 response x-microcks-default: true value: {} "481": description: ThrottlingException content: application/json: schema: $ref: "#/components/schemas/ThrottlingException" examples: ListProgressUpdateStreams481Example: summary: Default ListProgressUpdateStreams 481 response x-microcks-default: true value: {} "482": description: InternalServerError content: application/json: schema: $ref: "#/components/schemas/InternalServerError" examples: ListProgressUpdateStreams482Example: summary: Default ListProgressUpdateStreams 482 response x-microcks-default: true value: {} "483": description: ServiceUnavailableException content: application/json: schema: $ref: "#/components/schemas/ServiceUnavailableException" examples: ListProgressUpdateStreams483Example: summary: Default ListProgressUpdateStreams 483 response x-microcks-default: true value: {} "484": description: InvalidInputException content: application/json: schema: $ref: "#/components/schemas/InvalidInputException" examples: ListProgressUpdateStreams484Example: summary: Default ListProgressUpdateStreams 484 response x-microcks-default: true value: {} "485": description: HomeRegionNotSetException content: application/json: schema: $ref: "#/components/schemas/HomeRegionNotSetException" examples: ListProgressUpdateStreams485Example: summary: Default ListProgressUpdateStreams 485 response x-microcks-default: true value: {} requestBody: required: true content: application/json: schema: $ref: "#/components/schemas/ListProgressUpdateStreamsRequest" parameters: - name: MaxResults in: query schema: type: string description: Pagination limit required: false - name: NextToken in: query schema: type: string description: Pagination token required: false - name: X-Amz-Target in: header required: true schema: type: string enum: - AWSMigrationHub.ListProgressUpdateStreams summary: Amazon Migration Hub List Progress Update Streams 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.NotifyApplicationState: post: operationId: NotifyApplicationState description: "Sets the migration state of an application. For a given application identified by the value passed to ApplicationId, its status is set or updated by passing one of three values to Status: NOT_STARTED | IN_PROGRESS | COMPLETED." responses: "200": description: Success content: application/json: schema: $ref: "#/components/schemas/NotifyApplicationStateResult" examples: NotifyApplicationState200Example: summary: Default NotifyApplicationState 200 response x-microcks-default: true value: {} "480": description: AccessDeniedException content: application/json: schema: $ref: "#/components/schemas/AccessDeniedException" examples: NotifyApplicationState480Example: summary: Default NotifyApplicationState 480 response x-microcks-default: true value: {} "481": description: ThrottlingException content: application/json: schema: $ref: "#/components/schemas/ThrottlingException" examples: NotifyApplicationState481Example: summary: Default NotifyApplicationState 481 response x-microcks-default: true value: {} "482": description: InternalServerError content: application/json: schema: $ref: "#/components/schemas/InternalServerError" examples: NotifyApplicationState482Example: summary: Default NotifyApplicationState 482 response x-microcks-default: true value: {} "483": description: ServiceUnavailableException content: application/json: schema: $ref: "#/components/schemas/ServiceUnavailableException" examples: NotifyApplicationState483Example: summary: Default NotifyApplicationState 483 response x-microcks-default: true value: {} "484": description: DryRunOperation content: application/json: schema: $ref: "#/components/schemas/DryRunOperation" examples: NotifyApplicationState484Example: summary: Default NotifyApplicationState 484 response x-microcks-default: true value: {} "485": description: UnauthorizedOperation content: application/json: schema: $ref: "#/components/schemas/UnauthorizedOperation" examples: NotifyApplicationState485Example: summary: Default NotifyApplicationState 485 response x-microcks-default: true value: {} "486": description: InvalidInputException content: application/json: schema: $ref: "#/components/schemas/InvalidInputException" examples: NotifyApplicationState486Example: summary: Default NotifyApplicationState 486 response x-microcks-default: true value: {} "487": description: PolicyErrorException content: application/json: schema: $ref: "#/components/schemas/PolicyErrorException" examples: NotifyApplicationState487Example: summary: Default NotifyApplicationState 487 response x-microcks-default: true value: {} "488": description: ResourceNotFoundException content: application/json: schema: $ref: "#/components/schemas/ResourceNotFoundException" examples: NotifyApplicationState488Example: summary: Default NotifyApplicationState 488 response x-microcks-default: true value: {} "489": description: HomeRegionNotSetException content: application/json: schema: $ref: "#/components/schemas/HomeRegionNotSetException" examples: NotifyApplicationState489Example: summary: Default NotifyApplicationState 489 response x-microcks-default: true value: {} requestBody: required: true content: application/json: schema: $ref: "#/components/schemas/NotifyApplicationStateRequest" parameters: - name: X-Amz-Target in: header required: true schema: type: string enum: - AWSMigrationHub.NotifyApplicationState summary: Amazon Migration Hub Notify 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.NotifyMigrationTaskState: post: operationId: NotifyMigrationTaskState description:

Notifies Migration Hub of the current status, progress, or other detail regarding a migration task. This API has the following traits:

Migration tools will call the NotifyMigrationTaskState API to share the latest progress and status.
MigrationTaskName is used for addressing updates to the correct target.
ProgressUpdateStream is used for access control and to provide a namespace for each migration tool.

responses: "200": description: Success content: application/json: schema: $ref: "#/components/schemas/NotifyMigrationTaskStateResult" examples: NotifyMigrationTaskState200Example: summary: Default NotifyMigrationTaskState 200 response x-microcks-default: true value: {} "480": description: AccessDeniedException content: application/json: schema: $ref: "#/components/schemas/AccessDeniedException" examples: NotifyMigrationTaskState480Example: summary: Default NotifyMigrationTaskState 480 response x-microcks-default: true value: {} "481": description: ThrottlingException content: application/json: schema: $ref: "#/components/schemas/ThrottlingException" examples: NotifyMigrationTaskState481Example: summary: Default NotifyMigrationTaskState 481 response x-microcks-default: true value: {} "482": description: InternalServerError content: application/json: schema: $ref: "#/components/schemas/InternalServerError" examples: NotifyMigrationTaskState482Example: summary: Default NotifyMigrationTaskState 482 response x-microcks-default: true value: {} "483": description: ServiceUnavailableException content: application/json: schema: $ref: "#/components/schemas/ServiceUnavailableException" examples: NotifyMigrationTaskState483Example: summary: Default NotifyMigrationTaskState 483 response x-microcks-default: true value: {} "484": description: DryRunOperation content: application/json: schema: $ref: "#/components/schemas/DryRunOperation" examples: NotifyMigrationTaskState484Example: summary: Default NotifyMigrationTaskState 484 response x-microcks-default: true value: {} "485": description: UnauthorizedOperation content: application/json: schema: $ref: "#/components/schemas/UnauthorizedOperation" examples: NotifyMigrationTaskState485Example: summary: Default NotifyMigrationTaskState 485 response x-microcks-default: true value: {} "486": description: InvalidInputException content: application/json: schema: $ref: "#/components/schemas/InvalidInputException" examples: NotifyMigrationTaskState486Example: summary: Default NotifyMigrationTaskState 486 response x-microcks-default: true value: {} "487": description: ResourceNotFoundException content: application/json: schema: $ref: "#/components/schemas/ResourceNotFoundException" examples: NotifyMigrationTaskState487Example: summary: Default NotifyMigrationTaskState 487 response x-microcks-default: true value: {} "488": description: HomeRegionNotSetException content: application/json: schema: $ref: "#/components/schemas/HomeRegionNotSetException" examples: NotifyMigrationTaskState488Example: summary: Default NotifyMigrationTaskState 488 response x-microcks-default: true value: {} requestBody: required: true content: application/json: schema: $ref: "#/components/schemas/NotifyMigrationTaskStateRequest" parameters: - name: X-Amz-Target in: header required: true schema: type: string enum: - AWSMigrationHub.NotifyMigrationTaskState summary: Amazon Migration Hub Notify Migration Task 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.PutResourceAttributes: post: operationId: PutResourceAttributes description:

Provides identifying details of the resource being migrated so that it can be associated in the Application Discovery Service repository. This association occurs asynchronously after PutResourceAttributes returns.

Keep in mind that subsequent calls to PutResourceAttributes will override previously stored attributes. For example, if it is first called with a MAC address, but later, it is desired to add an IP address, it will then be required to call it with both the IP and MAC addresses to prevent overriding the MAC address.
Note the instructions regarding the special use case of the ResourceAttributeList parameter when specifying any "VM" related value.

Because this is an asynchronous call, it will always return 200, whether an association occurs or not. To confirm if an association was found based on the provided details, call ListDiscoveredResources.

responses: "200": description: Success content: application/json: schema: $ref: "#/components/schemas/PutResourceAttributesResult" examples: PutResourceAttributes200Example: summary: Default PutResourceAttributes 200 response x-microcks-default: true value: {} "480": description: AccessDeniedException content: application/json: schema: $ref: "#/components/schemas/AccessDeniedException" examples: PutResourceAttributes480Example: summary: Default PutResourceAttributes 480 response x-microcks-default: true value: {} "481": description: ThrottlingException content: application/json: schema: $ref: "#/components/schemas/ThrottlingException" examples: PutResourceAttributes481Example: summary: Default PutResourceAttributes 481 response x-microcks-default: true value: {} "482": description: InternalServerError content: application/json: schema: $ref: "#/components/schemas/InternalServerError" examples: PutResourceAttributes482Example: summary: Default PutResourceAttributes 482 response x-microcks-default: true value: {} "483": description: ServiceUnavailableException content: application/json: schema: $ref: "#/components/schemas/ServiceUnavailableException" examples: PutResourceAttributes483Example: summary: Default PutResourceAttributes 483 response x-microcks-default: true value: {} "484": description: DryRunOperation content: application/json: schema: $ref: "#/components/schemas/DryRunOperation" examples: PutResourceAttributes484Example: summary: Default PutResourceAttributes 484 response x-microcks-default: true value: {} "485": description: UnauthorizedOperation content: application/json: schema: $ref: "#/components/schemas/UnauthorizedOperation" examples: PutResourceAttributes485Example: summary: Default PutResourceAttributes 485 response x-microcks-default: true value: {} "486": description: InvalidInputException content: application/json: schema: $ref: "#/components/schemas/InvalidInputException" examples: PutResourceAttributes486Example: summary: Default PutResourceAttributes 486 response x-microcks-default: true value: {} "487": description: ResourceNotFoundException content: application/json: schema: $ref: "#/components/schemas/ResourceNotFoundException" examples: PutResourceAttributes487Example: summary: Default PutResourceAttributes 487 response x-microcks-default: true value: {} "488": description: HomeRegionNotSetException content: application/json: schema: $ref: "#/components/schemas/HomeRegionNotSetException" examples: PutResourceAttributes488Example: summary: Default PutResourceAttributes 488 response x-microcks-default: true value: {} requestBody: required: true content: application/json: schema: $ref: "#/components/schemas/PutResourceAttributesRequest" parameters: - name: X-Amz-Target in: header required: true schema: type: string enum: - AWSMigrationHub.PutResourceAttributes summary: Amazon Migration Hub Put Resource Attributes 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" components: parameters: X-Amz-Content-Sha256: name: X-Amz-Content-Sha256 in: header schema: type: string required: false X-Amz-Date: name: X-Amz-Date in: header schema: type: string required: false X-Amz-Algorithm: name: X-Amz-Algorithm in: header schema: type: string required: false X-Amz-Credential: name: X-Amz-Credential in: header schema: type: string required: false X-Amz-Security-Token: name: X-Amz-Security-Token in: header schema: type: string required: false X-Amz-Signature: name: X-Amz-Signature in: header schema: type: string required: false X-Amz-SignedHeaders: name: X-Amz-SignedHeaders in: header schema: type: string required: false securitySchemes: hmac: type: apiKey name: Authorization in: header description: Amazon Signature authorization v4 x-amazon-apigateway-authtype: awsSigv4 schemas: AssociateCreatedArtifactResult: type: object properties: {} AssociateCreatedArtifactRequest: type: object required: - ProgressUpdateStream - MigrationTaskName - CreatedArtifact title: AssociateCreatedArtifactRequest properties: ProgressUpdateStream: allOf: - $ref: "#/components/schemas/ProgressUpdateStream" - description: "The name of the ProgressUpdateStream. " MigrationTaskName: allOf: - $ref: "#/components/schemas/MigrationTaskName" - description: "Unique identifier that references the migration task. Do not store personal data in this field. " CreatedArtifact: allOf: - $ref: "#/components/schemas/CreatedArtifact" - description: "An ARN of the AWS resource related to the migration (e.g., AMI, EC2 instance, RDS instance, etc.) " DryRun: allOf: - $ref: "#/components/schemas/DryRun" - description: Optional boolean flag to indicate whether any effect should take place. Used to test if the caller has permission to make the call. AccessDeniedException: {} ThrottlingException: {} InternalServerError: {} ServiceUnavailableException: {} DryRunOperation: {} UnauthorizedOperation: {} InvalidInputException: {} ResourceNotFoundException: {} HomeRegionNotSetException: {} AssociateDiscoveredResourceResult: type: object properties: {} AssociateDiscoveredResourceRequest: type: object required: - ProgressUpdateStream - MigrationTaskName - DiscoveredResource title: AssociateDiscoveredResourceRequest properties: ProgressUpdateStream: allOf: - $ref: "#/components/schemas/ProgressUpdateStream" - description: The name of the ProgressUpdateStream. MigrationTaskName: allOf: - $ref: "#/components/schemas/MigrationTaskName" - description: "The identifier given to the MigrationTask. Do not store personal data in this field. " DiscoveredResource: allOf: - $ref: "#/components/schemas/DiscoveredResource" - description: Object representing a Resource. DryRun: allOf: - $ref: "#/components/schemas/DryRun" - description: Optional boolean flag to indicate whether any effect should take place. Used to test if the caller has permission to make the call. PolicyErrorException: {} CreateProgressUpdateStreamResult: type: object properties: {} CreateProgressUpdateStreamRequest: type: object required: - ProgressUpdateStreamName title: CreateProgressUpdateStreamRequest properties: ProgressUpdateStreamName: allOf: - $ref: "#/components/schemas/ProgressUpdateStream" - description: "The name of the ProgressUpdateStream. Do not store personal data in this field. " DryRun: allOf: - $ref: "#/components/schemas/DryRun" - description: Optional boolean flag to indicate whether any effect should take place. Used to test if the caller has permission to make the call. DeleteProgressUpdateStreamResult: type: object properties: {} DeleteProgressUpdateStreamRequest: type: object required: - ProgressUpdateStreamName title: DeleteProgressUpdateStreamRequest properties: ProgressUpdateStreamName: allOf: - $ref: "#/components/schemas/ProgressUpdateStream" - description: "The name of the ProgressUpdateStream. Do not store personal data in this field. " DryRun: allOf: - $ref: "#/components/schemas/DryRun" - description: Optional boolean flag to indicate whether any effect should take place. Used to test if the caller has permission to make the call. DescribeApplicationStateResult: type: object properties: ApplicationStatus: allOf: - $ref: "#/components/schemas/ApplicationStatus" - description: Status of the application - Not Started, In-Progress, Complete. LastUpdatedTime: allOf: - $ref: "#/components/schemas/UpdateDateTime" - description: The timestamp when the application status was last updated. DescribeApplicationStateRequest: type: object required: - ApplicationId title: DescribeApplicationStateRequest properties: ApplicationId: allOf: - $ref: "#/components/schemas/ApplicationId" - description: The configurationId in Application Discovery Service that uniquely identifies the grouped application. DescribeMigrationTaskResult: type: object properties: MigrationTask: allOf: - $ref: "#/components/schemas/MigrationTask" - description: Object encapsulating information about the migration task. DescribeMigrationTaskRequest: type: object required: - ProgressUpdateStream - MigrationTaskName title: DescribeMigrationTaskRequest properties: ProgressUpdateStream: allOf: - $ref: "#/components/schemas/ProgressUpdateStream" - description: "The name of the ProgressUpdateStream. " MigrationTaskName: allOf: - $ref: "#/components/schemas/MigrationTaskName" - description: "The identifier given to the MigrationTask. Do not store personal data in this field. " DisassociateCreatedArtifactResult: type: object properties: {} DisassociateCreatedArtifactRequest: type: object required: - ProgressUpdateStream - MigrationTaskName - CreatedArtifactName title: DisassociateCreatedArtifactRequest properties: ProgressUpdateStream: allOf: - $ref: "#/components/schemas/ProgressUpdateStream" - description: "The name of the ProgressUpdateStream. " MigrationTaskName: allOf: - $ref: "#/components/schemas/MigrationTaskName" - description: "Unique identifier that references the migration task to be disassociated with the artifact. Do not store personal data in this field. " CreatedArtifactName: allOf: - $ref: "#/components/schemas/CreatedArtifactName" - description: An ARN of the AWS resource related to the migration (e.g., AMI, EC2 instance, RDS instance, etc.) DryRun: allOf: - $ref: "#/components/schemas/DryRun" - description: Optional boolean flag to indicate whether any effect should take place. Used to test if the caller has permission to make the call. DisassociateDiscoveredResourceResult: type: object properties: {} DisassociateDiscoveredResourceRequest: type: object required: - ProgressUpdateStream - MigrationTaskName - ConfigurationId title: DisassociateDiscoveredResourceRequest properties: ProgressUpdateStream: allOf: - $ref: "#/components/schemas/ProgressUpdateStream" - description: The name of the ProgressUpdateStream. MigrationTaskName: allOf: - $ref: "#/components/schemas/MigrationTaskName" - description: "The identifier given to the MigrationTask. Do not store personal data in this field. " ConfigurationId: allOf: - $ref: "#/components/schemas/ConfigurationId" - description: ConfigurationId of the Application Discovery Service resource to be disassociated. DryRun: allOf: - $ref: "#/components/schemas/DryRun" - description: Optional boolean flag to indicate whether any effect should take place. Used to test if the caller has permission to make the call. ImportMigrationTaskResult: type: object properties: {} ImportMigrationTaskRequest: type: object required: - ProgressUpdateStream - MigrationTaskName title: ImportMigrationTaskRequest properties: ProgressUpdateStream: allOf: - $ref: "#/components/schemas/ProgressUpdateStream" - description: The name of the ProgressUpdateStream. > MigrationTaskName: allOf: - $ref: "#/components/schemas/MigrationTaskName" - description: "Unique identifier that references the migration task. Do not store personal data in this field. " DryRun: allOf: - $ref: "#/components/schemas/DryRun" - description: Optional boolean flag to indicate whether any effect should take place. Used to test if the caller has permission to make the call. ListApplicationStatesResult: type: object properties: ApplicationStateList: allOf: - $ref: "#/components/schemas/ApplicationStateList" - description: A list of Applications that exist in Application Discovery Service. NextToken: allOf: - $ref: "#/components/schemas/Token" - description: If a NextToken was returned by a previous call, there are more results available. To retrieve the next page of results, make the call again using the returned token in NextToken. ListApplicationStatesRequest: type: object title: ListApplicationStatesRequest properties: ApplicationIds: allOf: - $ref: "#/components/schemas/ApplicationIds" - description: The configurationIds from the Application Discovery Service that uniquely identifies your applications. NextToken: allOf: - $ref: "#/components/schemas/Token" - description: If a NextToken was returned by a previous call, there are more results available. To retrieve the next page of results, make the call again using the returned token in NextToken. MaxResults: allOf: - $ref: "#/components/schemas/MaxResults" - description: Maximum number of results to be returned per page. ListCreatedArtifactsResult: type: object properties: NextToken: allOf: - $ref: "#/components/schemas/Token" - description: If there are more created artifacts than the max result, return the next token to be passed to the next call as a bookmark of where to start from. CreatedArtifactList: allOf: - $ref: "#/components/schemas/CreatedArtifactList" - description: List of created artifacts up to the maximum number of results specified in the request. ListCreatedArtifactsRequest: type: object required: - ProgressUpdateStream - MigrationTaskName title: ListCreatedArtifactsRequest properties: ProgressUpdateStream: allOf: - $ref: "#/components/schemas/ProgressUpdateStream" - description: "The name of the ProgressUpdateStream. " MigrationTaskName: allOf: - $ref: "#/components/schemas/MigrationTaskName" - description: "Unique identifier that references the migration task. Do not store personal data in this field. " NextToken: allOf: - $ref: "#/components/schemas/Token" - description: If a NextToken was returned by a previous call, there are more results available. To retrieve the next page of results, make the call again using the returned token in NextToken. MaxResults: allOf: - $ref: "#/components/schemas/MaxResultsCreatedArtifacts" - description: Maximum number of results to be returned per page. ListDiscoveredResourcesResult: type: object properties: NextToken: allOf: - $ref: "#/components/schemas/Token" - description: If there are more discovered resources than the max result, return the next token to be passed to the next call as a bookmark of where to start from. DiscoveredResourceList: allOf: - $ref: "#/components/schemas/DiscoveredResourceList" - description: Returned list of discovered resources associated with the given MigrationTask. ListDiscoveredResourcesRequest: type: object required: - ProgressUpdateStream - MigrationTaskName title: ListDiscoveredResourcesRequest properties: ProgressUpdateStream: allOf: - $ref: "#/components/schemas/ProgressUpdateStream" - description: The name of the ProgressUpdateStream. MigrationTaskName: allOf: - $ref: "#/components/schemas/MigrationTaskName" - description: "The name of the MigrationTask. Do not store personal data in this field. " NextToken: allOf: - $ref: "#/components/schemas/Token" - description: If a NextToken was returned by a previous call, there are more results available. To retrieve the next page of results, make the call again using the returned token in NextToken. MaxResults: allOf: - $ref: "#/components/schemas/MaxResultsResources" - description: The maximum number of results returned per page. ListMigrationTasksResult: type: object properties: NextToken: allOf: - $ref: "#/components/schemas/Token" - description: If there are more migration tasks than the max result, return the next token to be passed to the next call as a bookmark of where to start from. MigrationTaskSummaryList: allOf: - $ref: "#/components/schemas/MigrationTaskSummaryList" - description: "Lists the migration task's summary which includes: MigrationTaskName, ProgressPercent, ProgressUpdateStream, Status, and the UpdateDateTime for each task." ListMigrationTasksRequest: type: object title: ListMigrationTasksRequest properties: NextToken: allOf: - $ref: "#/components/schemas/Token" - description: If a NextToken was returned by a previous call, there are more results available. To retrieve the next page of results, make the call again using the returned token in NextToken. MaxResults: allOf: - $ref: "#/components/schemas/MaxResults" - description: Value to specify how many results are returned per page. ResourceName: allOf: - $ref: "#/components/schemas/ResourceName" - description: Filter migration tasks by discovered resource name. ListProgressUpdateStreamsResult: type: object properties: ProgressUpdateStreamSummaryList: allOf: - $ref: "#/components/schemas/ProgressUpdateStreamSummaryList" - description: List of progress update streams up to the max number of results passed in the input. NextToken: allOf: - $ref: "#/components/schemas/Token" - description: If there are more streams created than the max result, return the next token to be passed to the next call as a bookmark of where to start from. ListProgressUpdateStreamsRequest: type: object title: ListProgressUpdateStreamsRequest properties: NextToken: allOf: - $ref: "#/components/schemas/Token" - description: If a NextToken was returned by a previous call, there are more results available. To retrieve the next page of results, make the call again using the returned token in NextToken. MaxResults: allOf: - $ref: "#/components/schemas/MaxResults" - description: Filter to limit the maximum number of results to list per page. NotifyApplicationStateResult: type: object properties: {} NotifyApplicationStateRequest: type: object required: - ApplicationId - Status title: NotifyApplicationStateRequest properties: ApplicationId: allOf: - $ref: "#/components/schemas/ApplicationId" - description: The configurationId in Application Discovery Service that uniquely identifies the grouped application. Status: allOf: - $ref: "#/components/schemas/ApplicationStatus" - description: Status of the application - Not Started, In-Progress, Complete. UpdateDateTime: allOf: - $ref: "#/components/schemas/UpdateDateTime" - description: The timestamp when the application state changed. DryRun: allOf: - $ref: "#/components/schemas/DryRun" - description: Optional boolean flag to indicate whether any effect should take place. Used to test if the caller has permission to make the call. NotifyMigrationTaskStateResult: type: object properties: {} NotifyMigrationTaskStateRequest: type: object required: - ProgressUpdateStream - MigrationTaskName - Task - UpdateDateTime - NextUpdateSeconds title: NotifyMigrationTaskStateRequest properties: ProgressUpdateStream: allOf: - $ref: "#/components/schemas/ProgressUpdateStream" - description: "The name of the ProgressUpdateStream. " MigrationTaskName: allOf: - $ref: "#/components/schemas/MigrationTaskName" - description: "Unique identifier that references the migration task. Do not store personal data in this field. " Task: allOf: - $ref: "#/components/schemas/Task" - description: Information about the task's progress and status. UpdateDateTime: allOf: - $ref: "#/components/schemas/UpdateDateTime" - description: The timestamp when the task was gathered. NextUpdateSeconds: allOf: - $ref: "#/components/schemas/NextUpdateSeconds" - description: Number of seconds after the UpdateDateTime within which the Migration Hub can expect an update. If Migration Hub does not receive an update within the specified interval, then the migration task will be considered stale. DryRun: allOf: - $ref: "#/components/schemas/DryRun" - description: Optional boolean flag to indicate whether any effect should take place. Used to test if the caller has permission to make the call. PutResourceAttributesResult: type: object properties: {} PutResourceAttributesRequest: type: object required: - ProgressUpdateStream - MigrationTaskName - ResourceAttributeList title: PutResourceAttributesRequest properties: ProgressUpdateStream: allOf: - $ref: "#/components/schemas/ProgressUpdateStream" - description: "The name of the ProgressUpdateStream. " MigrationTaskName: allOf: - $ref: "#/components/schemas/MigrationTaskName" - description: "Unique identifier that references the migration task. Do not store personal data in this field. " ResourceAttributeList: allOf: - $ref: "#/components/schemas/ResourceAttributeList" - description: '

Information about the resource that is being migrated. This data will be used to map the task to a resource in the Application Discovery Service repository.

If any "VM" related value is set for a ResourceAttribute object, it is required that VM_MANAGER_ID, as a minimum, is always set. If VM_MANAGER_ID is not set, then all "VM" fields will be discarded and "VM" fields will not be used for matching the migration task to a server in Application Discovery Service repository. See the Example section below for a use case of specifying "VM" related values.
If a server you are trying to match has multiple IP or MAC addresses, you should provide as many as you know in separate type/value pairs passed to the ResourceAttributeList parameter to maximize the chances of matching.

' DryRun: allOf: - $ref: "#/components/schemas/DryRun" - description: Optional boolean flag to indicate whether any effect should take place. Used to test if the caller has permission to make the call. ApplicationId: type: string pattern: ^.{1,1600}$ minLength: 1 maxLength: 1600 ApplicationIds: type: array items: $ref: "#/components/schemas/ApplicationId" minItems: 1 maxItems: 100 ApplicationStatus: type: string enum: - NOT_STARTED - IN_PROGRESS - COMPLETED UpdateDateTime: type: string format: date-time ApplicationState: type: object properties: ApplicationId: allOf: - $ref: "#/components/schemas/ApplicationId" - description: The configurationId from the Application Discovery Service that uniquely identifies an application. ApplicationStatus: allOf: - $ref: "#/components/schemas/ApplicationStatus" - description: The current status of an application. LastUpdatedTime: allOf: - $ref: "#/components/schemas/UpdateDateTime" - description: The timestamp when the application status was last updated. description: The state of an application discovered through Migration Hub import, the AWS Agentless Discovery Connector, or the AWS Application Discovery Agent. ApplicationStateList: type: array items: $ref: "#/components/schemas/ApplicationState" minItems: 0 maxItems: 1000 ProgressUpdateStream: type: string pattern: "[^/:|\\000-\\037]+" minLength: 1 maxLength: 50 MigrationTaskName: type: string pattern: "[^:|]+" minLength: 1 maxLength: 256 CreatedArtifact: type: object required: - Name properties: Name: allOf: - $ref: "#/components/schemas/CreatedArtifactName" - description: An ARN that uniquely identifies the result of a migration task. Description: allOf: - $ref: "#/components/schemas/CreatedArtifactDescription" - description: A description that can be free-form text to record additional detail about the artifact for clarity or for later reference. description: An ARN of the AWS cloud resource target receiving the migration (e.g., AMI, EC2 instance, RDS instance, etc.). DryRun: type: boolean DiscoveredResource: type: object required: - ConfigurationId properties: ConfigurationId: allOf: - $ref: "#/components/schemas/ConfigurationId" - description: The configurationId in Application Discovery Service that uniquely identifies the on-premise resource. Description: allOf: - $ref: "#/components/schemas/DiscoveredResourceDescription" - description: A description that can be free-form text to record additional detail about the discovered resource for clarity or later reference. description: Object representing the on-premises resource being migrated. ConfigurationId: type: string pattern: ^.{1,1600}$ minLength: 1 maxLength: 1600 CreatedArtifactName: type: string pattern: arn:[a-z-]+:[a-z0-9-]+:(?:[a-z0-9-]+|):(?:[0-9]{12}|):.* minLength: 1 maxLength: 1600 CreatedArtifactDescription: type: string pattern: ^.{0,500}$ minLength: 0 maxLength: 500 CreatedArtifactList: type: array items: $ref: "#/components/schemas/CreatedArtifact" MigrationTask: type: object properties: ProgressUpdateStream: allOf: - $ref: "#/components/schemas/ProgressUpdateStream" - description: A name that identifies the vendor of the migration tool being used. MigrationTaskName: allOf: - $ref: "#/components/schemas/MigrationTaskName" - description: "Unique identifier that references the migration task. Do not store personal data in this field. " Task: allOf: - $ref: "#/components/schemas/Task" - description: Task object encapsulating task information. UpdateDateTime: allOf: - $ref: "#/components/schemas/UpdateDateTime" - description: The timestamp when the task was gathered. ResourceAttributeList: allOf: - $ref: "#/components/schemas/LatestResourceAttributeList" - description: Information about the resource that is being migrated. This data will be used to map the task to a resource in the Application Discovery Service repository. description: Represents a migration task in a migration tool. DiscoveredResourceDescription: type: string pattern: ^.{0,500}$ minLength: 0 maxLength: 500 DiscoveredResourceList: type: array items: $ref: "#/components/schemas/DiscoveredResource" ResourceAttribute: type: object required: - Type - Value properties: Type: allOf: - $ref: "#/components/schemas/ResourceAttributeType" - description: Type of resource. Value: allOf: - $ref: "#/components/schemas/ResourceAttributeValue" - description: Value of the resource type. description: "

Attribute associated with a resource.

Note the corresponding format required per type listed below:

IPV4

x.x.x.x

where x is an integer in the range [0,255]

IPV6

y : y : y : y : y : y : y : y

where y is a hexadecimal between 0 and FFFF. [0, FFFF]

MAC_ADDRESS

^([0-9A-Fa-f]{2}[:-]){5}([0-9A-Fa-f]{2})$

FQDN

^[^<>{}\\\\\\\\/?,=\\\\p{Cntrl}]{1,256}$

" LatestResourceAttributeList: type: array items: $ref: "#/components/schemas/ResourceAttribute" minItems: 0 maxItems: 100 Token: type: string pattern: ^[a-zA-Z0-9\/\+\=]{0,2048}$ minLength: 0 maxLength: 2048 MaxResults: type: integer minimum: 1 maximum: 100 MaxResultsCreatedArtifacts: type: integer minimum: 1 maximum: 10 MaxResultsResources: type: integer minimum: 1 maximum: 10 ResourceName: type: string pattern: ^.{1,1600}$ minLength: 1 maxLength: 1600 MigrationTaskSummaryList: type: array items: $ref: "#/components/schemas/MigrationTaskSummary" ProgressUpdateStreamSummaryList: type: array items: $ref: "#/components/schemas/ProgressUpdateStreamSummary" Task: type: object required: - Status properties: Status: allOf: - $ref: "#/components/schemas/Status" - description: Status of the task - Not Started, In-Progress, Complete. StatusDetail: allOf: - $ref: "#/components/schemas/StatusDetail" - description: Details of task status as notified by a migration tool. A tool might use this field to provide clarifying information about the status that is unique to that tool or that explains an error state. ProgressPercent: allOf: - $ref: "#/components/schemas/ProgressPercent" - description: Indication of the percentage completion of the task. description: Task object encapsulating task information. Status: type: string enum: - NOT_STARTED - IN_PROGRESS - FAILED - COMPLETED ProgressPercent: type: integer minimum: 0 maximum: 100 StatusDetail: type: string pattern: ^.{0,500}$ minLength: 0 maxLength: 500 MigrationTaskSummary: type: object properties: ProgressUpdateStream: allOf: - $ref: "#/components/schemas/ProgressUpdateStream" - description: An AWS resource used for access control. It should uniquely identify the migration tool as it is used for all updates made by the tool. MigrationTaskName: allOf: - $ref: "#/components/schemas/MigrationTaskName" - description: "Unique identifier that references the migration task. Do not store personal data in this field. " Status: allOf: - $ref: "#/components/schemas/Status" - description: Status of the task. ProgressPercent: allOf: - $ref: "#/components/schemas/ProgressPercent" - description: Indication of the percentage completion of the task. StatusDetail: allOf: - $ref: "#/components/schemas/StatusDetail" - description: Detail information of what is being done within the overall status state. UpdateDateTime: allOf: - $ref: "#/components/schemas/UpdateDateTime" - description: The timestamp when the task was gathered. description: MigrationTaskSummary includes MigrationTaskName, ProgressPercent, ProgressUpdateStream, Status, and UpdateDateTime for each task. NextUpdateSeconds: type: integer minimum: 0 ProgressUpdateStreamSummary: type: object properties: ProgressUpdateStreamName: allOf: - $ref: "#/components/schemas/ProgressUpdateStream" - description: "The name of the ProgressUpdateStream. Do not store personal data in this field. " description: Summary of the AWS resource used for access control that is implicitly linked to your AWS account. ResourceAttributeList: type: array items: $ref: "#/components/schemas/ResourceAttribute" minItems: 1 maxItems: 100 ResourceAttributeType: type: string enum: - IPV4_ADDRESS - IPV6_ADDRESS - MAC_ADDRESS - FQDN - VM_MANAGER_ID - VM_MANAGED_OBJECT_REFERENCE - VM_NAME - VM_PATH - BIOS_ID - MOTHERBOARD_SERIAL_NUMBER ResourceAttributeValue: type: string pattern: ^.{1,256}$ minLength: 1 maxLength: 256 security: - hmac: []