[ aws . databrew ]

list-datasets

Description

Lists all of the DataBrew datasets.

See also: AWS API Documentation

See ‘aws help’ for descriptions of global parameters.

list-datasets 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: Datasets

Synopsis

  list-datasets
[--cli-input-json | --cli-input-yaml]
[--starting-token <value>]
[--page-size <value>]
[--max-items <value>]
[--generate-cli-skeleton <value>]

Options

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

See ‘aws help’ for descriptions of global parameters.

Output

Datasets -> (list)

A list of datasets that are defined.

(structure)

Represents a dataset that can be processed by DataBrew.

AccountId -> (string)

The ID of the AWS account that owns the dataset.

CreatedBy -> (string)

The Amazon Resource Name (ARN) of the user who created the dataset.

CreateDate -> (timestamp)

The date and time that the dataset was created.

Name -> (string)

The unique name of the dataset.

FormatOptions -> (structure)

Options that define how DataBrew interprets the data in the dataset.

Json -> (structure)

Options that define how JSON input is to be interpreted by DataBrew.

MultiLine -> (boolean)

A value that specifies whether JSON input contains embedded new line characters.

Excel -> (structure)

Options that define how Excel input is to be interpreted by DataBrew.

SheetNames -> (list)

Specifies one or more named sheets in the Excel file, which will be included in the dataset.

(string)

SheetIndexes -> (list)

Specifies one or more sheet numbers in the Excel file, which will be included in the dataset.

(integer)

Csv -> (structure)

Options that define how Csv input is to be interpreted by DataBrew.

Delimiter -> (string)

A single character that specifies the delimiter being used in the Csv file.

Input -> (structure)

Information on how DataBrew can find the dataset, in either the AWS Glue Data Catalog or Amazon S3.

S3InputDefinition -> (structure)

The Amazon S3 location where the data is stored.

Bucket -> (string)

The S3 bucket name.

Key -> (string)

The unique name of the object in the bucket.

DataCatalogInputDefinition -> (structure)

The AWS Glue Data Catalog parameters for the data.

CatalogId -> (string)

The unique identifier of the AWS account that holds the Data Catalog that stores the data.

DatabaseName -> (string)

The name of a database in the Data Catalog.

TableName -> (string)

The name of a database table in the Data Catalog. This table corresponds to a DataBrew dataset.

TempDirectory -> (structure)

An Amazon location that AWS Glue Data Catalog can use as a temporary directory.

Bucket -> (string)

The S3 bucket name.

Key -> (string)

The unique name of the object in the bucket.

LastModifiedDate -> (timestamp)

The last modification date and time of the dataset.

LastModifiedBy -> (string)

The Amazon Resource Name (ARN) of the user who last modified the dataset.

Source -> (string)

The location of the data for the dataset, either Amazon S3 or the AWS Glue Data Catalog.

Tags -> (map)

Metadata tags that have been applied to the dataset.

key -> (string)

value -> (string)

ResourceArn -> (string)

The unique Amazon Resource Name (ARN) for the dataset.

NextToken -> (string)

A token that you can use in a subsequent call to retrieve the next set of results.