Skip to content
AWS for Query.Farm

aws.quicksight.describe_data_source

Example SQL Queries

SELECT * FROM
aws.quicksight.describe_data_source
WHERE
"aws_account_id" = 'VALUE'
AND "data_source_id" = 'VALUE';

Description

Describes a data source.

Table Definition

Column NameColumn Data Type
aws_account_id Required Input Column

The Amazon Web Services account ID.

VARCHAR
data_source_id Required Input Column

The ID of the data source. This ID is unique per Amazon Web Services Region for each Amazon Web Services account.

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.

_aws_region Input Column

The AWS region to use.

VARCHAR
data_source

The information on the data source.

STRUCT(
    "arn" VARCHAR,
    "data_source_id" VARCHAR,
    "name" VARCHAR,
    "type" VARCHAR,
    "status" VARCHAR,
    "created_time" TIMESTAMP_S,
    "last_updated_time" TIMESTAMP_S,
    "data_source_parameters" STRUCT(
        "amazon_elasticsearch_parameters" STRUCT(
            "domain" VARCHAR
        ),
        "athena_parameters" STRUCT(
            "work_group" VARCHAR,
            "role_arn" VARCHAR
        ),
        "aurora_parameters" STRUCT(
            "host" VARCHAR,
            "port" BIGINT,
            "database" VARCHAR
        ),
        "aurora_postgre_sql_parameters" STRUCT(
            "host" VARCHAR,
            "port" BIGINT,
            "database" VARCHAR
        ),
        "aws_iot_analytics_parameters" STRUCT(
            "data_set_name" VARCHAR
        ),
        "jira_parameters" STRUCT(
            "site_base_url" VARCHAR
        ),
        "maria_db_parameters" STRUCT(
            "host" VARCHAR,
            "port" BIGINT,
            "database" VARCHAR
        ),
        "my_sql_parameters" STRUCT(
            "host" VARCHAR,
            "port" BIGINT,
            "database" VARCHAR
        ),
        "oracle_parameters" STRUCT(
            "host" VARCHAR,
            "port" BIGINT,
            "database" VARCHAR
        ),
        "postgre_sql_parameters" STRUCT(
            "host" VARCHAR,
            "port" BIGINT,
            "database" VARCHAR
        ),
        "presto_parameters" STRUCT(
            "host" VARCHAR,
            "port" BIGINT,
            "catalog" VARCHAR
        ),
        "rds_parameters" STRUCT(
            "instance_id" VARCHAR,
            "database" VARCHAR
        ),
        "redshift_parameters" STRUCT(
            "host" VARCHAR,
            "port" BIGINT,
            "database" VARCHAR,
            "cluster_id" VARCHAR,
            "iam_parameters" STRUCT(
                "role_arn" VARCHAR,
                "database_user" VARCHAR,
                "database_groups" VARCHAR[],
                "auto_create_database_user" BOOLEAN
            ),
            "identity_center_configuration" STRUCT(
                "enable_identity_propagation" BOOLEAN
            )
        ),
        "s3_parameters" STRUCT(
            "manifest_file_location" STRUCT(
                "bucket" VARCHAR,
                "key" VARCHAR
            ),
            "role_arn" VARCHAR
        ),
        "service_now_parameters" STRUCT(
            "site_base_url" VARCHAR
        ),
        "snowflake_parameters" STRUCT(
            "host" VARCHAR,
            "database" VARCHAR,
            "warehouse" VARCHAR
        ),
        "spark_parameters" STRUCT(
            "host" VARCHAR,
            "port" BIGINT
        ),
        "sql_server_parameters" STRUCT(
            "host" VARCHAR,
            "port" BIGINT,
            "database" VARCHAR
        ),
        "teradata_parameters" STRUCT(
            "host" VARCHAR,
            "port" BIGINT,
            "database" VARCHAR
        ),
        "twitter_parameters" STRUCT(
            "query" VARCHAR,
            "max_rows" BIGINT
        ),
        "amazon_open_search_parameters" STRUCT(
            "domain" VARCHAR
        ),
        "exasol_parameters" STRUCT(
            "host" VARCHAR,
            "port" BIGINT
        ),
        "databricks_parameters" STRUCT(
            "host" VARCHAR,
            "port" BIGINT,
            "sql_endpoint_path" VARCHAR
        ),
        "starburst_parameters" STRUCT(
            "host" VARCHAR,
            "port" BIGINT,
            "catalog" VARCHAR,
            "product_type" VARCHAR
        ),
        "trino_parameters" STRUCT(
            "host" VARCHAR,
            "port" BIGINT,
            "catalog" VARCHAR
        ),
        "big_query_parameters" STRUCT(
            "project_id" VARCHAR,
            "data_set_region" VARCHAR
        )
    ),
    "alternate_data_source_parameters" STRUCT(
        "amazon_elasticsearch_parameters" STRUCT(
            "domain" VARCHAR
        ),
        "athena_parameters" STRUCT(
            "work_group" VARCHAR,
            "role_arn" VARCHAR
        ),
        "aurora_parameters" STRUCT(
            "host" VARCHAR,
            "port" BIGINT,
            "database" VARCHAR
        ),
        "aurora_postgre_sql_parameters" STRUCT(
            "host" VARCHAR,
            "port" BIGINT,
            "database" VARCHAR
        ),
        "aws_iot_analytics_parameters" STRUCT(
            "data_set_name" VARCHAR
        ),
        "jira_parameters" STRUCT(
            "site_base_url" VARCHAR
        ),
        "maria_db_parameters" STRUCT(
            "host" VARCHAR,
            "port" BIGINT,
            "database" VARCHAR
        ),
        "my_sql_parameters" STRUCT(
            "host" VARCHAR,
            "port" BIGINT,
            "database" VARCHAR
        ),
        "oracle_parameters" STRUCT(
            "host" VARCHAR,
            "port" BIGINT,
            "database" VARCHAR
        ),
        "postgre_sql_parameters" STRUCT(
            "host" VARCHAR,
            "port" BIGINT,
            "database" VARCHAR
        ),
        "presto_parameters" STRUCT(
            "host" VARCHAR,
            "port" BIGINT,
            "catalog" VARCHAR
        ),
        "rds_parameters" STRUCT(
            "instance_id" VARCHAR,
            "database" VARCHAR
        ),
        "redshift_parameters" STRUCT(
            "host" VARCHAR,
            "port" BIGINT,
            "database" VARCHAR,
            "cluster_id" VARCHAR,
            "iam_parameters" STRUCT(
                "role_arn" VARCHAR,
                "database_user" VARCHAR,
                "database_groups" VARCHAR[],
                "auto_create_database_user" BOOLEAN
            ),
            "identity_center_configuration" STRUCT(
                "enable_identity_propagation" BOOLEAN
            )
        ),
        "s3_parameters" STRUCT(
            "manifest_file_location" STRUCT(
                "bucket" VARCHAR,
                "key" VARCHAR
            ),
            "role_arn" VARCHAR
        ),
        "service_now_parameters" STRUCT(
            "site_base_url" VARCHAR
        ),
        "snowflake_parameters" STRUCT(
            "host" VARCHAR,
            "database" VARCHAR,
            "warehouse" VARCHAR
        ),
        "spark_parameters" STRUCT(
            "host" VARCHAR,
            "port" BIGINT
        ),
        "sql_server_parameters" STRUCT(
            "host" VARCHAR,
            "port" BIGINT,
            "database" VARCHAR
        ),
        "teradata_parameters" STRUCT(
            "host" VARCHAR,
            "port" BIGINT,
            "database" VARCHAR
        ),
        "twitter_parameters" STRUCT(
            "query" VARCHAR,
            "max_rows" BIGINT
        ),
        "amazon_open_search_parameters" STRUCT(
            "domain" VARCHAR
        ),
        "exasol_parameters" STRUCT(
            "host" VARCHAR,
            "port" BIGINT
        ),
        "databricks_parameters" STRUCT(
            "host" VARCHAR,
            "port" BIGINT,
            "sql_endpoint_path" VARCHAR
        ),
        "starburst_parameters" STRUCT(
            "host" VARCHAR,
            "port" BIGINT,
            "catalog" VARCHAR,
            "product_type" VARCHAR
        ),
        "trino_parameters" STRUCT(
            "host" VARCHAR,
            "port" BIGINT,
            "catalog" VARCHAR
        ),
        "big_query_parameters" STRUCT(
            "project_id" VARCHAR,
            "data_set_region" VARCHAR
        )
    )[],
    "vpc_connection_properties" STRUCT(
        "vpc_connection_arn" VARCHAR
    ),
    "ssl_properties" STRUCT(
        "disable_ssl" BOOLEAN
    ),
    "error_info" STRUCT(
        "type" VARCHAR,
        "message" VARCHAR
    ),
    "secret_arn" VARCHAR
)
Show child fields
data_source.alternate_data_source_parameters[]
Show child fields
data_source.alternate_data_source_parameters[].amazon_elasticsearch_parameters

The parameters for OpenSearch.

Show child fields
data_source.alternate_data_source_parameters[].amazon_elasticsearch_parameters.domain

The OpenSearch domain.

data_source.alternate_data_source_parameters[].amazon_open_search_parameters

The parameters for OpenSearch.

Show child fields
data_source.alternate_data_source_parameters[].amazon_open_search_parameters.domain

The OpenSearch domain.

data_source.alternate_data_source_parameters[].athena_parameters

The parameters for Amazon Athena.

Show child fields
data_source.alternate_data_source_parameters[].athena_parameters.role_arn

Use the RoleArn structure to override an account-wide role for a specific Athena data source. For example, say an account administrator has turned off all Athena access with an account-wide role. The administrator can then use RoleArn to bypass the account-wide role and allow Athena access for the single Athena data source that is specified in the structure, even if the account-wide role forbidding Athena access is still active.

data_source.alternate_data_source_parameters[].athena_parameters.work_group

The workgroup that Amazon Athena uses.

data_source.alternate_data_source_parameters[].aurora_parameters

The parameters for Amazon Aurora MySQL.

Show child fields
data_source.alternate_data_source_parameters[].aurora_parameters.database

Database.

data_source.alternate_data_source_parameters[].aurora_parameters.host

Host.

data_source.alternate_data_source_parameters[].aurora_parameters.port

Port.

data_source.alternate_data_source_parameters[].aurora_postgre_sql_parameters

The parameters for Amazon Aurora.

Show child fields
data_source.alternate_data_source_parameters[].aurora_postgre_sql_parameters.database

The Amazon Aurora PostgreSQL database to connect to.

data_source.alternate_data_source_parameters[].aurora_postgre_sql_parameters.host

The Amazon Aurora PostgreSQL-Compatible host to connect to.

data_source.alternate_data_source_parameters[].aurora_postgre_sql_parameters.port

The port that Amazon Aurora PostgreSQL is listening on.

data_source.alternate_data_source_parameters[].aws_iot_analytics_parameters

The parameters for IoT Analytics.

Show child fields
data_source.alternate_data_source_parameters[].aws_iot_analytics_parameters.data_set_name

Dataset name.

data_source.alternate_data_source_parameters[].big_query_parameters

The parameters that are required to connect to a Google BigQuery data source.

Show child fields
data_source.alternate_data_source_parameters[].big_query_parameters.data_set_region

The storage location where you create a Google BigQuery data source.

data_source.alternate_data_source_parameters[].big_query_parameters.project_id

The Google Cloud Platform project ID where your datasource was created.

data_source.alternate_data_source_parameters[].databricks_parameters

The parameters that are required to connect to a Databricks data source.

Show child fields
data_source.alternate_data_source_parameters[].databricks_parameters.host

The host name of the Databricks data source.

data_source.alternate_data_source_parameters[].databricks_parameters.port

The port for the Databricks data source.

data_source.alternate_data_source_parameters[].databricks_parameters.sql_endpoint_path

The HTTP path of the Databricks data source.

data_source.alternate_data_source_parameters[].exasol_parameters

The parameters for Exasol.

Show child fields
data_source.alternate_data_source_parameters[].exasol_parameters.host

The hostname or IP address of the Exasol data source.

data_source.alternate_data_source_parameters[].exasol_parameters.port

The port for the Exasol data source.

data_source.alternate_data_source_parameters[].jira_parameters

The parameters for Jira.

Show child fields
data_source.alternate_data_source_parameters[].jira_parameters.site_base_url

The base URL of the Jira site.

data_source.alternate_data_source_parameters[].maria_db_parameters

The parameters for MariaDB.

Show child fields
data_source.alternate_data_source_parameters[].maria_db_parameters.database

Database.

data_source.alternate_data_source_parameters[].maria_db_parameters.host

Host.

data_source.alternate_data_source_parameters[].maria_db_parameters.port

Port.

data_source.alternate_data_source_parameters[].my_sql_parameters

The parameters for MySQL.

Show child fields
data_source.alternate_data_source_parameters[].my_sql_parameters.database

Database.

data_source.alternate_data_source_parameters[].my_sql_parameters.host

Host.

data_source.alternate_data_source_parameters[].my_sql_parameters.port

Port.

data_source.alternate_data_source_parameters[].oracle_parameters

The parameters for Oracle.

Show child fields
data_source.alternate_data_source_parameters[].oracle_parameters.database

The database.

data_source.alternate_data_source_parameters[].oracle_parameters.host

An Oracle host.

data_source.alternate_data_source_parameters[].oracle_parameters.port

The port.

data_source.alternate_data_source_parameters[].postgre_sql_parameters

The parameters for PostgreSQL.

Show child fields
data_source.alternate_data_source_parameters[].postgre_sql_parameters.database

Database.

data_source.alternate_data_source_parameters[].postgre_sql_parameters.host

Host.

data_source.alternate_data_source_parameters[].postgre_sql_parameters.port

Port.

data_source.alternate_data_source_parameters[].presto_parameters

The parameters for Presto.

Show child fields
data_source.alternate_data_source_parameters[].presto_parameters.catalog

Catalog.

data_source.alternate_data_source_parameters[].presto_parameters.host

Host.

data_source.alternate_data_source_parameters[].presto_parameters.port

Port.

data_source.alternate_data_source_parameters[].rds_parameters

The parameters for Amazon RDS.

Show child fields
data_source.alternate_data_source_parameters[].rds_parameters.database

Database.

data_source.alternate_data_source_parameters[].rds_parameters.instance_id

Instance ID.

data_source.alternate_data_source_parameters[].redshift_parameters

The parameters for Amazon Redshift.

Show child fields
data_source.alternate_data_source_parameters[].redshift_parameters.cluster_id

Cluster ID. This field can be blank if the Host and Port are provided.

data_source.alternate_data_source_parameters[].redshift_parameters.database

Database.

data_source.alternate_data_source_parameters[].redshift_parameters.host

Host. This field can be blank if ClusterId is provided.

data_source.alternate_data_source_parameters[].redshift_parameters.iam_parameters

An optional parameter that uses IAM authentication to grant Amazon QuickSight access to your cluster. This parameter can be used instead of DataSourceCredentials.

Show child fields
data_source.alternate_data_source_parameters[].redshift_parameters.iam_parameters.auto_create_database_user

Automatically creates a database user. If your database doesn't have a DatabaseUser, set this parameter to True. If there is no DatabaseUser, Amazon QuickSight can't connect to your cluster. The RoleArn that you use for this operation must grant access to redshift:CreateClusterUser to successfully create the user.

data_source.alternate_data_source_parameters[].redshift_parameters.iam_parameters.database_groups[]
data_source.alternate_data_source_parameters[].redshift_parameters.iam_parameters.database_user

The user whose permissions and group memberships will be used by Amazon QuickSight to access the cluster. If this user already exists in your database, Amazon QuickSight is granted the same permissions that the user has. If the user doesn't exist, set the value of AutoCreateDatabaseUser to True to create a new user with PUBLIC permissions.

data_source.alternate_data_source_parameters[].redshift_parameters.iam_parameters.role_arn

Use the RoleArn structure to allow Amazon QuickSight to call redshift:GetClusterCredentials on your cluster. The calling principal must have iam:PassRole access to pass the role to Amazon QuickSight. The role's trust policy must allow the Amazon QuickSight service principal to assume the role.

data_source.alternate_data_source_parameters[].redshift_parameters.identity_center_configuration

An optional parameter that configures IAM Identity Center authentication to grant Amazon QuickSight access to your cluster.

This parameter can only be specified if your Amazon QuickSight account is configured with IAM Identity Center.

Show child fields
data_source.alternate_data_source_parameters[].redshift_parameters.identity_center_configuration.enable_identity_propagation

A Boolean option that controls whether Trusted Identity Propagation should be used.

data_source.alternate_data_source_parameters[].redshift_parameters.port

Port. This field can be blank if the ClusterId is provided.

data_source.alternate_data_source_parameters[].s3_parameters

The parameters for S3.

Show child fields
data_source.alternate_data_source_parameters[].s3_parameters.manifest_file_location

Location of the Amazon S3 manifest file. This is NULL if the manifest file was uploaded into Amazon QuickSight.

Show child fields
data_source.alternate_data_source_parameters[].s3_parameters.manifest_file_location.bucket

Amazon S3 bucket.

data_source.alternate_data_source_parameters[].s3_parameters.manifest_file_location.key

Amazon S3 key that identifies an object.

data_source.alternate_data_source_parameters[].s3_parameters.role_arn

Use the RoleArn structure to override an account-wide role for a specific S3 data source. For example, say an account administrator has turned off all S3 access with an account-wide role. The administrator can then use RoleArn to bypass the account-wide role and allow S3 access for the single S3 data source that is specified in the structure, even if the account-wide role forbidding S3 access is still active.

data_source.alternate_data_source_parameters[].service_now_parameters

The parameters for ServiceNow.

Show child fields
data_source.alternate_data_source_parameters[].service_now_parameters.site_base_url

URL of the base site.

data_source.alternate_data_source_parameters[].snowflake_parameters

The parameters for Snowflake.

Show child fields
data_source.alternate_data_source_parameters[].snowflake_parameters.database

Database.

data_source.alternate_data_source_parameters[].snowflake_parameters.host

Host.

data_source.alternate_data_source_parameters[].snowflake_parameters.warehouse

Warehouse.

data_source.alternate_data_source_parameters[].spark_parameters

The parameters for Spark.

Show child fields
data_source.alternate_data_source_parameters[].spark_parameters.host

Host.

data_source.alternate_data_source_parameters[].spark_parameters.port

Port.

data_source.alternate_data_source_parameters[].sql_server_parameters

The parameters for SQL Server.

Show child fields
data_source.alternate_data_source_parameters[].sql_server_parameters.database

Database.

data_source.alternate_data_source_parameters[].sql_server_parameters.host

Host.

data_source.alternate_data_source_parameters[].sql_server_parameters.port

Port.

data_source.alternate_data_source_parameters[].starburst_parameters

The parameters that are required to connect to a Starburst data source.

Show child fields
data_source.alternate_data_source_parameters[].starburst_parameters.catalog

The catalog name for the Starburst data source.

data_source.alternate_data_source_parameters[].starburst_parameters.host

The host name of the Starburst data source.

data_source.alternate_data_source_parameters[].starburst_parameters.port

The port for the Starburst data source.

data_source.alternate_data_source_parameters[].starburst_parameters.product_type

The product type for the Starburst data source.

data_source.alternate_data_source_parameters[].teradata_parameters

The parameters for Teradata.

Show child fields
data_source.alternate_data_source_parameters[].teradata_parameters.database

Database.

data_source.alternate_data_source_parameters[].teradata_parameters.host

Host.

data_source.alternate_data_source_parameters[].teradata_parameters.port

Port.

data_source.alternate_data_source_parameters[].trino_parameters

The parameters that are required to connect to a Trino data source.

Show child fields
data_source.alternate_data_source_parameters[].trino_parameters.catalog

The catalog name for the Trino data source.

data_source.alternate_data_source_parameters[].trino_parameters.host

The host name of the Trino data source.

data_source.alternate_data_source_parameters[].trino_parameters.port

The port for the Trino data source.

data_source.alternate_data_source_parameters[].twitter_parameters

The parameters for Twitter.

Show child fields
data_source.alternate_data_source_parameters[].twitter_parameters.max_rows

Maximum number of rows to query Twitter.

data_source.alternate_data_source_parameters[].twitter_parameters.query

Twitter query string.

data_source.arn

The Amazon Resource Name (ARN) of the data source.

data_source.created_time

The time that this data source was created.

data_source.data_source_id

The ID of the data source. This ID is unique per Amazon Web Services Region for each Amazon Web Services account.

data_source.data_source_parameters

The parameters that Amazon QuickSight uses to connect to your underlying source. This is a variant type structure. For this structure to be valid, only one of the attributes can be non-null.

Show child fields
data_source.data_source_parameters.amazon_elasticsearch_parameters

The parameters for OpenSearch.

Show child fields
data_source.data_source_parameters.amazon_elasticsearch_parameters.domain

The OpenSearch domain.

data_source.data_source_parameters.amazon_open_search_parameters

The parameters for OpenSearch.

Show child fields
data_source.data_source_parameters.amazon_open_search_parameters.domain

The OpenSearch domain.

data_source.data_source_parameters.athena_parameters

The parameters for Amazon Athena.

Show child fields
data_source.data_source_parameters.athena_parameters.role_arn

Use the RoleArn structure to override an account-wide role for a specific Athena data source. For example, say an account administrator has turned off all Athena access with an account-wide role. The administrator can then use RoleArn to bypass the account-wide role and allow Athena access for the single Athena data source that is specified in the structure, even if the account-wide role forbidding Athena access is still active.

data_source.data_source_parameters.athena_parameters.work_group

The workgroup that Amazon Athena uses.

data_source.data_source_parameters.aurora_parameters

The parameters for Amazon Aurora MySQL.

Show child fields
data_source.data_source_parameters.aurora_parameters.database

Database.

data_source.data_source_parameters.aurora_parameters.host

Host.

data_source.data_source_parameters.aurora_parameters.port

Port.

data_source.data_source_parameters.aurora_postgre_sql_parameters

The parameters for Amazon Aurora.

Show child fields
data_source.data_source_parameters.aurora_postgre_sql_parameters.database

The Amazon Aurora PostgreSQL database to connect to.

data_source.data_source_parameters.aurora_postgre_sql_parameters.host

The Amazon Aurora PostgreSQL-Compatible host to connect to.

data_source.data_source_parameters.aurora_postgre_sql_parameters.port

The port that Amazon Aurora PostgreSQL is listening on.

data_source.data_source_parameters.aws_iot_analytics_parameters

The parameters for IoT Analytics.

Show child fields
data_source.data_source_parameters.aws_iot_analytics_parameters.data_set_name

Dataset name.

data_source.data_source_parameters.big_query_parameters

The parameters that are required to connect to a Google BigQuery data source.

Show child fields
data_source.data_source_parameters.big_query_parameters.data_set_region

The storage location where you create a Google BigQuery data source.

data_source.data_source_parameters.big_query_parameters.project_id

The Google Cloud Platform project ID where your datasource was created.

data_source.data_source_parameters.databricks_parameters

The parameters that are required to connect to a Databricks data source.

Show child fields
data_source.data_source_parameters.databricks_parameters.host

The host name of the Databricks data source.

data_source.data_source_parameters.databricks_parameters.port

The port for the Databricks data source.

data_source.data_source_parameters.databricks_parameters.sql_endpoint_path

The HTTP path of the Databricks data source.

data_source.data_source_parameters.exasol_parameters

The parameters for Exasol.

Show child fields
data_source.data_source_parameters.exasol_parameters.host

The hostname or IP address of the Exasol data source.

data_source.data_source_parameters.exasol_parameters.port

The port for the Exasol data source.

data_source.data_source_parameters.jira_parameters

The parameters for Jira.

Show child fields
data_source.data_source_parameters.jira_parameters.site_base_url

The base URL of the Jira site.

data_source.data_source_parameters.maria_db_parameters

The parameters for MariaDB.

Show child fields
data_source.data_source_parameters.maria_db_parameters.database

Database.

data_source.data_source_parameters.maria_db_parameters.host

Host.

data_source.data_source_parameters.maria_db_parameters.port

Port.

data_source.data_source_parameters.my_sql_parameters

The parameters for MySQL.

Show child fields
data_source.data_source_parameters.my_sql_parameters.database

Database.

data_source.data_source_parameters.my_sql_parameters.host

Host.

data_source.data_source_parameters.my_sql_parameters.port

Port.

data_source.data_source_parameters.oracle_parameters

The parameters for Oracle.

Show child fields
data_source.data_source_parameters.oracle_parameters.database

The database.

data_source.data_source_parameters.oracle_parameters.host

An Oracle host.

data_source.data_source_parameters.oracle_parameters.port

The port.

data_source.data_source_parameters.postgre_sql_parameters

The parameters for PostgreSQL.

Show child fields
data_source.data_source_parameters.postgre_sql_parameters.database

Database.

data_source.data_source_parameters.postgre_sql_parameters.host

Host.

data_source.data_source_parameters.postgre_sql_parameters.port

Port.

data_source.data_source_parameters.presto_parameters

The parameters for Presto.

Show child fields
data_source.data_source_parameters.presto_parameters.catalog

Catalog.

data_source.data_source_parameters.presto_parameters.host

Host.

data_source.data_source_parameters.presto_parameters.port

Port.

data_source.data_source_parameters.rds_parameters

The parameters for Amazon RDS.

Show child fields
data_source.data_source_parameters.rds_parameters.database

Database.

data_source.data_source_parameters.rds_parameters.instance_id

Instance ID.

data_source.data_source_parameters.redshift_parameters

The parameters for Amazon Redshift.

Show child fields
data_source.data_source_parameters.redshift_parameters.cluster_id

Cluster ID. This field can be blank if the Host and Port are provided.

data_source.data_source_parameters.redshift_parameters.database

Database.

data_source.data_source_parameters.redshift_parameters.host

Host. This field can be blank if ClusterId is provided.

data_source.data_source_parameters.redshift_parameters.iam_parameters

An optional parameter that uses IAM authentication to grant Amazon QuickSight access to your cluster. This parameter can be used instead of DataSourceCredentials.

Show child fields
data_source.data_source_parameters.redshift_parameters.iam_parameters.auto_create_database_user

Automatically creates a database user. If your database doesn't have a DatabaseUser, set this parameter to True. If there is no DatabaseUser, Amazon QuickSight can't connect to your cluster. The RoleArn that you use for this operation must grant access to redshift:CreateClusterUser to successfully create the user.

data_source.data_source_parameters.redshift_parameters.iam_parameters.database_groups[]
data_source.data_source_parameters.redshift_parameters.iam_parameters.database_user

The user whose permissions and group memberships will be used by Amazon QuickSight to access the cluster. If this user already exists in your database, Amazon QuickSight is granted the same permissions that the user has. If the user doesn't exist, set the value of AutoCreateDatabaseUser to True to create a new user with PUBLIC permissions.

data_source.data_source_parameters.redshift_parameters.iam_parameters.role_arn

Use the RoleArn structure to allow Amazon QuickSight to call redshift:GetClusterCredentials on your cluster. The calling principal must have iam:PassRole access to pass the role to Amazon QuickSight. The role's trust policy must allow the Amazon QuickSight service principal to assume the role.

data_source.data_source_parameters.redshift_parameters.identity_center_configuration

An optional parameter that configures IAM Identity Center authentication to grant Amazon QuickSight access to your cluster.

This parameter can only be specified if your Amazon QuickSight account is configured with IAM Identity Center.

Show child fields
data_source.data_source_parameters.redshift_parameters.identity_center_configuration.enable_identity_propagation

A Boolean option that controls whether Trusted Identity Propagation should be used.

data_source.data_source_parameters.redshift_parameters.port

Port. This field can be blank if the ClusterId is provided.

data_source.data_source_parameters.s3_parameters

The parameters for S3.

Show child fields
data_source.data_source_parameters.s3_parameters.manifest_file_location

Location of the Amazon S3 manifest file. This is NULL if the manifest file was uploaded into Amazon QuickSight.

Show child fields
data_source.data_source_parameters.s3_parameters.manifest_file_location.bucket

Amazon S3 bucket.

data_source.data_source_parameters.s3_parameters.manifest_file_location.key

Amazon S3 key that identifies an object.

data_source.data_source_parameters.s3_parameters.role_arn

Use the RoleArn structure to override an account-wide role for a specific S3 data source. For example, say an account administrator has turned off all S3 access with an account-wide role. The administrator can then use RoleArn to bypass the account-wide role and allow S3 access for the single S3 data source that is specified in the structure, even if the account-wide role forbidding S3 access is still active.

data_source.data_source_parameters.service_now_parameters

The parameters for ServiceNow.

Show child fields
data_source.data_source_parameters.service_now_parameters.site_base_url

URL of the base site.

data_source.data_source_parameters.snowflake_parameters

The parameters for Snowflake.

Show child fields
data_source.data_source_parameters.snowflake_parameters.database

Database.

data_source.data_source_parameters.snowflake_parameters.host

Host.

data_source.data_source_parameters.snowflake_parameters.warehouse

Warehouse.

data_source.data_source_parameters.spark_parameters

The parameters for Spark.

Show child fields
data_source.data_source_parameters.spark_parameters.host

Host.

data_source.data_source_parameters.spark_parameters.port

Port.

data_source.data_source_parameters.sql_server_parameters

The parameters for SQL Server.

Show child fields
data_source.data_source_parameters.sql_server_parameters.database

Database.

data_source.data_source_parameters.sql_server_parameters.host

Host.

data_source.data_source_parameters.sql_server_parameters.port

Port.

data_source.data_source_parameters.starburst_parameters

The parameters that are required to connect to a Starburst data source.

Show child fields
data_source.data_source_parameters.starburst_parameters.catalog

The catalog name for the Starburst data source.

data_source.data_source_parameters.starburst_parameters.host

The host name of the Starburst data source.

data_source.data_source_parameters.starburst_parameters.port

The port for the Starburst data source.

data_source.data_source_parameters.starburst_parameters.product_type

The product type for the Starburst data source.

data_source.data_source_parameters.teradata_parameters

The parameters for Teradata.

Show child fields
data_source.data_source_parameters.teradata_parameters.database

Database.

data_source.data_source_parameters.teradata_parameters.host

Host.

data_source.data_source_parameters.teradata_parameters.port

Port.

data_source.data_source_parameters.trino_parameters

The parameters that are required to connect to a Trino data source.

Show child fields
data_source.data_source_parameters.trino_parameters.catalog

The catalog name for the Trino data source.

data_source.data_source_parameters.trino_parameters.host

The host name of the Trino data source.

data_source.data_source_parameters.trino_parameters.port

The port for the Trino data source.

data_source.data_source_parameters.twitter_parameters

The parameters for Twitter.

Show child fields
data_source.data_source_parameters.twitter_parameters.max_rows

Maximum number of rows to query Twitter.

data_source.data_source_parameters.twitter_parameters.query

Twitter query string.

data_source.error_info

Error information from the last update or the creation of the data source.

Show child fields
data_source.error_info.message

Error message.

data_source.error_info.type

Error type.

data_source.last_updated_time

The last time that this data source was updated.

data_source.name

A display name for the data source.

data_source.secret_arn

The Amazon Resource Name (ARN) of the secret associated with the data source in Amazon Secrets Manager.

data_source.ssl_properties

Secure Socket Layer (SSL) properties that apply when Amazon QuickSight connects to your underlying source.

Show child fields
data_source.ssl_properties.disable_ssl

A Boolean option to control whether SSL should be disabled.

data_source.status

The HTTP status of the request.

data_source.type

The type of the data source. This type indicates which database engine the data source connects to.

data_source.vpc_connection_properties

The VPC connection information. You need to use this parameter only when you want Amazon QuickSight to use a VPC connection when connecting to your underlying source.

Show child fields
data_source.vpc_connection_properties.vpc_connection_arn

The Amazon Resource Name (ARN) for the VPC connection.

request_id

The Amazon Web Services request ID for this operation.

VARCHAR
status

The HTTP status of the request.

BIGINT