JavaScript is disabled on your browser.
Skip navigation links

AWS SDK for Java 1.x API Reference - 1.12.793

We announced the upcoming end-of-support for AWS SDK for Java (v1). We recommend that you migrate to AWS SDK for Java v2. For dates, additional details, and information on how to migrate, please refer to the linked announcement.
  • Summary:
  • Nested |
  • Field |
  • Constr |
  • Method
  • Detail:
  • Field |
  • Constr |
  • Method
com.amazonaws.services.migrationhub

Interface AWSMigrationHubAsync

  • All Superinterfaces:
    AWSMigrationHub
    All Known Implementing Classes:
    AbstractAWSMigrationHubAsync, AWSMigrationHubAsyncClient


    @Generated(value="com.amazonaws:aws-java-sdk-code-generator")
    public interface AWSMigrationHubAsync
    extends AWSMigrationHub 
    Interface for accessing AWS Migration Hub asynchronously. Each asynchronous method will return a Java Future object representing the asynchronous operation; overloads which accept an AsyncHandler can be used to receive notification when an asynchronous operation completes.

    Note: Do not directly implement this interface, new methods are added to it regularly. Extend from AbstractAWSMigrationHubAsync instead.

    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.

    • Method Detail

      • associateCreatedArtifactAsync

        Future<AssociateCreatedArtifactResult> associateCreatedArtifactAsync(AssociateCreatedArtifactRequest 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.

        Parameters:
        associateCreatedArtifactRequest -
        Returns:
        A Java Future containing the result of the AssociateCreatedArtifact operation returned by the service.
        See Also:
        AWS API Documentation
      • associateCreatedArtifactAsync

        Future<AssociateCreatedArtifactResult> associateCreatedArtifactAsync(AssociateCreatedArtifactRequest associateCreatedArtifactRequest,
         AsyncHandler<AssociateCreatedArtifactRequest,AssociateCreatedArtifactResult> asyncHandler)

        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.

        Parameters:
        associateCreatedArtifactRequest -
        asyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an implementation of the callback methods in this interface to receive notification of successful or unsuccessful completion of the operation.
        Returns:
        A Java Future containing the result of the AssociateCreatedArtifact operation returned by the service.
        See Also:
        AWS API Documentation
      • associateDiscoveredResourceAsync

        Future<AssociateDiscoveredResourceResult> associateDiscoveredResourceAsync(AssociateDiscoveredResourceRequest associateDiscoveredResourceRequest)

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

        Parameters:
        associateDiscoveredResourceRequest -
        Returns:
        A Java Future containing the result of the AssociateDiscoveredResource operation returned by the service.
        See Also:
        AWS API Documentation
      • createProgressUpdateStreamAsync

        Future<CreateProgressUpdateStreamResult> createProgressUpdateStreamAsync(CreateProgressUpdateStreamRequest 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.

        Parameters:
        createProgressUpdateStreamRequest -
        Returns:
        A Java Future containing the result of the CreateProgressUpdateStream operation returned by the service.
        See Also:
        AWS API Documentation
      • createProgressUpdateStreamAsync

        Future<CreateProgressUpdateStreamResult> createProgressUpdateStreamAsync(CreateProgressUpdateStreamRequest createProgressUpdateStreamRequest,
         AsyncHandler<CreateProgressUpdateStreamRequest,CreateProgressUpdateStreamResult> asyncHandler)

        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.

        Parameters:
        createProgressUpdateStreamRequest -
        asyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an implementation of the callback methods in this interface to receive notification of successful or unsuccessful completion of the operation.
        Returns:
        A Java Future containing the result of the CreateProgressUpdateStream operation returned by the service.
        See Also:
        AWS API Documentation
      • deleteProgressUpdateStreamAsync

        Future<DeleteProgressUpdateStreamResult> deleteProgressUpdateStreamAsync(DeleteProgressUpdateStreamRequest 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 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).

        Parameters:
        deleteProgressUpdateStreamRequest -
        Returns:
        A Java Future containing the result of the DeleteProgressUpdateStream operation returned by the service.
        See Also:
        AWS API Documentation
      • deleteProgressUpdateStreamAsync

        Future<DeleteProgressUpdateStreamResult> deleteProgressUpdateStreamAsync(DeleteProgressUpdateStreamRequest deleteProgressUpdateStreamRequest,
         AsyncHandler<DeleteProgressUpdateStreamRequest,DeleteProgressUpdateStreamResult> asyncHandler)

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

        Parameters:
        deleteProgressUpdateStreamRequest -
        asyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an implementation of the callback methods in this interface to receive notification of successful or unsuccessful completion of the operation.
        Returns:
        A Java Future containing the result of the DeleteProgressUpdateStream operation returned by the service.
        See Also:
        AWS API Documentation
      • describeMigrationTaskAsync

        Future<DescribeMigrationTaskResult> describeMigrationTaskAsync(DescribeMigrationTaskRequest describeMigrationTaskRequest)

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

        Parameters:
        describeMigrationTaskRequest -
        Returns:
        A Java Future containing the result of the DescribeMigrationTask operation returned by the service.
        See Also:
        AWS API Documentation
      • describeMigrationTaskAsync

        Future<DescribeMigrationTaskResult> describeMigrationTaskAsync(DescribeMigrationTaskRequest describeMigrationTaskRequest,
         AsyncHandler<DescribeMigrationTaskRequest,DescribeMigrationTaskResult> asyncHandler)

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

        Parameters:
        describeMigrationTaskRequest -
        asyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an implementation of the callback methods in this interface to receive notification of successful or unsuccessful completion of the operation.
        Returns:
        A Java Future containing the result of the DescribeMigrationTask operation returned by the service.
        See Also:
        AWS API Documentation
      • disassociateCreatedArtifactAsync

        Future<DisassociateCreatedArtifactResult> disassociateCreatedArtifactAsync(DisassociateCreatedArtifactRequest 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.

        Parameters:
        disassociateCreatedArtifactRequest -
        Returns:
        A Java Future containing the result of the DisassociateCreatedArtifact operation returned by the service.
        See Also:
        AWS API Documentation
      • disassociateCreatedArtifactAsync

        Future<DisassociateCreatedArtifactResult> disassociateCreatedArtifactAsync(DisassociateCreatedArtifactRequest disassociateCreatedArtifactRequest,
         AsyncHandler<DisassociateCreatedArtifactRequest,DisassociateCreatedArtifactResult> asyncHandler)

        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.

        Parameters:
        disassociateCreatedArtifactRequest -
        asyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an implementation of the callback methods in this interface to receive notification of successful or unsuccessful completion of the operation.
        Returns:
        A Java Future containing the result of the DisassociateCreatedArtifact operation returned by the service.
        See Also:
        AWS API Documentation
      • importMigrationTaskAsync

        Future<ImportMigrationTaskResult> importMigrationTaskAsync(ImportMigrationTaskRequest 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.

        Parameters:
        importMigrationTaskRequest -
        Returns:
        A Java Future containing the result of the ImportMigrationTask operation returned by the service.
        See Also:
        AWS API Documentation
      • importMigrationTaskAsync

        Future<ImportMigrationTaskResult> importMigrationTaskAsync(ImportMigrationTaskRequest importMigrationTaskRequest,
         AsyncHandler<ImportMigrationTaskRequest,ImportMigrationTaskResult> asyncHandler)

        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.

        Parameters:
        importMigrationTaskRequest -
        asyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an implementation of the callback methods in this interface to receive notification of successful or unsuccessful completion of the operation.
        Returns:
        A Java Future containing the result of the ImportMigrationTask operation returned by the service.
        See Also:
        AWS API Documentation
      • listApplicationStatesAsync

        Future<ListApplicationStatesResult> listApplicationStatesAsync(ListApplicationStatesRequest listApplicationStatesRequest)

        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.

        Parameters:
        listApplicationStatesRequest -
        Returns:
        A Java Future containing the result of the ListApplicationStates operation returned by the service.
        See Also:
        AWS API Documentation
      • listApplicationStatesAsync

        Future<ListApplicationStatesResult> listApplicationStatesAsync(ListApplicationStatesRequest listApplicationStatesRequest,
         AsyncHandler<ListApplicationStatesRequest,ListApplicationStatesResult> asyncHandler)

        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.

        Parameters:
        listApplicationStatesRequest -
        asyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an implementation of the callback methods in this interface to receive notification of successful or unsuccessful completion of the operation.
        Returns:
        A Java Future containing the result of the ListApplicationStates operation returned by the service.
        See Also:
        AWS API Documentation
      • listCreatedArtifactsAsync

        Future<ListCreatedArtifactsResult> listCreatedArtifactsAsync(ListCreatedArtifactsRequest 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.

        Parameters:
        listCreatedArtifactsRequest -
        Returns:
        A Java Future containing the result of the ListCreatedArtifacts operation returned by the service.
        See Also:
        AWS API Documentation
      • listCreatedArtifactsAsync

        Future<ListCreatedArtifactsResult> listCreatedArtifactsAsync(ListCreatedArtifactsRequest listCreatedArtifactsRequest,
         AsyncHandler<ListCreatedArtifactsRequest,ListCreatedArtifactsResult> asyncHandler)

        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.

        Parameters:
        listCreatedArtifactsRequest -
        asyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an implementation of the callback methods in this interface to receive notification of successful or unsuccessful completion of the operation.
        Returns:
        A Java Future containing the result of the ListCreatedArtifacts operation returned by the service.
        See Also:
        AWS API Documentation
      • listMigrationTasksAsync

        Future<ListMigrationTasksResult> listMigrationTasksAsync(ListMigrationTasksRequest 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.

        Parameters:
        listMigrationTasksRequest -
        Returns:
        A Java Future containing the result of the ListMigrationTasks operation returned by the service.
        See Also:
        AWS API Documentation
      • listMigrationTasksAsync

        Future<ListMigrationTasksResult> listMigrationTasksAsync(ListMigrationTasksRequest listMigrationTasksRequest,
         AsyncHandler<ListMigrationTasksRequest,ListMigrationTasksResult> asyncHandler)

        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.

        Parameters:
        listMigrationTasksRequest -
        asyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an implementation of the callback methods in this interface to receive notification of successful or unsuccessful completion of the operation.
        Returns:
        A Java Future containing the result of the ListMigrationTasks operation returned by the service.
        See Also:
        AWS API Documentation
      • notifyApplicationStateAsync

        Future<NotifyApplicationStateResult> notifyApplicationStateAsync(NotifyApplicationStateRequest 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.

        Parameters:
        notifyApplicationStateRequest -
        Returns:
        A Java Future containing the result of the NotifyApplicationState operation returned by the service.
        See Also:
        AWS API Documentation
      • notifyApplicationStateAsync

        Future<NotifyApplicationStateResult> notifyApplicationStateAsync(NotifyApplicationStateRequest notifyApplicationStateRequest,
         AsyncHandler<NotifyApplicationStateRequest,NotifyApplicationStateResult> asyncHandler)

        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.

        Parameters:
        notifyApplicationStateRequest -
        asyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an implementation of the callback methods in this interface to receive notification of successful or unsuccessful completion of the operation.
        Returns:
        A Java Future containing the result of the NotifyApplicationState operation returned by the service.
        See Also:
        AWS API Documentation
      • notifyMigrationTaskStateAsync

        Future<NotifyMigrationTaskStateResult> notifyMigrationTaskStateAsync(NotifyMigrationTaskStateRequest 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.

        Parameters:
        notifyMigrationTaskStateRequest -
        Returns:
        A Java Future containing the result of the NotifyMigrationTaskState operation returned by the service.
        See Also:
        AWS API Documentation
      • notifyMigrationTaskStateAsync

        Future<NotifyMigrationTaskStateResult> notifyMigrationTaskStateAsync(NotifyMigrationTaskStateRequest notifyMigrationTaskStateRequest,
         AsyncHandler<NotifyMigrationTaskStateRequest,NotifyMigrationTaskStateResult> asyncHandler)

        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.

        Parameters:
        notifyMigrationTaskStateRequest -
        asyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an implementation of the callback methods in this interface to receive notification of successful or unsuccessful completion of the operation.
        Returns:
        A Java Future containing the result of the NotifyMigrationTaskState operation returned by the service.
        See Also:
        AWS API Documentation
      • putResourceAttributesAsync

        Future<PutResourceAttributesResult> putResourceAttributesAsync(PutResourceAttributesRequest putResourceAttributesRequest)

        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.

        Parameters:
        putResourceAttributesRequest -
        Returns:
        A Java Future containing the result of the PutResourceAttributes operation returned by the service.
        See Also:
        AWS API Documentation
      • putResourceAttributesAsync

        Future<PutResourceAttributesResult> putResourceAttributesAsync(PutResourceAttributesRequest putResourceAttributesRequest,
         AsyncHandler<PutResourceAttributesRequest,PutResourceAttributesResult> asyncHandler)

        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.

        Parameters:
        putResourceAttributesRequest -
        asyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an implementation of the callback methods in this interface to receive notification of successful or unsuccessful completion of the operation.
        Returns:
        A Java Future containing the result of the PutResourceAttributes operation returned by the service.
        See Also:
        AWS API Documentation
Skip navigation links
  • Summary:
  • Nested |
  • Field |
  • Constr |
  • Method
  • Detail:
  • Field |
  • Constr |
  • Method

AltStyle によって変換されたページ (->オリジナル) /