AWS CLI Command Reference

[ aws . finspace-data ]

get-data-view

Description

Gets information about a Dataview.

See also: AWS API Documentation

Synopsis

  get-data-view
--data-view-id <value>
--dataset-id <value>
[--cli-input-json | --cli-input-yaml]
[--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>]
[--cli-binary-format <value>]
[--no-cli-pager]
[--cli-auto-prompt]
[--no-cli-auto-prompt]

Options

--data-view-id (string)

The unique identifier for the Dataview.

--dataset-id (string)

The unique identifier for the Dataset used in the Dataview.

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

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

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
  • yaml
  • yaml-stream

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

--cli-binary-format (string)

The formatting style to be used for binary blobs. The default format is base64. The base64 format expects binary blobs to be provided as a base64 encoded string. The raw-in-base64-out format preserves compatibility with AWS CLI V1 behavior and binary values must be passed literally. When providing contents from a file that map to a binary blob fileb:// will always be treated as binary and use the file contents directly regardless of the cli-binary-format setting. When using file:// the file contents will need to properly formatted for the configured cli-binary-format.

  • base64
  • raw-in-base64-out

--no-cli-pager (boolean)

Disable cli pager for output.

--cli-auto-prompt (boolean)

Automatically prompt for CLI input parameters.

--no-cli-auto-prompt (boolean)

Disable automatically prompt for CLI input parameters.

Output

autoUpdate -> (boolean)

Flag to indicate Dataview should be updated automatically.

partitionColumns -> (list)

Ordered set of column names used to partition data.

(string)

1 - 255 character String

datasetId -> (string)

The unique identifier for the Dataset used in the Dataview.

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.

errorInfo -> (structure)

Information about an error that occurred for the Dataview.

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.

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.

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.

sortColumns -> (list)

Columns to be used for sorting the data.

(string)

1 - 255 character String

dataViewId -> (string)

The unique identifier for the Dataview.

dataViewArn -> (string)

The ARN identifier of the Dataview.

destinationTypeParams -> (structure)

Options that define the destination type for the Dataview.

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)

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.
© Copyright 2018, Amazon Web Services. Created using Sphinx.