AWS Server Migration Service
API Reference (API Version 2016-10-24)

GetReplicationJobs

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

Request Syntax

{ "maxResults": number, "nextToken": "string", "replicationJobId": "string" }

Request Parameters

For information about the parameters that are common to all actions, see Common Parameters.

The request accepts the following data in JSON format.

maxResults

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.

Type: Integer

Required: No

nextToken

The token for the next set of results.

Type: String

Required: No

replicationJobId

The identifier of the replication job.

Type: String

Required: No

Response Syntax

{ "nextToken": "string", "replicationJobList": [ { "description": "string", "encrypted": boolean, "frequency": number, "kmsKeyId": "string", "latestAmiId": "string", "licenseType": "string", "nextReplicationRunStartTime": number, "numberOfRecentAmisToKeep": number, "replicationJobId": "string", "replicationRunList": [ { "amiId": "string", "completedTime": number, "description": "string", "encrypted": boolean, "kmsKeyId": "string", "replicationRunId": "string", "scheduledStartTime": number, "stageDetails": { "stage": "string", "stageProgress": "string" }, "state": "string", "statusMessage": "string", "type": "string" } ], "roleName": "string", "runOnce": boolean, "seedReplicationTime": number, "serverId": "string", "serverType": "string", "state": "string", "statusMessage": "string", "vmServer": { "vmManagerName": "string", "vmManagerType": "string", "vmName": "string", "vmPath": "string", "vmServerAddress": { "vmId": "string", "vmManagerId": "string" } } } ] }

Response Elements

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

nextToken

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

Type: String

replicationJobList

Information about the replication jobs.

Type: Array of ReplicationJob objects

Errors

For information about the errors that are common to all actions, see Common Errors.

InvalidParameterException

A specified parameter is not valid.

HTTP Status Code: 400

MissingRequiredParameterException

A required parameter is missing.

HTTP Status Code: 400

UnauthorizedOperationException

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

HTTP Status Code: 400

See Also

For more information about using this API in one of the language-specific AWS SDKs, see the following: