Skip to main content

data_sources

Creates, updates, deletes, gets or lists a data_sources resource.

Overview

Namedata_sources
TypeResource
Idaws.quicksight.data_sources

Fields

The following fields are returned by SELECT queries:

NameDatatypeDescription
data_sourceobjectThe structure of a data source.
request_idstringThe Amazon Web Services request ID for this operation.
statusintegerThe HTTP status of the request.

Methods

The following methods are available for this resource:

NameAccessible byRequired ParamsOptional ParamsDescription
describe_data_sourceselectaws_account_id, data_source_id, regionDescribes a data source.
search_data_sourcesselectaws_account_id, regionUse the SearchDataSources operation to search for data sources that belong to an account.
list_data_sourcesselectaws_account_id, regionnext-token, max-resultsLists data sources in current Amazon Web Services Region that belong to this Amazon Web Services account.
create_data_sourceinsertaws_account_id, region, DataSourceIdCreates a data source.
update_data_sourceupdateaws_account_id, data_source_id, regionUpdates a data source.
delete_data_sourcedeleteaws_account_id, data_source_id, regionDeletes the data source permanently. This operation breaks all the datasets that reference the deleted data source.

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.

NameDatatypeDescription
aws_account_idstringThe Amazon Web Services account ID.
data_source_idstringThe ID of the data source. This ID is unique per Amazon Web Services Region for each Amazon Web Services account.
regionstringAWS region (default: us-east-1)
max-resultsintegerThe maximum number of results to be returned per request.
next-tokenstringThe token for the next set of results, or null if there are no more results.

SELECT examples

Describes a data source.

SELECT
data_source,
request_id,
status
FROM aws.quicksight.data_sources
WHERE aws_account_id = '{{ aws_account_id }}' -- required
AND data_source_id = '{{ data_source_id }}' -- required
AND region = '{{ region }}' -- required
;

INSERT examples

Creates a data source.

INSERT INTO aws.quicksight.data_sources (
DataSourceId,
Name,
Type,
DataSourceParameters,
Credentials,
Permissions,
VpcConnectionProperties,
SslProperties,
Tags,
FolderArns,
aws_account_id,
region
)
SELECT
'{{ DataSourceId }}' /* required */,
'{{ Name }}',
'{{ Type }}',
'{{ DataSourceParameters }}',
'{{ Credentials }}',
'{{ Permissions }}',
'{{ VpcConnectionProperties }}',
'{{ SslProperties }}',
'{{ Tags }}',
'{{ FolderArns }}',
'{{ aws_account_id }}',
'{{ region }}'
RETURNING
arn,
creation_status,
data_source_id,
request_id,
status
;

UPDATE examples

Updates a data source.

UPDATE aws.quicksight.data_sources
SET
Name = '{{ Name }}',
DataSourceParameters = '{{ DataSourceParameters }}',
Credentials = '{{ Credentials }}',
VpcConnectionProperties = '{{ VpcConnectionProperties }}',
SslProperties = '{{ SslProperties }}'
WHERE
aws_account_id = '{{ aws_account_id }}' --required
AND data_source_id = '{{ data_source_id }}' --required
AND region = '{{ region }}' --required
RETURNING
arn,
data_source_id,
request_id,
status,
update_status;

DELETE examples

Deletes the data source permanently. This operation breaks all the datasets that reference the deleted data source.

DELETE FROM aws.quicksight.data_sources
WHERE aws_account_id = '{{ aws_account_id }}' --required
AND data_source_id = '{{ data_source_id }}' --required
AND region = '{{ region }}' --required
;