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.

Implementation for accessing MigrationHub

Inheritance Hierarchy

System.Object
  Amazon.Runtime.AmazonServiceClient
    Amazon.MigrationHub.AmazonMigrationHubClient

Namespace: Amazon.MigrationHub
Assembly: AWSSDK.MigrationHub.dll
Version: 3.x.y.z

Syntax

C#
public class AmazonMigrationHubClient : AmazonServiceClient
         IAmazonMigrationHub, IAmazonService, IDisposable

The AmazonMigrationHubClient type exposes the following members

Constructors

NameDescription
Public Method AmazonMigrationHubClient()

Constructs AmazonMigrationHubClient with the credentials loaded from the application's default configuration, and if unsuccessful from the Instance Profile service on an EC2 instance. Example App.config with credentials set.



    
        
    

             

Public Method AmazonMigrationHubClient(RegionEndpoint)

Constructs AmazonMigrationHubClient with the credentials loaded from the application's default configuration, and if unsuccessful from the Instance Profile service on an EC2 instance. Example App.config with credentials set.



    
        
    

             

Public Method AmazonMigrationHubClient(AmazonMigrationHubConfig)

Constructs AmazonMigrationHubClient with the credentials loaded from the application's default configuration, and if unsuccessful from the Instance Profile service on an EC2 instance. Example App.config with credentials set.



    
        
    

             

Public Method AmazonMigrationHubClient(AWSCredentials)

Constructs AmazonMigrationHubClient with AWS Credentials

Public Method AmazonMigrationHubClient(AWSCredentials, RegionEndpoint)

Constructs AmazonMigrationHubClient with AWS Credentials

Public Method AmazonMigrationHubClient(AWSCredentials, AmazonMigrationHubConfig)

Constructs AmazonMigrationHubClient with AWS Credentials and an AmazonMigrationHubClient Configuration object.

Public Method AmazonMigrationHubClient(string, string)

Constructs AmazonMigrationHubClient with AWS Access Key ID and AWS Secret Key

Public Method AmazonMigrationHubClient(string, string, RegionEndpoint)

Constructs AmazonMigrationHubClient with AWS Access Key ID and AWS Secret Key

Public Method AmazonMigrationHubClient(string, string, AmazonMigrationHubConfig)

Constructs AmazonMigrationHubClient with AWS Access Key ID, AWS Secret Key and an AmazonMigrationHubClient Configuration object.

Public Method AmazonMigrationHubClient(string, string, string)

Constructs AmazonMigrationHubClient with AWS Access Key ID and AWS Secret Key

Public Method AmazonMigrationHubClient(string, string, string, RegionEndpoint)

Constructs AmazonMigrationHubClient with AWS Access Key ID and AWS Secret Key

Public Method AmazonMigrationHubClient(string, string, string, AmazonMigrationHubConfig)

Constructs AmazonMigrationHubClient with AWS Access Key ID, AWS Secret Key and an AmazonMigrationHubClient Configuration object.

Properties

NameTypeDescription
Public Property Config Amazon.Runtime.IClientConfig Inherited from Amazon.Runtime.AmazonServiceClient.

Methods

Note:

Asynchronous operations (methods ending with Async) in the table below are for .NET 4.5 or higher. For .NET 3.5 the SDK follows the standard naming convention of BeginMethodName and EndMethodName to indicate asynchronous operations - these method pairs are not shown in the table below.

NameDescription
Public Method AssociateCreatedArtifact(AssociateCreatedArtifactRequest)

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.

Public Method AssociateCreatedArtifactAsync(AssociateCreatedArtifactRequest, CancellationToken)

Initiates the asynchronous execution of the AssociateCreatedArtifact operation.

Public Method AssociateDiscoveredResource(AssociateDiscoveredResourceRequest)

Associates a discovered resource ID from Application Discovery Service (ADS) with a migration task.

Public Method AssociateDiscoveredResourceAsync(AssociateDiscoveredResourceRequest, CancellationToken)

Initiates the asynchronous execution of the AssociateDiscoveredResource operation.

Public Method CreateProgressUpdateStream(CreateProgressUpdateStreamRequest)

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.

Public Method CreateProgressUpdateStreamAsync(CreateProgressUpdateStreamRequest, CancellationToken)

Initiates the asynchronous execution of the CreateProgressUpdateStream operation.

Public Method DeleteProgressUpdateStream(DeleteProgressUpdateStreamRequest)

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

Public Method DeleteProgressUpdateStreamAsync(DeleteProgressUpdateStreamRequest, CancellationToken)

Initiates the asynchronous execution of the DeleteProgressUpdateStream operation.

Public Method DescribeApplicationState(DescribeApplicationStateRequest)

Gets the migration status of an application.

Public Method DescribeApplicationStateAsync(DescribeApplicationStateRequest, CancellationToken)

Initiates the asynchronous execution of the DescribeApplicationState operation.

Public Method DescribeMigrationTask(DescribeMigrationTaskRequest)

Retrieves a list of all attributes associated with a specific migration task.

Public Method DescribeMigrationTaskAsync(DescribeMigrationTaskRequest, CancellationToken)

Initiates the asynchronous execution of the DescribeMigrationTask operation.

Public Method DisassociateCreatedArtifact(DisassociateCreatedArtifactRequest)

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.

Public Method DisassociateCreatedArtifactAsync(DisassociateCreatedArtifactRequest, CancellationToken)

Initiates the asynchronous execution of the DisassociateCreatedArtifact operation.

Public Method DisassociateDiscoveredResource(DisassociateDiscoveredResourceRequest)

Disassociate an Application Discovery Service (ADS) discovered resource from a migration task.

Public Method DisassociateDiscoveredResourceAsync(DisassociateDiscoveredResourceRequest, CancellationToken)

Initiates the asynchronous execution of the DisassociateDiscoveredResource operation.

Public Method Dispose() Inherited from Amazon.Runtime.AmazonServiceClient.
Public Method ImportMigrationTask(ImportMigrationTaskRequest)

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.

Public Method ImportMigrationTaskAsync(ImportMigrationTaskRequest, CancellationToken)

Initiates the asynchronous execution of the ImportMigrationTask operation.

Public Method ListCreatedArtifacts(ListCreatedArtifactsRequest)

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.

Public Method ListCreatedArtifactsAsync(ListCreatedArtifactsRequest, CancellationToken)

Initiates the asynchronous execution of the ListCreatedArtifacts operation.

Public Method ListDiscoveredResources(ListDiscoveredResourcesRequest)

Lists discovered resources associated with the given MigrationTask.

Public Method ListDiscoveredResourcesAsync(ListDiscoveredResourcesRequest, CancellationToken)

Initiates the asynchronous execution of the ListDiscoveredResources operation.

Public Method ListMigrationTasks(ListMigrationTasksRequest)

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.

Public Method ListMigrationTasksAsync(ListMigrationTasksRequest, CancellationToken)

Initiates the asynchronous execution of the ListMigrationTasks operation.

Public Method ListProgressUpdateStreams(ListProgressUpdateStreamsRequest)

Lists progress update streams associated with the user account making this call.

Public Method ListProgressUpdateStreamsAsync(ListProgressUpdateStreamsRequest, CancellationToken)

Initiates the asynchronous execution of the ListProgressUpdateStreams operation.

Public Method NotifyApplicationState(NotifyApplicationStateRequest)

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.

Public Method NotifyApplicationStateAsync(NotifyApplicationStateRequest, CancellationToken)

Initiates the asynchronous execution of the NotifyApplicationState operation.

Public Method NotifyMigrationTaskState(NotifyMigrationTaskStateRequest)

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.

Public Method NotifyMigrationTaskStateAsync(NotifyMigrationTaskStateRequest, CancellationToken)

Initiates the asynchronous execution of the NotifyMigrationTaskState operation.

Public Method PutResourceAttributes(PutResourceAttributesRequest)

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.

Public Method PutResourceAttributesAsync(PutResourceAttributesRequest, CancellationToken)

Initiates the asynchronous execution of the PutResourceAttributes operation.

Events

NameDescription
Event AfterResponseEvent Inherited from Amazon.Runtime.AmazonServiceClient.
Event BeforeRequestEvent Inherited from Amazon.Runtime.AmazonServiceClient.
Event ExceptionEvent Inherited from Amazon.Runtime.AmazonServiceClient.

Version Information

.NET Standard:
Supported in: 1.3

.NET Framework:
Supported in: 4.5, 4.0, 3.5

Portable Class Library:
Supported in: Windows Store Apps
Supported in: Windows Phone 8.1
Supported in: Xamarin Android
Supported in: Xamarin iOS (Unified)
Supported in: Xamarin.Forms