AWS CLI Command Reference

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

list-datasets

Description

List the datasets that you have configured in this Region. For more information about datasets, see Flywheel overview in the Amazon Comprehend Developer Guide .

See also: AWS API Documentation

Synopsis

  list-datasets
[--flywheel-arn <value>]
[--filter <value>]
[--next-token <value>]
[--max-results <value>]
[--cli-input-json <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

--flywheel-arn (string)

The Amazon Resource Number (ARN) of the flywheel.

--filter (structure)

Filters the datasets to be returned in the response.

Status -> (string)

Filter the datasets based on the dataset status.

DatasetType -> (string)

Filter the datasets based on the dataset type.

CreationTimeAfter -> (timestamp)

Filter the datasets to include datasets created after the specified time.

CreationTimeBefore -> (timestamp)

Filter the datasets to include datasets created before the specified time.

Shorthand Syntax:

Status=string,DatasetType=string,CreationTimeAfter=timestamp,CreationTimeBefore=timestamp

JSON Syntax:

{
  "Status": "CREATING"|"COMPLETED"|"FAILED",
  "DatasetType": "TRAIN"|"TEST",
  "CreationTimeAfter": timestamp,
  "CreationTimeBefore": timestamp
}

--next-token (string)

Identifies the next page of results to return.

--max-results (integer)

Maximum number of results to return in a response. The default is 100.

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

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

Examples

Note

To use the following examples, you must have the AWS CLI installed and configured. See the Getting started guide in the AWS CLI User Guide for more information.

Unless otherwise stated, all examples have unix-like quotation rules. These examples will need to be adapted to your terminal's quoting rules. See Using quotation marks with strings in the AWS CLI User Guide .

To list all flywheel datasets

The following list-datasets example lists all datasets associated with a flywheel.

aws comprehend list-datasets \
    --flywheel-arn arn:aws:comprehend:us-west-2:111122223333:flywheel/flywheel-entity

Output:

{
    "DatasetPropertiesList": [
        {
            "DatasetArn": "arn:aws:comprehend:us-west-2:111122223333:flywheel/flywheel-entity/dataset/example-dataset-1",
            "DatasetName": "example-dataset-1",
            "DatasetType": "TRAIN",
            "DatasetS3Uri": "s3://DOC-EXAMPLE-BUCKET/flywheel-entity/schemaVersion=1/20230616T200543Z/datasets/example-dataset-1/20230616T203710Z/",
            "Status": "CREATING",
            "CreationTime": "2023-06-16T20:37:10.400000+00:00"
        },
        {
            "DatasetArn": "arn:aws:comprehend:us-west-2:111122223333:flywheel/flywheel-entity/dataset/example-dataset-2",
            "DatasetName": "example-dataset-2",
            "DatasetType": "TRAIN",
            "DatasetS3Uri": "s3://DOC-EXAMPLE-BUCKET/flywheel-entity/schemaVersion=1/20230616T200543Z/datasets/example-dataset-2/20230616T200607Z/",
            "Description": "TRAIN Dataset created by Flywheel creation.",
            "Status": "COMPLETED",
            "NumberOfDocuments": 5572,
            "CreationTime": "2023-06-16T20:06:07.722000+00:00"
        }
    ]
}

For more information, see Flywheel Overview in Amazon Comprehend Developer Guide.

Output

DatasetPropertiesList -> (list)

The dataset properties list.

(structure)

Properties associated with the dataset.

DatasetArn -> (string)

The ARN of the dataset.

DatasetName -> (string)

The name of the dataset.

DatasetType -> (string)

The dataset type (training data or test data).

DatasetS3Uri -> (string)

The S3 URI where the dataset is stored.

Description -> (string)

Description of the dataset.

Status -> (string)

The dataset status. While the system creates the dataset, the status is CREATING . When the dataset is ready to use, the status changes to COMPLETED .

Message -> (string)

A description of the status of the dataset.

NumberOfDocuments -> (long)

The number of documents in the dataset.

CreationTime -> (timestamp)

Creation time of the dataset.

EndTime -> (timestamp)

Time when the data from the dataset becomes available in the data lake.

NextToken -> (string)

Identifies the next page of results to return.