list-dbc-diagnostic-data-jobs¶

Description¶

Lists diagnostic jobs for the given Database Catalog. The output includes a list of jobs along with their current status and metadata related to each job.

list-dbc-diagnostic-data-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.

Synopsis¶

  list-dbc-diagnostic-data-jobs
--cluster-id <value>
--dbc-id <value>
[--status <value>]
[--max-items <value>]
[--starting-token <value>]
[--page-size <value>]
[--cli-input-json <value>]
[--generate-cli-skeleton]

Options¶

--cluster-id (string)

ID of cluster.

--dbc-id (string)

ID of the Database Catalog.

--status (string)

Represents the possible status values of a Diagnostic Data Job.

Possible values:

• Starting

• Succeeded

• Failed

• Running

• Unknown

• Deleted

Form Factors: public

--max-items (integer)

The total number of items to return. If the total number of items available is more than the value specified in max-items then a nextToken will be provided in the output that you can use to resume pagination. This nextToken response element should not be used directly outside of the CDP CLI. This option cannnot be combined with the no-paginate CLI option. If no max-items value is specified, then a default value of 100 is used.

--starting-token (string)

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

--page-size (integer)

The size of each page. Generally this does not need to be set and the default page size used is appropriate.

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

--generate-cli-skeleton (boolean)

Prints a sample input JSON to standard output. Note the specified operation is not run if this argument is specified. The sample input can be used as an argument for --cli-input-json.

Output¶

jobs -> (array)

The list of the jobs belonging to the particular Database Catalog

item -> (object)

Represents a Diagnostic Data Job

Form Factors: public

jobId -> (string)

The unique identifier of the Diagnostic Data Job.

startTime -> (datetime)

The start time of the Diagnostic Data Job.

endTime -> (datetime)

The finish time of the Diagnostic Data Job.

url -> (string)

This URL points to a download location if the destination is DOWNLOAD.

status -> (string)

Represents the possible status values of a Diagnostic Data Job.

Form Factors: public

labels -> (map)

Additional key-value pair attributes associated with the Diagnostic Data Job.

key -> (string)

value -> (string)

nextToken -> (string)

The token to use when requesting the next set of results. If there are no additional results, the string is empty.

Form Factors¶

public