Table Of Contents

Feedback

User Guide

First time using the AWS CLI? See the User Guide for help getting started.

Note: You are viewing the documentation for an older major version of the AWS CLI (version 1).

AWS CLI version 2, the latest major version of AWS CLI, is now stable and recommended for general use. To view this page for the AWS CLI version 2, click here. For more information see the AWS CLI version 2 installation instructions and migration guide.

[ aws . sms ]

get-replication-jobs

Description

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

See also: AWS API Documentation

See 'aws help' for descriptions of global parameters.

get-replication-jobs is a paginated operation. Multiple API calls may be issued in order to retrieve the entire data set of results. You can disable pagination by providing the --no-paginate argument. When using --output text and the --query argument on a paginated response, the --query argument must extract data from the results of the following query expressions: replicationJobList

Synopsis

  get-replication-jobs
[--replication-job-id <value>]
[--cli-input-json <value>]
[--starting-token <value>]
[--page-size <value>]
[--max-items <value>]
[--generate-cli-skeleton <value>]

Options

--replication-job-id (string)

The ID of the replication job.

--cli-input-json (string) Performs service operation based on the JSON string provided. The JSON string follows the format provided by --generate-cli-skeleton. If other arguments are provided on the command line, the CLI values will override the JSON-provided values. It is not possible to pass arbitrary binary values using a JSON-provided value as the string will be taken literally.

--starting-token (string)

A token to specify where to start paginating. This is the NextToken from a previously truncated response.

For usage examples, see Pagination in the AWS Command Line Interface User Guide .

--page-size (integer)

The size of each page to get in the AWS service call. This does not affect the number of items returned in the command's output. Setting a smaller page size results in more calls to the AWS service, retrieving fewer items in each call. This can help prevent the AWS service calls from timing out.

For usage examples, see Pagination in the AWS Command Line Interface User Guide .

--max-items (integer)

The total number of items to return in the command's output. If the total number of items available is more than the value specified, a NextToken is provided in the command's output. To resume pagination, provide the NextToken value in the starting-token argument of a subsequent command. Do not use the NextToken response element directly outside of the AWS CLI.

For usage examples, see Pagination in the AWS Command Line Interface User Guide .

--generate-cli-skeleton (string) Prints a JSON skeleton to standard output without sending an API request. If provided with no value or the value input, prints a sample input JSON that can be used as an argument for --cli-input-json. If provided with the value output, it validates the command inputs and returns a sample output JSON for that command.

See 'aws help' for descriptions of global parameters.

Output

replicationJobList -> (list)

Information about the replication jobs.

(structure)

Represents a replication job.

replicationJobId -> (string)

The ID of the replication job.

serverId -> (string)

The ID of the server.

serverType -> (string)

The type of server.

vmServer -> (structure)

Information about the VM server.

vmServerAddress -> (structure)

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 -> (string)

The type of VM management product.

vmPath -> (string)

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

seedReplicationTime -> (timestamp)

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 -> (timestamp)

The start time of the next replication run.

licenseType -> (string)

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

latestAmiId -> (string)

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

state -> (string)

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)

The ID of the KMS key for replication jobs that produce encrypted AMIs. This value can be any of the following:

  • KMS key ID
  • KMS key alias
  • ARN referring to the KMS key ID
  • ARN referring to the KMS key alias

If encrypted is enabled but a KMS key ID is not specified, the customer's default KMS key for Amazon EBS is used.

replicationRunList -> (list)

Information about the replication runs.

(structure)

Represents a replication run.

replicationRunId -> (string)

The ID of the replication run.

state -> (string)

The state of the replication run.

type -> (string)

The type of replication run.

stageDetails -> (structure)

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 -> (timestamp)

The start time of the next replication run.

completedTime -> (timestamp)

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)

The ID of the KMS key for replication jobs that produce encrypted AMIs. This value can be any of the following:

  • KMS key ID
  • KMS key alias
  • ARN referring to the KMS key ID
  • ARN referring to the KMS key alias

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

nextToken -> (string)

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