AssociateCreatedArtifact

$result = $client->associateCreatedArtifact([/* ... */]);
$promise = $client->associateCreatedArtifactAsync([/* ... */]);

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.

Parameter Syntax

$result = $client->associateCreatedArtifact([
    'CreatedArtifact' => [ // REQUIRED
        'Description' => '<string>',
        'Name' => '<string>', // REQUIRED
    ],
    'DryRun' => true || false,
    'MigrationTaskName' => '<string>', // REQUIRED
    'ProgressUpdateStream' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

[]

Result Details

Errors

AccessDeniedException:

You do not have sufficient access to perform this action.

ThrottlingException:

The request was denied due to request throttling.

InternalServerError:

Exception raised when an internal, configuration, or dependency error is encountered.

ServiceUnavailableException:

Exception raised when there is an internal, configuration, or dependency error encountered.

DryRunOperation:

Exception raised to indicate a successfully authorized action when the DryRun flag is set to "true".

UnauthorizedOperation:

Exception raised to indicate a request was not authorized when the DryRun flag is set to "true".

InvalidInputException:

Exception raised when the provided input violates a policy constraint or is entered in the wrong format or data type.

ResourceNotFoundException:

Exception raised when the request references a resource (Application Discovery Service configuration, update stream, migration task, etc.) that does not exist in Application Discovery Service (Application Discovery Service) or in Migration Hub's repository.

HomeRegionNotSetException:

The home region is not set. Set the home region to continue.

AssociateDiscoveredResource

$result = $client->associateDiscoveredResource([/* ... */]);
$promise = $client->associateDiscoveredResourceAsync([/* ... */]);

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

Parameter Syntax

$result = $client->associateDiscoveredResource([
    'DiscoveredResource' => [ // REQUIRED
        'ConfigurationId' => '<string>', // REQUIRED
        'Description' => '<string>',
    ],
    'DryRun' => true || false,
    'MigrationTaskName' => '<string>', // REQUIRED
    'ProgressUpdateStream' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

[]

Result Details

Errors

AccessDeniedException:

You do not have sufficient access to perform this action.

ThrottlingException:

The request was denied due to request throttling.

InternalServerError:

Exception raised when an internal, configuration, or dependency error is encountered.

ServiceUnavailableException:

Exception raised when there is an internal, configuration, or dependency error encountered.

DryRunOperation:

Exception raised to indicate a successfully authorized action when the DryRun flag is set to "true".

UnauthorizedOperation:

Exception raised to indicate a request was not authorized when the DryRun flag is set to "true".

InvalidInputException:

Exception raised when the provided input violates a policy constraint or is entered in the wrong format or data type.

PolicyErrorException:

Exception raised when there are problems accessing Application Discovery Service (Application Discovery Service); most likely due to a misconfigured policy or the migrationhub-discovery role is missing or not configured correctly.

ResourceNotFoundException:

Exception raised when the request references a resource (Application Discovery Service configuration, update stream, migration task, etc.) that does not exist in Application Discovery Service (Application Discovery Service) or in Migration Hub's repository.

HomeRegionNotSetException:

The home region is not set. Set the home region to continue.

AssociateSourceResource

$result = $client->associateSourceResource([/* ... */]);
$promise = $client->associateSourceResourceAsync([/* ... */]);

Associates a source resource with a migration task. For example, the source resource can be a source server, an application, or a migration wave.

Parameter Syntax

$result = $client->associateSourceResource([
    'DryRun' => true || false,
    'MigrationTaskName' => '<string>', // REQUIRED
    'ProgressUpdateStream' => '<string>', // REQUIRED
    'SourceResource' => [ // REQUIRED
        'Description' => '<string>',
        'Name' => '<string>', // REQUIRED
        'StatusDetail' => '<string>',
    ],
]);

Parameter Details

Result Syntax

[]

Result Details

Errors

AccessDeniedException:

You do not have sufficient access to perform this action.

ThrottlingException:

The request was denied due to request throttling.

InternalServerError:

Exception raised when an internal, configuration, or dependency error is encountered.

ServiceUnavailableException:

Exception raised when there is an internal, configuration, or dependency error encountered.

DryRunOperation:

Exception raised to indicate a successfully authorized action when the DryRun flag is set to "true".

UnauthorizedOperation:

Exception raised to indicate a request was not authorized when the DryRun flag is set to "true".

InvalidInputException:

Exception raised when the provided input violates a policy constraint or is entered in the wrong format or data type.

ResourceNotFoundException:

Exception raised when the request references a resource (Application Discovery Service configuration, update stream, migration task, etc.) that does not exist in Application Discovery Service (Application Discovery Service) or in Migration Hub's repository.

CreateProgressUpdateStream

$result = $client->createProgressUpdateStream([/* ... */]);
$promise = $client->createProgressUpdateStreamAsync([/* ... */]);

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.

Parameter Syntax

$result = $client->createProgressUpdateStream([
    'DryRun' => true || false,
    'ProgressUpdateStreamName' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

[]

Result Details

Errors

AccessDeniedException:

You do not have sufficient access to perform this action.

ThrottlingException:

The request was denied due to request throttling.

InternalServerError:

Exception raised when an internal, configuration, or dependency error is encountered.

ServiceUnavailableException:

Exception raised when there is an internal, configuration, or dependency error encountered.

DryRunOperation:

Exception raised to indicate a successfully authorized action when the DryRun flag is set to "true".

UnauthorizedOperation:

Exception raised to indicate a request was not authorized when the DryRun flag is set to "true".

InvalidInputException:

Exception raised when the provided input violates a policy constraint or is entered in the wrong format or data type.

HomeRegionNotSetException:

The home region is not set. Set the home region to continue.

DeleteProgressUpdateStream

$result = $client->deleteProgressUpdateStream([/* ... */]);
$promise = $client->deleteProgressUpdateStreamAsync([/* ... */]);

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

Parameter Syntax

$result = $client->deleteProgressUpdateStream([
    'DryRun' => true || false,
    'ProgressUpdateStreamName' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

[]

Result Details

Errors

AccessDeniedException:

You do not have sufficient access to perform this action.

ThrottlingException:

The request was denied due to request throttling.

InternalServerError:

Exception raised when an internal, configuration, or dependency error is encountered.

ServiceUnavailableException:

Exception raised when there is an internal, configuration, or dependency error encountered.

DryRunOperation:

Exception raised to indicate a successfully authorized action when the DryRun flag is set to "true".

UnauthorizedOperation:

Exception raised to indicate a request was not authorized when the DryRun flag is set to "true".

InvalidInputException:

Exception raised when the provided input violates a policy constraint or is entered in the wrong format or data type.

ResourceNotFoundException:

Exception raised when the request references a resource (Application Discovery Service configuration, update stream, migration task, etc.) that does not exist in Application Discovery Service (Application Discovery Service) or in Migration Hub's repository.

HomeRegionNotSetException:

The home region is not set. Set the home region to continue.

DescribeApplicationState

$result = $client->describeApplicationState([/* ... */]);
$promise = $client->describeApplicationStateAsync([/* ... */]);

Gets the migration status of an application.

Parameter Syntax

$result = $client->describeApplicationState([
    'ApplicationId' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

[
    'ApplicationStatus' => 'NOT_STARTED|IN_PROGRESS|COMPLETED',
    'LastUpdatedTime' => <DateTime>,
]

Result Details

Errors

AccessDeniedException:

You do not have sufficient access to perform this action.

ThrottlingException:

The request was denied due to request throttling.

InternalServerError:

Exception raised when an internal, configuration, or dependency error is encountered.

ServiceUnavailableException:

Exception raised when there is an internal, configuration, or dependency error encountered.

InvalidInputException:

Exception raised when the provided input violates a policy constraint or is entered in the wrong format or data type.

PolicyErrorException:

Exception raised when there are problems accessing Application Discovery Service (Application Discovery Service); most likely due to a misconfigured policy or the migrationhub-discovery role is missing or not configured correctly.

ResourceNotFoundException:

Exception raised when the request references a resource (Application Discovery Service configuration, update stream, migration task, etc.) that does not exist in Application Discovery Service (Application Discovery Service) or in Migration Hub's repository.

HomeRegionNotSetException:

The home region is not set. Set the home region to continue.

DescribeMigrationTask

$result = $client->describeMigrationTask([/* ... */]);
$promise = $client->describeMigrationTaskAsync([/* ... */]);

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

Parameter Syntax

$result = $client->describeMigrationTask([
    'MigrationTaskName' => '<string>', // REQUIRED
    'ProgressUpdateStream' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

[
    'MigrationTask' => [
        'MigrationTaskName' => '<string>',
        'ProgressUpdateStream' => '<string>',
        'ResourceAttributeList' => [
            [
                'Type' => 'IPV4_ADDRESS|IPV6_ADDRESS|MAC_ADDRESS|FQDN|VM_MANAGER_ID|VM_MANAGED_OBJECT_REFERENCE|VM_NAME|VM_PATH|BIOS_ID|MOTHERBOARD_SERIAL_NUMBER',
                'Value' => '<string>',
            ],
            // ...
        ],
        'Task' => [
            'ProgressPercent' => <integer>,
            'Status' => 'NOT_STARTED|IN_PROGRESS|FAILED|COMPLETED',
            'StatusDetail' => '<string>',
        ],
        'UpdateDateTime' => <DateTime>,
    ],
]

Result Details

Errors

AccessDeniedException:

You do not have sufficient access to perform this action.

ThrottlingException:

The request was denied due to request throttling.

InternalServerError:

Exception raised when an internal, configuration, or dependency error is encountered.

ServiceUnavailableException:

Exception raised when there is an internal, configuration, or dependency error encountered.

InvalidInputException:

Exception raised when the provided input violates a policy constraint or is entered in the wrong format or data type.

ResourceNotFoundException:

Exception raised when the request references a resource (Application Discovery Service configuration, update stream, migration task, etc.) that does not exist in Application Discovery Service (Application Discovery Service) or in Migration Hub's repository.

HomeRegionNotSetException:

The home region is not set. Set the home region to continue.

DisassociateCreatedArtifact

$result = $client->disassociateCreatedArtifact([/* ... */]);
$promise = $client->disassociateCreatedArtifactAsync([/* ... */]);

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.

Parameter Syntax

$result = $client->disassociateCreatedArtifact([
    'CreatedArtifactName' => '<string>', // REQUIRED
    'DryRun' => true || false,
    'MigrationTaskName' => '<string>', // REQUIRED
    'ProgressUpdateStream' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

[]

Result Details

Errors

AccessDeniedException:

You do not have sufficient access to perform this action.

ThrottlingException:

The request was denied due to request throttling.

InternalServerError:

Exception raised when an internal, configuration, or dependency error is encountered.

ServiceUnavailableException:

Exception raised when there is an internal, configuration, or dependency error encountered.

DryRunOperation:

Exception raised to indicate a successfully authorized action when the DryRun flag is set to "true".

UnauthorizedOperation:

Exception raised to indicate a request was not authorized when the DryRun flag is set to "true".

InvalidInputException:

Exception raised when the provided input violates a policy constraint or is entered in the wrong format or data type.

ResourceNotFoundException:

Exception raised when the request references a resource (Application Discovery Service configuration, update stream, migration task, etc.) that does not exist in Application Discovery Service (Application Discovery Service) or in Migration Hub's repository.

HomeRegionNotSetException:

The home region is not set. Set the home region to continue.

DisassociateDiscoveredResource

$result = $client->disassociateDiscoveredResource([/* ... */]);
$promise = $client->disassociateDiscoveredResourceAsync([/* ... */]);

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

Parameter Syntax

$result = $client->disassociateDiscoveredResource([
    'ConfigurationId' => '<string>', // REQUIRED
    'DryRun' => true || false,
    'MigrationTaskName' => '<string>', // REQUIRED
    'ProgressUpdateStream' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

[]

Result Details

Errors

AccessDeniedException:

You do not have sufficient access to perform this action.

ThrottlingException:

The request was denied due to request throttling.

InternalServerError:

Exception raised when an internal, configuration, or dependency error is encountered.

ServiceUnavailableException:

Exception raised when there is an internal, configuration, or dependency error encountered.

DryRunOperation:

Exception raised to indicate a successfully authorized action when the DryRun flag is set to "true".

UnauthorizedOperation:

Exception raised to indicate a request was not authorized when the DryRun flag is set to "true".

InvalidInputException:

Exception raised when the provided input violates a policy constraint or is entered in the wrong format or data type.

ResourceNotFoundException:

Exception raised when the request references a resource (Application Discovery Service configuration, update stream, migration task, etc.) that does not exist in Application Discovery Service (Application Discovery Service) or in Migration Hub's repository.

HomeRegionNotSetException:

The home region is not set. Set the home region to continue.

DisassociateSourceResource

$result = $client->disassociateSourceResource([/* ... */]);
$promise = $client->disassociateSourceResourceAsync([/* ... */]);

Removes the association between a source resource and a migration task.

Parameter Syntax

$result = $client->disassociateSourceResource([
    'DryRun' => true || false,
    'MigrationTaskName' => '<string>', // REQUIRED
    'ProgressUpdateStream' => '<string>', // REQUIRED
    'SourceResourceName' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

[]

Result Details

Errors

AccessDeniedException:

You do not have sufficient access to perform this action.

ThrottlingException:

The request was denied due to request throttling.

InternalServerError:

Exception raised when an internal, configuration, or dependency error is encountered.

ServiceUnavailableException:

Exception raised when there is an internal, configuration, or dependency error encountered.

DryRunOperation:

Exception raised to indicate a successfully authorized action when the DryRun flag is set to "true".

UnauthorizedOperation:

Exception raised to indicate a request was not authorized when the DryRun flag is set to "true".

InvalidInputException:

Exception raised when the provided input violates a policy constraint or is entered in the wrong format or data type.

ResourceNotFoundException:

Exception raised when the request references a resource (Application Discovery Service configuration, update stream, migration task, etc.) that does not exist in Application Discovery Service (Application Discovery Service) or in Migration Hub's repository.

ImportMigrationTask

$result = $client->importMigrationTask([/* ... */]);
$promise = $client->importMigrationTaskAsync([/* ... */]);

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.

Parameter Syntax

$result = $client->importMigrationTask([
    'DryRun' => true || false,
    'MigrationTaskName' => '<string>', // REQUIRED
    'ProgressUpdateStream' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

[]

Result Details

Errors

AccessDeniedException:

You do not have sufficient access to perform this action.

ThrottlingException:

The request was denied due to request throttling.

InternalServerError:

Exception raised when an internal, configuration, or dependency error is encountered.

ServiceUnavailableException:

Exception raised when there is an internal, configuration, or dependency error encountered.

DryRunOperation:

Exception raised to indicate a successfully authorized action when the DryRun flag is set to "true".

UnauthorizedOperation:

Exception raised to indicate a request was not authorized when the DryRun flag is set to "true".

InvalidInputException:

Exception raised when the provided input violates a policy constraint or is entered in the wrong format or data type.

ResourceNotFoundException:

Exception raised when the request references a resource (Application Discovery Service configuration, update stream, migration task, etc.) that does not exist in Application Discovery Service (Application Discovery Service) or in Migration Hub's repository.

HomeRegionNotSetException:

The home region is not set. Set the home region to continue.

ListApplicationStates

$result = $client->listApplicationStates([/* ... */]);
$promise = $client->listApplicationStatesAsync([/* ... */]);

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.

Parameter Syntax

$result = $client->listApplicationStates([
    'ApplicationIds' => ['<string>', ...],
    'MaxResults' => <integer>,
    'NextToken' => '<string>',
]);

Parameter Details

Result Syntax

[
    'ApplicationStateList' => [
        [
            'ApplicationId' => '<string>',
            'ApplicationStatus' => 'NOT_STARTED|IN_PROGRESS|COMPLETED',
            'LastUpdatedTime' => <DateTime>,
        ],
        // ...
    ],
    'NextToken' => '<string>',
]

Result Details

Errors

AccessDeniedException:

You do not have sufficient access to perform this action.

ThrottlingException:

The request was denied due to request throttling.

InternalServerError:

Exception raised when an internal, configuration, or dependency error is encountered.

ServiceUnavailableException:

Exception raised when there is an internal, configuration, or dependency error encountered.

InvalidInputException:

Exception raised when the provided input violates a policy constraint or is entered in the wrong format or data type.

HomeRegionNotSetException:

The home region is not set. Set the home region to continue.

ListCreatedArtifacts

$result = $client->listCreatedArtifacts([/* ... */]);
$promise = $client->listCreatedArtifactsAsync([/* ... */]);

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.

Parameter Syntax

$result = $client->listCreatedArtifacts([
    'MaxResults' => <integer>,
    'MigrationTaskName' => '<string>', // REQUIRED
    'NextToken' => '<string>',
    'ProgressUpdateStream' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

[
    'CreatedArtifactList' => [
        [
            'Description' => '<string>',
            'Name' => '<string>',
        ],
        // ...
    ],
    'NextToken' => '<string>',
]

Result Details

Errors

AccessDeniedException:

You do not have sufficient access to perform this action.

ThrottlingException:

The request was denied due to request throttling.

InternalServerError:

Exception raised when an internal, configuration, or dependency error is encountered.

ServiceUnavailableException:

Exception raised when there is an internal, configuration, or dependency error encountered.

InvalidInputException:

Exception raised when the provided input violates a policy constraint or is entered in the wrong format or data type.

ResourceNotFoundException:

Exception raised when the request references a resource (Application Discovery Service configuration, update stream, migration task, etc.) that does not exist in Application Discovery Service (Application Discovery Service) or in Migration Hub's repository.

HomeRegionNotSetException:

The home region is not set. Set the home region to continue.

ListDiscoveredResources

$result = $client->listDiscoveredResources([/* ... */]);
$promise = $client->listDiscoveredResourcesAsync([/* ... */]);

Lists discovered resources associated with the given MigrationTask.

Parameter Syntax

$result = $client->listDiscoveredResources([
    'MaxResults' => <integer>,
    'MigrationTaskName' => '<string>', // REQUIRED
    'NextToken' => '<string>',
    'ProgressUpdateStream' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

[
    'DiscoveredResourceList' => [
        [
            'ConfigurationId' => '<string>',
            'Description' => '<string>',
        ],
        // ...
    ],
    'NextToken' => '<string>',
]

Result Details

Errors

AccessDeniedException:

You do not have sufficient access to perform this action.

ThrottlingException:

The request was denied due to request throttling.

InternalServerError:

Exception raised when an internal, configuration, or dependency error is encountered.

ServiceUnavailableException:

Exception raised when there is an internal, configuration, or dependency error encountered.

InvalidInputException:

Exception raised when the provided input violates a policy constraint or is entered in the wrong format or data type.

ResourceNotFoundException:

Exception raised when the request references a resource (Application Discovery Service configuration, update stream, migration task, etc.) that does not exist in Application Discovery Service (Application Discovery Service) or in Migration Hub's repository.

HomeRegionNotSetException:

The home region is not set. Set the home region to continue.

ListMigrationTaskUpdates

$result = $client->listMigrationTaskUpdates([/* ... */]);
$promise = $client->listMigrationTaskUpdatesAsync([/* ... */]);

This is a paginated API that returns all the migration-task states for the specified MigrationTaskName and ProgressUpdateStream.

Parameter Syntax

$result = $client->listMigrationTaskUpdates([
    'MaxResults' => <integer>,
    'MigrationTaskName' => '<string>', // REQUIRED
    'NextToken' => '<string>',
    'ProgressUpdateStream' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

[
    'MigrationTaskUpdateList' => [
        [
            'MigrationTaskState' => [
                'ProgressPercent' => <integer>,
                'Status' => 'NOT_STARTED|IN_PROGRESS|FAILED|COMPLETED',
                'StatusDetail' => '<string>',
            ],
            'UpdateDateTime' => <DateTime>,
            'UpdateType' => 'MIGRATION_TASK_STATE_UPDATED',
        ],
        // ...
    ],
    'NextToken' => '<string>',
]

Result Details

Errors

AccessDeniedException:

You do not have sufficient access to perform this action.

ThrottlingException:

The request was denied due to request throttling.

InternalServerError:

Exception raised when an internal, configuration, or dependency error is encountered.

ServiceUnavailableException:

Exception raised when there is an internal, configuration, or dependency error encountered.

InvalidInputException:

Exception raised when the provided input violates a policy constraint or is entered in the wrong format or data type.

ResourceNotFoundException:

Exception raised when the request references a resource (Application Discovery Service configuration, update stream, migration task, etc.) that does not exist in Application Discovery Service (Application Discovery Service) or in Migration Hub's repository.

ListMigrationTasks

$result = $client->listMigrationTasks([/* ... */]);
$promise = $client->listMigrationTasksAsync([/* ... */]);

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.

Parameter Syntax

$result = $client->listMigrationTasks([
    'MaxResults' => <integer>,
    'NextToken' => '<string>',
    'ResourceName' => '<string>',
]);

Parameter Details

Result Syntax

[
    'MigrationTaskSummaryList' => [
        [
            'MigrationTaskName' => '<string>',
            'ProgressPercent' => <integer>,
            'ProgressUpdateStream' => '<string>',
            'Status' => 'NOT_STARTED|IN_PROGRESS|FAILED|COMPLETED',
            'StatusDetail' => '<string>',
            'UpdateDateTime' => <DateTime>,
        ],
        // ...
    ],
    'NextToken' => '<string>',
]

Result Details

Errors

AccessDeniedException:

You do not have sufficient access to perform this action.

ThrottlingException:

The request was denied due to request throttling.

InternalServerError:

Exception raised when an internal, configuration, or dependency error is encountered.

ServiceUnavailableException:

Exception raised when there is an internal, configuration, or dependency error encountered.

InvalidInputException:

Exception raised when the provided input violates a policy constraint or is entered in the wrong format or data type.

PolicyErrorException:

Exception raised when there are problems accessing Application Discovery Service (Application Discovery Service); most likely due to a misconfigured policy or the migrationhub-discovery role is missing or not configured correctly.

ResourceNotFoundException:

Exception raised when the request references a resource (Application Discovery Service configuration, update stream, migration task, etc.) that does not exist in Application Discovery Service (Application Discovery Service) or in Migration Hub's repository.

HomeRegionNotSetException:

The home region is not set. Set the home region to continue.

ListProgressUpdateStreams

$result = $client->listProgressUpdateStreams([/* ... */]);
$promise = $client->listProgressUpdateStreamsAsync([/* ... */]);

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

Parameter Syntax

$result = $client->listProgressUpdateStreams([
    'MaxResults' => <integer>,
    'NextToken' => '<string>',
]);

Parameter Details

Result Syntax

[
    'NextToken' => '<string>',
    'ProgressUpdateStreamSummaryList' => [
        [
            'ProgressUpdateStreamName' => '<string>',
        ],
        // ...
    ],
]

Result Details

Errors

AccessDeniedException:

You do not have sufficient access to perform this action.

ThrottlingException:

The request was denied due to request throttling.

InternalServerError:

Exception raised when an internal, configuration, or dependency error is encountered.

ServiceUnavailableException:

Exception raised when there is an internal, configuration, or dependency error encountered.

InvalidInputException:

Exception raised when the provided input violates a policy constraint or is entered in the wrong format or data type.

HomeRegionNotSetException:

The home region is not set. Set the home region to continue.

ListSourceResources

$result = $client->listSourceResources([/* ... */]);
$promise = $client->listSourceResourcesAsync([/* ... */]);

Lists all the source resource that are associated with the specified MigrationTaskName and ProgressUpdateStream.

Parameter Syntax

$result = $client->listSourceResources([
    'MaxResults' => <integer>,
    'MigrationTaskName' => '<string>', // REQUIRED
    'NextToken' => '<string>',
    'ProgressUpdateStream' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

[
    'NextToken' => '<string>',
    'SourceResourceList' => [
        [
            'Description' => '<string>',
            'Name' => '<string>',
            'StatusDetail' => '<string>',
        ],
        // ...
    ],
]

Result Details

Errors

AccessDeniedException:

You do not have sufficient access to perform this action.

ThrottlingException:

The request was denied due to request throttling.

InternalServerError:

Exception raised when an internal, configuration, or dependency error is encountered.

ServiceUnavailableException:

Exception raised when there is an internal, configuration, or dependency error encountered.

InvalidInputException:

Exception raised when the provided input violates a policy constraint or is entered in the wrong format or data type.

ResourceNotFoundException:

Exception raised when the request references a resource (Application Discovery Service configuration, update stream, migration task, etc.) that does not exist in Application Discovery Service (Application Discovery Service) or in Migration Hub's repository.

NotifyApplicationState

$result = $client->notifyApplicationState([/* ... */]);
$promise = $client->notifyApplicationStateAsync([/* ... */]);

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.

Parameter Syntax

$result = $client->notifyApplicationState([
    'ApplicationId' => '<string>', // REQUIRED
    'DryRun' => true || false,
    'Status' => 'NOT_STARTED|IN_PROGRESS|COMPLETED', // REQUIRED
    'UpdateDateTime' => <integer || string || DateTime>,
]);

Parameter Details

Result Syntax

[]

Result Details

Errors

AccessDeniedException:

You do not have sufficient access to perform this action.

ThrottlingException:

The request was denied due to request throttling.

InternalServerError:

Exception raised when an internal, configuration, or dependency error is encountered.

ServiceUnavailableException:

Exception raised when there is an internal, configuration, or dependency error encountered.

DryRunOperation:

Exception raised to indicate a successfully authorized action when the DryRun flag is set to "true".

UnauthorizedOperation:

Exception raised to indicate a request was not authorized when the DryRun flag is set to "true".

InvalidInputException:

Exception raised when the provided input violates a policy constraint or is entered in the wrong format or data type.

PolicyErrorException:

Exception raised when there are problems accessing Application Discovery Service (Application Discovery Service); most likely due to a misconfigured policy or the migrationhub-discovery role is missing or not configured correctly.

ResourceNotFoundException:

Exception raised when the request references a resource (Application Discovery Service configuration, update stream, migration task, etc.) that does not exist in Application Discovery Service (Application Discovery Service) or in Migration Hub's repository.

HomeRegionNotSetException:

The home region is not set. Set the home region to continue.

NotifyMigrationTaskState

$result = $client->notifyMigrationTaskState([/* ... */]);
$promise = $client->notifyMigrationTaskStateAsync([/* ... */]);

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.

Parameter Syntax

$result = $client->notifyMigrationTaskState([
    'DryRun' => true || false,
    'MigrationTaskName' => '<string>', // REQUIRED
    'NextUpdateSeconds' => <integer>, // REQUIRED
    'ProgressUpdateStream' => '<string>', // REQUIRED
    'Task' => [ // REQUIRED
        'ProgressPercent' => <integer>,
        'Status' => 'NOT_STARTED|IN_PROGRESS|FAILED|COMPLETED', // REQUIRED
        'StatusDetail' => '<string>',
    ],
    'UpdateDateTime' => <integer || string || DateTime>, // REQUIRED
]);

Parameter Details

Result Syntax

[]

Result Details

Errors

AccessDeniedException:

You do not have sufficient access to perform this action.

ThrottlingException:

The request was denied due to request throttling.

InternalServerError:

Exception raised when an internal, configuration, or dependency error is encountered.

ServiceUnavailableException:

Exception raised when there is an internal, configuration, or dependency error encountered.

DryRunOperation:

Exception raised to indicate a successfully authorized action when the DryRun flag is set to "true".

UnauthorizedOperation:

Exception raised to indicate a request was not authorized when the DryRun flag is set to "true".

InvalidInputException:

Exception raised when the provided input violates a policy constraint or is entered in the wrong format or data type.

ResourceNotFoundException:

Exception raised when the request references a resource (Application Discovery Service configuration, update stream, migration task, etc.) that does not exist in Application Discovery Service (Application Discovery Service) or in Migration Hub's repository.

HomeRegionNotSetException:

The home region is not set. Set the home region to continue.

PutResourceAttributes

$result = $client->putResourceAttributes([/* ... */]);
$promise = $client->putResourceAttributesAsync([/* ... */]);

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.

Parameter Syntax

$result = $client->putResourceAttributes([
    'DryRun' => true || false,
    'MigrationTaskName' => '<string>', // REQUIRED
    'ProgressUpdateStream' => '<string>', // REQUIRED
    'ResourceAttributeList' => [ // REQUIRED
        [
            'Type' => 'IPV4_ADDRESS|IPV6_ADDRESS|MAC_ADDRESS|FQDN|VM_MANAGER_ID|VM_MANAGED_OBJECT_REFERENCE|VM_NAME|VM_PATH|BIOS_ID|MOTHERBOARD_SERIAL_NUMBER', // REQUIRED
            'Value' => '<string>', // REQUIRED
        ],
        // ...
    ],
]);

Parameter Details

Result Syntax

[]

Result Details

Errors

AccessDeniedException:

You do not have sufficient access to perform this action.

ThrottlingException:

The request was denied due to request throttling.

InternalServerError:

Exception raised when an internal, configuration, or dependency error is encountered.

ServiceUnavailableException:

Exception raised when there is an internal, configuration, or dependency error encountered.

DryRunOperation:

Exception raised to indicate a successfully authorized action when the DryRun flag is set to "true".

UnauthorizedOperation:

Exception raised to indicate a request was not authorized when the DryRun flag is set to "true".

InvalidInputException:

Exception raised when the provided input violates a policy constraint or is entered in the wrong format or data type.

ResourceNotFoundException:

Exception raised when the request references a resource (Application Discovery Service configuration, update stream, migration task, etc.) that does not exist in Application Discovery Service (Application Discovery Service) or in Migration Hub's repository.

HomeRegionNotSetException:

The home region is not set. Set the home region to continue.