external_data_view_access_details
Creates, updates, deletes, gets or lists an external_data_view_access_details resource.
Overview
| Name | external_data_view_access_details |
| Type | Resource |
| Id | aws.finspace_data.external_data_view_access_details |
Fields
The following fields are returned by SELECT queries:
- get_external_data_view_access_details
| Name | Datatype | Description |
|---|---|---|
credentials | object | The credentials required to access the external Dataview from the S3 location. |
s_3_location | object | The location where the external Dataview is stored. |
Methods
The following methods are available for this resource:
| Name | Accessible by | Required Params | Optional Params | Description |
|---|---|---|---|---|
get_external_data_view_access_details | select | dataview_id, dataset_id, region | 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. |
Parameters
Parameters can be passed in the WHERE clause of a query. Check the Methods section to see which parameters are required or optional for each operation.
| Name | Datatype | Description |
|---|---|---|
dataset_id | string | The unique identifier for the Dataset. |
dataview_id | string | The unique identifier for the Dataview that you want to access. |
region | string | AWS region (default: us-east-1) |
SELECT examples
- get_external_data_view_access_details
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.
SELECT
credentials,
s_3_location
FROM aws.finspace_data.external_data_view_access_details
WHERE dataview_id = '{{ dataview_id }}' -- required
AND dataset_id = '{{ dataset_id }}' -- required
AND region = '{{ region }}' -- required
;