---
title: "POST /#X-Amz-Target=AWSServerMigrationService_V2016_10_24.GetReplicationJobs"
method: POST
path: "/#X-Amz-Target=AWSServerMigrationService_V2016_10_24.GetReplicationJobs"
---

# POST /#X-Amz-Target=AWSServerMigrationService_V2016_10_24.GetReplicationJobs

`POST /#X-Amz-Target=AWSServerMigrationService_V2016_10_24.GetReplicationJobs`

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

## Query parameters

- `maxResults` string
- `nextToken` string

## Headers

- `X-Amz-Target` 'AWSServerMigrationService_V2016_10_24.GetReplicationJobs', required

## Request body

- GetReplicationJobsRequest
  - `replicationJobId` string — The ID of the replication job.
  - `nextToken` string — The token for the next set of results.
  - `maxResults` integer — 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 <code>NextToken</code> value.

## Response `200`

Success

- GetReplicationJobsResponse
  - `replicationJobList` ReplicationJob[] — Information about the replication jobs.
    - `replicationJobId` string — The ID of the replication job.
    - `serverId` string — The ID of the server.
    - `serverType` 'VIRTUAL_MACHINE' — The type of server.
    - `vmServer` object — Information about the VM server.
      - `vmServerAddress` object — The VM server location.
        - `vmManagerId` string — The ID of the VM manager.
        - `vmId` string — The ID of the VM.
      - `vmName` string — The name of the VM.
      - `vmManagerName` string — The name of the VM manager.
      - `vmManagerType` 'VSPHERE' | 'SCVMM' | 'HYPERV-MANAGER' — The type of VM management product.
      - `vmPath` string — The VM folder path in the vCenter Server virtual machine inventory tree.
    - `seedReplicationTime` string, date-time — The seed replication time.
    - `frequency` integer — The time between consecutive replication runs, in hours.
    - `runOnce` boolean — Indicates whether to run the replication job one time.
    - `nextReplicationRunStartTime` string, date-time — The start time of the next replication run.
    - `licenseType` 'AWS' | 'BYOL' — The license type to be used for the AMI created by a successful replication run.
    - `roleName` string — The name of the IAM role to be used by Server Migration Service.
    - `latestAmiId` string — The ID of the latest Amazon Machine Image (AMI).
    - `state` 'PENDING' | 'ACTIVE' | 'FAILED' | 'DELETING' | 'DELETED' | 'COMPLETED' | 'PAUSED_ON_FAILURE' | 'FAILING' — The state of the replication job.
    - `statusMessage` string — The description of the current status of the replication job.
    - `description` string — The description of the replication job.
    - `numberOfRecentAmisToKeep` integer — The 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.
    - `encrypted` boolean — Indicates whether the replication job should produce encrypted AMIs.
    - `kmsKeyId` string — <p>The ID of the KMS key for replication jobs that produce encrypted AMIs. This value can be any of the following: </p> <ul> <li> <p>KMS key ID</p> </li> <li> <p>KMS key alias</p> </li> <li> <p>ARN referring to the KMS key ID</p> </li> <li> <p>ARN referring to the KMS key alias</p> </li> </ul> <p>If encrypted is enabled but a KMS key ID is not specified, the customer's default KMS key for Amazon EBS is used.</p>
    - `replicationRunList` ReplicationRun[] — Information about the replication runs.
      - `replicationRunId` string — The ID of the replication run.
      - `state` 'PENDING' | 'MISSED' | 'ACTIVE' | 'FAILED' | 'COMPLETED' | 'DELETING' | 'DELETED' — The state of the replication run.
      - `type` 'ON_DEMAND' | 'AUTOMATIC' — The type of replication run.
      - `stageDetails` object — Details about the current stage of the replication run.
        - `stage` string — The current stage of a replication run.
        - `stageProgress` string — The progress of the current stage of a replication run.
      - `statusMessage` string — The description of the current status of the replication job.
      - `amiId` string — The ID of the Amazon Machine Image (AMI) from the replication run.
      - `scheduledStartTime` string, date-time — The start time of the next replication run.
      - `completedTime` string, date-time — The completion time of the last replication run.
      - `description` string — The description of the replication run.
      - `encrypted` boolean — Indicates whether the replication run should produce an encrypted AMI.
      - `kmsKeyId` string — <p>The ID of the KMS key for replication jobs that produce encrypted AMIs. This value can be any of the following:</p> <ul> <li> <p>KMS key ID</p> </li> <li> <p>KMS key alias</p> </li> <li> <p>ARN referring to the KMS key ID</p> </li> <li> <p>ARN referring to the KMS key alias</p> </li> </ul> <p> If encrypted is <i>true</i> but a KMS key ID is not specified, the customer's default KMS key for Amazon EBS is used. </p>
  - `nextToken` string — The token required to retrieve the next set of results. This value is null when there are no more results to return.

## Other responses

- `480` — InvalidParameterException
- `481` — MissingRequiredParameterException
- `482` — UnauthorizedOperationException

---

[API](https://skmtc.net/aws/apis/sms.md) · [All operations](https://skmtc.net/aws/apis/sms/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/aws/sms/versions/b93b64b4502e/schema)
