QuickSight / Client / describe_data_source

describe_data_source

QuickSight.Client.describe_data_source(**kwargs)

Describes a data source.

See also: AWS API Documentation

Request Syntax

response = client.describe_data_source(
    AwsAccountId='string',
    DataSourceId='string'
)

Parameters:

• AwsAccountId (string) –

  [REQUIRED]

  The Amazon Web Services account ID.

• DataSourceId (string) –

  [REQUIRED]

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

Return type:

dict

Returns:

Response Syntax

{
    'DataSource': {
        'Arn': 'string',
        'DataSourceId': 'string',
        'Name': 'string',
        'Type': 'ADOBE_ANALYTICS'|'AMAZON_ELASTICSEARCH'|'ATHENA'|'AURORA'|'AURORA_POSTGRESQL'|'AWS_IOT_ANALYTICS'|'GITHUB'|'JIRA'|'MARIADB'|'MYSQL'|'ORACLE'|'POSTGRESQL'|'PRESTO'|'REDSHIFT'|'S3'|'SALESFORCE'|'SERVICENOW'|'SNOWFLAKE'|'SPARK'|'SQLSERVER'|'TERADATA'|'TWITTER'|'TIMESTREAM'|'AMAZON_OPENSEARCH'|'EXASOL'|'DATABRICKS',
        'Status': 'CREATION_IN_PROGRESS'|'CREATION_SUCCESSFUL'|'CREATION_FAILED'|'UPDATE_IN_PROGRESS'|'UPDATE_SUCCESSFUL'|'UPDATE_FAILED'|'DELETED',
        'CreatedTime': datetime(2015, 1, 1),
        'LastUpdatedTime': datetime(2015, 1, 1),
        'DataSourceParameters': {
            'AmazonElasticsearchParameters': {
                'Domain': 'string'
            },
            'AthenaParameters': {
                'WorkGroup': 'string',
                'RoleArn': 'string'
            },
            'AuroraParameters': {
                'Host': 'string',
                'Port': 123,
                'Database': 'string'
            },
            'AuroraPostgreSqlParameters': {
                'Host': 'string',
                'Port': 123,
                'Database': 'string'
            },
            'AwsIotAnalyticsParameters': {
                'DataSetName': 'string'
            },
            'JiraParameters': {
                'SiteBaseUrl': 'string'
            },
            'MariaDbParameters': {
                'Host': 'string',
                'Port': 123,
                'Database': 'string'
            },
            'MySqlParameters': {
                'Host': 'string',
                'Port': 123,
                'Database': 'string'
            },
            'OracleParameters': {
                'Host': 'string',
                'Port': 123,
                'Database': 'string'
            },
            'PostgreSqlParameters': {
                'Host': 'string',
                'Port': 123,
                'Database': 'string'
            },
            'PrestoParameters': {
                'Host': 'string',
                'Port': 123,
                'Catalog': 'string'
            },
            'RdsParameters': {
                'InstanceId': 'string',
                'Database': 'string'
            },
            'RedshiftParameters': {
                'Host': 'string',
                'Port': 123,
                'Database': 'string',
                'ClusterId': 'string'
            },
            'S3Parameters': {
                'ManifestFileLocation': {
                    'Bucket': 'string',
                    'Key': 'string'
                },
                'RoleArn': 'string'
            },
            'ServiceNowParameters': {
                'SiteBaseUrl': 'string'
            },
            'SnowflakeParameters': {
                'Host': 'string',
                'Database': 'string',
                'Warehouse': 'string'
            },
            'SparkParameters': {
                'Host': 'string',
                'Port': 123
            },
            'SqlServerParameters': {
                'Host': 'string',
                'Port': 123,
                'Database': 'string'
            },
            'TeradataParameters': {
                'Host': 'string',
                'Port': 123,
                'Database': 'string'
            },
            'TwitterParameters': {
                'Query': 'string',
                'MaxRows': 123
            },
            'AmazonOpenSearchParameters': {
                'Domain': 'string'
            },
            'ExasolParameters': {
                'Host': 'string',
                'Port': 123
            },
            'DatabricksParameters': {
                'Host': 'string',
                'Port': 123,
                'SqlEndpointPath': 'string'
            }
        },
        'AlternateDataSourceParameters': [
            {
                'AmazonElasticsearchParameters': {
                    'Domain': 'string'
                },
                'AthenaParameters': {
                    'WorkGroup': 'string',
                    'RoleArn': 'string'
                },
                'AuroraParameters': {
                    'Host': 'string',
                    'Port': 123,
                    'Database': 'string'
                },
                'AuroraPostgreSqlParameters': {
                    'Host': 'string',
                    'Port': 123,
                    'Database': 'string'
                },
                'AwsIotAnalyticsParameters': {
                    'DataSetName': 'string'
                },
                'JiraParameters': {
                    'SiteBaseUrl': 'string'
                },
                'MariaDbParameters': {
                    'Host': 'string',
                    'Port': 123,
                    'Database': 'string'
                },
                'MySqlParameters': {
                    'Host': 'string',
                    'Port': 123,
                    'Database': 'string'
                },
                'OracleParameters': {
                    'Host': 'string',
                    'Port': 123,
                    'Database': 'string'
                },
                'PostgreSqlParameters': {
                    'Host': 'string',
                    'Port': 123,
                    'Database': 'string'
                },
                'PrestoParameters': {
                    'Host': 'string',
                    'Port': 123,
                    'Catalog': 'string'
                },
                'RdsParameters': {
                    'InstanceId': 'string',
                    'Database': 'string'
                },
                'RedshiftParameters': {
                    'Host': 'string',
                    'Port': 123,
                    'Database': 'string',
                    'ClusterId': 'string'
                },
                'S3Parameters': {
                    'ManifestFileLocation': {
                        'Bucket': 'string',
                        'Key': 'string'
                    },
                    'RoleArn': 'string'
                },
                'ServiceNowParameters': {
                    'SiteBaseUrl': 'string'
                },
                'SnowflakeParameters': {
                    'Host': 'string',
                    'Database': 'string',
                    'Warehouse': 'string'
                },
                'SparkParameters': {
                    'Host': 'string',
                    'Port': 123
                },
                'SqlServerParameters': {
                    'Host': 'string',
                    'Port': 123,
                    'Database': 'string'
                },
                'TeradataParameters': {
                    'Host': 'string',
                    'Port': 123,
                    'Database': 'string'
                },
                'TwitterParameters': {
                    'Query': 'string',
                    'MaxRows': 123
                },
                'AmazonOpenSearchParameters': {
                    'Domain': 'string'
                },
                'ExasolParameters': {
                    'Host': 'string',
                    'Port': 123
                },
                'DatabricksParameters': {
                    'Host': 'string',
                    'Port': 123,
                    'SqlEndpointPath': 'string'
                }
            },
        ],
        'VpcConnectionProperties': {
            'VpcConnectionArn': 'string'
        },
        'SslProperties': {
            'DisableSsl': True|False
        },
        'ErrorInfo': {
            'Type': 'ACCESS_DENIED'|'COPY_SOURCE_NOT_FOUND'|'TIMEOUT'|'ENGINE_VERSION_NOT_SUPPORTED'|'UNKNOWN_HOST'|'GENERIC_SQL_FAILURE'|'CONFLICT'|'UNKNOWN',
            'Message': 'string'
        },
        'SecretArn': 'string'
    },
    'RequestId': 'string',
    'Status': 123
}

Response Structure

• (dict) –

  • DataSource (dict) –

    The information on the data source.

    • Arn (string) –

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

    • DataSourceId (string) –

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

    • Name (string) –

      A display name for the data source.

    • Type (string) –

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

    • Status (string) –

      The HTTP status of the request.

    • CreatedTime (datetime) –

      The time that this data source was created.

    • LastUpdatedTime (datetime) –

      The last time that this data source was updated.

    • DataSourceParameters (dict) –

      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.

      • AmazonElasticsearchParameters (dict) –

        The parameters for OpenSearch.

        • Domain (string) –

          The OpenSearch domain.

      • AthenaParameters (dict) –

        The parameters for Amazon Athena.

        • WorkGroup (string) –

          The workgroup that Amazon Athena uses.

        • RoleArn (string) –

          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.

      • AuroraParameters (dict) –

        The parameters for Amazon Aurora MySQL.

        • Host (string) –

          Host.

        • Port (integer) –

          Port.

        • Database (string) –

          Database.

      • AuroraPostgreSqlParameters (dict) –

        The parameters for Amazon Aurora.

        • Host (string) –

          The Amazon Aurora PostgreSQL-Compatible host to connect to.

        • Port (integer) –

          The port that Amazon Aurora PostgreSQL is listening on.

        • Database (string) –

          The Amazon Aurora PostgreSQL database to connect to.

      • AwsIotAnalyticsParameters (dict) –

        The parameters for IoT Analytics.

        • DataSetName (string) –

          Dataset name.

      • JiraParameters (dict) –

        The parameters for Jira.

        • SiteBaseUrl (string) –

          The base URL of the Jira site.

      • MariaDbParameters (dict) –

        The parameters for MariaDB.

        • Host (string) –

          Host.

        • Port (integer) –

          Port.

        • Database (string) –

          Database.

      • MySqlParameters (dict) –

        The parameters for MySQL.

        • Host (string) –

          Host.

        • Port (integer) –

          Port.

        • Database (string) –

          Database.

      • OracleParameters (dict) –

        The parameters for Oracle.

        • Host (string) –

          An Oracle host.

        • Port (integer) –

          Port.

        • Database (string) –

          Database.

      • PostgreSqlParameters (dict) –

        The parameters for PostgreSQL.

        • Host (string) –

          Host.

        • Port (integer) –

          Port.

        • Database (string) –

          Database.

      • PrestoParameters (dict) –

        The parameters for Presto.

        • Host (string) –

          Host.

        • Port (integer) –

          Port.

        • Catalog (string) –

          Catalog.

      • RdsParameters (dict) –

        The parameters for Amazon RDS.

        • InstanceId (string) –

          Instance ID.

        • Database (string) –

          Database.

      • RedshiftParameters (dict) –

        The parameters for Amazon Redshift.

        • Host (string) –

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

        • Port (integer) –

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

        • Database (string) –

          Database.

        • ClusterId (string) –

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

      • S3Parameters (dict) –

        The parameters for S3.

        • ManifestFileLocation (dict) –

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

          • Bucket (string) –

            Amazon S3 bucket.

          • Key (string) –

            Amazon S3 key that identifies an object.

        • RoleArn (string) –

          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.

      • ServiceNowParameters (dict) –

        The parameters for ServiceNow.

        • SiteBaseUrl (string) –

          URL of the base site.

      • SnowflakeParameters (dict) –

        The parameters for Snowflake.

        • Host (string) –

          Host.

        • Database (string) –

          Database.

        • Warehouse (string) –

          Warehouse.

      • SparkParameters (dict) –

        The parameters for Spark.

        • Host (string) –

          Host.

        • Port (integer) –

          Port.

      • SqlServerParameters (dict) –

        The parameters for SQL Server.

        • Host (string) –

          Host.

        • Port (integer) –

          Port.

        • Database (string) –

          Database.

      • TeradataParameters (dict) –

        The parameters for Teradata.

        • Host (string) –

          Host.

        • Port (integer) –

          Port.

        • Database (string) –

          Database.

      • TwitterParameters (dict) –

        The parameters for Twitter.

        • Query (string) –

          Twitter query string.

        • MaxRows (integer) –

          Maximum number of rows to query Twitter.

      • AmazonOpenSearchParameters (dict) –

        The parameters for OpenSearch.

        • Domain (string) –

          The OpenSearch domain.

      • ExasolParameters (dict) –

        The parameters for Exasol.

        • Host (string) –

          The hostname or IP address of the Exasol data source.

        • Port (integer) –

          The port for the Exasol data source.

      • DatabricksParameters (dict) –

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

        • Host (string) –

          The host name of the Databricks data source.

        • Port (integer) –

          The port for the Databricks data source.

        • SqlEndpointPath (string) –

          The HTTP path of the Databricks data source.

    • AlternateDataSourceParameters (list) –

      A set of alternate data source parameters that you want to share for the credentials stored with this data source. The credentials are applied in tandem with the data source parameters when you copy a data source by using a create or update request. The API operation compares the DataSourceParameters structure that’s in the request with the structures in the AlternateDataSourceParameters allow list. If the structures are an exact match, the request is allowed to use the credentials from this existing data source. If the AlternateDataSourceParameters list is null, the Credentials originally used with this DataSourceParameters are automatically allowed.

      • (dict) –

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

        • AmazonElasticsearchParameters (dict) –

          The parameters for OpenSearch.

          • Domain (string) –

            The OpenSearch domain.

        • AthenaParameters (dict) –

          The parameters for Amazon Athena.

          • WorkGroup (string) –

            The workgroup that Amazon Athena uses.

          • RoleArn (string) –

            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.

        • AuroraParameters (dict) –

          The parameters for Amazon Aurora MySQL.

          • Host (string) –

            Host.

          • Port (integer) –

            Port.

          • Database (string) –

            Database.

        • AuroraPostgreSqlParameters (dict) –

          The parameters for Amazon Aurora.

          • Host (string) –

            The Amazon Aurora PostgreSQL-Compatible host to connect to.

          • Port (integer) –

            The port that Amazon Aurora PostgreSQL is listening on.

          • Database (string) –

            The Amazon Aurora PostgreSQL database to connect to.

        • AwsIotAnalyticsParameters (dict) –

          The parameters for IoT Analytics.

          • DataSetName (string) –

            Dataset name.

        • JiraParameters (dict) –

          The parameters for Jira.

          • SiteBaseUrl (string) –

            The base URL of the Jira site.

        • MariaDbParameters (dict) –

          The parameters for MariaDB.

          • Host (string) –

            Host.

          • Port (integer) –

            Port.

          • Database (string) –

            Database.

        • MySqlParameters (dict) –

          The parameters for MySQL.

          • Host (string) –

            Host.

          • Port (integer) –

            Port.

          • Database (string) –

            Database.

        • OracleParameters (dict) –

          The parameters for Oracle.

          • Host (string) –

            An Oracle host.

          • Port (integer) –

            Port.

          • Database (string) –

            Database.

        • PostgreSqlParameters (dict) –

          The parameters for PostgreSQL.

          • Host (string) –

            Host.

          • Port (integer) –

            Port.

          • Database (string) –

            Database.

        • PrestoParameters (dict) –

          The parameters for Presto.

          • Host (string) –

            Host.

          • Port (integer) –

            Port.

          • Catalog (string) –

            Catalog.

        • RdsParameters (dict) –

          The parameters for Amazon RDS.

          • InstanceId (string) –

            Instance ID.

          • Database (string) –

            Database.

        • RedshiftParameters (dict) –

          The parameters for Amazon Redshift.

          • Host (string) –

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

          • Port (integer) –

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

          • Database (string) –

            Database.

          • ClusterId (string) –

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

        • S3Parameters (dict) –

          The parameters for S3.

          • ManifestFileLocation (dict) –

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

            • Bucket (string) –

              Amazon S3 bucket.

            • Key (string) –

              Amazon S3 key that identifies an object.

          • RoleArn (string) –

            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.

        • ServiceNowParameters (dict) –

          The parameters for ServiceNow.

          • SiteBaseUrl (string) –

            URL of the base site.

        • SnowflakeParameters (dict) –

          The parameters for Snowflake.

          • Host (string) –

            Host.

          • Database (string) –

            Database.

          • Warehouse (string) –

            Warehouse.

        • SparkParameters (dict) –

          The parameters for Spark.

          • Host (string) –

            Host.

          • Port (integer) –

            Port.

        • SqlServerParameters (dict) –

          The parameters for SQL Server.

          • Host (string) –

            Host.

          • Port (integer) –

            Port.

          • Database (string) –

            Database.

        • TeradataParameters (dict) –

          The parameters for Teradata.

          • Host (string) –

            Host.

          • Port (integer) –

            Port.

          • Database (string) –

            Database.

        • TwitterParameters (dict) –

          The parameters for Twitter.

          • Query (string) –

            Twitter query string.

          • MaxRows (integer) –

            Maximum number of rows to query Twitter.

        • AmazonOpenSearchParameters (dict) –

          The parameters for OpenSearch.

          • Domain (string) –

            The OpenSearch domain.

        • ExasolParameters (dict) –

          The parameters for Exasol.

          • Host (string) –

            The hostname or IP address of the Exasol data source.

          • Port (integer) –

            The port for the Exasol data source.

        • DatabricksParameters (dict) –

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

          • Host (string) –

            The host name of the Databricks data source.

          • Port (integer) –

            The port for the Databricks data source.

          • SqlEndpointPath (string) –

            The HTTP path of the Databricks data source.

    • VpcConnectionProperties (dict) –

      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.

      • VpcConnectionArn (string) –

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

    • SslProperties (dict) –

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

      • DisableSsl (boolean) –

        A Boolean option to control whether SSL should be disabled.

    • ErrorInfo (dict) –

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

      • Type (string) –

        Error type.

      • Message (string) –

        Error message.

    • SecretArn (string) –

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

  • RequestId (string) –

    The Amazon Web Services request ID for this operation.

  • Status (integer) –

    The HTTP status of the request.

Exceptions

• QuickSight.Client.exceptions.AccessDeniedException

• QuickSight.Client.exceptions.InvalidParameterValueException

• QuickSight.Client.exceptions.ThrottlingException

• QuickSight.Client.exceptions.ResourceNotFoundException

• QuickSight.Client.exceptions.InternalFailureException