AWS SDK for PHP 3.x

Service ID: sms

Version: 2016-10-24

This page describes the parameters and results for the operations of the AWS Server Migration Service (2016-10-24), and shows how to use the Aws\Sms\SmsClient object to call the described operations. This documentation is specific to the 2016-10-24 API version of the service.

Operation Summary

Each of the following operations can be created from a client using $client->getCommand('CommandName'), where "CommandName" is the name of one of the following operations. Note: a command is a value that encapsulates an operation and the parameters used to create an HTTP request.

You can also create and send a command immediately using the magic methods available on a client object: $client->commandName(/* parameters */). You can send the command asynchronously (returning a promise) by appending the word "Async" to the operation name: $client->commandNameAsync(/* parameters */).

CreateApp ( array $params = [] )
Creates an application.
CreateReplicationJob ( array $params = [] )
Creates a replication job.
DeleteApp ( array $params = [] )
Deletes an existing application.
DeleteAppLaunchConfiguration ( array $params = [] )
Deletes existing launch configuration for an application.
DeleteAppReplicationConfiguration ( array $params = [] )
Deletes existing replication configuration for an application.
DeleteReplicationJob ( array $params = [] )
Deletes the specified replication job.
DeleteServerCatalog ( array $params = [] )
Deletes all servers from your server catalog.
DisassociateConnector ( array $params = [] )
Disassociates the specified connector from AWS SMS.
GenerateChangeSet ( array $params = [] )
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.
GenerateTemplate ( array $params = [] )
Generates an Amazon CloudFormation template based on the current launch configuration and writes it to an Amazon S3 object in the customer’s Amazon S3 bucket.
GetApp ( array $params = [] )
Retrieve information about an application.
GetAppLaunchConfiguration ( array $params = [] )
Retrieves the application launch configuration associated with an application.
GetAppReplicationConfiguration ( array $params = [] )
Retrieves an application replication configuration associatd with an application.
GetConnectors ( array $params = [] )
Describes the connectors registered with the AWS SMS.
GetReplicationJobs ( array $params = [] )
Describes the specified replication job or all of your replication jobs.
GetReplicationRuns ( array $params = [] )
Describes the replication runs for the specified replication job.
GetServers ( array $params = [] )
Describes the servers in your server catalog.
ImportServerCatalog ( array $params = [] )
Gathers a complete list of on-premises servers.
LaunchApp ( array $params = [] )
Launches an application stack.
ListApps ( array $params = [] )
Returns a list of summaries for all applications.
PutAppLaunchConfiguration ( array $params = [] )
Creates a launch configuration for an application.
PutAppReplicationConfiguration ( array $params = [] )
Creates or updates a replication configuration for an application.
StartAppReplication ( array $params = [] )
Starts replicating an application.
StartOnDemandReplicationRun ( array $params = [] )
Starts an on-demand replication run for the specified replication job.
StopAppReplication ( array $params = [] )
Stops replicating an application.
TerminateApp ( array $params = [] )
Terminates the stack for an application.
UpdateApp ( array $params = [] )
Updates an application.
UpdateReplicationJob ( array $params = [] )
Updates the specified settings for the specified replication job.

Paginators

Paginators handle automatically iterating over paginated API results. Paginators are associated with specific API operations, and they accept the parameters that the corresponding API operation accepts. You can get a paginator from a client class using getPaginator($paginatorName, $operationParameters). This client supports the following paginators:

GetConnectors
GetReplicationJobs
GetReplicationRuns
GetServers

Operations

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

Members

clientToken

Type: string

A unique, case-sensitive identifier you provide to ensure idempotency of application creation.

description

Type: string

Description of the new application

name

Type: string

Name of the new application.

roleName

Type: string

Name of service role in customer's account to be used by AWS SMS.

serverGroups

Type: Array of ServerGroup structures

List of server groups to include in the application.

tags

Type: Array of Tag structures

List of tags to be associated with the application.

Result Syntax

[
    'appSummary' => [
        'appId' => '<string>',
        'creationTime' => <DateTime>,
        'description' => '<string>',
        'lastModified' => <DateTime>,
        'latestReplicationTime' => <DateTime>,
        '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|DELTA_LAUNCH_IN_PROGRESS|DELTA_LAUNCH_FAILED|LAUNCH_FAILED|TERMINATE_IN_PROGRESS|TERMINATE_FAILED|TERMINATED',
        'launchStatusMessage' => '<string>',
        'name' => '<string>',
        'replicationStatus' => 'READY_FOR_CONFIGURATION|CONFIGURATION_IN_PROGRESS|CONFIGURATION_INVALID|READY_FOR_REPLICATION|VALIDATION_IN_PROGRESS|REPLICATION_PENDING|REPLICATION_IN_PROGRESS|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

Members

appSummary

Type: AppSummary structure

Summary description of the application.

serverGroups

Type: Array of ServerGroup structures

List of server groups included in the application.

tags

Type: Array of Tag structures

List of taags associated with the application.

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

Members

description

Type: string

The description of the replication job.

encrypted

Type: boolean

When true, the replication job produces encrypted AMIs. See also KmsKeyId below.

frequency

Type: int

The time between consecutive replication runs, in hours.

kmsKeyId

Type: string

KMS key ID for replication jobs that produce encrypted AMIs. Can be any of the following:

KMS key ID
KMS key alias
ARN referring to KMS key ID
ARN referring to KMS key alias

If encrypted is true but a KMS key id is not specified, the customer's default KMS key for EBS is used.

licenseType

Type: string

The license type to be used for the AMI created by a successful replication run.

numberOfRecentAmisToKeep

Type: int

The maximum number of SMS-created AMIs to retain. The oldest will be deleted once the maximum number is reached and a new AMI is created.

roleName

Type: string

The name of the IAM role to be used by the AWS SMS.

runOnce

Type: boolean

seedReplicationTime

Required: Yes
Type: timestamp (string|DateTime or anything parsable by strtotime)

The seed replication time.

serverId

Required: Yes
Type: string

The identifier of the server.

Result Syntax

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

Result Details

Members

replicationJobId

Type: string

The unique identifier of the replication job.

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 an existing application. Optionally deletes the launched stack associated with the application and all AWS SMS replication jobs for servers in the application.

Parameter Syntax

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

Parameter Details

Members

appId

Type: string

ID of the application to delete.

forceStopAppReplication

Type: boolean

While deleting the application, stop all replication jobs corresponding to the servers in the application.

forceTerminateApp

Type: boolean

While deleting the application, terminate the stack corresponding to the application.

Result Syntax

[]

Result Details

The results for this operation are always empty.

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 existing launch configuration for an application.

Parameter Syntax

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

Parameter Details

Members

appId

Type: string

ID of the application associated with the launch configuration.

Result Syntax

[]

Result Details

The results for this operation are always empty.

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 existing replication configuration for an application.

Parameter Syntax

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

Parameter Details

Members

appId

Type: string

ID of the application associated with the replication configuration.

Result Syntax

[]

Result Details

The results for this operation are always empty.

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. AWS deletes the contents of the Amazon S3 bucket used to store AWS SMS artifacts. The AMIs created by the replication runs are not deleted.

Parameter Syntax

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

Parameter Details

Members

replicationJobId

Required: Yes
Type: string

The identifier of the replication job.

Result Syntax

[]

Result Details

The results for this operation are always empty.

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

Members

Result Syntax

[]

Result Details

The results for this operation are always empty.

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 AWS SMS.

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

Parameter Syntax

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

Parameter Details

Members

connectorId

Required: Yes
Type: string

The identifier of the connector.

Result Syntax

[]

Result Details

The results for this operation are always empty.

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

Members

appId

Type: string

ID of the application associated with the change set.

changesetFormat

Type: string

Format for the change set.

Result Syntax

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

Result Details

Members

s3Location

Type: S3Location structure

Location of the Amazon S3 object.

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 Amazon 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

Members

appId

Type: string

ID of the application associated with the Amazon CloudFormation template.

templateFormat

Type: string

Format for generating the Amazon CloudFormation template.

Result Syntax

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

Result Details

Members

s3Location

Type: S3Location structure

Location of the Amazon S3 object.

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 an application.

Parameter Syntax

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

Parameter Details

Members

appId

Type: string

ID of the application whose information is being retrieved.

Result Syntax

[
    'appSummary' => [
        'appId' => '<string>',
        'creationTime' => <DateTime>,
        'description' => '<string>',
        'lastModified' => <DateTime>,
        'latestReplicationTime' => <DateTime>,
        '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|DELTA_LAUNCH_IN_PROGRESS|DELTA_LAUNCH_FAILED|LAUNCH_FAILED|TERMINATE_IN_PROGRESS|TERMINATE_FAILED|TERMINATED',
        'launchStatusMessage' => '<string>',
        'name' => '<string>',
        'replicationStatus' => 'READY_FOR_CONFIGURATION|CONFIGURATION_IN_PROGRESS|CONFIGURATION_INVALID|READY_FOR_REPLICATION|VALIDATION_IN_PROGRESS|REPLICATION_PENDING|REPLICATION_IN_PROGRESS|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

Members

appSummary

Type: AppSummary structure

Information about the application.

serverGroups

Type: Array of ServerGroup structures

List of server groups belonging to the application.

tags

Type: Array of Tag structures

List of tags associated with the application.

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 an application.

Parameter Syntax

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

Parameter Details

Members

appId

Type: string

ID of the application launch configuration.

Result Syntax

[
    'appId' => '<string>',
    'roleName' => '<string>',
    'serverGroupLaunchConfigurations' => [
        [
            'launchOrder' => <integer>,
            'serverGroupId' => '<string>',
            'serverLaunchConfigurations' => [
                [
                    'associatePublicIpAddress' => true || false,
                    'ec2KeyName' => '<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

Members

appId

Type: string

ID of the application associated with the launch configuration.

roleName

Type: string

Name of the service role in the customer's account that Amazon CloudFormation uses to launch the application.

serverGroupLaunchConfigurations

Type: Array of ServerGroupLaunchConfiguration structures

List of launch configurations for server groups in this application.

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 an application replication configuration associatd with an application.

Parameter Syntax

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

Parameter Details

Members

appId

Type: string

ID of the application associated with the replication configuration.

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

Members

serverGroupReplicationConfigurations

Type: Array of ServerGroupReplicationConfiguration structures

Replication configurations associated with server groups in this application.

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 AWS SMS.

Parameter Syntax

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

Parameter Details

Members

maxResults

Type: int

The maximum number of results to return in a single call. The default value is 50. To retrieve the remaining results, make another call with the returned NextToken value.

nextToken

Type: string

The token for the next set of results.

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

Members

connectorList

Type: Array of Connector structures

Information about the registered connectors.

nextToken

Type: string

The token required to retrieve the next set of results. This value is null when there are no more results to return.

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

Members

maxResults

Type: int

The maximum number of results to return in a single call. The default value is 50. To retrieve the remaining results, make another call with the returned NextToken value.

nextToken

Type: string

The token for the next set of results.

replicationJobId

Type: string

The identifier of the replication job.

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

Members

nextToken

Type: string

The token required to retrieve the next set of results. This value is null when there are no more results to return.

replicationJobList

Type: Array of ReplicationJob structures

Information about the replication jobs.

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

Members

maxResults

Type: int

The maximum number of results to return in a single call. The default value is 50. To retrieve the remaining results, make another call with the returned NextToken value.

nextToken

Type: string

The token for the next set of results.

replicationJobId

Required: Yes
Type: string

The identifier of the replication job.

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

Members

nextToken

Type: string

The token required to retrieve the next set of results. This value is null when there are no more results to return.

replicationJob

Type: ReplicationJob structure

Information about the replication job.

replicationRunList

Type: Array of ReplicationRun structures

Information about the replication runs.

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

Members

maxResults

Type: int

The maximum number of results to return in a single call. The default value is 50. To retrieve the remaining results, make another call with the returned NextToken value.

nextToken

Type: string

The token for the next set of results.

vmServerAddressList

Type: Array of VmServerAddress structures

List of VmServerAddress objects

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

Members

lastModifiedOn

Type: timestamp (string|DateTime or anything parsable by strtotime)

The time when the server was last modified.

nextToken

Type: string

The token required to retrieve the next set of results. This value is null when there are no more results to return.

serverCatalogStatus

Type: string

The status of the server catalog.

serverList

Type: Array of Server structures

Information about the servers.

Errors

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

ImportServerCatalog

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

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

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

Parameter Syntax

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

Parameter Details

Members

Result Syntax

[]

Result Details

The results for this operation are always empty.

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 an application stack.

Parameter Syntax

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

Parameter Details

Members

appId

Type: string

ID of the application to launch.

Result Syntax

[]

Result Details

The results for this operation are always empty.

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([/* ... */]);

Returns a list of summaries for all applications.

Parameter Syntax

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

Parameter Details

Members

appIds

Type: Array of strings

maxResults

Type: int

The maximum number of results to return in a single call. The default value is 50. To retrieve the remaining results, make another call with the returned NextToken value.

nextToken

Type: string

The token for the next set of results.

Result Syntax

[
    'apps' => [
        [
            'appId' => '<string>',
            'creationTime' => <DateTime>,
            'description' => '<string>',
            'lastModified' => <DateTime>,
            'latestReplicationTime' => <DateTime>,
            '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|DELTA_LAUNCH_IN_PROGRESS|DELTA_LAUNCH_FAILED|LAUNCH_FAILED|TERMINATE_IN_PROGRESS|TERMINATE_FAILED|TERMINATED',
            'launchStatusMessage' => '<string>',
            'name' => '<string>',
            'replicationStatus' => 'READY_FOR_CONFIGURATION|CONFIGURATION_IN_PROGRESS|CONFIGURATION_INVALID|READY_FOR_REPLICATION|VALIDATION_IN_PROGRESS|REPLICATION_PENDING|REPLICATION_IN_PROGRESS|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

Members

apps

Type: Array of AppSummary structures

A list of application summaries.

nextToken

Type: string

The token required to retrieve the next set of results. This value is null when there are no more results to return.

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 a launch configuration for an application.

Parameter Syntax

$result = $client->putAppLaunchConfiguration([
    'appId' => '<string>',
    'roleName' => '<string>',
    'serverGroupLaunchConfigurations' => [
        [
            'launchOrder' => <integer>,
            'serverGroupId' => '<string>',
            'serverLaunchConfigurations' => [
                [
                    'associatePublicIpAddress' => true || false,
                    'ec2KeyName' => '<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

Members

appId

Type: string

ID of the application associated with the launch configuration.

roleName

Type: string

Name of service role in the customer's account that Amazon CloudFormation uses to launch the application.

serverGroupLaunchConfigurations

Type: Array of ServerGroupLaunchConfiguration structures

Launch configurations for server groups in the application.

Result Syntax

[]

Result Details

The results for this operation are always empty.

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 a replication configuration for an 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

Members

appId

Type: string

ID of the application tassociated with the replication configuration.

serverGroupReplicationConfigurations

Type: Array of ServerGroupReplicationConfiguration structures

Replication configurations for server groups in the application.

Result Syntax

[]

Result Details

The results for this operation are always empty.

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 an application.

Parameter Syntax

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

Parameter Details

Members

appId

Type: string

ID of the application to replicate.

Result Syntax

[]

Result Details

The results for this operation are always empty.

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 you can request in a 24-hour period.

Parameter Syntax

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

Parameter Details

Members

description

Type: string

The description of the replication run.

replicationJobId

Required: Yes
Type: string

The identifier of the replication job.

Result Syntax

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

Result Details

Members

replicationRunId

Type: string

The identifier of the replication run.

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.

StopAppReplication

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

Stops replicating an application.

Parameter Syntax

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

Parameter Details

Members

appId

Type: string

ID of the application to stop replicating.

Result Syntax

[]

Result Details

The results for this operation are always empty.

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 an application.

Parameter Syntax

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

Parameter Details

Members

appId

Type: string

ID of the application to terminate.

Result Syntax

[]

Result Details

The results for this operation are always empty.

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 an 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

Members

appId

Type: string

ID of the application to update.

description

Type: string

New description of the application.

name

Type: string

New name of the application.

roleName

Type: string

Name of the service role in the customer's account used by AWS SMS.

serverGroups

Type: Array of ServerGroup structures

List of server groups in the application to update.

tags

Type: Array of Tag structures

List of tags to associate with the application.

Result Syntax

[
    'appSummary' => [
        'appId' => '<string>',
        'creationTime' => <DateTime>,
        'description' => '<string>',
        'lastModified' => <DateTime>,
        'latestReplicationTime' => <DateTime>,
        '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|DELTA_LAUNCH_IN_PROGRESS|DELTA_LAUNCH_FAILED|LAUNCH_FAILED|TERMINATE_IN_PROGRESS|TERMINATE_FAILED|TERMINATED',
        'launchStatusMessage' => '<string>',
        'name' => '<string>',
        'replicationStatus' => 'READY_FOR_CONFIGURATION|CONFIGURATION_IN_PROGRESS|CONFIGURATION_INVALID|READY_FOR_REPLICATION|VALIDATION_IN_PROGRESS|REPLICATION_PENDING|REPLICATION_IN_PROGRESS|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

Members

appSummary

Type: AppSummary structure

Summary description of the application.

serverGroups

Type: Array of ServerGroup structures

List of updated server groups in the application.

tags

Type: Array of Tag structures

List of tags associated with the application.

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

Members

description

Type: string

The description of the replication job.

encrypted

Type: boolean

When true, the replication job produces encrypted AMIs . See also KmsKeyId below.

frequency

Type: int

The time between consecutive replication runs, in hours.

kmsKeyId

Type: string

KMS key ID for replication jobs that produce encrypted AMIs. Can be any of the following:

KMS key ID
KMS key alias
ARN referring to KMS key ID
ARN referring to KMS key alias

If encrypted is true but a KMS key id is not specified, the customer's default KMS key for EBS is used.

licenseType

Type: string

The license type to be used for the AMI created by a successful replication run.

nextReplicationRunStartTime

Type: timestamp (string|DateTime or anything parsable by strtotime)

The start time of the next replication run.

numberOfRecentAmisToKeep

Type: int

The maximum number of SMS-created AMIs to retain. The oldest will be deleted once the maximum number is reached and a new AMI is created.

replicationJobId

Required: Yes
Type: string

The identifier of the replication job.

roleName

Type: string

The name of the IAM role to be used by AWS SMS.

Result Syntax

[]

Result Details

The results for this operation are always empty.

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.

Shapes

AppSummary

Description

Information about the application.

Members

appId

Type: string

Unique ID of the application.

creationTime

Type: timestamp (string|DateTime or anything parsable by strtotime)

Time of creation of this application.

description

Type: string

Description of the application.

lastModified

Type: timestamp (string|DateTime or anything parsable by strtotime)

Timestamp of the application's creation.

latestReplicationTime

Type: timestamp (string|DateTime or anything parsable by strtotime)

Timestamp of the application's most recent successful replication.

launchDetails

Type: LaunchDetails structure

Details about the latest launch of the application.

launchStatus

Type: string

Launch status of the application.

launchStatusMessage

Type: string

A message related to the launch status of the application.

name

Type: string

Name of the application.

replicationStatus

Type: string

Replication status of the application.

replicationStatusMessage

Type: string

A message related to the replication status of the application.

roleName

Type: string

Name of the service role in the customer's account used by AWS SMS.

status

Type: string

Status of the application.

statusMessage

Type: string

A message related to the status of the application

totalServerGroups

Type: int

Number of server groups present in the application.

totalServers

Type: int

Number of servers present in the application.

Connector

Description

Represents a connector.

Members

associatedOn

Type: timestamp (string|DateTime or anything parsable by strtotime)

The time the connector was associated.

capabilityList

Type: Array of strings

The capabilities of the connector.

connectorId

Type: string

The identifier of the connector.

ipAddress

Type: string

The IP address of the connector.

macAddress

Type: string

The MAC address of the connector.

status

Type: string

The status of the connector.

version

Type: string

The connector version.

vmManagerId

Type: string

The identifier of the VM manager.

vmManagerName

Type: string

The name of the VM manager.

vmManagerType

Type: string

The VM management product.

InternalError

Description

An internal error occurred.

Members

message

Type: string

InvalidParameterException

Description

A specified parameter is not valid.

Members

message

Type: string

LaunchDetails

Description

Details about the latest launch of an application.

Members

latestLaunchTime

Type: timestamp (string|DateTime or anything parsable by strtotime)

Latest time this application was launched successfully.

stackId

Type: string

Identifier of the latest stack launched for this application.

stackName

Type: string

Name of the latest stack launched for this application.

MissingRequiredParameterException

Description

A required parameter is missing.

Members

message

Type: string

NoConnectorsAvailableException

Description

There are no connectors available.

Members

message

Type: string

OperationNotPermittedException

Description

This operation is not allowed.

Members

message

Type: string

ReplicationJob

Description

Represents a replication job.

Members

description

Type: string

The description of the replication job.

encrypted

Type: boolean

Whether the replication job should produce encrypted AMIs or not. See also KmsKeyId below.

frequency

Type: int

The time between consecutive replication runs, in hours.

kmsKeyId

Type: string

KMS key ID for replication jobs that produce encrypted AMIs. Can be any of the following:

KMS key ID
KMS key alias
ARN referring to KMS key ID
ARN referring to KMS key alias

If encrypted is true but a KMS key id is not specified, the customer's default KMS key for EBS is used.

latestAmiId

Type: string

The ID of the latest Amazon Machine Image (AMI).

licenseType

Type: string

The license type to be used for the AMI created by a successful replication run.

nextReplicationRunStartTime

Type: timestamp (string|DateTime or anything parsable by strtotime)

The start time of the next replication run.

numberOfRecentAmisToKeep

Type: int

Number of recent AMIs to keep in the customer's account for a replication job. By default the value is set to zero, meaning that all AMIs are kept.

replicationJobId

Type: string

The identifier of the replication job.

replicationRunList

Type: Array of ReplicationRun structures

Information about the replication runs.

roleName

Type: string

The name of the IAM role to be used by the Server Migration Service.

runOnce

Type: boolean

seedReplicationTime

Type: timestamp (string|DateTime or anything parsable by strtotime)

The seed replication time.

serverId

Type: string

The identifier of the server.

serverType

Type: string

The type of server.

state

Type: string

The state of the replication job.

statusMessage

Type: string

The description of the current status of the replication job.

vmServer

Type: VmServer structure

Information about the VM server.

ReplicationJobAlreadyExistsException

Description

The specified replication job already exists.

Members

message

Type: string

ReplicationJobNotFoundException

Description

The specified replication job does not exist.

Members

message

Type: string

ReplicationRun

Description

Represents a replication run.

Members

amiId

Type: string

The identifier of the Amazon Machine Image (AMI) from the replication run.

completedTime

Type: timestamp (string|DateTime or anything parsable by strtotime)

The completion time of the last replication run.

description

Type: string

The description of the replication run.

encrypted

Type: boolean

Whether the replication run should produce encrypted AMI or not. See also KmsKeyId below.

kmsKeyId

Type: string

KMS key ID for replication jobs that produce encrypted AMIs. Can be any of the following:

KMS key ID
KMS key alias
ARN referring to KMS key ID
ARN referring to KMS key alias

If encrypted is true but a KMS key id is not specified, the customer's default KMS key for EBS is used.

replicationRunId

Type: string

The identifier of the replication run.

scheduledStartTime

Type: timestamp (string|DateTime or anything parsable by strtotime)

The start time of the next replication run.

stageDetails

Type: ReplicationRunStageDetails structure

Details of the current stage of the replication run.

state

Type: string

The state of the replication run.

statusMessage

Type: string

The description of the current status of the replication job.

type

Type: string

The type of replication run.

ReplicationRunLimitExceededException

Description

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

Members

message

Type: string

ReplicationRunStageDetails

Description

Details of the current stage of a replication run.

Members

stage

Type: string

String describing the current stage of a replication run.

stageProgress

Type: string

String describing the progress of the current stage of a replication run.

S3Location

Description

Location of the Amazon S3 object in the customer's account.

Members

bucket

Type: string

Amazon S3 bucket name.

key

Type: string

Amazon S3 bucket key.

Server

Description

Represents a server.

Members

replicationJobId

Type: string

The identifier of the replication job.

replicationJobTerminated

Type: boolean

Indicates whether the replication job is deleted or failed.

serverId

Type: string

The identifier of the server.

serverType

Type: string

The type of server.

vmServer

Type: VmServer structure

Information about the VM server.

ServerCannotBeReplicatedException

Description

The specified server cannot be replicated.

Members

message

Type: string

ServerGroup

Description

A logical grouping of servers.

Members

name

Type: string

Name of a server group.

serverGroupId

Type: string

Identifier of a server group.

serverList

Type: Array of Server structures

List of servers belonging to a server group.

ServerGroupLaunchConfiguration

Description

Launch configuration for a server group.

Members

launchOrder

Type: int

Launch order of servers in the server group.

serverGroupId

Type: string

Identifier of the server group the launch configuration is associated with.

serverLaunchConfigurations

Type: Array of ServerLaunchConfiguration structures

Launch configuration for servers in the server group.

ServerGroupReplicationConfiguration

Description

Replication configuration for a server group.

Members

serverGroupId

Type: string

Identifier of the server group this replication configuration is associated with.

serverReplicationConfigurations

Type: Array of ServerReplicationConfiguration structures

Replication configuration for servers in the server group.

ServerLaunchConfiguration

Description

Launch configuration for a server.

Members

associatePublicIpAddress

Type: boolean

If true, a publicly accessible IP address is created when launching the server.

ec2KeyName

Type: string

Name of the EC2 SSH Key to be used for connecting to the launched server.

instanceType

Type: string

Instance type to be used for launching the server.

logicalId

Type: string

Logical ID of the server in the Amazon CloudFormation template.

securityGroup

Type: string

Identifier of the security group that applies to the launched server.

server

Type: Server structure

Identifier of the server the launch configuration is associated with.

subnet

Type: string

Identifier of the subnet the server should be launched into.

userData

Type: UserData structure

Location of the user-data script to be executed when launching the server.

vpc

Type: string

Identifier of the VPC the server should be launched into.

ServerReplicationConfiguration

Description

Replication configuration of a server.

Members

server

Type: Server structure

Identifier of the server this replication configuration is associated with.

serverReplicationParameters

Type: ServerReplicationParameters structure

Parameters for replicating the server.

ServerReplicationParameters

Description

Replication parameters for replicating a server.

Members

encrypted

Type: boolean

When true, the replication job produces encrypted AMIs. See also KmsKeyId below.

frequency

Type: int

Frequency of creating replication jobs for the server.

kmsKeyId

Type: string

KMS key ID for replication jobs that produce encrypted AMIs. Can be any of the following:

KMS key ID
KMS key alias
ARN referring to KMS key ID
ARN referring to KMS key alias

If encrypted is true but a KMS key id is not specified, the customer's default KMS key for EBS is used.

licenseType

Type: string

License type for creating a replication job for the server.

numberOfRecentAmisToKeep

Type: int

Number of recent AMIs to keep when creating a replication job for this server.

runOnce

Type: boolean

seedTime

Type: timestamp (string|DateTime or anything parsable by strtotime)

Seed time for creating a replication job for the server.

TemporarilyUnavailableException

Description

The service is temporarily unavailable.

Members

UnauthorizedOperationException

Description

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

Members

message

Type: string

UserData

Description

A script that runs on first launch of an Amazon EC2 instance. Used for configuring the server during launch.

Members

s3Location

Type: S3Location structure

Amazon S3 location of the user-data script.

VmServer

Description

Represents a VM server.

Members

vmManagerName

Type: string

The name of the VM manager.

vmManagerType

Type: string

The type of VM management product.

vmName

Type: string

The name of the VM.

vmPath

Type: string

The VM folder path in the vCenter Server virtual machine inventory tree.

vmServerAddress

Type: VmServerAddress structure

Information about the VM server location.

VmServerAddress

Description

Represents a VM server location.

Members

vmId

Type: string

The identifier of the VM.

vmManagerId

Type: string

The identifier of the VM manager.

Namespaces

Classes

Interfaces

Traits

Exceptions

Functions

AWS Server Migration Service 2016-10-24

Operation Summary

Paginators

Operations

CreateApp

Parameter Syntax

Parameter Details

Members

Result Syntax

Result Details

Members

Errors

CreateReplicationJob

Parameter Syntax

Parameter Details

Members

Result Syntax

Result Details

Members

Errors

DeleteApp

Parameter Syntax

Parameter Details

Members

Result Syntax

Result Details

Errors

DeleteAppLaunchConfiguration

Parameter Syntax

Parameter Details

Members

Result Syntax

Result Details

Errors

DeleteAppReplicationConfiguration

Parameter Syntax

Parameter Details

Members

Result Syntax

Result Details

Errors

DeleteReplicationJob

Parameter Syntax

Parameter Details

Members

Result Syntax

Result Details

Errors

DeleteServerCatalog

Parameter Syntax

Parameter Details

Members

Result Syntax

Result Details

Errors

DisassociateConnector

Parameter Syntax

Parameter Details

Members

Result Syntax

Result Details

Errors

GenerateChangeSet

Parameter Syntax

Parameter Details

Members

Result Syntax

Result Details

Members

Errors

GenerateTemplate

Parameter Syntax

Parameter Details

Members