ArchiveApplication

$result = $client->archiveApplication([/* ... */]);
$promise = $client->archiveApplicationAsync([/* ... */]);

Archive application.

Parameter Syntax

$result = $client->archiveApplication([
    'accountID' => '<string>',
    'applicationID' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

[
    'applicationAggregatedStatus' => [
        'healthStatus' => 'HEALTHY|LAGGING|ERROR',
        'lastUpdateDateTime' => '<string>',
        'progressStatus' => 'NOT_STARTED|IN_PROGRESS|COMPLETED',
        'totalSourceServers' => <integer>,
    ],
    'applicationID' => '<string>',
    'arn' => '<string>',
    'creationDateTime' => '<string>',
    'description' => '<string>',
    'isArchived' => true || false,
    'lastModifiedDateTime' => '<string>',
    'name' => '<string>',
    'tags' => ['<string>', ...],
    'waveID' => '<string>',
]

Result Details

Errors

UninitializedAccountException:

Uninitialized account exception.

ResourceNotFoundException:

Resource not found exception.

ServiceQuotaExceededException:

The request could not be completed because its exceeded the service quota.

ConflictException:

The request could not be completed due to a conflict with the current state of the target resource.

ArchiveWave

$result = $client->archiveWave([/* ... */]);
$promise = $client->archiveWaveAsync([/* ... */]);

Archive wave.

Parameter Syntax

$result = $client->archiveWave([
    'accountID' => '<string>',
    'waveID' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

[
    'arn' => '<string>',
    'creationDateTime' => '<string>',
    'description' => '<string>',
    'isArchived' => true || false,
    'lastModifiedDateTime' => '<string>',
    'name' => '<string>',
    'tags' => ['<string>', ...],
    'waveAggregatedStatus' => [
        'healthStatus' => 'HEALTHY|LAGGING|ERROR',
        'lastUpdateDateTime' => '<string>',
        'progressStatus' => 'NOT_STARTED|IN_PROGRESS|COMPLETED',
        'replicationStartedDateTime' => '<string>',
        'totalApplications' => <integer>,
    ],
    'waveID' => '<string>',
]

Result Details

Errors

UninitializedAccountException:

Uninitialized account exception.

ResourceNotFoundException:

Resource not found exception.

ServiceQuotaExceededException:

The request could not be completed because its exceeded the service quota.

ConflictException:

The request could not be completed due to a conflict with the current state of the target resource.

AssociateApplications

$result = $client->associateApplications([/* ... */]);
$promise = $client->associateApplicationsAsync([/* ... */]);

Associate applications to wave.

Parameter Syntax

$result = $client->associateApplications([
    'accountID' => '<string>',
    'applicationIDs' => ['<string>', ...], // REQUIRED
    'waveID' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

[]

Result Details

Errors

UninitializedAccountException:

Uninitialized account exception.

ResourceNotFoundException:

Resource not found exception.

ServiceQuotaExceededException:

The request could not be completed because its exceeded the service quota.

ConflictException:

The request could not be completed due to a conflict with the current state of the target resource.

AssociateSourceServers

$result = $client->associateSourceServers([/* ... */]);
$promise = $client->associateSourceServersAsync([/* ... */]);

Associate source servers to application.

Parameter Syntax

$result = $client->associateSourceServers([
    'accountID' => '<string>',
    'applicationID' => '<string>', // REQUIRED
    'sourceServerIDs' => ['<string>', ...], // REQUIRED
]);

Parameter Details

Result Syntax

[]

Result Details

Errors

UninitializedAccountException:

Uninitialized account exception.

ResourceNotFoundException:

Resource not found exception.

ServiceQuotaExceededException:

The request could not be completed because its exceeded the service quota.

ConflictException:

The request could not be completed due to a conflict with the current state of the target resource.

ChangeServerLifeCycleState

$result = $client->changeServerLifeCycleState([/* ... */]);
$promise = $client->changeServerLifeCycleStateAsync([/* ... */]);

Allows the user to set the SourceServer.LifeCycle.state property for specific Source Server IDs to one of the following: READY_FOR_TEST or READY_FOR_CUTOVER. This command only works if the Source Server is already launchable (dataReplicationInfo.lagDuration is not null.)

Parameter Syntax

$result = $client->changeServerLifeCycleState([
    'accountID' => '<string>',
    'lifeCycle' => [ // REQUIRED
        'state' => 'READY_FOR_TEST|READY_FOR_CUTOVER|CUTOVER', // REQUIRED
    ],
    'sourceServerID' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

[
    'applicationID' => '<string>',
    'arn' => '<string>',
    'connectorAction' => [
        'connectorArn' => '<string>',
        'credentialsSecretArn' => '<string>',
    ],
    'dataReplicationInfo' => [
        'dataReplicationError' => [
            'error' => 'AGENT_NOT_SEEN|SNAPSHOTS_FAILURE|NOT_CONVERGING|UNSTABLE_NETWORK|FAILED_TO_CREATE_SECURITY_GROUP|FAILED_TO_LAUNCH_REPLICATION_SERVER|FAILED_TO_BOOT_REPLICATION_SERVER|FAILED_TO_AUTHENTICATE_WITH_SERVICE|FAILED_TO_DOWNLOAD_REPLICATION_SOFTWARE|FAILED_TO_CREATE_STAGING_DISKS|FAILED_TO_ATTACH_STAGING_DISKS|FAILED_TO_PAIR_REPLICATION_SERVER_WITH_AGENT|FAILED_TO_CONNECT_AGENT_TO_REPLICATION_SERVER|FAILED_TO_START_DATA_TRANSFER|UNSUPPORTED_VM_CONFIGURATION|LAST_SNAPSHOT_JOB_FAILED',
            'rawError' => '<string>',
        ],
        'dataReplicationInitiation' => [
            'nextAttemptDateTime' => '<string>',
            'startDateTime' => '<string>',
            'steps' => [
                [
                    'name' => 'WAIT|CREATE_SECURITY_GROUP|LAUNCH_REPLICATION_SERVER|BOOT_REPLICATION_SERVER|AUTHENTICATE_WITH_SERVICE|DOWNLOAD_REPLICATION_SOFTWARE|CREATE_STAGING_DISKS|ATTACH_STAGING_DISKS|PAIR_REPLICATION_SERVER_WITH_AGENT|CONNECT_AGENT_TO_REPLICATION_SERVER|START_DATA_TRANSFER',
                    'status' => 'NOT_STARTED|IN_PROGRESS|SUCCEEDED|FAILED|SKIPPED',
                ],
                // ...
            ],
        ],
        'dataReplicationState' => 'STOPPED|INITIATING|INITIAL_SYNC|BACKLOG|CREATING_SNAPSHOT|CONTINUOUS|PAUSED|RESCAN|STALLED|DISCONNECTED|PENDING_SNAPSHOT_SHIPPING|SHIPPING_SNAPSHOT',
        'etaDateTime' => '<string>',
        'lagDuration' => '<string>',
        'lastSnapshotDateTime' => '<string>',
        'replicatedDisks' => [
            [
                'backloggedStorageBytes' => <integer>,
                'deviceName' => '<string>',
                'replicatedStorageBytes' => <integer>,
                'rescannedStorageBytes' => <integer>,
                'totalStorageBytes' => <integer>,
            ],
            // ...
        ],
    ],
    'fqdnForActionFramework' => '<string>',
    'isArchived' => true || false,
    'launchedInstance' => [
        'ec2InstanceID' => '<string>',
        'firstBoot' => 'WAITING|SUCCEEDED|UNKNOWN|STOPPED',
        'jobID' => '<string>',
    ],
    'lifeCycle' => [
        'addedToServiceDateTime' => '<string>',
        'elapsedReplicationDuration' => '<string>',
        'firstByteDateTime' => '<string>',
        'lastCutover' => [
            'finalized' => [
                'apiCallDateTime' => '<string>',
            ],
            'initiated' => [
                'apiCallDateTime' => '<string>',
                'jobID' => '<string>',
            ],
            'reverted' => [
                'apiCallDateTime' => '<string>',
            ],
        ],
        'lastSeenByServiceDateTime' => '<string>',
        'lastTest' => [
            'finalized' => [
                'apiCallDateTime' => '<string>',
            ],
            'initiated' => [
                'apiCallDateTime' => '<string>',
                'jobID' => '<string>',
            ],
            'reverted' => [
                'apiCallDateTime' => '<string>',
            ],
        ],
        'state' => 'STOPPED|NOT_READY|READY_FOR_TEST|TESTING|READY_FOR_CUTOVER|CUTTING_OVER|CUTOVER|DISCONNECTED|DISCOVERED|PENDING_INSTALLATION',
    ],
    'replicationType' => 'AGENT_BASED|SNAPSHOT_SHIPPING',
    'sourceProperties' => [
        'cpus' => [
            [
                'cores' => <integer>,
                'modelName' => '<string>',
            ],
            // ...
        ],
        'disks' => [
            [
                'bytes' => <integer>,
                'deviceName' => '<string>',
            ],
            // ...
        ],
        'identificationHints' => [
            'awsInstanceID' => '<string>',
            'fqdn' => '<string>',
            'hostname' => '<string>',
            'vmPath' => '<string>',
            'vmWareUuid' => '<string>',
        ],
        'lastUpdatedDateTime' => '<string>',
        'networkInterfaces' => [
            [
                'ips' => ['<string>', ...],
                'isPrimary' => true || false,
                'macAddress' => '<string>',
            ],
            // ...
        ],
        'os' => [
            'fullString' => '<string>',
        ],
        'ramBytes' => <integer>,
        'recommendedInstanceType' => '<string>',
    ],
    'sourceServerID' => '<string>',
    'tags' => ['<string>', ...],
    'userProvidedID' => '<string>',
    'vcenterClientID' => '<string>',
]

Result Details

Errors

UninitializedAccountException:

Uninitialized account exception.

ResourceNotFoundException:

Resource not found exception.

ValidationException:

Validate exception.

ConflictException:

The request could not be completed due to a conflict with the current state of the target resource.

CreateApplication

$result = $client->createApplication([/* ... */]);
$promise = $client->createApplicationAsync([/* ... */]);

Create application.

Parameter Syntax

$result = $client->createApplication([
    'accountID' => '<string>',
    'description' => '<string>',
    'name' => '<string>', // REQUIRED
    'tags' => ['<string>', ...],
]);

Parameter Details

Result Syntax

[
    'applicationAggregatedStatus' => [
        'healthStatus' => 'HEALTHY|LAGGING|ERROR',
        'lastUpdateDateTime' => '<string>',
        'progressStatus' => 'NOT_STARTED|IN_PROGRESS|COMPLETED',
        'totalSourceServers' => <integer>,
    ],
    'applicationID' => '<string>',
    'arn' => '<string>',
    'creationDateTime' => '<string>',
    'description' => '<string>',
    'isArchived' => true || false,
    'lastModifiedDateTime' => '<string>',
    'name' => '<string>',
    'tags' => ['<string>', ...],
    'waveID' => '<string>',
]

Result Details

Errors

UninitializedAccountException:

Uninitialized account exception.

ServiceQuotaExceededException:

The request could not be completed because its exceeded the service quota.

ConflictException:

The request could not be completed due to a conflict with the current state of the target resource.

CreateConnector

$result = $client->createConnector([/* ... */]);
$promise = $client->createConnectorAsync([/* ... */]);

Create Connector.

Parameter Syntax

$result = $client->createConnector([
    'name' => '<string>', // REQUIRED
    'ssmCommandConfig' => [
        'cloudWatchLogGroupName' => '<string>',
        'cloudWatchOutputEnabled' => true || false, // REQUIRED
        'outputS3BucketName' => '<string>',
        's3OutputEnabled' => true || false, // REQUIRED
    ],
    'ssmInstanceID' => '<string>', // REQUIRED
    'tags' => ['<string>', ...],
]);

Parameter Details

Result Syntax

[
    'arn' => '<string>',
    'connectorID' => '<string>',
    'name' => '<string>',
    'ssmCommandConfig' => [
        'cloudWatchLogGroupName' => '<string>',
        'cloudWatchOutputEnabled' => true || false,
        'outputS3BucketName' => '<string>',
        's3OutputEnabled' => true || false,
    ],
    'ssmInstanceID' => '<string>',
    'tags' => ['<string>', ...],
]

Result Details

Errors

UninitializedAccountException:

Uninitialized account exception.

ValidationException:

Validate exception.

CreateLaunchConfigurationTemplate

$result = $client->createLaunchConfigurationTemplate([/* ... */]);
$promise = $client->createLaunchConfigurationTemplateAsync([/* ... */]);

Creates a new Launch Configuration Template.

Parameter Syntax

$result = $client->createLaunchConfigurationTemplate([
    'associatePublicIpAddress' => true || false,
    'bootMode' => 'LEGACY_BIOS|UEFI|USE_SOURCE',
    'copyPrivateIp' => true || false,
    'copyTags' => true || false,
    'enableMapAutoTagging' => true || false,
    'largeVolumeConf' => [
        'iops' => <integer>,
        'throughput' => <integer>,
        'volumeType' => 'io1|io2|gp3|gp2|st1|sc1|standard',
    ],
    'launchDisposition' => 'STOPPED|STARTED',
    'licensing' => [
        'osByol' => true || false,
    ],
    'mapAutoTaggingMpeID' => '<string>',
    'postLaunchActions' => [
        'cloudWatchLogGroupName' => '<string>',
        'deployment' => 'TEST_AND_CUTOVER|CUTOVER_ONLY|TEST_ONLY',
        's3LogBucket' => '<string>',
        's3OutputKeyPrefix' => '<string>',
        'ssmDocuments' => [
            [
                'actionName' => '<string>', // REQUIRED
                'externalParameters' => [
                    '<SsmDocumentParameterName>' => [
                        'dynamicPath' => '<string>',
                    ],
                    // ...
                ],
                'mustSucceedForCutover' => true || false,
                'parameters' => [
                    '<SsmDocumentParameterName>' => [
                        [
                            'parameterName' => '<string>', // REQUIRED
                            'parameterType' => 'STRING', // REQUIRED
                        ],
                        // ...
                    ],
                    // ...
                ],
                'ssmDocumentName' => '<string>', // REQUIRED
                'timeoutSeconds' => <integer>,
            ],
            // ...
        ],
    ],
    'smallVolumeConf' => [
        'iops' => <integer>,
        'throughput' => <integer>,
        'volumeType' => 'io1|io2|gp3|gp2|st1|sc1|standard',
    ],
    'smallVolumeMaxSize' => <integer>,
    'tags' => ['<string>', ...],
    'targetInstanceTypeRightSizingMethod' => 'NONE|BASIC',
]);

Parameter Details

Result Syntax

[
    'arn' => '<string>',
    'associatePublicIpAddress' => true || false,
    'bootMode' => 'LEGACY_BIOS|UEFI|USE_SOURCE',
    'copyPrivateIp' => true || false,
    'copyTags' => true || false,
    'ec2LaunchTemplateID' => '<string>',
    'enableMapAutoTagging' => true || false,
    'largeVolumeConf' => [
        'iops' => <integer>,
        'throughput' => <integer>,
        'volumeType' => 'io1|io2|gp3|gp2|st1|sc1|standard',
    ],
    'launchConfigurationTemplateID' => '<string>',
    'launchDisposition' => 'STOPPED|STARTED',
    'licensing' => [
        'osByol' => true || false,
    ],
    'mapAutoTaggingMpeID' => '<string>',
    'postLaunchActions' => [
        'cloudWatchLogGroupName' => '<string>',
        'deployment' => 'TEST_AND_CUTOVER|CUTOVER_ONLY|TEST_ONLY',
        's3LogBucket' => '<string>',
        's3OutputKeyPrefix' => '<string>',
        'ssmDocuments' => [
            [
                'actionName' => '<string>',
                'externalParameters' => [
                    '<SsmDocumentParameterName>' => [
                        'dynamicPath' => '<string>',
                    ],
                    // ...
                ],
                'mustSucceedForCutover' => true || false,
                'parameters' => [
                    '<SsmDocumentParameterName>' => [
                        [
                            'parameterName' => '<string>',
                            'parameterType' => 'STRING',
                        ],
                        // ...
                    ],
                    // ...
                ],
                'ssmDocumentName' => '<string>',
                'timeoutSeconds' => <integer>,
            ],
            // ...
        ],
    ],
    'smallVolumeConf' => [
        'iops' => <integer>,
        'throughput' => <integer>,
        'volumeType' => 'io1|io2|gp3|gp2|st1|sc1|standard',
    ],
    'smallVolumeMaxSize' => <integer>,
    'tags' => ['<string>', ...],
    'targetInstanceTypeRightSizingMethod' => 'NONE|BASIC',
]

Result Details

Errors

UninitializedAccountException:

Uninitialized account exception.

ValidationException:

Validate exception.

AccessDeniedException:

Operating denied due to a file permission or access check error.

CreateReplicationConfigurationTemplate

$result = $client->createReplicationConfigurationTemplate([/* ... */]);
$promise = $client->createReplicationConfigurationTemplateAsync([/* ... */]);

Creates a new ReplicationConfigurationTemplate.

Parameter Syntax

$result = $client->createReplicationConfigurationTemplate([
    'associateDefaultSecurityGroup' => true || false, // REQUIRED
    'bandwidthThrottling' => <integer>, // REQUIRED
    'createPublicIP' => true || false, // REQUIRED
    'dataPlaneRouting' => 'PRIVATE_IP|PUBLIC_IP', // REQUIRED
    'defaultLargeStagingDiskType' => 'GP2|ST1|GP3', // REQUIRED
    'ebsEncryption' => 'DEFAULT|CUSTOM', // REQUIRED
    'ebsEncryptionKeyArn' => '<string>',
    'replicationServerInstanceType' => '<string>', // REQUIRED
    'replicationServersSecurityGroupsIDs' => ['<string>', ...], // REQUIRED
    'stagingAreaSubnetId' => '<string>', // REQUIRED
    'stagingAreaTags' => ['<string>', ...], // REQUIRED
    'tags' => ['<string>', ...],
    'useDedicatedReplicationServer' => true || false, // REQUIRED
    'useFipsEndpoint' => true || false,
]);

Parameter Details

Result Syntax

[
    'arn' => '<string>',
    'associateDefaultSecurityGroup' => true || false,
    'bandwidthThrottling' => <integer>,
    'createPublicIP' => true || false,
    'dataPlaneRouting' => 'PRIVATE_IP|PUBLIC_IP',
    'defaultLargeStagingDiskType' => 'GP2|ST1|GP3',
    'ebsEncryption' => 'DEFAULT|CUSTOM',
    'ebsEncryptionKeyArn' => '<string>',
    'replicationConfigurationTemplateID' => '<string>',
    'replicationServerInstanceType' => '<string>',
    'replicationServersSecurityGroupsIDs' => ['<string>', ...],
    'stagingAreaSubnetId' => '<string>',
    'stagingAreaTags' => ['<string>', ...],
    'tags' => ['<string>', ...],
    'useDedicatedReplicationServer' => true || false,
    'useFipsEndpoint' => true || false,
]

Result Details

Errors

UninitializedAccountException:

Uninitialized account exception.

ValidationException:

Validate exception.

AccessDeniedException:

Operating denied due to a file permission or access check error.

CreateWave

$result = $client->createWave([/* ... */]);
$promise = $client->createWaveAsync([/* ... */]);

Create wave.

Parameter Syntax

$result = $client->createWave([
    'accountID' => '<string>',
    'description' => '<string>',
    'name' => '<string>', // REQUIRED
    'tags' => ['<string>', ...],
]);

Parameter Details

Result Syntax

[
    'arn' => '<string>',
    'creationDateTime' => '<string>',
    'description' => '<string>',
    'isArchived' => true || false,
    'lastModifiedDateTime' => '<string>',
    'name' => '<string>',
    'tags' => ['<string>', ...],
    'waveAggregatedStatus' => [
        'healthStatus' => 'HEALTHY|LAGGING|ERROR',
        'lastUpdateDateTime' => '<string>',
        'progressStatus' => 'NOT_STARTED|IN_PROGRESS|COMPLETED',
        'replicationStartedDateTime' => '<string>',
        'totalApplications' => <integer>,
    ],
    'waveID' => '<string>',
]

Result Details

Errors

UninitializedAccountException:

Uninitialized account exception.

ServiceQuotaExceededException:

The request could not be completed because its exceeded the service quota.

ConflictException:

The request could not be completed due to a conflict with the current state of the target resource.

DeleteApplication

$result = $client->deleteApplication([/* ... */]);
$promise = $client->deleteApplicationAsync([/* ... */]);

Delete application.

Parameter Syntax

$result = $client->deleteApplication([
    'accountID' => '<string>',
    'applicationID' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

[]

Result Details

Errors

UninitializedAccountException:

Uninitialized account exception.

ResourceNotFoundException:

Resource not found exception.

ConflictException:

The request could not be completed due to a conflict with the current state of the target resource.

DeleteConnector

$result = $client->deleteConnector([/* ... */]);
$promise = $client->deleteConnectorAsync([/* ... */]);

Delete Connector.

Parameter Syntax

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

Parameter Details

Result Syntax

[]

Result Details

Errors

UninitializedAccountException:

Uninitialized account exception.

ResourceNotFoundException:

Resource not found exception.

ValidationException:

Validate exception.

DeleteJob

$result = $client->deleteJob([/* ... */]);
$promise = $client->deleteJobAsync([/* ... */]);

Deletes a single Job by ID.

Parameter Syntax

$result = $client->deleteJob([
    'accountID' => '<string>',
    'jobID' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

[]

Result Details

Errors

UninitializedAccountException:

Uninitialized account exception.

ResourceNotFoundException:

Resource not found exception.

ConflictException:

The request could not be completed due to a conflict with the current state of the target resource.

DeleteLaunchConfigurationTemplate

$result = $client->deleteLaunchConfigurationTemplate([/* ... */]);
$promise = $client->deleteLaunchConfigurationTemplateAsync([/* ... */]);

Deletes a single Launch Configuration Template by ID.

Parameter Syntax

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

Parameter Details

Result Syntax

[]

Result Details

Errors

UninitializedAccountException:

Uninitialized account exception.

ResourceNotFoundException:

Resource not found exception.

ConflictException:

The request could not be completed due to a conflict with the current state of the target resource.

DeleteReplicationConfigurationTemplate

$result = $client->deleteReplicationConfigurationTemplate([/* ... */]);
$promise = $client->deleteReplicationConfigurationTemplateAsync([/* ... */]);

Deletes a single Replication Configuration Template by ID

Parameter Syntax

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

Parameter Details

Result Syntax

[]

Result Details

Errors

UninitializedAccountException:

Uninitialized account exception.

ResourceNotFoundException:

Resource not found exception.

ConflictException:

The request could not be completed due to a conflict with the current state of the target resource.

DeleteSourceServer

$result = $client->deleteSourceServer([/* ... */]);
$promise = $client->deleteSourceServerAsync([/* ... */]);

Deletes a single source server by ID.

Parameter Syntax

$result = $client->deleteSourceServer([
    'accountID' => '<string>',
    'sourceServerID' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

[]

Result Details

Errors

UninitializedAccountException:

Uninitialized account exception.

ResourceNotFoundException:

Resource not found exception.

ConflictException:

The request could not be completed due to a conflict with the current state of the target resource.

DeleteVcenterClient

$result = $client->deleteVcenterClient([/* ... */]);
$promise = $client->deleteVcenterClientAsync([/* ... */]);

Deletes a given vCenter client by ID.

Parameter Syntax

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

Parameter Details

Result Syntax

[]

Result Details

Errors

UninitializedAccountException:

Uninitialized account exception.

ResourceNotFoundException:

Resource not found exception.

ValidationException:

Validate exception.

DeleteWave

$result = $client->deleteWave([/* ... */]);
$promise = $client->deleteWaveAsync([/* ... */]);

Delete wave.

Parameter Syntax

$result = $client->deleteWave([
    'accountID' => '<string>',
    'waveID' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

[]

Result Details

Errors

UninitializedAccountException:

Uninitialized account exception.

ResourceNotFoundException:

Resource not found exception.

ConflictException:

The request could not be completed due to a conflict with the current state of the target resource.

DescribeJobLogItems

$result = $client->describeJobLogItems([/* ... */]);
$promise = $client->describeJobLogItemsAsync([/* ... */]);

Retrieves detailed job log items with paging.

Parameter Syntax

$result = $client->describeJobLogItems([
    'accountID' => '<string>',
    'jobID' => '<string>', // REQUIRED
    'maxResults' => <integer>,
    'nextToken' => '<string>',
]);

Parameter Details

Result Syntax

[
    'items' => [
        [
            'event' => 'JOB_START|SERVER_SKIPPED|CLEANUP_START|CLEANUP_END|CLEANUP_FAIL|SNAPSHOT_START|SNAPSHOT_END|SNAPSHOT_FAIL|USING_PREVIOUS_SNAPSHOT|CONVERSION_START|CONVERSION_END|CONVERSION_FAIL|LAUNCH_START|LAUNCH_FAILED|JOB_CANCEL|JOB_END',
            'eventData' => [
                'conversionServerID' => '<string>',
                'rawError' => '<string>',
                'sourceServerID' => '<string>',
                'targetInstanceID' => '<string>',
            ],
            'logDateTime' => '<string>',
        ],
        // ...
    ],
    'nextToken' => '<string>',
]

Result Details

Errors

UninitializedAccountException:

Uninitialized account exception.

ValidationException:

Validate exception.

DescribeJobs

$result = $client->describeJobs([/* ... */]);
$promise = $client->describeJobsAsync([/* ... */]);

Returns a list of Jobs. Use the JobsID and fromDate and toData filters to limit which jobs are returned. The response is sorted by creationDataTime - latest date first. Jobs are normally created by the StartTest, StartCutover, and TerminateTargetInstances APIs. Jobs are also created by DiagnosticLaunch and TerminateDiagnosticInstances, which are APIs available only to *Support* and only used in response to relevant support tickets.

Parameter Syntax

$result = $client->describeJobs([
    'accountID' => '<string>',
    'filters' => [
        'fromDate' => '<string>',
        'jobIDs' => ['<string>', ...],
        'toDate' => '<string>',
    ],
    'maxResults' => <integer>,
    'nextToken' => '<string>',
]);

Parameter Details

Result Syntax

[
    'items' => [
        [
            'arn' => '<string>',
            'creationDateTime' => '<string>',
            'endDateTime' => '<string>',
            'initiatedBy' => 'START_TEST|START_CUTOVER|DIAGNOSTIC|TERMINATE',
            'jobID' => '<string>',
            'participatingServers' => [
                [
                    'launchStatus' => 'PENDING|IN_PROGRESS|LAUNCHED|FAILED|TERMINATED',
                    'launchedEc2InstanceID' => '<string>',
                    'postLaunchActionsStatus' => [
                        'postLaunchActionsLaunchStatusList' => [
                            [
                                'executionID' => '<string>',
                                'executionStatus' => 'IN_PROGRESS|SUCCESS|FAILED',
                                'failureReason' => '<string>',
                                'ssmDocument' => [
                                    'actionName' => '<string>',
                                    'externalParameters' => [
                                        '<SsmDocumentParameterName>' => [
                                            'dynamicPath' => '<string>',
                                        ],
                                        // ...
                                    ],
                                    'mustSucceedForCutover' => true || false,
                                    'parameters' => [
                                        '<SsmDocumentParameterName>' => [
                                            [
                                                'parameterName' => '<string>',
                                                'parameterType' => 'STRING',
                                            ],
                                            // ...
                                        ],
                                        // ...
                                    ],
                                    'ssmDocumentName' => '<string>',
                                    'timeoutSeconds' => <integer>,
                                ],
                                'ssmDocumentType' => 'AUTOMATION|COMMAND',
                            ],
                            // ...
                        ],
                        'ssmAgentDiscoveryDatetime' => '<string>',
                    ],
                    'sourceServerID' => '<string>',
                ],
                // ...
            ],
            'status' => 'PENDING|STARTED|COMPLETED',
            'tags' => ['<string>', ...],
            'type' => 'LAUNCH|TERMINATE',
        ],
        // ...
    ],
    'nextToken' => '<string>',
]

Result Details

Errors

UninitializedAccountException:

Uninitialized account exception.

ValidationException:

Validate exception.

DescribeLaunchConfigurationTemplates

$result = $client->describeLaunchConfigurationTemplates([/* ... */]);
$promise = $client->describeLaunchConfigurationTemplatesAsync([/* ... */]);

Lists all Launch Configuration Templates, filtered by Launch Configuration Template IDs

Parameter Syntax

$result = $client->describeLaunchConfigurationTemplates([
    'launchConfigurationTemplateIDs' => ['<string>', ...],
    'maxResults' => <integer>,
    'nextToken' => '<string>',
]);

Parameter Details

Result Syntax

[
    'items' => [
        [
            'arn' => '<string>',
            'associatePublicIpAddress' => true || false,
            'bootMode' => 'LEGACY_BIOS|UEFI|USE_SOURCE',
            'copyPrivateIp' => true || false,
            'copyTags' => true || false,
            'ec2LaunchTemplateID' => '<string>',
            'enableMapAutoTagging' => true || false,
            'largeVolumeConf' => [
                'iops' => <integer>,
                'throughput' => <integer>,
                'volumeType' => 'io1|io2|gp3|gp2|st1|sc1|standard',
            ],
            'launchConfigurationTemplateID' => '<string>',
            'launchDisposition' => 'STOPPED|STARTED',
            'licensing' => [
                'osByol' => true || false,
            ],
            'mapAutoTaggingMpeID' => '<string>',
            'postLaunchActions' => [
                'cloudWatchLogGroupName' => '<string>',
                'deployment' => 'TEST_AND_CUTOVER|CUTOVER_ONLY|TEST_ONLY',
                's3LogBucket' => '<string>',
                's3OutputKeyPrefix' => '<string>',
                'ssmDocuments' => [
                    [
                        'actionName' => '<string>',
                        'externalParameters' => [
                            '<SsmDocumentParameterName>' => [
                                'dynamicPath' => '<string>',
                            ],
                            // ...
                        ],
                        'mustSucceedForCutover' => true || false,
                        'parameters' => [
                            '<SsmDocumentParameterName>' => [
                                [
                                    'parameterName' => '<string>',
                                    'parameterType' => 'STRING',
                                ],
                                // ...
                            ],
                            // ...
                        ],
                        'ssmDocumentName' => '<string>',
                        'timeoutSeconds' => <integer>,
                    ],
                    // ...
                ],
            ],
            'smallVolumeConf' => [
                'iops' => <integer>,
                'throughput' => <integer>,
                'volumeType' => 'io1|io2|gp3|gp2|st1|sc1|standard',
            ],
            'smallVolumeMaxSize' => <integer>,
            'tags' => ['<string>', ...],
            'targetInstanceTypeRightSizingMethod' => 'NONE|BASIC',
        ],
        // ...
    ],
    'nextToken' => '<string>',
]

Result Details

Errors

UninitializedAccountException:

Uninitialized account exception.

ResourceNotFoundException:

Resource not found exception.

ValidationException:

Validate exception.

DescribeReplicationConfigurationTemplates

$result = $client->describeReplicationConfigurationTemplates([/* ... */]);
$promise = $client->describeReplicationConfigurationTemplatesAsync([/* ... */]);

Lists all ReplicationConfigurationTemplates, filtered by Source Server IDs.

Parameter Syntax

$result = $client->describeReplicationConfigurationTemplates([
    'maxResults' => <integer>,
    'nextToken' => '<string>',
    'replicationConfigurationTemplateIDs' => ['<string>', ...],
]);

Parameter Details

Result Syntax

[
    'items' => [
        [
            'arn' => '<string>',
            'associateDefaultSecurityGroup' => true || false,
            'bandwidthThrottling' => <integer>,
            'createPublicIP' => true || false,
            'dataPlaneRouting' => 'PRIVATE_IP|PUBLIC_IP',
            'defaultLargeStagingDiskType' => 'GP2|ST1|GP3',
            'ebsEncryption' => 'DEFAULT|CUSTOM',
            'ebsEncryptionKeyArn' => '<string>',
            'replicationConfigurationTemplateID' => '<string>',
            'replicationServerInstanceType' => '<string>',
            'replicationServersSecurityGroupsIDs' => ['<string>', ...],
            'stagingAreaSubnetId' => '<string>',
            'stagingAreaTags' => ['<string>', ...],
            'tags' => ['<string>', ...],
            'useDedicatedReplicationServer' => true || false,
            'useFipsEndpoint' => true || false,
        ],
        // ...
    ],
    'nextToken' => '<string>',
]

Result Details

Errors

UninitializedAccountException:

Uninitialized account exception.

ResourceNotFoundException:

Resource not found exception.

ValidationException:

Validate exception.

DescribeSourceServers

$result = $client->describeSourceServers([/* ... */]);
$promise = $client->describeSourceServersAsync([/* ... */]);

Retrieves all SourceServers or multiple SourceServers by ID.

Parameter Syntax

$result = $client->describeSourceServers([
    'accountID' => '<string>',
    'filters' => [
        'applicationIDs' => ['<string>', ...],
        'isArchived' => true || false,
        'lifeCycleStates' => ['<string>', ...],
        'replicationTypes' => ['<string>', ...],
        'sourceServerIDs' => ['<string>', ...],
    ],
    'maxResults' => <integer>,
    'nextToken' => '<string>',
]);

Parameter Details

Result Syntax

[
    'items' => [
        [
            'applicationID' => '<string>',
            'arn' => '<string>',
            'connectorAction' => [
                'connectorArn' => '<string>',
                'credentialsSecretArn' => '<string>',
            ],
            'dataReplicationInfo' => [
                'dataReplicationError' => [
                    'error' => 'AGENT_NOT_SEEN|SNAPSHOTS_FAILURE|NOT_CONVERGING|UNSTABLE_NETWORK|FAILED_TO_CREATE_SECURITY_GROUP|FAILED_TO_LAUNCH_REPLICATION_SERVER|FAILED_TO_BOOT_REPLICATION_SERVER|FAILED_TO_AUTHENTICATE_WITH_SERVICE|FAILED_TO_DOWNLOAD_REPLICATION_SOFTWARE|FAILED_TO_CREATE_STAGING_DISKS|FAILED_TO_ATTACH_STAGING_DISKS|FAILED_TO_PAIR_REPLICATION_SERVER_WITH_AGENT|FAILED_TO_CONNECT_AGENT_TO_REPLICATION_SERVER|FAILED_TO_START_DATA_TRANSFER|UNSUPPORTED_VM_CONFIGURATION|LAST_SNAPSHOT_JOB_FAILED',
                    'rawError' => '<string>',
                ],
                'dataReplicationInitiation' => [
                    'nextAttemptDateTime' => '<string>',
                    'startDateTime' => '<string>',
                    'steps' => [
                        [
                            'name' => 'WAIT|CREATE_SECURITY_GROUP|LAUNCH_REPLICATION_SERVER|BOOT_REPLICATION_SERVER|AUTHENTICATE_WITH_SERVICE|DOWNLOAD_REPLICATION_SOFTWARE|CREATE_STAGING_DISKS|ATTACH_STAGING_DISKS|PAIR_REPLICATION_SERVER_WITH_AGENT|CONNECT_AGENT_TO_REPLICATION_SERVER|START_DATA_TRANSFER',
                            'status' => 'NOT_STARTED|IN_PROGRESS|SUCCEEDED|FAILED|SKIPPED',
                        ],
                        // ...
                    ],
                ],
                'dataReplicationState' => 'STOPPED|INITIATING|INITIAL_SYNC|BACKLOG|CREATING_SNAPSHOT|CONTINUOUS|PAUSED|RESCAN|STALLED|DISCONNECTED|PENDING_SNAPSHOT_SHIPPING|SHIPPING_SNAPSHOT',
                'etaDateTime' => '<string>',
                'lagDuration' => '<string>',
                'lastSnapshotDateTime' => '<string>',
                'replicatedDisks' => [
                    [
                        'backloggedStorageBytes' => <integer>,
                        'deviceName' => '<string>',
                        'replicatedStorageBytes' => <integer>,
                        'rescannedStorageBytes' => <integer>,
                        'totalStorageBytes' => <integer>,
                    ],
                    // ...
                ],
            ],
            'fqdnForActionFramework' => '<string>',
            'isArchived' => true || false,
            'launchedInstance' => [
                'ec2InstanceID' => '<string>',
                'firstBoot' => 'WAITING|SUCCEEDED|UNKNOWN|STOPPED',
                'jobID' => '<string>',
            ],
            'lifeCycle' => [
                'addedToServiceDateTime' => '<string>',
                'elapsedReplicationDuration' => '<string>',
                'firstByteDateTime' => '<string>',
                'lastCutover' => [
                    'finalized' => [
                        'apiCallDateTime' => '<string>',
                    ],
                    'initiated' => [
                        'apiCallDateTime' => '<string>',
                        'jobID' => '<string>',
                    ],
                    'reverted' => [
                        'apiCallDateTime' => '<string>',
                    ],
                ],
                'lastSeenByServiceDateTime' => '<string>',
                'lastTest' => [
                    'finalized' => [
                        'apiCallDateTime' => '<string>',
                    ],
                    'initiated' => [
                        'apiCallDateTime' => '<string>',
                        'jobID' => '<string>',
                    ],
                    'reverted' => [
                        'apiCallDateTime' => '<string>',
                    ],
                ],
                'state' => 'STOPPED|NOT_READY|READY_FOR_TEST|TESTING|READY_FOR_CUTOVER|CUTTING_OVER|CUTOVER|DISCONNECTED|DISCOVERED|PENDING_INSTALLATION',
            ],
            'replicationType' => 'AGENT_BASED|SNAPSHOT_SHIPPING',
            'sourceProperties' => [
                'cpus' => [
                    [
                        'cores' => <integer>,
                        'modelName' => '<string>',
                    ],
                    // ...
                ],
                'disks' => [
                    [
                        'bytes' => <integer>,
                        'deviceName' => '<string>',
                    ],
                    // ...
                ],
                'identificationHints' => [
                    'awsInstanceID' => '<string>',
                    'fqdn' => '<string>',
                    'hostname' => '<string>',
                    'vmPath' => '<string>',
                    'vmWareUuid' => '<string>',
                ],
                'lastUpdatedDateTime' => '<string>',
                'networkInterfaces' => [
                    [
                        'ips' => ['<string>', ...],
                        'isPrimary' => true || false,
                        'macAddress' => '<string>',
                    ],
                    // ...
                ],
                'os' => [
                    'fullString' => '<string>',
                ],
                'ramBytes' => <integer>,
                'recommendedInstanceType' => '<string>',
            ],
            'sourceServerID' => '<string>',
            'tags' => ['<string>', ...],
            'userProvidedID' => '<string>',
            'vcenterClientID' => '<string>',
        ],
        // ...
    ],
    'nextToken' => '<string>',
]

Result Details

Errors

UninitializedAccountException:

Uninitialized account exception.

ValidationException:

Validate exception.

DescribeVcenterClients

$result = $client->describeVcenterClients([/* ... */]);
$promise = $client->describeVcenterClientsAsync([/* ... */]);

Returns a list of the installed vCenter clients.

Parameter Syntax

$result = $client->describeVcenterClients([
    'maxResults' => <integer>,
    'nextToken' => '<string>',
]);

Parameter Details

Result Syntax

[
    'items' => [
        [
            'arn' => '<string>',
            'datacenterName' => '<string>',
            'hostname' => '<string>',
            'lastSeenDatetime' => '<string>',
            'sourceServerTags' => ['<string>', ...],
            'tags' => ['<string>', ...],
            'vcenterClientID' => '<string>',
            'vcenterUUID' => '<string>',
        ],
        // ...
    ],
    'nextToken' => '<string>',
]

Result Details

Errors

UninitializedAccountException:

Uninitialized account exception.

ResourceNotFoundException:

Resource not found exception.

ValidationException:

Validate exception.

DisassociateApplications

$result = $client->disassociateApplications([/* ... */]);
$promise = $client->disassociateApplicationsAsync([/* ... */]);

Disassociate applications from wave.

Parameter Syntax

$result = $client->disassociateApplications([
    'accountID' => '<string>',
    'applicationIDs' => ['<string>', ...], // REQUIRED
    'waveID' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

[]

Result Details

Errors

UninitializedAccountException:

Uninitialized account exception.

ResourceNotFoundException:

Resource not found exception.

ConflictException:

The request could not be completed due to a conflict with the current state of the target resource.

DisassociateSourceServers

$result = $client->disassociateSourceServers([/* ... */]);
$promise = $client->disassociateSourceServersAsync([/* ... */]);

Disassociate source servers from application.

Parameter Syntax

$result = $client->disassociateSourceServers([
    'accountID' => '<string>',
    'applicationID' => '<string>', // REQUIRED
    'sourceServerIDs' => ['<string>', ...], // REQUIRED
]);

Parameter Details

Result Syntax

[]

Result Details

Errors

UninitializedAccountException:

Uninitialized account exception.

ResourceNotFoundException:

Resource not found exception.

ConflictException:

The request could not be completed due to a conflict with the current state of the target resource.

DisconnectFromService

$result = $client->disconnectFromService([/* ... */]);
$promise = $client->disconnectFromServiceAsync([/* ... */]);

Disconnects specific Source Servers from Application Migration Service. Data replication is stopped immediately. All AWS resources created by Application Migration Service for enabling the replication of these source servers will be terminated / deleted within 90 minutes. Launched Test or Cutover instances will NOT be terminated. If the agent on the source server has not been prevented from communicating with the Application Migration Service service, then it will receive a command to uninstall itself (within approximately 10 minutes). The following properties of the SourceServer will be changed immediately: dataReplicationInfo.dataReplicationState will be set to DISCONNECTED; The totalStorageBytes property for each of dataReplicationInfo.replicatedDisks will be set to zero; dataReplicationInfo.lagDuration and dataReplicationInfo.lagDuration will be nullified.

Parameter Syntax

$result = $client->disconnectFromService([
    'accountID' => '<string>',
    'sourceServerID' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

[
    'applicationID' => '<string>',
    'arn' => '<string>',
    'connectorAction' => [
        'connectorArn' => '<string>',
        'credentialsSecretArn' => '<string>',
    ],
    'dataReplicationInfo' => [
        'dataReplicationError' => [
            'error' => 'AGENT_NOT_SEEN|SNAPSHOTS_FAILURE|NOT_CONVERGING|UNSTABLE_NETWORK|FAILED_TO_CREATE_SECURITY_GROUP|FAILED_TO_LAUNCH_REPLICATION_SERVER|FAILED_TO_BOOT_REPLICATION_SERVER|FAILED_TO_AUTHENTICATE_WITH_SERVICE|FAILED_TO_DOWNLOAD_REPLICATION_SOFTWARE|FAILED_TO_CREATE_STAGING_DISKS|FAILED_TO_ATTACH_STAGING_DISKS|FAILED_TO_PAIR_REPLICATION_SERVER_WITH_AGENT|FAILED_TO_CONNECT_AGENT_TO_REPLICATION_SERVER|FAILED_TO_START_DATA_TRANSFER|UNSUPPORTED_VM_CONFIGURATION|LAST_SNAPSHOT_JOB_FAILED',
            'rawError' => '<string>',
        ],
        'dataReplicationInitiation' => [
            'nextAttemptDateTime' => '<string>',
            'startDateTime' => '<string>',
            'steps' => [
                [
                    'name' => 'WAIT|CREATE_SECURITY_GROUP|LAUNCH_REPLICATION_SERVER|BOOT_REPLICATION_SERVER|AUTHENTICATE_WITH_SERVICE|DOWNLOAD_REPLICATION_SOFTWARE|CREATE_STAGING_DISKS|ATTACH_STAGING_DISKS|PAIR_REPLICATION_SERVER_WITH_AGENT|CONNECT_AGENT_TO_REPLICATION_SERVER|START_DATA_TRANSFER',
                    'status' => 'NOT_STARTED|IN_PROGRESS|SUCCEEDED|FAILED|SKIPPED',
                ],
                // ...
            ],
        ],
        'dataReplicationState' => 'STOPPED|INITIATING|INITIAL_SYNC|BACKLOG|CREATING_SNAPSHOT|CONTINUOUS|PAUSED|RESCAN|STALLED|DISCONNECTED|PENDING_SNAPSHOT_SHIPPING|SHIPPING_SNAPSHOT',
        'etaDateTime' => '<string>',
        'lagDuration' => '<string>',
        'lastSnapshotDateTime' => '<string>',
        'replicatedDisks' => [
            [
                'backloggedStorageBytes' => <integer>,
                'deviceName' => '<string>',
                'replicatedStorageBytes' => <integer>,
                'rescannedStorageBytes' => <integer>,
                'totalStorageBytes' => <integer>,
            ],
            // ...
        ],
    ],
    'fqdnForActionFramework' => '<string>',
    'isArchived' => true || false,
    'launchedInstance' => [
        'ec2InstanceID' => '<string>',
        'firstBoot' => 'WAITING|SUCCEEDED|UNKNOWN|STOPPED',
        'jobID' => '<string>',
    ],
    'lifeCycle' => [
        'addedToServiceDateTime' => '<string>',
        'elapsedReplicationDuration' => '<string>',
        'firstByteDateTime' => '<string>',
        'lastCutover' => [
            'finalized' => [
                'apiCallDateTime' => '<string>',
            ],
            'initiated' => [
                'apiCallDateTime' => '<string>',
                'jobID' => '<string>',
            ],
            'reverted' => [
                'apiCallDateTime' => '<string>',
            ],
        ],
        'lastSeenByServiceDateTime' => '<string>',
        'lastTest' => [
            'finalized' => [
                'apiCallDateTime' => '<string>',
            ],
            'initiated' => [
                'apiCallDateTime' => '<string>',
                'jobID' => '<string>',
            ],
            'reverted' => [
                'apiCallDateTime' => '<string>',
            ],
        ],
        'state' => 'STOPPED|NOT_READY|READY_FOR_TEST|TESTING|READY_FOR_CUTOVER|CUTTING_OVER|CUTOVER|DISCONNECTED|DISCOVERED|PENDING_INSTALLATION',
    ],
    'replicationType' => 'AGENT_BASED|SNAPSHOT_SHIPPING',
    'sourceProperties' => [
        'cpus' => [
            [
                'cores' => <integer>,
                'modelName' => '<string>',
            ],
            // ...
        ],
        'disks' => [
            [
                'bytes' => <integer>,
                'deviceName' => '<string>',
            ],
            // ...
        ],
        'identificationHints' => [
            'awsInstanceID' => '<string>',
            'fqdn' => '<string>',
            'hostname' => '<string>',
            'vmPath' => '<string>',
            'vmWareUuid' => '<string>',
        ],
        'lastUpdatedDateTime' => '<string>',
        'networkInterfaces' => [
            [
                'ips' => ['<string>', ...],
                'isPrimary' => true || false,
                'macAddress' => '<string>',
            ],
            // ...
        ],
        'os' => [
            'fullString' => '<string>',
        ],
        'ramBytes' => <integer>,
        'recommendedInstanceType' => '<string>',
    ],
    'sourceServerID' => '<string>',
    'tags' => ['<string>', ...],
    'userProvidedID' => '<string>',
    'vcenterClientID' => '<string>',
]

Result Details

Errors

UninitializedAccountException:

Uninitialized account exception.

ResourceNotFoundException:

Resource not found exception.

ConflictException:

The request could not be completed due to a conflict with the current state of the target resource.

FinalizeCutover

$result = $client->finalizeCutover([/* ... */]);
$promise = $client->finalizeCutoverAsync([/* ... */]);

Finalizes the cutover immediately for specific Source Servers. All AWS resources created by Application Migration Service for enabling the replication of these source servers will be terminated / deleted within 90 minutes. Launched Test or Cutover instances will NOT be terminated. The AWS Replication Agent will receive a command to uninstall itself (within 10 minutes). The following properties of the SourceServer will be changed immediately: dataReplicationInfo.dataReplicationState will be changed to DISCONNECTED; The SourceServer.lifeCycle.state will be changed to CUTOVER; The totalStorageBytes property fo each of dataReplicationInfo.replicatedDisks will be set to zero; dataReplicationInfo.lagDuration and dataReplicationInfo.lagDuration will be nullified.

Parameter Syntax

$result = $client->finalizeCutover([
    'accountID' => '<string>',
    'sourceServerID' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

[
    'applicationID' => '<string>',
    'arn' => '<string>',
    'connectorAction' => [
        'connectorArn' => '<string>',
        'credentialsSecretArn' => '<string>',
    ],
    'dataReplicationInfo' => [
        'dataReplicationError' => [
            'error' => 'AGENT_NOT_SEEN|SNAPSHOTS_FAILURE|NOT_CONVERGING|UNSTABLE_NETWORK|FAILED_TO_CREATE_SECURITY_GROUP|FAILED_TO_LAUNCH_REPLICATION_SERVER|FAILED_TO_BOOT_REPLICATION_SERVER|FAILED_TO_AUTHENTICATE_WITH_SERVICE|FAILED_TO_DOWNLOAD_REPLICATION_SOFTWARE|FAILED_TO_CREATE_STAGING_DISKS|FAILED_TO_ATTACH_STAGING_DISKS|FAILED_TO_PAIR_REPLICATION_SERVER_WITH_AGENT|FAILED_TO_CONNECT_AGENT_TO_REPLICATION_SERVER|FAILED_TO_START_DATA_TRANSFER|UNSUPPORTED_VM_CONFIGURATION|LAST_SNAPSHOT_JOB_FAILED',
            'rawError' => '<string>',
        ],
        'dataReplicationInitiation' => [
            'nextAttemptDateTime' => '<string>',
            'startDateTime' => '<string>',
            'steps' => [
                [
                    'name' => 'WAIT|CREATE_SECURITY_GROUP|LAUNCH_REPLICATION_SERVER|BOOT_REPLICATION_SERVER|AUTHENTICATE_WITH_SERVICE|DOWNLOAD_REPLICATION_SOFTWARE|CREATE_STAGING_DISKS|ATTACH_STAGING_DISKS|PAIR_REPLICATION_SERVER_WITH_AGENT|CONNECT_AGENT_TO_REPLICATION_SERVER|START_DATA_TRANSFER',
                    'status' => 'NOT_STARTED|IN_PROGRESS|SUCCEEDED|FAILED|SKIPPED',
                ],
                // ...
            ],
        ],
        'dataReplicationState' => 'STOPPED|INITIATING|INITIAL_SYNC|BACKLOG|CREATING_SNAPSHOT|CONTINUOUS|PAUSED|RESCAN|STALLED|DISCONNECTED|PENDING_SNAPSHOT_SHIPPING|SHIPPING_SNAPSHOT',
        'etaDateTime' => '<string>',
        'lagDuration' => '<string>',
        'lastSnapshotDateTime' => '<string>',
        'replicatedDisks' => [
            [
                'backloggedStorageBytes' => <integer>,
                'deviceName' => '<string>',
                'replicatedStorageBytes' => <integer>,
                'rescannedStorageBytes' => <integer>,
                'totalStorageBytes' => <integer>,
            ],
            // ...
        ],
    ],
    'fqdnForActionFramework' => '<string>',
    'isArchived' => true || false,
    'launchedInstance' => [
        'ec2InstanceID' => '<string>',
        'firstBoot' => 'WAITING|SUCCEEDED|UNKNOWN|STOPPED',
        'jobID' => '<string>',
    ],
    'lifeCycle' => [
        'addedToServiceDateTime' => '<string>',
        'elapsedReplicationDuration' => '<string>',
        'firstByteDateTime' => '<string>',
        'lastCutover' => [
            'finalized' => [
                'apiCallDateTime' => '<string>',
            ],
            'initiated' => [
                'apiCallDateTime' => '<string>',
                'jobID' => '<string>',
            ],
            'reverted' => [
                'apiCallDateTime' => '<string>',
            ],
        ],
        'lastSeenByServiceDateTime' => '<string>',
        'lastTest' => [
            'finalized' => [
                'apiCallDateTime' => '<string>',
            ],
            'initiated' => [
                'apiCallDateTime' => '<string>',
                'jobID' => '<string>',
            ],
            'reverted' => [
                'apiCallDateTime' => '<string>',
            ],
        ],
        'state' => 'STOPPED|NOT_READY|READY_FOR_TEST|TESTING|READY_FOR_CUTOVER|CUTTING_OVER|CUTOVER|DISCONNECTED|DISCOVERED|PENDING_INSTALLATION',
    ],
    'replicationType' => 'AGENT_BASED|SNAPSHOT_SHIPPING',
    'sourceProperties' => [
        'cpus' => [
            [
                'cores' => <integer>,
                'modelName' => '<string>',
            ],
            // ...
        ],
        'disks' => [
            [
                'bytes' => <integer>,
                'deviceName' => '<string>',
            ],
            // ...
        ],
        'identificationHints' => [
            'awsInstanceID' => '<string>',
            'fqdn' => '<string>',
            'hostname' => '<string>',
            'vmPath' => '<string>',
            'vmWareUuid' => '<string>',
        ],
        'lastUpdatedDateTime' => '<string>',
        'networkInterfaces' => [
            [
                'ips' => ['<string>', ...],
                'isPrimary' => true || false,
                'macAddress' => '<string>',
            ],
            // ...
        ],
        'os' => [
            'fullString' => '<string>',
        ],
        'ramBytes' => <integer>,
        'recommendedInstanceType' => '<string>',
    ],
    'sourceServerID' => '<string>',
    'tags' => ['<string>', ...],
    'userProvidedID' => '<string>',
    'vcenterClientID' => '<string>',
]

Result Details

Errors

UninitializedAccountException:

Uninitialized account exception.

ResourceNotFoundException:

Resource not found exception.

ValidationException:

Validate exception.

ConflictException:

The request could not be completed due to a conflict with the current state of the target resource.

GetLaunchConfiguration

$result = $client->getLaunchConfiguration([/* ... */]);
$promise = $client->getLaunchConfigurationAsync([/* ... */]);

Lists all LaunchConfigurations available, filtered by Source Server IDs.

Parameter Syntax

$result = $client->getLaunchConfiguration([
    'accountID' => '<string>',
    'sourceServerID' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

[
    'bootMode' => 'LEGACY_BIOS|UEFI|USE_SOURCE',
    'copyPrivateIp' => true || false,
    'copyTags' => true || false,
    'ec2LaunchTemplateID' => '<string>',
    'enableMapAutoTagging' => true || false,
    'launchDisposition' => 'STOPPED|STARTED',
    'licensing' => [
        'osByol' => true || false,
    ],
    'mapAutoTaggingMpeID' => '<string>',
    'name' => '<string>',
    'postLaunchActions' => [
        'cloudWatchLogGroupName' => '<string>',
        'deployment' => 'TEST_AND_CUTOVER|CUTOVER_ONLY|TEST_ONLY',
        's3LogBucket' => '<string>',
        's3OutputKeyPrefix' => '<string>',
        'ssmDocuments' => [
            [
                'actionName' => '<string>',
                'externalParameters' => [
                    '<SsmDocumentParameterName>' => [
                        'dynamicPath' => '<string>',
                    ],
                    // ...
                ],
                'mustSucceedForCutover' => true || false,
                'parameters' => [
                    '<SsmDocumentParameterName>' => [
                        [
                            'parameterName' => '<string>',
                            'parameterType' => 'STRING',
                        ],
                        // ...
                    ],
                    // ...
                ],
                'ssmDocumentName' => '<string>',
                'timeoutSeconds' => <integer>,
            ],
            // ...
        ],
    ],
    'sourceServerID' => '<string>',
    'targetInstanceTypeRightSizingMethod' => 'NONE|BASIC',
]

Result Details

Errors

UninitializedAccountException:

Uninitialized account exception.

ResourceNotFoundException:

Resource not found exception.

GetReplicationConfiguration

$result = $client->getReplicationConfiguration([/* ... */]);
$promise = $client->getReplicationConfigurationAsync([/* ... */]);

Lists all ReplicationConfigurations, filtered by Source Server ID.

Parameter Syntax

$result = $client->getReplicationConfiguration([
    'accountID' => '<string>',
    'sourceServerID' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

[
    'associateDefaultSecurityGroup' => true || false,
    'bandwidthThrottling' => <integer>,
    'createPublicIP' => true || false,
    'dataPlaneRouting' => 'PRIVATE_IP|PUBLIC_IP',
    'defaultLargeStagingDiskType' => 'GP2|ST1|GP3',
    'ebsEncryption' => 'DEFAULT|CUSTOM',
    'ebsEncryptionKeyArn' => '<string>',
    'name' => '<string>',
    'replicatedDisks' => [
        [
            'deviceName' => '<string>',
            'iops' => <integer>,
            'isBootDisk' => true || false,
            'stagingDiskType' => 'AUTO|GP2|IO1|SC1|ST1|STANDARD|GP3|IO2',
            'throughput' => <integer>,
        ],
        // ...
    ],
    'replicationServerInstanceType' => '<string>',
    'replicationServersSecurityGroupsIDs' => ['<string>', ...],
    'sourceServerID' => '<string>',
    'stagingAreaSubnetId' => '<string>',
    'stagingAreaTags' => ['<string>', ...],
    'useDedicatedReplicationServer' => true || false,
    'useFipsEndpoint' => true || false,
]

Result Details

Errors

UninitializedAccountException:

Uninitialized account exception.

ResourceNotFoundException:

Resource not found exception.

InitializeService

$result = $client->initializeService([/* ... */]);
$promise = $client->initializeServiceAsync([/* ... */]);

Initialize Application Migration Service.

Parameter Syntax

$result = $client->initializeService([
]);

Parameter Details

Result Syntax

[]

Result Details

Errors

ValidationException:

Validate exception.

AccessDeniedException:

Operating denied due to a file permission or access check error.

ListApplications

$result = $client->listApplications([/* ... */]);
$promise = $client->listApplicationsAsync([/* ... */]);

Retrieves all applications or multiple applications by ID.

Parameter Syntax

$result = $client->listApplications([
    'accountID' => '<string>',
    'filters' => [
        'applicationIDs' => ['<string>', ...],
        'isArchived' => true || false,
        'waveIDs' => ['<string>', ...],
    ],
    'maxResults' => <integer>,
    'nextToken' => '<string>',
]);

Parameter Details

Result Syntax

[
    'items' => [
        [
            'applicationAggregatedStatus' => [
                'healthStatus' => 'HEALTHY|LAGGING|ERROR',
                'lastUpdateDateTime' => '<string>',
                'progressStatus' => 'NOT_STARTED|IN_PROGRESS|COMPLETED',
                'totalSourceServers' => <integer>,
            ],
            'applicationID' => '<string>',
            'arn' => '<string>',
            'creationDateTime' => '<string>',
            'description' => '<string>',
            'isArchived' => true || false,
            'lastModifiedDateTime' => '<string>',
            'name' => '<string>',
            'tags' => ['<string>', ...],
            'waveID' => '<string>',
        ],
        // ...
    ],
    'nextToken' => '<string>',
]

Result Details

Errors

UninitializedAccountException:

Uninitialized account exception.

ListConnectors

$result = $client->listConnectors([/* ... */]);
$promise = $client->listConnectorsAsync([/* ... */]);

List Connectors.

Parameter Syntax

$result = $client->listConnectors([
    'filters' => [
        'connectorIDs' => ['<string>', ...],
    ],
    'maxResults' => <integer>,
    'nextToken' => '<string>',
]);

Parameter Details

Result Syntax

[
    'items' => [
        [
            'arn' => '<string>',
            'connectorID' => '<string>',
            'name' => '<string>',
            'ssmCommandConfig' => [
                'cloudWatchLogGroupName' => '<string>',
                'cloudWatchOutputEnabled' => true || false,
                'outputS3BucketName' => '<string>',
                's3OutputEnabled' => true || false,
            ],
            'ssmInstanceID' => '<string>',
            'tags' => ['<string>', ...],
        ],
        // ...
    ],
    'nextToken' => '<string>',
]

Result Details

Errors

UninitializedAccountException:

Uninitialized account exception.

ValidationException:

Validate exception.

ListExportErrors

$result = $client->listExportErrors([/* ... */]);
$promise = $client->listExportErrorsAsync([/* ... */]);

List export errors.

Parameter Syntax

$result = $client->listExportErrors([
    'exportID' => '<string>', // REQUIRED
    'maxResults' => <integer>,
    'nextToken' => '<string>',
]);

Parameter Details

Result Syntax

[
    'items' => [
        [
            'errorData' => [
                'rawError' => '<string>',
            ],
            'errorDateTime' => '<string>',
        ],
        // ...
    ],
    'nextToken' => '<string>',
]

Result Details

Errors

UninitializedAccountException:

Uninitialized account exception.

ValidationException:

Validate exception.

ListExports

$result = $client->listExports([/* ... */]);
$promise = $client->listExportsAsync([/* ... */]);

List exports.

Parameter Syntax

$result = $client->listExports([
    'filters' => [
        'exportIDs' => ['<string>', ...],
    ],
    'maxResults' => <integer>,
    'nextToken' => '<string>',
]);

Parameter Details

Result Syntax

[
    'items' => [
        [
            'creationDateTime' => '<string>',
            'endDateTime' => '<string>',
            'exportID' => '<string>',
            'progressPercentage' => <float>,
            's3Bucket' => '<string>',
            's3BucketOwner' => '<string>',
            's3Key' => '<string>',
            'status' => 'PENDING|STARTED|FAILED|SUCCEEDED',
            'summary' => [
                'applicationsCount' => <integer>,
                'serversCount' => <integer>,
                'wavesCount' => <integer>,
            ],
        ],
        // ...
    ],
    'nextToken' => '<string>',
]

Result Details

Errors

UninitializedAccountException:

Uninitialized account exception.

ListImportErrors

$result = $client->listImportErrors([/* ... */]);
$promise = $client->listImportErrorsAsync([/* ... */]);

List import errors.

Parameter Syntax

$result = $client->listImportErrors([
    'importID' => '<string>', // REQUIRED
    'maxResults' => <integer>,
    'nextToken' => '<string>',
]);

Parameter Details

Result Syntax

[
    'items' => [
        [
            'errorData' => [
                'accountID' => '<string>',
                'applicationID' => '<string>',
                'ec2LaunchTemplateID' => '<string>',
                'rawError' => '<string>',
                'rowNumber' => <integer>,
                'sourceServerID' => '<string>',
                'waveID' => '<string>',
            ],
            'errorDateTime' => '<string>',
            'errorType' => 'VALIDATION_ERROR|PROCESSING_ERROR',
        ],
        // ...
    ],
    'nextToken' => '<string>',
]

Result Details

Errors

UninitializedAccountException:

Uninitialized account exception.

ValidationException:

Validate exception.

ListImports

$result = $client->listImports([/* ... */]);
$promise = $client->listImportsAsync([/* ... */]);

List imports.

Parameter Syntax

$result = $client->listImports([
    'filters' => [
        'importIDs' => ['<string>', ...],
    ],
    'maxResults' => <integer>,
    'nextToken' => '<string>',
]);

Parameter Details

Result Syntax

[
    'items' => [
        [
            'creationDateTime' => '<string>',
            'endDateTime' => '<string>',
            'importID' => '<string>',
            'progressPercentage' => <float>,
            's3BucketSource' => [
                's3Bucket' => '<string>',
                's3BucketOwner' => '<string>',
                's3Key' => '<string>',
            ],
            'status' => 'PENDING|STARTED|FAILED|SUCCEEDED',
            'summary' => [
                'applications' => [
                    'createdCount' => <integer>,
                    'modifiedCount' => <integer>,
                ],
                'servers' => [
                    'createdCount' => <integer>,
                    'modifiedCount' => <integer>,
                ],
                'waves' => [
                    'createdCount' => <integer>,
                    'modifiedCount' => <integer>,
                ],
            ],
        ],
        // ...
    ],
    'nextToken' => '<string>',
]

Result Details

Errors

UninitializedAccountException:

Uninitialized account exception.

ValidationException:

Validate exception.

ListManagedAccounts

$result = $client->listManagedAccounts([/* ... */]);
$promise = $client->listManagedAccountsAsync([/* ... */]);

List Managed Accounts.

Parameter Syntax

$result = $client->listManagedAccounts([
    'maxResults' => <integer>,
    'nextToken' => '<string>',
]);

Parameter Details

Result Syntax

[
    'items' => [
        [
            'accountId' => '<string>',
        ],
        // ...
    ],
    'nextToken' => '<string>',
]

Result Details

Errors

UninitializedAccountException:

Uninitialized account exception.

ValidationException:

Validate exception.

ListSourceServerActions

$result = $client->listSourceServerActions([/* ... */]);
$promise = $client->listSourceServerActionsAsync([/* ... */]);

List source server post migration custom actions.

Parameter Syntax

$result = $client->listSourceServerActions([
    'accountID' => '<string>',
    'filters' => [
        'actionIDs' => ['<string>', ...],
    ],
    'maxResults' => <integer>,
    'nextToken' => '<string>',
    'sourceServerID' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

[
    'items' => [
        [
            'actionID' => '<string>',
            'actionName' => '<string>',
            'active' => true || false,
            'category' => 'DISASTER_RECOVERY|OPERATING_SYSTEM|LICENSE_AND_SUBSCRIPTION|VALIDATION|OBSERVABILITY|REFACTORING|SECURITY|NETWORKING|CONFIGURATION|BACKUP|OTHER',
            'description' => '<string>',
            'documentIdentifier' => '<string>',
            'documentVersion' => '<string>',
            'externalParameters' => [
                '<SsmDocumentParameterName>' => [
                    'dynamicPath' => '<string>',
                ],
                // ...
            ],
            'mustSucceedForCutover' => true || false,
            'order' => <integer>,
            'parameters' => [
                '<SsmDocumentParameterName>' => [
                    [
                        'parameterName' => '<string>',
                        'parameterType' => 'STRING',
                    ],
                    // ...
                ],
                // ...
            ],
            'timeoutSeconds' => <integer>,
        ],
        // ...
    ],
    'nextToken' => '<string>',
]

Result Details

Errors

UninitializedAccountException:

Uninitialized account exception.

ResourceNotFoundException:

Resource not found exception.

ListTagsForResource

$result = $client->listTagsForResource([/* ... */]);
$promise = $client->listTagsForResourceAsync([/* ... */]);

List all tags for your Application Migration Service resources.

Parameter Syntax

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

Parameter Details

Result Syntax

[
    'tags' => ['<string>', ...],
]

Result Details

Errors

ResourceNotFoundException:

Resource not found exception.

ThrottlingException:

Reached throttling quota exception.

ValidationException:

Validate exception.

AccessDeniedException:

Operating denied due to a file permission or access check error.

InternalServerException:

The server encountered an unexpected condition that prevented it from fulfilling the request.

ListTemplateActions

$result = $client->listTemplateActions([/* ... */]);
$promise = $client->listTemplateActionsAsync([/* ... */]);

List template post migration custom actions.

Parameter Syntax

$result = $client->listTemplateActions([
    'filters' => [
        'actionIDs' => ['<string>', ...],
    ],
    'launchConfigurationTemplateID' => '<string>', // REQUIRED
    'maxResults' => <integer>,
    'nextToken' => '<string>',
]);

Parameter Details

Result Syntax

[
    'items' => [
        [
            'actionID' => '<string>',
            'actionName' => '<string>',
            'active' => true || false,
            'category' => 'DISASTER_RECOVERY|OPERATING_SYSTEM|LICENSE_AND_SUBSCRIPTION|VALIDATION|OBSERVABILITY|REFACTORING|SECURITY|NETWORKING|CONFIGURATION|BACKUP|OTHER',
            'description' => '<string>',
            'documentIdentifier' => '<string>',
            'documentVersion' => '<string>',
            'externalParameters' => [
                '<SsmDocumentParameterName>' => [
                    'dynamicPath' => '<string>',
                ],
                // ...
            ],
            'mustSucceedForCutover' => true || false,
            'operatingSystem' => '<string>',
            'order' => <integer>,
            'parameters' => [
                '<SsmDocumentParameterName>' => [
                    [
                        'parameterName' => '<string>',
                        'parameterType' => 'STRING',
                    ],
                    // ...
                ],
                // ...
            ],
            'timeoutSeconds' => <integer>,
        ],
        // ...
    ],
    'nextToken' => '<string>',
]

Result Details

Errors

UninitializedAccountException:

Uninitialized account exception.

ResourceNotFoundException:

Resource not found exception.

ListWaves

$result = $client->listWaves([/* ... */]);
$promise = $client->listWavesAsync([/* ... */]);

Retrieves all waves or multiple waves by ID.

Parameter Syntax

$result = $client->listWaves([
    'accountID' => '<string>',
    'filters' => [
        'isArchived' => true || false,
        'waveIDs' => ['<string>', ...],
    ],
    'maxResults' => <integer>,
    'nextToken' => '<string>',
]);

Parameter Details

Result Syntax

[
    'items' => [
        [
            'arn' => '<string>',
            'creationDateTime' => '<string>',
            'description' => '<string>',
            'isArchived' => true || false,
            'lastModifiedDateTime' => '<string>',
            'name' => '<string>',
            'tags' => ['<string>', ...],
            'waveAggregatedStatus' => [
                'healthStatus' => 'HEALTHY|LAGGING|ERROR',
                'lastUpdateDateTime' => '<string>',
                'progressStatus' => 'NOT_STARTED|IN_PROGRESS|COMPLETED',
                'replicationStartedDateTime' => '<string>',
                'totalApplications' => <integer>,
            ],
            'waveID' => '<string>',
        ],
        // ...
    ],
    'nextToken' => '<string>',
]

Result Details

Errors

UninitializedAccountException:

Uninitialized account exception.

MarkAsArchived

$result = $client->markAsArchived([/* ... */]);
$promise = $client->markAsArchivedAsync([/* ... */]);

Archives specific Source Servers by setting the SourceServer.isArchived property to true for specified SourceServers by ID. This command only works for SourceServers with a lifecycle. state which equals DISCONNECTED or CUTOVER.

Parameter Syntax

$result = $client->markAsArchived([
    'accountID' => '<string>',
    'sourceServerID' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

[
    'applicationID' => '<string>',
    'arn' => '<string>',
    'connectorAction' => [
        'connectorArn' => '<string>',
        'credentialsSecretArn' => '<string>',
    ],
    'dataReplicationInfo' => [
        'dataReplicationError' => [
            'error' => 'AGENT_NOT_SEEN|SNAPSHOTS_FAILURE|NOT_CONVERGING|UNSTABLE_NETWORK|FAILED_TO_CREATE_SECURITY_GROUP|FAILED_TO_LAUNCH_REPLICATION_SERVER|FAILED_TO_BOOT_REPLICATION_SERVER|FAILED_TO_AUTHENTICATE_WITH_SERVICE|FAILED_TO_DOWNLOAD_REPLICATION_SOFTWARE|FAILED_TO_CREATE_STAGING_DISKS|FAILED_TO_ATTACH_STAGING_DISKS|FAILED_TO_PAIR_REPLICATION_SERVER_WITH_AGENT|FAILED_TO_CONNECT_AGENT_TO_REPLICATION_SERVER|FAILED_TO_START_DATA_TRANSFER|UNSUPPORTED_VM_CONFIGURATION|LAST_SNAPSHOT_JOB_FAILED',
            'rawError' => '<string>',
        ],
        'dataReplicationInitiation' => [
            'nextAttemptDateTime' => '<string>',
            'startDateTime' => '<string>',
            'steps' => [
                [
                    'name' => 'WAIT|CREATE_SECURITY_GROUP|LAUNCH_REPLICATION_SERVER|BOOT_REPLICATION_SERVER|AUTHENTICATE_WITH_SERVICE|DOWNLOAD_REPLICATION_SOFTWARE|CREATE_STAGING_DISKS|ATTACH_STAGING_DISKS|PAIR_REPLICATION_SERVER_WITH_AGENT|CONNECT_AGENT_TO_REPLICATION_SERVER|START_DATA_TRANSFER',
                    'status' => 'NOT_STARTED|IN_PROGRESS|SUCCEEDED|FAILED|SKIPPED',
                ],
                // ...
            ],
        ],
        'dataReplicationState' => 'STOPPED|INITIATING|INITIAL_SYNC|BACKLOG|CREATING_SNAPSHOT|CONTINUOUS|PAUSED|RESCAN|STALLED|DISCONNECTED|PENDING_SNAPSHOT_SHIPPING|SHIPPING_SNAPSHOT',
        'etaDateTime' => '<string>',
        'lagDuration' => '<string>',
        'lastSnapshotDateTime' => '<string>',
        'replicatedDisks' => [
            [
                'backloggedStorageBytes' => <integer>,
                'deviceName' => '<string>',
                'replicatedStorageBytes' => <integer>,
                'rescannedStorageBytes' => <integer>,
                'totalStorageBytes' => <integer>,
            ],
            // ...
        ],
    ],
    'fqdnForActionFramework' => '<string>',
    'isArchived' => true || false,
    'launchedInstance' => [
        'ec2InstanceID' => '<string>',
        'firstBoot' => 'WAITING|SUCCEEDED|UNKNOWN|STOPPED',
        'jobID' => '<string>',
    ],
    'lifeCycle' => [
        'addedToServiceDateTime' => '<string>',
        'elapsedReplicationDuration' => '<string>',
        'firstByteDateTime' => '<string>',
        'lastCutover' => [
            'finalized' => [
                'apiCallDateTime' => '<string>',
            ],
            'initiated' => [
                'apiCallDateTime' => '<string>',
                'jobID' => '<string>',
            ],
            'reverted' => [
                'apiCallDateTime' => '<string>',
            ],
        ],
        'lastSeenByServiceDateTime' => '<string>',
        'lastTest' => [
            'finalized' => [
                'apiCallDateTime' => '<string>',
            ],
            'initiated' => [
                'apiCallDateTime' => '<string>',
                'jobID' => '<string>',
            ],
            'reverted' => [
                'apiCallDateTime' => '<string>',
            ],
        ],
        'state' => 'STOPPED|NOT_READY|READY_FOR_TEST|TESTING|READY_FOR_CUTOVER|CUTTING_OVER|CUTOVER|DISCONNECTED|DISCOVERED|PENDING_INSTALLATION',
    ],
    'replicationType' => 'AGENT_BASED|SNAPSHOT_SHIPPING',
    'sourceProperties' => [
        'cpus' => [
            [
                'cores' => <integer>,
                'modelName' => '<string>',
            ],
            // ...
        ],
        'disks' => [
            [
                'bytes' => <integer>,
                'deviceName' => '<string>',
            ],
            // ...
        ],
        'identificationHints' => [
            'awsInstanceID' => '<string>',
            'fqdn' => '<string>',
            'hostname' => '<string>',
            'vmPath' => '<string>',
            'vmWareUuid' => '<string>',
        ],
        'lastUpdatedDateTime' => '<string>',
        'networkInterfaces' => [
            [
                'ips' => ['<string>', ...],
                'isPrimary' => true || false,
                'macAddress' => '<string>',
            ],
            // ...
        ],
        'os' => [
            'fullString' => '<string>',
        ],
        'ramBytes' => <integer>,
        'recommendedInstanceType' => '<string>',
    ],
    'sourceServerID' => '<string>',
    'tags' => ['<string>', ...],
    'userProvidedID' => '<string>',
    'vcenterClientID' => '<string>',
]

Result Details

Errors

UninitializedAccountException:

Uninitialized account exception.

ResourceNotFoundException:

Resource not found exception.

ConflictException:

The request could not be completed due to a conflict with the current state of the target resource.

PauseReplication

$result = $client->pauseReplication([/* ... */]);
$promise = $client->pauseReplicationAsync([/* ... */]);

Pause Replication.

Parameter Syntax

$result = $client->pauseReplication([
    'accountID' => '<string>',
    'sourceServerID' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

[
    'applicationID' => '<string>',
    'arn' => '<string>',
    'connectorAction' => [
        'connectorArn' => '<string>',
        'credentialsSecretArn' => '<string>',
    ],
    'dataReplicationInfo' => [
        'dataReplicationError' => [
            'error' => 'AGENT_NOT_SEEN|SNAPSHOTS_FAILURE|NOT_CONVERGING|UNSTABLE_NETWORK|FAILED_TO_CREATE_SECURITY_GROUP|FAILED_TO_LAUNCH_REPLICATION_SERVER|FAILED_TO_BOOT_REPLICATION_SERVER|FAILED_TO_AUTHENTICATE_WITH_SERVICE|FAILED_TO_DOWNLOAD_REPLICATION_SOFTWARE|FAILED_TO_CREATE_STAGING_DISKS|FAILED_TO_ATTACH_STAGING_DISKS|FAILED_TO_PAIR_REPLICATION_SERVER_WITH_AGENT|FAILED_TO_CONNECT_AGENT_TO_REPLICATION_SERVER|FAILED_TO_START_DATA_TRANSFER|UNSUPPORTED_VM_CONFIGURATION|LAST_SNAPSHOT_JOB_FAILED',
            'rawError' => '<string>',
        ],
        'dataReplicationInitiation' => [
            'nextAttemptDateTime' => '<string>',
            'startDateTime' => '<string>',
            'steps' => [
                [
                    'name' => 'WAIT|CREATE_SECURITY_GROUP|LAUNCH_REPLICATION_SERVER|BOOT_REPLICATION_SERVER|AUTHENTICATE_WITH_SERVICE|DOWNLOAD_REPLICATION_SOFTWARE|CREATE_STAGING_DISKS|ATTACH_STAGING_DISKS|PAIR_REPLICATION_SERVER_WITH_AGENT|CONNECT_AGENT_TO_REPLICATION_SERVER|START_DATA_TRANSFER',
                    'status' => 'NOT_STARTED|IN_PROGRESS|SUCCEEDED|FAILED|SKIPPED',
                ],
                // ...
            ],
        ],
        'dataReplicationState' => 'STOPPED|INITIATING|INITIAL_SYNC|BACKLOG|CREATING_SNAPSHOT|CONTINUOUS|PAUSED|RESCAN|STALLED|DISCONNECTED|PENDING_SNAPSHOT_SHIPPING|SHIPPING_SNAPSHOT',
        'etaDateTime' => '<string>',
        'lagDuration' => '<string>',
        'lastSnapshotDateTime' => '<string>',
        'replicatedDisks' => [
            [
                'backloggedStorageBytes' => <integer>,
                'deviceName' => '<string>',
                'replicatedStorageBytes' => <integer>,
                'rescannedStorageBytes' => <integer>,
                'totalStorageBytes' => <integer>,
            ],
            // ...
        ],
    ],
    'fqdnForActionFramework' => '<string>',
    'isArchived' => true || false,
    'launchedInstance' => [
        'ec2InstanceID' => '<string>',
        'firstBoot' => 'WAITING|SUCCEEDED|UNKNOWN|STOPPED',
        'jobID' => '<string>',
    ],
    'lifeCycle' => [
        'addedToServiceDateTime' => '<string>',
        'elapsedReplicationDuration' => '<string>',
        'firstByteDateTime' => '<string>',
        'lastCutover' => [
            'finalized' => [
                'apiCallDateTime' => '<string>',
            ],
            'initiated' => [
                'apiCallDateTime' => '<string>',
                'jobID' => '<string>',
            ],
            'reverted' => [
                'apiCallDateTime' => '<string>',
            ],
        ],
        'lastSeenByServiceDateTime' => '<string>',
        'lastTest' => [
            'finalized' => [
                'apiCallDateTime' => '<string>',
            ],
            'initiated' => [
                'apiCallDateTime' => '<string>',
                'jobID' => '<string>',
            ],
            'reverted' => [
                'apiCallDateTime' => '<string>',
            ],
        ],
        'state' => 'STOPPED|NOT_READY|READY_FOR_TEST|TESTING|READY_FOR_CUTOVER|CUTTING_OVER|CUTOVER|DISCONNECTED|DISCOVERED|PENDING_INSTALLATION',
    ],
    'replicationType' => 'AGENT_BASED|SNAPSHOT_SHIPPING',
    'sourceProperties' => [
        'cpus' => [
            [
                'cores' => <integer>,
                'modelName' => '<string>',
            ],
            // ...
        ],
        'disks' => [
            [
                'bytes' => <integer>,
                'deviceName' => '<string>',
            ],
            // ...
        ],
        'identificationHints' => [
            'awsInstanceID' => '<string>',
            'fqdn' => '<string>',
            'hostname' => '<string>',
            'vmPath' => '<string>',
            'vmWareUuid' => '<string>',
        ],
        'lastUpdatedDateTime' => '<string>',
        'networkInterfaces' => [
            [
                'ips' => ['<string>', ...],
                'isPrimary' => true || false,
                'macAddress' => '<string>',
            ],
            // ...
        ],
        'os' => [
            'fullString' => '<string>',
        ],
        'ramBytes' => <integer>,
        'recommendedInstanceType' => '<string>',
    ],
    'sourceServerID' => '<string>',
    'tags' => ['<string>', ...],
    'userProvidedID' => '<string>',
    'vcenterClientID' => '<string>',
]

Result Details

Errors

UninitializedAccountException:

Uninitialized account exception.

ResourceNotFoundException:

Resource not found exception.

ValidationException:

Validate exception.

ServiceQuotaExceededException:

The request could not be completed because its exceeded the service quota.

ConflictException:

The request could not be completed due to a conflict with the current state of the target resource.

PutSourceServerAction

$result = $client->putSourceServerAction([/* ... */]);
$promise = $client->putSourceServerActionAsync([/* ... */]);

Put source server post migration custom action.

Parameter Syntax

$result = $client->putSourceServerAction([
    'accountID' => '<string>',
    'actionID' => '<string>', // REQUIRED
    'actionName' => '<string>', // REQUIRED
    'active' => true || false,
    'category' => 'DISASTER_RECOVERY|OPERATING_SYSTEM|LICENSE_AND_SUBSCRIPTION|VALIDATION|OBSERVABILITY|REFACTORING|SECURITY|NETWORKING|CONFIGURATION|BACKUP|OTHER',
    'description' => '<string>',
    'documentIdentifier' => '<string>', // REQUIRED
    'documentVersion' => '<string>',
    'externalParameters' => [
        '<SsmDocumentParameterName>' => [
            'dynamicPath' => '<string>',
        ],
        // ...
    ],
    'mustSucceedForCutover' => true || false,
    'order' => <integer>, // REQUIRED
    'parameters' => [
        '<SsmDocumentParameterName>' => [
            [
                'parameterName' => '<string>', // REQUIRED
                'parameterType' => 'STRING', // REQUIRED
            ],
            // ...
        ],
        // ...
    ],
    'sourceServerID' => '<string>', // REQUIRED
    'timeoutSeconds' => <integer>,
]);

Parameter Details

Result Syntax

[
    'actionID' => '<string>',
    'actionName' => '<string>',
    'active' => true || false,
    'category' => 'DISASTER_RECOVERY|OPERATING_SYSTEM|LICENSE_AND_SUBSCRIPTION|VALIDATION|OBSERVABILITY|REFACTORING|SECURITY|NETWORKING|CONFIGURATION|BACKUP|OTHER',
    'description' => '<string>',
    'documentIdentifier' => '<string>',
    'documentVersion' => '<string>',
    'externalParameters' => [
        '<SsmDocumentParameterName>' => [
            'dynamicPath' => '<string>',
        ],
        // ...
    ],
    'mustSucceedForCutover' => true || false,
    'order' => <integer>,
    'parameters' => [
        '<SsmDocumentParameterName>' => [
            [
                'parameterName' => '<string>',
                'parameterType' => 'STRING',
            ],
            // ...
        ],
        // ...
    ],
    'timeoutSeconds' => <integer>,
]

Result Details

Errors

UninitializedAccountException:

Uninitialized account exception.

ResourceNotFoundException:

Resource not found exception.

ValidationException:

Validate exception.

ConflictException:

The request could not be completed due to a conflict with the current state of the target resource.

PutTemplateAction

$result = $client->putTemplateAction([/* ... */]);
$promise = $client->putTemplateActionAsync([/* ... */]);

Put template post migration custom action.

Parameter Syntax

$result = $client->putTemplateAction([
    'actionID' => '<string>', // REQUIRED
    'actionName' => '<string>', // REQUIRED
    'active' => true || false,
    'category' => 'DISASTER_RECOVERY|OPERATING_SYSTEM|LICENSE_AND_SUBSCRIPTION|VALIDATION|OBSERVABILITY|REFACTORING|SECURITY|NETWORKING|CONFIGURATION|BACKUP|OTHER',
    'description' => '<string>',
    'documentIdentifier' => '<string>', // REQUIRED
    'documentVersion' => '<string>',
    'externalParameters' => [
        '<SsmDocumentParameterName>' => [
            'dynamicPath' => '<string>',
        ],
        // ...
    ],
    'launchConfigurationTemplateID' => '<string>', // REQUIRED
    'mustSucceedForCutover' => true || false,
    'operatingSystem' => '<string>',
    'order' => <integer>, // REQUIRED
    'parameters' => [
        '<SsmDocumentParameterName>' => [
            [
                'parameterName' => '<string>', // REQUIRED
                'parameterType' => 'STRING', // REQUIRED
            ],
            // ...
        ],
        // ...
    ],
    'timeoutSeconds' => <integer>,
]);

Parameter Details

Result Syntax

[
    'actionID' => '<string>',
    'actionName' => '<string>',
    'active' => true || false,
    'category' => 'DISASTER_RECOVERY|OPERATING_SYSTEM|LICENSE_AND_SUBSCRIPTION|VALIDATION|OBSERVABILITY|REFACTORING|SECURITY|NETWORKING|CONFIGURATION|BACKUP|OTHER',
    'description' => '<string>',
    'documentIdentifier' => '<string>',
    'documentVersion' => '<string>',
    'externalParameters' => [
        '<SsmDocumentParameterName>' => [
            'dynamicPath' => '<string>',
        ],
        // ...
    ],
    'mustSucceedForCutover' => true || false,
    'operatingSystem' => '<string>',
    'order' => <integer>,
    'parameters' => [
        '<SsmDocumentParameterName>' => [
            [
                'parameterName' => '<string>',
                'parameterType' => 'STRING',
            ],
            // ...
        ],
        // ...
    ],
    'timeoutSeconds' => <integer>,
]

Result Details

Errors

UninitializedAccountException:

Uninitialized account exception.

ResourceNotFoundException:

Resource not found exception.

ValidationException:

Validate exception.

ConflictException:

The request could not be completed due to a conflict with the current state of the target resource.

RemoveSourceServerAction

$result = $client->removeSourceServerAction([/* ... */]);
$promise = $client->removeSourceServerActionAsync([/* ... */]);

Remove source server post migration custom action.

Parameter Syntax

$result = $client->removeSourceServerAction([
    'accountID' => '<string>',
    'actionID' => '<string>', // REQUIRED
    'sourceServerID' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

[]

Result Details

Errors

UninitializedAccountException:

Uninitialized account exception.

ResourceNotFoundException:

Resource not found exception.

ValidationException:

Validate exception.

RemoveTemplateAction

$result = $client->removeTemplateAction([/* ... */]);
$promise = $client->removeTemplateActionAsync([/* ... */]);

Remove template post migration custom action.

Parameter Syntax

$result = $client->removeTemplateAction([
    'actionID' => '<string>', // REQUIRED
    'launchConfigurationTemplateID' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

[]

Result Details

Errors

UninitializedAccountException:

Uninitialized account exception.

ResourceNotFoundException:

Resource not found exception.

ValidationException:

Validate exception.

ResumeReplication

$result = $client->resumeReplication([/* ... */]);
$promise = $client->resumeReplicationAsync([/* ... */]);

Resume Replication.

Parameter Syntax

$result = $client->resumeReplication([
    'accountID' => '<string>',
    'sourceServerID' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

[
    'applicationID' => '<string>',
    'arn' => '<string>',
    'connectorAction' => [
        'connectorArn' => '<string>',
        'credentialsSecretArn' => '<string>',
    ],
    'dataReplicationInfo' => [
        'dataReplicationError' => [
            'error' => 'AGENT_NOT_SEEN|SNAPSHOTS_FAILURE|NOT_CONVERGING|UNSTABLE_NETWORK|FAILED_TO_CREATE_SECURITY_GROUP|FAILED_TO_LAUNCH_REPLICATION_SERVER|FAILED_TO_BOOT_REPLICATION_SERVER|FAILED_TO_AUTHENTICATE_WITH_SERVICE|FAILED_TO_DOWNLOAD_REPLICATION_SOFTWARE|FAILED_TO_CREATE_STAGING_DISKS|FAILED_TO_ATTACH_STAGING_DISKS|FAILED_TO_PAIR_REPLICATION_SERVER_WITH_AGENT|FAILED_TO_CONNECT_AGENT_TO_REPLICATION_SERVER|FAILED_TO_START_DATA_TRANSFER|UNSUPPORTED_VM_CONFIGURATION|LAST_SNAPSHOT_JOB_FAILED',
            'rawError' => '<string>',
        ],
        'dataReplicationInitiation' => [
            'nextAttemptDateTime' => '<string>',
            'startDateTime' => '<string>',
            'steps' => [
                [
                    'name' => 'WAIT|CREATE_SECURITY_GROUP|LAUNCH_REPLICATION_SERVER|BOOT_REPLICATION_SERVER|AUTHENTICATE_WITH_SERVICE|DOWNLOAD_REPLICATION_SOFTWARE|CREATE_STAGING_DISKS|ATTACH_STAGING_DISKS|PAIR_REPLICATION_SERVER_WITH_AGENT|CONNECT_AGENT_TO_REPLICATION_SERVER|START_DATA_TRANSFER',
                    'status' => 'NOT_STARTED|IN_PROGRESS|SUCCEEDED|FAILED|SKIPPED',
                ],
                // ...
            ],
        ],
        'dataReplicationState' => 'STOPPED|INITIATING|INITIAL_SYNC|BACKLOG|CREATING_SNAPSHOT|CONTINUOUS|PAUSED|RESCAN|STALLED|DISCONNECTED|PENDING_SNAPSHOT_SHIPPING|SHIPPING_SNAPSHOT',
        'etaDateTime' => '<string>',
        'lagDuration' => '<string>',
        'lastSnapshotDateTime' => '<string>',
        'replicatedDisks' => [
            [
                'backloggedStorageBytes' => <integer>,
                'deviceName' => '<string>',
                'replicatedStorageBytes' => <integer>,
                'rescannedStorageBytes' => <integer>,
                'totalStorageBytes' => <integer>,
            ],
            // ...
        ],
    ],
    'fqdnForActionFramework' => '<string>',
    'isArchived' => true || false,
    'launchedInstance' => [
        'ec2InstanceID' => '<string>',
        'firstBoot' => 'WAITING|SUCCEEDED|UNKNOWN|STOPPED',
        'jobID' => '<string>',
    ],
    'lifeCycle' => [
        'addedToServiceDateTime' => '<string>',
        'elapsedReplicationDuration' => '<string>',
        'firstByteDateTime' => '<string>',
        'lastCutover' => [
            'finalized' => [
                'apiCallDateTime' => '<string>',
            ],
            'initiated' => [
                'apiCallDateTime' => '<string>',
                'jobID' => '<string>',
            ],
            'reverted' => [
                'apiCallDateTime' => '<string>',
            ],
        ],
        'lastSeenByServiceDateTime' => '<string>',
        'lastTest' => [
            'finalized' => [
                'apiCallDateTime' => '<string>',
            ],
            'initiated' => [
                'apiCallDateTime' => '<string>',
                'jobID' => '<string>',
            ],
            'reverted' => [
                'apiCallDateTime' => '<string>',
            ],
        ],
        'state' => 'STOPPED|NOT_READY|READY_FOR_TEST|TESTING|READY_FOR_CUTOVER|CUTTING_OVER|CUTOVER|DISCONNECTED|DISCOVERED|PENDING_INSTALLATION',
    ],
    'replicationType' => 'AGENT_BASED|SNAPSHOT_SHIPPING',
    'sourceProperties' => [
        'cpus' => [
            [
                'cores' => <integer>,
                'modelName' => '<string>',
            ],
            // ...
        ],
        'disks' => [
            [
                'bytes' => <integer>,
                'deviceName' => '<string>',
            ],
            // ...
        ],
        'identificationHints' => [
            'awsInstanceID' => '<string>',
            'fqdn' => '<string>',
            'hostname' => '<string>',
            'vmPath' => '<string>',
            'vmWareUuid' => '<string>',
        ],
        'lastUpdatedDateTime' => '<string>',
        'networkInterfaces' => [
            [
                'ips' => ['<string>', ...],
                'isPrimary' => true || false,
                'macAddress' => '<string>',
            ],
            // ...
        ],
        'os' => [
            'fullString' => '<string>',
        ],
        'ramBytes' => <integer>,
        'recommendedInstanceType' => '<string>',
    ],
    'sourceServerID' => '<string>',
    'tags' => ['<string>', ...],
    'userProvidedID' => '<string>',
    'vcenterClientID' => '<string>',
]

Result Details

Errors

UninitializedAccountException:

Uninitialized account exception.

ResourceNotFoundException:

Resource not found exception.

ValidationException:

Validate exception.

ServiceQuotaExceededException:

The request could not be completed because its exceeded the service quota.

ConflictException:

The request could not be completed due to a conflict with the current state of the target resource.

RetryDataReplication

$result = $client->retryDataReplication([/* ... */]);
$promise = $client->retryDataReplicationAsync([/* ... */]);

Causes the data replication initiation sequence to begin immediately upon next Handshake for specified SourceServer IDs, regardless of when the previous initiation started. This command will not work if the SourceServer is not stalled or is in a DISCONNECTED or STOPPED state.

Parameter Syntax

$result = $client->retryDataReplication([
    'accountID' => '<string>',
    'sourceServerID' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

[
    'applicationID' => '<string>',
    'arn' => '<string>',
    'connectorAction' => [
        'connectorArn' => '<string>',
        'credentialsSecretArn' => '<string>',
    ],
    'dataReplicationInfo' => [
        'dataReplicationError' => [
            'error' => 'AGENT_NOT_SEEN|SNAPSHOTS_FAILURE|NOT_CONVERGING|UNSTABLE_NETWORK|FAILED_TO_CREATE_SECURITY_GROUP|FAILED_TO_LAUNCH_REPLICATION_SERVER|FAILED_TO_BOOT_REPLICATION_SERVER|FAILED_TO_AUTHENTICATE_WITH_SERVICE|FAILED_TO_DOWNLOAD_REPLICATION_SOFTWARE|FAILED_TO_CREATE_STAGING_DISKS|FAILED_TO_ATTACH_STAGING_DISKS|FAILED_TO_PAIR_REPLICATION_SERVER_WITH_AGENT|FAILED_TO_CONNECT_AGENT_TO_REPLICATION_SERVER|FAILED_TO_START_DATA_TRANSFER|UNSUPPORTED_VM_CONFIGURATION|LAST_SNAPSHOT_JOB_FAILED',
            'rawError' => '<string>',
        ],
        'dataReplicationInitiation' => [
            'nextAttemptDateTime' => '<string>',
            'startDateTime' => '<string>',
            'steps' => [
                [
                    'name' => 'WAIT|CREATE_SECURITY_GROUP|LAUNCH_REPLICATION_SERVER|BOOT_REPLICATION_SERVER|AUTHENTICATE_WITH_SERVICE|DOWNLOAD_REPLICATION_SOFTWARE|CREATE_STAGING_DISKS|ATTACH_STAGING_DISKS|PAIR_REPLICATION_SERVER_WITH_AGENT|CONNECT_AGENT_TO_REPLICATION_SERVER|START_DATA_TRANSFER',
                    'status' => 'NOT_STARTED|IN_PROGRESS|SUCCEEDED|FAILED|SKIPPED',
                ],
                // ...
            ],
        ],
        'dataReplicationState' => 'STOPPED|INITIATING|INITIAL_SYNC|BACKLOG|CREATING_SNAPSHOT|CONTINUOUS|PAUSED|RESCAN|STALLED|DISCONNECTED|PENDING_SNAPSHOT_SHIPPING|SHIPPING_SNAPSHOT',
        'etaDateTime' => '<string>',
        'lagDuration' => '<string>',
        'lastSnapshotDateTime' => '<string>',
        'replicatedDisks' => [
            [
                'backloggedStorageBytes' => <integer>,
                'deviceName' => '<string>',
                'replicatedStorageBytes' => <integer>,
                'rescannedStorageBytes' => <integer>,
                'totalStorageBytes' => <integer>,
            ],
            // ...
        ],
    ],
    'fqdnForActionFramework' => '<string>',
    'isArchived' => true || false,
    'launchedInstance' => [
        'ec2InstanceID' => '<string>',
        'firstBoot' => 'WAITING|SUCCEEDED|UNKNOWN|STOPPED',
        'jobID' => '<string>',
    ],
    'lifeCycle' => [
        'addedToServiceDateTime' => '<string>',
        'elapsedReplicationDuration' => '<string>',
        'firstByteDateTime' => '<string>',
        'lastCutover' => [
            'finalized' => [
                'apiCallDateTime' => '<string>',
            ],
            'initiated' => [
                'apiCallDateTime' => '<string>',
                'jobID' => '<string>',
            ],
            'reverted' => [
                'apiCallDateTime' => '<string>',
            ],
        ],
        'lastSeenByServiceDateTime' => '<string>',
        'lastTest' => [
            'finalized' => [
                'apiCallDateTime' => '<string>',
            ],
            'initiated' => [
                'apiCallDateTime' => '<string>',
                'jobID' => '<string>',
            ],
            'reverted' => [
                'apiCallDateTime' => '<string>',
            ],
        ],
        'state' => 'STOPPED|NOT_READY|READY_FOR_TEST|TESTING|READY_FOR_CUTOVER|CUTTING_OVER|CUTOVER|DISCONNECTED|DISCOVERED|PENDING_INSTALLATION',
    ],
    'replicationType' => 'AGENT_BASED|SNAPSHOT_SHIPPING',
    'sourceProperties' => [
        'cpus' => [
            [
                'cores' => <integer>,
                'modelName' => '<string>',
            ],
            // ...
        ],
        'disks' => [
            [
                'bytes' => <integer>,
                'deviceName' => '<string>',
            ],
            // ...
        ],
        'identificationHints' => [
            'awsInstanceID' => '<string>',
            'fqdn' => '<string>',
            'hostname' => '<string>',
            'vmPath' => '<string>',
            'vmWareUuid' => '<string>',
        ],
        'lastUpdatedDateTime' => '<string>',
        'networkInterfaces' => [
            [
                'ips' => ['<string>', ...],
                'isPrimary' => true || false,
                'macAddress' => '<string>',
            ],
            // ...
        ],
        'os' => [
            'fullString' => '<string>',
        ],
        'ramBytes' => <integer>,
        'recommendedInstanceType' => '<string>',
    ],
    'sourceServerID' => '<string>',
    'tags' => ['<string>', ...],
    'userProvidedID' => '<string>',
    'vcenterClientID' => '<string>',
]

Result Details

Errors

UninitializedAccountException:

Uninitialized account exception.

ResourceNotFoundException:

Resource not found exception.

ValidationException:

Validate exception.

StartCutover

$result = $client->startCutover([/* ... */]);
$promise = $client->startCutoverAsync([/* ... */]);

Launches a Cutover Instance for specific Source Servers. This command starts a LAUNCH job whose initiatedBy property is StartCutover and changes the SourceServer.lifeCycle.state property to CUTTING_OVER.

Parameter Syntax

$result = $client->startCutover([
    'accountID' => '<string>',
    'sourceServerIDs' => ['<string>', ...], // REQUIRED
    'tags' => ['<string>', ...],
]);

Parameter Details

Result Syntax

[
    'job' => [
        'arn' => '<string>',
        'creationDateTime' => '<string>',
        'endDateTime' => '<string>',
        'initiatedBy' => 'START_TEST|START_CUTOVER|DIAGNOSTIC|TERMINATE',
        'jobID' => '<string>',
        'participatingServers' => [
            [
                'launchStatus' => 'PENDING|IN_PROGRESS|LAUNCHED|FAILED|TERMINATED',
                'launchedEc2InstanceID' => '<string>',
                'postLaunchActionsStatus' => [
                    'postLaunchActionsLaunchStatusList' => [
                        [
                            'executionID' => '<string>',
                            'executionStatus' => 'IN_PROGRESS|SUCCESS|FAILED',
                            'failureReason' => '<string>',
                            'ssmDocument' => [
                                'actionName' => '<string>',
                                'externalParameters' => [
                                    '<SsmDocumentParameterName>' => [
                                        'dynamicPath' => '<string>',
                                    ],
                                    // ...
                                ],
                                'mustSucceedForCutover' => true || false,
                                'parameters' => [
                                    '<SsmDocumentParameterName>' => [
                                        [
                                            'parameterName' => '<string>',
                                            'parameterType' => 'STRING',
                                        ],
                                        // ...
                                    ],
                                    // ...
                                ],
                                'ssmDocumentName' => '<string>',
                                'timeoutSeconds' => <integer>,
                            ],
                            'ssmDocumentType' => 'AUTOMATION|COMMAND',
                        ],
                        // ...
                    ],
                    'ssmAgentDiscoveryDatetime' => '<string>',
                ],
                'sourceServerID' => '<string>',
            ],
            // ...
        ],
        'status' => 'PENDING|STARTED|COMPLETED',
        'tags' => ['<string>', ...],
        'type' => 'LAUNCH|TERMINATE',
    ],
]

Result Details

Errors

UninitializedAccountException:

Uninitialized account exception.

ValidationException:

Validate exception.

ConflictException:

The request could not be completed due to a conflict with the current state of the target resource.

StartExport

$result = $client->startExport([/* ... */]);
$promise = $client->startExportAsync([/* ... */]);

Start export.

Parameter Syntax

$result = $client->startExport([
    's3Bucket' => '<string>', // REQUIRED
    's3BucketOwner' => '<string>',
    's3Key' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

[
    'exportTask' => [
        'creationDateTime' => '<string>',
        'endDateTime' => '<string>',
        'exportID' => '<string>',
        'progressPercentage' => <float>,
        's3Bucket' => '<string>',
        's3BucketOwner' => '<string>',
        's3Key' => '<string>',
        'status' => 'PENDING|STARTED|FAILED|SUCCEEDED',
        'summary' => [
            'applicationsCount' => <integer>,
            'serversCount' => <integer>,
            'wavesCount' => <integer>,
        ],
    ],
]

Result Details

Errors

UninitializedAccountException:

Uninitialized account exception.

ValidationException:

Validate exception.

ServiceQuotaExceededException:

The request could not be completed because its exceeded the service quota.

StartImport

$result = $client->startImport([/* ... */]);
$promise = $client->startImportAsync([/* ... */]);

Start import.

Parameter Syntax

$result = $client->startImport([
    'clientToken' => '<string>',
    's3BucketSource' => [ // REQUIRED
        's3Bucket' => '<string>', // REQUIRED
        's3BucketOwner' => '<string>',
        's3Key' => '<string>', // REQUIRED
    ],
]);

Parameter Details

Result Syntax

[
    'importTask' => [
        'creationDateTime' => '<string>',
        'endDateTime' => '<string>',
        'importID' => '<string>',
        'progressPercentage' => <float>,
        's3BucketSource' => [
            's3Bucket' => '<string>',
            's3BucketOwner' => '<string>',
            's3Key' => '<string>',
        ],
        'status' => 'PENDING|STARTED|FAILED|SUCCEEDED',
        'summary' => [
            'applications' => [
                'createdCount' => <integer>,
                'modifiedCount' => <integer>,
            ],
            'servers' => [
                'createdCount' => <integer>,
                'modifiedCount' => <integer>,
            ],
            'waves' => [
                'createdCount' => <integer>,
                'modifiedCount' => <integer>,
            ],
        ],
    ],
]

Result Details

Errors

UninitializedAccountException:

Uninitialized account exception.

ResourceNotFoundException:

Resource not found exception.

ValidationException:

Validate exception.

ServiceQuotaExceededException:

The request could not be completed because its exceeded the service quota.

ConflictException:

The request could not be completed due to a conflict with the current state of the target resource.

StartReplication

$result = $client->startReplication([/* ... */]);
$promise = $client->startReplicationAsync([/* ... */]);

Starts replication for SNAPSHOT_SHIPPING agents.

Parameter Syntax

$result = $client->startReplication([
    'accountID' => '<string>',
    'sourceServerID' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

[
    'applicationID' => '<string>',
    'arn' => '<string>',
    'connectorAction' => [
        'connectorArn' => '<string>',
        'credentialsSecretArn' => '<string>',
    ],
    'dataReplicationInfo' => [
        'dataReplicationError' => [
            'error' => 'AGENT_NOT_SEEN|SNAPSHOTS_FAILURE|NOT_CONVERGING|UNSTABLE_NETWORK|FAILED_TO_CREATE_SECURITY_GROUP|FAILED_TO_LAUNCH_REPLICATION_SERVER|FAILED_TO_BOOT_REPLICATION_SERVER|FAILED_TO_AUTHENTICATE_WITH_SERVICE|FAILED_TO_DOWNLOAD_REPLICATION_SOFTWARE|FAILED_TO_CREATE_STAGING_DISKS|FAILED_TO_ATTACH_STAGING_DISKS|FAILED_TO_PAIR_REPLICATION_SERVER_WITH_AGENT|FAILED_TO_CONNECT_AGENT_TO_REPLICATION_SERVER|FAILED_TO_START_DATA_TRANSFER|UNSUPPORTED_VM_CONFIGURATION|LAST_SNAPSHOT_JOB_FAILED',
            'rawError' => '<string>',
        ],
        'dataReplicationInitiation' => [
            'nextAttemptDateTime' => '<string>',
            'startDateTime' => '<string>',
            'steps' => [
                [
                    'name' => 'WAIT|CREATE_SECURITY_GROUP|LAUNCH_REPLICATION_SERVER|BOOT_REPLICATION_SERVER|AUTHENTICATE_WITH_SERVICE|DOWNLOAD_REPLICATION_SOFTWARE|CREATE_STAGING_DISKS|ATTACH_STAGING_DISKS|PAIR_REPLICATION_SERVER_WITH_AGENT|CONNECT_AGENT_TO_REPLICATION_SERVER|START_DATA_TRANSFER',
                    'status' => 'NOT_STARTED|IN_PROGRESS|SUCCEEDED|FAILED|SKIPPED',
                ],
                // ...
            ],
        ],
        'dataReplicationState' => 'STOPPED|INITIATING|INITIAL_SYNC|BACKLOG|CREATING_SNAPSHOT|CONTINUOUS|PAUSED|RESCAN|STALLED|DISCONNECTED|PENDING_SNAPSHOT_SHIPPING|SHIPPING_SNAPSHOT',
        'etaDateTime' => '<string>',
        'lagDuration' => '<string>',
        'lastSnapshotDateTime' => '<string>',
        'replicatedDisks' => [
            [
                'backloggedStorageBytes' => <integer>,
                'deviceName' => '<string>',
                'replicatedStorageBytes' => <integer>,
                'rescannedStorageBytes' => <integer>,
                'totalStorageBytes' => <integer>,
            ],
            // ...
        ],
    ],
    'fqdnForActionFramework' => '<string>',
    'isArchived' => true || false,
    'launchedInstance' => [
        'ec2InstanceID' => '<string>',
        'firstBoot' => 'WAITING|SUCCEEDED|UNKNOWN|STOPPED',
        'jobID' => '<string>',
    ],
    'lifeCycle' => [
        'addedToServiceDateTime' => '<string>',
        'elapsedReplicationDuration' => '<string>',
        'firstByteDateTime' => '<string>',
        'lastCutover' => [
            'finalized' => [
                'apiCallDateTime' => '<string>',
            ],
            'initiated' => [
                'apiCallDateTime' => '<string>',
                'jobID' => '<string>',
            ],
            'reverted' => [
                'apiCallDateTime' => '<string>',
            ],
        ],
        'lastSeenByServiceDateTime' => '<string>',
        'lastTest' => [
            'finalized' => [
                'apiCallDateTime' => '<string>',
            ],
            'initiated' => [
                'apiCallDateTime' => '<string>',
                'jobID' => '<string>',
            ],
            'reverted' => [
                'apiCallDateTime' => '<string>',
            ],
        ],
        'state' => 'STOPPED|NOT_READY|READY_FOR_TEST|TESTING|READY_FOR_CUTOVER|CUTTING_OVER|CUTOVER|DISCONNECTED|DISCOVERED|PENDING_INSTALLATION',
    ],
    'replicationType' => 'AGENT_BASED|SNAPSHOT_SHIPPING',
    'sourceProperties' => [
        'cpus' => [
            [
                'cores' => <integer>,
                'modelName' => '<string>',
            ],
            // ...
        ],
        'disks' => [
            [
                'bytes' => <integer>,
                'deviceName' => '<string>',
            ],
            // ...
        ],
        'identificationHints' => [
            'awsInstanceID' => '<string>',
            'fqdn' => '<string>',
            'hostname' => '<string>',
            'vmPath' => '<string>',
            'vmWareUuid' => '<string>',
        ],
        'lastUpdatedDateTime' => '<string>',
        'networkInterfaces' => [
            [
                'ips' => ['<string>', ...],
                'isPrimary' => true || false,
                'macAddress' => '<string>',
            ],
            // ...
        ],
        'os' => [
            'fullString' => '<string>',
        ],
        'ramBytes' => <integer>,
        'recommendedInstanceType' => '<string>',
    ],
    'sourceServerID' => '<string>',
    'tags' => ['<string>', ...],
    'userProvidedID' => '<string>',
    'vcenterClientID' => '<string>',
]

Result Details

Errors

UninitializedAccountException:

Uninitialized account exception.

ResourceNotFoundException:

Resource not found exception.

ValidationException:

Validate exception.

ServiceQuotaExceededException:

The request could not be completed because its exceeded the service quota.

ConflictException:

The request could not be completed due to a conflict with the current state of the target resource.

StartTest

$result = $client->startTest([/* ... */]);
$promise = $client->startTestAsync([/* ... */]);

Launches a Test Instance for specific Source Servers. This command starts a LAUNCH job whose initiatedBy property is StartTest and changes the SourceServer.lifeCycle.state property to TESTING.

Parameter Syntax

$result = $client->startTest([
    'accountID' => '<string>',
    'sourceServerIDs' => ['<string>', ...], // REQUIRED
    'tags' => ['<string>', ...],
]);

Parameter Details