[ aws . drs ]

describe-jobs

Description

Returns a list of Jobs. Use the JobsID and fromDate and toDate filters to limit which jobs are returned. The response is sorted by creationDataTime - latest date first. Jobs are created by the StartRecovery, TerminateRecoveryInstances and StartFailbackLaunch 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

Synopsis

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

Options

--filters (structure)

A set of filters by which to return Jobs.

fromDate -> (string)

The start date in a date range query.

jobIDs -> (list)

An array of Job IDs that should be returned. An empty array means all jobs.

(string)

toDate -> (string)

The end date in a date range query.

Shorthand Syntax:

fromDate=string,jobIDs=string,string,toDate=string

JSON Syntax:

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

--cli-input-json | --cli-input-yaml (string) Reads arguments from the JSON string provided. The JSON string follows the format provided by --generate-cli-skeleton. If other arguments are provided on the command line, those 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. This may not be specified along with --cli-input-yaml.

--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. Similarly, if provided yaml-input it will print a sample input YAML that can be used with --cli-input-yaml. If provided with the value output, it validates the command inputs and returns a sample output JSON for that command. The generated JSON skeleton is not stable between versions of the AWS CLI and there are no backwards compatibility guarantees in the JSON skeleton generated.

See ‘aws help’ for descriptions of global parameters.

Output

items -> (list)

An array of Jobs.

(structure)

A job is an asynchronous workflow.

arn -> (string)

The ARN of a Job.

creationDateTime -> (string)

The date and time of when the Job was created.

endDateTime -> (string)

The date and time of when the Job ended.

initiatedBy -> (string)

A string representing who initiated the Job.

jobID -> (string)

The ID of the Job.

participatingServers -> (list)

A list of servers that the Job is acting upon.

(structure)

Represents a server participating in an asynchronous Job.

launchStatus -> (string)

The launch status of a participating server.

recoveryInstanceID -> (string)

The Recovery Instance ID of a participating server.

sourceServerID -> (string)

The Source Server ID of a participating server.

status -> (string)

The status of the Job.

tags -> (map)

A list of tags associated with the Job.

key -> (string)

value -> (string)

type -> (string)

The type of the Job.

nextToken -> (string)

The token of the next Job to retrieve.