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 . finspace-data ]

list-data-views

Description

Lists all available Dataviews for a Dataset.

See also: AWS API Documentation

list-data-views 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: dataViews

Synopsis

  list-data-views
--dataset-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

--dataset-id (string)

The unique identifier of the Dataset for which to retrieve Dataviews.

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

nextToken -> (string)

A token that indicates where a results page should begin.

dataViews -> (list)

A list of Dataviews.

(structure)

Structure for the summary of a Dataview.

dataViewId -> (string)

The unique identifier for the Dataview.

dataViewArn -> (string)

The ARN identifier of the Dataview.

datasetId -> (string)

Th unique identifier for the Dataview Dataset.

asOfTimestamp -> (long)

Time range to use for the Dataview. The value is determined as epoch time in milliseconds. For example, the value for Monday, November 1, 2021 12:00:00 PM UTC is specified as 1635768000000.

partitionColumns -> (list)

Ordered set of column names used to partition data.

(string)

1 - 255 character String

sortColumns -> (list)

Columns to be used for sorting the data.

(string)

1 - 255 character String

status -> (string)

The status of a Dataview creation.

  • RUNNING – Dataview creation is running.
  • STARTING – Dataview creation is starting.
  • FAILED – Dataview creation has failed.
  • CANCELLED – Dataview creation has been cancelled.
  • TIMEOUT – Dataview creation has timed out.
  • SUCCESS – Dataview creation has succeeded.
  • PENDING – Dataview creation is pending.
  • FAILED_CLEANUP_FAILED – Dataview creation failed and resource cleanup failed.

errorInfo -> (structure)

The structure with error messages.

errorMessage -> (string)

The text of the error message.

errorCategory -> (string)

The category of the error.

  • VALIDATION – The inputs to this request are invalid.
  • SERVICE_QUOTA_EXCEEDED – Service quotas have been exceeded. Please contact AWS support to increase quotas.
  • ACCESS_DENIED – Missing required permission to perform this request.
  • RESOURCE_NOT_FOUND – One or more inputs to this request were not found.
  • THROTTLING – The system temporarily lacks sufficient resources to process the request.
  • INTERNAL_SERVICE_EXCEPTION – An internal service error has occurred.
  • CANCELLED – Cancelled.
  • USER_RECOVERABLE – A user recoverable error has occurred.

destinationTypeProperties -> (structure)

Information about the Dataview destination.

destinationType -> (string)

Destination type for a Dataview.

  • GLUE_TABLE – Glue table destination type.
  • S3 – S3 destination type.

s3DestinationExportFileFormat -> (string)

Dataview export file format.

  • PARQUET – Parquet export file format.
  • DELIMITED_TEXT – Delimited text export file format.

s3DestinationExportFileFormatOptions -> (map)

Format Options for S3 Destination type.

Here is an example of how you could specify the s3DestinationExportFileFormatOptions

{ "header": "true", "delimiter": ",", "compression": "gzip" }

key -> (string)

value -> (string)

autoUpdate -> (boolean)

The flag to indicate Dataview should be updated automatically.

createTime -> (long)

The timestamp at which the Dataview was created in FinSpace. The value is determined as epoch time in milliseconds. For example, the value for Monday, November 1, 2021 12:00:00 PM UTC is specified as 1635768000000.

lastModifiedTime -> (long)

The last time that a Dataview was modified. The value is determined as epoch time in milliseconds. For example, the value for Monday, November 1, 2021 12:00:00 PM UTC is specified as 1635768000000.