NAME

Paws::MigrationHub - Perl Interface to AWS AWS Migration Hub

SYNOPSIS

  use Paws;

  my $obj = Paws->service('MigrationHub');
  my $res = $obj->Method(
    Arg1 => $val1,
    Arg2 => [ 'V1', 'V2' ],
    # if Arg3 is an object, the HashRef will be used as arguments to the constructor
    # of the arguments type
    Arg3 => { Att1 => 'Val1' },
    # if Arg4 is an array of objects, the HashRefs will be passed as arguments to
    # the constructor of the arguments type
    Arg4 => [ { Att1 => 'Val1'  }, { Att1 => 'Val2' } ],
  );

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.

For the AWS API documentation, see https://docs.aws.amazon.com/migrationhub/

METHODS

AssociateCreatedArtifact

CreatedArtifact => Paws::MigrationHub::CreatedArtifact
MigrationTaskName => Str
ProgressUpdateStream => Str
[DryRun => Bool]

Each argument is described in detail in: Paws::MigrationHub::AssociateCreatedArtifact

Returns: a Paws::MigrationHub::AssociateCreatedArtifactResult instance

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.

AssociateDiscoveredResource

DiscoveredResource => Paws::MigrationHub::DiscoveredResource
MigrationTaskName => Str
ProgressUpdateStream => Str
[DryRun => Bool]

Each argument is described in detail in: Paws::MigrationHub::AssociateDiscoveredResource

Returns: a Paws::MigrationHub::AssociateDiscoveredResourceResult instance

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

CreateProgressUpdateStream

ProgressUpdateStreamName => Str
[DryRun => Bool]

Each argument is described in detail in: Paws::MigrationHub::CreateProgressUpdateStream

Returns: a Paws::MigrationHub::CreateProgressUpdateStreamResult instance

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.

DeleteProgressUpdateStream

ProgressUpdateStreamName => Str
[DryRun => Bool]

Each argument is described in detail in: Paws::MigrationHub::DeleteProgressUpdateStream

Returns: a Paws::MigrationHub::DeleteProgressUpdateStreamResult instance

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

DescribeApplicationState

ApplicationId => Str

Each argument is described in detail in: Paws::MigrationHub::DescribeApplicationState

Returns: a Paws::MigrationHub::DescribeApplicationStateResult instance

Gets the migration status of an application.

DescribeMigrationTask

MigrationTaskName => Str
ProgressUpdateStream => Str

Each argument is described in detail in: Paws::MigrationHub::DescribeMigrationTask

Returns: a Paws::MigrationHub::DescribeMigrationTaskResult instance

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

DisassociateCreatedArtifact

CreatedArtifactName => Str
MigrationTaskName => Str
ProgressUpdateStream => Str
[DryRun => Bool]

Each argument is described in detail in: Paws::MigrationHub::DisassociateCreatedArtifact

Returns: a Paws::MigrationHub::DisassociateCreatedArtifactResult instance

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.

DisassociateDiscoveredResource

ConfigurationId => Str
MigrationTaskName => Str
ProgressUpdateStream => Str
[DryRun => Bool]

Each argument is described in detail in: Paws::MigrationHub::DisassociateDiscoveredResource

Returns: a Paws::MigrationHub::DisassociateDiscoveredResourceResult instance

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

ImportMigrationTask

MigrationTaskName => Str
ProgressUpdateStream => Str
[DryRun => Bool]

Each argument is described in detail in: Paws::MigrationHub::ImportMigrationTask

Returns: a Paws::MigrationHub::ImportMigrationTaskResult instance

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.

ListApplicationStates

[ApplicationIds => ArrayRef[Str|Undef]]
[MaxResults => Int]
[NextToken => Str]

Each argument is described in detail in: Paws::MigrationHub::ListApplicationStates

Returns: a Paws::MigrationHub::ListApplicationStatesResult instance

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.

ListCreatedArtifacts

MigrationTaskName => Str
ProgressUpdateStream => Str
[MaxResults => Int]
[NextToken => Str]

Each argument is described in detail in: Paws::MigrationHub::ListCreatedArtifacts

Returns: a Paws::MigrationHub::ListCreatedArtifactsResult instance

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.

ListDiscoveredResources

MigrationTaskName => Str
ProgressUpdateStream => Str
[MaxResults => Int]
[NextToken => Str]

Each argument is described in detail in: Paws::MigrationHub::ListDiscoveredResources

Returns: a Paws::MigrationHub::ListDiscoveredResourcesResult instance

Lists discovered resources associated with the given MigrationTask.

ListMigrationTasks

[MaxResults => Int]
[NextToken => Str]
[ResourceName => Str]

Each argument is described in detail in: Paws::MigrationHub::ListMigrationTasks

Returns: a Paws::MigrationHub::ListMigrationTasksResult instance

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.

ListProgressUpdateStreams

[MaxResults => Int]
[NextToken => Str]

Each argument is described in detail in: Paws::MigrationHub::ListProgressUpdateStreams

Returns: a Paws::MigrationHub::ListProgressUpdateStreamsResult instance

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

NotifyApplicationState

ApplicationId => Str
Status => Str
[DryRun => Bool]
[UpdateDateTime => Str]

Each argument is described in detail in: Paws::MigrationHub::NotifyApplicationState

Returns: a Paws::MigrationHub::NotifyApplicationStateResult instance

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.

NotifyMigrationTaskState

MigrationTaskName => Str
NextUpdateSeconds => Int
ProgressUpdateStream => Str
Task => Paws::MigrationHub::Task
UpdateDateTime => Str
[DryRun => Bool]

Each argument is described in detail in: Paws::MigrationHub::NotifyMigrationTaskState

Returns: a Paws::MigrationHub::NotifyMigrationTaskStateResult instance

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.

PutResourceAttributes

MigrationTaskName => Str
ProgressUpdateStream => Str
ResourceAttributeList => ArrayRef[Paws::MigrationHub::ResourceAttribute]
[DryRun => Bool]

Each argument is described in detail in: Paws::MigrationHub::PutResourceAttributes

Returns: a Paws::MigrationHub::PutResourceAttributesResult instance

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 (https://docs.aws.amazon.com/migrationhub/latest/ug/API_PutResourceAttributes.html#migrationhub-PutResourceAttributes-request-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.

PAGINATORS

Paginator methods are helpers that repetively call methods that return partial results