Skip to content
AWS for Query.Farm

aws.finspace_data.get_data_view

Example SQL Queries

SELECT * FROM
aws.finspace_data.get_data_view
WHERE
"data_view_id" = 'VALUE'
AND "dataset_id" = 'VALUE';

Description

Gets information about a Dataview.

Table Definition

Column NameColumn Data Type
data_view_id Required Input Column

The unique identifier for the Dataview.

VARCHAR
dataset_id Required Input Column

The unique identifier for the Dataset used in the Dataview.

VARCHAR
_aws_profile Input Column

The AWS profile defines the AWS identity used. It can be defined via credentials or by assuming a IAM role.

STRUCT(
    "type" VARCHAR,
    "name" VARCHAR,
    "account_id" VARCHAR,
    "via_profile_name" VARCHAR,
    "assumed_role_arn" VARCHAR,
    "organization" STRUCT(
        "account_name" VARCHAR,
        "id" VARCHAR,
        "tags" STRUCT(
            "key" VARCHAR,
            "value" VARCHAR
        )[],
        "master_account" STRUCT(
            "id" VARCHAR,
            "email" VARCHAR
        ),
        "parents" STRUCT(
            "type" VARCHAR,
            "id" VARCHAR,
            "name" VARCHAR,
            "tags" STRUCT(
                "key" VARCHAR,
                "value" VARCHAR
            )[]
        )[]
    )
)
Show child fields
_aws_profile.account_id

The AWS account id

_aws_profile.assumed_role_arn

The ARN of the assumed role

_aws_profile.name

The unique name of the profile.

_aws_profile.organization

Information about this profile's membership in the AWS organization.

Show child fields
_aws_profile.organization.account_name

The name of account speciifed by the organization

_aws_profile.organization.id

The organization id

_aws_profile.organization.master_account
Show child fields
_aws_profile.organization.master_account.email

The organization master account email address

_aws_profile.organization.master_account.id

The organization master account id

_aws_profile.organization.parents[]
Show child fields
_aws_profile.organization.parents[].id

The id of the parent

_aws_profile.organization.parents[].name

The name of the parent

_aws_profile.organization.parents[].tags[]
Show child fields
_aws_profile.organization.parents[].tags[].key
_aws_profile.organization.parents[].tags[].value
_aws_profile.organization.parents[].type

The type of parent can be an organization unit or a root

_aws_profile.organization.tags[]
Show child fields
_aws_profile.organization.tags[].key
_aws_profile.organization.tags[].value
_aws_profile.type

The type of profile, either 'credentials' or 'assumed_role'

_aws_profile.via_profile_name

This IAM role for this profile is assumed by first utilizing another profile with this name to obtain credentials.

as_of_timestamp

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.

BIGINT
auto_update

Flag to indicate Dataview should be updated automatically.

BOOLEAN
create_time

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.

BIGINT
data_view_arn

The ARN identifier of the Dataview.

VARCHAR
destination_type_params

Options that define the destination type for the Dataview.

STRUCT(
    "destination_type" VARCHAR,
    "s3_destination_export_file_format" VARCHAR,
    "s3_destination_export_file_format_options" MAP(VARCHAR, VARCHAR)
)
Show child fields
destination_type_params.destination_type

Destination type for a Dataview.

  • GLUE_TABLE – Glue table destination type.

  • S3 – S3 destination type.

destination_type_params.s3_destination_export_file_format

Dataview export file format.

  • PARQUET – Parquet export file format.

  • DELIMITED_TEXT – Delimited text export file format.

destination_type_params.s3_destination_export_file_format_options

Format Options for S3 Destination type.

Here is an example of how you could specify the s3DestinationExportFileFormatOptions

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

error_info

Information about an error that occurred for the Dataview.

STRUCT(
    "error_message" VARCHAR,
    "error_category" VARCHAR
)
Show child fields
error_info.error_category

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.

error_info.error_message

The text of the error message.

last_modified_time

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.

BIGINT
partition_columns

Ordered set of column names used to partition data.

VARCHAR[]
Show child fields
partition_columns[]
sort_columns

Columns to be used for sorting the data.

VARCHAR[]
Show child fields
sort_columns[]
status

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.

VARCHAR