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 . mgn ]



Returns a list of Jobs. Use the JobsID and fromDate and toData filters to limit which jobs are returned. The response is sorted by creationDataTime - latest date first. Jobs are normally created by the StartTest, StartCutover, and TerminateTargetInstances APIs. Jobs are also created by DiagnosticLaunch and TerminateDiagnosticInstances, which are APIs available only to Support and only used in response to relevant support tickets.

See also: AWS API Documentation

See 'aws help' for descriptions of global parameters.

describe-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: items


[--filters <value>]
[--cli-input-json <value>]
[--starting-token <value>]
[--page-size <value>]
[--max-items <value>]
[--generate-cli-skeleton <value>]


--filters (structure)

Request to describe Job log filters.

fromDate -> (string)

Request to describe Job log filters by date.

jobIDs -> (list)

Request to describe Job log filters by job ID.


toDate -> (string)

Request to describe job log items by last date.

Shorthand Syntax:


JSON Syntax:

  "fromDate": "string",
  "jobIDs": ["string", ...],
  "toDate": "string"

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


items -> (list)

Request to describe Job log items.



arn -> (string)

the ARN of the specific Job.

creationDateTime -> (string)

Job creation time.

endDateTime -> (string)

Job end time.

initiatedBy -> (string)

Job initiated by field.

jobID -> (string)

Job ID.

participatingServers -> (list)

Servers participating in a specific Job.


Server participating in Job.

launchStatus -> (string)

Participating server launch status.

launchedEc2InstanceID -> (string)

Participating server Source Server ID.

postLaunchActionsStatus -> (structure)

Participating server Source Server ID.

postLaunchActionsLaunchStatusList -> (list)

Server participating in Job.


Job type.

executionID -> (string)

Job type.

executionStatus -> (string)

Job type.

failureReason -> (string)

Job type.

ssmDocument -> (structure)

Job type.

actionName -> (string)

Source server replication type.

mustSucceedForCutover -> (boolean)

Source server replication type.

parameters -> (map)

Source server replication type.

key -> (string)

value -> (list)


Source server replication type.

parameterName -> (string)

Source server replication type.

parameterType -> (string)

Source server replication type.

ssmDocumentName -> (string)

Source server replication type.

timeoutSeconds -> (integer)

Source server replication type.

ssmDocumentType -> (string)

Job type.

ssmAgentDiscoveryDatetime -> (string)

Server participating in Job.

sourceServerID -> (string)

Participating server Source Server ID.

status -> (string)

Job status.

tags -> (map)

Tags associated with specific Job.

key -> (string)

value -> (string)

type -> (string)

Job type.

nextToken -> (string)

Request to describe Job response by next token.