Elastic Disaster Recovery Service 2020-02-26

CreateExtendedSourceServer

$result = $client->createExtendedSourceServer([/* ... */]);
$promise = $client->createExtendedSourceServerAsync([/* ... */]);

Parameter Syntax

$result = $client->createExtendedSourceServer([
    'sourceServerArn' => '<string>', // REQUIRED
    'tags' => ['<string>', ...],
]);

Parameter Details

Result Syntax

[
    'sourceServer' => [
        '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>,
                ],
                // ...
            ],
        ],
        'lastLaunchResult' => 'NOT_STARTED|PENDING|SUCCEEDED|FAILED',
        'lifeCycle' => [
            'addedToServiceDateTime' => '<string>',
            'elapsedReplicationDuration' => '<string>',
            'firstByteDateTime' => '<string>',
            'lastLaunch' => [
                'initiated' => [
                    'apiCallDateTime' => '<string>',
                    'jobID' => '<string>',
                    'type' => 'RECOVERY|DRILL',
                ],
            ],
            'lastSeenByServiceDateTime' => '<string>',
        ],
        'recoveryInstanceId' => '<string>',
        'replicationDirection' => 'FAILOVER|FAILBACK',
        'reversedDirectionSourceServerArn' => '<string>',
        'sourceCloudProperties' => [
            'originAccountID' => '<string>',
            'originAvailabilityZone' => '<string>',
            'originRegion' => '<string>',
        ],
        '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>',
        'stagingArea' => [
            'errorMessage' => '<string>',
            'stagingAccountID' => '<string>',
            'stagingSourceServerArn' => '<string>',
            'status' => 'EXTENDED|EXTENSION_ERROR|NOT_EXTENDED',
        ],
        'tags' => ['<string>', ...],
    ],
]

Result Details

Errors

• ResourceNotFoundException:

  The resource for this operation was not found.

• InternalServerException:

  The request processing has failed because of an unknown error, exception or failure.

• ServiceQuotaExceededException:

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

• ThrottlingException:

  The request was denied due to request throttling.

• AccessDeniedException:

  You do not have sufficient access to perform this action.

• ValidationException:

  The input fails to satisfy the constraints specified by the AWS service.

• UninitializedAccountException:

  The account performing the request has not been initialized.

CreateReplicationConfigurationTemplate

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

Parameter Syntax

$result = $client->createReplicationConfigurationTemplate([
    'associateDefaultSecurityGroup' => true || false, // REQUIRED
    'bandwidthThrottling' => <integer>, // REQUIRED
    'createPublicIP' => true || false, // REQUIRED
    'dataPlaneRouting' => 'PRIVATE_IP|PUBLIC_IP', // REQUIRED
    'defaultLargeStagingDiskType' => 'GP2|GP3|ST1|AUTO', // REQUIRED
    'ebsEncryption' => 'DEFAULT|CUSTOM', // REQUIRED
    'ebsEncryptionKeyArn' => '<string>',
    'pitPolicy' => [ // REQUIRED
        [
            'enabled' => true || false,
            'interval' => <integer>, // REQUIRED
            'retentionDuration' => <integer>, // REQUIRED
            'ruleID' => <integer>,
            'units' => 'MINUTE|HOUR|DAY', // REQUIRED
        ],
        // ...
    ],
    'replicationServerInstanceType' => '<string>', // REQUIRED
    'replicationServersSecurityGroupsIDs' => ['<string>', ...], // REQUIRED
    'stagingAreaSubnetId' => '<string>', // REQUIRED
    'stagingAreaTags' => ['<string>', ...], // REQUIRED
    'tags' => ['<string>', ...],
    'useDedicatedReplicationServer' => true || false, // REQUIRED
]);

Parameter Details

Result Syntax

[
    'arn' => '<string>',
    'associateDefaultSecurityGroup' => true || false,
    'bandwidthThrottling' => <integer>,
    'createPublicIP' => true || false,
    'dataPlaneRouting' => 'PRIVATE_IP|PUBLIC_IP',
    'defaultLargeStagingDiskType' => 'GP2|GP3|ST1|AUTO',
    'ebsEncryption' => 'DEFAULT|CUSTOM',
    'ebsEncryptionKeyArn' => '<string>',
    'pitPolicy' => [
        [
            'enabled' => true || false,
            'interval' => <integer>,
            'retentionDuration' => <integer>,
            'ruleID' => <integer>,
            'units' => 'MINUTE|HOUR|DAY',
        ],
        // ...
    ],
    'replicationConfigurationTemplateID' => '<string>',
    'replicationServerInstanceType' => '<string>',
    'replicationServersSecurityGroupsIDs' => ['<string>', ...],
    'stagingAreaSubnetId' => '<string>',
    'stagingAreaTags' => ['<string>', ...],
    'tags' => ['<string>', ...],
    'useDedicatedReplicationServer' => true || false,
]

Result Details

Errors

• InternalServerException:

  The request processing has failed because of an unknown error, exception or failure.

• ServiceQuotaExceededException:

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

• ThrottlingException:

  The request was denied due to request throttling.

• AccessDeniedException:

  You do not have sufficient access to perform this action.

• ValidationException:

  The input fails to satisfy the constraints specified by the AWS service.

• UninitializedAccountException:

  The account performing the request has not been initialized.

DeleteJob

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

Parameter Syntax

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

Parameter Details

Result Syntax

[]

Result Details

Errors

• ResourceNotFoundException:

  The resource for this operation was not found.

• InternalServerException:

  The request processing has failed because of an unknown error, exception or failure.

• ConflictException:

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

• ThrottlingException:

  The request was denied due to request throttling.

• UninitializedAccountException:

  The account performing the request has not been initialized.

DeleteRecoveryInstance

$result = $client->deleteRecoveryInstance([/* ... */]);
$promise = $client->deleteRecoveryInstanceAsync([/* ... */]);

Parameter Syntax

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

Parameter Details

Result Syntax

[]

Result Details

Errors

• InternalServerException:

  The request processing has failed because of an unknown error, exception or failure.

• ConflictException:

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

• ThrottlingException:

  The request was denied due to request throttling.

• AccessDeniedException:

  You do not have sufficient access to perform this action.

• UninitializedAccountException:

  The account performing the request has not been initialized.

DeleteReplicationConfigurationTemplate

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

Parameter Syntax

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

Parameter Details

Result Syntax

[]

Result Details

Errors

• ResourceNotFoundException:

  The resource for this operation was not found.

• InternalServerException:

  The request processing has failed because of an unknown error, exception or failure.

• ConflictException:

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

• ThrottlingException:

  The request was denied due to request throttling.

• UninitializedAccountException:

  The account performing the request has not been initialized.

DeleteSourceServer

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

Parameter Syntax

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

Parameter Details

Result Syntax

[]

Result Details

Errors

• ResourceNotFoundException:

  The resource for this operation was not found.

• InternalServerException:

  The request processing has failed because of an unknown error, exception or failure.

• ConflictException:

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

• ThrottlingException:

  The request was denied due to request throttling.

• UninitializedAccountException:

  The account performing the request has not been initialized.

DescribeJobLogItems

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

Parameter Syntax

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

Parameter Details

Result Syntax

[
    'items' => [
        [
            'event' => 'JOB_START|SERVER_SKIPPED|CLEANUP_START|CLEANUP_END|CLEANUP_FAIL|SNAPSHOT_START|SNAPSHOT_END|SNAPSHOT_FAIL|USING_PREVIOUS_SNAPSHOT|USING_PREVIOUS_SNAPSHOT_FAILED|CONVERSION_START|CONVERSION_END|CONVERSION_FAIL|LAUNCH_START|LAUNCH_FAILED|JOB_CANCEL|JOB_END',
            'eventData' => [
                'conversionProperties' => [
                    'dataTimestamp' => '<string>',
                    'forceUefi' => true || false,
                    'rootVolumeName' => '<string>',
                    'volumeToConversionMap' => [
                        '<LargeBoundedString>' => ['<string>', ...],
                        // ...
                    ],
                    'volumeToVolumeSize' => [<integer>, ...],
                ],
                'conversionServerID' => '<string>',
                'rawError' => '<string>',
                'sourceServerID' => '<string>',
                'targetInstanceID' => '<string>',
            ],
            'logDateTime' => '<string>',
        ],
        // ...
    ],
    'nextToken' => '<string>',
]

Result Details

Errors

• InternalServerException:

  The request processing has failed because of an unknown error, exception or failure.

• ThrottlingException:

  The request was denied due to request throttling.

• ValidationException:

  The input fails to satisfy the constraints specified by the AWS service.

• UninitializedAccountException:

  The account performing the request has not been initialized.

DescribeJobs

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

Parameter Syntax

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

Parameter Details

Result Syntax

[
    'items' => [
        [
            'arn' => '<string>',
            'creationDateTime' => '<string>',
            'endDateTime' => '<string>',
            'initiatedBy' => 'START_RECOVERY|START_DRILL|FAILBACK|DIAGNOSTIC|TERMINATE_RECOVERY_INSTANCES|TARGET_ACCOUNT',
            'jobID' => '<string>',
            'participatingServers' => [
                [
                    'launchStatus' => 'PENDING|IN_PROGRESS|LAUNCHED|FAILED|TERMINATED',
                    'recoveryInstanceID' => '<string>',
                    'sourceServerID' => '<string>',
                ],
                // ...
            ],
            'status' => 'PENDING|STARTED|COMPLETED',
            'tags' => ['<string>', ...],
            'type' => 'LAUNCH|TERMINATE|CREATE_CONVERTED_SNAPSHOT',
        ],
        // ...
    ],
    'nextToken' => '<string>',
]

Result Details

Errors

• InternalServerException:

  The request processing has failed because of an unknown error, exception or failure.

• ThrottlingException:

  The request was denied due to request throttling.

• ValidationException:

  The input fails to satisfy the constraints specified by the AWS service.

• UninitializedAccountException:

  The account performing the request has not been initialized.

DescribeRecoveryInstances

$result = $client->describeRecoveryInstances([/* ... */]);
$promise = $client->describeRecoveryInstancesAsync([/* ... */]);

Parameter Syntax

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

Parameter Details

Result Syntax

[
    'items' => [
        [
            'arn' => '<string>',
            'dataReplicationInfo' => [
                'dataReplicationError' => [
                    'error' => 'AGENT_NOT_SEEN|FAILBACK_CLIENT_NOT_SEEN|NOT_CONVERGING|UNSTABLE_NETWORK|FAILED_TO_ESTABLISH_RECOVERY_INSTANCE_COMMUNICATION|FAILED_TO_DOWNLOAD_REPLICATION_SOFTWARE_TO_FAILBACK_CLIENT|FAILED_TO_CONFIGURE_REPLICATION_SOFTWARE|FAILED_TO_PAIR_AGENT_WITH_REPLICATION_SOFTWARE|FAILED_TO_ESTABLISH_AGENT_REPLICATOR_SOFTWARE_COMMUNICATION|FAILED_GETTING_REPLICATION_STATE|SNAPSHOTS_FAILURE|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' => [
                    'startDateTime' => '<string>',
                    'steps' => [
                        [
                            'name' => 'LINK_FAILBACK_CLIENT_WITH_RECOVERY_INSTANCE|COMPLETE_VOLUME_MAPPING|ESTABLISH_RECOVERY_INSTANCE_COMMUNICATION|DOWNLOAD_REPLICATION_SOFTWARE_TO_FAILBACK_CLIENT|CONFIGURE_REPLICATION_SOFTWARE|PAIR_AGENT_WITH_REPLICATION_SOFTWARE|ESTABLISH_AGENT_REPLICATOR_SOFTWARE_COMMUNICATION|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|REPLICATION_STATE_NOT_AVAILABLE|NOT_STARTED',
                'etaDateTime' => '<string>',
                'lagDuration' => '<string>',
                'replicatedDisks' => [
                    [
                        'backloggedStorageBytes' => <integer>,
                        'deviceName' => '<string>',
                        'replicatedStorageBytes' => <integer>,
                        'rescannedStorageBytes' => <integer>,
                        'totalStorageBytes' => <integer>,
                    ],
                    // ...
                ],
            ],
            'ec2InstanceID' => '<string>',
            'ec2InstanceState' => 'PENDING|RUNNING|STOPPING|STOPPED|SHUTTING-DOWN|TERMINATED|NOT_FOUND',
            'failback' => [
                'agentLastSeenByServiceDateTime' => '<string>',
                'elapsedReplicationDuration' => '<string>',
                'failbackClientID' => '<string>',
                'failbackClientLastSeenByServiceDateTime' => '<string>',
                'failbackInitiationTime' => '<string>',
                'failbackJobID' => '<string>',
                'failbackLaunchType' => 'RECOVERY|DRILL',
                'failbackToOriginalServer' => true || false,
                'firstByteDateTime' => '<string>',
                'state' => 'FAILBACK_NOT_STARTED|FAILBACK_IN_PROGRESS|FAILBACK_READY_FOR_LAUNCH|FAILBACK_COMPLETED|FAILBACK_ERROR|FAILBACK_NOT_READY_FOR_LAUNCH|FAILBACK_LAUNCH_STATE_NOT_AVAILABLE',
            ],
            'isDrill' => true || false,
            'jobID' => '<string>',
            'originEnvironment' => 'ON_PREMISES|AWS',
            'pointInTimeSnapshotDateTime' => '<string>',
            'recoveryInstanceID' => '<string>',
            'recoveryInstanceProperties' => [
                'cpus' => [
                    [
                        'cores' => <integer>,
                        'modelName' => '<string>',
                    ],
                    // ...
                ],
                'disks' => [
                    [
                        'bytes' => <integer>,
                        'ebsVolumeID' => '<string>',
                        'internalDeviceName' => '<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>,
            ],
            'sourceServerID' => '<string>',
            'tags' => ['<string>', ...],
        ],
        // ...
    ],
    'nextToken' => '<string>',
]

Result Details

Errors

• InternalServerException:

  The request processing has failed because of an unknown error, exception or failure.

• ThrottlingException:

  The request was denied due to request throttling.

• AccessDeniedException:

  You do not have sufficient access to perform this action.

• UninitializedAccountException:

  The account performing the request has not been initialized.

DescribeRecoverySnapshots

$result = $client->describeRecoverySnapshots([/* ... */]);
$promise = $client->describeRecoverySnapshotsAsync([/* ... */]);

Parameter Syntax

$result = $client->describeRecoverySnapshots([
    'filters' => [
        'fromDateTime' => '<string>',
        'toDateTime' => '<string>',
    ],
    'maxResults' => <integer>,
    'nextToken' => '<string>',
    'order' => 'ASC|DESC',
    'sourceServerID' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

[
    'items' => [
        [
            'ebsSnapshots' => ['<string>', ...],
            'expectedTimestamp' => '<string>',
            'snapshotID' => '<string>',
            'sourceServerID' => '<string>',
            'timestamp' => '<string>',
        ],
        // ...
    ],
    'nextToken' => '<string>',
]

Result Details

Errors

• InternalServerException:

  The request processing has failed because of an unknown error, exception or failure.

• ThrottlingException:

  The request was denied due to request throttling.

• AccessDeniedException:

  You do not have sufficient access to perform this action.

• ValidationException:

  The input fails to satisfy the constraints specified by the AWS service.

• UninitializedAccountException:

  The account performing the request has not been initialized.

DescribeReplicationConfigurationTemplates

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

Parameter Syntax

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

Parameter Details

Result Syntax

[
    'items' => [
        [
            'arn' => '<string>',
            'associateDefaultSecurityGroup' => true || false,
            'bandwidthThrottling' => <integer>,
            'createPublicIP' => true || false,
            'dataPlaneRouting' => 'PRIVATE_IP|PUBLIC_IP',
            'defaultLargeStagingDiskType' => 'GP2|GP3|ST1|AUTO',
            'ebsEncryption' => 'DEFAULT|CUSTOM',
            'ebsEncryptionKeyArn' => '<string>',
            'pitPolicy' => [
                [
                    'enabled' => true || false,
                    'interval' => <integer>,
                    'retentionDuration' => <integer>,
                    'ruleID' => <integer>,
                    'units' => 'MINUTE|HOUR|DAY',
                ],
                // ...
            ],
            'replicationConfigurationTemplateID' => '<string>',
            'replicationServerInstanceType' => '<string>',
            'replicationServersSecurityGroupsIDs' => ['<string>', ...],
            'stagingAreaSubnetId' => '<string>',
            'stagingAreaTags' => ['<string>', ...],
            'tags' => ['<string>', ...],
            'useDedicatedReplicationServer' => true || false,
        ],
        // ...
    ],
    'nextToken' => '<string>',
]

Result Details

Errors

• ResourceNotFoundException:

  The resource for this operation was not found.

• InternalServerException:

  The request processing has failed because of an unknown error, exception or failure.

• ThrottlingException:

  The request was denied due to request throttling.

• ValidationException:

  The input fails to satisfy the constraints specified by the AWS service.

• UninitializedAccountException:

  The account performing the request has not been initialized.

DescribeSourceServers

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

Parameter Syntax

$result = $client->describeSourceServers([
    'filters' => [
        'hardwareId' => '<string>',
        'sourceServerIDs' => ['<string>', ...],
        'stagingAccountIDs' => ['<string>', ...],
    ],
    'maxResults' => <integer>,
    'nextToken' => '<string>',
]);

Parameter Details

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>,
                    ],
                    // ...
                ],
            ],
            'lastLaunchResult' => 'NOT_STARTED|PENDING|SUCCEEDED|FAILED',
            'lifeCycle' => [
                'addedToServiceDateTime' => '<string>',
                'elapsedReplicationDuration' => '<string>',
                'firstByteDateTime' => '<string>',
                'lastLaunch' => [
                    'initiated' => [
                        'apiCallDateTime' => '<string>',
                        'jobID' => '<string>',
                        'type' => 'RECOVERY|DRILL',
                    ],
                ],
                'lastSeenByServiceDateTime' => '<string>',
            ],
            'recoveryInstanceId' => '<string>',
            'replicationDirection' => 'FAILOVER|FAILBACK',
            'reversedDirectionSourceServerArn' => '<string>',
            'sourceCloudProperties' => [
                'originAccountID' => '<string>',
                'originAvailabilityZone' => '<string>',
                'originRegion' => '<string>',
            ],
            '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>',
            'stagingArea' => [
                'errorMessage' => '<string>',
                'stagingAccountID' => '<string>',
                'stagingSourceServerArn' => '<string>',
                'status' => 'EXTENDED|EXTENSION_ERROR|NOT_EXTENDED',
            ],
            'tags' => ['<string>', ...],
        ],
        // ...
    ],
    'nextToken' => '<string>',
]

Result Details

Errors

• InternalServerException:

  The request processing has failed because of an unknown error, exception or failure.

• ThrottlingException:

  The request was denied due to request throttling.

• ValidationException:

  The input fails to satisfy the constraints specified by the AWS service.

• UninitializedAccountException:

  The account performing the request has not been initialized.

DisconnectRecoveryInstance

$result = $client->disconnectRecoveryInstance([/* ... */]);
$promise = $client->disconnectRecoveryInstanceAsync([/* ... */]);

Parameter Syntax

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

Parameter Details

Result Syntax

[]

Result Details

Errors

• ResourceNotFoundException:

  The resource for this operation was not found.

• InternalServerException:

  The request processing has failed because of an unknown error, exception or failure.

• ConflictException:

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

• ThrottlingException:

  The request was denied due to request throttling.

• AccessDeniedException:

  You do not have sufficient access to perform this action.

• UninitializedAccountException:

  The account performing the request has not been initialized.

DisconnectSourceServer

$result = $client->disconnectSourceServer([/* ... */]);
$promise = $client->disconnectSourceServerAsync([/* ... */]);

Parameter Syntax

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

Parameter Details

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>,
            ],
            // ...
        ],
    ],
    'lastLaunchResult' => 'NOT_STARTED|PENDING|SUCCEEDED|FAILED',
    'lifeCycle' => [
        'addedToServiceDateTime' => '<string>',
        'elapsedReplicationDuration' => '<string>',
        'firstByteDateTime' => '<string>',
        'lastLaunch' => [
            'initiated' => [
                'apiCallDateTime' => '<string>',
                'jobID' => '<string>',
                'type' => 'RECOVERY|DRILL',
            ],
        ],
        'lastSeenByServiceDateTime' => '<string>',
    ],
    'recoveryInstanceId' => '<string>',
    'replicationDirection' => 'FAILOVER|FAILBACK',
    'reversedDirectionSourceServerArn' => '<string>',
    'sourceCloudProperties' => [
        'originAccountID' => '<string>',
        'originAvailabilityZone' => '<string>',
        'originRegion' => '<string>',
    ],
    '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>',
    'stagingArea' => [
        'errorMessage' => '<string>',
        'stagingAccountID' => '<string>',
        'stagingSourceServerArn' => '<string>',
        'status' => 'EXTENDED|EXTENSION_ERROR|NOT_EXTENDED',
    ],
    'tags' => ['<string>', ...],
]

Result Details

Errors

• ResourceNotFoundException:

  The resource for this operation was not found.

• InternalServerException:

  The request processing has failed because of an unknown error, exception or failure.

• ConflictException:

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

• ThrottlingException:

  The request was denied due to request throttling.

• UninitializedAccountException:

  The account performing the request has not been initialized.

GetFailbackReplicationConfiguration

$result = $client->getFailbackReplicationConfiguration([/* ... */]);
$promise = $client->getFailbackReplicationConfigurationAsync([/* ... */]);

Parameter Syntax

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

Parameter Details

Result Syntax

[
    'bandwidthThrottling' => <integer>,
    'name' => '<string>',
    'recoveryInstanceID' => '<string>',
    'usePrivateIP' => true || false,
]

Result Details

Errors

• ResourceNotFoundException:

  The resource for this operation was not found.

• InternalServerException:

  The request processing has failed because of an unknown error, exception or failure.

• ThrottlingException:

  The request was denied due to request throttling.

• UninitializedAccountException:

  The account performing the request has not been initialized.

GetLaunchConfiguration

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

Parameter Syntax

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

Parameter Details

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

Errors

• ResourceNotFoundException:

  The resource for this operation was not found.

• InternalServerException:

  The request processing has failed because of an unknown error, exception or failure.

• ThrottlingException:

  The request was denied due to request throttling.

• UninitializedAccountException:

  The account performing the request has not been initialized.

GetReplicationConfiguration

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

Parameter Syntax

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

Parameter Details

Result Syntax

[
    'associateDefaultSecurityGroup' => true || false,
    'bandwidthThrottling' => <integer>,
    'createPublicIP' => true || false,
    'dataPlaneRouting' => 'PRIVATE_IP|PUBLIC_IP',
    'defaultLargeStagingDiskType' => 'GP2|GP3|ST1|AUTO',
    'ebsEncryption' => 'DEFAULT|CUSTOM',
    'ebsEncryptionKeyArn' => '<string>',
    'name' => '<string>',
    'pitPolicy' => [
        [
            'enabled' => true || false,
            'interval' => <integer>,
            'retentionDuration' => <integer>,
            'ruleID' => <integer>,
            'units' => 'MINUTE|HOUR|DAY',
        ],
        // ...
    ],
    'replicatedDisks' => [
        [
            'deviceName' => '<string>',
            'iops' => <integer>,
            'isBootDisk' => true || false,
            'optimizedStagingDiskType' => 'AUTO|GP2|GP3|IO1|SC1|ST1|STANDARD',
            'stagingDiskType' => 'AUTO|GP2|GP3|IO1|SC1|ST1|STANDARD',
            'throughput' => <integer>,
        ],
        // ...
    ],
    'replicationServerInstanceType' => '<string>',
    'replicationServersSecurityGroupsIDs' => ['<string>', ...],
    'sourceServerID' => '<string>',
    'stagingAreaSubnetId' => '<string>',
    'stagingAreaTags' => ['<string>', ...],
    'useDedicatedReplicationServer' => true || false,
]

Result Details

Errors

• ResourceNotFoundException:

  The resource for this operation was not found.

• InternalServerException:

  The request processing has failed because of an unknown error, exception or failure.

• ThrottlingException:

  The request was denied due to request throttling.

• AccessDeniedException:

  You do not have sufficient access to perform this action.

• UninitializedAccountException:

  The account performing the request has not been initialized.

InitializeService

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

Parameter Syntax

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

Parameter Details

Result Syntax

[]

Result Details

Errors

• InternalServerException:

  The request processing has failed because of an unknown error, exception or failure.

• ThrottlingException:

  The request was denied due to request throttling.

• AccessDeniedException:

  You do not have sufficient access to perform this action.

• ValidationException:

  The input fails to satisfy the constraints specified by the AWS service.

ListExtensibleSourceServers

$result = $client->listExtensibleSourceServers([/* ... */]);
$promise = $client->listExtensibleSourceServersAsync([/* ... */]);

Parameter Syntax

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

Parameter Details

Result Syntax

[
    'items' => [
        [
            'arn' => '<string>',
            'hostname' => '<string>',
            'tags' => ['<string>', ...],
        ],
        // ...
    ],
    'nextToken' => '<string>',
]

Result Details

Errors

• InternalServerException:

  The request processing has failed because of an unknown error, exception or failure.

• ThrottlingException:

  The request was denied due to request throttling.

• AccessDeniedException:

  You do not have sufficient access to perform this action.

• ValidationException:

  The input fails to satisfy the constraints specified by the AWS service.

• UninitializedAccountException:

  The account performing the request has not been initialized.

ListStagingAccounts

$result = $client->listStagingAccounts([/* ... */]);
$promise = $client->listStagingAccountsAsync([/* ... */]);

Parameter Syntax

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

Parameter Details

Result Syntax

[
    'accounts' => [
        [
            'accountID' => '<string>',
        ],
        // ...
    ],
    'nextToken' => '<string>',
]

Result Details

Errors

• InternalServerException:

  The request processing has failed because of an unknown error, exception or failure.

• ThrottlingException:

  The request was denied due to request throttling.

• AccessDeniedException:

  You do not have sufficient access to perform this action.

• ValidationException:

  The input fails to satisfy the constraints specified by the AWS service.

• UninitializedAccountException:

  The account performing the request has not been initialized.

ListTagsForResource

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

Parameter Syntax

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

Parameter Details

Result Syntax

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

Result Details

Errors

• ResourceNotFoundException:

  The resource for this operation was not found.

• InternalServerException:

  The request processing has failed because of an unknown error, exception or failure.

• ThrottlingException:

  The request was denied due to request throttling.

• AccessDeniedException:

  You do not have sufficient access to perform this action.

• ValidationException:

  The input fails to satisfy the constraints specified by the AWS service.

RetryDataReplication

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

Parameter Syntax

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

Parameter Details

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>,
            ],
            // ...
        ],
    ],
    'lastLaunchResult' => 'NOT_STARTED|PENDING|SUCCEEDED|FAILED',
    'lifeCycle' => [
        'addedToServiceDateTime' => '<string>',
        'elapsedReplicationDuration' => '<string>',
        'firstByteDateTime' => '<string>',
        'lastLaunch' => [
            'initiated' => [
                'apiCallDateTime' => '<string>',
                'jobID' => '<string>',
                'type' => 'RECOVERY|DRILL',
            ],
        ],
        'lastSeenByServiceDateTime' => '<string>',
    ],
    'recoveryInstanceId' => '<string>',
    'replicationDirection' => 'FAILOVER|FAILBACK',
    'reversedDirectionSourceServerArn' => '<string>',
    'sourceCloudProperties' => [
        'originAccountID' => '<string>',
        'originAvailabilityZone' => '<string>',
        'originRegion' => '<string>',
    ],
    '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>',
    'stagingArea' => [
        'errorMessage' => '<string>',
        'stagingAccountID' => '<string>',
        'stagingSourceServerArn' => '<string>',
        'status' => 'EXTENDED|EXTENSION_ERROR|NOT_EXTENDED',
    ],
    'tags' => ['<string>', ...],
]

Result Details

Errors

• ResourceNotFoundException:

  The resource for this operation was not found.

• InternalServerException:

  The request processing has failed because of an unknown error, exception or failure.

• ThrottlingException:

  The request was denied due to request throttling.

• ValidationException:

  The input fails to satisfy the constraints specified by the AWS service.

• UninitializedAccountException:

  The account performing the request has not been initialized.

ReverseReplication

$result = $client->reverseReplication([/* ... */]);
$promise = $client->reverseReplicationAsync([/* ... */]);

Parameter Syntax

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

Parameter Details

Result Syntax

[
    'reversedDirectionSourceServerArn' => '<string>',
]

Result Details

Errors

• ResourceNotFoundException:

  The resource for this operation was not found.

• InternalServerException:

  The request processing has failed because of an unknown error, exception or failure.

• ConflictException:

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

• ThrottlingException:

  The request was denied due to request throttling.

• AccessDeniedException:

  You do not have sufficient access to perform this action.

• ValidationException:

  The input fails to satisfy the constraints specified by the AWS service.

• UninitializedAccountException:

  The account performing the request has not been initialized.

StartFailbackLaunch

$result = $client->startFailbackLaunch([/* ... */]);
$promise = $client->startFailbackLaunchAsync([/* ... */]);

Parameter Syntax

$result = $client->startFailbackLaunch([
    'recoveryInstanceIDs' => ['<string>', ...], // REQUIRED
    'tags' => ['<string>', ...],
]);

Parameter Details

Result Syntax

[
    'job' => [
        'arn' => '<string>',
        'creationDateTime' => '<string>',
        'endDateTime' => '<string>',
        'initiatedBy' => 'START_RECOVERY|START_DRILL|FAILBACK|DIAGNOSTIC|TERMINATE_RECOVERY_INSTANCES|TARGET_ACCOUNT',
        'jobID' => '<string>',
        'participatingServers' => [
            [
                'launchStatus' => 'PENDING|IN_PROGRESS|LAUNCHED|FAILED|TERMINATED',
                'recoveryInstanceID' => '<string>',
                'sourceServerID' => '<string>',
            ],
            // ...
        ],
        'status' => 'PENDING|STARTED|COMPLETED',
        'tags' => ['<string>', ...],
        'type' => 'LAUNCH|TERMINATE|CREATE_CONVERTED_SNAPSHOT',
    ],
]

Result Details

Errors

• InternalServerException:

  The request processing has failed because of an unknown error, exception or failure.

• ConflictException:

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

• ServiceQuotaExceededException:

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

• ThrottlingException:

  The request was denied due to request throttling.

• ValidationException:

  The input fails to satisfy the constraints specified by the AWS service.

• UninitializedAccountException:

  The account performing the request has not been initialized.

StartRecovery

$result = $client->startRecovery([/* ... */]);
$promise = $client->startRecoveryAsync([/* ... */]);

Parameter Syntax

$result = $client->startRecovery([
    'isDrill' => true || false,
    'sourceServers' => [ // REQUIRED
        [
            'recoverySnapshotID' => '<string>',
            'sourceServerID' => '<string>', // REQUIRED
        ],
        // ...
    ],
    'tags' => ['<string>', ...],
]);

Parameter Details

Result Syntax

[
    'job' => [
        'arn' => '<string>',
        'creationDateTime' => '<string>',
        'endDateTime' => '<string>',
        'initiatedBy' => 'START_RECOVERY|START_DRILL|FAILBACK|DIAGNOSTIC|TERMINATE_RECOVERY_INSTANCES|TARGET_ACCOUNT',
        'jobID' => '<string>',
        'participatingServers' => [
            [
                'launchStatus' => 'PENDING|IN_PROGRESS|LAUNCHED|FAILED|TERMINATED',
                'recoveryInstanceID' => '<string>',
                'sourceServerID' => '<string>',
            ],
            // ...
        ],
        'status' => 'PENDING|STARTED|COMPLETED',
        'tags' => ['<string>', ...],
        'type' => 'LAUNCH|TERMINATE|CREATE_CONVERTED_SNAPSHOT',
    ],
]

Result Details

Errors

• InternalServerException:

  The request processing has failed because of an unknown error, exception or failure.

• ConflictException:

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

• ServiceQuotaExceededException:

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

• ThrottlingException:

  The request was denied due to request throttling.

• UninitializedAccountException:

  The account performing the request has not been initialized.

StartReplication

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

Parameter Syntax

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

Parameter Details

Result Syntax

[
    'sourceServer' => [
        '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>,
                ],
                // ...
            ],
        ],
        'lastLaunchResult' => 'NOT_STARTED|PENDING|SUCCEEDED|FAILED',
        'lifeCycle' => [
            'addedToServiceDateTime' => '<string>',
            'elapsedReplicationDuration' => '<string>',
            'firstByteDateTime' => '<string>',
            'lastLaunch' => [
                'initiated' => [
                    'apiCallDateTime' => '<string>',
                    'jobID' => '<string>',
                    'type' => 'RECOVERY|DRILL',
                ],
            ],
            'lastSeenByServiceDateTime' => '<string>',
        ],
        'recoveryInstanceId' => '<string>',
        'replicationDirection' => 'FAILOVER|FAILBACK',
        'reversedDirectionSourceServerArn' => '<string>',
        'sourceCloudProperties' => [
            'originAccountID' => '<string>',
            'originAvailabilityZone' => '<string>',
            'originRegion' => '<string>',
        ],
        '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>',
        'stagingArea' => [
            'errorMessage' => '<string>',
            'stagingAccountID' => '<string>',
            'stagingSourceServerArn' => '<string>',
            'status' => 'EXTENDED|EXTENSION_ERROR|NOT_EXTENDED',
        ],
        'tags' => ['<string>', ...],
    ],
]

Result Details

Errors

• ResourceNotFoundException:

  The resource for this operation was not found.

• InternalServerException:

  The request processing has failed because of an unknown error, exception or failure.

• ConflictException:

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

• ThrottlingException:

  The request was denied due to request throttling.

• UninitializedAccountException:

  The account performing the request has not been initialized.

StopFailback

$result = $client->stopFailback([/* ... */]);
$promise = $client->stopFailbackAsync([/* ... */]);

Parameter Syntax

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

Parameter Details

Result Syntax

[]

Result Details

Errors

• ResourceNotFoundException:

  The resource for this operation was not found.

• InternalServerException:

  The request processing has failed because of an unknown error, exception or failure.

• ThrottlingException:

  The request was denied due to request throttling.

• UninitializedAccountException:

  The account performing the request has not been initialized.

StopReplication

$result = $client->stopReplication([/* ... */]);
$promise = $client->stopReplicationAsync([/* ... */]);

Parameter Syntax

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

Parameter Details

Result Syntax

[
    'sourceServer' => [
        '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>,
                ],
                // ...
            ],
        ],
        'lastLaunchResult' => 'NOT_STARTED|PENDING|SUCCEEDED|FAILED',
        'lifeCycle' => [
            'addedToServiceDateTime' => '<string>',
            'elapsedReplicationDuration' => '<string>',
            'firstByteDateTime' => '<string>',
            'lastLaunch' => [
                'initiated' => [
                    'apiCallDateTime' => '<string>',
                    'jobID' => '<string>',
                    'type' => 'RECOVERY|DRILL',
                ],
            ],
            'lastSeenByServiceDateTime' => '<string>',
        ],
        'recoveryInstanceId' => '<string>',
        'replicationDirection' => 'FAILOVER|FAILBACK',
        'reversedDirectionSourceServerArn' => '<string>',
        'sourceCloudProperties' => [
            'originAccountID' => '<string>',
            'originAvailabilityZone' => '<string>',
            'originRegion' => '<string>',
        ],
        '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>',
        'stagingArea' => [
            'errorMessage' => '<string>',
            'stagingAccountID' => '<string>',
            'stagingSourceServerArn' => '<string>',
            'status' => 'EXTENDED|EXTENSION_ERROR|NOT_EXTENDED',
        ],
        'tags' => ['<string>', ...],
    ],
]

Result Details

Errors

• ResourceNotFoundException:

  The resource for this operation was not found.

• InternalServerException:

  The request processing has failed because of an unknown error, exception or failure.

• ConflictException:

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

• ThrottlingException:

  The request was denied due to request throttling.

• UninitializedAccountException:

  The account performing the request has not been initialized.

TagResource

$result = $client->tagResource([/* ... */]);
$promise = $client->tagResourceAsync([/* ... */]);

Parameter Syntax

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

Parameter Details

Result Syntax

[]

Result Details

Errors

• ResourceNotFoundException:

  The resource for this operation was not found.

• InternalServerException:

  The request processing has failed because of an unknown error, exception or failure.

• ThrottlingException:

  The request was denied due to request throttling.

• AccessDeniedException:

  You do not have sufficient access to perform this action.

• ValidationException:

  The input fails to satisfy the constraints specified by the AWS service.

TerminateRecoveryInstances

$result = $client->terminateRecoveryInstances([/* ... */]);
$promise = $client->terminateRecoveryInstancesAsync([/* ... */]);

Parameter Syntax

$result = $client->terminateRecoveryInstances([
    'recoveryInstanceIDs' => ['<string>', ...], // REQUIRED
]);

Parameter Details

Result Syntax

[
    'job' => [
        'arn' => '<string>',
        'creationDateTime' => '<string>',
        'endDateTime' => '<string>',
        'initiatedBy' => 'START_RECOVERY|START_DRILL|FAILBACK|DIAGNOSTIC|TERMINATE_RECOVERY_INSTANCES|TARGET_ACCOUNT',
        'jobID' => '<string>',
        'participatingServers' => [
            [
                'launchStatus' => 'PENDING|IN_PROGRESS|LAUNCHED|FAILED|TERMINATED',
                'recoveryInstanceID' => '<string>',
                'sourceServerID' => '<string>',
            ],
            // ...
        ],
        'status' => 'PENDING|STARTED|COMPLETED',
        'tags' => ['<string>', ...],
        'type' => 'LAUNCH|TERMINATE|CREATE_CONVERTED_SNAPSHOT',
    ],
]

Result Details

Errors

• InternalServerException:

  The request processing has failed because of an unknown error, exception or failure.

• ConflictException:

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

• ServiceQuotaExceededException:

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

• ThrottlingException:

  The request was denied due to request throttling.

• UninitializedAccountException:

  The account performing the request has not been initialized.

UntagResource

$result = $client->untagResource([/* ... */]);
$promise = $client->untagResourceAsync([/* ... */]);

Parameter Syntax

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

Parameter Details

Result Syntax

[]

Result Details

Errors

• ResourceNotFoundException:

  The resource for this operation was not found.

• InternalServerException:

  The request processing has failed because of an unknown error, exception or failure.

• ThrottlingException:

  The request was denied due to request throttling.

• AccessDeniedException:

  You do not have sufficient access to perform this action.

• ValidationException:

  The input fails to satisfy the constraints specified by the AWS service.

UpdateFailbackReplicationConfiguration

$result = $client->updateFailbackReplicationConfiguration([/* ... */]);
$promise = $client->updateFailbackReplicationConfigurationAsync([/* ... */]);

Parameter Syntax

$result = $client->updateFailbackReplicationConfiguration([
    'bandwidthThrottling' => <integer>,
    'name' => '<string>',
    'recoveryInstanceID' => '<string>', // REQUIRED
    'usePrivateIP' => true || false,
]);

Parameter Details

Result Syntax

[]

Result Details

Errors

• ResourceNotFoundException:

  The resource for this operation was not found.

• InternalServerException:

  The request processing has failed because of an unknown error, exception or failure.

• ThrottlingException:

  The request was denied due to request throttling.

• AccessDeniedException:

  You do not have sufficient access to perform this action.

• UninitializedAccountException:

  The account performing the request has not been initialized.

UpdateLaunchConfiguration

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

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

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

Errors

• ResourceNotFoundException:

  The resource for this operation was not found.

• InternalServerException:

  The request processing has failed because of an unknown error, exception or failure.

• ConflictException:

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

• ThrottlingException:

  The request was denied due to request throttling.

• ValidationException:

  The input fails to satisfy the constraints specified by the AWS service.

• UninitializedAccountException:

  The account performing the request has not been initialized.

UpdateReplicationConfiguration

$result = $client->updateReplicationConfiguration([/* ... */]);
$promise = $client->updateReplicationConfigurationAsync([/* ... */]);

Parameter Syntax

$result = $client->updateReplicationConfiguration([
    'associateDefaultSecurityGroup' => true || false,
    'bandwidthThrottling' => <integer>,
    'createPublicIP' => true || false,
    'dataPlaneRouting' => 'PRIVATE_IP|PUBLIC_IP',
    'defaultLargeStagingDiskType' => 'GP2|GP3|ST1|AUTO',
    'ebsEncryption' => 'DEFAULT|CUSTOM',
    'ebsEncryptionKeyArn' => '<string>',
    'name' => '<string>',
    'pitPolicy' => [
        [
            'enabled' => true || false,
            'interval' => <integer>, // REQUIRED
            'retentionDuration' => <integer>, // REQUIRED
            'ruleID' => <integer>,
            'units' => 'MINUTE|HOUR|DAY', // REQUIRED
        ],
        // ...
    ],
    'replicatedDisks' => [
        [
            'deviceName' => '<string>',
            'iops' => <integer>,
            'isBootDisk' => true || false,
            'optimizedStagingDiskType' => 'AUTO|GP2|GP3|IO1|SC1|ST1|STANDARD',
            'stagingDiskType' => 'AUTO|GP2|GP3|IO1|SC1|ST1|STANDARD',
            'throughput' => <integer>,
        ],
        // ...
    ],
    'replicationServerInstanceType' => '<string>',
    'replicationServersSecurityGroupsIDs' => ['<string>', ...],
    'sourceServerID' => '<string>', // REQUIRED
    'stagingAreaSubnetId' => '<string>',
    'stagingAreaTags' => ['<string>', ...],
    'useDedicatedReplicationServer' => true || false,
]);

Parameter Details