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>,
            ],
            // ...
        ],
        'replicatorId' => '<string>',
    ],
    '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,
    'enableParametersEncryption' => true || false,
    'largeVolumeConf' => [
        'iops' => <integer>,
        'throughput' => <integer>,
        'volumeType' => 'io1|io2|gp3|gp2|st1|sc1|standard',
    ],
    'launchDisposition' => 'STOPPED|STARTED',
    'licensing' => [
        'osByol' => true || false,
    ],
    'mapAutoTaggingMpeID' => '<string>',
    'parametersEncryptionKey' => '<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|SECURE_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,
    'enableParametersEncryption' => 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>',
    'parametersEncryptionKey' => '<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|SECURE_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.

AccessDeniedException:

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

ValidationException:

Validate exception.

CreateNetworkMigrationDefinition

$result = $client->createNetworkMigrationDefinition([/* ... */]);
$promise = $client->createNetworkMigrationDefinitionAsync([/* ... */]);

Creates a new network migration definition that specifies the source and target network configuration for a migration.

Parameter Syntax

$result = $client->createNetworkMigrationDefinition([
    'description' => '<string>',
    'name' => '<string>', // REQUIRED
    'scopeTags' => ['<string>', ...],
    'sourceConfigurations' => [
        [
            'sourceEnvironment' => 'NSX|VSPHERE|FORTIGATE_FIREWALL|PALO_ALTO_FIREWALL|CISCO_ACI|LOGICAL_MODEL|MODELIZE_IT', // REQUIRED
            'sourceS3Configuration' => [ // REQUIRED
                's3Bucket' => '<string>', // REQUIRED
                's3BucketOwner' => '<string>', // REQUIRED
                's3Key' => '<string>', // REQUIRED
            ],
        ],
        // ...
    ],
    'tags' => ['<string>', ...],
    'targetDeployment' => 'SINGLE_ACCOUNT|MULTI_ACCOUNT',
    'targetNetwork' => [ // REQUIRED
        'inboundCidr' => '<string>',
        'inspectionCidr' => '<string>',
        'outboundCidr' => '<string>',
        'topology' => 'ISOLATED_VPC|HUB_AND_SPOKE', // REQUIRED
    ],
    'targetS3Configuration' => [ // REQUIRED
        's3Bucket' => '<string>', // REQUIRED
        's3BucketOwner' => '<string>', // REQUIRED
    ],
]);

Parameter Details

Result Syntax

[
    'arn' => '<string>',
    'createdAt' => <DateTime>,
    'description' => '<string>',
    'name' => '<string>',
    'networkMigrationDefinitionID' => '<string>',
    'scopeTags' => ['<string>', ...],
    'sourceConfigurations' => [
        [
            'sourceEnvironment' => 'NSX|VSPHERE|FORTIGATE_FIREWALL|PALO_ALTO_FIREWALL|CISCO_ACI|LOGICAL_MODEL|MODELIZE_IT',
            'sourceS3Configuration' => [
                's3Bucket' => '<string>',
                's3BucketOwner' => '<string>',
                's3Key' => '<string>',
            ],
        ],
        // ...
    ],
    'tags' => ['<string>', ...],
    'targetDeployment' => 'SINGLE_ACCOUNT|MULTI_ACCOUNT',
    'targetNetwork' => [
        'inboundCidr' => '<string>',
        'inspectionCidr' => '<string>',
        'outboundCidr' => '<string>',
        'topology' => 'ISOLATED_VPC|HUB_AND_SPOKE',
    ],
    'targetS3Configuration' => [
        's3Bucket' => '<string>',
        's3BucketOwner' => '<string>',
    ],
    'updatedAt' => <DateTime>,
]

Result Details

Errors

ValidationException:

Validate exception.

ServiceQuotaExceededException:

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

Examples

Example 1: Sample CreateNetworkMigrationDefinition call

$result = $client->createNetworkMigrationDefinition([
    'name' => 'network1',
    'description' => 'network 1 description',
    'sourceConfigurations' => [
        [
            'sourceEnvironment' => 'NSX',
            'sourceS3Configuration' => [
                's3Bucket' => 'source_bucket',
                's3BucketOwner' => '012345678901',
                's3Key' => 'source_key',
            ],
        ],
    ],
    'targetDeployment' => 'SINGLE_ACCOUNT',
    'targetNetwork' => [
        'inboundCidr' => '192.168.1.0/24',
        'topology' => 'ISOLATED_VPC',
    ],
    'targetS3Configuration' => [
        's3Bucket' => 'target_bucket',
        's3BucketOwner' => '012345678901',
    ],
]);

Result syntax:

[
    'name' => 'network1',
    'createdAt' => ,
    'description' => 'network 1 description',
    'networkMigrationDefinitionID' => 'nmd-01234567891234567',
    'sourceConfigurations' => [
        [
            'sourceEnvironment' => 'NSX',
            'sourceS3Configuration' => [
                's3Bucket' => 'source_bucket',
                's3BucketOwner' => '012345678901',
                's3Key' => 'source_key',
            ],
        ],
    ],
    'tags' => [
    ],
    'targetNetwork' => [
        'inboundCidr' => '192.168.1.0/24',
        'topology' => 'ISOLATED_VPC',
    ],
    'targetS3Configuration' => [
        's3Bucket' => 'target_bucket',
        's3BucketOwner' => '012345678901',
    ],
    'updatedAt' => ,
]

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>',
    'internetProtocol' => 'IPV4|IPV6',
    'replicationServerInstanceType' => '<string>', // REQUIRED
    'replicationServersSecurityGroupsIDs' => ['<string>', ...], // REQUIRED
    'stagingAreaSubnetId' => '<string>', // REQUIRED
    'stagingAreaTags' => ['<string>', ...], // REQUIRED
    'storeSnapshotOnLocalZone' => true || false,
    '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>',
    'internetProtocol' => 'IPV4|IPV6',
    'replicationConfigurationTemplateID' => '<string>',
    'replicationServerInstanceType' => '<string>',
    'replicationServersSecurityGroupsIDs' => ['<string>', ...],
    'stagingAreaSubnetId' => '<string>',
    'stagingAreaTags' => ['<string>', ...],
    'storeSnapshotOnLocalZone' => true || false,
    'tags' => ['<string>', ...],
    'useDedicatedReplicationServer' => true || false,
    'useFipsEndpoint' => true || false,
]

Result Details

Errors

UninitializedAccountException:

Uninitialized account exception.

AccessDeniedException:

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

ValidationException:

Validate exception.

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.

DeleteNetworkMigrationDefinition

$result = $client->deleteNetworkMigrationDefinition([/* ... */]);
$promise = $client->deleteNetworkMigrationDefinitionAsync([/* ... */]);

Deletes a network migration definition. This operation removes the migration definition and all associated metadata.

Parameter Syntax

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

Parameter Details

Result Syntax

[]

Result Details

Errors

ResourceNotFoundException:

Resource not found exception.

AccessDeniedException:

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

ConflictException:

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

Examples

Example 1: Sample DeleteNetworkMigrationDefinition call

$result = $client->deleteNetworkMigrationDefinition([
    'networkMigrationDefinitionID' => 'nmd-01234567891234567',
]);

Result syntax:

[
]

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' => [
                'attemptCount' => <integer>,
                'conversionServerID' => '<string>',
                'maxAttemptsCount' => <integer>,
                '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|SECURE_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,
            'enableParametersEncryption' => 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>',
            'parametersEncryptionKey' => '<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|SECURE_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>',
            'internetProtocol' => 'IPV4|IPV6',
            'replicationConfigurationTemplateID' => '<string>',
            'replicationServerInstanceType' => '<string>',
            'replicationServersSecurityGroupsIDs' => ['<string>', ...],
            'stagingAreaSubnetId' => '<string>',
            'stagingAreaTags' => ['<string>', ...],
            'storeSnapshotOnLocalZone' => true || false,
            '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>,
                    ],
                    // ...
                ],
                'replicatorId' => '<string>',
            ],
            '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>,
            ],
            // ...
        ],
        'replicatorId' => '<string>',
    ],
    '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>,
            ],
            // ...
        ],
        'replicatorId' => '<string>',
    ],
    '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|SECURE_STRING',
                        ],
                        // ...
                    ],
                    // ...
                ],
                'ssmDocumentName' => '<string>',
                'timeoutSeconds' => <integer>,
            ],
            // ...
        ],
    ],
    'sourceServerID' => '<string>',
    'targetInstanceTypeRightSizingMethod' => 'NONE|BASIC',
]

Result Details

Errors

UninitializedAccountException:

Uninitialized account exception.

ResourceNotFoundException:

Resource not found exception.

GetNetworkMigrationDefinition

$result = $client->getNetworkMigrationDefinition([/* ... */]);
$promise = $client->getNetworkMigrationDefinitionAsync([/* ... */]);

Retrieves the details of a network migration definition including source and target configurations.

Parameter Syntax

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

Parameter Details

Result Syntax

[
    'arn' => '<string>',
    'createdAt' => <DateTime>,
    'description' => '<string>',
    'name' => '<string>',
    'networkMigrationDefinitionID' => '<string>',
    'scopeTags' => ['<string>', ...],
    'sourceConfigurations' => [
        [
            'sourceEnvironment' => 'NSX|VSPHERE|FORTIGATE_FIREWALL|PALO_ALTO_FIREWALL|CISCO_ACI|LOGICAL_MODEL|MODELIZE_IT',
            'sourceS3Configuration' => [
                's3Bucket' => '<string>',
                's3BucketOwner' => '<string>',
                's3Key' => '<string>',
            ],
        ],
        // ...
    ],
    'tags' => ['<string>', ...],
    'targetDeployment' => 'SINGLE_ACCOUNT|MULTI_ACCOUNT',
    'targetNetwork' => [
        'inboundCidr' => '<string>',
        'inspectionCidr' => '<string>',
        'outboundCidr' => '<string>',
        'topology' => 'ISOLATED_VPC|HUB_AND_SPOKE',
    ],
    'targetS3Configuration' => [
        's3Bucket' => '<string>',
        's3BucketOwner' => '<string>',
    ],
    'updatedAt' => <DateTime>,
]

Result Details

Errors

ResourceNotFoundException:

Resource not found exception.

AccessDeniedException:

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

Examples

Example 1: Sample GetNetworkMigrationDefinition call

$result = $client->getNetworkMigrationDefinition([
    'networkMigrationDefinitionID' => 'nmd-01234567891234567',
]);

Result syntax:

[
    'name' => 'network1',
    'createdAt' => ,
    'description' => 'network 1 description',
    'networkMigrationDefinitionID' => 'nmd-01234567891234567',
    'sourceConfigurations' => [
        [
            'sourceEnvironment' => 'NSX',
            'sourceS3Configuration' => [
                's3Bucket' => 'source_bucket',
                's3BucketOwner' => '012345678901',
                's3Key' => 'source_key',
            ],
        ],
    ],
    'tags' => [
    ],
    'targetNetwork' => [
        'inboundCidr' => '192.168.1.0/24',
        'topology' => 'ISOLATED_VPC',
    ],
    'targetS3Configuration' => [
        's3Bucket' => 'target_bucket',
        's3BucketOwner' => '012345678901',
    ],
    'updatedAt' => ,
]

GetNetworkMigrationMapperSegmentConstruct

$result = $client->getNetworkMigrationMapperSegmentConstruct([/* ... */]);
$promise = $client->getNetworkMigrationMapperSegmentConstructAsync([/* ... */]);

Retrieves detailed information about a specific construct within a mapper segment, including its properties and configuration data.

Parameter Syntax

$result = $client->getNetworkMigrationMapperSegmentConstruct([
    'constructID' => '<string>', // REQUIRED
    'networkMigrationDefinitionID' => '<string>', // REQUIRED
    'networkMigrationExecutionID' => '<string>', // REQUIRED
    'segmentID' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

[
    'construct' => [
        'constructID' => '<string>',
        'constructType' => '<string>',
        'createdAt' => <DateTime>,
        'description' => '<string>',
        'logicalID' => '<string>',
        'name' => '<string>',
        'properties' => ['<string>', ...],
        'updatedAt' => <DateTime>,
    ],
]

Result Details

Errors

ResourceNotFoundException:

Resource not found exception.

AccessDeniedException:

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

ValidationException:

Validate exception.

Examples

Example 1: Sample GetNetworkMigrationMapperSegmentConstruct call

$result = $client->getNetworkMigrationMapperSegmentConstruct([
    'constructID' => 'abc45678-abcd-abcd-efab-012345678abc',
    'networkMigrationDefinitionID' => 'nmd-01234567891234567',
    'networkMigrationExecutionID' => '01234567-abcd-abcd-abcd-0123456789ab',
    'segmentID' => '12345678-abcd-abcd-efab-0123456789ab',
]);

Result syntax:

[
    'construct' => [
        'name' => 'SegmentConstructName',
        'constructID' => 'abc45678-abcd-abcd-efab-012345678abc',
        'constructType' => 'AWS::EC2::VPC',
        'createdAt' => ,
        'description' => 'Segment construct description',
        'logicalID' => 'logical-id1',
        'properties' => [
            'CidrBlock' => '192.168.101.0/24',
            'MapPublicIpOnLaunch' => 'False',
            'Tags' => '[{'Key': 'Name', 'Value': '/infra/tier-1s/cgw/segments/Lab1-veeam-test-192.168.101.0/24'}]',
        ],
        'updatedAt' => ,
    ],
]

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>',
    'internetProtocol' => 'IPV4|IPV6',
    '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>', ...],
    'storeSnapshotOnLocalZone' => true || false,
    '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

AccessDeniedException:

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

ValidationException:

Validate exception.

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' => [
        [
            'arn' => '<string>',
            '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>,
            ],
            'tags' => ['<string>', ...],
        ],
        // ...
    ],
    '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.

ListImportFileEnrichments

$result = $client->listImportFileEnrichments([/* ... */]);
$promise = $client->listImportFileEnrichmentsAsync([/* ... */]);

Lists import file enrichment jobs with optional filtering by job IDs.

Parameter Syntax

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

Parameter Details

Result Syntax

[
    'items' => [
        [
            'checksum' => [
                'encryptionAlgorithm' => 'SHA256',
                'hash' => '<string>',
            ],
            'createdAt' => <DateTime>,
            'endedAt' => <DateTime>,
            'jobID' => '<string>',
            's3BucketTarget' => [
                's3Bucket' => '<string>',
                's3BucketOwner' => '<string>',
                's3Key' => '<string>',
            ],
            'status' => 'PENDING|STARTED|FAILED|SUCCEEDED|SUCCEEDED_WITH_WARNINGS',
            'statusDetails' => '<string>',
        ],
        // ...
    ],
    'nextToken' => '<string>',
]

Result Details

Errors

ValidationException:

Validate exception.

Examples

Example 1: Sample ListImportFileEnrichments call

$result = $client->listImportFileEnrichments([
    'filters' => [
        'jobIDs' => [
            '01234567-abcd-abcd-efab-0123456789ab',
        ],
    ],
    'maxResults' => 10,
]);

Result syntax:

[
    'items' => [
        [
            'createdAt' => ,
            'endedAt' => ,
            'jobID' => '01234567-abcd-abcd-efab-0123456789ab',
            's3BucketTarget' => [
                's3Bucket' => 'my-target-bucket',
                's3BucketOwner' => '123456789012',
                's3Key' => 'enriched/output.csv',
            ],
            'status' => 'SUCCEEDED',
            'statusDetails' => 'Import file enrichment completed successfully',
        ],
    ],
    'nextToken' => 'NextTokenId',
]

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' => [
        [
            'arn' => '<string>',
            '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>,
                ],
            ],
            'tags' => ['<string>', ...],
        ],
        // ...
    ],
    '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.

ListNetworkMigrationAnalyses

$result = $client->listNetworkMigrationAnalyses([/* ... */]);
$promise = $client->listNetworkMigrationAnalysesAsync([/* ... */]);

Lists network migration analysis jobs for a specified execution. Returns information about analysis job status and results.

Parameter Syntax

$result = $client->listNetworkMigrationAnalyses([
    'filters' => [
        'jobIDs' => ['<string>', ...],
    ],
    'maxResults' => <integer>,
    'networkMigrationDefinitionID' => '<string>', // REQUIRED
    'networkMigrationExecutionID' => '<string>', // REQUIRED
    'nextToken' => '<string>',
]);

Parameter Details

Result Syntax

[
    'items' => [
        [
            'createdAt' => <DateTime>,
            'endedAt' => <DateTime>,
            'jobID' => '<string>',
            'networkMigrationDefinitionID' => '<string>',
            'networkMigrationExecutionID' => '<string>',
            'status' => 'PENDING|STARTED|SUCCEEDED|FAILED',
            'statusDetails' => '<string>',
        ],
        // ...
    ],
    'nextToken' => '<string>',
]

Result Details

Errors

ResourceNotFoundException:

Resource not found exception.

ThrottlingException:

Reached throttling quota exception.

AccessDeniedException:

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

ValidationException:

Validate exception.

Examples

Example 1: Sample ListNetworkMigrationAnalyses call

$result = $client->listNetworkMigrationAnalyses([
    'networkMigrationDefinitionID' => 'nmd-01234567891234567',
    'networkMigrationExecutionID' => '01234567-abcd-abcd-abcd-0123456789ab',
]);

Result syntax:

[
    'items' => [
        [
            'createdAt' => ,
            'endedAt' => ,
            'jobID' => '01234567-abcd-abcd-efab-0123456789ab',
            'networkMigrationDefinitionID' => 'nmd-01234567891234567',
            'networkMigrationExecutionID' => '01234567-abcd-abcd-abcd-0123456789ab',
            'status' => 'SUCCEEDED',
            'statusDetails' => 'Job status details',
        ],
    ],
    'nextToken' => 'NextTokenId',
]

ListNetworkMigrationAnalysisResults

$result = $client->listNetworkMigrationAnalysisResults([/* ... */]);
$promise = $client->listNetworkMigrationAnalysisResultsAsync([/* ... */]);

Lists the results of network migration analyses, showing connectivity and compatibility findings for migrated resources.

Parameter Syntax

$result = $client->listNetworkMigrationAnalysisResults([
    'filters' => [
        'vpcIDs' => ['<string>', ...],
    ],
    'maxResults' => <integer>,
    'networkMigrationDefinitionID' => '<string>', // REQUIRED
    'networkMigrationExecutionID' => '<string>', // REQUIRED
    'nextToken' => '<string>',
]);

Parameter Details

Result Syntax

[
    'items' => [
        [
            'analysisResult' => '<string>',
            'analyzerType' => 'REACHABILITY_ANALYZER',
            'jobID' => '<string>',
            'networkMigrationDefinitionID' => '<string>',
            'networkMigrationExecutionID' => '<string>',
            'source' => [
                'subnetID' => '<string>',
                'vpcID' => '<string>',
            ],
            'status' => 'PENDING|STARTED|SUCCEEDED|FAILED',
            'target' => [
                'subnetID' => '<string>',
                'vpcID' => '<string>',
            ],
        ],
        // ...
    ],
    'nextToken' => '<string>',
]

Result Details

Errors

ResourceNotFoundException:

Resource not found exception.

ThrottlingException:

Reached throttling quota exception.

AccessDeniedException:

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

ValidationException:

Validate exception.

Examples

Example 1: Sample ListNetworkMigrationAnalysisResults call

$result = $client->listNetworkMigrationAnalysisResults([
    'networkMigrationDefinitionID' => 'nmd-01234567891234567',
    'networkMigrationExecutionID' => '01234567-abcd-abcd-abcd-0123456789ab',
]);

Result syntax:

[
    'items' => [
        [
            'analysisResult' => 'analysis result',
            'analyzerType' => 'REACHABILITY_ANALYZER',
            'jobID' => '01234567-abcd-abcd-efab-0123456789ab',
            'networkMigrationDefinitionID' => 'nmd-01234567891234567',
            'networkMigrationExecutionID' => '01234567-abcd-abcd-abcd-0123456789ab',
            'source' => [
                'subnetID' => 'subnet-12345678',
                'vpcID' => 'vpc-12345678',
            ],
            'status' => 'SUCCEEDED',
            'target' => [
                'subnetID' => 'subnet-01234567',
                'vpcID' => 'vpc-01234567',
            ],
        ],
    ],
    'nextToken' => 'NextTokenId',
]

ListNetworkMigrationCodeGenerationSegments

$result = $client->listNetworkMigrationCodeGenerationSegments([/* ... */]);
$promise = $client->listNetworkMigrationCodeGenerationSegmentsAsync([/* ... */]);

Lists code generation segments, which represent individual infrastructure components generated as code templates.

Parameter Syntax

$result = $client->listNetworkMigrationCodeGenerationSegments([
    'filters' => [
        'segmentIDs' => ['<string>', ...],
    ],
    'maxResults' => <integer>,
    'networkMigrationDefinitionID' => '<string>', // REQUIRED
    'networkMigrationExecutionID' => '<string>', // REQUIRED
    'nextToken' => '<string>',
]);

Parameter Details

Result Syntax

[
    'items' => [
        [
            'artifacts' => [
                [
                    'artifactID' => '<string>',
                    'artifactSubType' => 'APPLICATION|NESTED_STACK|STACK',
                    'artifactType' => 'CDK_TYPESCRIPT|CLOUDFORMATION_TEMPLATE|CDKTF_TYPESCRIPT|TERRAFORM_CONFIGURATION|CDK_L2_TYPESCRIPT',
                    'checksum' => [
                        'encryptionAlgorithm' => 'SHA256',
                        'hash' => '<string>',
                    ],
                    'createdAt' => <DateTime>,
                    'logicalID' => '<string>',
                    'outputS3Configuration' => [
                        's3Bucket' => '<string>',
                        's3BucketOwner' => '<string>',
                        's3Key' => '<string>',
                    ],
                ],
                // ...
            ],
            'createdAt' => <DateTime>,
            'jobID' => '<string>',
            'logicalID' => '<string>',
            'mapperSegmentID' => '<string>',
            'networkMigrationDefinitionID' => '<string>',
            'networkMigrationExecutionID' => '<string>',
            'segmentID' => '<string>',
            'segmentType' => 'WORKLOAD|APPLIANCE|NETWORK',
        ],
        // ...
    ],
    'nextToken' => '<string>',
]

Result Details

Errors

ResourceNotFoundException:

Resource not found exception.

ThrottlingException:

Reached throttling quota exception.

AccessDeniedException:

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

ValidationException:

Validate exception.

Examples

Example 1: Sample ListNetworkMigrationCodeGenerationSegments call

$result = $client->listNetworkMigrationCodeGenerationSegments([
    'networkMigrationDefinitionID' => 'nmd-01234567891234567',
    'networkMigrationExecutionID' => '01234567-abcd-abcd-abcd-0123456789ab',
]);

Result syntax:

[
    'items' => [
        [
            'artifacts' => [
                [
                    'artifactID' => 'a2345678-abcd-abcd-efab-0123456789ab',
                    'artifactSubType' => 'STACK',
                    'artifactType' => 'CDK_TYPESCRIPT',
                    'checksum' => [
                        'encryptionAlgorithm' => 'SHA256',
                        'hash' => '0123456789aAbBcCdDeEfF0123456789',
                    ],
                    'createdAt' => ,
                    'logicalID' => 'logical-id2',
                    'outputS3Configuration' => [
                        's3Bucket' => 's3_bucket',
                        's3BucketOwner' => '012345678901',
                        's3Key' => 'S3KeyName',
                    ],
                ],
            ],
            'createdAt' => ,
            'jobID' => '01234567-abcd-abcd-efab-0123456789ab',
            'logicalID' => 'logical-id1',
            'mapperSegmentID' => '12345678-abcd-abcd-efab-0123456789ab',
            'networkMigrationDefinitionID' => 'nmd-01234567891234567',
            'networkMigrationExecutionID' => '01234567-abcd-abcd-abcd-0123456789ab',
            'segmentID' => '12345678-abcd-abcd-efab-0123456789ab',
            'segmentType' => 'WORKLOAD',
        ],
    ],
    'nextToken' => 'NextTokenId',
]

ListNetworkMigrationCodeGenerations

$result = $client->listNetworkMigrationCodeGenerations([/* ... */]);
$promise = $client->listNetworkMigrationCodeGenerationsAsync([/* ... */]);

Lists network migration code generation jobs, which convert network mappings into infrastructure-as-code templates.

Parameter Syntax

$result = $client->listNetworkMigrationCodeGenerations([
    'filters' => [
        'jobIDs' => ['<string>', ...],
    ],
    'maxResults' => <integer>,
    'networkMigrationDefinitionID' => '<string>', // REQUIRED
    'networkMigrationExecutionID' => '<string>', // REQUIRED
    'nextToken' => '<string>',
]);

Parameter Details

Result Syntax

[
    'items' => [
        [
            'codeGenerationOutputFormatStatusDetailsMap' => [
                '<CodeGenerationOutputFormatType>' => [
                    'status' => 'SUCCEEDED|FAILED',
                    'statusDetailList' => '<string>',
                ],
                // ...
            ],
            'createdAt' => <DateTime>,
            'endedAt' => <DateTime>,
            'jobID' => '<string>',
            'networkMigrationDefinitionID' => '<string>',
            'networkMigrationExecutionID' => '<string>',
            'status' => 'PENDING|STARTED|SUCCEEDED|FAILED',
            'statusDetails' => '<string>',
        ],
        // ...
    ],
    'nextToken' => '<string>',
]

Result Details

Errors

ResourceNotFoundException:

Resource not found exception.

ThrottlingException:

Reached throttling quota exception.

AccessDeniedException:

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

ValidationException:

Validate exception.

Examples

Example 1: Sample ListNetworkMigrationCodeGenerations call

$result = $client->listNetworkMigrationCodeGenerations([
    'networkMigrationDefinitionID' => 'nmd-01234567891234567',
    'networkMigrationExecutionID' => '01234567-abcd-abcd-abcd-0123456789ab',
]);

Result syntax:

[
    'items' => [
        [
            'createdAt' => ,
            'endedAt' => ,
            'jobID' => '01234567-abcd-abcd-efab-0123456789ab',
            'networkMigrationDefinitionID' => 'nmd-01234567891234567',
            'networkMigrationExecutionID' => '01234567-abcd-abcd-abcd-0123456789ab',
            'status' => 'SUCCEEDED',
            'statusDetails' => 'Job status details',
        ],
    ],
    'nextToken' => 'NextTokenId',
]

ListNetworkMigrationDefinitions

$result = $client->listNetworkMigrationDefinitions([/* ... */]);
$promise = $client->listNetworkMigrationDefinitionsAsync([/* ... */]);

Lists all network migration definitions in the account, with optional filtering.

Parameter Syntax

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

Parameter Details

Result Syntax

[
    'items' => [
        [
            'arn' => '<string>',
            'name' => '<string>',
            'networkMigrationDefinitionID' => '<string>',
            'scopeTags' => ['<string>', ...],
            'sourceEnvironment' => 'NSX|VSPHERE|FORTIGATE_FIREWALL|PALO_ALTO_FIREWALL|CISCO_ACI|LOGICAL_MODEL|MODELIZE_IT',
            'tags' => ['<string>', ...],
        ],
        // ...
    ],
    'nextToken' => '<string>',
]

Result Details

Errors

AccessDeniedException:

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

Examples

Example 1: Sample ListNetworkMigrationDefinitions call

$result = $client->listNetworkMigrationDefinitions([
    'filters' => [
        'networkMigrationDefinitionIDs' => [
            'nmd-01234567891234567',
        ],
    ],
]);

Result syntax:

[
    'items' => [
        [
            'name' => 'network1',
            'networkMigrationDefinitionID' => 'nmd-01234567891234567',
            'sourceEnvironment' => 'NSX',
        ],
    ],
    'nextToken' => 'NextTokenId',
]

ListNetworkMigrationDeployedStacks

$result = $client->listNetworkMigrationDeployedStacks([/* ... */]);
$promise = $client->listNetworkMigrationDeployedStacksAsync([/* ... */]);

Lists CloudFormation stacks that have been deployed as part of the network migration.

Parameter Syntax

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

Parameter Details

Result Syntax

[
    'items' => [
        [
            'failedResources' => [
                [
                    'logicalID' => '<string>',
                    'status' => 'CREATE_FAILED|DELETE_FAILED',
                    'statusReason' => '<string>',
                ],
                // ...
            ],
            'segmentID' => '<string>',
            'stackLogicalID' => '<string>',
            'stackPhysicalID' => '<string>',
            'status' => 'CREATE_COMPLETE|CREATE_FAILED|CREATE_STARTED|DELETE_COMPLETE|DELETE_FAILED|DELETE_STARTED',
            'targetAccount' => '<string>',
        ],
        // ...
    ],
    'nextToken' => '<string>',
]

Result Details

Errors

ResourceNotFoundException:

Resource not found exception.

ThrottlingException:

Reached throttling quota exception.

AccessDeniedException:

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

ValidationException:

Validate exception.

Examples

Example 1: Sample ListNetworkMigrationDeployedStacks call

$result = $client->listNetworkMigrationDeployedStacks([
    'networkMigrationDefinitionID' => 'nmd-01234567891234567',
    'networkMigrationExecutionID' => '01234567-abcd-abcd-abcd-0123456789ab',
]);

Result syntax:

[
    'items' => [
        [
            'failedResources' => [
            ],
            'segmentID' => '12345678-abcd-abcd-efab-0123456789ab',
            'stackLogicalID' => 'logical-id1',
            'stackPhysicalID' => 'arn:aws:cloudformation:us-east-1:012345678901:stack/ExampleStack/b2345678-abcd-abcd-efab-0123456789ab',
            'status' => 'CREATE_STARTED',
            'targetAccount' => '234567890123',
        ],
    ],
    'nextToken' => 'NextTokenId',
]

ListNetworkMigrationDeployments

$result = $client->listNetworkMigrationDeployments([/* ... */]);
$promise = $client->listNetworkMigrationDeploymentsAsync([/* ... */]);

Lists network migration deployment jobs and their current status.

Parameter Syntax

$result = $client->listNetworkMigrationDeployments([
    'filters' => [
        'jobIDs' => ['<string>', ...],
    ],
    'maxResults' => <integer>,
    'networkMigrationDefinitionID' => '<string>', // REQUIRED
    'networkMigrationExecutionID' => '<string>', // REQUIRED
    'nextToken' => '<string>',
]);

Parameter Details

Result Syntax

[
    'items' => [
        [
            'createdAt' => <DateTime>,
            'endedAt' => <DateTime>,
            'jobID' => '<string>',
            'networkMigrationDefinitionID' => '<string>',
            'networkMigrationExecutionID' => '<string>',
            'status' => 'PENDING|STARTED|SUCCEEDED|FAILED',
            'statusDetails' => '<string>',
        ],
        // ...
    ],
    'nextToken' => '<string>',
]

Result Details

Errors

ResourceNotFoundException:

Resource not found exception.

ThrottlingException:

Reached throttling quota exception.

AccessDeniedException:

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

ValidationException:

Validate exception.

Examples

Example 1: Sample ListNetworkMigrationDeployments call

$result = $client->listNetworkMigrationDeployments([
    'networkMigrationDefinitionID' => 'nmd-01234567891234567',
    'networkMigrationExecutionID' => '01234567-abcd-abcd-abcd-0123456789ab',
]);

Result syntax:

[
    'items' => [
        [
            'createdAt' => ,
            'endedAt' => ,
            'jobID' => '01234567-abcd-abcd-efab-0123456789ab',
            'networkMigrationDefinitionID' => 'nmd-01234567891234567',
            'networkMigrationExecutionID' => '01234567-abcd-abcd-abcd-0123456789ab',
            'status' => 'SUCCEEDED',
            'statusDetails' => 'Job status details',
        ],
    ],
    'nextToken' => 'NextTokenId',
]

ListNetworkMigrationExecutions

$result = $client->listNetworkMigrationExecutions([/* ... */]);
$promise = $client->listNetworkMigrationExecutionsAsync([/* ... */]);

Lists network migration execution instances for a given definition, showing the status and progress of each execution.

Parameter Syntax

$result = $client->listNetworkMigrationExecutions([
    'filters' => [
        'networkMigrationExecutionIDs' => ['<string>', ...],
        'networkMigrationExecutionStatuses' => ['<string>', ...],
    ],
    'maxResults' => <integer>,
    'networkMigrationDefinitionID' => '<string>', // REQUIRED
    'nextToken' => '<string>',
]);

Parameter Details

Result Syntax

[
    'items' => [
        [
            'activity' => 'MAPPING|MAPPING_UPDATE|CODE_GENERATION|DEPLOY|DEPLOYED_STACKS_DELETION|ANALYZE',
            'createdAt' => <DateTime>,
            'networkMigrationDefinitionID' => '<string>',
            'networkMigrationExecutionID' => '<string>',
            'stage' => 'MAPPING|CODE_GENERATION|DEPLOY|DEPLOYED_STACKS_DELETION|ANALYZE',
            'status' => 'PENDING|STARTED|SUCCEEDED|FAILED',
            'tags' => ['<string>', ...],
            'updatedAt' => <DateTime>,
        ],
        // ...
    ],
    'nextToken' => '<string>',
]

Result Details

Errors

ResourceNotFoundException:

Resource not found exception.

AccessDeniedException:

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

Examples

Example 1: Sample ListNetworkMigrationExecutions call

$result = $client->listNetworkMigrationExecutions([
    'networkMigrationDefinitionID' => 'nmd-01234567891234567',
]);

Result syntax:

[
    'items' => [
        [
            'activity' => 'CODE_GENERATION',
            'createdAt' => ,
            'networkMigrationDefinitionID' => 'nmd-01234567891234567',
            'networkMigrationExecutionID' => '01234567-abcd-abcd-abcd-0123456789ab',
            'stage' => 'CODE_GENERATION',
            'status' => 'SUCCEEDED',
            'tags' => [
            ],
            'updatedAt' => ,
        ],
    ],
    'nextToken' => 'NextTokenId',
]

ListNetworkMigrationMapperSegmentConstructs

$result = $client->listNetworkMigrationMapperSegmentConstructs([/* ... */]);
$promise = $client->listNetworkMigrationMapperSegmentConstructsAsync([/* ... */]);

Lists constructs within a mapper segment, representing individual infrastructure components like VPCs, subnets, or security groups.

Parameter Syntax

$result = $client->listNetworkMigrationMapperSegmentConstructs([
    'filters' => [
        'constructIDs' => ['<string>', ...],
        'constructTypes' => ['<string>', ...],
    ],
    'maxResults' => <integer>,
    'networkMigrationDefinitionID' => '<string>', // REQUIRED
    'networkMigrationExecutionID' => '<string>', // REQUIRED
    'nextToken' => '<string>',
    'segmentID' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

[
    'items' => [
        [
            'constructID' => '<string>',
            'constructType' => '<string>',
            'createdAt' => <DateTime>,
            'description' => '<string>',
            'logicalID' => '<string>',
            'name' => '<string>',
            'properties' => ['<string>', ...],
            'updatedAt' => <DateTime>,
        ],
        // ...
    ],
    'nextToken' => '<string>',
]

Result Details

Errors

ResourceNotFoundException:

Resource not found exception.

ThrottlingException:

Reached throttling quota exception.

AccessDeniedException:

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

ValidationException:

Validate exception.

Examples

Example 1: Sample ListNetworkMigrationMapperSegmentConstructs call with properties enabled

$result = $client->listNetworkMigrationMapperSegmentConstructs([
    'networkMigrationDefinitionID' => 'nmd-01234567891234567',
    'networkMigrationExecutionID' => '01234567-abcd-abcd-abcd-0123456789ab',
    'segmentID' => '12345678-abcd-abcd-efab-0123456789ab',
]);

Result syntax:

[
    'items' => [
        [
            'name' => 'SegmentConstructName',
            'constructID' => 'abc45678-abcd-abcd-efab-012345678abc',
            'constructType' => 'AWS::EC2::VPC',
            'createdAt' => ,
            'description' => 'Segment construct description',
            'logicalID' => 'logical-id1',
            'properties' => [
                'CidrBlock' => '192.168.101.0/24',
                'MapPublicIpOnLaunch' => 'False',
                'Tags' => '[{'Key': 'Name', 'Value': '/infra/tier-1s/cgw/segments/Lab1-veeam-test-192.168.101.0/24'}]',
            ],
            'updatedAt' => ,
        ],
    ],
    'nextToken' => 'NextTokenId',
]

Example 2: Sample ListNetworkMigrationMapperSegmentConstructs call with properties disabled (default)

$result = $client->listNetworkMigrationMapperSegmentConstructs([
    'networkMigrationDefinitionID' => 'nmd-01234567891234567',
    'networkMigrationExecutionID' => '01234567-abcd-abcd-abcd-0123456789ab',
    'segmentID' => '12345678-abcd-abcd-efab-0123456789ab',
]);

Result syntax:

[
    'items' => [
        [
            'name' => 'SegmentConstructName',
            'constructID' => 'abc45678-abcd-abcd-efab-012345678abc',
            'constructType' => 'AWS::EC2::VPC',
            'createdAt' => ,
            'description' => 'Segment construct description',
            'logicalID' => 'logical-id1',
            'updatedAt' => ,
        ],
    ],
    'nextToken' => 'NextTokenId',
]

ListNetworkMigrationMapperSegments

$result = $client->listNetworkMigrationMapperSegments([/* ... */]);
$promise = $client->listNetworkMigrationMapperSegmentsAsync([/* ... */]);

Lists mapper segments, which represent logical groupings of network resources to be migrated together.

Parameter Syntax

$result = $client->listNetworkMigrationMapperSegments([
    'filters' => [
        'segmentIDs' => ['<string>', ...],
    ],
    'maxResults' => <integer>,
    'networkMigrationDefinitionID' => '<string>', // REQUIRED
    'networkMigrationExecutionID' => '<string>', // REQUIRED
    'nextToken' => '<string>',
]);

Parameter Details

Result Syntax

[
    'items' => [
        [
            'checksum' => [
                'encryptionAlgorithm' => 'SHA256',
                'hash' => '<string>',
            ],
            'createdAt' => <DateTime>,
            'description' => '<string>',
            'jobID' => '<string>',
            'logicalID' => '<string>',
            'name' => '<string>',
            'networkMigrationDefinitionID' => '<string>',
            'networkMigrationExecutionID' => '<string>',
            'outputS3Configuration' => [
                's3Bucket' => '<string>',
                's3BucketOwner' => '<string>',
                's3Key' => '<string>',
            ],
            'referencedSegments' => ['<string>', ...],
            'scopeTags' => ['<string>', ...],
            'segmentID' => '<string>',
            'segmentType' => 'WORKLOAD|APPLIANCE',
            'targetAccount' => '<string>',
            'updatedAt' => <DateTime>,
        ],
        // ...
    ],
    'nextToken' => '<string>',
]

Result Details

Errors

ResourceNotFoundException:

Resource not found exception.

ThrottlingException:

Reached throttling quota exception.

AccessDeniedException:

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

ValidationException:

Validate exception.

Examples

Example 1: Sample ListNetworkMigrationMapperSegments call

$result = $client->listNetworkMigrationMapperSegments([
    'networkMigrationDefinitionID' => 'nmd-01234567891234567',
    'networkMigrationExecutionID' => '01234567-abcd-abcd-abcd-0123456789ab',
]);

Result syntax:

[
    'items' => [
        [
            'name' => 'SegmentName',
            'checksum' => [
                'encryptionAlgorithm' => 'SHA256',
                'hash' => '0123456789aAbBcCdDeEfF0123456789',
            ],
            'createdAt' => ,
            'description' => 'Segment description',
            'jobID' => '01234567-abcd-abcd-efab-0123456789ab',
            'logicalID' => 'logical-id1',
            'networkMigrationDefinitionID' => 'nmd-01234567891234567',
            'networkMigrationExecutionID' => '01234567-abcd-abcd-abcd-0123456789ab',
            'outputS3Configuration' => [
                's3Bucket' => 's3_bucket',
                's3BucketOwner' => '012345678901',
                's3Key' => 'S3KeyName',
            ],
            'segmentID' => '12345678-abcd-abcd-efab-0123456789ab',
            'segmentType' => 'WORKLOAD',
            'updatedAt' => ,
        ],
    ],
    'nextToken' => 'NextTokenId',
]

ListNetworkMigrationMappingUpdates

$result = $client->listNetworkMigrationMappingUpdates([/* ... */]);
$promise = $client->listNetworkMigrationMappingUpdatesAsync([/* ... */]);

Lists mapping update jobs, which apply customer modifications to the generated network mappings.

Parameter Syntax

$result = $client->listNetworkMigrationMappingUpdates([
    'filters' => [
        'jobIDs' => ['<string>', ...],
    ],
    'maxResults' => <integer>,
    'networkMigrationDefinitionID' => '<string>', // REQUIRED
    'networkMigrationExecutionID' => '<string>', // REQUIRED
    'nextToken' => '<string>',
]);

Parameter Details

Result Syntax

[
    'items' => [
        [
            'createdAt' => <DateTime>,
            'endedAt' => <DateTime>,
            'jobID' => '<string>',
            'networkMigrationDefinitionID' => '<string>',
            'networkMigrationExecutionID' => '<string>',
            'status' => 'PENDING|STARTED|SUCCEEDED|FAILED',
            'statusDetails' => '<string>',
        ],
        // ...
    ],
    'nextToken' => '<string>',
]

Result Details

Errors

ResourceNotFoundException:

Resource not found exception.

ThrottlingException:

Reached throttling quota exception.

AccessDeniedException:

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

ValidationException:

Validate exception.

Examples

Example 1: Sample ListNetworkMigrationMappingUpdates call

$result = $client->listNetworkMigrationMappingUpdates([
    'networkMigrationDefinitionID' => 'nmd-01234567891234567',
    'networkMigrationExecutionID' => '01234567-abcd-abcd-abcd-0123456789ab',
]);

Result syntax:

[
    'items' => [
        [
            'createdAt' => ,
            'endedAt' => ,
            'jobID' => '01234567-abcd-abcd-efab-0123456789ab',
            'networkMigrationDefinitionID' => 'nmd-01234567891234567',
            'networkMigrationExecutionID' => '01234567-abcd-abcd-abcd-0123456789ab',
            'status' => 'SUCCEEDED',
            'statusDetails' => 'Job status details',
        ],
    ],
    'nextToken' => 'NextTokenId',
]

ListNetworkMigrationMappings

$result = $client->listNetworkMigrationMappings([/* ... */]);
$promise = $client->listNetworkMigrationMappingsAsync([/* ... */]);

Lists network migration mapping jobs, which analyze and create relationships between source and target network resources.

Parameter Syntax

$result = $client->listNetworkMigrationMappings([
    'filters' => [
        'jobIDs' => ['<string>', ...],
    ],
    'maxResults' => <integer>,
    'networkMigrationDefinitionID' => '<string>', // REQUIRED
    'networkMigrationExecutionID' => '<string>', // REQUIRED
    'nextToken' => '<string>',
]);

Parameter Details

Result Syntax

[
    'items' => [
        [
            'createdAt' => <DateTime>,
            'endedAt' => <DateTime>,
            'jobID' => '<string>',
            'networkMigrationDefinitionID' => '<string>',
            'networkMigrationExecutionID' => '<string>',
            'status' => 'PENDING|STARTED|SUCCEEDED|FAILED',
            'statusDetails' => '<string>',
        ],
        // ...
    ],
    'nextToken' => '<string>',
]

Result Details

Errors

ResourceNotFoundException:

Resource not found exception.

ThrottlingException:

Reached throttling quota exception.

AccessDeniedException:

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

ValidationException:

Validate exception.

Examples

Example 1: Sample ListNetworkMigrationMappings call

$result = $client->listNetworkMigrationMappings([
    'networkMigrationDefinitionID' => 'nmd-01234567891234567',
    'networkMigrationExecutionID' => '01234567-abcd-abcd-abcd-0123456789ab',
]);

Result syntax:

[
    'items' => [
        [
            'createdAt' => ,
            'endedAt' => ,
            'jobID' => '01234567-abcd-abcd-efab-0123456789ab',
            'networkMigrationDefinitionID' => 'nmd-01234567891234567',
            'networkMigrationExecutionID' => '01234567-abcd-abcd-abcd-0123456789ab',
            'status' => 'SUCCEEDED',
            'statusDetails' => 'Job status details',
        ],
    ],
    'nextToken' => 'NextTokenId',
]

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|SECURE_STRING',
                    ],
                    // ...
                ],
                // ...
            ],
            'timeoutSeconds' => <integer>,
        ],
        // ...
    ],
    'nextToken' => '<string>',
]

Result Details