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

describe-job-log-items

Description

Retrieves a detailed Job log with pagination.

See also: AWS API Documentation

describe-job-log-items 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-job-log-items
--job-id <value>
[--cli-input-json <value>]
[--starting-token <value>]
[--page-size <value>]
[--max-items <value>]
[--generate-cli-skeleton <value>]
[--debug]
[--endpoint-url <value>]
[--no-verify-ssl]
[--no-paginate]
[--output <value>]
[--query <value>]
[--profile <value>]
[--region <value>]
[--version <value>]
[--color <value>]
[--no-sign-request]
[--ca-bundle <value>]
[--cli-read-timeout <value>]
[--cli-connect-timeout <value>]

Options

--job-id (string)

The ID of the Job for which Job log items will be retrieved.

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

Global Options

--debug (boolean)

Turn on debug logging.

--endpoint-url (string)

Override command's default URL with the given URL.

--no-verify-ssl (boolean)

By default, the AWS CLI uses SSL when communicating with AWS services. For each SSL connection, the AWS CLI will verify SSL certificates. This option overrides the default behavior of verifying SSL certificates.

--no-paginate (boolean)

Disable automatic pagination.

--output (string)

The formatting style for command output.

  • json
  • text
  • table

--query (string)

A JMESPath query to use in filtering the response data.

--profile (string)

Use a specific profile from your credential file.

--region (string)

The region to use. Overrides config/env settings.

--version (string)

Display the version of this tool.

--color (string)

Turn on/off color output.

  • on
  • off
  • auto

--no-sign-request (boolean)

Do not sign requests. Credentials will not be loaded if this argument is provided.

--ca-bundle (string)

The CA certificate bundle to use when verifying SSL certificates. Overrides config/env settings.

--cli-read-timeout (int)

The maximum socket read time in seconds. If the value is set to 0, the socket read will be blocking and not timeout. The default value is 60 seconds.

--cli-connect-timeout (int)

The maximum socket connect time in seconds. If the value is set to 0, the socket connect will be blocking and not timeout. The default value is 60 seconds.

Output

items -> (list)

An array of Job log items.

(structure)

A log outputted by a Job.

event -> (string)

The event represents the type of a log.

eventData -> (structure)

Metadata associated with a Job log.

conversionProperties -> (structure)

Properties of a conversion job

dataTimestamp -> (string)

The timestamp of when the snapshot being converted was taken

forceUefi -> (boolean)

Whether the volume being converted uses UEFI or not

rootVolumeName -> (string)

The root volume name of a conversion job

volumeToConversionMap -> (map)

A mapping between the volumes being converted and the converted snapshot ids

key -> (string)

value -> (map)

key -> (string)

value -> (string)

volumeToProductCodes -> (map)

A mapping between the volumes being converted and the product codes associated with them

key -> (string)

value -> (list)

(structure)

Properties of a product code associated with a volume.

productCodeId -> (string)

Id of a product code associated with a volume.

productCodeMode -> (string)

Mode of a product code associated with a volume.

volumeToVolumeSize -> (map)

A mapping between the volumes and their sizes

key -> (string)

value -> (long)

conversionServerID -> (string)

The ID of a conversion server.

eventResourceData -> (tagged union structure)

Properties of resource related to a job event.

Note

This is a Tagged Union structure. Only one of the following top level keys can be set: sourceNetworkData.

sourceNetworkData -> (structure)

Source Network properties.

sourceNetworkID -> (string)

Source Network ID.

sourceVpc -> (string)

VPC ID protected by the Source Network.

stackName -> (string)

CloudFormation stack name that was deployed for recovering the Source Network.

targetVpc -> (string)

ID of the recovered VPC following Source Network recovery.

rawError -> (string)

A string representing a job error.

sourceServerID -> (string)

The ID of a Source Server.

targetInstanceID -> (string)

The ID of a Recovery Instance.

logDateTime -> (string)

The date and time the log was taken.

nextToken -> (string)

The token of the next Job log items to retrieve.