AWS SDK Version 3 for .NET
API Reference

AWS services or capabilities described in AWS Documentation may vary by region/location. Click Getting Started with Amazon AWS to see specific differences applicable to the China (Beijing) Region.

Classes

NameDescription
Class AccessDeniedException

MigrationHub exception

Class AssociateCreatedArtifactRequest

Container for the parameters to the AssociateCreatedArtifact operation. 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.

Class AssociateCreatedArtifactResponse

This is the response object from the AssociateCreatedArtifact operation.

Class AssociateDiscoveredResourceRequest

Container for the parameters to the AssociateDiscoveredResource operation. Associates a discovered resource ID from Application Discovery Service (ADS) with a migration task.

Class AssociateDiscoveredResourceResponse

This is the response object from the AssociateDiscoveredResource operation.

Class CreatedArtifact

An ARN of the AWS cloud resource target receiving the migration (e.g., AMI, EC2 instance, RDS instance, etc.).

Class CreateProgressUpdateStreamRequest

Container for the parameters to the CreateProgressUpdateStream operation. 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.

Class CreateProgressUpdateStreamResponse

This is the response object from the CreateProgressUpdateStream operation.

Class DeleteProgressUpdateStreamRequest

Container for the parameters to the DeleteProgressUpdateStream operation. 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 be doing the actual delete of 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 realted 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).

Class DeleteProgressUpdateStreamResponse

This is the response object from the DeleteProgressUpdateStream operation.

Class DescribeApplicationStateRequest

Container for the parameters to the DescribeApplicationState operation. Gets the migration status of an application.

Class DescribeApplicationStateResponse

This is the response object from the DescribeApplicationState operation.

Class DescribeMigrationTaskRequest

Container for the parameters to the DescribeMigrationTask operation. Retrieves a list of all attributes associated with a specific migration task.

Class DescribeMigrationTaskResponse

This is the response object from the DescribeMigrationTask operation.

Class DisassociateCreatedArtifactRequest

Container for the parameters to the DisassociateCreatedArtifact operation. 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.

Class DisassociateCreatedArtifactResponse

This is the response object from the DisassociateCreatedArtifact operation.

Class DisassociateDiscoveredResourceRequest

Container for the parameters to the DisassociateDiscoveredResource operation. Disassociate an Application Discovery Service (ADS) discovered resource from a migration task.

Class DisassociateDiscoveredResourceResponse

This is the response object from the DisassociateDiscoveredResource operation.

Class DiscoveredResource

Object representing the on-premises resource being migrated.

Class DryRunOperationException

MigrationHub exception

Class ImportMigrationTaskRequest

Container for the parameters to the ImportMigrationTask operation. 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.

Class ImportMigrationTaskResponse

This is the response object from the ImportMigrationTask operation.

Class InternalServerErrorException

MigrationHub exception

Class InvalidInputException

MigrationHub exception

Class ListCreatedArtifactsRequest

Container for the parameters to the ListCreatedArtifacts operation. 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.

Class ListCreatedArtifactsResponse

This is the response object from the ListCreatedArtifacts operation.

Class ListDiscoveredResourcesRequest

Container for the parameters to the ListDiscoveredResources operation. Lists discovered resources associated with the given MigrationTask.

Class ListDiscoveredResourcesResponse

This is the response object from the ListDiscoveredResources operation.

Class ListMigrationTasksRequest

Container for the parameters to the ListMigrationTasks operation. 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.

Class ListMigrationTasksResponse

This is the response object from the ListMigrationTasks operation.

Class ListProgressUpdateStreamsRequest

Container for the parameters to the ListProgressUpdateStreams operation. Lists progress update streams associated with the user account making this call.

Class ListProgressUpdateStreamsResponse

This is the response object from the ListProgressUpdateStreams operation.

Class MigrationTask

Represents a migration task in a migration tool.

Class MigrationTaskSummary

MigrationTaskSummary includes MigrationTaskName, ProgressPercent, ProgressUpdateStream, Status, and UpdateDateTime for each task.

Class NotifyApplicationStateRequest

Container for the parameters to the NotifyApplicationState operation. 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.

Class NotifyApplicationStateResponse

This is the response object from the NotifyApplicationState operation.

Class NotifyMigrationTaskStateRequest

Container for the parameters to the NotifyMigrationTaskState operation. 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.

Class NotifyMigrationTaskStateResponse

This is the response object from the NotifyMigrationTaskState operation.

Class PolicyErrorException

MigrationHub exception

Class ProgressUpdateStreamSummary

Summary of the AWS resource used for access control that is implicitly linked to your AWS account.

Class PutResourceAttributesRequest

Container for the parameters to the PutResourceAttributes operation. Provides identifying details of the resource being migrated so that it can be associated in the Application Discovery Service (ADS)'s 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 overiding the MAC address.

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 ListAssociatedResource.

Class PutResourceAttributesResponse

This is the response object from the PutResourceAttributes operation.

Class ResourceAttribute

Attribute associated with a resource.

Class ResourceNotFoundException

MigrationHub exception

Class ServiceUnavailableException

MigrationHub exception

Class Task

Task object encapsulating task information.

Class UnauthorizedOperationException

MigrationHub exception