AbstractAWSMigrationHub (AWS SDK for Java

java.lang.Object
- com.amazonaws.services.migrationhub.AbstractAWSMigrationHub

All Implemented Interfaces:

AWSMigrationHub

Direct Known Subclasses:

AbstractAWSMigrationHubAsync
```
@Generated(value="com.amazonaws:aws-java-sdk-code-generator")
public class AbstractAWSMigrationHub
extends Object
implements AWSMigrationHub
```
Abstract implementation of AWSMigrationHub. Convenient method forms pass through to the corresponding overload that takes a request object, which throws an UnsupportedOperationException.

Field Summary
- Fields inherited from interface com.amazonaws.services.migrationhub.AWSMigrationHub
  ENDPOINT_PREFIX

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`AssociateCreatedArtifactResult`	`associateCreatedArtifact(AssociateCreatedArtifactRequest request)` Associates a created artifact of an AWS cloud resource, the target receiving the migration, with the migration task performed by a migration tool.
`AssociateDiscoveredResourceResult`	`associateDiscoveredResource(AssociateDiscoveredResourceRequest request)` Associates a discovered resource ID from Application Discovery Service (ADS) with a migration task.
`CreateProgressUpdateStreamResult`	`createProgressUpdateStream(CreateProgressUpdateStreamRequest request)` 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.
`DeleteProgressUpdateStreamResult`	`deleteProgressUpdateStream(DeleteProgressUpdateStreamRequest request)` Deletes a progress update stream, including all of its tasks, which was previously created as an AWS resource used for access control.
`DescribeApplicationStateResult`	`describeApplicationState(DescribeApplicationStateRequest request)` Gets the migration status of an application.
`DescribeMigrationTaskResult`	`describeMigrationTask(DescribeMigrationTaskRequest request)` Retrieves a list of all attributes associated with a specific migration task.
`DisassociateCreatedArtifactResult`	`disassociateCreatedArtifact(DisassociateCreatedArtifactRequest request)` Disassociates a created artifact of an AWS resource with a migration task performed by a migration tool that was previously associated.
`DisassociateDiscoveredResourceResult`	`disassociateDiscoveredResource(DisassociateDiscoveredResourceRequest request)` Disassociate an Application Discovery Service (ADS) discovered resource from a migration task.
`ResponseMetadata`	`getCachedResponseMetadata(AmazonWebServiceRequest request)` Returns additional metadata for a previously executed successful request, typically used for debugging issues where a service isn't acting as expected.
`ImportMigrationTaskResult`	`importMigrationTask(ImportMigrationTaskRequest request)` Registers a new migration task which represents a server, database, etc., being migrated to AWS by a migration tool.
`ListCreatedArtifactsResult`	`listCreatedArtifacts(ListCreatedArtifactsRequest request)` Lists the created artifacts attached to a given migration task in an update stream.
`ListDiscoveredResourcesResult`	`listDiscoveredResources(ListDiscoveredResourcesRequest request)` Lists discovered resources associated with the given `MigrationTask`.
`ListMigrationTasksResult`	`listMigrationTasks(ListMigrationTasksRequest request)` Lists all, or filtered by resource name, migration tasks associated with the user account making this call.
`ListProgressUpdateStreamsResult`	`listProgressUpdateStreams(ListProgressUpdateStreamsRequest request)` Lists progress update streams associated with the user account making this call.
`NotifyApplicationStateResult`	`notifyApplicationState(NotifyApplicationStateRequest request)` Sets the migration state of an application.
`NotifyMigrationTaskStateResult`	`notifyMigrationTaskState(NotifyMigrationTaskStateRequest request)` Notifies Migration Hub of the current status, progress, or other detail regarding a migration task.
`PutResourceAttributesResult`	`putResourceAttributes(PutResourceAttributesRequest request)` Provides identifying details of the resource being migrated so that it can be associated in the Application Discovery Service (ADS)'s repository.
`void`	`shutdown()` Shuts down this client object, releasing any resources that might be held open.

Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Method Detail
  - associateCreatedArtifact
```
public AssociateCreatedArtifactResult associateCreatedArtifact(AssociateCreatedArtifactRequest request)
```
    Description copied from interface: AWSMigrationHub
    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.
    Specified by:
    
    associateCreatedArtifact in interface AWSMigrationHub
    
    Returns:
    
    Result of the AssociateCreatedArtifact operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - associateDiscoveredResource
```
public AssociateDiscoveredResourceResult associateDiscoveredResource(AssociateDiscoveredResourceRequest request)
```
    Description copied from interface: AWSMigrationHub
    
    Associates a discovered resource ID from Application Discovery Service (ADS) with a migration task.
    
    Specified by:
    
    associateDiscoveredResource in interface AWSMigrationHub
    
    Returns:
    
    Result of the AssociateDiscoveredResource operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - createProgressUpdateStream
```
public CreateProgressUpdateStreamResult createProgressUpdateStream(CreateProgressUpdateStreamRequest request)
```
    Description copied from interface: AWSMigrationHub
    
    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.
    
    Specified by:
    
    createProgressUpdateStream in interface AWSMigrationHub
    
    Returns:
    
    Result of the CreateProgressUpdateStream operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - deleteProgressUpdateStream
```
public DeleteProgressUpdateStreamResult deleteProgressUpdateStream(DeleteProgressUpdateStreamRequest request)
```
    Description copied from interface: AWSMigrationHub
    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).
    Specified by:
    
    deleteProgressUpdateStream in interface AWSMigrationHub
    
    Returns:
    
    Result of the DeleteProgressUpdateStream operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - describeApplicationState
```
public DescribeApplicationStateResult describeApplicationState(DescribeApplicationStateRequest request)
```
    Description copied from interface: AWSMigrationHub
    
    Gets the migration status of an application.
    
    Specified by:
    
    describeApplicationState in interface AWSMigrationHub
    
    Returns:
    
    Result of the DescribeApplicationState operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - describeMigrationTask
```
public DescribeMigrationTaskResult describeMigrationTask(DescribeMigrationTaskRequest request)
```
    Description copied from interface: AWSMigrationHub
    
    Retrieves a list of all attributes associated with a specific migration task.
    
    Specified by:
    
    describeMigrationTask in interface AWSMigrationHub
    
    Returns:
    
    Result of the DescribeMigrationTask operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - disassociateCreatedArtifact
```
public DisassociateCreatedArtifactResult disassociateCreatedArtifact(DisassociateCreatedArtifactRequest request)
```
    Description copied from interface: AWSMigrationHub
    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.
    Specified by:
    
    disassociateCreatedArtifact in interface AWSMigrationHub
    
    Returns:
    
    Result of the DisassociateCreatedArtifact operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - disassociateDiscoveredResource
```
public DisassociateDiscoveredResourceResult disassociateDiscoveredResource(DisassociateDiscoveredResourceRequest request)
```
    Description copied from interface: AWSMigrationHub
    
    Disassociate an Application Discovery Service (ADS) discovered resource from a migration task.
    
    Specified by:
    
    disassociateDiscoveredResource in interface AWSMigrationHub
    
    Returns:
    
    Result of the DisassociateDiscoveredResource operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - importMigrationTask
```
public ImportMigrationTaskResult importMigrationTask(ImportMigrationTaskRequest request)
```
    Description copied from interface: AWSMigrationHub
    
    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.
    
    Specified by:
    
    importMigrationTask in interface AWSMigrationHub
    
    Returns:
    
    Result of the ImportMigrationTask operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - listCreatedArtifacts
```
public ListCreatedArtifactsResult listCreatedArtifacts(ListCreatedArtifactsRequest request)
```
    Description copied from interface: AWSMigrationHub
    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.
    Specified by:
    
    listCreatedArtifacts in interface AWSMigrationHub
    
    Returns:
    
    Result of the ListCreatedArtifacts operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - listDiscoveredResources
```
public ListDiscoveredResourcesResult listDiscoveredResources(ListDiscoveredResourcesRequest request)
```
    Description copied from interface: AWSMigrationHub
    
    Lists discovered resources associated with the given MigrationTask.
    
    Specified by:
    
    listDiscoveredResources in interface AWSMigrationHub
    
    Returns:
    
    Result of the ListDiscoveredResources operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - listMigrationTasks
```
public ListMigrationTasksResult listMigrationTasks(ListMigrationTasksRequest request)
```
    Description copied from interface: AWSMigrationHub
    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.
    Specified by:
    
    listMigrationTasks in interface AWSMigrationHub
    
    Returns:
    
    Result of the ListMigrationTasks operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - listProgressUpdateStreams
```
public ListProgressUpdateStreamsResult listProgressUpdateStreams(ListProgressUpdateStreamsRequest request)
```
    Description copied from interface: AWSMigrationHub
    
    Lists progress update streams associated with the user account making this call.
    
    Specified by:
    
    listProgressUpdateStreams in interface AWSMigrationHub
    
    Returns:
    
    Result of the ListProgressUpdateStreams operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - notifyApplicationState
```
public NotifyApplicationStateResult notifyApplicationState(NotifyApplicationStateRequest request)
```
    Description copied from interface: AWSMigrationHub
    
    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.
    
    Specified by:
    
    notifyApplicationState in interface AWSMigrationHub
    
    Returns:
    
    Result of the NotifyApplicationState operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - notifyMigrationTaskState
```
public NotifyMigrationTaskStateResult notifyMigrationTaskState(NotifyMigrationTaskStateRequest request)
```
    Description copied from interface: AWSMigrationHub
    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.
    Specified by:
    
    notifyMigrationTaskState in interface AWSMigrationHub
    
    Returns:
    
    Result of the NotifyMigrationTaskState operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - putResourceAttributes
```
public PutResourceAttributesResult putResourceAttributes(PutResourceAttributesRequest request)
```
    Description copied from interface: AWSMigrationHub
    
    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.
    
    Specified by:
    
    putResourceAttributes in interface AWSMigrationHub
    
    Returns:
    
    Result of the PutResourceAttributes operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - shutdown
```
public void shutdown()
```
    Description copied from interface: AWSMigrationHub
    
    Shuts down this client object, releasing any resources that might be held open. This is an optional method, and callers are not expected to call it, but can if they want to explicitly release any open resources. Once a client has been shutdown, it should not be used to make any more requests.
    
    Specified by:
    
    shutdown in interface AWSMigrationHub
  - getCachedResponseMetadata
```
public ResponseMetadata getCachedResponseMetadata(AmazonWebServiceRequest request)
```
    Description copied from interface: AWSMigrationHub
    
    Returns additional metadata for a previously executed successful request, typically used for debugging issues where a service isn't acting as expected. This data isn't considered part of the result data returned by an operation, so it's available through this separate, diagnostic interface.
    Response metadata is only cached for a limited period of time, so if you need to access this extra diagnostic information for an executed request, you should use this method to retrieve it as soon as possible after executing a request.
    
    Specified by:
    
    getCachedResponseMetadata in interface AWSMigrationHub
    
    Parameters:
    
    request - The originally executed request.
    
    Returns:
    
    The response metadata for the specified request, or null if none is available.

Did this page help you?

Class AbstractAWSMigrationHub

Field Summary

Fields inherited from interface com.amazonaws.services.migrationhub.AWSMigrationHub

Method Summary

Methods inherited from class java.lang.Object

Method Detail

associateCreatedArtifact

associateDiscoveredResource

createProgressUpdateStream

deleteProgressUpdateStream

describeApplicationState

describeMigrationTask

disassociateCreatedArtifact

disassociateDiscoveredResource

importMigrationTask

listCreatedArtifacts

listDiscoveredResources

listMigrationTasks

listProgressUpdateStreams

notifyApplicationState

notifyMigrationTaskState

putResourceAttributes

shutdown

getCachedResponseMetadata