[ aws . lookoutvision ]

list-dataset-entries

Description

Lists the JSON Lines within a dataset. An Amazon Lookout for Vision JSON Line contains the anomaly information for a single image, including the image location and the assigned label.

This operation requires permissions to perform the lookoutvision:ListDatasetEntries operation.

See also: AWS API Documentation

See ‘aws help’ for descriptions of global parameters.

list-dataset-entries 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: DatasetEntries

Synopsis

  list-dataset-entries
--project-name <value>
--dataset-type <value>
[--labeled | --no-labeled]
[--anomaly-class <value>]
[--before-creation-date <value>]
[--after-creation-date <value>]
[--source-ref-contains <value>]
[--cli-input-json | --cli-input-yaml]
[--starting-token <value>]
[--page-size <value>]
[--max-items <value>]
[--generate-cli-skeleton <value>]

Options

--project-name (string)

The name of the project that contains the dataset that you want to list.

--dataset-type (string)

The type of the dataset that you want to list. Specify train to list the training dataset. Specify test to list the test dataset. If you have a single dataset project, specify train .

--labeled | --no-labeled (boolean)

Specify true to include labeled entries, otherwise specify false . If you don’t specify a value, Lookout for Vision returns all entries.

--anomaly-class (string)

Specify normal to include only normal images. Specify anomaly to only include anomalous entries. If you don’t specify a value, Amazon Lookout for Vision returns normal and anomalous images.

--before-creation-date (timestamp)

Only includes entries before the specified date in the response. For example, 2020-06-23T00:00:00 .

--after-creation-date (timestamp)

Only includes entries after the specified date in the response. For example, 2020-06-23T00:00:00 .

--source-ref-contains (string)

Perform a “contains” search on the values of the source-ref key within the dataset. For example a value of “IMG_17” returns all JSON Lines where the source-ref key value matches IMG_17 .

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

DatasetEntries -> (list)

A list of the entries (JSON Lines) within the dataset.

(string)

NextToken -> (string)

If the response is truncated, Amazon Lookout for Vision returns this token that you can use in the subsequent request to retrieve the next set ofdataset entries.