Skip to content
AWS for Query.Farm

aws.finspace_data.get_external_data_view_access_details

Example SQL Queries

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

Description

Returns the credentials to access the external Dataview from an S3 location. To call this API:

  • You must retrieve the programmatic credentials.

  • You must be a member of a FinSpace user group, where the dataset that you want to access has Read Dataset Data permissions.

Table Definition

Column NameColumn Data Type
data_view_id Required Input Column

The unique identifier for the Dataview that you want to access.

VARCHAR
dataset_id Required Input Column

The unique identifier for the Dataset.

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.

credentials

The credentials required to access the external Dataview from the S3 location.

STRUCT(
    "access_key_id" VARCHAR,
    "secret_access_key" VARCHAR,
    "session_token" VARCHAR,
    "expiration" BIGINT
)
Show child fields
credentials.access_key_id

The unique identifier for the security credentials.

credentials.expiration

The Epoch time when the current credentials expire.

credentials.secret_access_key

The secret access key that can be used to sign requests.

credentials.session_token

The token that users must pass to use the credentials.

s3_location

The location where the external Dataview is stored.

STRUCT(
    "bucket" VARCHAR,
    "key" VARCHAR
)
Show child fields
s3_location.bucket

The name of the S3 bucket.

s3_location.key

The path of the folder, within the S3 bucket that contains the Dataset.