AWS SDK for PHP 3.x

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

ChangeServerLifeCycleState ( array $params = [] )
Allows the user to set the SourceServer.
CreateReplicationConfigurationTemplate ( array $params = [] )
Creates a new ReplicationConfigurationTemplate.
DeleteJob ( array $params = [] )
Deletes a single Job by ID.
DeleteReplicationConfigurationTemplate ( array $params = [] )
Deletes a single Replication Configuration Template by ID
DeleteSourceServer ( array $params = [] )
Deletes a single source server by ID.
DescribeJobLogItems ( array $params = [] )
Retrieves detailed Job log with paging.
DescribeJobs ( array $params = [] )
Returns a list of Jobs.
DescribeReplicationConfigurationTemplates ( array $params = [] )
Lists all ReplicationConfigurationTemplates, filtered by Source Server IDs.
DescribeSourceServers ( array $params = [] )
Retrieves all SourceServers or multiple SourceServers by ID.
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.
ListTagsForResource ( array $params = [] )
List all tags for your Application Migration Service resources.
MarkAsArchived ( array $params = [] )
Archives specific Source Servers by setting the SourceServer.
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.
StartTest ( array $params = [] )
Lauches 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.
UntagResource ( array $params = [] )
Deletes the specified set of tags from the specified set of Application Migration Service resources.
UpdateLaunchConfiguration ( array $params = [] )
Updates multiple LaunchConfigurations by Source Server ID.
UpdateReplicationConfiguration ( array $params = [] )
Allows you to update multiple ReplicationConfigurations by Source Server ID.
UpdateReplicationConfigurationTemplate ( array $params = [] )
Updates multiple ReplicationConfigurationTemplates by ID.

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:

DescribeJobLogItems
DescribeJobs
DescribeReplicationConfigurationTemplates
DescribeSourceServers

Operations

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

[
    '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',
            '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',
        'etaDateTime' => '<string>',
        'lagDuration' => '<string>',
        'replicatedDisks' => [
            [
                'backloggedStorageBytes' => <integer>,
                'deviceName' => '<string>',
                'replicatedStorageBytes' => <integer>,
                'rescannedStorageBytes' => <integer>,
                'totalStorageBytes' => <integer>,
            ],
            // ...
        ],
    ],
    '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',
    ],
    'sourceProperties' => [
        'cpus' => [
            [
                'cores' => <integer>,
                'modelName' => '<string>',
            ],
            // ...
        ],
        'disks' => [
            [
                'bytes' => <integer>,
                'deviceName' => '<string>',
            ],
            // ...
        ],
        'identificationHints' => [
            'awsInstanceID' => '<string>',
            'fqdn' => '<string>',
            'hostname' => '<string>',
            'vmWareUuid' => '<string>',
        ],
        'lastUpdatedDateTime' => '<string>',
        'networkInterfaces' => [
            [
                'ips' => ['<string>', ...],
                'isPrimary' => true || false,
                'macAddress' => '<string>',
            ],
            // ...
        ],
        'os' => [
            'fullString' => '<string>',
        ],
        'ramBytes' => <integer>,
        'recommendedInstanceType' => '<string>',
    ],
    'sourceServerID' => '<string>',
    'tags' => ['<string>', ...],
]

Result Details

Members

arn

Type: string

Source server ARN.

dataReplicationInfo

Type: DataReplicationInfo structure

Source server data replication info.

isArchived

Type: boolean

Source server archived status.

launchedInstance

Type: LaunchedInstance structure

Source server launched instance.

lifeCycle

Type: LifeCycle structure

Source server lifecycle state.

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.

Errors

UninitializedAccountException:
Unitialized account exception.
ResourceNotFoundException:
Resource not found exception.
ValidationException:
Validate exception.
ConflictException:
The request could not be completed due to a conflict with the current state of the target resource.

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', // 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 Staging Disk EBS volume type to "gp2" during Replication Settings template creation.

ebsEncryption

Required: Yes
Type: string

Request to configure EBS enryption during Replication Settings template creation.

ebsEncryptionKeyArn

Type: string

Request to configure an EBS enryption 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 Secuirity 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 Staiging 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',
    '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 throtting.

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 dedault 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 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:
Unitialized account exception.
ValidationException:
Validate exception.
AccessDeniedException:
Operating denied due to a file permission or access check error.

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

The results for this operation are always empty.

Errors

UninitializedAccountException:
Unitialized account exception.
ResourceNotFoundException:
Resource not found exception.
ConflictException:
The request could not be completed due to a conflict with the current state of the target resource.

DeleteReplicationConfigurationTemplate

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

Deletes a single Replication Configuration Template by ID

Parameter Syntax

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

Parameter Details

Members

replicationConfigurationTemplateID

Required: Yes
Type: string

Request to delete Replication Configuration Template from service by Replication Configuration Template ID.

Result Syntax

[]

Result Details

The results for this operation are always empty.

Errors

UninitializedAccountException:
Unitialized account exception.
ResourceNotFoundException:
Resource not found exception.
ConflictException:
The request could not be completed due to a conflict with the current state of the target resource.

DeleteSourceServer

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

Deletes a single source server by ID.

Parameter Syntax

$result = $client->deleteSourceServer([
    '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

The results for this operation are always empty.

Errors

UninitializedAccountException:
Unitialized account exception.
ResourceNotFoundException:
Resource not found exception.
ConflictException:
The request could not be completed due to a conflict with the current state of the target resource.

DescribeJobLogItems

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

Retrieves detailed Job log 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:
Unitialized account exception.
ValidationException:
Validate exception.

DescribeJobs

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

Returns a list of Jobs. Use the JobsID and fromDate and toData filters to limit which jobs are returned. The response is sorted by creationDataTime - latest date first. Jobs are normaly 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' => [ // REQUIRED
        'fromDate' => '<string>',
        'jobIDs' => ['<string>', ...],
        'toDate' => '<string>',
    ],
    'maxResults' => <integer>,
    'nextToken' => '<string>',
]);

Parameter Details

Members

filters

Required: Yes
Type: DescribeJobsRequestFilters structure

Request to describe Job log filters.

maxResults

Type: int

Request to describe Job log by max results.

nextToken

Type: string

Request to describe Job logby 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',
                    '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:
Unitialized account exception.
ValidationException:
Validate exception.

DescribeReplicationConfigurationTemplates

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

Lists all ReplicationConfigurationTemplates, filtered by Source Server IDs.

Parameter Syntax

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

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

Required: Yes
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',
            '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:
Unitialized account exception.
ResourceNotFoundException:
Resource not found exception.
ValidationException:
Validate exception.

DescribeSourceServers

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

Retrieves all SourceServers or multiple SourceServers by ID.

Parameter Syntax

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

Parameter Details

Members

filters

Required: Yes
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' => [
        [
            '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',
                    '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',
                'etaDateTime' => '<string>',
                'lagDuration' => '<string>',
                'replicatedDisks' => [
                    [
                        'backloggedStorageBytes' => <integer>,
                        'deviceName' => '<string>',
                        'replicatedStorageBytes' => <integer>,
                        'rescannedStorageBytes' => <integer>,
                        'totalStorageBytes' => <integer>,
                    ],
                    // ...
                ],
            ],
            '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',
            ],
            'sourceProperties' => [
                'cpus' => [
                    [
                        'cores' => <integer>,
                        'modelName' => '<string>',
                    ],
                    // ...
                ],
                'disks' => [
                    [
                        'bytes' => <integer>,
                        'deviceName' => '<string>',
                    ],
                    // ...
                ],
                'identificationHints' => [
                    'awsInstanceID' => '<string>',
                    'fqdn' => '<string>',
                    'hostname' => '<string>',
                    'vmWareUuid' => '<string>',
                ],
                'lastUpdatedDateTime' => '<string>',
                'networkInterfaces' => [
                    [
                        'ips' => ['<string>', ...],
                        'isPrimary' => true || false,
                        'macAddress' => '<string>',
                    ],
                    // ...
                ],
                'os' => [
                    'fullString' => '<string>',
                ],
                'ramBytes' => <integer>,
                'recommendedInstanceType' => '<string>',
            ],
            'sourceServerID' => '<string>',
            'tags' => ['<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:
Unitialized account exception.
ValidationException:
Validate exception.

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 communciating 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.lagDurationwill 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

[
    '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',
            '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',
        'etaDateTime' => '<string>',
        'lagDuration' => '<string>',
        'replicatedDisks' => [
            [
                'backloggedStorageBytes' => <integer>,
                'deviceName' => '<string>',
                'replicatedStorageBytes' => <integer>,
                'rescannedStorageBytes' => <integer>,
                'totalStorageBytes' => <integer>,
            ],
            // ...
        ],
    ],
    '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',
    ],
    'sourceProperties' => [
        'cpus' => [
            [
                'cores' => <integer>,
                'modelName' => '<string>',
            ],
            // ...
        ],
        'disks' => [
            [
                'bytes' => <integer>,
                'deviceName' => '<string>',
            ],
            // ...
        ],
        'identificationHints' => [
            'awsInstanceID' => '<string>',
            'fqdn' => '<string>',
            'hostname' => '<string>',
            'vmWareUuid' => '<string>',
        ],
        'lastUpdatedDateTime' => '<string>',
        'networkInterfaces' => [
            [
                'ips' => ['<string>', ...],
                'isPrimary' => true || false,
                'macAddress' => '<string>',
            ],
            // ...
        ],
        'os' => [
            'fullString' => '<string>',
        ],
        'ramBytes' => <integer>,
        'recommendedInstanceType' => '<string>',
    ],
    'sourceServerID' => '<string>',
    'tags' => ['<string>', ...],
]

Result Details

Members

arn

Type: string

Source server ARN.

dataReplicationInfo

Type: DataReplicationInfo structure

Source server data replication info.

isArchived

Type: boolean

Source server archived status.

launchedInstance

Type: LaunchedInstance structure

Source server launched instance.

lifeCycle

Type: LifeCycle structure

Source server lifecycle state.

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.

Errors

UninitializedAccountException:
Unitialized account exception.
ResourceNotFoundException:
Resource not found exception.
ConflictException:
The request could not be completed due to a conflict with the current state of the target resource.

FinalizeCutover

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

Finalizes the cutover immediately for specific Source Servers. All AWS resources created by Application Migration Service for enabling the replication of these source servers will be terminated / deleted within 90 minutes. Launched Test or Cutover instances will NOT be terminated. The AWS Replication Agent will receive a command to uninstall itself (within 10 minutes). The following properties of the SourceServer will be changed immediately: dataReplicationInfo.dataReplicationState will be 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.lagDurationwill be nullified.

Parameter Syntax

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

Parameter Details

Members

sourceServerID

Required: Yes
Type: string

Request to finalize Cutover by Soure Server ID.

Result Syntax

[
    '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',
            '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',
        'etaDateTime' => '<string>',
        'lagDuration' => '<string>',
        'replicatedDisks' => [
            [
                'backloggedStorageBytes' => <integer>,
                'deviceName' => '<string>',
                'replicatedStorageBytes' => <integer>,
                'rescannedStorageBytes' => <integer>,
                'totalStorageBytes' => <integer>,
            ],
            // ...
        ],
    ],
    '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',
    ],
    'sourceProperties' => [
        'cpus' => [
            [
                'cores' => <integer>,
                'modelName' => '<string>',
            ],
            // ...
        ],
        'disks' => [
            [
                'bytes' => <integer>,
                'deviceName' => '<string>',
            ],
            // ...
        ],
        'identificationHints' => [
            'awsInstanceID' => '<string>',
            'fqdn' => '<string>',
            'hostname' => '<string>',
            'vmWareUuid' => '<string>',
        ],
        'lastUpdatedDateTime' => '<string>',
        'networkInterfaces' => [
            [
                'ips' => ['<string>', ...],
                'isPrimary' => true || false,
                'macAddress' => '<string>',
            ],
            // ...
        ],
        'os' => [
            'fullString' => '<string>',
        ],
        'ramBytes' => <integer>,
        'recommendedInstanceType' => '<string>',
    ],
    'sourceServerID' => '<string>',
    'tags' => ['<string>', ...],
]

Result Details

Members

arn

Type: string

Source server ARN.

dataReplicationInfo

Type: DataReplicationInfo structure

Source server data replication info.

isArchived

Type: boolean

Source server archived status.

launchedInstance

Type: LaunchedInstance structure

Source server launched instance.

lifeCycle

Type: LifeCycle structure

Source server lifecycle state.

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.

Errors

UninitializedAccountException:
Unitialized account exception.
ResourceNotFoundException:
Resource not found exception.
ValidationException:
Validate exception.
ConflictException:
The request could not be completed due to a conflict with the current state of the target resource.

GetLaunchConfiguration

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

Lists all LaunchConfigurations available, filtered by Source Server IDs.

Parameter Syntax

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

Parameter Details

Members

sourceServerID

Required: Yes
Type: string

Request to get Launch Configuration information by Source Server ID.

Result Syntax

[
    'copyPrivateIp' => true || false,
    'copyTags' => true || false,
    'ec2LaunchTemplateID' => '<string>',
    'launchDisposition' => 'STOPPED|STARTED',
    'licensing' => [
        'osByol' => true || false,
    ],
    'name' => '<string>',
    'sourceServerID' => '<string>',
    'targetInstanceTypeRightSizingMethod' => 'NONE|BASIC',
]

Result Details

Members

copyPrivateIp

Type: boolean

Copy Private IP during Launch Configuration.

copyTags

Type: boolean

Copy Tags during Launch Configuration.

ec2LaunchTemplateID

Type: string

Configure EC2 lauch configuration template ID.

launchDisposition

Type: string

Configure launch dispostion for launch configuration.

licensing

Type: Licensing structure

Configure launch configuration OS licensing.

name

Type: string

Configure launch configuration name.

sourceServerID

Type: string

Configure launch configuration Source Server ID.

targetInstanceTypeRightSizingMethod

Type: string

Configure launch configuration Target instance type right sizing method.

Errors

UninitializedAccountException:
Unitialized account exception.
ResourceNotFoundException:
Resource not found exception.

GetReplicationConfiguration

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

Lists all ReplicationConfigurations, filtered by Source Server ID.

Parameter Syntax

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

Parameter Details

Members

sourceServerID

Required: Yes
Type: string

Request to get Replication Configuaration by Source Server ID.

Result Syntax

[
    'associateDefaultSecurityGroup' => true || false,
    'bandwidthThrottling' => <integer>,
    'createPublicIP' => true || false,
    'dataPlaneRouting' => 'PRIVATE_IP|PUBLIC_IP',
    'defaultLargeStagingDiskType' => 'GP2|ST1',
    'ebsEncryption' => 'DEFAULT|CUSTOM',
    'ebsEncryptionKeyArn' => '<string>',
    'name' => '<string>',
    'replicatedDisks' => [
        [
            'deviceName' => '<string>',
            'iops' => <integer>,
            'isBootDisk' => true || false,
            'stagingDiskType' => 'AUTO|GP2|IO1|SC1|ST1|STANDARD',
        ],
        // ...
    ],
    '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:
Unitialized account exception.
ResourceNotFoundException:
Resource not found exception.

InitializeService

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

Initialize Application Migration Service.

Parameter Syntax

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

Parameter Details

Members

Result Syntax

[]

Result Details

The results for this operation are always empty.

Errors

ValidationException:
Validate exception.
AccessDeniedException:
Operating denied due to a file permission or access check error.

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

ResourceNotFoundException:
Resource not found exception.
ThrottlingException:
Reached throttling quota exception.
ValidationException:
Validate exception.
AccessDeniedException:
Operating denied due to a file permission or access check error.
InternalServerException:
The server encountered an unexpected condition that prevented it from fulfilling the request.

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

[
    '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',
            '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',
        'etaDateTime' => '<string>',
        'lagDuration' => '<string>',
        'replicatedDisks' => [
            [
                'backloggedStorageBytes' => <integer>,
                'deviceName' => '<string>',
                'replicatedStorageBytes' => <integer>,
                'rescannedStorageBytes' => <integer>,
                'totalStorageBytes' => <integer>,
            ],
            // ...
        ],
    ],
    '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',
    ],
    'sourceProperties' => [
        'cpus' => [
            [
                'cores' => <integer>,
                'modelName' => '<string>',
            ],
            // ...
        ],
        'disks' => [
            [
                'bytes' => <integer>,
                'deviceName' => '<string>',
            ],
            // ...
        ],
        'identificationHints' => [
            'awsInstanceID' => '<string>',
            'fqdn' => '<string>',
            'hostname' => '<string>',
            'vmWareUuid' => '<string>',
        ],
        'lastUpdatedDateTime' => '<string>',
        'networkInterfaces' => [
            [
                'ips' => ['<string>', ...],
                'isPrimary' => true || false,
                'macAddress' => '<string>',
            ],
            // ...
        ],
        'os' => [
            'fullString' => '<string>',
        ],
        'ramBytes' => <integer>,
        'recommendedInstanceType' => '<string>',
    ],
    'sourceServerID' => '<string>',
    'tags' => ['<string>', ...],
]

Result Details

Members

arn

Type: string

Source server ARN.

dataReplicationInfo

Type: DataReplicationInfo structure

Source server data replication info.

isArchived

Type: boolean

Source server archived status.

launchedInstance

Type: LaunchedInstance structure

Source server launched instance.

lifeCycle

Type: LifeCycle structure

Source server lifecycle state.

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.

Errors

UninitializedAccountException:
Unitialized account exception.
ResourceNotFoundException:
Resource not found exception.
ConflictException:
The request could not be completed due to a conflict with the current state of the target resource.

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

[
    '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',
            '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',
        'etaDateTime' => '<string>',
        'lagDuration' => '<string>',
        'replicatedDisks' => [
            [
                'backloggedStorageBytes' => <integer>,
                'deviceName' => '<string>',
                'replicatedStorageBytes' => <integer>,
                'rescannedStorageBytes' => <integer>,
                'totalStorageBytes' => <integer>,
            ],
            // ...
        ],
    ],
    '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',
    ],
    'sourceProperties' => [
        'cpus' => [
            [
                'cores' => <integer>,
                'modelName' => '<string>',
            ],
            // ...
        ],
        'disks' => [
            [
                'bytes' => <integer>,
                'deviceName' => '<string>',
            ],
            // ...
        ],
        'identificationHints' => [
            'awsInstanceID' => '<string>',
            'fqdn' => '<string>',
            'hostname' => '<string>',
            'vmWareUuid' => '<string>',
        ],
        'lastUpdatedDateTime' => '<string>',
        'networkInterfaces' => [
            [
                'ips' => ['<string>', ...],
                'isPrimary' => true || false,
                'macAddress' => '<string>',
            ],
            // ...
        ],
        'os' => [
            'fullString' => '<string>',
        ],
        'ramBytes' => <integer>,
        'recommendedInstanceType' => '<string>',
    ],
    'sourceServerID' => '<string>',
    'tags' => ['<string>', ...],
]

Result Details

Members

arn

Type: string

Source server ARN.

dataReplicationInfo

Type: DataReplicationInfo structure

Source server data replication info.

isArchived

Type: boolean

Source server archived status.

launchedInstance

Type: LaunchedInstance structure

Source server launched instance.

lifeCycle

Type: LifeCycle structure

Source server lifecycle state.

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.

Errors

UninitializedAccountException:
Unitialized account exception.
ResourceNotFoundException:
Resource not found exception.
ValidationException:
Validate exception.

StartCutover

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

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

Parameter Syntax

$result = $client->startCutover([
    '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',
                'sourceServerID' => '<string>',
            ],
            // ...
        ],
        'status' => 'PENDING|STARTED|COMPLETED',
        'tags' => ['<string>', ...],
        'type' => 'LAUNCH|TERMINATE',
    ],
]

Result Details

Members

job

Type: Job structure

Start Cutover Job response.

Errors

UninitializedAccountException:
Unitialized account exception.
ValidationException:
Validate exception.
ConflictException:
The request could not be completed due to a conflict with the current state of the target resource.

StartTest

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

Lauches 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',
                'sourceServerID' => '<string>',
            ],
            // ...
        ],
        'status' => 'PENDING|STARTED|COMPLETED',
        'tags' => ['<string>', ...],
        'type' => 'LAUNCH|TERMINATE',
    ],
]

Result Details

Members

job

Type: Job structure

Start Test Job response.

Errors

UninitializedAccountException:
Unitialized account exception.
ValidationException:
Validate exception.
ConflictException:
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

The results for this operation are always empty.

Errors

ResourceNotFoundException:
Resource not found exception.
ThrottlingException:
Reached throttling quota exception.
ValidationException:
Validate exception.
AccessDeniedException:
Operating denied due to a file permission or access check error.
InternalServerException:
The server encountered an unexpected condition that prevented it from fulfilling the request.

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',
                '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:
Unitialized account exception.
ValidationException:
Validate exception.
ConflictException:
The request could not be completed due to a conflict with the current state of the target resource.

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

The results for this operation are always empty.

Errors

ResourceNotFoundException:
Resource not found exception.
ThrottlingException:
Reached throttling quota exception.
ValidationException:
Validate exception.
AccessDeniedException:
Operating denied due to a file permission or access check error.
InternalServerException:
The server encountered an unexpected condition that prevented it from fulfilling the request.

UpdateLaunchConfiguration

$result = $client->updateLaunchConfiguration([/* ... */]);
$promise = $client->updateLaunchConfigurationAsync([/* ... */]);

Updates multiple LaunchConfigurations by Source Server ID.

Parameter Syntax

$result = $client->updateLaunchConfiguration([
    'copyPrivateIp' => true || false,
    'copyTags' => true || false,
    'launchDisposition' => 'STOPPED|STARTED',
    'licensing' => [
        'osByol' => true || false,
    ],
    'name' => '<string>',
    'sourceServerID' => '<string>', // REQUIRED
    'targetInstanceTypeRightSizingMethod' => 'NONE|BASIC',
]);

Parameter Details

Members

copyPrivateIp

Type: boolean

Update Launch configuration copy Private IP request.

copyTags

Type: boolean

Update Launch configuration copy Tags request.

launchDisposition

Type: string

Update Launch configuration launch disposition request.

licensing

Type: Licensing structure

Update Launch configuration licensing request.

name

Type: string

Update Launch configuration name request.

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

[
    'copyPrivateIp' => true || false,
    'copyTags' => true || false,
    'ec2LaunchTemplateID' => '<string>',
    'launchDisposition' => 'STOPPED|STARTED',
    'licensing' => [
        'osByol' => true || false,
    ],
    'name' => '<string>',
    'sourceServerID' => '<string>',
    'targetInstanceTypeRightSizingMethod' => 'NONE|BASIC',
]

Result Details

Members

copyPrivateIp

Type: boolean

Copy Private IP during Launch Configuration.

copyTags

Type: boolean

Copy Tags during Launch Configuration.

ec2LaunchTemplateID

Type: string

Configure EC2 lauch configuration template ID.

launchDisposition

Type: string

Configure launch dispostion for launch configuration.

licensing

Type: Licensing structure

Configure launch configuration OS licensing.

name

Type: string

Configure launch configuration name.

sourceServerID

Type: string

Configure launch configuration Source Server ID.

targetInstanceTypeRightSizingMethod

Type: string

Configure launch configuration Target instance type right sizing method.

Errors

UninitializedAccountException:
Unitialized account exception.
ResourceNotFoundException:
Resource not found exception.
ValidationException:
Validate exception.
ConflictException:
The request could not be completed due to a conflict with the current state of the target resource.

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',
    'ebsEncryption' => 'DEFAULT|CUSTOM',
    'ebsEncryptionKeyArn' => '<string>',
    'name' => '<string>',
    'replicatedDisks' => [
        [
            'deviceName' => '<string>',
            'iops' => <integer>,
            'isBootDisk' => true || false,
            'stagingDiskType' => 'AUTO|GP2|IO1|SC1|ST1|STANDARD',
        ],
        // ...
    ],
    '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',
    'ebsEncryption' => 'DEFAULT|CUSTOM',
    'ebsEncryptionKeyArn' => '<string>',
    'name' => '<string>',
    'replicatedDisks' => [
        [
            'deviceName' => '<string>',
            'iops' => <integer>,
            'isBootDisk' => true || false,
            'stagingDiskType' => 'AUTO|GP2|IO1|SC1|ST1|STANDARD',
        ],
        // ...
    ],
    '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:
Unitialized account exception.
ResourceNotFoundException:
Resource not found exception.
ValidationException:
Validate exception.
AccessDeniedException:
Operating denied due to a file permission or access check error.
ConflictException:
The request could not be completed due to a conflict with the current state of the target resource.

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',
    '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',
    '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 throtting.

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 dedault 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 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:
Unitialized account exception.
ResourceNotFoundException:
Resource not found exception.
ValidationException:
Validate exception.
AccessDeniedException:
Operating denied due to a file permission or access check error.

Shapes

AccessDeniedException

Description

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

Members

code

Type: string

message

Type: string

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

message

Type: string

resourceId

Type: string

A conflict occured when prompting for the Resource ID.

resourceType

Type: string

A conflict occured 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 durating.

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 intiation 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 by last date.

DescribeSourceServersRequestFilters

Description

Request to filter Source Servers list.

Members

isArchived

Type: boolean

Request to filter Source Servers list by archived.

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.

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.

vmWareUuid

Type: string

vmWare UUID identification hint.

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

LaunchedInstance

Description

Configure launced instance.

Members

ec2InstanceID

Type: string

Configure launced instance EC2 ID.

firstBoot

Type: string

Configure launced instance first boot.

jobID

Type: string

Configure launced 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 finlized.

initiated

Type: LifeCycleLastTestInitiated structure

Lifecycle last Test initiated.

reverted

Type: LifeCycleLastTestReverted structure

Lifecycle last Test reverted.

LifeCycleLastTestFinalized

Description

Lifecycle last Test finlized.

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.

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.

sourceServerID

Type: string

Participating server Source Server ID.

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.

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.

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.

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

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

Namespaces

Classes

Interfaces

Traits

Exceptions

Functions

Application Migration Service 2020-02-26

Operation Summary

Paginators

Operations

ChangeServerLifeCycleState

Parameter Syntax

Parameter Details

Members

Result Syntax

Result Details

Members

Errors

CreateReplicationConfigurationTemplate

Parameter Syntax

Parameter Details

Members

Result Syntax

Result Details

Members

Errors

DeleteJob

Parameter Syntax

Parameter Details

Members

Result Syntax

Result Details

Errors

DeleteReplicationConfigurationTemplate

Parameter Syntax

Parameter Details

Members

Result Syntax

Result Details

Errors

DeleteSourceServer

Parameter Syntax

Parameter Details

Members

Result Syntax

Result Details

Errors

DescribeJobLogItems

Parameter Syntax

Parameter Details

Members

Result Syntax

Result Details

Members

Errors

DescribeJobs

Parameter Syntax

Parameter Details

Members

Result Syntax

Result Details

Members

Errors

DescribeReplicationConfigurationTemplates

Parameter Syntax

Parameter Details

Members

Result Syntax

Result Details

Members

Errors

DescribeSourceServers

Parameter Syntax

Parameter Details

Members

Result Syntax

Result Details

Members

Errors

DisconnectFromService