Application Migration Service 2020-02-26
- Client: Aws\mgn\mgnClient
- Service ID: mgn
- Version: 2020-02-26
This page describes the parameters and results for the operations of the Application Migration Service (2020-02-26), and shows how to use the Aws\mgn\mgnClient object to call the described operations. This documentation is specific to the 2020-02-26 API version of the service.
Operation Summary
Each of the following operations can be created from a client using
$client->getCommand('CommandName'), where "CommandName" is the
name of one of the following operations. Note: a command is a value that
encapsulates an operation and the parameters used to create an HTTP request.
You can also create and send a command immediately using the magic methods
available on a client object: $client->commandName(/* parameters */).
You can send the command asynchronously (returning a promise) by appending the
word "Async" to the operation name: $client->commandNameAsync(/* parameters */).
- ArchiveApplication ( array $params = [] )
Archive application.
- ArchiveWave ( array $params = [] )
Archive wave.
- AssociateApplications ( array $params = [] )
Associate applications to wave.
- AssociateSourceServers ( array $params = [] )
Associate source servers to application.
- ChangeServerLifeCycleState ( array $params = [] )
Allows the user to set the SourceServer.
- CreateApplication ( array $params = [] )
Create application.
- CreateLaunchConfigurationTemplate ( array $params = [] )
Creates a new Launch Configuration Template.
- CreateReplicationConfigurationTemplate ( array $params = [] )
Creates a new ReplicationConfigurationTemplate.
- CreateWave ( array $params = [] )
Create wave.
- DeleteApplication ( array $params = [] )
Delete application.
- DeleteJob ( array $params = [] )
Deletes a single Job by ID.
- DeleteLaunchConfigurationTemplate ( array $params = [] )
Deletes a single Launch Configuration Template by ID.
- DeleteReplicationConfigurationTemplate ( array $params = [] )
Deletes a single Replication Configuration Template by ID
- DeleteSourceServer ( array $params = [] )
Deletes a single source server by ID.
- DeleteVcenterClient ( array $params = [] )
Deletes a given vCenter client by ID.
- DeleteWave ( array $params = [] )
Delete wave.
- DescribeJobLogItems ( array $params = [] )
Retrieves detailed job log items with paging.
- DescribeJobs ( array $params = [] )
Returns a list of Jobs.
- DescribeLaunchConfigurationTemplates ( array $params = [] )
Lists all Launch Configuration Templates, filtered by Launch Configuration Template IDs
- DescribeReplicationConfigurationTemplates ( array $params = [] )
Lists all ReplicationConfigurationTemplates, filtered by Source Server IDs.
- DescribeSourceServers ( array $params = [] )
Retrieves all SourceServers or multiple SourceServers by ID.
- DescribeVcenterClients ( array $params = [] )
Returns a list of the installed vCenter clients.
- DisassociateApplications ( array $params = [] )
Disassociate applications from wave.
- DisassociateSourceServers ( array $params = [] )
Disassociate source servers from application.
- DisconnectFromService ( array $params = [] )
Disconnects specific Source Servers from Application Migration Service.
- FinalizeCutover ( array $params = [] )
Finalizes the cutover immediately for specific Source Servers.
- GetLaunchConfiguration ( array $params = [] )
Lists all LaunchConfigurations available, filtered by Source Server IDs.
- GetReplicationConfiguration ( array $params = [] )
Lists all ReplicationConfigurations, filtered by Source Server ID.
- InitializeService ( array $params = [] )
Initialize Application Migration Service.
- ListApplications ( array $params = [] )
Retrieves all applications or multiple applications by ID.
- ListExportErrors ( array $params = [] )
List export errors.
- ListExports ( array $params = [] )
List exports.
- ListImportErrors ( array $params = [] )
List import errors.
- ListImports ( array $params = [] )
List imports.
- ListSourceServerActions ( array $params = [] )
List source server post migration custom actions.
- ListTagsForResource ( array $params = [] )
List all tags for your Application Migration Service resources.
- ListTemplateActions ( array $params = [] )
List template post migration custom actions.
- ListWaves ( array $params = [] )
Retrieves all waves or multiple waves by ID.
- MarkAsArchived ( array $params = [] )
Archives specific Source Servers by setting the SourceServer.
- PutSourceServerAction ( array $params = [] )
Put source server post migration custom action.
- PutTemplateAction ( array $params = [] )
Put template post migration custom action.
- RemoveSourceServerAction ( array $params = [] )
Remove source server post migration custom action.
- RemoveTemplateAction ( array $params = [] )
Remove template post migration custom action.
- RetryDataReplication ( array $params = [] )
Causes the data replication initiation sequence to begin immediately upon next Handshake for specified SourceServer IDs, regardless of when the previous initiation started.
- StartCutover ( array $params = [] )
Launches a Cutover Instance for specific Source Servers.
- StartExport ( array $params = [] )
Start export.
- StartImport ( array $params = [] )
Start import.
- StartReplication ( array $params = [] )
Starts replication for SNAPSHOT_SHIPPING agents.
- StartTest ( array $params = [] )
Launches a Test Instance for specific Source Servers.
- TagResource ( array $params = [] )
Adds or overwrites only the specified tags for the specified Application Migration Service resource or resources.
- TerminateTargetInstances ( array $params = [] )
Starts a job that terminates specific launched EC2 Test and Cutover instances.
- UnarchiveApplication ( array $params = [] )
Unarchive application.
- UnarchiveWave ( array $params = [] )
Unarchive wave.
- UntagResource ( array $params = [] )
Deletes the specified set of tags from the specified set of Application Migration Service resources.
- UpdateApplication ( array $params = [] )
Update application.
- UpdateLaunchConfiguration ( array $params = [] )
Updates multiple LaunchConfigurations by Source Server ID.
- UpdateLaunchConfigurationTemplate ( array $params = [] )
Updates an existing Launch Configuration Template by ID.
- UpdateReplicationConfiguration ( array $params = [] )
Allows you to update multiple ReplicationConfigurations by Source Server ID.
- UpdateReplicationConfigurationTemplate ( array $params = [] )
Updates multiple ReplicationConfigurationTemplates by ID.
- UpdateSourceServerReplicationType ( array $params = [] )
Allows you to change between the AGENT_BASED replication type and the SNAPSHOT_SHIPPING replication type.
- UpdateWave ( array $params = [] )
Update wave.
Paginators
Paginators handle automatically iterating over paginated API results. Paginators are associated with specific API operations, and they accept the parameters that the corresponding API operation accepts. You can get a paginator from a client class using getPaginator($paginatorName, $operationParameters). This client supports the following paginators:
Operations
ArchiveApplication
$result = $client->archiveApplication([/* ... */]); $promise = $client->archiveApplicationAsync([/* ... */]);
Archive application.
Parameter Syntax
$result = $client->archiveApplication([
'applicationID' => '<string>', // REQUIRED
]);
Parameter Details
Members
- applicationID
-
- Required: Yes
- Type: string
Application ID.
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
Members
- applicationAggregatedStatus
-
- Type: ApplicationAggregatedStatus structure
Application aggregated status.
- applicationID
-
- Type: string
Application ID.
- arn
-
- Type: string
Application ARN.
- creationDateTime
-
- Type: string
Application creation dateTime.
- description
-
- Type: string
Application description.
- isArchived
-
- Type: boolean
Application archival status.
- lastModifiedDateTime
-
- Type: string
Application last modified dateTime.
- name
-
- Type: string
Application name.
- tags
-
- Type: Associative array of custom strings keys (TagKey) to strings
Application tags.
- waveID
-
- Type: string
Application wave ID.
Errors
-
UninitializedAccountException:
Uninitialized account exception.
-
Resource not found exception.
-
ServiceQuotaExceededException:
The request could not be completed because its exceeded the service quota.
-
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([
'waveID' => '<string>', // REQUIRED
]);
Parameter Details
Members
- waveID
-
- Required: Yes
- Type: string
Wave ID.
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
Members
- arn
-
- Type: string
Wave ARN.
- creationDateTime
-
- Type: string
Wave creation dateTime.
- description
-
- Type: string
Wave description.
- isArchived
-
- Type: boolean
Wave archival status.
- lastModifiedDateTime
-
- Type: string
Wave last modified dateTime.
- name
-
- Type: string
Wave name.
- tags
-
- Type: Associative array of custom strings keys (TagKey) to strings
Wave tags.
- waveAggregatedStatus
-
- Type: WaveAggregatedStatus structure
Wave aggregated status.
- waveID
-
- Type: string
Wave ID.
Errors
-
UninitializedAccountException:
Uninitialized account exception.
-
Resource not found exception.
-
ServiceQuotaExceededException:
The request could not be completed because its exceeded the service quota.
-
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([
'applicationIDs' => ['<string>', ...], // REQUIRED
'waveID' => '<string>', // REQUIRED
]);
Parameter Details
Members
- applicationIDs
-
- Required: Yes
- Type: Array of strings
Application IDs list.
- waveID
-
- Required: Yes
- Type: string
Wave ID.
Result Syntax
[]
Result Details
Errors
-
UninitializedAccountException:
Uninitialized account exception.
-
Resource not found exception.
-
ServiceQuotaExceededException:
The request could not be completed because its exceeded the service quota.
-
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([
'applicationID' => '<string>', // REQUIRED
'sourceServerIDs' => ['<string>', ...], // REQUIRED
]);
Parameter Details
Members
- applicationID
-
- Required: Yes
- Type: string
Application ID.
- sourceServerIDs
-
- Required: Yes
- Type: Array of strings
Source server IDs list.
Result Syntax
[]
Result Details
Errors
-
UninitializedAccountException:
Uninitialized account exception.
-
Resource not found exception.
-
ServiceQuotaExceededException:
The request could not be completed because its exceeded the service quota.
-
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([
'lifeCycle' => [ // REQUIRED
'state' => 'READY_FOR_TEST|READY_FOR_CUTOVER|CUTOVER', // REQUIRED
],
'sourceServerID' => '<string>', // REQUIRED
]);
Parameter Details
Members
- lifeCycle
-
- Required: Yes
- Type: ChangeServerLifeCycleStateSourceServerLifecycle structure
The request to change the source server migration lifecycle state.
- sourceServerID
-
- Required: Yes
- Type: string
The request to change the source server migration lifecycle state by source server ID.
Result Syntax
[
'applicationID' => '<string>',
'arn' => '<string>',
'dataReplicationInfo' => [
'dataReplicationError' => [
'error' => 'AGENT_NOT_SEEN|SNAPSHOTS_FAILURE|NOT_CONVERGING|UNSTABLE_NETWORK|FAILED_TO_CREATE_SECURITY_GROUP|FAILED_TO_LAUNCH_REPLICATION_SERVER|FAILED_TO_BOOT_REPLICATION_SERVER|FAILED_TO_AUTHENTICATE_WITH_SERVICE|FAILED_TO_DOWNLOAD_REPLICATION_SOFTWARE|FAILED_TO_CREATE_STAGING_DISKS|FAILED_TO_ATTACH_STAGING_DISKS|FAILED_TO_PAIR_REPLICATION_SERVER_WITH_AGENT|FAILED_TO_CONNECT_AGENT_TO_REPLICATION_SERVER|FAILED_TO_START_DATA_TRANSFER|UNSUPPORTED_VM_CONFIGURATION|LAST_SNAPSHOT_JOB_FAILED',
'rawError' => '<string>',
],
'dataReplicationInitiation' => [
'nextAttemptDateTime' => '<string>',
'startDateTime' => '<string>',
'steps' => [
[
'name' => 'WAIT|CREATE_SECURITY_GROUP|LAUNCH_REPLICATION_SERVER|BOOT_REPLICATION_SERVER|AUTHENTICATE_WITH_SERVICE|DOWNLOAD_REPLICATION_SOFTWARE|CREATE_STAGING_DISKS|ATTACH_STAGING_DISKS|PAIR_REPLICATION_SERVER_WITH_AGENT|CONNECT_AGENT_TO_REPLICATION_SERVER|START_DATA_TRANSFER',
'status' => 'NOT_STARTED|IN_PROGRESS|SUCCEEDED|FAILED|SKIPPED',
],
// ...
],
],
'dataReplicationState' => 'STOPPED|INITIATING|INITIAL_SYNC|BACKLOG|CREATING_SNAPSHOT|CONTINUOUS|PAUSED|RESCAN|STALLED|DISCONNECTED|PENDING_SNAPSHOT_SHIPPING|SHIPPING_SNAPSHOT',
'etaDateTime' => '<string>',
'lagDuration' => '<string>',
'lastSnapshotDateTime' => '<string>',
'replicatedDisks' => [
[
'backloggedStorageBytes' => <integer>,
'deviceName' => '<string>',
'replicatedStorageBytes' => <integer>,
'rescannedStorageBytes' => <integer>,
'totalStorageBytes' => <integer>,
],
// ...
],
],
'fqdnForActionFramework' => '<string>',
'isArchived' => true || false,
'launchedInstance' => [
'ec2InstanceID' => '<string>',
'firstBoot' => 'WAITING|SUCCEEDED|UNKNOWN|STOPPED',
'jobID' => '<string>',
],
'lifeCycle' => [
'addedToServiceDateTime' => '<string>',
'elapsedReplicationDuration' => '<string>',
'firstByteDateTime' => '<string>',
'lastCutover' => [
'finalized' => [
'apiCallDateTime' => '<string>',
],
'initiated' => [
'apiCallDateTime' => '<string>',
'jobID' => '<string>',
],
'reverted' => [
'apiCallDateTime' => '<string>',
],
],
'lastSeenByServiceDateTime' => '<string>',
'lastTest' => [
'finalized' => [
'apiCallDateTime' => '<string>',
],
'initiated' => [
'apiCallDateTime' => '<string>',
'jobID' => '<string>',
],
'reverted' => [
'apiCallDateTime' => '<string>',
],
],
'state' => 'STOPPED|NOT_READY|READY_FOR_TEST|TESTING|READY_FOR_CUTOVER|CUTTING_OVER|CUTOVER|DISCONNECTED|DISCOVERED|PENDING_INSTALLATION',
],
'replicationType' => 'AGENT_BASED|SNAPSHOT_SHIPPING',
'sourceProperties' => [
'cpus' => [
[
'cores' => <integer>,
'modelName' => '<string>',
],
// ...
],
'disks' => [
[
'bytes' => <integer>,
'deviceName' => '<string>',
],
// ...
],
'identificationHints' => [
'awsInstanceID' => '<string>',
'fqdn' => '<string>',
'hostname' => '<string>',
'vmPath' => '<string>',
'vmWareUuid' => '<string>',
],
'lastUpdatedDateTime' => '<string>',
'networkInterfaces' => [
[
'ips' => ['<string>', ...],
'isPrimary' => true || false,
'macAddress' => '<string>',
],
// ...
],
'os' => [
'fullString' => '<string>',
],
'ramBytes' => <integer>,
'recommendedInstanceType' => '<string>',
],
'sourceServerID' => '<string>',
'tags' => ['<string>', ...],
'userProvidedID' => '<string>',
'vcenterClientID' => '<string>',
]
Result Details
Members
- applicationID
-
- Type: string
Source server application ID.
- arn
-
- Type: string
Source server ARN.
- dataReplicationInfo
-
- Type: DataReplicationInfo structure
Source server data replication info.
- fqdnForActionFramework
-
- Type: string
Source server fqdn for action framework.
- isArchived
-
- Type: boolean
Source server archived status.
- launchedInstance
-
- Type: LaunchedInstance structure
Source server launched instance.
- lifeCycle
-
- Type: LifeCycle structure
Source server lifecycle state.
- replicationType
-
- Type: string
Source server replication type.
- sourceProperties
-
- Type: SourceProperties structure
Source server properties.
- sourceServerID
-
- Type: string
Source server ID.
- tags
-
- Type: Associative array of custom strings keys (TagKey) to strings
Source server Tags.
- userProvidedID
-
- Type: string
Source server user provided ID.
- vcenterClientID
-
- Type: string
Source server vCenter client id.
Errors
-
UninitializedAccountException:
Uninitialized account exception.
-
Resource not found exception.
-
Validate exception.
-
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([
'description' => '<string>',
'name' => '<string>', // REQUIRED
'tags' => ['<string>', ...],
]);
Parameter Details
Members
- description
-
- Type: string
Application description.
- name
-
- Required: Yes
- Type: string
Application name.
- tags
-
- Type: Associative array of custom strings keys (TagKey) to strings
Application tags.
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
Members
- applicationAggregatedStatus
-
- Type: ApplicationAggregatedStatus structure
Application aggregated status.
- applicationID
-
- Type: string
Application ID.
- arn
-
- Type: string
Application ARN.
- creationDateTime
-
- Type: string
Application creation dateTime.
- description
-
- Type: string
Application description.
- isArchived
-
- Type: boolean
Application archival status.
- lastModifiedDateTime
-
- Type: string
Application last modified dateTime.
- name
-
- Type: string
Application name.
- tags
-
- Type: Associative array of custom strings keys (TagKey) to strings
Application tags.
- waveID
-
- Type: string
Application wave ID.
Errors
-
UninitializedAccountException:
Uninitialized account exception.
-
ServiceQuotaExceededException:
The request could not be completed because its exceeded the service quota.
-
The request could not be completed due to a conflict with the current state of the target resource.
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',
'copyPrivateIp' => true || false,
'copyTags' => true || false,
'enableMapAutoTagging' => true || false,
'largeVolumeConf' => [
'iops' => <integer>,
'throughput' => <integer>,
'volumeType' => 'io1|io2|gp3|gp2|st1|sc1|standard',
],
'launchDisposition' => 'STOPPED|STARTED',
'licensing' => [
'osByol' => true || false,
],
'mapAutoTaggingMpeID' => '<string>',
'postLaunchActions' => [
'cloudWatchLogGroupName' => '<string>',
'deployment' => 'TEST_AND_CUTOVER|CUTOVER_ONLY|TEST_ONLY',
's3LogBucket' => '<string>',
's3OutputKeyPrefix' => '<string>',
'ssmDocuments' => [
[
'actionName' => '<string>', // REQUIRED
'externalParameters' => [
'<SsmDocumentParameterName>' => [
'dynamicPath' => '<string>',
],
// ...
],
'mustSucceedForCutover' => true || false,
'parameters' => [
'<SsmDocumentParameterName>' => [
[
'parameterName' => '<string>', // REQUIRED
'parameterType' => 'STRING', // REQUIRED
],
// ...
],
// ...
],
'ssmDocumentName' => '<string>', // REQUIRED
'timeoutSeconds' => <integer>,
],
// ...
],
],
'smallVolumeConf' => [
'iops' => <integer>,
'throughput' => <integer>,
'volumeType' => 'io1|io2|gp3|gp2|st1|sc1|standard',
],
'smallVolumeMaxSize' => <integer>,
'tags' => ['<string>', ...],
'targetInstanceTypeRightSizingMethod' => 'NONE|BASIC',
]);
Parameter Details
Members
- associatePublicIpAddress
-
- Type: boolean
Associate public Ip address.
- bootMode
-
- Type: string
Launch configuration template boot mode.
- copyPrivateIp
-
- Type: boolean
Copy private Ip.
- copyTags
-
- Type: boolean
Copy tags.
- enableMapAutoTagging
-
- Type: boolean
Enable map auto tagging.
- largeVolumeConf
-
- Type: LaunchTemplateDiskConf structure
Large volume config.
- launchDisposition
-
- Type: string
Launch disposition.
- licensing
-
- Type: Licensing structure
Configure Licensing.
- mapAutoTaggingMpeID
-
- Type: string
Launch configuration template map auto tagging MPE ID.
- postLaunchActions
-
- Type: PostLaunchActions structure
Launch configuration template post launch actions.
- smallVolumeConf
-
- Type: LaunchTemplateDiskConf structure
Small volume config.
- smallVolumeMaxSize
-
- Type: long (int|float)
Small volume maximum size.
- tags
-
- Type: Associative array of custom strings keys (TagKey) to strings
Request to associate tags during creation of a Launch Configuration Template.
- targetInstanceTypeRightSizingMethod
-
- Type: string
Target instance type right-sizing method.
Result Syntax
[
'arn' => '<string>',
'associatePublicIpAddress' => true || false,
'bootMode' => 'LEGACY_BIOS|UEFI',
'copyPrivateIp' => true || false,
'copyTags' => true || false,
'ec2LaunchTemplateID' => '<string>',
'enableMapAutoTagging' => true || false,
'largeVolumeConf' => [
'iops' => <integer>,
'throughput' => <integer>,
'volumeType' => 'io1|io2|gp3|gp2|st1|sc1|standard',
],
'launchConfigurationTemplateID' => '<string>',
'launchDisposition' => 'STOPPED|STARTED',
'licensing' => [
'osByol' => true || false,
],
'mapAutoTaggingMpeID' => '<string>',
'postLaunchActions' => [
'cloudWatchLogGroupName' => '<string>',
'deployment' => 'TEST_AND_CUTOVER|CUTOVER_ONLY|TEST_ONLY',
's3LogBucket' => '<string>',
's3OutputKeyPrefix' => '<string>',
'ssmDocuments' => [
[
'actionName' => '<string>',
'externalParameters' => [
'<SsmDocumentParameterName>' => [
'dynamicPath' => '<string>',
],
// ...
],
'mustSucceedForCutover' => true || false,
'parameters' => [
'<SsmDocumentParameterName>' => [
[
'parameterName' => '<string>',
'parameterType' => 'STRING',
],
// ...
],
// ...
],
'ssmDocumentName' => '<string>',
'timeoutSeconds' => <integer>,
],
// ...
],
],
'smallVolumeConf' => [
'iops' => <integer>,
'throughput' => <integer>,
'volumeType' => 'io1|io2|gp3|gp2|st1|sc1|standard',
],
'smallVolumeMaxSize' => <integer>,
'tags' => ['<string>', ...],
'targetInstanceTypeRightSizingMethod' => 'NONE|BASIC',
]
Result Details
Members
- arn
-
- Type: string
ARN of the Launch Configuration Template.
- associatePublicIpAddress
-
- Type: boolean
Associate public Ip address.
- bootMode
-
- Type: string
Launch configuration template boot mode.
- copyPrivateIp
-
- Type: boolean
Copy private Ip.
- copyTags
-
- Type: boolean
Copy tags.
- ec2LaunchTemplateID
-
- Type: string
EC2 launch template ID.
- enableMapAutoTagging
-
- Type: boolean
Enable map auto tagging.
- largeVolumeConf
-
- Type: LaunchTemplateDiskConf structure
Large volume config.
- launchConfigurationTemplateID
-
- Required: Yes
- Type: string
ID of the Launch Configuration Template.
- launchDisposition
-
- Type: string
Launch disposition.
- licensing
-
- Type: Licensing structure
Configure Licensing.
- mapAutoTaggingMpeID
-
- Type: string
Launch configuration template map auto tagging MPE ID.
- postLaunchActions
-
- Type: PostLaunchActions structure
Post Launch Actions of the Launch Configuration Template.
- smallVolumeConf
-
- Type: LaunchTemplateDiskConf structure
Small volume config.
- smallVolumeMaxSize
-
- Type: long (int|float)
Small volume maximum size.
- tags
-
- Type: Associative array of custom strings keys (TagKey) to strings
Tags of the Launch Configuration Template.
- targetInstanceTypeRightSizingMethod
-
- Type: string
Target instance type right-sizing method.
Errors
-
UninitializedAccountException:
Uninitialized account exception.
-
Validate exception.
-
Operating denied due to a file permission or access check error.
CreateReplicationConfigurationTemplate
$result = $client->createReplicationConfigurationTemplate([/* ... */]); $promise = $client->createReplicationConfigurationTemplateAsync([/* ... */]);
Creates a new ReplicationConfigurationTemplate.
Parameter Syntax
$result = $client->createReplicationConfigurationTemplate([
'associateDefaultSecurityGroup' => true || false, // REQUIRED
'bandwidthThrottling' => <integer>, // REQUIRED
'createPublicIP' => true || false, // REQUIRED
'dataPlaneRouting' => 'PRIVATE_IP|PUBLIC_IP', // REQUIRED
'defaultLargeStagingDiskType' => 'GP2|ST1|GP3', // REQUIRED
'ebsEncryption' => 'DEFAULT|CUSTOM', // REQUIRED
'ebsEncryptionKeyArn' => '<string>',
'replicationServerInstanceType' => '<string>', // REQUIRED
'replicationServersSecurityGroupsIDs' => ['<string>', ...], // REQUIRED
'stagingAreaSubnetId' => '<string>', // REQUIRED
'stagingAreaTags' => ['<string>', ...], // REQUIRED
'tags' => ['<string>', ...],
'useDedicatedReplicationServer' => true || false, // REQUIRED
]);
Parameter Details
Members
- associateDefaultSecurityGroup
-
- Required: Yes
- Type: boolean
Request to associate the default Application Migration Service Security group with the Replication Settings template.
- bandwidthThrottling
-
- Required: Yes
- Type: long (int|float)
Request to configure bandwidth throttling during Replication Settings template creation.
- createPublicIP
-
- Required: Yes
- Type: boolean
Request to create Public IP during Replication Settings template creation.
- dataPlaneRouting
-
- Required: Yes
- Type: string
Request to configure data plane routing during Replication Settings template creation.
- defaultLargeStagingDiskType
-
- Required: Yes
- Type: string
Request to configure the default large staging disk EBS volume type during Replication Settings template creation.
- ebsEncryption
-
- Required: Yes
- Type: string
Request to configure EBS encryption during Replication Settings template creation.
- ebsEncryptionKeyArn
-
- Type: string
Request to configure an EBS encryption key during Replication Settings template creation.
- replicationServerInstanceType
-
- Required: Yes
- Type: string
Request to configure the Replication Server instance type during Replication Settings template creation.
- replicationServersSecurityGroupsIDs
-
- Required: Yes
- Type: Array of strings
Request to configure the Replication Server Security group ID during Replication Settings template creation.
- stagingAreaSubnetId
-
- Required: Yes
- Type: string
Request to configure the Staging Area subnet ID during Replication Settings template creation.
- stagingAreaTags
-
- Required: Yes
- Type: Associative array of custom strings keys (TagKey) to strings
Request to configure Staging Area tags during Replication Settings template creation.
- tags
-
- Type: Associative array of custom strings keys (TagKey) to strings
Request to configure tags during Replication Settings template creation.
- useDedicatedReplicationServer
-
- Required: Yes
- Type: boolean
Request to use Dedicated Replication Servers during Replication Settings template creation.
Result Syntax
[
'arn' => '<string>',
'associateDefaultSecurityGroup' => true || false,
'bandwidthThrottling' => <integer>,
'createPublicIP' => true || false,
'dataPlaneRouting' => 'PRIVATE_IP|PUBLIC_IP',
'defaultLargeStagingDiskType' => 'GP2|ST1|GP3',
'ebsEncryption' => 'DEFAULT|CUSTOM',
'ebsEncryptionKeyArn' => '<string>',
'replicationConfigurationTemplateID' => '<string>',
'replicationServerInstanceType' => '<string>',
'replicationServersSecurityGroupsIDs' => ['<string>', ...],
'stagingAreaSubnetId' => '<string>',
'stagingAreaTags' => ['<string>', ...],
'tags' => ['<string>', ...],
'useDedicatedReplicationServer' => true || false,
]
Result Details
Members
- arn
-
- Type: string
Replication Configuration template ARN.
- associateDefaultSecurityGroup
-
- Type: boolean
Replication Configuration template associate default Application Migration Service Security group.
- bandwidthThrottling
-
- Type: long (int|float)
Replication Configuration template bandwidth throttling.
- createPublicIP
-
- Type: boolean
Replication Configuration template create Public IP.
- dataPlaneRouting
-
- Type: string
Replication Configuration template data plane routing.
- defaultLargeStagingDiskType
-
- Type: string
Replication Configuration template use default large Staging Disk type.
- ebsEncryption
-
- Type: string
Replication Configuration template EBS encryption.
- ebsEncryptionKeyArn
-
- Type: string
Replication Configuration template EBS encryption key ARN.
- replicationConfigurationTemplateID
-
- Required: Yes
- Type: string
Replication Configuration template ID.
- replicationServerInstanceType
-
- Type: string
Replication Configuration template server instance type.
- replicationServersSecurityGroupsIDs
-
- Type: Array of strings
Replication Configuration template server Security Groups IDs.
- stagingAreaSubnetId
-
- Type: string
Replication Configuration template Staging Area subnet ID.
- stagingAreaTags
-
- Type: Associative array of custom strings keys (TagKey) to strings
Replication Configuration template Staging Area Tags.
- tags
-
- Type: Associative array of custom strings keys (TagKey) to strings
Replication Configuration template Tags.
- useDedicatedReplicationServer
-
- Type: boolean
Replication Configuration template use Dedicated Replication Server.
Errors
-
UninitializedAccountException:
Uninitialized account exception.
-
Validate exception.
-
Operating denied due to a file permission or access check error.
CreateWave
$result = $client->createWave([/* ... */]); $promise = $client->createWaveAsync([/* ... */]);
Create wave.
Parameter Syntax
$result = $client->createWave([
'description' => '<string>',
'name' => '<string>', // REQUIRED
'tags' => ['<string>', ...],
]);
Parameter Details
Members
- description
-
- Type: string
Wave description.
- name
-
- Required: Yes
- Type: string
Wave name.
- tags
-
- Type: Associative array of custom strings keys (TagKey) to strings
Wave tags.
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
Members
- arn
-
- Type: string
Wave ARN.
- creationDateTime
-
- Type: string
Wave creation dateTime.
- description
-
- Type: string
Wave description.
- isArchived
-
- Type: boolean
Wave archival status.
- lastModifiedDateTime
-
- Type: string
Wave last modified dateTime.
- name
-
- Type: string
Wave name.
- tags
-
- Type: Associative array of custom strings keys (TagKey) to strings
Wave tags.
- waveAggregatedStatus
-
- Type: WaveAggregatedStatus structure
Wave aggregated status.
- waveID
-
- Type: string
Wave ID.
Errors
-
UninitializedAccountException:
Uninitialized account exception.
-
ServiceQuotaExceededException:
The request could not be completed because its exceeded the service quota.
-
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([
'applicationID' => '<string>', // REQUIRED
]);
Parameter Details
Members
- applicationID
-
- Required: Yes
- Type: string
Application ID.
Result Syntax
[]
Result Details
Errors
-
UninitializedAccountException:
Uninitialized account exception.
-
Resource not found exception.
-
The request could not be completed due to a conflict with the current state of the target resource.
DeleteJob
$result = $client->deleteJob([/* ... */]); $promise = $client->deleteJobAsync([/* ... */]);
Deletes a single Job by ID.
Parameter Syntax
$result = $client->deleteJob([
'jobID' => '<string>', // REQUIRED
]);
Parameter Details
Members
- jobID
-
- Required: Yes
- Type: string
Request to delete Job from service by Job ID.
Result Syntax
[]
Result Details
Errors
-
UninitializedAccountException:
Uninitialized account exception.
-
Resource not found exception.
-
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
Members
- launchConfigurationTemplateID
-
- Required: Yes
- Type: string
ID of resource to be deleted.
Result Syntax
[]
Result Details
Errors
-
UninitializedAccountException:
Uninitialized account exception.
-
Resource not found exception.
-
The request could not be completed due to a conflict with the current state of the target resource.
DeleteReplicationConfigurationTemplate
$result = $client->deleteReplicationConfigurationTemplate([/* ... */]); $promise = $client->deleteReplicationConfigurationTemplateAsync([/* ... */]);
Deletes a single Replication Configuration Template by ID
Parameter Syntax
$result = $client->deleteReplicationConfigurationTemplate([
'replicationConfigurationTemplateID' => '<string>', // REQUIRED
]);
Parameter Details
Members
- replicationConfigurationTemplateID
-
- Required: Yes
- Type: string
Request to delete Replication Configuration Template from service by Replication Configuration Template ID.
Result Syntax
[]
Result Details
Errors
-
UninitializedAccountException:
Uninitialized account exception.
-
Resource not found exception.
-
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([
'sourceServerID' => '<string>', // REQUIRED
]);
Parameter Details
Members
- sourceServerID
-
- Required: Yes
- Type: string
Request to delete Source Server from service by Server ID.
Result Syntax
[]
Result Details
Errors
-
UninitializedAccountException:
Uninitialized account exception.
-
Resource not found exception.
-
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
Members
- vcenterClientID
-
- Required: Yes
- Type: string
ID of resource to be deleted.
Result Syntax
[]
Result Details
Errors
-
UninitializedAccountException:
Uninitialized account exception.
-
Resource not found exception.
-
Validate exception.
DeleteWave
$result = $client->deleteWave([/* ... */]); $promise = $client->deleteWaveAsync([/* ... */]);
Delete wave.
Parameter Syntax
$result = $client->deleteWave([
'waveID' => '<string>', // REQUIRED
]);
Parameter Details
Members
- waveID
-
- Required: Yes
- Type: string
Wave ID.
Result Syntax
[]
Result Details
Errors
-
UninitializedAccountException:
Uninitialized account exception.
-
Resource not found exception.
-
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([
'jobID' => '<string>', // REQUIRED
'maxResults' => <integer>,
'nextToken' => '<string>',
]);
Parameter Details
Members
- jobID
-
- Required: Yes
- Type: string
Request to describe Job log job ID.
- maxResults
-
- Type: int
Request to describe Job log item maximum results.
- nextToken
-
- Type: string
Request to describe Job log next token.
Result Syntax
[
'items' => [
[
'event' => 'JOB_START|SERVER_SKIPPED|CLEANUP_START|CLEANUP_END|CLEANUP_FAIL|SNAPSHOT_START|SNAPSHOT_END|SNAPSHOT_FAIL|USING_PREVIOUS_SNAPSHOT|CONVERSION_START|CONVERSION_END|CONVERSION_FAIL|LAUNCH_START|LAUNCH_FAILED|JOB_CANCEL|JOB_END',
'eventData' => [
'conversionServerID' => '<string>',
'rawError' => '<string>',
'sourceServerID' => '<string>',
'targetInstanceID' => '<string>',
],
'logDateTime' => '<string>',
],
// ...
],
'nextToken' => '<string>',
]
Result Details
Members
- items
-
- Type: Array of JobLog structures
Request to describe Job log response items.
- nextToken
-
- Type: string
Request to describe Job log response next token.
Errors
-
UninitializedAccountException:
Uninitialized account exception.
-
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([
'filters' => [
'fromDate' => '<string>',
'jobIDs' => ['<string>', ...],
'toDate' => '<string>',
],
'maxResults' => <integer>,
'nextToken' => '<string>',
]);
Parameter Details
Members
- filters
-
- Type: DescribeJobsRequestFilters structure
Request to describe Job log filters.
- maxResults
-
- Type: int
Request to describe job log items by max results.
- nextToken
-
- Type: string
Request to describe job log items by next token.
Result Syntax
[
'items' => [
[
'arn' => '<string>',
'creationDateTime' => '<string>',
'endDateTime' => '<string>',
'initiatedBy' => 'START_TEST|START_CUTOVER|DIAGNOSTIC|TERMINATE',
'jobID' => '<string>',
'participatingServers' => [
[
'launchStatus' => 'PENDING|IN_PROGRESS|LAUNCHED|FAILED|TERMINATED',
'launchedEc2InstanceID' => '<string>',
'postLaunchActionsStatus' => [
'postLaunchActionsLaunchStatusList' => [
[
'executionID' => '<string>',
'executionStatus' => 'IN_PROGRESS|SUCCESS|FAILED',
'failureReason' => '<string>',
'ssmDocument' => [
'actionName' => '<string>',
'externalParameters' => [
'<SsmDocumentParameterName>' => [
'dynamicPath' => '<string>',
],
// ...
],
'mustSucceedForCutover' => true || false,
'parameters' => [
'<SsmDocumentParameterName>' => [
[
'parameterName' => '<string>',
'parameterType' => 'STRING',
],
// ...
],
// ...
],
'ssmDocumentName' => '<string>',
'timeoutSeconds' => <integer>,
],
'ssmDocumentType' => 'AUTOMATION|COMMAND',
],
// ...
],
'ssmAgentDiscoveryDatetime' => '<string>',
],
'sourceServerID' => '<string>',
],
// ...
],
'status' => 'PENDING|STARTED|COMPLETED',
'tags' => ['<string>', ...],
'type' => 'LAUNCH|TERMINATE',
],
// ...
],
'nextToken' => '<string>',
]
Result Details
Members
- items
-
- Type: Array of Job structures
Request to describe Job log items.
- nextToken
-
- Type: string
Request to describe Job response by next token.
Errors
-
UninitializedAccountException:
Uninitialized account exception.
-
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
Members
- launchConfigurationTemplateIDs
-
- Type: Array of strings
Request to filter Launch Configuration Templates list by Launch Configuration Template ID.
- maxResults
-
- Type: int
Maximum results to be returned in DescribeLaunchConfigurationTemplates.
- nextToken
-
- Type: string
Next pagination token returned from DescribeLaunchConfigurationTemplates.
Result Syntax
[
'items' => [
[
'arn' => '<string>',
'associatePublicIpAddress' => true || false,
'bootMode' => 'LEGACY_BIOS|UEFI',
'copyPrivateIp' => true || false,
'copyTags' => true || false,
'ec2LaunchTemplateID' => '<string>',
'enableMapAutoTagging' => true || false,
'largeVolumeConf' => [
'iops' => <integer>,
'throughput' => <integer>,
'volumeType' => 'io1|io2|gp3|gp2|st1|sc1|standard',
],
'launchConfigurationTemplateID' => '<string>',
'launchDisposition' => 'STOPPED|STARTED',
'licensing' => [
'osByol' => true || false,
],
'mapAutoTaggingMpeID' => '<string>',
'postLaunchActions' => [
'cloudWatchLogGroupName' => '<string>',
'deployment' => 'TEST_AND_CUTOVER|CUTOVER_ONLY|TEST_ONLY',
's3LogBucket' => '<string>',
's3OutputKeyPrefix' => '<string>',
'ssmDocuments' => [
[
'actionName' => '<string>',
'externalParameters' => [
'<SsmDocumentParameterName>' => [
'dynamicPath' => '<string>',
],
// ...
],
'mustSucceedForCutover' => true || false,
'parameters' => [
'<SsmDocumentParameterName>' => [
[
'parameterName' => '<string>',
'parameterType' => 'STRING',
],
// ...
],
// ...
],
'ssmDocumentName' => '<string>',
'timeoutSeconds' => <integer>,
],
// ...
],
],
'smallVolumeConf' => [
'iops' => <integer>,
'throughput' => <integer>,
'volumeType' => 'io1|io2|gp3|gp2|st1|sc1|standard',
],
'smallVolumeMaxSize' => <integer>,
'tags' => ['<string>', ...],
'targetInstanceTypeRightSizingMethod' => 'NONE|BASIC',
],
// ...
],
'nextToken' => '<string>',
]
Result Details
Members
- items
-
- Type: Array of LaunchConfigurationTemplate structures
List of items returned by DescribeLaunchConfigurationTemplates.
- nextToken
-
- Type: string
Next pagination token returned from DescribeLaunchConfigurationTemplates.
Errors
-
UninitializedAccountException:
Uninitialized account exception.
-
Resource not found exception.
-
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
Members
- maxResults
-
- Type: int
Request to describe Replication Configuration template by max results.
- nextToken
-
- Type: string
Request to describe Replication Configuration template by next token.
- replicationConfigurationTemplateIDs
-
- Type: Array of strings
Request to describe Replication Configuration template by template IDs.
Result Syntax
[
'items' => [
[
'arn' => '<string>',
'associateDefaultSecurityGroup' => true || false,
'bandwidthThrottling' => <integer>,
'createPublicIP' => true || false,
'dataPlaneRouting' => 'PRIVATE_IP|PUBLIC_IP',
'defaultLargeStagingDiskType' => 'GP2|ST1|GP3',
'ebsEncryption' => 'DEFAULT|CUSTOM',
'ebsEncryptionKeyArn' => '<string>',
'replicationConfigurationTemplateID' => '<string>',
'replicationServerInstanceType' => '<string>',
'replicationServersSecurityGroupsIDs' => ['<string>', ...],
'stagingAreaSubnetId' => '<string>',
'stagingAreaTags' => ['<string>', ...],
'tags' => ['<string>', ...],
'useDedicatedReplicationServer' => true || false,
],
// ...
],
'nextToken' => '<string>',
]
Result Details
Members
- items
-
- Type: Array of ReplicationConfigurationTemplate structures
Request to describe Replication Configuration template by items.
- nextToken
-
- Type: string
Request to describe Replication Configuration template by next token.
Errors
-
UninitializedAccountException:
Uninitialized account exception.
-
Resource not found exception.
-
Validate exception.
DescribeSourceServers
$result = $client->describeSourceServers([/* ... */]); $promise = $client->describeSourceServersAsync([/* ... */]);
Retrieves all SourceServers or multiple SourceServers by ID.
Parameter Syntax
$result = $client->describeSourceServers([
'filters' => [
'applicationIDs' => ['<string>', ...],
'isArchived' => true || false,
'lifeCycleStates' => ['<string>', ...],
'replicationTypes' => ['<string>', ...],
'sourceServerIDs' => ['<string>', ...],
],
'maxResults' => <integer>,
'nextToken' => '<string>',
]);
Parameter Details
Members
- filters
-
- Type: DescribeSourceServersRequestFilters structure
Request to filter Source Servers list.
- maxResults
-
- Type: int
Request to filter Source Servers list by maximum results.
- nextToken
-
- Type: string
Request to filter Source Servers list by next token.
Result Syntax
[
'items' => [
[
'applicationID' => '<string>',
'arn' => '<string>',
'dataReplicationInfo' => [
'dataReplicationError' => [
'error' => 'AGENT_NOT_SEEN|SNAPSHOTS_FAILURE|NOT_CONVERGING|UNSTABLE_NETWORK|FAILED_TO_CREATE_SECURITY_GROUP|FAILED_TO_LAUNCH_REPLICATION_SERVER|FAILED_TO_BOOT_REPLICATION_SERVER|FAILED_TO_AUTHENTICATE_WITH_SERVICE|FAILED_TO_DOWNLOAD_REPLICATION_SOFTWARE|FAILED_TO_CREATE_STAGING_DISKS|FAILED_TO_ATTACH_STAGING_DISKS|FAILED_TO_PAIR_REPLICATION_SERVER_WITH_AGENT|FAILED_TO_CONNECT_AGENT_TO_REPLICATION_SERVER|FAILED_TO_START_DATA_TRANSFER|UNSUPPORTED_VM_CONFIGURATION|LAST_SNAPSHOT_JOB_FAILED',
'rawError' => '<string>',
],
'dataReplicationInitiation' => [
'nextAttemptDateTime' => '<string>',
'startDateTime' => '<string>',
'steps' => [
[
'name' => 'WAIT|CREATE_SECURITY_GROUP|LAUNCH_REPLICATION_SERVER|BOOT_REPLICATION_SERVER|AUTHENTICATE_WITH_SERVICE|DOWNLOAD_REPLICATION_SOFTWARE|CREATE_STAGING_DISKS|ATTACH_STAGING_DISKS|PAIR_REPLICATION_SERVER_WITH_AGENT|CONNECT_AGENT_TO_REPLICATION_SERVER|START_DATA_TRANSFER',
'status' => 'NOT_STARTED|IN_PROGRESS|SUCCEEDED|FAILED|SKIPPED',
],
// ...
],
],
'dataReplicationState' => 'STOPPED|INITIATING|INITIAL_SYNC|BACKLOG|CREATING_SNAPSHOT|CONTINUOUS|PAUSED|RESCAN|STALLED|DISCONNECTED|PENDING_SNAPSHOT_SHIPPING|SHIPPING_SNAPSHOT',
'etaDateTime' => '<string>',
'lagDuration' => '<string>',
'lastSnapshotDateTime' => '<string>',
'replicatedDisks' => [
[
'backloggedStorageBytes' => <integer>,
'deviceName' => '<string>',
'replicatedStorageBytes' => <integer>,
'rescannedStorageBytes' => <integer>,
'totalStorageBytes' => <integer>,
],
// ...
],
],
'fqdnForActionFramework' => '<string>',
'isArchived' => true || false,
'launchedInstance' => [
'ec2InstanceID' => '<string>',
'firstBoot' => 'WAITING|SUCCEEDED|UNKNOWN|STOPPED',
'jobID' => '<string>',
],
'lifeCycle' => [
'addedToServiceDateTime' => '<string>',
'elapsedReplicationDuration' => '<string>',
'firstByteDateTime' => '<string>',
'lastCutover' => [
'finalized' => [
'apiCallDateTime' => '<string>',
],
'initiated' => [
'apiCallDateTime' => '<string>',
'jobID' => '<string>',
],
'reverted' => [
'apiCallDateTime' => '<string>',
],
],
'lastSeenByServiceDateTime' => '<string>',
'lastTest' => [
'finalized' => [
'apiCallDateTime' => '<string>',
],
'initiated' => [
'apiCallDateTime' => '<string>',
'jobID' => '<string>',
],
'reverted' => [
'apiCallDateTime' => '<string>',
],
],
'state' => 'STOPPED|NOT_READY|READY_FOR_TEST|TESTING|READY_FOR_CUTOVER|CUTTING_OVER|CUTOVER|DISCONNECTED|DISCOVERED|PENDING_INSTALLATION',
],
'replicationType' => 'AGENT_BASED|SNAPSHOT_SHIPPING',
'sourceProperties' => [
'cpus' => [
[
'cores' => <integer>,
'modelName' => '<string>',
],
// ...
],
'disks' => [
[
'bytes' => <integer>,
'deviceName' => '<string>',
],
// ...
],
'identificationHints' => [
'awsInstanceID' => '<string>',
'fqdn' => '<string>',
'hostname' => '<string>',
'vmPath' => '<string>',
'vmWareUuid' => '<string>',
],
'lastUpdatedDateTime' => '<string>',
'networkInterfaces' => [
[
'ips' => ['<string>', ...],
'isPrimary' => true || false,
'macAddress' => '<string>',
],
// ...
],
'os' => [
'fullString' => '<string>',
],
'ramBytes' => <integer>,
'recommendedInstanceType' => '<string>',
],
'sourceServerID' => '<string>',
'tags' => ['<string>', ...],
'userProvidedID' => '<string>',
'vcenterClientID' => '<string>',
],
// ...
],
'nextToken' => '<string>',
]
Result Details
Members
- items
-
- Type: Array of SourceServer structures
Request to filter Source Servers list by item.
- nextToken
-
- Type: string
Request to filter Source Servers next token.
Errors
-
UninitializedAccountException:
Uninitialized account exception.
-
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
Members
- maxResults
-
- Type: int
Maximum results to be returned in DescribeVcenterClients.
- nextToken
-
- Type: string
Next pagination token to be provided for DescribeVcenterClients.
Result Syntax
[
'items' => [
[
'arn' => '<string>',
'datacenterName' => '<string>',
'hostname' => '<string>',
'lastSeenDatetime' => '<string>',
'sourceServerTags' => ['<string>', ...],
'tags' => ['<string>', ...],
'vcenterClientID' => '<string>',
'vcenterUUID' => '<string>',
],
// ...
],
'nextToken' => '<string>',
]
Result Details
Members
- items
-
- Type: Array of VcenterClient structures
List of items returned by DescribeVcenterClients.
- nextToken
-
- Type: string
Next pagination token returned from DescribeVcenterClients.
Errors
-
UninitializedAccountException:
Uninitialized account exception.
-
Resource not found exception.
-
Validate exception.
DisassociateApplications
$result = $client->disassociateApplications([/* ... */]); $promise = $client->disassociateApplicationsAsync([/* ... */]);
Disassociate applications from wave.
Parameter Syntax
$result = $client->disassociateApplications([
'applicationIDs' => ['<string>', ...], // REQUIRED
'waveID' => '<string>', // REQUIRED
]);
Parameter Details
Members
- applicationIDs
-
- Required: Yes
- Type: Array of strings
Application IDs list.
- waveID
-
- Required: Yes
- Type: string
Wave ID.
Result Syntax
[]
Result Details
Errors
-
UninitializedAccountException:
Uninitialized account exception.
-
Resource not found exception.
-
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([
'applicationID' => '<string>', // REQUIRED
'sourceServerIDs' => ['<string>', ...], // REQUIRED
]);
Parameter Details
Members
- applicationID
-
- Required: Yes
- Type: string
Application ID.
- sourceServerIDs
-
- Required: Yes
- Type: Array of strings
Source server IDs list.
Result Syntax
[]
Result Details
Errors
-
UninitializedAccountException:
Uninitialized account exception.
-
Resource not found exception.
-
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([
'sourceServerID' => '<string>', // REQUIRED
]);
Parameter Details
Members
- sourceServerID
-
- Required: Yes
- Type: string
Request to disconnect Source Server from service by Server ID.
Result Syntax
[
'applicationID' => '<string>',
'arn' => '<string>',
'dataReplicationInfo' => [
'dataReplicationError' => [
'error' => 'AGENT_NOT_SEEN|SNAPSHOTS_FAILURE|NOT_CONVERGING|UNSTABLE_NETWORK|FAILED_TO_CREATE_SECURITY_GROUP|FAILED_TO_LAUNCH_REPLICATION_SERVER|FAILED_TO_BOOT_REPLICATION_SERVER|FAILED_TO_AUTHENTICATE_WITH_SERVICE|FAILED_TO_DOWNLOAD_REPLICATION_SOFTWARE|FAILED_TO_CREATE_STAGING_DISKS|FAILED_TO_ATTACH_STAGING_DISKS|FAILED_TO_PAIR_REPLICATION_SERVER_WITH_AGENT|FAILED_TO_CONNECT_AGENT_TO_REPLICATION_SERVER|FAILED_TO_START_DATA_TRANSFER|UNSUPPORTED_VM_CONFIGURATION|LAST_SNAPSHOT_JOB_FAILED',
'rawError' => '<string>',
],
'dataReplicationInitiation' => [
'nextAttemptDateTime' => '<string>',
'startDateTime' => '<string>',
'steps' => [
[
'name' => 'WAIT|CREATE_SECURITY_GROUP|LAUNCH_REPLICATION_SERVER|BOOT_REPLICATION_SERVER|AUTHENTICATE_WITH_SERVICE|DOWNLOAD_REPLICATION_SOFTWARE|CREATE_STAGING_DISKS|ATTACH_STAGING_DISKS|PAIR_REPLICATION_SERVER_WITH_AGENT|CONNECT_AGENT_TO_REPLICATION_SERVER|START_DATA_TRANSFER',
'status' => 'NOT_STARTED|IN_PROGRESS|SUCCEEDED|FAILED|SKIPPED',
],
// ...
],
],
'dataReplicationState' => 'STOPPED|INITIATING|INITIAL_SYNC|BACKLOG|CREATING_SNAPSHOT|CONTINUOUS|PAUSED|RESCAN|STALLED|DISCONNECTED|PENDING_SNAPSHOT_SHIPPING|SHIPPING_SNAPSHOT',
'etaDateTime' => '<string>',
'lagDuration' => '<string>',
'lastSnapshotDateTime' => '<string>',
'replicatedDisks' => [
[
'backloggedStorageBytes' => <integer>,
'deviceName' => '<string>',
'replicatedStorageBytes' => <integer>,
'rescannedStorageBytes' => <integer>,
'totalStorageBytes' => <integer>,
],
// ...
],
],
'fqdnForActionFramework' => '<string>',
'isArchived' => true || false,
'launchedInstance' => [
'ec2InstanceID' => '<string>',
'firstBoot' => 'WAITING|SUCCEEDED|UNKNOWN|STOPPED',
'jobID' => '<string>',
],
'lifeCycle' => [
'addedToServiceDateTime' => '<string>',
'elapsedReplicationDuration' => '<string>',
'firstByteDateTime' => '<string>',
'lastCutover' => [
'finalized' => [
'apiCallDateTime' => '<string>',
],
'initiated' => [
'apiCallDateTime' => '<string>',
'jobID' => '<string>',
],
'reverted' => [
'apiCallDateTime' => '<string>',
],
],
'lastSeenByServiceDateTime' => '<string>',
'lastTest' => [
'finalized' => [
'apiCallDateTime' => '<string>',
],
'initiated' => [
'apiCallDateTime' => '<string>',
'jobID' => '<string>',
],
'reverted' => [
'apiCallDateTime' => '<string>',
],
],
'state' => 'STOPPED|NOT_READY|READY_FOR_TEST|TESTING|READY_FOR_CUTOVER|CUTTING_OVER|CUTOVER|DISCONNECTED|DISCOVERED|PENDING_INSTALLATION',
],
'replicationType' => 'AGENT_BASED|SNAPSHOT_SHIPPING',
'sourceProperties' => [
'cpus' => [
[
'cores' => <integer>,
'modelName' => '<string>',
],
// ...
],
'disks' => [
[
'bytes' => <integer>,
'deviceName' => '<string>',
],
// ...
],
'identificationHints' => [
'awsInstanceID' => '<string>',
'fqdn' => '<string>',
'hostname' => '<string>',
'vmPath' => '<string>',
'vmWareUuid' => '<string>',
],
'lastUpdatedDateTime' => '<string>',
'networkInterfaces' => [
[
'ips' => ['<string>', ...],
'isPrimary' => true || false,
'macAddress' => '<string>',
],
// ...
],
'os' => [
'fullString' => '<string>',
],
'ramBytes' => <integer>,
'recommendedInstanceType' => '<string>',
],
'sourceServerID' => '<string>',
'tags' => ['<string>', ...],
'userProvidedID' => '<string>',
'vcenterClientID' => '<string>',
]
Result Details
Members
- applicationID
-
- Type: string
Source server application ID.
- arn
-
- Type: string
Source server ARN.
- dataReplicationInfo
-
- Type: DataReplicationInfo structure
Source server data replication info.
- fqdnForActionFramework
-
- Type: string
Source server fqdn for action framework.
- isArchived
-
- Type: boolean
Source server archived status.
- launchedInstance
-
- Type: LaunchedInstance structure
Source server launched instance.
- lifeCycle
-
- Type: LifeCycle structure
Source server lifecycle state.
- replicationType
-
- Type: string
Source server replication type.
- sourceProperties
-
- Type: SourceProperties structure
Source server properties.
- sourceServerID
-
- Type: string
Source server ID.
- tags
-
- Type: Associative array of custom strings keys (TagKey) to strings
Source server Tags.
- userProvidedID
-
- Type: string
Source server user provided ID.
- vcenterClientID
-
- Type: string
Source server vCenter client id.
Errors
-
UninitializedAccountException:
Uninitialized account exception.
-
Resource not found exception.
-
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([
'sourceServerID' => '<string>', // REQUIRED
]);
Parameter Details
Members
- sourceServerID
-
- Required: Yes
- Type: string
Request to finalize Cutover by Source Server ID.
Result Syntax
[
'applicationID' => '<string>',
'arn' => '<string>',
'dataReplicationInfo' => [
'dataReplicationError' => [
'error' => 'AGENT_NOT_SEEN|SNAPSHOTS_FAILURE|NOT_CONVERGING|UNSTABLE_NETWORK|FAILED_TO_CREATE_SECURITY_GROUP|FAILED_TO_LAUNCH_REPLICATION_SERVER|FAILED_TO_BOOT_REPLICATION_SERVER|FAILED_TO_AUTHENTICATE_WITH_SERVICE|FAILED_TO_DOWNLOAD_REPLICATION_SOFTWARE|FAILED_TO_CREATE_STAGING_DISKS|FAILED_TO_ATTACH_STAGING_DISKS|FAILED_TO_PAIR_REPLICATION_SERVER_WITH_AGENT|FAILED_TO_CONNECT_AGENT_TO_REPLICATION_SERVER|FAILED_TO_START_DATA_TRANSFER|UNSUPPORTED_VM_CONFIGURATION|LAST_SNAPSHOT_JOB_FAILED',
'rawError' => '<string>',
],
'dataReplicationInitiation' => [
'nextAttemptDateTime' => '<string>',
'startDateTime' => '<string>',
'steps' => [
[
'name' => 'WAIT|CREATE_SECURITY_GROUP|LAUNCH_REPLICATION_SERVER|BOOT_REPLICATION_SERVER|AUTHENTICATE_WITH_SERVICE|DOWNLOAD_REPLICATION_SOFTWARE|CREATE_STAGING_DISKS|ATTACH_STAGING_DISKS|PAIR_REPLICATION_SERVER_WITH_AGENT|CONNECT_AGENT_TO_REPLICATION_SERVER|START_DATA_TRANSFER',
'status' => 'NOT_STARTED|IN_PROGRESS|SUCCEEDED|FAILED|SKIPPED',
],
// ...
],
],
'dataReplicationState' => 'STOPPED|INITIATING|INITIAL_SYNC|BACKLOG|CREATING_SNAPSHOT|CONTINUOUS|PAUSED|RESCAN|STALLED|DISCONNECTED|PENDING_SNAPSHOT_SHIPPING|SHIPPING_SNAPSHOT',
'etaDateTime' => '<string>',
'lagDuration' => '<string>',
'lastSnapshotDateTime' => '<string>',
'replicatedDisks' => [
[
'backloggedStorageBytes' => <integer>,
'deviceName' => '<string>',
'replicatedStorageBytes' => <integer>,
'rescannedStorageBytes' => <integer>,
'totalStorageBytes' => <integer>,
],
// ...
],
],
'fqdnForActionFramework' => '<string>',
'isArchived' => true || false,
'launchedInstance' => [
'ec2InstanceID' => '<string>',
'firstBoot' => 'WAITING|SUCCEEDED|UNKNOWN|STOPPED',
'jobID' => '<string>',
],
'lifeCycle' => [
'addedToServiceDateTime' => '<string>',
'elapsedReplicationDuration' => '<string>',
'firstByteDateTime' => '<string>',
'lastCutover' => [
'finalized' => [
'apiCallDateTime' => '<string>',
],
'initiated' => [
'apiCallDateTime' => '<string>',
'jobID' => '<string>',
],
'reverted' => [
'apiCallDateTime' => '<string>',
],
],
'lastSeenByServiceDateTime' => '<string>',
'lastTest' => [
'finalized' => [
'apiCallDateTime' => '<string>',
],
'initiated' => [
'apiCallDateTime' => '<string>',
'jobID' => '<string>',
],
'reverted' => [
'apiCallDateTime' => '<string>',
],
],
'state' => 'STOPPED|NOT_READY|READY_FOR_TEST|TESTING|READY_FOR_CUTOVER|CUTTING_OVER|CUTOVER|DISCONNECTED|DISCOVERED|PENDING_INSTALLATION',
],
'replicationType' => 'AGENT_BASED|SNAPSHOT_SHIPPING',
'sourceProperties' => [
'cpus' => [
[
'cores' => <integer>,
'modelName' => '<string>',
],
// ...
],
'disks' => [
[
'bytes' => <integer>,
'deviceName' => '<string>',
],
// ...
],
'identificationHints' => [
'awsInstanceID' => '<string>',
'fqdn' => '<string>',
'hostname' => '<string>',
'vmPath' => '<string>',
'vmWareUuid' => '<string>',
],
'lastUpdatedDateTime' => '<string>',
'networkInterfaces' => [
[
'ips' => ['<string>', ...],
'isPrimary' => true || false,
'macAddress' => '<string>',
],
// ...
],
'os' => [
'fullString' => '<string>',
],
'ramBytes' => <integer>,
'recommendedInstanceType' => '<string>',
],
'sourceServerID' => '<string>',
'tags' => ['<string>', ...],
'userProvidedID' => '<string>',
'vcenterClientID' => '<string>',
]
Result Details
Members
- applicationID
-
- Type: string
Source server application ID.
- arn
-
- Type: string
Source server ARN.
- dataReplicationInfo
-
- Type: DataReplicationInfo structure
Source server data replication info.
- fqdnForActionFramework
-
- Type: string
Source server fqdn for action framework.
- isArchived
-
- Type: boolean
Source server archived status.
- launchedInstance
-
- Type: LaunchedInstance structure
Source server launched instance.
- lifeCycle
-
- Type: LifeCycle structure
Source server lifecycle state.
- replicationType
-
- Type: string
Source server replication type.
- sourceProperties
-
- Type: SourceProperties structure
Source server properties.
- sourceServerID
-
- Type: string
Source server ID.
- tags
-
- Type: Associative array of custom strings keys (TagKey) to strings
Source server Tags.
- userProvidedID
-
- Type: string
Source server user provided ID.
- vcenterClientID
-
- Type: string
Source server vCenter client id.
Errors
-
UninitializedAccountException:
Uninitialized account exception.
-
Resource not found exception.
-
Validate exception.
-
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([
'sourceServerID' => '<string>', // REQUIRED
]);
Parameter Details
Members
- sourceServerID
-
- Required: Yes
- Type: string
Request to get Launch Configuration information by Source Server ID.
Result Syntax
[
'bootMode' => 'LEGACY_BIOS|UEFI',
'copyPrivateIp' => true || false,
'copyTags' => true || false,
'ec2LaunchTemplateID' => '<string>',
'enableMapAutoTagging' => true || false,
'launchDisposition' => 'STOPPED|STARTED',
'licensing' => [
'osByol' => true || false,
],
'mapAutoTaggingMpeID' => '<string>',
'name' => '<string>',
'postLaunchActions' => [
'cloudWatchLogGroupName' => '<string>',
'deployment' => 'TEST_AND_CUTOVER|CUTOVER_ONLY|TEST_ONLY',
's3LogBucket' => '<string>',
's3OutputKeyPrefix' => '<string>',
'ssmDocuments' => [
[
'actionName' => '<string>',
'externalParameters' => [
'<SsmDocumentParameterName>' => [
'dynamicPath' => '<string>',
],
// ...
],
'mustSucceedForCutover' => true || false,
'parameters' => [
'<SsmDocumentParameterName>' => [
[
'parameterName' => '<string>',
'parameterType' => 'STRING',
],
// ...
],
// ...
],
'ssmDocumentName' => '<string>',
'timeoutSeconds' => <integer>,
],
// ...
],
],
'sourceServerID' => '<string>',
'targetInstanceTypeRightSizingMethod' => 'NONE|BASIC',
]
Result Details
Members
- bootMode
-
- Type: string
Launch configuration boot mode.
- copyPrivateIp
-
- Type: boolean
Copy Private IP during Launch Configuration.
- copyTags
-
- Type: boolean
Copy Tags during Launch Configuration.
- ec2LaunchTemplateID
-
- Type: string
Launch configuration EC2 Launch template ID.
- enableMapAutoTagging
-
- Type: boolean
Enable map auto tagging.
- launchDisposition
-
- Type: string
Launch disposition for launch configuration.
- licensing
-
- Type: Licensing structure
Launch configuration OS licensing.
- mapAutoTaggingMpeID
-
- Type: string
Map auto tagging MPE ID.
- name
-
- Type: string
Launch configuration name.
- postLaunchActions
-
- Type: PostLaunchActions structure
Post Launch Actions to executed on the Test or Cutover instance.
- sourceServerID
-
- Type: string
Launch configuration Source Server ID.
- targetInstanceTypeRightSizingMethod
-
- Type: string
Launch configuration Target instance type right sizing method.
Errors
-
UninitializedAccountException:
Uninitialized account exception.
-
Resource not found exception.
GetReplicationConfiguration
$result = $client->getReplicationConfiguration([/* ... */]); $promise = $client->getReplicationConfigurationAsync([/* ... */]);
Lists all ReplicationConfigurations, filtered by Source Server ID.
Parameter Syntax
$result = $client->getReplicationConfiguration([
'sourceServerID' => '<string>', // REQUIRED
]);
Parameter Details
Members
- sourceServerID
-
- Required: Yes
- Type: string
Request to get Replication Configuration by Source Server ID.
Result Syntax
[
'associateDefaultSecurityGroup' => true || false,
'bandwidthThrottling' => <integer>,
'createPublicIP' => true || false,
'dataPlaneRouting' => 'PRIVATE_IP|PUBLIC_IP',
'defaultLargeStagingDiskType' => 'GP2|ST1|GP3',
'ebsEncryption' => 'DEFAULT|CUSTOM',
'ebsEncryptionKeyArn' => '<string>',
'name' => '<string>',
'replicatedDisks' => [
[
'deviceName' => '<string>',
'iops' => <integer>,
'isBootDisk' => true || false,
'stagingDiskType' => 'AUTO|GP2|IO1|SC1|ST1|STANDARD|GP3|IO2',
'throughput' => <integer>,
],
// ...
],
'replicationServerInstanceType' => '<string>',
'replicationServersSecurityGroupsIDs' => ['<string>', ...],
'sourceServerID' => '<string>',
'stagingAreaSubnetId' => '<string>',
'stagingAreaTags' => ['<string>', ...],
'useDedicatedReplicationServer' => true || false,
]
Result Details
Members
- associateDefaultSecurityGroup
-
- Type: boolean
Replication Configuration associate default Application Migration Service Security Group.
- bandwidthThrottling
-
- Type: long (int|float)
Replication Configuration set bandwidth throttling.
- createPublicIP
-
- Type: boolean
Replication Configuration create Public IP.
- dataPlaneRouting
-
- Type: string
Replication Configuration data plane routing.
- defaultLargeStagingDiskType
-
- Type: string
Replication Configuration use default large Staging Disks.
- ebsEncryption
-
- Type: string
Replication Configuration EBS encryption.
- ebsEncryptionKeyArn
-
- Type: string
Replication Configuration EBS encryption key ARN.
- name
-
- Type: string
Replication Configuration name.
- replicatedDisks
-
- Type: Array of ReplicationConfigurationReplicatedDisk structures
Replication Configuration replicated disks.
- replicationServerInstanceType
-
- Type: string
Replication Configuration Replication Server instance type.
- replicationServersSecurityGroupsIDs
-
- Type: Array of strings
Replication Configuration Replication Server Security Group IDs.
- sourceServerID
-
- Type: string
Replication Configuration Source Server ID.
- stagingAreaSubnetId
-
- Type: string
Replication Configuration Staging Area subnet ID.
- stagingAreaTags
-
- Type: Associative array of custom strings keys (TagKey) to strings
Replication Configuration Staging Area tags.
- useDedicatedReplicationServer
-
- Type: boolean
Replication Configuration use Dedicated Replication Server.
Errors
-
UninitializedAccountException:
Uninitialized account exception.
-
Resource not found exception.
InitializeService
$result = $client->initializeService([/* ... */]); $promise = $client->initializeServiceAsync([/* ... */]);
Initialize Application Migration Service.
Parameter Syntax
$result = $client->initializeService([ ]);
Parameter Details
Members
Result Syntax
[]
Result Details
Errors
-
Validate exception.
-
Operating denied due to a file permission or access check error.
ListApplications
$result = $client->listApplications([/* ... */]); $promise = $client->listApplicationsAsync([/* ... */]);
Retrieves all applications or multiple applications by ID.
Parameter Syntax
$result = $client->listApplications([
'filters' => [
'applicationIDs' => ['<string>', ...],
'isArchived' => true || false,
'waveIDs' => ['<string>', ...],
],
'maxResults' => <integer>,
'nextToken' => '<string>',
]);
Parameter Details
Members
- filters
-
- Type: ListApplicationsRequestFilters structure
Applications list filters.
- maxResults
-
- Type: int
Maximum results to return when listing applications.
- nextToken
-
- Type: string
Request next token.
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
Members
- items
-
- Type: Array of Application structures
Applications list.
- nextToken
-
- Type: string
Response next token.
Errors
-
UninitializedAccountException:
Uninitialized account 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
Members
- exportID
-
- Required: Yes
- Type: string
List export errors request export id.
- maxResults
-
- Type: int
List export errors request max results.
- nextToken
-
- Type: string
List export errors request next token.
Result Syntax
[
'items' => [
[
'errorData' => [
'rawError' => '<string>',
],
'errorDateTime' => '<string>',
],
// ...
],
'nextToken' => '<string>',
]
Result Details
Members
- items
-
- Type: Array of ExportTaskError structures
List export errors response items.
- nextToken
-
- Type: string
List export errors response next token.
Errors
-
UninitializedAccountException:
Uninitialized account exception.
-
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
Members
- filters
-
- Type: ListExportsRequestFilters structure
List exports request filters.
- maxResults
-
- Type: int
List export request max results.
- nextToken
-
- Type: string
List export request next token.
Result Syntax
[
'items' => [
[
'creationDateTime' => '<string>',
'endDateTime' => '<string>',
'exportID' => '<string>',
'progressPercentage' => <float>,
's3Bucket' => '<string>',
's3BucketOwner' => '<string>',
's3Key' => '<string>',
'status' => 'PENDING|STARTED|FAILED|SUCCEEDED',
'summary' => [
'applicationsCount' => <integer>,
'serversCount' => <integer>,
'wavesCount' => <integer>,
],
],
// ...
],
'nextToken' => '<string>',
]
Result Details
Members
- items
-
- Type: Array of ExportTask structures
List export response items.
- nextToken
-
- Type: string
List export response next token.
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
Members
- importID
-
- Required: Yes
- Type: string
List import errors request import id.
- maxResults
-
- Type: int
List import errors request max results.
- nextToken
-
- Type: string
List import errors request next token.
Result Syntax
[
'items' => [
[
'errorData' => [
'applicationID' => '<string>',
'ec2LaunchTemplateID' => '<string>',
'rawError' => '<string>',
'rowNumber' => <integer>,
'sourceServerID' => '<string>',
'waveID' => '<string>',
],
'errorDateTime' => '<string>',
'errorType' => 'VALIDATION_ERROR|PROCESSING_ERROR',
],
// ...
],
'nextToken' => '<string>',
]
Result Details
Members
- items
-
- Type: Array of ImportTaskError structures
List imports errors response items.
- nextToken
-
- Type: string
List imports errors response next token.
Errors
-
UninitializedAccountException:
Uninitialized account exception.
-
Validate exception.
ListImports
$result = $client->listImports([/* ... */]); $promise = $client->listImportsAsync([/* ... */]);
List imports.
Parameter Syntax
$result = $client->listImports([
'filters' => [
'importIDs' => ['<string>', ...],
],
'maxResults' => <integer>,
'nextToken' => '<string>',
]);
Parameter Details
Members
- filters
-
- Type: ListImportsRequestFilters structure
List imports request filters.
- maxResults
-
- Type: int
List imports request max results.
- nextToken
-
- Type: string
List imports request next token.
Result Syntax
[
'items' => [
[
'creationDateTime' => '<string>',
'endDateTime' => '<string>',
'importID' => '<string>',
'progressPercentage' => <float>,
's3BucketSource' => [
's3Bucket' => '<string>',
's3BucketOwner' => '<string>',
's3Key' => '<string>',
],
'status' => 'PENDING|STARTED|FAILED|SUCCEEDED',
'summary' => [
'applications' => [
'createdCount' => <integer>,
'modifiedCount' => <integer>,
],
'servers' => [
'createdCount' => <integer>,
'modifiedCount' => <integer>,
],
'waves' => [
'createdCount' => <integer>,
'modifiedCount' => <integer>,
],
],
],
// ...
],
'nextToken' => '<string>',
]
Result Details
Members
- items
-
- Type: Array of ImportTask structures
List import response items.
- nextToken
-
- Type: string
List import response next token.
Errors
-
UninitializedAccountException:
Uninitialized account exception.
-
Validate exception.
ListSourceServerActions
$result = $client->listSourceServerActions([/* ... */]); $promise = $client->listSourceServerActionsAsync([/* ... */]);
List source server post migration custom actions.
Parameter Syntax
$result = $client->listSourceServerActions([
'filters' => [
'actionIDs' => ['<string>', ...],
],
'maxResults' => <integer>,
'nextToken' => '<string>',
'sourceServerID' => '<string>', // REQUIRED
]);
Parameter Details
Members
- filters
-
- Type: SourceServerActionsRequestFilters structure
Filters to apply when listing source server post migration custom actions.
- maxResults
-
- Type: int
Maximum amount of items to return when listing source server post migration custom actions.
- nextToken
-
- Type: string
Next token to use when listing source server post migration custom actions.
- sourceServerID
-
- Required: Yes
- Type: string
Source server ID.
Result Syntax
[
'items' => [
[
'actionID' => '<string>',
'actionName' => '<string>',
'active' => true || false,
'category' => 'DISASTER_RECOVERY|OPERATING_SYSTEM|LICENSE_AND_SUBSCRIPTION|VALIDATION|OBSERVABILITY|SECURITY|NETWORKING|CONFIGURATION|BACKUP|OTHER',
'description' => '<string>',
'documentIdentifier' => '<string>',
'documentVersion' => '<string>',
'externalParameters' => [
'<SsmDocumentParameterName>' => [
'dynamicPath' => '<string>',
],
// ...
],
'mustSucceedForCutover' => true || false,
'order' => <integer>,
'parameters' => [
'<SsmDocumentParameterName>' => [
[
'parameterName' => '<string>',
'parameterType' => 'STRING',
],
// ...
],
// ...
],
'timeoutSeconds' => <integer>,
],
// ...
],
'nextToken' => '<string>',
]
Result Details
Members
- items
-
- Type: Array of SourceServerActionDocument structures
List of source server post migration custom actions.
- nextToken
-
- Type: string
Next token returned when listing source server post migration custom actions.
Errors
-
UninitializedAccountException:
Uninitialized account exception.
-
Resource not found exception.
ListTagsForResource
$result = $client->listTagsForResource([/* ... */]); $promise = $client->listTagsForResourceAsync([/* ... */]);
List all tags for your Application Migration Service resources.
Parameter Syntax
$result = $client->listTagsForResource([
'resourceArn' => '<string>', // REQUIRED
]);
Parameter Details
Members
- resourceArn
-
- Required: Yes
- Type: string
List tags for resource request by ARN.
Result Syntax
[
'tags' => ['<string>', ...],
]
Result Details
Members
- tags
-
- Type: Associative array of custom strings keys (TagKey) to strings
List tags for resource response.
Errors
-
Resource not found exception.
-
Reached throttling quota exception.
-
Validate exception.
-
Operating denied due to a file permission or access check error.
-
The server encountered an unexpected condition that prevented it from fulfilling the request.
ListTemplateActions
$result = $client->listTemplateActions([/* ... */]); $promise = $client->listTemplateActionsAsync([/* ... */]);
List template post migration custom actions.
Parameter Syntax
$result = $client->listTemplateActions([
'filters' => [
'actionIDs' => ['<string>', ...],
],
'launchConfigurationTemplateID' => '<string>', // REQUIRED
'maxResults' => <integer>,
'nextToken' => '<string>',
]);
Parameter Details
Members
- filters
-
- Type: TemplateActionsRequestFilters structure
Filters to apply when listing template post migration custom actions.
- launchConfigurationTemplateID
-
- Required: Yes
- Type: string
Launch configuration template ID.
- maxResults
-
- Type: int
Maximum amount of items to return when listing template post migration custom actions.
- nextToken
-
- Type: string
Next token to use when listing template post migration custom actions.
Result Syntax
[
'items' => [
[
'actionID' => '<string>',
'actionName' => '<string>',
'active' => true || false,
'category' => 'DISASTER_RECOVERY|OPERATING_SYSTEM|LICENSE_AND_SUBSCRIPTION|VALIDATION|OBSERVABILITY|SECURITY|NETWORKING|CONFIGURATION|BACKUP|OTHER',
'description' => '<string>',
'documentIdentifier' => '<string>',
'documentVersion' => '<string>',
'externalParameters' => [
'<SsmDocumentParameterName>' => [
'dynamicPath' => '<string>',
],
// ...
],
'mustSucceedForCutover' => true || false,
'operatingSystem' => '<string>',
'order' => <integer>,
'parameters' => [
'<SsmDocumentParameterName>' => [
[
'parameterName' => '<string>',
'parameterType' => 'STRING',
],
// ...
],
// ...
],
'timeoutSeconds' => <integer>,
],
// ...
],
'nextToken' => '<string>',
]
Result Details
Members
- items
-
- Type: Array of TemplateActionDocument structures
List of template post migration custom actions.
- nextToken
-
- Type: string
Next token returned when listing template post migration custom actions.
Errors
-
UninitializedAccountException:
Uninitialized account exception.
-
Resource not found exception.
ListWaves
$result = $client->listWaves([/* ... */]); $promise = $client->listWavesAsync([/* ... */]);
Retrieves all waves or multiple waves by ID.
Parameter Syntax
$result = $client->listWaves([
'filters' => [
'isArchived' => true || false,
'waveIDs' => ['<string>', ...],
],
'maxResults' => <integer>,
'nextToken' => '<string>',
]);
Parameter Details
Members
- filters
-
- Type: ListWavesRequestFilters structure
Waves list filters.
- maxResults
-
- Type: int
Maximum results to return when listing waves.
- nextToken
-
- Type: string
Request next token.
Result Syntax
[
'items' => [
[
'arn' => '<string>',
'creationDateTime' => '<string>',
'description' => '<string>',
'isArchived' => true || false,
'lastModifiedDateTime' => '<string>',
'name' => '<string>',
'tags' => ['<string>', ...],
'waveAggregatedStatus' => [
'healthStatus' => 'HEALTHY|LAGGING|ERROR',
'lastUpdateDateTime' => '<string>',
'progressStatus' => 'NOT_STARTED|IN_PROGRESS|COMPLETED',
'replicationStartedDateTime' => '<string>',
'totalApplications' => <integer>,
],
'waveID' => '<string>',
],
// ...
],
'nextToken' => '<string>',
]
Result Details
Members
- items
-
- Type: Array of Wave structures
Waves list.
- nextToken
-
- Type: string
Response next token.
Errors
-
UninitializedAccountException:
Uninitialized account exception.
MarkAsArchived
$result = $client->markAsArchived([/* ... */]); $promise = $client->markAsArchivedAsync([/* ... */]);
Archives specific Source Servers by setting the SourceServer.isArchived property to true for specified SourceServers by ID. This command only works for SourceServers with a lifecycle. state which equals DISCONNECTED or CUTOVER.
Parameter Syntax
$result = $client->markAsArchived([
'sourceServerID' => '<string>', // REQUIRED
]);
Parameter Details
Members
- sourceServerID
-
- Required: Yes
- Type: string
Mark as archived by Source Server ID.
Result Syntax
[
'applicationID' => '<string>',
'arn' => '<string>',
'dataReplicationInfo' => [
'dataReplicationError' => [
'error' => 'AGENT_NOT_SEEN|SNAPSHOTS_FAILURE|NOT_CONVERGING|UNSTABLE_NETWORK|FAILED_TO_CREATE_SECURITY_GROUP|FAILED_TO_LAUNCH_REPLICATION_SERVER|FAILED_TO_BOOT_REPLICATION_SERVER|FAILED_TO_AUTHENTICATE_WITH_SERVICE|FAILED_TO_DOWNLOAD_REPLICATION_SOFTWARE|FAILED_TO_CREATE_STAGING_DISKS|FAILED_TO_ATTACH_STAGING_DISKS|FAILED_TO_PAIR_REPLICATION_SERVER_WITH_AGENT|FAILED_TO_CONNECT_AGENT_TO_REPLICATION_SERVER|FAILED_TO_START_DATA_TRANSFER|UNSUPPORTED_VM_CONFIGURATION|LAST_SNAPSHOT_JOB_FAILED',
'rawError' => '<string>',
],
'dataReplicationInitiation' => [
'nextAttemptDateTime' => '<string>',
'startDateTime' => '<string>',
'steps' => [
[
'name' => 'WAIT|CREATE_SECURITY_GROUP|LAUNCH_REPLICATION_SERVER|BOOT_REPLICATION_SERVER|AUTHENTICATE_WITH_SERVICE|DOWNLOAD_REPLICATION_SOFTWARE|CREATE_STAGING_DISKS|ATTACH_STAGING_DISKS|PAIR_REPLICATION_SERVER_WITH_AGENT|CONNECT_AGENT_TO_REPLICATION_SERVER|START_DATA_TRANSFER',
'status' => 'NOT_STARTED|IN_PROGRESS|SUCCEEDED|FAILED|SKIPPED',
],
// ...
],
],
'dataReplicationState' => 'STOPPED|INITIATING|INITIAL_SYNC|BACKLOG|CREATING_SNAPSHOT|CONTINUOUS|PAUSED|RESCAN|STALLED|DISCONNECTED|PENDING_SNAPSHOT_SHIPPING|SHIPPING_SNAPSHOT',
'etaDateTime' => '<string>',
'lagDuration' => '<string>',
'lastSnapshotDateTime' => '<string>',
'replicatedDisks' => [
[
'backloggedStorageBytes' => <integer>,
'deviceName' => '<string>',
'replicatedStorageBytes' => <integer>,
'rescannedStorageBytes' => <integer>,
'totalStorageBytes' => <integer>,
],
// ...
],
],
'fqdnForActionFramework' => '<string>',
'isArchived' => true || false,
'launchedInstance' => [
'ec2InstanceID' => '<string>',
'firstBoot' => 'WAITING|SUCCEEDED|UNKNOWN|STOPPED',
'jobID' => '<string>',
],
'lifeCycle' => [
'addedToServiceDateTime' => '<string>',
'elapsedReplicationDuration' => '<string>',
'firstByteDateTime' => '<string>',
'lastCutover' => [
'finalized' => [
'apiCallDateTime' => '<string>',
],
'initiated' => [
'apiCallDateTime' => '<string>',
'jobID' => '<string>',
],
'reverted' => [
'apiCallDateTime' => '<string>',
],
],
'lastSeenByServiceDateTime' => '<string>',
'lastTest' => [
'finalized' => [
'apiCallDateTime' => '<string>',
],
'initiated' => [
'apiCallDateTime' => '<string>',
'jobID' => '<string>',
],
'reverted' => [
'apiCallDateTime' => '<string>',
],
],
'state' => 'STOPPED|NOT_READY|READY_FOR_TEST|TESTING|READY_FOR_CUTOVER|CUTTING_OVER|CUTOVER|DISCONNECTED|DISCOVERED|PENDING_INSTALLATION',
],
'replicationType' => 'AGENT_BASED|SNAPSHOT_SHIPPING',
'sourceProperties' => [
'cpus' => [
[
'cores' => <integer>,
'modelName' => '<string>',
],
// ...
],
'disks' => [
[
'bytes' => <integer>,
'deviceName' => '<string>',
],
// ...
],
'identificationHints' => [
'awsInstanceID' => '<string>',
'fqdn' => '<string>',
'hostname' => '<string>',
'vmPath' => '<string>',
'vmWareUuid' => '<string>',
],
'lastUpdatedDateTime' => '<string>',
'networkInterfaces' => [
[
'ips' => ['<string>', ...],
'isPrimary' => true || false,
'macAddress' => '<string>',
],
// ...
],
'os' => [
'fullString' => '<string>',
],
'ramBytes' => <integer>,
'recommendedInstanceType' => '<string>',
],
'sourceServerID' => '<string>',
'tags' => ['<string>', ...],
'userProvidedID' => '<string>',
'vcenterClientID' => '<string>',
]
Result Details
Members
- applicationID
-
- Type: string
Source server application ID.
- arn
-
- Type: string
Source server ARN.
- dataReplicationInfo
-
- Type: DataReplicationInfo structure
Source server data replication info.
- fqdnForActionFramework
-
- Type: string
Source server fqdn for action framework.
- isArchived
-
- Type: boolean
Source server archived status.
- launchedInstance
-
- Type: LaunchedInstance structure
Source server launched instance.
- lifeCycle
-
- Type: LifeCycle structure
Source server lifecycle state.
- replicationType
-
- Type: string
Source server replication type.
- sourceProperties
-
- Type: SourceProperties structure
Source server properties.
- sourceServerID
-
- Type: string
Source server ID.
- tags
-
- Type: Associative array of custom strings keys (TagKey) to strings
Source server Tags.
- userProvidedID
-
- Type: string
Source server user provided ID.
- vcenterClientID
-
- Type: string
Source server vCenter client id.
Errors
-
UninitializedAccountException:
Uninitialized account exception.
-
Resource not found exception.
-
The request could not be completed due to a conflict with the current state of the target resource.
PutSourceServerAction
$result = $client->putSourceServerAction([/* ... */]); $promise = $client->putSourceServerActionAsync([/* ... */]);
Put source server post migration custom action.
Parameter Syntax
$result = $client->putSourceServerAction([
'actionID' => '<string>', // REQUIRED
'actionName' => '<string>', // REQUIRED
'active' => true || false,
'category' => 'DISASTER_RECOVERY|OPERATING_SYSTEM|LICENSE_AND_SUBSCRIPTION|VALIDATION|OBSERVABILITY|SECURITY|NETWORKING|CONFIGURATION|BACKUP|OTHER',
'description' => '<string>',
'documentIdentifier' => '<string>', // REQUIRED
'documentVersion' => '<string>',
'externalParameters' => [
'<SsmDocumentParameterName>' => [
'dynamicPath' => '<string>',
],
// ...
],
'mustSucceedForCutover' => true || false,
'order' => <integer>, // REQUIRED
'parameters' => [
'<SsmDocumentParameterName>' => [
[
'parameterName' => '<string>', // REQUIRED
'parameterType' => 'STRING', // REQUIRED
],
// ...
],
// ...
],
'sourceServerID' => '<string>', // REQUIRED
'timeoutSeconds' => <integer>,
]);
Parameter Details
Members
- actionID
-
- Required: Yes
- Type: string
Source server post migration custom action ID.
- actionName
-
- Required: Yes
- Type: string
Source server post migration custom action name.
- active
-
- Type: boolean
Source server post migration custom action active status.
- category
-
- Type: string
Source server post migration custom action category.
- description
-
- Type: string
Source server post migration custom action description.
- documentIdentifier
-
- Required: Yes
- Type: string
Source server post migration custom action document identifier.
- documentVersion
-
- Type: string
Source server post migration custom action document version.
- externalParameters
-
- Type: Associative array of custom strings keys (SsmDocumentParameterName) to SsmExternalParameter structures
Source server post migration custom action external parameters.
- mustSucceedForCutover
-
- Type: boolean
Source server post migration custom action must succeed for cutover.
- order
-
- Required: Yes
- Type: int
Source server post migration custom action order.
- parameters
-
- Type: Associative array of custom strings keys (SsmDocumentParameterName) to SsmParameterStoreParameter structuress
Source server post migration custom action parameters.
- sourceServerID
-
- Required: Yes
- Type: string
Source server ID.
- timeoutSeconds
-
- Type: int
Source server post migration custom action timeout in seconds.
Result Syntax
[
'actionID' => '<string>',
'actionName' => '<string>',
'active' => true || false,
'category' => 'DISASTER_RECOVERY|OPERATING_SYSTEM|LICENSE_AND_SUBSCRIPTION|VALIDATION|OBSERVABILITY|SECURITY|NETWORKING|CONFIGURATION|BACKUP|OTHER',
'description' => '<string>',
'documentIdentifier' => '<string>',
'documentVersion' => '<string>',
'externalParameters' => [
'<SsmDocumentParameterName>' => [
'dynamicPath' => '<string>',
],
// ...
],
'mustSucceedForCutover' => true || false,
'order' => <integer>,
'parameters' => [
'<SsmDocumentParameterName>' => [
[
'parameterName' => '<string>',
'parameterType' => 'STRING',
],
// ...
],
// ...
],
'timeoutSeconds' => <integer>,
]
Result Details
Members
- actionID
-
- Type: string
Source server post migration custom action ID.
- actionName
-
- Type: string
Source server post migration custom action name.
- active
-
- Type: boolean
Source server post migration custom action active status.
- category
-
- Type: string
Source server post migration custom action category.
- description
-
- Type: string
Source server post migration custom action description.
- documentIdentifier
-
- Type: string
Source server post migration custom action document identifier.
- documentVersion
-
- Type: string
Source server post migration custom action document version.
- externalParameters
-
- Type: Associative array of custom strings keys (SsmDocumentParameterName) to SsmExternalParameter structures
Source server post migration custom action external parameters.
- mustSucceedForCutover
-
- Type: boolean
Source server post migration custom action must succeed for cutover.
- order
-
- Type: int
Source server post migration custom action order.
- parameters
-
- Type: Associative array of custom strings keys (SsmDocumentParameterName) to SsmParameterStoreParameter structuress
Source server post migration custom action parameters.
- timeoutSeconds
-
- Type: int
Source server post migration custom action timeout in seconds.
Errors
-
UninitializedAccountException:
Uninitialized account exception.
-
Resource not found exception.
-
Validate exception.
-
The request could not be completed due to a conflict with the current state of the target resource.
PutTemplateAction
$result = $client->putTemplateAction([/* ... */]); $promise = $client->putTemplateActionAsync([/* ... */]);
Put template post migration custom action.
Parameter Syntax
$result = $client->putTemplateAction([
'actionID' => '<string>', // REQUIRED
'actionName' => '<string>', // REQUIRED
'active' => true || false,
'category' => 'DISASTER_RECOVERY|OPERATING_SYSTEM|LICENSE_AND_SUBSCRIPTION|VALIDATION|OBSERVABILITY|SECURITY|NETWORKING|CONFIGURATION|BACKUP|OTHER',
'description' => '<string>',
'documentIdentifier' => '<string>', // REQUIRED
'documentVersion' => '<string>',
'externalParameters' => [
'<SsmDocumentParameterName>' => [
'dynamicPath' => '<string>',
],
// ...
],
'launchConfigurationTemplateID' => '<string>', // REQUIRED
'mustSucceedForCutover' => true || false,
'operatingSystem' => '<string>',
'order' => <integer>, // REQUIRED
'parameters' => [
'<SsmDocumentParameterName>' => [
[
'parameterName' => '<string>', // REQUIRED
'parameterType' => 'STRING', // REQUIRED
],
// ...
],
// ...
],
'timeoutSeconds' => <integer>,
]);
Parameter Details
Members
- actionID
-
- Required: Yes
- Type: string
Template post migration custom action ID.
- actionName
-
- Required: Yes
- Type: string
Template post migration custom action name.
- active
-
- Type: boolean
Template post migration custom action active status.
- category
-
- Type: string
Template post migration custom action category.
- description
-
- Type: string
Template post migration custom action description.
- documentIdentifier
-
- Required: Yes
- Type: string
Template post migration custom action document identifier.
- documentVersion
-
- Type: string
Template post migration custom action document version.
- externalParameters
-
- Type: Associative array of custom strings keys (SsmDocumentParameterName) to SsmExternalParameter structures
Template post migration custom action external parameters.
- launchConfigurationTemplateID
-
- Required: Yes
- Type: string
Launch configuration template ID.
- mustSucceedForCutover
-
- Type: boolean
Template post migration custom action must succeed for cutover.
- operatingSystem
-
- Type: string
Operating system eligible for this template post migration custom action.
- order
-
- Required: Yes
- Type: int
Template post migration custom action order.
- parameters
-
- Type: Associative array of custom strings keys (SsmDocumentParameterName) to SsmParameterStoreParameter structuress
Template post migration custom action parameters.
- timeoutSeconds
-
- Type: int
Template post migration custom action timeout in seconds.
Result Syntax
[
'actionID' => '<string>',
'actionName' => '<string>',
'active' => true || false,
'category' => 'DISASTER_RECOVERY|OPERATING_SYSTEM|LICENSE_AND_SUBSCRIPTION|VALIDATION|OBSERVABILITY|SECURITY|NETWORKING|CONFIGURATION|BACKUP|OTHER',
'description' => '<string>',
'documentIdentifier' => '<string>',
'documentVersion' => '<string>',
'externalParameters' => [
'<SsmDocumentParameterName>' => [
'dynamicPath' => '<string>',
],
// ...
],
'mustSucceedForCutover' => true || false,
'operatingSystem' => '<string>',
'order' => <integer>,
'parameters' => [
'<SsmDocumentParameterName>' => [
[
'parameterName' => '<string>',
'parameterType' => 'STRING',
],
// ...
],
// ...
],
'timeoutSeconds' => <integer>,
]
Result Details
Members
- actionID
-
- Type: string
Template post migration custom action ID.
- actionName
-
- Type: string
Template post migration custom action name.
- active
-
- Type: boolean
Template post migration custom action active status.
- category
-
- Type: string
Template post migration custom action category.
- description
-
- Type: string
Template post migration custom action description.
- documentIdentifier
-
- Type: string
Template post migration custom action document identifier.
- documentVersion
-
- Type: string
Template post migration custom action document version.
- externalParameters
-
- Type: Associative array of custom strings keys (SsmDocumentParameterName) to SsmExternalParameter structures
Template post migration custom action external parameters.
- mustSucceedForCutover
-
- Type: boolean
Template post migration custom action must succeed for cutover.
- operatingSystem
-
- Type: string
Operating system eligible for this template post migration custom action.
- order
-
- Type: int
Template post migration custom action order.
- parameters
-
- Type: Associative array of custom strings keys (SsmDocumentParameterName) to SsmParameterStoreParameter structuress
Template post migration custom action parameters.
- timeoutSeconds
-
- Type: int
Template post migration custom action timeout in seconds.
Errors
-
UninitializedAccountException:
Uninitialized account exception.
-
Resource not found exception.
-
Validate exception.
-
The request could not be completed due to a conflict with the current state of the target resource.
RemoveSourceServerAction
$result = $client->removeSourceServerAction([/* ... */]); $promise = $client->removeSourceServerActionAsync([/* ... */]);
Remove source server post migration custom action.
Parameter Syntax
$result = $client->removeSourceServerAction([
'actionID' => '<string>', // REQUIRED
'sourceServerID' => '<string>', // REQUIRED
]);
Parameter Details
Members
- actionID
-
- Required: Yes
- Type: string
Source server post migration custom action ID to remove.
- sourceServerID
-
- Required: Yes
- Type: string
Source server ID of the post migration custom action to remove.
Result Syntax
[]
Result Details
Errors
-
UninitializedAccountException:
Uninitialized account exception.
-
Resource not found exception.
-
Validate exception.
RemoveTemplateAction
$result = $client->removeTemplateAction([/* ... */]); $promise = $client->removeTemplateActionAsync([/* ... */]);
Remove template post migration custom action.
Parameter Syntax
$result = $client->removeTemplateAction([
'actionID' => '<string>', // REQUIRED
'launchConfigurationTemplateID' => '<string>', // REQUIRED
]);
Parameter Details
Members
- actionID
-
- Required: Yes
- Type: string
Template post migration custom action ID to remove.
- launchConfigurationTemplateID
-
- Required: Yes
- Type: string
Launch configuration template ID of the post migration custom action to remove.
Result Syntax
[]
Result Details
Errors
-
UninitializedAccountException:
Uninitialized account exception.
-
Resource not found exception.
-
Validate exception.
RetryDataReplication
$result = $client->retryDataReplication([/* ... */]); $promise = $client->retryDataReplicationAsync([/* ... */]);
Causes the data replication initiation sequence to begin immediately upon next Handshake for specified SourceServer IDs, regardless of when the previous initiation started. This command will not work if the SourceServer is not stalled or is in a DISCONNECTED or STOPPED state.
Parameter Syntax
$result = $client->retryDataReplication([
'sourceServerID' => '<string>', // REQUIRED
]);
Parameter Details
Members
- sourceServerID
-
- Required: Yes
- Type: string
Retry data replication for Source Server ID.
Result Syntax
[
'applicationID' => '<string>',
'arn' => '<string>',
'dataReplicationInfo' => [
'dataReplicationError' => [
'error' => 'AGENT_NOT_SEEN|SNAPSHOTS_FAILURE|NOT_CONVERGING|UNSTABLE_NETWORK|FAILED_TO_CREATE_SECURITY_GROUP|FAILED_TO_LAUNCH_REPLICATION_SERVER|FAILED_TO_BOOT_REPLICATION_SERVER|FAILED_TO_AUTHENTICATE_WITH_SERVICE|FAILED_TO_DOWNLOAD_REPLICATION_SOFTWARE|FAILED_TO_CREATE_STAGING_DISKS|FAILED_TO_ATTACH_STAGING_DISKS|FAILED_TO_PAIR_REPLICATION_SERVER_WITH_AGENT|FAILED_TO_CONNECT_AGENT_TO_REPLICATION_SERVER|FAILED_TO_START_DATA_TRANSFER|UNSUPPORTED_VM_CONFIGURATION|LAST_SNAPSHOT_JOB_FAILED',
'rawError' => '<string>',
],
'dataReplicationInitiation' => [
'nextAttemptDateTime' => '<string>',
'startDateTime' => '<string>',
'steps' => [
[
'name' => 'WAIT|CREATE_SECURITY_GROUP|LAUNCH_REPLICATION_SERVER|BOOT_REPLICATION_SERVER|AUTHENTICATE_WITH_SERVICE|DOWNLOAD_REPLICATION_SOFTWARE|CREATE_STAGING_DISKS|ATTACH_STAGING_DISKS|PAIR_REPLICATION_SERVER_WITH_AGENT|CONNECT_AGENT_TO_REPLICATION_SERVER|START_DATA_TRANSFER',
'status' => 'NOT_STARTED|IN_PROGRESS|SUCCEEDED|FAILED|SKIPPED',
],
// ...
],
],
'dataReplicationState' => 'STOPPED|INITIATING|INITIAL_SYNC|BACKLOG|CREATING_SNAPSHOT|CONTINUOUS|PAUSED|RESCAN|STALLED|DISCONNECTED|PENDING_SNAPSHOT_SHIPPING|SHIPPING_SNAPSHOT',
'etaDateTime' => '<string>',
'lagDuration' => '<string>',
'lastSnapshotDateTime' => '<string>',
'replicatedDisks' => [
[
'backloggedStorageBytes' => <integer>,
'deviceName' => '<string>',
'replicatedStorageBytes' => <integer>,
'rescannedStorageBytes' => <integer>,
'totalStorageBytes' => <integer>,
],
// ...
],
],
'fqdnForActionFramework' => '<string>',
'isArchived' => true || false,
'launchedInstance' => [
'ec2InstanceID' => '<string>',
'firstBoot' => 'WAITING|SUCCEEDED|UNKNOWN|STOPPED',
'jobID' => '<string>',
],
'lifeCycle' => [
'addedToServiceDateTime' => '<string>',
'elapsedReplicationDuration' => '<string>',
'firstByteDateTime' => '<string>',
'lastCutover' => [
'finalized' => [
'apiCallDateTime' => '<string>',
],
'initiated' => [
'apiCallDateTime' => '<string>',
'jobID' => '<string>',
],
'reverted' => [
'apiCallDateTime' => '<string>',
],
],
'lastSeenByServiceDateTime' => '<string>',
'lastTest' => [
'finalized' => [
'apiCallDateTime' => '<string>',
],
'initiated' => [
'apiCallDateTime' => '<string>',
'jobID' => '<string>',
],
'reverted' => [
'apiCallDateTime' => '<string>',
],
],
'state' => 'STOPPED|NOT_READY|READY_FOR_TEST|TESTING|READY_FOR_CUTOVER|CUTTING_OVER|CUTOVER|DISCONNECTED|DISCOVERED|PENDING_INSTALLATION',
],
'replicationType' => 'AGENT_BASED|SNAPSHOT_SHIPPING',
'sourceProperties' => [
'cpus' => [
[
'cores' => <integer>,
'modelName' => '<string>',
],
// ...
],
'disks' => [
[
'bytes' => <integer>,
'deviceName' => '<string>',
],
// ...
],
'identificationHints' => [
'awsInstanceID' => '<string>',
'fqdn' => '<string>',
'hostname' => '<string>',
'vmPath' => '<string>',
'vmWareUuid' => '<string>',
],
'lastUpdatedDateTime' => '<string>',
'networkInterfaces' => [
[
'ips' => ['<string>', ...],
'isPrimary' => true || false,
'macAddress' => '<string>',
],
// ...
],
'os' => [
'fullString' => '<string>',
],
'ramBytes' => <integer>,
'recommendedInstanceType' => '<string>',
],
'sourceServerID' => '<string>',
'tags' => ['<string>', ...],
'userProvidedID' => '<string>',
'vcenterClientID' => '<string>',
]
Result Details
Members
- applicationID
-
- Type: string
Source server application ID.
- arn
-
- Type: string
Source server ARN.
- dataReplicationInfo
-
- Type: DataReplicationInfo structure
Source server data replication info.
- fqdnForActionFramework
-
- Type: string
Source server fqdn for action framework.
- isArchived
-
- Type: boolean
Source server archived status.
- launchedInstance
-
- Type: LaunchedInstance structure
Source server launched instance.
- lifeCycle
-
- Type: LifeCycle structure
Source server lifecycle state.
- replicationType
-
- Type: string
Source server replication type.
- sourceProperties
-
- Type: SourceProperties structure
Source server properties.
- sourceServerID
-
- Type: string
Source server ID.
- tags
-
- Type: Associative array of custom strings keys (TagKey) to strings
Source server Tags.
- userProvidedID
-
- Type: string
Source server user provided ID.
- vcenterClientID
-
- Type: string
Source server vCenter client id.
Errors
-
UninitializedAccountException:
Uninitialized account exception.
-
Resource not found exception.
-
Validate exception.
StartCutover
$result = $client->startCutover([/* ... */]); $promise = $client->startCutoverAsync([/* ... */]);
Launches a Cutover Instance for specific Source Servers. This command starts a LAUNCH job whose initiatedBy property is StartCutover and changes the SourceServer.lifeCycle.state property to CUTTING_OVER.
Parameter Syntax
$result = $client->startCutover([
'sourceServerIDs' => ['<string>', ...], // REQUIRED
'tags' => ['<string>', ...],
]);
Parameter Details
Members
- sourceServerIDs
-
- Required: Yes
- Type: Array of strings
Start Cutover by Source Server IDs.
- tags
-
- Type: Associative array of custom strings keys (TagKey) to strings
Start Cutover by Tags.
Result Syntax
[
'job' => [
'arn' => '<string>',
'creationDateTime' => '<string>',
'endDateTime' => '<string>',
'initiatedBy' => 'START_TEST|START_CUTOVER|DIAGNOSTIC|TERMINATE',
'jobID' => '<string>',
'participatingServers' => [
[
'launchStatus' => 'PENDING|IN_PROGRESS|LAUNCHED|FAILED|TERMINATED',
'launchedEc2InstanceID' => '<string>',
'postLaunchActionsStatus' => [
'postLaunchActionsLaunchStatusList' => [
[
'executionID' => '<string>',
'executionStatus' => 'IN_PROGRESS|SUCCESS|FAILED',
'failureReason' => '<string>',
'ssmDocument' => [
'actionName' => '<string>',
'externalParameters' => [
'<SsmDocumentParameterName>' => [
'dynamicPath' => '<string>',
],
// ...
],
'mustSucceedForCutover' => true || false,
'parameters' => [
'<SsmDocumentParameterName>' => [
[
'parameterName' => '<string>',
'parameterType' => 'STRING',
],
// ...
],
// ...
],
'ssmDocumentName' => '<string>',
'timeoutSeconds' => <integer>,
],
'ssmDocumentType' => 'AUTOMATION|COMMAND',
],
// ...
],
'ssmAgentDiscoveryDatetime' => '<string>',
],
'sourceServerID' => '<string>',
],
// ...
],
'status' => 'PENDING|STARTED|COMPLETED',
'tags' => ['<string>', ...],
'type' => 'LAUNCH|TERMINATE',
],
]
Result Details
Members
- job
-
- Type: Job structure
Start Cutover Job response.
Errors
-
UninitializedAccountException:
Uninitialized account exception.
-
Validate exception.
-
The request could not be completed due to a conflict with the current state of the target resource.
StartExport
$result = $client->startExport([/* ... */]); $promise = $client->startExportAsync([/* ... */]);
Start export.
Parameter Syntax
$result = $client->startExport([
's3Bucket' => '<string>', // REQUIRED
's3BucketOwner' => '<string>',
's3Key' => '<string>', // REQUIRED
]);
Parameter Details
Members
- s3Bucket
-
- Required: Yes
- Type: string
Start export request s3 bucket.
- s3BucketOwner
-
- Type: string
Start export request s3 bucket owner.
- s3Key
-
- Required: Yes
- Type: string
Start export request s3key.
Result Syntax
[
'exportTask' => [
'creationDateTime' => '<string>',
'endDateTime' => '<string>',
'exportID' => '<string>',
'progressPercentage' => <float>,
's3Bucket' => '<string>',
's3BucketOwner' => '<string>',
's3Key' => '<string>',
'status' => 'PENDING|STARTED|FAILED|SUCCEEDED',
'summary' => [
'applicationsCount' => <integer>,
'serversCount' => <integer>,
'wavesCount' => <integer>,
],
],
]
Result Details
Members
- exportTask
-
- Type: ExportTask structure
Start export response export task.
Errors
-
UninitializedAccountException:
Uninitialized account exception.
-
Validate exception.
-
ServiceQuotaExceededException:
The request could not be completed because its exceeded the service quota.
StartImport
$result = $client->startImport([/* ... */]); $promise = $client->startImportAsync([/* ... */]);
Start import.
Parameter Syntax
$result = $client->startImport([
'clientToken' => '<string>',
's3BucketSource' => [ // REQUIRED
's3Bucket' => '<string>', // REQUIRED
's3BucketOwner' => '<string>',
's3Key' => '<string>', // REQUIRED
],
]);
Parameter Details
Members
- clientToken
-
- Type: string
Start import request client token.
- s3BucketSource
-
- Required: Yes
- Type: S3BucketSource structure
Start import request s3 bucket source.
Result Syntax
[
'importTask' => [
'creationDateTime' => '<string>',
'endDateTime' => '<string>',
'importID' => '<string>',
'progressPercentage' => <float>,
's3BucketSource' => [
's3Bucket' => '<string>',
's3BucketOwner' => '<string>',
's3Key' => '<string>',
],
'status' => 'PENDING|STARTED|FAILED|SUCCEEDED',
'summary' => [
'applications' => [
'createdCount' => <integer>,
'modifiedCount' => <integer>,
],
'servers' => [
'createdCount' => <integer>,
'modifiedCount' => <integer>,
],
'waves' => [
'createdCount' => <integer>,
'modifiedCount' => <integer>,
],
],
],
]
Result Details
Members
- importTask
-
- Type: ImportTask structure
Start import response import task.
Errors
-
UninitializedAccountException:
Uninitialized account exception.
-
Resource not found exception.
-
Validate exception.
-
ServiceQuotaExceededException:
The request could not be completed because its exceeded the service quota.
-
The request could not be completed due to a conflict with the current state of the target resource.
StartReplication
$result = $client->startReplication([/* ... */]); $promise = $client->startReplicationAsync([/* ... */]);
Starts replication for SNAPSHOT_SHIPPING agents.
Parameter Syntax
$result = $client->startReplication([
'sourceServerID' => '<string>', // REQUIRED
]);
Parameter Details
Members
- sourceServerID
-
- Required: Yes
- Type: string
ID of source server on which to start replication.
Result Syntax
[
'applicationID' => '<string>',
'arn' => '<string>',
'dataReplicationInfo' => [
'dataReplicationError' => [
'error' => 'AGENT_NOT_SEEN|SNAPSHOTS_FAILURE|NOT_CONVERGING|UNSTABLE_NETWORK|FAILED_TO_CREATE_SECURITY_GROUP|FAILED_TO_LAUNCH_REPLICATION_SERVER|FAILED_TO_BOOT_REPLICATION_SERVER|FAILED_TO_AUTHENTICATE_WITH_SERVICE|FAILED_TO_DOWNLOAD_REPLICATION_SOFTWARE|FAILED_TO_CREATE_STAGING_DISKS|FAILED_TO_ATTACH_STAGING_DISKS|FAILED_TO_PAIR_REPLICATION_SERVER_WITH_AGENT|FAILED_TO_CONNECT_AGENT_TO_REPLICATION_SERVER|FAILED_TO_START_DATA_TRANSFER|UNSUPPORTED_VM_CONFIGURATION|LAST_SNAPSHOT_JOB_FAILED',
'rawError' => '<string>',
],
'dataReplicationInitiation' => [
'nextAttemptDateTime' => '<string>',
'startDateTime' => '<string>',
'steps' => [
[
'name' => 'WAIT|CREATE_SECURITY_GROUP|LAUNCH_REPLICATION_SERVER|BOOT_REPLICATION_SERVER|AUTHENTICATE_WITH_SERVICE|DOWNLOAD_REPLICATION_SOFTWARE|CREATE_STAGING_DISKS|ATTACH_STAGING_DISKS|PAIR_REPLICATION_SERVER_WITH_AGENT|CONNECT_AGENT_TO_REPLICATION_SERVER|START_DATA_TRANSFER',
'status' => 'NOT_STARTED|IN_PROGRESS|SUCCEEDED|FAILED|SKIPPED',
],
// ...
],
],
'dataReplicationState' => 'STOPPED|INITIATING|INITIAL_SYNC|BACKLOG|CREATING_SNAPSHOT|CONTINUOUS|PAUSED|RESCAN|STALLED|DISCONNECTED|PENDING_SNAPSHOT_SHIPPING|SHIPPING_SNAPSHOT',
'etaDateTime' => '<string>',
'lagDuration' => '<string>',
'lastSnapshotDateTime' => '<string>',
'replicatedDisks' => [
[
'backloggedStorageBytes' => <integer>,
'deviceName' => '<string>',
'replicatedStorageBytes' => <integer>,
'rescannedStorageBytes' => <integer>,
'totalStorageBytes' => <integer>,
],
// ...
],
],
'fqdnForActionFramework' => '<string>',
'isArchived' => true || false,
'launchedInstance' => [
'ec2InstanceID' => '<string>',
'firstBoot' => 'WAITING|SUCCEEDED|UNKNOWN|STOPPED',
'jobID' => '<string>',
],
'lifeCycle' => [
'addedToServiceDateTime' => '<string>',
'elapsedReplicationDuration' => '<string>',
'firstByteDateTime' => '<string>',
'lastCutover' => [
'finalized' => [
'apiCallDateTime' => '<string>',
],
'initiated' => [
'apiCallDateTime' => '<string>',
'jobID' => '<string>',
],
'reverted' => [
'apiCallDateTime' => '<string>',
],
],
'lastSeenByServiceDateTime' => '<string>',
'lastTest' => [
'finalized' => [
'apiCallDateTime' => '<string>',
],
'initiated' => [
'apiCallDateTime' => '<string>',
'jobID' => '<string>',
],
'reverted' => [
'apiCallDateTime' => '<string>',
],
],
'state' => 'STOPPED|NOT_READY|READY_FOR_TEST|TESTING|READY_FOR_CUTOVER|CUTTING_OVER|CUTOVER|DISCONNECTED|DISCOVERED|PENDING_INSTALLATION',
],
'replicationType' => 'AGENT_BASED|SNAPSHOT_SHIPPING',
'sourceProperties' => [
'cpus' => [
[
'cores' => <integer>,
'modelName' => '<string>',
],
// ...
],
'disks' => [
[
'bytes' => <integer>,
'deviceName' => '<string>',
],
// ...
],
'identificationHints' => [
'awsInstanceID' => '<string>',
'fqdn' => '<string>',
'hostname' => '<string>',
'vmPath' => '<string>',
'vmWareUuid' => '<string>',
],
'lastUpdatedDateTime' => '<string>',
'networkInterfaces' => [
[
'ips' => ['<string>', ...],
'isPrimary' => true || false,
'macAddress' => '<string>',
],
// ...
],
'os' => [
'fullString' => '<string>',
],
'ramBytes' => <integer>,
'recommendedInstanceType' => '<string>',
],
'sourceServerID' => '<string>',
'tags' => ['<string>', ...],
'userProvidedID' => '<string>',
'vcenterClientID' => '<string>',
]
Result Details
Members
- applicationID
-
- Type: string
Source server application ID.
- arn
-
- Type: string
Source server ARN.
- dataReplicationInfo
-
- Type: DataReplicationInfo structure
Source server data replication info.
- fqdnForActionFramework
-
- Type: string
Source server fqdn for action framework.
- isArchived
-
- Type: boolean
Source server archived status.
- launchedInstance
-
- Type: LaunchedInstance structure
Source server launched instance.
- lifeCycle
-
- Type: LifeCycle structure
Source server lifecycle state.
- replicationType
-
- Type: string
Source server replication type.
- sourceProperties
-
- Type: SourceProperties structure
Source server properties.
- sourceServerID
-
- Type: string
Source server ID.
- tags
-
- Type: Associative array of custom strings keys (TagKey) to strings
Source server Tags.
- userProvidedID
-
- Type: string
Source server user provided ID.
- vcenterClientID
-
- Type: string
Source server vCenter client id.
Errors
-
UninitializedAccountException:
Uninitialized account exception.
-
Resource not found exception.
-
Validate exception.
-
ServiceQuotaExceededException:
The request could not be completed because its exceeded the service quota.
-
The request could not be completed due to a conflict with the current state of the target resource.
StartTest
$result = $client->startTest([/* ... */]); $promise = $client->startTestAsync([/* ... */]);
Launches a Test Instance for specific Source Servers. This command starts a LAUNCH job whose initiatedBy property is StartTest and changes the SourceServer.lifeCycle.state property to TESTING.
Parameter Syntax
$result = $client->startTest([
'sourceServerIDs' => ['<string>', ...], // REQUIRED
'tags' => ['<string>', ...],
]);
Parameter Details
Members
- sourceServerIDs
-
- Required: Yes
- Type: Array of strings
Start Test for Source Server IDs.
- tags
-
- Type: Associative array of custom strings keys (TagKey) to strings
Start Test by Tags.
Result Syntax
[
'job' => [
'arn' => '<string>',
'creationDateTime' => '<string>',
'endDateTime' => '<string>',
'initiatedBy' => 'START_TEST|START_CUTOVER|DIAGNOSTIC|TERMINATE',
'jobID' => '<string>',
'participatingServers' => [
[
'launchStatus' => 'PENDING|IN_PROGRESS|LAUNCHED|FAILED|TERMINATED',
'launchedEc2InstanceID' => '<string>',
'postLaunchActionsStatus' => [
'postLaunchActionsLaunchStatusList' => [
[
'executionID' => '<string>',
'executionStatus' => 'IN_PROGRESS|SUCCESS|FAILED',
'failureReason' => '<string>',
'ssmDocument' => [
'actionName' => '<string>',
'externalParameters' => [
'<SsmDocumentParameterName>' => [
'dynamicPath' => '<string>',
],
// ...
],
'mustSucceedForCutover' => true || false,
'parameters' => [
'<SsmDocumentParameterName>' => [
[
'parameterName' => '<string>',
'parameterType' => 'STRING',
],
// ...
],
// ...
],
'ssmDocumentName' => '<string>',
'timeoutSeconds' => <integer>,
],
'ssmDocumentType' => 'AUTOMATION|COMMAND',
],
// ...
],
'ssmAgentDiscoveryDatetime' => '<string>',
],
'sourceServerID' => '<string>',
],
// ...
],
'status' => 'PENDING|STARTED|COMPLETED',
'tags' => ['<string>', ...],
'type' => 'LAUNCH|TERMINATE',
],
]
Result Details
Members
- job
-
- Type: Job structure
Start Test Job response.
Errors
-
UninitializedAccountException:
Uninitialized account exception.
-
Validate exception.
-
The request could not be completed due to a conflict with the current state of the target resource.
TagResource
$result = $client->tagResource([/* ... */]); $promise = $client->tagResourceAsync([/* ... */]);
Adds or overwrites only the specified tags for the specified Application Migration Service resource or resources. When you specify an existing tag key, the value is overwritten with the new value. Each resource can have a maximum of 50 tags. Each tag consists of a key and optional value.
Parameter Syntax
$result = $client->tagResource([
'resourceArn' => '<string>', // REQUIRED
'tags' => ['<string>', ...], // REQUIRED
]);
Parameter Details
Members
- resourceArn
-
- Required: Yes
- Type: string
Tag resource by ARN.
- tags
-
- Required: Yes
- Type: Associative array of custom strings keys (TagKey) to strings
Tag resource by Tags.
Result Syntax
[]
Result Details
Errors
-
Resource not found exception.
-
Reached throttling quota exception.
-
Validate exception.
-
Operating denied due to a file permission or access check error.
-
The server encountered an unexpected condition that prevented it from fulfilling the request.
TerminateTargetInstances
$result = $client->terminateTargetInstances([/* ... */]); $promise = $client->terminateTargetInstancesAsync([/* ... */]);
Starts a job that terminates specific launched EC2 Test and Cutover instances. This command will not work for any Source Server with a lifecycle.state of TESTING, CUTTING_OVER, or CUTOVER.
Parameter Syntax
$result = $client->terminateTargetInstances([
'sourceServerIDs' => ['<string>', ...], // REQUIRED
'tags' => ['<string>', ...],
]);
Parameter Details
Members
- sourceServerIDs
-
- Required: Yes
- Type: Array of strings
Terminate Target instance by Source Server IDs.
- tags
-
- Type: Associative array of custom strings keys (TagKey) to strings
Terminate Target instance by Tags.
Result Syntax
[
'job' => [
'arn' => '<string>',
'creationDateTime' => '<string>',
'endDateTime' => '<string>',
'initiatedBy' => 'START_TEST|START_CUTOVER|DIAGNOSTIC|TERMINATE',
'jobID' => '<string>',
'participatingServers' => [
[
'launchStatus' => 'PENDING|IN_PROGRESS|LAUNCHED|FAILED|TERMINATED',
'launchedEc2InstanceID' => '<string>',
'postLaunchActionsStatus' => [
'postLaunchActionsLaunchStatusList' => [
[
'executionID' => '<string>',
'executionStatus' => 'IN_PROGRESS|SUCCESS|FAILED',
'failureReason' => '<string>',
'ssmDocument' => [
'actionName' => '<string>',
'externalParameters' => [
'<SsmDocumentParameterName>' => [
'dynamicPath' => '<string>',
],
// ...
],
'mustSucceedForCutover' => true || false,
'parameters' => [
'<SsmDocumentParameterName>' => [
[
'parameterName' => '<string>',
'parameterType' => 'STRING',
],
// ...
],
// ...
],
'ssmDocumentName' => '<string>',
'timeoutSeconds' => <integer>,
],
'ssmDocumentType' => 'AUTOMATION|COMMAND',
],
// ...
],
'ssmAgentDiscoveryDatetime' => '<string>',
],
'sourceServerID' => '<string>',
],
// ...
],
'status' => 'PENDING|STARTED|COMPLETED',
'tags' => ['<string>', ...],
'type' => 'LAUNCH|TERMINATE',
],
]
Result Details
Members
- job
-
- Type: Job structure
Terminate Target instance Job response.
Errors
-
UninitializedAccountException:
Uninitialized account exception.
-
Validate exception.
-
The request could not be completed due to a conflict with the current state of the target resource.
UnarchiveApplication
$result = $client->unarchiveApplication([/* ... */]); $promise = $client->unarchiveApplicationAsync([/* ... */]);
Unarchive application.
Parameter Syntax
$result = $client->unarchiveApplication([
'applicationID' => '<string>', // REQUIRED
]);
Parameter Details
Members
- applicationID
-
- Required: Yes
- Type: string
Application ID.
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
Members
- applicationAggregatedStatus
-
- Type: ApplicationAggregatedStatus structure
Application aggregated status.
- applicationID
-
- Type: string
Application ID.
- arn
-
- Type: string
Application ARN.
- creationDateTime
-
- Type: string
Application creation dateTime.
- description
-
- Type: string
Application description.
- isArchived
-
- Type: boolean
Application archival status.
- lastModifiedDateTime
-
- Type: string
Application last modified dateTime.
- name
-
- Type: string
Application name.
- tags
-
- Type: Associative array of custom strings keys (TagKey) to strings
Application tags.
- waveID
-
- Type: string
Application wave ID.
Errors
-
UninitializedAccountException:
Uninitialized account exception.
-
Resource not found exception.
-
ServiceQuotaExceededException:
The request could not be completed because its exceeded the service quota.
UnarchiveWave
$result = $client->unarchiveWave([/* ... */]); $promise = $client->unarchiveWaveAsync([/* ... */]);
Unarchive wave.
Parameter Syntax
$result = $client->unarchiveWave([
'waveID' => '<string>', // REQUIRED
]);
Parameter Details
Members
- waveID
-
- Required: Yes
- Type: string
Wave ID.
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
Members
- arn
-
- Type: string
Wave ARN.
- creationDateTime
-
- Type: string
Wave creation dateTime.
- description
-
- Type: string
Wave description.
- isArchived
-
- Type: boolean
Wave archival status.
- lastModifiedDateTime
-
- Type: string
Wave last modified dateTime.
- name
-
- Type: string
Wave name.
- tags
-
- Type: Associative array of custom strings keys (TagKey) to strings
Wave tags.
- waveAggregatedStatus
-
- Type: WaveAggregatedStatus structure
Wave aggregated status.
- waveID
-
- Type: string
Wave ID.
Errors
-
UninitializedAccountException:
Uninitialized account exception.
-
Resource not found exception.
-
ServiceQuotaExceededException:
The request could not be completed because its exceeded the service quota.
UntagResource
$result = $client->untagResource([/* ... */]); $promise = $client->untagResourceAsync([/* ... */]);
Deletes the specified set of tags from the specified set of Application Migration Service resources.
Parameter Syntax
$result = $client->untagResource([
'resourceArn' => '<string>', // REQUIRED
'tagKeys' => ['<string>', ...], // REQUIRED
]);
Parameter Details
Members
- resourceArn
-
- Required: Yes
- Type: string
Untag resource by ARN.
- tagKeys
-
- Required: Yes
- Type: Array of strings
Untag resource by Keys.
Result Syntax
[]
Result Details
Errors
-
Resource not found exception.
-
Reached throttling quota exception.
-
Validate exception.
-
Operating denied due to a file permission or access check error.
-
The server encountered an unexpected condition that prevented it from fulfilling the request.
UpdateApplication
$result = $client->updateApplication([/* ... */]); $promise = $client->updateApplicationAsync([/* ... */]);
Update application.
Parameter Syntax
$result = $client->updateApplication([
'applicationID' => '<string>', // REQUIRED
'description' => '<string>',
'name' => '<string>',
]);
Parameter Details
Members
- applicationID
-
- Required: Yes
- Type: string
Application ID.
- description
-
- Type: string
Application description.
- name
-
- Type: string
Application name.
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
Members
- applicationAggregatedStatus
-
- Type: ApplicationAggregatedStatus structure
Application aggregated status.
- applicationID
-
- Type: string
Application ID.
- arn
-
- Type: string
Application ARN.
- creationDateTime
-
- Type: string
Application creation dateTime.
- description
-
- Type: string
Application description.
- isArchived
-
- Type: boolean
Application archival status.
- lastModifiedDateTime
-
- Type: string
Application last modified dateTime.
- name
-
- Type: string
Application name.
- tags
-
- Type: Associative array of custom strings keys (TagKey) to strings
Application tags.
- waveID
-
- Type: string
Application wave ID.
Errors
-
UninitializedAccountException:
Uninitialized account exception.
-
Resource not found exception.
-
The request could not be completed due to a conflict with the current state of the target resource.
UpdateLaunchConfiguration
$result = $client->updateLaunchConfiguration([/* ... */]); $promise = $client->updateLaunchConfigurationAsync([/* ... */]);
Updates multiple LaunchConfigurations by Source Server ID.
Parameter Syntax
$result = $client->updateLaunchConfiguration([
'bootMode' => 'LEGACY_BIOS|UEFI',
'copyPrivateIp' => true || false,
'copyTags' => true || false,
'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>', // REQUIRED
'externalParameters' => [
'<SsmDocumentParameterName>' => [
'dynamicPath' => '<string>',
],
// ...
],
'mustSucceedForCutover' => true || false,
'parameters' => [
'<SsmDocumentParameterName>' => [
[
'parameterName' => '<string>', // REQUIRED
'parameterType' => 'STRING', // REQUIRED
],
// ...
],
// ...
],
'ssmDocumentName' => '<string>', // REQUIRED
'timeoutSeconds' => <integer>,
],
// ...
],
],
'sourceServerID' => '<string>', // REQUIRED
'targetInstanceTypeRightSizingMethod' => 'NONE|BASIC',
]);
Parameter Details
Members
- bootMode
-
- Type: string
Update Launch configuration boot mode request.
- copyPrivateIp
-
- Type: boolean
Update Launch configuration copy Private IP request.
- copyTags
-
- Type: boolean
Update Launch configuration copy Tags request.
- enableMapAutoTagging
-
- Type: boolean
Enable map auto tagging.
- launchDisposition
-
- Type: string
Update Launch configuration launch disposition request.
- licensing
-
- Type: Licensing structure
Update Launch configuration licensing request.
- mapAutoTaggingMpeID
-
- Type: string
Launch configuration map auto tagging MPE ID.
- name
-
- Type: string
Update Launch configuration name request.
- postLaunchActions
-
- Type: PostLaunchActions structure
Post Launch Actions to executed on the Test or Cutover instance.
- sourceServerID
-
- Required: Yes
- Type: string
Update Launch configuration by Source Server ID request.
- targetInstanceTypeRightSizingMethod
-
- Type: string
Update Launch configuration Target instance right sizing request.
Result Syntax
[
'bootMode' => 'LEGACY_BIOS|UEFI',
'copyPrivateIp' => true || false,
'copyTags' => true || false,
'ec2LaunchTemplateID' => '<string>',
'enableMapAutoTagging' => true || false,
'launchDisposition' => 'STOPPED|STARTED',
'licensing' => [
'osByol' => true || false,
],
'mapAutoTaggingMpeID' => '<string>',
'name' => '<string>',
'postLaunchActions' => [
'cloudWatchLogGroupName' => '<string>',
'deployment' => 'TEST_AND_CUTOVER|CUTOVER_ONLY|TEST_ONLY',
's3LogBucket' => '<string>',
's3OutputKeyPrefix' => '<string>',
'ssmDocuments' => [
[
'actionName' => '<string>',
'externalParameters' => [
'<SsmDocumentParameterName>' => [
'dynamicPath' => '<string>',
],
// ...
],
'mustSucceedForCutover' => true || false,
'parameters' => [
'<SsmDocumentParameterName>' => [
[
'parameterName' => '<string>',
'parameterType' => 'STRING',
],
// ...
],
// ...
],
'ssmDocumentName' => '<string>',
'timeoutSeconds' => <integer>,
],
// ...
],
],
'sourceServerID' => '<string>',
'targetInstanceTypeRightSizingMethod' => 'NONE|BASIC',
]
Result Details
Members
- bootMode
-
- Type: string
Launch configuration boot mode.
- copyPrivateIp
-
- Type: boolean
Copy Private IP during Launch Configuration.
- copyTags
-
- Type: boolean
Copy Tags during Launch Configuration.
- ec2LaunchTemplateID
-
- Type: string
Launch configuration EC2 Launch template ID.
- enableMapAutoTagging
-
- Type: boolean
Enable map auto tagging.
- launchDisposition
-
- Type: string
Launch disposition for launch configuration.
- licensing
-
- Type: Licensing structure
Launch configuration OS licensing.
- mapAutoTaggingMpeID
-
- Type: string
Map auto tagging MPE ID.
- name
-
- Type: string
Launch configuration name.
- postLaunchActions
-
- Type: PostLaunchActions structure
Post Launch Actions to executed on the Test or Cutover instance.
- sourceServerID
-
- Type: string
Launch configuration Source Server ID.
- targetInstanceTypeRightSizingMethod
-
- Type: string
Launch configuration Target instance type right sizing method.
Errors
-
UninitializedAccountException:
Uninitialized account exception.
-
Resource not found exception.
-
Validate exception.
-
The request could not be completed due to a conflict with the current state of the target resource.
UpdateLaunchConfigurationTemplate
$result = $client->updateLaunchConfigurationTemplate([/* ... */]); $promise = $client->updateLaunchConfigurationTemplateAsync([/* ... */]);
Updates an existing Launch Configuration Template by ID.
Parameter Syntax
$result = $client->updateLaunchConfigurationTemplate([
'associatePublicIpAddress' => true || false,
'bootMode' => 'LEGACY_BIOS|UEFI',
'copyPrivateIp' => true || false,
'copyTags' => true || false,
'enableMapAutoTagging' => true || false,
'largeVolumeConf' => [
'iops' => <integer>,
'throughput' => <integer>,
'volumeType' => 'io1|io2|gp3|gp2|st1|sc1|standard',
],
'launchConfigurationTemplateID' => '<string>', // REQUIRED
'launchDisposition' => 'STOPPED|STARTED',
'licensing' => [
'osByol' => true || false,
],
'mapAutoTaggingMpeID' => '<string>',
'postLaunchActions' => [
'cloudWatchLogGroupName' => '<string>',
'deployment' => 'TEST_AND_CUTOVER|CUTOVER_ONLY|TEST_ONLY',
's3LogBucket' => '<string>',
's3OutputKeyPrefix' => '<string>',
'ssmDocuments' => [
[
'actionName' => '<string>', // REQUIRED
'externalParameters' => [
'<SsmDocumentParameterName>' => [
'dynamicPath' => '<string>',
],
// ...
],
'mustSucceedForCutover' => true || false,
'parameters' => [
'<SsmDocumentParameterName>' => [
[
'parameterName' => '<string>', // REQUIRED
'parameterType' => 'STRING', // REQUIRED
],
// ...
],
// ...
],
'ssmDocumentName' => '<string>', // REQUIRED
'timeoutSeconds' => <integer>,
],
// ...
],
],
'smallVolumeConf' => [
'iops' => <integer>,
'throughput' => <integer>,
'volumeType' => 'io1|io2|gp3|gp2|st1|sc1|standard',
],
'smallVolumeMaxSize' => <integer>,
'targetInstanceTypeRightSizingMethod' => 'NONE|BASIC',
]);
Parameter Details
Members
- associatePublicIpAddress
-
- Type: boolean
Associate public Ip address.
- bootMode
-
- Type: string
Launch configuration template boot mode.
- copyPrivateIp
-
- Type: boolean
Copy private Ip.
- copyTags
-
- Type: boolean
Copy tags.
- enableMapAutoTagging
-
- Type: boolean
Enable map auto tagging.
- largeVolumeConf
-
- Type: LaunchTemplateDiskConf structure
Large volume config.
- launchConfigurationTemplateID
-
- Required: Yes
- Type: string
Launch Configuration Template ID.
- launchDisposition
-
- Type: string
Launch disposition.
- licensing
-
- Type: Licensing structure
Configure Licensing.
- mapAutoTaggingMpeID
-
- Type: string
Launch configuration template map auto tagging MPE ID.
- postLaunchActions
-
- Type: PostLaunchActions structure
Post Launch Action to execute on the Test or Cutover instance.
- smallVolumeConf
-
- Type: LaunchTemplateDiskConf structure
Small volume config.
- smallVolumeMaxSize
-
- Type: long (int|float)
Small volume maximum size.
- targetInstanceTypeRightSizingMethod
-
- Type: string
Target instance type right-sizing method.
Result Syntax
[
'arn' => '<string>',
'associatePublicIpAddress' => true || false,
'bootMode' => 'LEGACY_BIOS|UEFI',
'copyPrivateIp' => true || false,
'copyTags' => true || false,
'ec2LaunchTemplateID' => '<string>',
'enableMapAutoTagging' => true || false,
'largeVolumeConf' => [
'iops' => <integer>,
'throughput' => <integer>,
'volumeType' => 'io1|io2|gp3|gp2|st1|sc1|standard',
],
'launchConfigurationTemplateID' => '<string>',
'launchDisposition' => 'STOPPED|STARTED',
'licensing' => [
'osByol' => true || false,
],
'mapAutoTaggingMpeID' => '<string>',
'postLaunchActions' => [
'cloudWatchLogGroupName' => '<string>',
'deployment' => 'TEST_AND_CUTOVER|CUTOVER_ONLY|TEST_ONLY',
's3LogBucket' => '<string>',
's3OutputKeyPrefix' => '<string>',
'ssmDocuments' => [
[
'actionName' => '<string>',
'externalParameters' => [
'<SsmDocumentParameterName>' => [
'dynamicPath' => '<string>',
],
// ...
],
'mustSucceedForCutover' => true || false,
'parameters' => [
'<SsmDocumentParameterName>' => [
[
'parameterName' => '<string>',
'parameterType' => 'STRING',
],
// ...
],
// ...
],
'ssmDocumentName' => '<string>',
'timeoutSeconds' => <integer>,
],
// ...
],
],
'smallVolumeConf' => [
'iops' => <integer>,
'throughput' => <integer>,
'volumeType' => 'io1|io2|gp3|gp2|st1|sc1|standard',
],
'smallVolumeMaxSize' => <integer>,
'tags' => ['<string>', ...],
'targetInstanceTypeRightSizingMethod' => 'NONE|BASIC',
]
Result Details
Members
- arn
-
- Type: string
ARN of the Launch Configuration Template.
- associatePublicIpAddress
-
- Type: boolean
Associate public Ip address.
- bootMode
-
- Type: string
Launch configuration template boot mode.
- copyPrivateIp
-
- Type: boolean
Copy private Ip.
- copyTags
-
- Type: boolean
Copy tags.
- ec2LaunchTemplateID
-
- Type: string
EC2 launch template ID.
- enableMapAutoTagging
-
- Type: boolean
Enable map auto tagging.
- largeVolumeConf
-
- Type: LaunchTemplateDiskConf structure
Large volume config.
- launchConfigurationTemplateID
-
- Required: Yes
- Type: string
ID of the Launch Configuration Template.
- launchDisposition
-
- Type: string
Launch disposition.
- licensing
-
- Type: Licensing structure
Configure Licensing.
- mapAutoTaggingMpeID
-
- Type: string
Launch configuration template map auto tagging MPE ID.
- postLaunchActions
-
- Type: PostLaunchActions structure
Post Launch Actions of the Launch Configuration Template.
- smallVolumeConf
-
- Type: LaunchTemplateDiskConf structure
Small volume config.
- smallVolumeMaxSize
-
- Type: long (int|float)
Small volume maximum size.
- tags
-
- Type: Associative array of custom strings keys (TagKey) to strings
Tags of the Launch Configuration Template.
- targetInstanceTypeRightSizingMethod
-
- Type: string
Target instance type right-sizing method.
Errors
-
UninitializedAccountException:
Uninitialized account exception.
-
Resource not found exception.
-
Validate exception.
-
Operating denied due to a file permission or access check error.
UpdateReplicationConfiguration
$result = $client->updateReplicationConfiguration([/* ... */]); $promise = $client->updateReplicationConfigurationAsync([/* ... */]);
Allows you to update multiple ReplicationConfigurations by Source Server ID.
Parameter Syntax
$result = $client->updateReplicationConfiguration([
'associateDefaultSecurityGroup' => true || false,
'bandwidthThrottling' => <integer>,
'createPublicIP' => true || false,
'dataPlaneRouting' => 'PRIVATE_IP|PUBLIC_IP',
'defaultLargeStagingDiskType' => 'GP2|ST1|GP3',
'ebsEncryption' => 'DEFAULT|CUSTOM',
'ebsEncryptionKeyArn' => '<string>',
'name' => '<string>',
'replicatedDisks' => [
[
'deviceName' => '<string>',
'iops' => <integer>,
'isBootDisk' => true || false,
'stagingDiskType' => 'AUTO|GP2|IO1|SC1|ST1|STANDARD|GP3|IO2',
'throughput' => <integer>,
],
// ...
],
'replicationServerInstanceType' => '<string>',
'replicationServersSecurityGroupsIDs' => ['<string>', ...],
'sourceServerID' => '<string>', // REQUIRED
'stagingAreaSubnetId' => '<string>',
'stagingAreaTags' => ['<string>', ...],
'useDedicatedReplicationServer' => true || false,
]);
Parameter Details
Members
- associateDefaultSecurityGroup
-
- Type: boolean
Update replication configuration associate default Application Migration Service Security group request.
- bandwidthThrottling
-
- Type: long (int|float)
Update replication configuration bandwidth throttling request.
- createPublicIP
-
- Type: boolean
Update replication configuration create Public IP request.
- dataPlaneRouting
-
- Type: string
Update replication configuration data plane routing request.
- defaultLargeStagingDiskType
-
- Type: string
Update replication configuration use default large Staging Disk type request.
- ebsEncryption
-
- Type: string
Update replication configuration EBS encryption request.
- ebsEncryptionKeyArn
-
- Type: string
Update replication configuration EBS encryption key ARN request.
- name
-
- Type: string
Update replication configuration name request.
- replicatedDisks
-
- Type: Array of ReplicationConfigurationReplicatedDisk structures
Update replication configuration replicated disks request.
- replicationServerInstanceType
-
- Type: string
Update replication configuration Replication Server instance type request.
- replicationServersSecurityGroupsIDs
-
- Type: Array of strings
Update replication configuration Replication Server Security Groups IDs request.
- sourceServerID
-
- Required: Yes
- Type: string
Update replication configuration Source Server ID request.
- stagingAreaSubnetId
-
- Type: string
Update replication configuration Staging Area subnet request.
- stagingAreaTags
-
- Type: Associative array of custom strings keys (TagKey) to strings
Update replication configuration Staging Area Tags request.
- useDedicatedReplicationServer
-
- Type: boolean
Update replication configuration use dedicated Replication Server request.
Result Syntax
[
'associateDefaultSecurityGroup' => true || false,
'bandwidthThrottling' => <integer>,
'createPublicIP' => true || false,
'dataPlaneRouting' => 'PRIVATE_IP|PUBLIC_IP',
'defaultLargeStagingDiskType' => 'GP2|ST1|GP3',
'ebsEncryption' => 'DEFAULT|CUSTOM',
'ebsEncryptionKeyArn' => '<string>',
'name' => '<string>',
'replicatedDisks' => [
[
'deviceName' => '<string>',
'iops' => <integer>,
'isBootDisk' => true || false,
'stagingDiskType' => 'AUTO|GP2|IO1|SC1|ST1|STANDARD|GP3|IO2',
'throughput' => <integer>,
],
// ...
],
'replicationServerInstanceType' => '<string>',
'replicationServersSecurityGroupsIDs' => ['<string>', ...],
'sourceServerID' => '<string>',
'stagingAreaSubnetId' => '<string>',
'stagingAreaTags' => ['<string>', ...],
'useDedicatedReplicationServer' => true || false,
]
Result Details
Members
- associateDefaultSecurityGroup
-
- Type: boolean
Replication Configuration associate default Application Migration Service Security Group.
- bandwidthThrottling
-
- Type: long (int|float)
Replication Configuration set bandwidth throttling.
- createPublicIP
-
- Type: boolean
Replication Configuration create Public IP.
- dataPlaneRouting
-
- Type: string
Replication Configuration data plane routing.
- defaultLargeStagingDiskType
-
- Type: string
Replication Configuration use default large Staging Disks.
- ebsEncryption
-
- Type: string
Replication Configuration EBS encryption.
- ebsEncryptionKeyArn
-
- Type: string
Replication Configuration EBS encryption key ARN.
- name
-
- Type: string
Replication Configuration name.
- replicatedDisks
-
- Type: Array of ReplicationConfigurationReplicatedDisk structures
Replication Configuration replicated disks.
- replicationServerInstanceType
-
- Type: string
Replication Configuration Replication Server instance type.
- replicationServersSecurityGroupsIDs
-
- Type: Array of strings
Replication Configuration Replication Server Security Group IDs.
- sourceServerID
-
- Type: string
Replication Configuration Source Server ID.
- stagingAreaSubnetId
-
- Type: string
Replication Configuration Staging Area subnet ID.
- stagingAreaTags
-
- Type: Associative array of custom strings keys (TagKey) to strings
Replication Configuration Staging Area tags.
- useDedicatedReplicationServer
-
- Type: boolean
Replication Configuration use Dedicated Replication Server.
Errors
-
UninitializedAccountException:
Uninitialized account exception.
-
Resource not found exception.
-
Validate exception.
-
Operating denied due to a file permission or access check error.
-
The request could not be completed due to a conflict with the current state of the target resource.
UpdateReplicationConfigurationTemplate
$result = $client->updateReplicationConfigurationTemplate([/* ... */]); $promise = $client->updateReplicationConfigurationTemplateAsync([/* ... */]);
Updates multiple ReplicationConfigurationTemplates by ID.
Parameter Syntax
$result = $client->updateReplicationConfigurationTemplate([
'arn' => '<string>',
'associateDefaultSecurityGroup' => true || false,
'bandwidthThrottling' => <integer>,
'createPublicIP' => true || false,
'dataPlaneRouting' => 'PRIVATE_IP|PUBLIC_IP',
'defaultLargeStagingDiskType' => 'GP2|ST1|GP3',
'ebsEncryption' => 'DEFAULT|CUSTOM',
'ebsEncryptionKeyArn' => '<string>',
'replicationConfigurationTemplateID' => '<string>', // REQUIRED
'replicationServerInstanceType' => '<string>',
'replicationServersSecurityGroupsIDs' => ['<string>', ...],
'stagingAreaSubnetId' => '<string>',
'stagingAreaTags' => ['<string>', ...],
'useDedicatedReplicationServer' => true || false,
]);
Parameter Details
Members
- arn
-
- Type: string
Update replication configuration template ARN request.
- associateDefaultSecurityGroup
-
- Type: boolean
Update replication configuration template associate default Application Migration Service Security group request.
- bandwidthThrottling
-
- Type: long (int|float)
Update replication configuration template bandwidth throttling request.
- createPublicIP
-
- Type: boolean
Update replication configuration template create Public IP request.
- dataPlaneRouting
-
- Type: string
Update replication configuration template data plane routing request.
- defaultLargeStagingDiskType
-
- Type: string
Update replication configuration template use default large Staging Disk type request.
- ebsEncryption
-
- Type: string
Update replication configuration template EBS encryption request.
- ebsEncryptionKeyArn
-
- Type: string
Update replication configuration template EBS encryption key ARN request.
- replicationConfigurationTemplateID
-
- Required: Yes
- Type: string
Update replication configuration template template ID request.
- replicationServerInstanceType
-
- Type: string
Update replication configuration template Replication Server instance type request.
- replicationServersSecurityGroupsIDs
-
- Type: Array of strings
Update replication configuration template Replication Server Security groups IDs request.
- stagingAreaSubnetId
-
- Type: string
Update replication configuration template Staging Area subnet ID request.
- stagingAreaTags
-
- Type: Associative array of custom strings keys (TagKey) to strings
Update replication configuration template Staging Area Tags request.
- useDedicatedReplicationServer
-
- Type: boolean
Update replication configuration template use dedicated Replication Server request.
Result Syntax
[
'arn' => '<string>',
'associateDefaultSecurityGroup' => true || false,
'bandwidthThrottling' => <integer>,
'createPublicIP' => true || false,
'dataPlaneRouting' => 'PRIVATE_IP|PUBLIC_IP',
'defaultLargeStagingDiskType' => 'GP2|ST1|GP3',
'ebsEncryption' => 'DEFAULT|CUSTOM',
'ebsEncryptionKeyArn' => '<string>',
'replicationConfigurationTemplateID' => '<string>',
'replicationServerInstanceType' => '<string>',
'replicationServersSecurityGroupsIDs' => ['<string>', ...],
'stagingAreaSubnetId' => '<string>',
'stagingAreaTags' => ['<string>', ...],
'tags' => ['<string>', ...],
'useDedicatedReplicationServer' => true || false,
]
Result Details
Members
- arn
-
- Type: string
Replication Configuration template ARN.
- associateDefaultSecurityGroup
-
- Type: boolean
Replication Configuration template associate default Application Migration Service Security group.
- bandwidthThrottling
-
- Type: long (int|float)
Replication Configuration template bandwidth throttling.
- createPublicIP
-
- Type: boolean
Replication Configuration template create Public IP.
- dataPlaneRouting
-
- Type: string
Replication Configuration template data plane routing.
- defaultLargeStagingDiskType
-
- Type: string
Replication Configuration template use default large Staging Disk type.
- ebsEncryption
-
- Type: string
Replication Configuration template EBS encryption.
- ebsEncryptionKeyArn
-
- Type: string
Replication Configuration template EBS encryption key ARN.
- replicationConfigurationTemplateID
-
- Required: Yes
- Type: string
Replication Configuration template ID.
- replicationServerInstanceType
-
- Type: string
Replication Configuration template server instance type.
- replicationServersSecurityGroupsIDs
-
- Type: Array of strings
Replication Configuration template server Security Groups IDs.
- stagingAreaSubnetId
-
- Type: string
Replication Configuration template Staging Area subnet ID.
- stagingAreaTags
-
- Type: Associative array of custom strings keys (TagKey) to strings
Replication Configuration template Staging Area Tags.
- tags
-
- Type: Associative array of custom strings keys (TagKey) to strings
Replication Configuration template Tags.
- useDedicatedReplicationServer
-
- Type: boolean
Replication Configuration template use Dedicated Replication Server.
Errors
-
UninitializedAccountException:
Uninitialized account exception.
-
Resource not found exception.
-
Validate exception.
-
Operating denied due to a file permission or access check error.
UpdateSourceServerReplicationType
$result = $client->updateSourceServerReplicationType([/* ... */]); $promise = $client->updateSourceServerReplicationTypeAsync([/* ... */]);
Allows you to change between the AGENT_BASED replication type and the SNAPSHOT_SHIPPING replication type.
Parameter Syntax
$result = $client->updateSourceServerReplicationType([
'replicationType' => 'AGENT_BASED|SNAPSHOT_SHIPPING', // REQUIRED
'sourceServerID' => '<string>', // REQUIRED
]);
Parameter Details
Members
- replicationType
-
- Required: Yes
- Type: string
Replication type to which to update source server.
- sourceServerID
-
- Required: Yes
- Type: string
ID of source server on which to update replication type.
Result Syntax
[
'applicationID' => '<string>',
'arn' => '<string>',
'dataReplicationInfo' => [
'dataReplicationError' => [
'error' => 'AGENT_NOT_SEEN|SNAPSHOTS_FAILURE|NOT_CONVERGING|UNSTABLE_NETWORK|FAILED_TO_CREATE_SECURITY_GROUP|FAILED_TO_LAUNCH_REPLICATION_SERVER|FAILED_TO_BOOT_REPLICATION_SERVER|FAILED_TO_AUTHENTICATE_WITH_SERVICE|FAILED_TO_DOWNLOAD_REPLICATION_SOFTWARE|FAILED_TO_CREATE_STAGING_DISKS|FAILED_TO_ATTACH_STAGING_DISKS|FAILED_TO_PAIR_REPLICATION_SERVER_WITH_AGENT|FAILED_TO_CONNECT_AGENT_TO_REPLICATION_SERVER|FAILED_TO_START_DATA_TRANSFER|UNSUPPORTED_VM_CONFIGURATION|LAST_SNAPSHOT_JOB_FAILED',
'rawError' => '<string>',
],
'dataReplicationInitiation' => [
'nextAttemptDateTime' => '<string>',
'startDateTime' => '<string>',
'steps' => [
[
'name' => 'WAIT|CREATE_SECURITY_GROUP|LAUNCH_REPLICATION_SERVER|BOOT_REPLICATION_SERVER|AUTHENTICATE_WITH_SERVICE|DOWNLOAD_REPLICATION_SOFTWARE|CREATE_STAGING_DISKS|ATTACH_STAGING_DISKS|PAIR_REPLICATION_SERVER_WITH_AGENT|CONNECT_AGENT_TO_REPLICATION_SERVER|START_DATA_TRANSFER',
'status' => 'NOT_STARTED|IN_PROGRESS|SUCCEEDED|FAILED|SKIPPED',
],
// ...
],
],
'dataReplicationState' => 'STOPPED|INITIATING|INITIAL_SYNC|BACKLOG|CREATING_SNAPSHOT|CONTINUOUS|PAUSED|RESCAN|STALLED|DISCONNECTED|PENDING_SNAPSHOT_SHIPPING|SHIPPING_SNAPSHOT',
'etaDateTime' => '<string>',
'lagDuration' => '<string>',
'lastSnapshotDateTime' => '<string>',
'replicatedDisks' => [
[
'backloggedStorageBytes' => <integer>,
'deviceName' => '<string>',
'replicatedStorageBytes' => <integer>,
'rescannedStorageBytes' => <integer>,
'totalStorageBytes' => <integer>,
],
// ...
],
],
'fqdnForActionFramework' => '<string>',
'isArchived' => true || false,
'launchedInstance' => [
'ec2InstanceID' => '<string>',
'firstBoot' => 'WAITING|SUCCEEDED|UNKNOWN|STOPPED',
'jobID' => '<string>',
],
'lifeCycle' => [
'addedToServiceDateTime' => '<string>',
'elapsedReplicationDuration' => '<string>',
'firstByteDateTime' => '<string>',
'lastCutover' => [
'finalized' => [
'apiCallDateTime' => '<string>',
],
'initiated' => [
'apiCallDateTime' => '<string>',
'jobID' => '<string>',
],
'reverted' => [
'apiCallDateTime' => '<string>',
],
],
'lastSeenByServiceDateTime' => '<string>',
'lastTest' => [
'finalized' => [
'apiCallDateTime' => '<string>',
],
'initiated' => [
'apiCallDateTime' => '<string>',
'jobID' => '<string>',
],
'reverted' => [
'apiCallDateTime' => '<string>',
],
],
'state' => 'STOPPED|NOT_READY|READY_FOR_TEST|TESTING|READY_FOR_CUTOVER|CUTTING_OVER|CUTOVER|DISCONNECTED|DISCOVERED|PENDING_INSTALLATION',
],
'replicationType' => 'AGENT_BASED|SNAPSHOT_SHIPPING',
'sourceProperties' => [
'cpus' => [
[
'cores' => <integer>,
'modelName' => '<string>',
],
// ...
],
'disks' => [
[
'bytes' => <integer>,
'deviceName' => '<string>',
],
// ...
],
'identificationHints' => [
'awsInstanceID' => '<string>',
'fqdn' => '<string>',
'hostname' => '<string>',
'vmPath' => '<string>',
'vmWareUuid' => '<string>',
],
'lastUpdatedDateTime' => '<string>',
'networkInterfaces' => [
[
'ips' => ['<string>', ...],
'isPrimary' => true || false,
'macAddress' => '<string>',
],
// ...
],
'os' => [
'fullString' => '<string>',
],
'ramBytes' => <integer>,
'recommendedInstanceType' => '<string>',
],
'sourceServerID' => '<string>',
'tags' => ['<string>', ...],
'userProvidedID' => '<string>',
'vcenterClientID' => '<string>',
]
Result Details
Members
- applicationID
-
- Type: string
Source server application ID.
- arn
-
- Type: string
Source server ARN.
- dataReplicationInfo
-
- Type: DataReplicationInfo structure
Source server data replication info.
- fqdnForActionFramework
-
- Type: string
Source server fqdn for action framework.
- isArchived
-
- Type: boolean
Source server archived status.
- launchedInstance
-
- Type: LaunchedInstance structure
Source server launched instance.
- lifeCycle
-
- Type: LifeCycle structure
Source server lifecycle state.
- replicationType
-
- Type: string
Source server replication type.
- sourceProperties
-
- Type: SourceProperties structure
Source server properties.
- sourceServerID
-
- Type: string
Source server ID.
- tags
-
- Type: Associative array of custom strings keys (TagKey) to strings
Source server Tags.
- userProvidedID
-
- Type: string
Source server user provided ID.
- vcenterClientID
-
- Type: string
Source server vCenter client id.
Errors
-
UninitializedAccountException:
Uninitialized account exception.
-
Resource not found exception.
-
Validate exception.
-
The request could not be completed due to a conflict with the current state of the target resource.
UpdateWave
$result = $client->updateWave([/* ... */]); $promise = $client->updateWaveAsync([/* ... */]);
Update wave.
Parameter Syntax
$result = $client->updateWave([
'description' => '<string>',
'name' => '<string>',
'waveID' => '<string>', // REQUIRED
]);
Parameter Details
Members
- description
-
- Type: string
Wave description.
- name
-
- Type: string
Wave name.
- waveID
-
- Required: Yes
- Type: string
Wave ID.
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
Members
- arn
-
- Type: string
Wave ARN.
- creationDateTime
-
- Type: string
Wave creation dateTime.
- description
-
- Type: string
Wave description.
- isArchived
-
- Type: boolean
Wave archival status.
- lastModifiedDateTime
-
- Type: string
Wave last modified dateTime.
- name
-
- Type: string
Wave name.
- tags
-
- Type: Associative array of custom strings keys (TagKey) to strings
Wave tags.
- waveAggregatedStatus
-
- Type: WaveAggregatedStatus structure
Wave aggregated status.
- waveID
-
- Type: string
Wave ID.
Errors
-
UninitializedAccountException:
Uninitialized account exception.
-
Resource not found exception.
-
The request could not be completed due to a conflict with the current state of the target resource.
Shapes
AccessDeniedException
Description
Operating denied due to a file permission or access check error.
Members
- code
-
- Type: string
- message
-
- Type: string
ApplicationAggregatedStatus
Description
Application aggregated status.
Members
- healthStatus
-
- Type: string
Application aggregated status health status.
- lastUpdateDateTime
-
- Type: string
Application aggregated status last update dateTime.
- progressStatus
-
- Type: string
Application aggregated status progress status.
- totalSourceServers
-
- Type: long (int|float)
Application aggregated status total source servers amount.
CPU
Description
Source server CPU information.
Members
- cores
-
- Type: long (int|float)
The number of CPU cores on the source server.
- modelName
-
- Type: string
The source server's CPU model name.
ChangeServerLifeCycleStateSourceServerLifecycle
Description
The request to change the source server migration lifecycle state.
Members
- state
-
- Required: Yes
- Type: string
The request to change the source server migration lifecycle state.
ConflictException
Description
The request could not be completed due to a conflict with the current state of the target resource.
Members
- code
-
- Type: string
- errors
-
- Type: Array of ErrorDetails structures
Conflict Exception specific errors.
- message
-
- Type: string
- resourceId
-
- Type: string
A conflict occurred when prompting for the Resource ID.
- resourceType
-
- Type: string
A conflict occurred when prompting for resource type.
DataReplicationError
Description
Error in data replication.
Members
- error
-
- Type: string
Error in data replication.
- rawError
-
- Type: string
Error in data replication.
DataReplicationInfo
Description
Request data replication info.
Members
- dataReplicationError
-
- Type: DataReplicationError structure
Error in obtaining data replication info.
- dataReplicationInitiation
-
- Type: DataReplicationInitiation structure
Request to query whether data replication has been initiated.
- dataReplicationState
-
- Type: string
Request to query the data replication state.
- etaDateTime
-
- Type: string
Request to query the time when data replication will be complete.
- lagDuration
-
- Type: string
Request to query data replication lag duration.
- lastSnapshotDateTime
-
- Type: string
Request to query data replication last snapshot time.
- replicatedDisks
-
- Type: Array of DataReplicationInfoReplicatedDisk structures
Request to query disks replicated.
DataReplicationInfoReplicatedDisk
Description
Request to query disks replicated.
Members
- backloggedStorageBytes
-
- Type: long (int|float)
Request to query data replication backlog size in bytes.
- deviceName
-
- Type: string
Request to query device name.
- replicatedStorageBytes
-
- Type: long (int|float)
Request to query amount of data replicated in bytes.
- rescannedStorageBytes
-
- Type: long (int|float)
Request to query amount of data rescanned in bytes.
- totalStorageBytes
-
- Type: long (int|float)
Request to query total amount of data replicated in bytes.
DataReplicationInitiation
Description
Data replication initiation.
Members
- nextAttemptDateTime
-
- Type: string
Request to query next data initiation date and time.
- startDateTime
-
- Type: string
Request to query data initiation start date and time.
- steps
-
- Type: Array of DataReplicationInitiationStep structures
Request to query data initiation steps.
DataReplicationInitiationStep
Description
Data replication initiation step.
Members
- name
-
- Type: string
Request to query data initiation step name.
- status
-
- Type: string
Request to query data initiation status.
DescribeJobsRequestFilters
Description
Request to describe Job log filters.
Members
- fromDate
-
- Type: string
Request to describe Job log filters by date.
- jobIDs
-
- Type: Array of strings
Request to describe Job log filters by job ID.
- toDate
-
- Type: string
Request to describe job log items by last date.
DescribeSourceServersRequestFilters
Description
Request to filter Source Servers list.
Members
- applicationIDs
-
- Type: Array of strings
Request to filter Source Servers list by application IDs.
- isArchived
-
- Type: boolean
Request to filter Source Servers list by archived.
- lifeCycleStates
-
- Type: Array of strings
Request to filter Source Servers list by life cycle states.
- replicationTypes
-
- Type: Array of strings
Request to filter Source Servers list by replication type.
- sourceServerIDs
-
- Type: Array of strings
Request to filter Source Servers list by Source Server ID.
Disk
Description
The disk identifier.
Members
- bytes
-
- Type: long (int|float)
The amount of storage on the disk in bytes.
- deviceName
-
- Type: string
The disk or device name.
ErrorDetails
Description
Error details.
Members
- code
-
- Type: string
Error details code.
- message
-
- Type: string
Error details message.
- resourceId
-
- Type: string
Error details resourceId.
- resourceType
-
- Type: string
Error details resourceType.
ExportErrorData
Description
Export errors data.
Members
- rawError
-
- Type: string
Export errors data raw error.
ExportTask
Description
Export task.
Members
- creationDateTime
-
- Type: string
Export task creation datetime.
- endDateTime
-
- Type: string
Export task end datetime.
- exportID
-
- Type: string
Export task id.
- progressPercentage
-
- Type: float
Export task progress percentage.
- s3Bucket
-
- Type: string
Export task s3 bucket.
- s3BucketOwner
-
- Type: string
Export task s3 bucket owner.
- s3Key
-
- Type: string
Export task s3 key.
- status
-
- Type: string
Export task status.
- summary
-
- Type: ExportTaskSummary structure
Export task summary.
ExportTaskError
Description
Export task error.
Members
- errorData
-
- Type: ExportErrorData structure
Export task error data.
- errorDateTime
-
- Type: string
Export task error datetime.
ExportTaskSummary
Description
Export task summary.
Members
- applicationsCount
-
- Type: long (int|float)
Export task summary applications count.
- serversCount
-
- Type: long (int|float)
Export task summary servers count.
- wavesCount
-
- Type: long (int|float)
Export task summary waves count.
IdentificationHints
Description
Identification hints.
Members
- awsInstanceID
-
- Type: string
AWS Instance ID identification hint.
- fqdn
-
- Type: string
FQDN address identification hint.
- hostname
-
- Type: string
Hostname identification hint.
- vmPath
-
- Type: string
vCenter VM path identification hint.
- vmWareUuid
-
- Type: string
vmWare UUID identification hint.
ImportErrorData
Description
Import error data.
Members
- applicationID
-
- Type: string
Import error data application ID.
- ec2LaunchTemplateID
-
- Type: string
Import error data ec2 LaunchTemplate ID.
- rawError
-
- Type: string
Import error data raw error.
- rowNumber
-
- Type: long (int|float)
Import error data row number.
- sourceServerID
-
- Type: string
Import error data source server ID.
- waveID
-
- Type: string
Import error data wave id.
ImportTask
Description
Import task.
Members
- creationDateTime
-
- Type: string
Import task creation datetime.
- endDateTime
-
- Type: string
Import task end datetime.
- importID
-
- Type: string
Import task id.
- progressPercentage
-
- Type: float
Import task progress percentage.
- s3BucketSource
-
- Type: S3BucketSource structure
Import task s3 bucket source.
- status
-
- Type: string
Import task status.
- summary
-
- Type: ImportTaskSummary structure
Import task summary.
ImportTaskError
Description
Import task error.
Members
- errorData
-
- Type: ImportErrorData structure
Import task error data.
- errorDateTime
-
- Type: string
Import task error datetime.
- errorType
-
- Type: string
Import task error type.
ImportTaskSummary
Description
Import task summary.
Members
- applications
-
- Type: ImportTaskSummaryApplications structure
Import task summary applications.
- servers
-
- Type: ImportTaskSummaryServers structure
Import task summary servers.
- waves
-
- Type: ImportTaskSummaryWaves structure
Import task summary waves.
ImportTaskSummaryApplications
Description
Import task summary applications.
Members
- createdCount
-
- Type: long (int|float)
Import task summary applications created count.
- modifiedCount
-
- Type: long (int|float)
Import task summary applications modified count.
ImportTaskSummaryServers
Description
Import task summary servers.
Members
- createdCount
-
- Type: long (int|float)
Import task summary servers created count.
- modifiedCount
-
- Type: long (int|float)
Import task summary servers modified count.
ImportTaskSummaryWaves
Description
Import task summery waves.
Members
- createdCount
-
- Type: long (int|float)
Import task summery waves created count.
- modifiedCount
-
- Type: long (int|float)
Import task summery waves modified count.
InternalServerException
Description
The server encountered an unexpected condition that prevented it from fulfilling the request.
Members
- message
-
- Required: Yes
- Type: string
- retryAfterSeconds
-
- Type: long (int|float)
The server encountered an unexpected condition that prevented it from fulfilling the request. The request will be retried again after x seconds.
Job
Description
Job.
Members
- arn
-
- Type: string
the ARN of the specific Job.
- creationDateTime
-
- Type: string
Job creation time.
- endDateTime
-
- Type: string
Job end time.
- initiatedBy
-
- Type: string
Job initiated by field.
- jobID
-
- Required: Yes
- Type: string
Job ID.
- participatingServers
-
- Type: Array of ParticipatingServer structures
Servers participating in a specific Job.
- status
-
- Type: string
Job status.
- tags
-
- Type: Associative array of custom strings keys (TagKey) to strings
Tags associated with specific Job.
- type
-
- Type: string
Job type.
JobLog
Description
Job log.
Members
- event
-
- Type: string
Job log event.
- eventData
-
- Type: JobLogEventData structure
Job event data
- logDateTime
-
- Type: string
Job log event date and time.
JobLogEventData
Description
Job log data
Members
- conversionServerID
-
- Type: string
Job Event conversion Server ID.
- rawError
-
- Type: string
Job error.
- sourceServerID
-
- Type: string
Job Event Source Server ID.
- targetInstanceID
-
- Type: string
Job Event Target instance ID.
JobPostLaunchActionsLaunchStatus
Description
Launch Status of the Job Post Launch Actions.
Members
- executionID
-
- Type: string
AWS Systems Manager Document's execution ID of the of the Job Post Launch Actions.
- executionStatus
-
- Type: string
AWS Systems Manager Document's execution status.
- failureReason
-
- Type: string
AWS Systems Manager Document's failure reason.
- ssmDocument
-
- Type: SsmDocument structure
AWS Systems Manager's Document of the of the Job Post Launch Actions.
- ssmDocumentType
-
- Type: string
AWS Systems Manager Document type.
LaunchTemplateDiskConf
Description
Launch template disk configuration.
Members
- iops
-
- Type: long (int|float)
Launch template disk iops configuration.
- throughput
-
- Type: long (int|float)
Launch template disk throughput configuration.
- volumeType
-
- Type: string
Launch template disk volume type configuration.
LaunchedInstance
Description
Launched instance.
Members
- ec2InstanceID
-
- Type: string
Launched instance EC2 ID.
- firstBoot
-
- Type: string
Launched instance first boot.
- jobID
-
- Type: string
Launched instance Job ID.
Licensing
Description
Configure Licensing.
Members
- osByol
-
- Type: boolean
Configure BYOL OS licensing.
LifeCycle
Description
Lifecycle.
Members
- addedToServiceDateTime
-
- Type: string
Lifecycle added to service data and time.
- elapsedReplicationDuration
-
- Type: string
Lifecycle elapsed time and duration.
- firstByteDateTime
-
- Type: string
Lifecycle replication initiation date and time.
- lastCutover
-
- Type: LifeCycleLastCutover structure
Lifecycle last Cutover.
- lastSeenByServiceDateTime
-
- Type: string
Lifecycle last seen date and time.
- lastTest
-
- Type: LifeCycleLastTest structure
Lifecycle last Test.
- state
-
- Type: string
Lifecycle state.
LifeCycleLastCutover
Description
Lifecycle last Cutover .
Members
- finalized
-
- Type: LifeCycleLastCutoverFinalized structure
Lifecycle Cutover finalized date and time.
- initiated
-
- Type: LifeCycleLastCutoverInitiated structure
Lifecycle last Cutover initiated.
- reverted
-
- Type: LifeCycleLastCutoverReverted structure
Lifecycle last Cutover reverted.
LifeCycleLastCutoverFinalized
Description
Lifecycle Cutover finalized
Members
- apiCallDateTime
-
- Type: string
Lifecycle Cutover finalized date and time.
LifeCycleLastCutoverInitiated
Description
Lifecycle last Cutover initiated.
Members
- apiCallDateTime
-
- Type: string
- jobID
-
- Type: string
Lifecycle last Cutover initiated by Job ID.
LifeCycleLastCutoverReverted
Description
Lifecycle last Cutover reverted.
Members
- apiCallDateTime
-
- Type: string
Lifecycle last Cutover reverted API call date time.
LifeCycleLastTest
Description
Lifecycle last Test.
Members
- finalized
-
- Type: LifeCycleLastTestFinalized structure
Lifecycle last Test finalized.
- initiated
-
- Type: LifeCycleLastTestInitiated structure
Lifecycle last Test initiated.
- reverted
-
- Type: LifeCycleLastTestReverted structure
Lifecycle last Test reverted.
LifeCycleLastTestFinalized
Description
Lifecycle last Test finalized.
Members
- apiCallDateTime
-
- Type: string
Lifecycle Test failed API call date and time.
LifeCycleLastTestInitiated
Description
Lifecycle last Test initiated.
Members
- apiCallDateTime
-
- Type: string
Lifecycle last Test initiated API call date and time.
- jobID
-
- Type: string
Lifecycle last Test initiated Job ID.
LifeCycleLastTestReverted
Description
Lifecycle last Test reverted.
Members
- apiCallDateTime
-
- Type: string
Lifecycle last Test reverted API call date and time.
ListApplicationsRequestFilters
Description
Applications list filters.
Members
- applicationIDs
-
- Type: Array of strings
Filter applications list by application ID.
- isArchived
-
- Type: boolean
Filter applications list by archival status.
- waveIDs
-
- Type: Array of strings
Filter applications list by wave ID.
ListExportsRequestFilters
Description
List exports request filters.
Members
- exportIDs
-
- Type: Array of strings
List exports request filters export ids.
ListImportsRequestFilters
Description
List imports request filters.
Members
- importIDs
-
- Type: Array of strings
List imports request filters import IDs.
ListWavesRequestFilters
Description
Waves list filters.
Members
- isArchived
-
- Type: boolean
Filter waves list by archival status.
- waveIDs
-
- Type: Array of strings
Filter waves list by wave ID.
NetworkInterface
Description
Network interface.
Members
- ips
-
- Type: Array of strings
Network interface IPs.
- isPrimary
-
- Type: boolean
Network interface primary IP.
- macAddress
-
- Type: string
Network interface Mac address.
OS
Description
Operating System.
Members
- fullString
-
- Type: string
OS full string.
ParticipatingServer
Description
Server participating in Job.
Members
- launchStatus
-
- Type: string
Participating server launch status.
- launchedEc2InstanceID
-
- Type: string
Participating server's launched ec2 instance ID.
- postLaunchActionsStatus
-
- Type: PostLaunchActionsStatus structure
Participating server's Post Launch Actions Status.
- sourceServerID
-
- Required: Yes
- Type: string
Participating server Source Server ID.
PostLaunchActions
Description
Post Launch Actions to executed on the Test or Cutover instance.
Members
- cloudWatchLogGroupName
-
- Type: string
AWS Systems Manager Command's CloudWatch log group name.
- deployment
-
- Type: string
Deployment type in which AWS Systems Manager Documents will be executed.
- s3LogBucket
-
- Type: string
AWS Systems Manager Command's logs S3 log bucket.
- s3OutputKeyPrefix
-
- Type: string
AWS Systems Manager Command's logs S3 output key prefix.
- ssmDocuments
-
- Type: Array of SsmDocument structures
AWS Systems Manager Documents.
PostLaunchActionsStatus
Description
Status of the Post Launch Actions running on the Test or Cutover instance.
Members
- postLaunchActionsLaunchStatusList
-
- Type: Array of JobPostLaunchActionsLaunchStatus structures
List of Post Launch Action status.
- ssmAgentDiscoveryDatetime
-
- Type: string
Time where the AWS Systems Manager was detected as running on the Test or Cutover instance.
ReplicationConfigurationReplicatedDisk
Description
Replication Configuration replicated disk.
Members
- deviceName
-
- Type: string
Replication Configuration replicated disk device name.
- iops
-
- Type: long (int|float)
Replication Configuration replicated disk IOPs.
- isBootDisk
-
- Type: boolean
Replication Configuration replicated disk boot disk.
- stagingDiskType
-
- Type: string
Replication Configuration replicated disk staging disk type.
- throughput
-
- Type: long (int|float)
Replication Configuration replicated disk throughput.
ResourceNotFoundException
Description
Resource not found exception.
Members
- code
-
- Type: string
- message
-
- Type: string
- resourceId
-
- Type: string
Resource ID not found error.
- resourceType
-
- Type: string
Resource type not found error.
S3BucketSource
Description
S3 bucket source.
Members
- s3Bucket
-
- Required: Yes
- Type: string
S3 bucket source s3 bucket.
- s3BucketOwner
-
- Type: string
S3 bucket source s3 bucket owner.
- s3Key
-
- Required: Yes
- Type: string
S3 bucket source s3 key.
ServiceQuotaExceededException
Description
The request could not be completed because its exceeded the service quota.
Members
- code
-
- Type: string
- message
-
- Type: string
- quotaCode
-
- Type: string
Exceeded the service quota code.
- quotaValue
-
- Type: int
Exceeded the service quota value.
- resourceId
-
- Type: string
Exceeded the service quota resource ID.
- resourceType
-
- Type: string
Exceeded the service quota resource type.
- serviceCode
-
- Type: string
Exceeded the service quota service code.
SourceProperties
Description
Source server properties.
Members
- cpus
-
- Type: Array of CPU structures
Source Server CPUs.
- disks
-
- Type: Array of Disk structures
Source Server disks.
- identificationHints
-
- Type: IdentificationHints structure
Source server identification hints.
- lastUpdatedDateTime
-
- Type: string
Source server last update date and time.
- networkInterfaces
-
- Type: Array of NetworkInterface structures
Source server network interfaces.
- os
-
- Type: OS structure
Source server OS.
- ramBytes
-
- Type: long (int|float)
Source server RAM in bytes.
- recommendedInstanceType
-
- Type: string
Source server recommended instance type.
SourceServerActionsRequestFilters
Description
Source server post migration custom action filters.
Members
- actionIDs
-
- Type: Array of strings
Action IDs to filter source server post migration custom actions by.
SsmDocument
Description
AWS Systems Manager Document.
Members
- actionName
-
- Required: Yes
- Type: string
User-friendly name for the AWS Systems Manager Document.
- externalParameters
-
- Type: Associative array of custom strings keys (SsmDocumentParameterName) to SsmExternalParameter structures
AWS Systems Manager Document external parameters.
- mustSucceedForCutover
-
- Type: boolean
If true, Cutover will not be enabled if the document has failed.
- parameters
-
- Type: Associative array of custom strings keys (SsmDocumentParameterName) to SsmParameterStoreParameter structuress
AWS Systems Manager Document parameters.
- ssmDocumentName
-
- Required: Yes
- Type: string
AWS Systems Manager Document name or full ARN.
- timeoutSeconds
-
- Type: int
AWS Systems Manager Document timeout seconds.
SsmExternalParameter
Description
AWS Systems Manager Document external parameter.
Members
- dynamicPath
-
- Type: string
AWS Systems Manager Document external parameters dynamic path.
SsmParameterStoreParameter
Description
AWS Systems Manager Parameter Store parameter.
Members
- parameterName
-
- Required: Yes
- Type: string
AWS Systems Manager Parameter Store parameter name.
- parameterType
-
- Required: Yes
- Type: string
AWS Systems Manager Parameter Store parameter type.
TemplateActionsRequestFilters
Description
Template post migration custom action filters.
Members
- actionIDs
-
- Type: Array of strings
Action IDs to filter template post migration custom actions by.
ThrottlingException
Description
Reached throttling quota exception.
Members
- message
-
- Required: Yes
- Type: string
- quotaCode
-
- Type: string
Reached throttling quota exception.
- retryAfterSeconds
-
- Type: string
Reached throttling quota exception will retry after x seconds.
- serviceCode
-
- Type: string
Reached throttling quota exception service code.
UninitializedAccountException
Description
Uninitialized account exception.
Members
- code
-
- Type: string
- message
-
- Type: string
ValidationException
Description
Validate exception.
Members
- code
-
- Type: string
- fieldList
-
- Type: Array of ValidationExceptionField structures
Validate exception field list.
- message
-
- Type: string
- reason
-
- Type: string
Validate exception reason.
ValidationExceptionField
Description
Validate exception field.
Members
- message
-
- Type: string
Validate exception field message.
- name
-
- Type: string
Validate exception field name.
VcenterClient
Description
vCenter client.
Members
- arn
-
- Type: string
Arn of vCenter client.
- datacenterName
-
- Type: string
Datacenter name of vCenter client.
- hostname
-
- Type: string
Hostname of vCenter client .
- lastSeenDatetime
-
- Type: string
Last seen time of vCenter client.
- sourceServerTags
-
- Type: Associative array of custom strings keys (TagKey) to strings
Tags for Source Server of vCenter client.
- tags
-
- Type: Associative array of custom strings keys (TagKey) to strings
Tags for vCenter client.
- vcenterClientID
-
- Type: string
ID of vCenter client.
- vcenterUUID
-
- Type: string
Vcenter UUID of vCenter client.
WaveAggregatedStatus
Description
Wave aggregated status.
Members
- healthStatus
-
- Type: string
Wave aggregated status health status.
- lastUpdateDateTime
-
- Type: string
Wave aggregated status last update dateTime.
- progressStatus
-
- Type: string
Wave aggregated status progress status.
- replicationStartedDateTime
-
- Type: string
DateTime marking when the first source server in the wave started replication.
- totalApplications
-
- Type: long (int|float)
Wave aggregated status total applications amount.