CreateApp

$result = $client->createApp([/* ... */]);
$promise = $client->createAppAsync([/* ... */]);

Creates an application. An application consists of one or more server groups. Each server group contain one or more servers.

Parameter Syntax

$result = $client->createApp([
    'clientToken' => '<string>',
    'description' => '<string>',
    'name' => '<string>',
    'roleName' => '<string>',
    'serverGroups' => [
        [
            'name' => '<string>',
            'serverGroupId' => '<string>',
            'serverList' => [
                [
                    'replicationJobId' => '<string>',
                    'replicationJobTerminated' => true || false,
                    'serverId' => '<string>',
                    'serverType' => 'VIRTUAL_MACHINE',
                    'vmServer' => [
                        'vmManagerName' => '<string>',
                        'vmManagerType' => 'VSPHERE|SCVMM|HYPERV-MANAGER',
                        'vmName' => '<string>',
                        'vmPath' => '<string>',
                        'vmServerAddress' => [
                            'vmId' => '<string>',
                            'vmManagerId' => '<string>',
                        ],
                    ],
                ],
                // ...
            ],
        ],
        // ...
    ],
    'tags' => [
        [
            'key' => '<string>',
            'value' => '<string>',
        ],
        // ...
    ],
]);

Parameter Details

Result Syntax

[
    'appSummary' => [
        'appId' => '<string>',
        'creationTime' => <DateTime>,
        'description' => '<string>',
        'importedAppId' => '<string>',
        'lastModified' => <DateTime>,
        'latestReplicationTime' => <DateTime>,
        'launchConfigurationStatus' => 'NOT_CONFIGURED|CONFIGURED',
        'launchDetails' => [
            'latestLaunchTime' => <DateTime>,
            'stackId' => '<string>',
            'stackName' => '<string>',
        ],
        'launchStatus' => 'READY_FOR_CONFIGURATION|CONFIGURATION_IN_PROGRESS|CONFIGURATION_INVALID|READY_FOR_LAUNCH|VALIDATION_IN_PROGRESS|LAUNCH_PENDING|LAUNCH_IN_PROGRESS|LAUNCHED|PARTIALLY_LAUNCHED|DELTA_LAUNCH_IN_PROGRESS|DELTA_LAUNCH_FAILED|LAUNCH_FAILED|TERMINATE_IN_PROGRESS|TERMINATE_FAILED|TERMINATED',
        'launchStatusMessage' => '<string>',
        'name' => '<string>',
        'replicationConfigurationStatus' => 'NOT_CONFIGURED|CONFIGURED',
        'replicationStatus' => 'READY_FOR_CONFIGURATION|CONFIGURATION_IN_PROGRESS|CONFIGURATION_INVALID|READY_FOR_REPLICATION|VALIDATION_IN_PROGRESS|REPLICATION_PENDING|REPLICATION_IN_PROGRESS|REPLICATED|PARTIALLY_REPLICATED|DELTA_REPLICATION_IN_PROGRESS|DELTA_REPLICATED|DELTA_REPLICATION_FAILED|REPLICATION_FAILED|REPLICATION_STOPPING|REPLICATION_STOP_FAILED|REPLICATION_STOPPED',
        'replicationStatusMessage' => '<string>',
        'roleName' => '<string>',
        'status' => 'CREATING|ACTIVE|UPDATING|DELETING|DELETED|DELETE_FAILED',
        'statusMessage' => '<string>',
        'totalServerGroups' => <integer>,
        'totalServers' => <integer>,
    ],
    'serverGroups' => [
        [
            'name' => '<string>',
            'serverGroupId' => '<string>',
            'serverList' => [
                [
                    'replicationJobId' => '<string>',
                    'replicationJobTerminated' => true || false,
                    'serverId' => '<string>',
                    'serverType' => 'VIRTUAL_MACHINE',
                    'vmServer' => [
                        'vmManagerName' => '<string>',
                        'vmManagerType' => 'VSPHERE|SCVMM|HYPERV-MANAGER',
                        'vmName' => '<string>',
                        'vmPath' => '<string>',
                        'vmServerAddress' => [
                            'vmId' => '<string>',
                            'vmManagerId' => '<string>',
                        ],
                    ],
                ],
                // ...
            ],
        ],
        // ...
    ],
    'tags' => [
        [
            'key' => '<string>',
            'value' => '<string>',
        ],
        // ...
    ],
]

Result Details

Errors

UnauthorizedOperationException:

You lack permissions needed to perform this operation. Check your IAM policies, and ensure that you are using the correct access keys.

InvalidParameterException:

A specified parameter is not valid.

MissingRequiredParameterException:

A required parameter is missing.

InternalError:

An internal error occurred.

OperationNotPermittedException:

This operation is not allowed.

CreateReplicationJob

$result = $client->createReplicationJob([/* ... */]);
$promise = $client->createReplicationJobAsync([/* ... */]);

Creates a replication job. The replication job schedules periodic replication runs to replicate your server to Amazon Web Services. Each replication run creates an Amazon Machine Image (AMI).

Parameter Syntax

$result = $client->createReplicationJob([
    'description' => '<string>',
    'encrypted' => true || false,
    'frequency' => <integer>,
    'kmsKeyId' => '<string>',
    'licenseType' => 'AWS|BYOL',
    'numberOfRecentAmisToKeep' => <integer>,
    'roleName' => '<string>',
    'runOnce' => true || false,
    'seedReplicationTime' => <integer || string || DateTime>, // REQUIRED
    'serverId' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

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

Result Details

Errors

InvalidParameterException:

A specified parameter is not valid.

MissingRequiredParameterException:

A required parameter is missing.

UnauthorizedOperationException:

You lack permissions needed to perform this operation. Check your IAM policies, and ensure that you are using the correct access keys.

OperationNotPermittedException:

This operation is not allowed.

ServerCannotBeReplicatedException:

The specified server cannot be replicated.

ReplicationJobAlreadyExistsException:

The specified replication job already exists.

NoConnectorsAvailableException:

There are no connectors available.

InternalError:

An internal error occurred.

TemporarilyUnavailableException:

The service is temporarily unavailable.

DeleteApp

$result = $client->deleteApp([/* ... */]);
$promise = $client->deleteAppAsync([/* ... */]);

Deletes the specified application. Optionally deletes the launched stack associated with the application and all Server Migration Service replication jobs for servers in the application.

Parameter Syntax

$result = $client->deleteApp([
    'appId' => '<string>',
    'forceStopAppReplication' => true || false,
    'forceTerminateApp' => true || false,
]);

Parameter Details

Result Syntax

[]

Result Details

Errors

UnauthorizedOperationException:

You lack permissions needed to perform this operation. Check your IAM policies, and ensure that you are using the correct access keys.

InvalidParameterException:

A specified parameter is not valid.

MissingRequiredParameterException:

A required parameter is missing.

InternalError:

An internal error occurred.

OperationNotPermittedException:

This operation is not allowed.

DeleteAppLaunchConfiguration

$result = $client->deleteAppLaunchConfiguration([/* ... */]);
$promise = $client->deleteAppLaunchConfigurationAsync([/* ... */]);

Deletes the launch configuration for the specified application.

Parameter Syntax

$result = $client->deleteAppLaunchConfiguration([
    'appId' => '<string>',
]);

Parameter Details

Result Syntax

[]

Result Details

Errors

UnauthorizedOperationException:

You lack permissions needed to perform this operation. Check your IAM policies, and ensure that you are using the correct access keys.

InvalidParameterException:

A specified parameter is not valid.

MissingRequiredParameterException:

A required parameter is missing.

InternalError:

An internal error occurred.

OperationNotPermittedException:

This operation is not allowed.

DeleteAppReplicationConfiguration

$result = $client->deleteAppReplicationConfiguration([/* ... */]);
$promise = $client->deleteAppReplicationConfigurationAsync([/* ... */]);

Deletes the replication configuration for the specified application.

Parameter Syntax

$result = $client->deleteAppReplicationConfiguration([
    'appId' => '<string>',
]);

Parameter Details

Result Syntax

[]

Result Details

Errors

UnauthorizedOperationException:

You lack permissions needed to perform this operation. Check your IAM policies, and ensure that you are using the correct access keys.

InvalidParameterException:

A specified parameter is not valid.

MissingRequiredParameterException:

A required parameter is missing.

InternalError:

An internal error occurred.

OperationNotPermittedException:

This operation is not allowed.

DeleteAppValidationConfiguration

$result = $client->deleteAppValidationConfiguration([/* ... */]);
$promise = $client->deleteAppValidationConfigurationAsync([/* ... */]);

Deletes the validation configuration for the specified application.

Parameter Syntax

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

Parameter Details

Result Syntax

[]

Result Details

Errors

UnauthorizedOperationException:

You lack permissions needed to perform this operation. Check your IAM policies, and ensure that you are using the correct access keys.

InvalidParameterException:

A specified parameter is not valid.

MissingRequiredParameterException:

A required parameter is missing.

InternalError:

An internal error occurred.

OperationNotPermittedException:

This operation is not allowed.

DeleteReplicationJob

$result = $client->deleteReplicationJob([/* ... */]);
$promise = $client->deleteReplicationJobAsync([/* ... */]);

Deletes the specified replication job.

After you delete a replication job, there are no further replication runs. Amazon Web Services deletes the contents of the Amazon S3 bucket used to store Server Migration Service artifacts. The AMIs created by the replication runs are not deleted.

Parameter Syntax

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

Parameter Details

Result Syntax

[]

Result Details

Errors

InvalidParameterException:

A specified parameter is not valid.

MissingRequiredParameterException:

A required parameter is missing.

UnauthorizedOperationException:

You lack permissions needed to perform this operation. Check your IAM policies, and ensure that you are using the correct access keys.

OperationNotPermittedException:

This operation is not allowed.

ReplicationJobNotFoundException:

The specified replication job does not exist.

DeleteServerCatalog

$result = $client->deleteServerCatalog([/* ... */]);
$promise = $client->deleteServerCatalogAsync([/* ... */]);

Deletes all servers from your server catalog.

Parameter Syntax

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

Parameter Details

Result Syntax

[]

Result Details

Errors

UnauthorizedOperationException:

You lack permissions needed to perform this operation. Check your IAM policies, and ensure that you are using the correct access keys.

OperationNotPermittedException:

This operation is not allowed.

InvalidParameterException:

A specified parameter is not valid.

MissingRequiredParameterException:

A required parameter is missing.

DisassociateConnector

$result = $client->disassociateConnector([/* ... */]);
$promise = $client->disassociateConnectorAsync([/* ... */]);

Disassociates the specified connector from Server Migration Service.

After you disassociate a connector, it is no longer available to support replication jobs.

Parameter Syntax

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

Parameter Details

Result Syntax

[]

Result Details

Errors

MissingRequiredParameterException:

A required parameter is missing.

UnauthorizedOperationException:

You lack permissions needed to perform this operation. Check your IAM policies, and ensure that you are using the correct access keys.

OperationNotPermittedException:

This operation is not allowed.

InvalidParameterException:

A specified parameter is not valid.

GenerateChangeSet

$result = $client->generateChangeSet([/* ... */]);
$promise = $client->generateChangeSetAsync([/* ... */]);

Generates a target change set for a currently launched stack and writes it to an Amazon S3 object in the customer’s Amazon S3 bucket.

Parameter Syntax

$result = $client->generateChangeSet([
    'appId' => '<string>',
    'changesetFormat' => 'JSON|YAML',
]);

Parameter Details

Result Syntax

[
    's3Location' => [
        'bucket' => '<string>',
        'key' => '<string>',
    ],
]

Result Details

Errors

UnauthorizedOperationException:

You lack permissions needed to perform this operation. Check your IAM policies, and ensure that you are using the correct access keys.

InvalidParameterException:

A specified parameter is not valid.

MissingRequiredParameterException:

A required parameter is missing.

InternalError:

An internal error occurred.

OperationNotPermittedException:

This operation is not allowed.

GenerateTemplate

$result = $client->generateTemplate([/* ... */]);
$promise = $client->generateTemplateAsync([/* ... */]);

Generates an CloudFormation template based on the current launch configuration and writes it to an Amazon S3 object in the customer’s Amazon S3 bucket.

Parameter Syntax

$result = $client->generateTemplate([
    'appId' => '<string>',
    'templateFormat' => 'JSON|YAML',
]);

Parameter Details

Result Syntax

[
    's3Location' => [
        'bucket' => '<string>',
        'key' => '<string>',
    ],
]

Result Details

Errors

UnauthorizedOperationException:

You lack permissions needed to perform this operation. Check your IAM policies, and ensure that you are using the correct access keys.

InvalidParameterException:

A specified parameter is not valid.

MissingRequiredParameterException:

A required parameter is missing.

InternalError:

An internal error occurred.

OperationNotPermittedException:

This operation is not allowed.

GetApp

$result = $client->getApp([/* ... */]);
$promise = $client->getAppAsync([/* ... */]);

Retrieve information about the specified application.

Parameter Syntax

$result = $client->getApp([
    'appId' => '<string>',
]);

Parameter Details

Result Syntax

[
    'appSummary' => [
        'appId' => '<string>',
        'creationTime' => <DateTime>,
        'description' => '<string>',
        'importedAppId' => '<string>',
        'lastModified' => <DateTime>,
        'latestReplicationTime' => <DateTime>,
        'launchConfigurationStatus' => 'NOT_CONFIGURED|CONFIGURED',
        'launchDetails' => [
            'latestLaunchTime' => <DateTime>,
            'stackId' => '<string>',
            'stackName' => '<string>',
        ],
        'launchStatus' => 'READY_FOR_CONFIGURATION|CONFIGURATION_IN_PROGRESS|CONFIGURATION_INVALID|READY_FOR_LAUNCH|VALIDATION_IN_PROGRESS|LAUNCH_PENDING|LAUNCH_IN_PROGRESS|LAUNCHED|PARTIALLY_LAUNCHED|DELTA_LAUNCH_IN_PROGRESS|DELTA_LAUNCH_FAILED|LAUNCH_FAILED|TERMINATE_IN_PROGRESS|TERMINATE_FAILED|TERMINATED',
        'launchStatusMessage' => '<string>',
        'name' => '<string>',
        'replicationConfigurationStatus' => 'NOT_CONFIGURED|CONFIGURED',
        'replicationStatus' => 'READY_FOR_CONFIGURATION|CONFIGURATION_IN_PROGRESS|CONFIGURATION_INVALID|READY_FOR_REPLICATION|VALIDATION_IN_PROGRESS|REPLICATION_PENDING|REPLICATION_IN_PROGRESS|REPLICATED|PARTIALLY_REPLICATED|DELTA_REPLICATION_IN_PROGRESS|DELTA_REPLICATED|DELTA_REPLICATION_FAILED|REPLICATION_FAILED|REPLICATION_STOPPING|REPLICATION_STOP_FAILED|REPLICATION_STOPPED',
        'replicationStatusMessage' => '<string>',
        'roleName' => '<string>',
        'status' => 'CREATING|ACTIVE|UPDATING|DELETING|DELETED|DELETE_FAILED',
        'statusMessage' => '<string>',
        'totalServerGroups' => <integer>,
        'totalServers' => <integer>,
    ],
    'serverGroups' => [
        [
            'name' => '<string>',
            'serverGroupId' => '<string>',
            'serverList' => [
                [
                    'replicationJobId' => '<string>',
                    'replicationJobTerminated' => true || false,
                    'serverId' => '<string>',
                    'serverType' => 'VIRTUAL_MACHINE',
                    'vmServer' => [
                        'vmManagerName' => '<string>',
                        'vmManagerType' => 'VSPHERE|SCVMM|HYPERV-MANAGER',
                        'vmName' => '<string>',
                        'vmPath' => '<string>',
                        'vmServerAddress' => [
                            'vmId' => '<string>',
                            'vmManagerId' => '<string>',
                        ],
                    ],
                ],
                // ...
            ],
        ],
        // ...
    ],
    'tags' => [
        [
            'key' => '<string>',
            'value' => '<string>',
        ],
        // ...
    ],
]

Result Details

Errors

UnauthorizedOperationException:

You lack permissions needed to perform this operation. Check your IAM policies, and ensure that you are using the correct access keys.

InvalidParameterException:

A specified parameter is not valid.

MissingRequiredParameterException:

A required parameter is missing.

InternalError:

An internal error occurred.

OperationNotPermittedException:

This operation is not allowed.

GetAppLaunchConfiguration

$result = $client->getAppLaunchConfiguration([/* ... */]);
$promise = $client->getAppLaunchConfigurationAsync([/* ... */]);

Retrieves the application launch configuration associated with the specified application.

Parameter Syntax

$result = $client->getAppLaunchConfiguration([
    'appId' => '<string>',
]);

Parameter Details

Result Syntax

[
    'appId' => '<string>',
    'autoLaunch' => true || false,
    'roleName' => '<string>',
    'serverGroupLaunchConfigurations' => [
        [
            'launchOrder' => <integer>,
            'serverGroupId' => '<string>',
            'serverLaunchConfigurations' => [
                [
                    'associatePublicIpAddress' => true || false,
                    'configureScript' => [
                        'bucket' => '<string>',
                        'key' => '<string>',
                    ],
                    'configureScriptType' => 'SHELL_SCRIPT|POWERSHELL_SCRIPT',
                    'ec2KeyName' => '<string>',
                    'iamInstanceProfileName' => '<string>',
                    'instanceType' => '<string>',
                    'logicalId' => '<string>',
                    'securityGroup' => '<string>',
                    'server' => [
                        'replicationJobId' => '<string>',
                        'replicationJobTerminated' => true || false,
                        'serverId' => '<string>',
                        'serverType' => 'VIRTUAL_MACHINE',
                        'vmServer' => [
                            'vmManagerName' => '<string>',
                            'vmManagerType' => 'VSPHERE|SCVMM|HYPERV-MANAGER',
                            'vmName' => '<string>',
                            'vmPath' => '<string>',
                            'vmServerAddress' => [
                                'vmId' => '<string>',
                                'vmManagerId' => '<string>',
                            ],
                        ],
                    ],
                    'subnet' => '<string>',
                    'userData' => [
                        's3Location' => [
                            'bucket' => '<string>',
                            'key' => '<string>',
                        ],
                    ],
                    'vpc' => '<string>',
                ],
                // ...
            ],
        ],
        // ...
    ],
]

Result Details

Errors

UnauthorizedOperationException:

You lack permissions needed to perform this operation. Check your IAM policies, and ensure that you are using the correct access keys.

InvalidParameterException:

A specified parameter is not valid.

MissingRequiredParameterException:

A required parameter is missing.

InternalError:

An internal error occurred.

OperationNotPermittedException:

This operation is not allowed.

GetAppReplicationConfiguration

$result = $client->getAppReplicationConfiguration([/* ... */]);
$promise = $client->getAppReplicationConfigurationAsync([/* ... */]);

Retrieves the application replication configuration associated with the specified application.

Parameter Syntax

$result = $client->getAppReplicationConfiguration([
    'appId' => '<string>',
]);

Parameter Details

Result Syntax

[
    'serverGroupReplicationConfigurations' => [
        [
            'serverGroupId' => '<string>',
            'serverReplicationConfigurations' => [
                [
                    'server' => [
                        'replicationJobId' => '<string>',
                        'replicationJobTerminated' => true || false,
                        'serverId' => '<string>',
                        'serverType' => 'VIRTUAL_MACHINE',
                        'vmServer' => [
                            'vmManagerName' => '<string>',
                            'vmManagerType' => 'VSPHERE|SCVMM|HYPERV-MANAGER',
                            'vmName' => '<string>',
                            'vmPath' => '<string>',
                            'vmServerAddress' => [
                                'vmId' => '<string>',
                                'vmManagerId' => '<string>',
                            ],
                        ],
                    ],
                    'serverReplicationParameters' => [
                        'encrypted' => true || false,
                        'frequency' => <integer>,
                        'kmsKeyId' => '<string>',
                        'licenseType' => 'AWS|BYOL',
                        'numberOfRecentAmisToKeep' => <integer>,
                        'runOnce' => true || false,
                        'seedTime' => <DateTime>,
                    ],
                ],
                // ...
            ],
        ],
        // ...
    ],
]

Result Details

Errors

UnauthorizedOperationException:

You lack permissions needed to perform this operation. Check your IAM policies, and ensure that you are using the correct access keys.

InvalidParameterException:

A specified parameter is not valid.

MissingRequiredParameterException:

A required parameter is missing.

InternalError:

An internal error occurred.

OperationNotPermittedException:

This operation is not allowed.

GetAppValidationConfiguration

$result = $client->getAppValidationConfiguration([/* ... */]);
$promise = $client->getAppValidationConfigurationAsync([/* ... */]);

Retrieves information about a configuration for validating an application.

Parameter Syntax

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

Parameter Details

Result Syntax

[
    'appValidationConfigurations' => [
        [
            'appValidationStrategy' => 'SSM',
            'name' => '<string>',
            'ssmValidationParameters' => [
                'command' => '<string>',
                'executionTimeoutSeconds' => <integer>,
                'instanceId' => '<string>',
                'outputS3BucketName' => '<string>',
                'scriptType' => 'SHELL_SCRIPT|POWERSHELL_SCRIPT',
                'source' => [
                    's3Location' => [
                        'bucket' => '<string>',
                        'key' => '<string>',
                    ],
                ],
            ],
            'validationId' => '<string>',
        ],
        // ...
    ],
    'serverGroupValidationConfigurations' => [
        [
            'serverGroupId' => '<string>',
            'serverValidationConfigurations' => [
                [
                    'name' => '<string>',
                    'server' => [
                        'replicationJobId' => '<string>',
                        'replicationJobTerminated' => true || false,
                        'serverId' => '<string>',
                        'serverType' => 'VIRTUAL_MACHINE',
                        'vmServer' => [
                            'vmManagerName' => '<string>',
                            'vmManagerType' => 'VSPHERE|SCVMM|HYPERV-MANAGER',
                            'vmName' => '<string>',
                            'vmPath' => '<string>',
                            'vmServerAddress' => [
                                'vmId' => '<string>',
                                'vmManagerId' => '<string>',
                            ],
                        ],
                    ],
                    'serverValidationStrategy' => 'USERDATA',
                    'userDataValidationParameters' => [
                        'scriptType' => 'SHELL_SCRIPT|POWERSHELL_SCRIPT',
                        'source' => [
                            's3Location' => [
                                'bucket' => '<string>',
                                'key' => '<string>',
                            ],
                        ],
                    ],
                    'validationId' => '<string>',
                ],
                // ...
            ],
        ],
        // ...
    ],
]

Result Details

Errors

UnauthorizedOperationException:

You lack permissions needed to perform this operation. Check your IAM policies, and ensure that you are using the correct access keys.

InvalidParameterException:

A specified parameter is not valid.

MissingRequiredParameterException:

A required parameter is missing.

InternalError:

An internal error occurred.

OperationNotPermittedException:

This operation is not allowed.

GetAppValidationOutput

$result = $client->getAppValidationOutput([/* ... */]);
$promise = $client->getAppValidationOutputAsync([/* ... */]);

Retrieves output from validating an application.

Parameter Syntax

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

Parameter Details

Result Syntax

[
    'validationOutputList' => [
        [
            'appValidationOutput' => [
                'ssmOutput' => [
                    's3Location' => [
                        'bucket' => '<string>',
                        'key' => '<string>',
                    ],
                ],
            ],
            'latestValidationTime' => <DateTime>,
            'name' => '<string>',
            'serverValidationOutput' => [
                'server' => [
                    'replicationJobId' => '<string>',
                    'replicationJobTerminated' => true || false,
                    'serverId' => '<string>',
                    'serverType' => 'VIRTUAL_MACHINE',
                    'vmServer' => [
                        'vmManagerName' => '<string>',
                        'vmManagerType' => 'VSPHERE|SCVMM|HYPERV-MANAGER',
                        'vmName' => '<string>',
                        'vmPath' => '<string>',
                        'vmServerAddress' => [
                            'vmId' => '<string>',
                            'vmManagerId' => '<string>',
                        ],
                    ],
                ],
            ],
            'status' => 'READY_FOR_VALIDATION|PENDING|IN_PROGRESS|SUCCEEDED|FAILED',
            'statusMessage' => '<string>',
            'validationId' => '<string>',
        ],
        // ...
    ],
]

Result Details

Errors

UnauthorizedOperationException:

You lack permissions needed to perform this operation. Check your IAM policies, and ensure that you are using the correct access keys.

InvalidParameterException:

A specified parameter is not valid.

MissingRequiredParameterException:

A required parameter is missing.

InternalError:

An internal error occurred.

OperationNotPermittedException:

This operation is not allowed.

GetConnectors

$result = $client->getConnectors([/* ... */]);
$promise = $client->getConnectorsAsync([/* ... */]);

Describes the connectors registered with the Server Migration Service.

Parameter Syntax

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

Parameter Details

Result Syntax

[
    'connectorList' => [
        [
            'associatedOn' => <DateTime>,
            'capabilityList' => ['<string>', ...],
            'connectorId' => '<string>',
            'ipAddress' => '<string>',
            'macAddress' => '<string>',
            'status' => 'HEALTHY|UNHEALTHY',
            'version' => '<string>',
            'vmManagerId' => '<string>',
            'vmManagerName' => '<string>',
            'vmManagerType' => 'VSPHERE|SCVMM|HYPERV-MANAGER',
        ],
        // ...
    ],
    'nextToken' => '<string>',
]

Result Details

Errors

UnauthorizedOperationException:

You lack permissions needed to perform this operation. Check your IAM policies, and ensure that you are using the correct access keys.

GetReplicationJobs

$result = $client->getReplicationJobs([/* ... */]);
$promise = $client->getReplicationJobsAsync([/* ... */]);

Describes the specified replication job or all of your replication jobs.

Parameter Syntax

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

Parameter Details

Result Syntax

[
    'nextToken' => '<string>',
    'replicationJobList' => [
        [
            'description' => '<string>',
            'encrypted' => true || false,
            'frequency' => <integer>,
            'kmsKeyId' => '<string>',
            'latestAmiId' => '<string>',
            'licenseType' => 'AWS|BYOL',
            'nextReplicationRunStartTime' => <DateTime>,
            'numberOfRecentAmisToKeep' => <integer>,
            'replicationJobId' => '<string>',
            'replicationRunList' => [
                [
                    'amiId' => '<string>',
                    'completedTime' => <DateTime>,
                    'description' => '<string>',
                    'encrypted' => true || false,
                    'kmsKeyId' => '<string>',
                    'replicationRunId' => '<string>',
                    'scheduledStartTime' => <DateTime>,
                    'stageDetails' => [
                        'stage' => '<string>',
                        'stageProgress' => '<string>',
                    ],
                    'state' => 'PENDING|MISSED|ACTIVE|FAILED|COMPLETED|DELETING|DELETED',
                    'statusMessage' => '<string>',
                    'type' => 'ON_DEMAND|AUTOMATIC',
                ],
                // ...
            ],
            'roleName' => '<string>',
            'runOnce' => true || false,
            'seedReplicationTime' => <DateTime>,
            'serverId' => '<string>',
            'serverType' => 'VIRTUAL_MACHINE',
            'state' => 'PENDING|ACTIVE|FAILED|DELETING|DELETED|COMPLETED|PAUSED_ON_FAILURE|FAILING',
            'statusMessage' => '<string>',
            'vmServer' => [
                'vmManagerName' => '<string>',
                'vmManagerType' => 'VSPHERE|SCVMM|HYPERV-MANAGER',
                'vmName' => '<string>',
                'vmPath' => '<string>',
                'vmServerAddress' => [
                    'vmId' => '<string>',
                    'vmManagerId' => '<string>',
                ],
            ],
        ],
        // ...
    ],
]

Result Details

Errors

InvalidParameterException:

A specified parameter is not valid.

MissingRequiredParameterException:

A required parameter is missing.

UnauthorizedOperationException:

You lack permissions needed to perform this operation. Check your IAM policies, and ensure that you are using the correct access keys.

GetReplicationRuns

$result = $client->getReplicationRuns([/* ... */]);
$promise = $client->getReplicationRunsAsync([/* ... */]);

Describes the replication runs for the specified replication job.

Parameter Syntax

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

Parameter Details

Result Syntax

[
    'nextToken' => '<string>',
    'replicationJob' => [
        'description' => '<string>',
        'encrypted' => true || false,
        'frequency' => <integer>,
        'kmsKeyId' => '<string>',
        'latestAmiId' => '<string>',
        'licenseType' => 'AWS|BYOL',
        'nextReplicationRunStartTime' => <DateTime>,
        'numberOfRecentAmisToKeep' => <integer>,
        'replicationJobId' => '<string>',
        'replicationRunList' => [
            [
                'amiId' => '<string>',
                'completedTime' => <DateTime>,
                'description' => '<string>',
                'encrypted' => true || false,
                'kmsKeyId' => '<string>',
                'replicationRunId' => '<string>',
                'scheduledStartTime' => <DateTime>,
                'stageDetails' => [
                    'stage' => '<string>',
                    'stageProgress' => '<string>',
                ],
                'state' => 'PENDING|MISSED|ACTIVE|FAILED|COMPLETED|DELETING|DELETED',
                'statusMessage' => '<string>',
                'type' => 'ON_DEMAND|AUTOMATIC',
            ],
            // ...
        ],
        'roleName' => '<string>',
        'runOnce' => true || false,
        'seedReplicationTime' => <DateTime>,
        'serverId' => '<string>',
        'serverType' => 'VIRTUAL_MACHINE',
        'state' => 'PENDING|ACTIVE|FAILED|DELETING|DELETED|COMPLETED|PAUSED_ON_FAILURE|FAILING',
        'statusMessage' => '<string>',
        'vmServer' => [
            'vmManagerName' => '<string>',
            'vmManagerType' => 'VSPHERE|SCVMM|HYPERV-MANAGER',
            'vmName' => '<string>',
            'vmPath' => '<string>',
            'vmServerAddress' => [
                'vmId' => '<string>',
                'vmManagerId' => '<string>',
            ],
        ],
    ],
    'replicationRunList' => [
        [
            'amiId' => '<string>',
            'completedTime' => <DateTime>,
            'description' => '<string>',
            'encrypted' => true || false,
            'kmsKeyId' => '<string>',
            'replicationRunId' => '<string>',
            'scheduledStartTime' => <DateTime>,
            'stageDetails' => [
                'stage' => '<string>',
                'stageProgress' => '<string>',
            ],
            'state' => 'PENDING|MISSED|ACTIVE|FAILED|COMPLETED|DELETING|DELETED',
            'statusMessage' => '<string>',
            'type' => 'ON_DEMAND|AUTOMATIC',
        ],
        // ...
    ],
]

Result Details

Errors

InvalidParameterException:

A specified parameter is not valid.

MissingRequiredParameterException:

A required parameter is missing.

UnauthorizedOperationException:

You lack permissions needed to perform this operation. Check your IAM policies, and ensure that you are using the correct access keys.

GetServers

$result = $client->getServers([/* ... */]);
$promise = $client->getServersAsync([/* ... */]);

Describes the servers in your server catalog.

Before you can describe your servers, you must import them using ImportServerCatalog.

Parameter Syntax

$result = $client->getServers([
    'maxResults' => <integer>,
    'nextToken' => '<string>',
    'vmServerAddressList' => [
        [
            'vmId' => '<string>',
            'vmManagerId' => '<string>',
        ],
        // ...
    ],
]);

Parameter Details

Result Syntax

[
    'lastModifiedOn' => <DateTime>,
    'nextToken' => '<string>',
    'serverCatalogStatus' => 'NOT_IMPORTED|IMPORTING|AVAILABLE|DELETED|EXPIRED',
    'serverList' => [
        [
            'replicationJobId' => '<string>',
            'replicationJobTerminated' => true || false,
            'serverId' => '<string>',
            'serverType' => 'VIRTUAL_MACHINE',
            'vmServer' => [
                'vmManagerName' => '<string>',
                'vmManagerType' => 'VSPHERE|SCVMM|HYPERV-MANAGER',
                'vmName' => '<string>',
                'vmPath' => '<string>',
                'vmServerAddress' => [
                    'vmId' => '<string>',
                    'vmManagerId' => '<string>',
                ],
            ],
        ],
        // ...
    ],
]

Result Details

Errors

UnauthorizedOperationException:

You lack permissions needed to perform this operation. Check your IAM policies, and ensure that you are using the correct access keys.

InvalidParameterException:

A specified parameter is not valid.

MissingRequiredParameterException:

A required parameter is missing.

InternalError:

An internal error occurred.

ImportAppCatalog

$result = $client->importAppCatalog([/* ... */]);
$promise = $client->importAppCatalogAsync([/* ... */]);

Allows application import from Migration Hub.

Parameter Syntax

$result = $client->importAppCatalog([
    'roleName' => '<string>',
]);

Parameter Details

Result Syntax

[]

Result Details

Errors

UnauthorizedOperationException:

You lack permissions needed to perform this operation. Check your IAM policies, and ensure that you are using the correct access keys.

InvalidParameterException:

A specified parameter is not valid.

MissingRequiredParameterException:

A required parameter is missing.

InternalError:

An internal error occurred.

OperationNotPermittedException:

This operation is not allowed.

ImportServerCatalog

$result = $client->importServerCatalog([/* ... */]);
$promise = $client->importServerCatalogAsync([/* ... */]);

Gathers a complete list of on-premises servers. Connectors must be installed and monitoring all servers to import.

This call returns immediately, but might take additional time to retrieve all the servers.

Parameter Syntax

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

Parameter Details

Result Syntax

[]

Result Details

Errors

UnauthorizedOperationException:

You lack permissions needed to perform this operation. Check your IAM policies, and ensure that you are using the correct access keys.

OperationNotPermittedException:

This operation is not allowed.

InvalidParameterException:

A specified parameter is not valid.

MissingRequiredParameterException:

A required parameter is missing.

NoConnectorsAvailableException:

There are no connectors available.

LaunchApp

$result = $client->launchApp([/* ... */]);
$promise = $client->launchAppAsync([/* ... */]);

Launches the specified application as a stack in CloudFormation.

Parameter Syntax

$result = $client->launchApp([
    'appId' => '<string>',
]);

Parameter Details

Result Syntax

[]

Result Details

Errors

UnauthorizedOperationException:

You lack permissions needed to perform this operation. Check your IAM policies, and ensure that you are using the correct access keys.

InvalidParameterException:

A specified parameter is not valid.

MissingRequiredParameterException:

A required parameter is missing.

InternalError:

An internal error occurred.

OperationNotPermittedException:

This operation is not allowed.

ListApps

$result = $client->listApps([/* ... */]);
$promise = $client->listAppsAsync([/* ... */]);

Retrieves summaries for all applications.

Parameter Syntax

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

Parameter Details

Result Syntax

[
    'apps' => [
        [
            'appId' => '<string>',
            'creationTime' => <DateTime>,
            'description' => '<string>',
            'importedAppId' => '<string>',
            'lastModified' => <DateTime>,
            'latestReplicationTime' => <DateTime>,
            'launchConfigurationStatus' => 'NOT_CONFIGURED|CONFIGURED',
            'launchDetails' => [
                'latestLaunchTime' => <DateTime>,
                'stackId' => '<string>',
                'stackName' => '<string>',
            ],
            'launchStatus' => 'READY_FOR_CONFIGURATION|CONFIGURATION_IN_PROGRESS|CONFIGURATION_INVALID|READY_FOR_LAUNCH|VALIDATION_IN_PROGRESS|LAUNCH_PENDING|LAUNCH_IN_PROGRESS|LAUNCHED|PARTIALLY_LAUNCHED|DELTA_LAUNCH_IN_PROGRESS|DELTA_LAUNCH_FAILED|LAUNCH_FAILED|TERMINATE_IN_PROGRESS|TERMINATE_FAILED|TERMINATED',
            'launchStatusMessage' => '<string>',
            'name' => '<string>',
            'replicationConfigurationStatus' => 'NOT_CONFIGURED|CONFIGURED',
            'replicationStatus' => 'READY_FOR_CONFIGURATION|CONFIGURATION_IN_PROGRESS|CONFIGURATION_INVALID|READY_FOR_REPLICATION|VALIDATION_IN_PROGRESS|REPLICATION_PENDING|REPLICATION_IN_PROGRESS|REPLICATED|PARTIALLY_REPLICATED|DELTA_REPLICATION_IN_PROGRESS|DELTA_REPLICATED|DELTA_REPLICATION_FAILED|REPLICATION_FAILED|REPLICATION_STOPPING|REPLICATION_STOP_FAILED|REPLICATION_STOPPED',
            'replicationStatusMessage' => '<string>',
            'roleName' => '<string>',
            'status' => 'CREATING|ACTIVE|UPDATING|DELETING|DELETED|DELETE_FAILED',
            'statusMessage' => '<string>',
            'totalServerGroups' => <integer>,
            'totalServers' => <integer>,
        ],
        // ...
    ],
    'nextToken' => '<string>',
]

Result Details

Errors

UnauthorizedOperationException:

You lack permissions needed to perform this operation. Check your IAM policies, and ensure that you are using the correct access keys.

InvalidParameterException:

A specified parameter is not valid.

MissingRequiredParameterException:

A required parameter is missing.

InternalError:

An internal error occurred.

OperationNotPermittedException:

This operation is not allowed.

NotifyAppValidationOutput

$result = $client->notifyAppValidationOutput([/* ... */]);
$promise = $client->notifyAppValidationOutputAsync([/* ... */]);

Provides information to Server Migration Service about whether application validation is successful.

Parameter Syntax

$result = $client->notifyAppValidationOutput([
    'appId' => '<string>', // REQUIRED
    'notificationContext' => [
        'status' => 'READY_FOR_VALIDATION|PENDING|IN_PROGRESS|SUCCEEDED|FAILED',
        'statusMessage' => '<string>',
        'validationId' => '<string>',
    ],
]);

Parameter Details

Result Syntax

[]

Result Details

Errors

UnauthorizedOperationException:

You lack permissions needed to perform this operation. Check your IAM policies, and ensure that you are using the correct access keys.

InvalidParameterException:

A specified parameter is not valid.

MissingRequiredParameterException:

A required parameter is missing.

InternalError:

An internal error occurred.

OperationNotPermittedException:

This operation is not allowed.

PutAppLaunchConfiguration

$result = $client->putAppLaunchConfiguration([/* ... */]);
$promise = $client->putAppLaunchConfigurationAsync([/* ... */]);

Creates or updates the launch configuration for the specified application.

Parameter Syntax

$result = $client->putAppLaunchConfiguration([
    'appId' => '<string>',
    'autoLaunch' => true || false,
    'roleName' => '<string>',
    'serverGroupLaunchConfigurations' => [
        [
            'launchOrder' => <integer>,
            'serverGroupId' => '<string>',
            'serverLaunchConfigurations' => [
                [
                    'associatePublicIpAddress' => true || false,
                    'configureScript' => [
                        'bucket' => '<string>',
                        'key' => '<string>',
                    ],
                    'configureScriptType' => 'SHELL_SCRIPT|POWERSHELL_SCRIPT',
                    'ec2KeyName' => '<string>',
                    'iamInstanceProfileName' => '<string>',
                    'instanceType' => '<string>',
                    'logicalId' => '<string>',
                    'securityGroup' => '<string>',
                    'server' => [
                        'replicationJobId' => '<string>',
                        'replicationJobTerminated' => true || false,
                        'serverId' => '<string>',
                        'serverType' => 'VIRTUAL_MACHINE',
                        'vmServer' => [
                            'vmManagerName' => '<string>',
                            'vmManagerType' => 'VSPHERE|SCVMM|HYPERV-MANAGER',
                            'vmName' => '<string>',
                            'vmPath' => '<string>',
                            'vmServerAddress' => [
                                'vmId' => '<string>',
                                'vmManagerId' => '<string>',
                            ],
                        ],
                    ],
                    'subnet' => '<string>',
                    'userData' => [
                        's3Location' => [
                            'bucket' => '<string>',
                            'key' => '<string>',
                        ],
                    ],
                    'vpc' => '<string>',
                ],
                // ...
            ],
        ],
        // ...
    ],
]);

Parameter Details

Result Syntax

[]

Result Details

Errors

UnauthorizedOperationException:

You lack permissions needed to perform this operation. Check your IAM policies, and ensure that you are using the correct access keys.

InvalidParameterException:

A specified parameter is not valid.

MissingRequiredParameterException:

A required parameter is missing.

InternalError:

An internal error occurred.

OperationNotPermittedException:

This operation is not allowed.

PutAppReplicationConfiguration

$result = $client->putAppReplicationConfiguration([/* ... */]);
$promise = $client->putAppReplicationConfigurationAsync([/* ... */]);

Creates or updates the replication configuration for the specified application.

Parameter Syntax

$result = $client->putAppReplicationConfiguration([
    'appId' => '<string>',
    'serverGroupReplicationConfigurations' => [
        [
            'serverGroupId' => '<string>',
            'serverReplicationConfigurations' => [
                [
                    'server' => [
                        'replicationJobId' => '<string>',
                        'replicationJobTerminated' => true || false,
                        'serverId' => '<string>',
                        'serverType' => 'VIRTUAL_MACHINE',
                        'vmServer' => [
                            'vmManagerName' => '<string>',
                            'vmManagerType' => 'VSPHERE|SCVMM|HYPERV-MANAGER',
                            'vmName' => '<string>',
                            'vmPath' => '<string>',
                            'vmServerAddress' => [
                                'vmId' => '<string>',
                                'vmManagerId' => '<string>',
                            ],
                        ],
                    ],
                    'serverReplicationParameters' => [
                        'encrypted' => true || false,
                        'frequency' => <integer>,
                        'kmsKeyId' => '<string>',
                        'licenseType' => 'AWS|BYOL',
                        'numberOfRecentAmisToKeep' => <integer>,
                        'runOnce' => true || false,
                        'seedTime' => <integer || string || DateTime>,
                    ],
                ],
                // ...
            ],
        ],
        // ...
    ],
]);

Parameter Details

Result Syntax

[]

Result Details

Errors

UnauthorizedOperationException:

You lack permissions needed to perform this operation. Check your IAM policies, and ensure that you are using the correct access keys.

InvalidParameterException:

A specified parameter is not valid.

MissingRequiredParameterException:

A required parameter is missing.

InternalError:

An internal error occurred.

OperationNotPermittedException:

This operation is not allowed.

PutAppValidationConfiguration

$result = $client->putAppValidationConfiguration([/* ... */]);
$promise = $client->putAppValidationConfigurationAsync([/* ... */]);

Creates or updates a validation configuration for the specified application.

Parameter Syntax

$result = $client->putAppValidationConfiguration([
    'appId' => '<string>', // REQUIRED
    'appValidationConfigurations' => [
        [
            'appValidationStrategy' => 'SSM',
            'name' => '<string>',
            'ssmValidationParameters' => [
                'command' => '<string>',
                'executionTimeoutSeconds' => <integer>,
                'instanceId' => '<string>',
                'outputS3BucketName' => '<string>',
                'scriptType' => 'SHELL_SCRIPT|POWERSHELL_SCRIPT',
                'source' => [
                    's3Location' => [
                        'bucket' => '<string>',
                        'key' => '<string>',
                    ],
                ],
            ],
            'validationId' => '<string>',
        ],
        // ...
    ],
    'serverGroupValidationConfigurations' => [
        [
            'serverGroupId' => '<string>',
            'serverValidationConfigurations' => [
                [
                    'name' => '<string>',
                    'server' => [
                        'replicationJobId' => '<string>',
                        'replicationJobTerminated' => true || false,
                        'serverId' => '<string>',
                        'serverType' => 'VIRTUAL_MACHINE',
                        'vmServer' => [
                            'vmManagerName' => '<string>',
                            'vmManagerType' => 'VSPHERE|SCVMM|HYPERV-MANAGER',
                            'vmName' => '<string>',
                            'vmPath' => '<string>',
                            'vmServerAddress' => [
                                'vmId' => '<string>',
                                'vmManagerId' => '<string>',
                            ],
                        ],
                    ],
                    'serverValidationStrategy' => 'USERDATA',
                    'userDataValidationParameters' => [
                        'scriptType' => 'SHELL_SCRIPT|POWERSHELL_SCRIPT',
                        'source' => [
                            's3Location' => [
                                'bucket' => '<string>',
                                'key' => '<string>',
                            ],
                        ],
                    ],
                    'validationId' => '<string>',
                ],
                // ...
            ],
        ],
        // ...
    ],
]);

Parameter Details

Result Syntax

[]

Result Details

Errors

UnauthorizedOperationException:

You lack permissions needed to perform this operation. Check your IAM policies, and ensure that you are using the correct access keys.

InvalidParameterException:

A specified parameter is not valid.

MissingRequiredParameterException:

A required parameter is missing.

InternalError:

An internal error occurred.

OperationNotPermittedException:

This operation is not allowed.

StartAppReplication

$result = $client->startAppReplication([/* ... */]);
$promise = $client->startAppReplicationAsync([/* ... */]);

Starts replicating the specified application by creating replication jobs for each server in the application.

Parameter Syntax

$result = $client->startAppReplication([
    'appId' => '<string>',
]);

Parameter Details

Result Syntax

[]

Result Details

Errors

UnauthorizedOperationException:

You lack permissions needed to perform this operation. Check your IAM policies, and ensure that you are using the correct access keys.

InvalidParameterException:

A specified parameter is not valid.

MissingRequiredParameterException:

A required parameter is missing.

InternalError:

An internal error occurred.

OperationNotPermittedException:

This operation is not allowed.

StartOnDemandAppReplication

$result = $client->startOnDemandAppReplication([/* ... */]);
$promise = $client->startOnDemandAppReplicationAsync([/* ... */]);

Starts an on-demand replication run for the specified application.

Parameter Syntax

$result = $client->startOnDemandAppReplication([
    'appId' => '<string>', // REQUIRED
    'description' => '<string>',
]);

Parameter Details

Result Syntax

[]

Result Details

Errors

UnauthorizedOperationException:

You lack permissions needed to perform this operation. Check your IAM policies, and ensure that you are using the correct access keys.

InvalidParameterException:

A specified parameter is not valid.

MissingRequiredParameterException:

A required parameter is missing.

InternalError:

An internal error occurred.

OperationNotPermittedException:

This operation is not allowed.

StartOnDemandReplicationRun

$result = $client->startOnDemandReplicationRun([/* ... */]);
$promise = $client->startOnDemandReplicationRunAsync([/* ... */]);

Starts an on-demand replication run for the specified replication job. This replication run starts immediately. This replication run is in addition to the ones already scheduled.

There is a limit on the number of on-demand replications runs that you can request in a 24-hour period.

Parameter Syntax

$result = $client->startOnDemandReplicationRun([
    'description' => '<string>',
    'replicationJobId' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

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

Result Details

Errors

InvalidParameterException:

A specified parameter is not valid.

MissingRequiredParameterException:

A required parameter is missing.

UnauthorizedOperationException:

You lack permissions needed to perform this operation. Check your IAM policies, and ensure that you are using the correct access keys.

OperationNotPermittedException:

This operation is not allowed.

ReplicationRunLimitExceededException:

You have exceeded the number of on-demand replication runs you can request in a 24-hour period.

DryRunOperationException:

The user has the required permissions, so the request would have succeeded, but a dry run was performed.

StopAppReplication

$result = $client->stopAppReplication([/* ... */]);
$promise = $client->stopAppReplicationAsync([/* ... */]);

Stops replicating the specified application by deleting the replication job for each server in the application.

Parameter Syntax

$result = $client->stopAppReplication([
    'appId' => '<string>',
]);

Parameter Details

Result Syntax

[]

Result Details

Errors

UnauthorizedOperationException:

You lack permissions needed to perform this operation. Check your IAM policies, and ensure that you are using the correct access keys.

InvalidParameterException:

A specified parameter is not valid.

MissingRequiredParameterException:

A required parameter is missing.

InternalError:

An internal error occurred.

OperationNotPermittedException:

This operation is not allowed.

TerminateApp

$result = $client->terminateApp([/* ... */]);
$promise = $client->terminateAppAsync([/* ... */]);

Terminates the stack for the specified application.

Parameter Syntax

$result = $client->terminateApp([
    'appId' => '<string>',
]);

Parameter Details

Result Syntax

[]

Result Details

Errors

UnauthorizedOperationException:

You lack permissions needed to perform this operation. Check your IAM policies, and ensure that you are using the correct access keys.

InvalidParameterException:

A specified parameter is not valid.

MissingRequiredParameterException:

A required parameter is missing.

InternalError:

An internal error occurred.

OperationNotPermittedException:

This operation is not allowed.

UpdateApp

$result = $client->updateApp([/* ... */]);
$promise = $client->updateAppAsync([/* ... */]);

Updates the specified application.

Parameter Syntax

$result = $client->updateApp([
    'appId' => '<string>',
    'description' => '<string>',
    'name' => '<string>',
    'roleName' => '<string>',
    'serverGroups' => [
        [
            'name' => '<string>',
            'serverGroupId' => '<string>',
            'serverList' => [
                [
                    'replicationJobId' => '<string>',
                    'replicationJobTerminated' => true || false,
                    'serverId' => '<string>',
                    'serverType' => 'VIRTUAL_MACHINE',
                    'vmServer' => [
                        'vmManagerName' => '<string>',
                        'vmManagerType' => 'VSPHERE|SCVMM|HYPERV-MANAGER',
                        'vmName' => '<string>',
                        'vmPath' => '<string>',
                        'vmServerAddress' => [
                            'vmId' => '<string>',
                            'vmManagerId' => '<string>',
                        ],
                    ],
                ],
                // ...
            ],
        ],
        // ...
    ],
    'tags' => [
        [
            'key' => '<string>',
            'value' => '<string>',
        ],
        // ...
    ],
]);

Parameter Details

Result Syntax

[
    'appSummary' => [
        'appId' => '<string>',
        'creationTime' => <DateTime>,
        'description' => '<string>',
        'importedAppId' => '<string>',
        'lastModified' => <DateTime>,
        'latestReplicationTime' => <DateTime>,
        'launchConfigurationStatus' => 'NOT_CONFIGURED|CONFIGURED',
        'launchDetails' => [
            'latestLaunchTime' => <DateTime>,
            'stackId' => '<string>',
            'stackName' => '<string>',
        ],
        'launchStatus' => 'READY_FOR_CONFIGURATION|CONFIGURATION_IN_PROGRESS|CONFIGURATION_INVALID|READY_FOR_LAUNCH|VALIDATION_IN_PROGRESS|LAUNCH_PENDING|LAUNCH_IN_PROGRESS|LAUNCHED|PARTIALLY_LAUNCHED|DELTA_LAUNCH_IN_PROGRESS|DELTA_LAUNCH_FAILED|LAUNCH_FAILED|TERMINATE_IN_PROGRESS|TERMINATE_FAILED|TERMINATED',
        'launchStatusMessage' => '<string>',
        'name' => '<string>',
        'replicationConfigurationStatus' => 'NOT_CONFIGURED|CONFIGURED',
        'replicationStatus' => 'READY_FOR_CONFIGURATION|CONFIGURATION_IN_PROGRESS|CONFIGURATION_INVALID|READY_FOR_REPLICATION|VALIDATION_IN_PROGRESS|REPLICATION_PENDING|REPLICATION_IN_PROGRESS|REPLICATED|PARTIALLY_REPLICATED|DELTA_REPLICATION_IN_PROGRESS|DELTA_REPLICATED|DELTA_REPLICATION_FAILED|REPLICATION_FAILED|REPLICATION_STOPPING|REPLICATION_STOP_FAILED|REPLICATION_STOPPED',
        'replicationStatusMessage' => '<string>',
        'roleName' => '<string>',
        'status' => 'CREATING|ACTIVE|UPDATING|DELETING|DELETED|DELETE_FAILED',
        'statusMessage' => '<string>',
        'totalServerGroups' => <integer>,
        'totalServers' => <integer>,
    ],
    'serverGroups' => [
        [
            'name' => '<string>',
            'serverGroupId' => '<string>',
            'serverList' => [
                [
                    'replicationJobId' => '<string>',
                    'replicationJobTerminated' => true || false,
                    'serverId' => '<string>',
                    'serverType' => 'VIRTUAL_MACHINE',
                    'vmServer' => [
                        'vmManagerName' => '<string>',
                        'vmManagerType' => 'VSPHERE|SCVMM|HYPERV-MANAGER',
                        'vmName' => '<string>',
                        'vmPath' => '<string>',
                        'vmServerAddress' => [
                            'vmId' => '<string>',
                            'vmManagerId' => '<string>',
                        ],
                    ],
                ],
                // ...
            ],
        ],
        // ...
    ],
    'tags' => [
        [
            'key' => '<string>',
            'value' => '<string>',
        ],
        // ...
    ],
]

Result Details

Errors

UnauthorizedOperationException:

You lack permissions needed to perform this operation. Check your IAM policies, and ensure that you are using the correct access keys.

InvalidParameterException:

A specified parameter is not valid.

MissingRequiredParameterException:

A required parameter is missing.

InternalError:

An internal error occurred.

OperationNotPermittedException:

This operation is not allowed.

UpdateReplicationJob

$result = $client->updateReplicationJob([/* ... */]);
$promise = $client->updateReplicationJobAsync([/* ... */]);

Updates the specified settings for the specified replication job.

Parameter Syntax

$result = $client->updateReplicationJob([
    'description' => '<string>',
    'encrypted' => true || false,
    'frequency' => <integer>,
    'kmsKeyId' => '<string>',
    'licenseType' => 'AWS|BYOL',
    'nextReplicationRunStartTime' => <integer || string || DateTime>,
    'numberOfRecentAmisToKeep' => <integer>,
    'replicationJobId' => '<string>', // REQUIRED
    'roleName' => '<string>',
]);

Parameter Details

Result Syntax

[]

Result Details

Errors

InvalidParameterException:

A specified parameter is not valid.

MissingRequiredParameterException:

A required parameter is missing.

OperationNotPermittedException:

This operation is not allowed.

UnauthorizedOperationException:

You lack permissions needed to perform this operation. Check your IAM policies, and ensure that you are using the correct access keys.

ServerCannotBeReplicatedException:

The specified server cannot be replicated.

ReplicationJobNotFoundException:

The specified replication job does not exist.

InternalError:

An internal error occurred.

TemporarilyUnavailableException:

The service is temporarily unavailable.