2022/11/18 - Amazon QuickSight - 3 new 10 updated api methods
Changes This release adds the following: 1) Asset management for centralized assets governance 2) QuickSight Q now supports public embedding 3) New Termination protection flag to mitigate accidental deletes 4) Athena data sources now accept a custom IAM role 5) QuickSight supports connectivity to Databricks
Use the DeleteAccountSubscription operation to delete an Amazon QuickSight account. This operation will result in an error message if you have configured your account termination protection settings to True . To change this setting and delete your account, call the UpdateAccountSettings API and set the value of the TerminationProtectionEnabled parameter to False , then make another call to the DeleteAccountSubscription API.
See also: AWS API Documentation
Request Syntax
client.delete_account_subscription(
AwsAccountId='string'
)
string
[REQUIRED]
The Amazon Web Services account ID of the account that you want to delete.
dict
Response Syntax
{
'RequestId': 'string',
'Status': 123
}
Response Structure
(dict) --
RequestId (string) --
The Amazon Web Services request ID for this operation.
Status (integer) --
The HTTP status of the request.
Use the SearchDataSources operation to search for data sources that belong to an account.
See also: AWS API Documentation
Request Syntax
client.search_data_sources(
AwsAccountId='string',
Filters=[
{
'Operator': 'StringEquals'|'StringLike',
'Name': 'DIRECT_QUICKSIGHT_VIEWER_OR_OWNER'|'DIRECT_QUICKSIGHT_OWNER'|'DIRECT_QUICKSIGHT_SOLE_OWNER'|'DATASOURCE_NAME',
'Value': 'string'
},
],
NextToken='string',
MaxResults=123
)
string
[REQUIRED]
The Amazon Web Services account ID.
list
[REQUIRED]
The filters to apply to the search.
(dict) --
A filter that you apply when searching for data sources.
Operator (string) -- [REQUIRED]
The comparison operator that you want to use as a filter, for example "Operator": "StringEquals" . Valid values are "StringEquals" and "StringLike" .
If you set the operator value to "StringEquals" , you need to provide an ownership related filter in the "NAME" field and the arn of the user or group whose data sources you want to search in the "Value" field. For example, "Name":"DIRECT_QUICKSIGHT_OWNER", "Operator": "StringEquals", "Value": "arn:aws:quicksight:us-east-1:1:user/default/UserName1" .
If you set the value to "StringLike" , you need to provide the name of the data sources you are searching for. For example, "Name":"DATASOURCE_NAME", "Operator": "StringLike", "Value": "Test" . The "StringLike" operator only supports the NAME value DATASOURCE_NAME .
Name (string) -- [REQUIRED]
The name of the value that you want to use as a filter, for example, "Name": "DIRECT_QUICKSIGHT_OWNER" .
Valid values are defined as follows:
DIRECT_QUICKSIGHT_VIEWER_OR_OWNER : Provide an ARN of a user or group, and any data sources with that ARN listed as one of the owners or viewers of the data sources are returned. Implicit permissions from folders or groups are not considered.
DIRECT_QUICKSIGHT_OWNER : Provide an ARN of a user or group, and any data sources with that ARN listed as one of the owners if the data source are returned. Implicit permissions from folders or groups are not considered.
DIRECT_QUICKSIGHT_SOLE_OWNER : Provide an ARN of a user or group, and any data sources with that ARN listed as the only owner of the data source are returned. Implicit permissions from folders or groups are not considered.
DATASOURCE_NAME : Any data sources whose names have a substring match to the provided value are returned.
Value (string) -- [REQUIRED]
The value of the named item, for example DIRECT_QUICKSIGHT_OWNER , that you want to use as a filter, for example, "Value": "arn:aws:quicksight:us-east-1:1:user/default/UserName1" .
string
A pagination token that can be used in a subsequent request.
integer
The maximum number of results to be returned per request.
dict
Response Syntax
{
'DataSourceSummaries': [
{
'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',
'CreatedTime': datetime(2015, 1, 1),
'LastUpdatedTime': datetime(2015, 1, 1)
},
],
'NextToken': 'string',
'Status': 123,
'RequestId': 'string'
}
Response Structure
(dict) --
DataSourceSummaries (list) --
A DataSourceSummaries object that returns a summary of a data source.
(dict) --
A DataSourceSummary object that returns a summary of a data source.
Arn (string) --
The arn of the datasource.
DataSourceId (string) --
The unique ID of the data source.
Name (string) --
The name of the data source.
Type (string) --
The type of the data source.
CreatedTime (datetime) --
The date and time that the data source was created. This value is expressed in MM-DD-YYYY HH:MM:SS format.
LastUpdatedTime (datetime) --
The date and time the data source was last updated. This value is expressed in MM-DD-YYYY HH:MM:SS format.
NextToken (string) --
A pagination token that can be used in a subsequent request.
Status (integer) --
The HTTP status of the request.
RequestId (string) --
The Amazon Web Services request ID for this operation.
Use the SearchDataSets operation to search for datasets that belong to an account.
See also: AWS API Documentation
Request Syntax
client.search_data_sets(
AwsAccountId='string',
Filters=[
{
'Operator': 'StringEquals'|'StringLike',
'Name': 'QUICKSIGHT_VIEWER_OR_OWNER'|'QUICKSIGHT_OWNER'|'DIRECT_QUICKSIGHT_VIEWER_OR_OWNER'|'DIRECT_QUICKSIGHT_OWNER'|'DIRECT_QUICKSIGHT_SOLE_OWNER'|'DATASET_NAME',
'Value': 'string'
},
],
NextToken='string',
MaxResults=123
)
string
[REQUIRED]
The Amazon Web Services account ID.
list
[REQUIRED]
The filters to apply to the search.
(dict) --
A filter that you apply when searching for datasets.
Operator (string) -- [REQUIRED]
The comparison operator that you want to use as a filter, for example "Operator": "StringEquals" . Valid values are "StringEquals" and "StringLike" .
If you set the operator value to "StringEquals" , you need to provide an ownership related filter in the "NAME" field and the arn of the user or group whose datasets you want to search in the "Value" field. For example, "Name":"QUICKSIGHT_OWNER", "Operator": "StringEquals", "Value": "arn:aws:quicksight:us-east- 1:1:user/default/UserName1" .
If you set the value to "StringLike" , you need to provide the name of the datasets you are searching for. For example, "Name":"DATASET_NAME", "Operator": "StringLike", "Value": "Test" . The "StringLike" operator only supports the NAME value DATASET_NAME .
Name (string) -- [REQUIRED]
The name of the value that you want to use as a filter, for example, "Name": "QUICKSIGHT_OWNER" .
Valid values are defined as follows:
QUICKSIGHT_VIEWER_OR_OWNER : Provide an ARN of a user or group, and any datasets with that ARN listed as one of the dataset owners or viewers are returned. Implicit permissions from folders or groups are considered.
QUICKSIGHT_OWNER : Provide an ARN of a user or group, and any datasets with that ARN listed as one of the owners of the dataset are returned. Implicit permissions from folders or groups are considered.
DIRECT_QUICKSIGHT_SOLE_OWNER : Provide an ARN of a user or group, and any datasets with that ARN listed as the only owner of the dataset are returned. Implicit permissions from folders or groups are not considered.
DIRECT_QUICKSIGHT_OWNER : Provide an ARN of a user or group, and any datasets with that ARN listed as one of the owners if the dataset are returned. Implicit permissions from folders or groups are not considered.
DIRECT_QUICKSIGHT_VIEWER_OR_OWNER : Provide an ARN of a user or group, and any datasets with that ARN listed as one of the owners or viewers of the dataset are returned. Implicit permissions from folders or groups are not considered.
DATASET_NAME : Any datasets whose names have a substring match to this value will be returned.
Value (string) -- [REQUIRED]
The value of the named item, in this case QUICKSIGHT_OWNER , that you want to use as a filter, for example, "Value": "arn:aws:quicksight:us-east-1:1:user/default/UserName1" .
string
A pagination token that can be used in a subsequent request.
integer
The maximum number of results to be returned per request.
dict
Response Syntax
{
'DataSetSummaries': [
{
'Arn': 'string',
'DataSetId': 'string',
'Name': 'string',
'CreatedTime': datetime(2015, 1, 1),
'LastUpdatedTime': datetime(2015, 1, 1),
'ImportMode': 'SPICE'|'DIRECT_QUERY',
'RowLevelPermissionDataSet': {
'Namespace': 'string',
'Arn': 'string',
'PermissionPolicy': 'GRANT_ACCESS'|'DENY_ACCESS',
'FormatVersion': 'VERSION_1'|'VERSION_2',
'Status': 'ENABLED'|'DISABLED'
},
'RowLevelPermissionTagConfigurationApplied': True|False,
'ColumnLevelPermissionRulesApplied': True|False
},
],
'NextToken': 'string',
'Status': 123,
'RequestId': 'string'
}
Response Structure
(dict) --
DataSetSummaries (list) --
A DataSetSummaries object that returns a summary of a dataset.
(dict) --
Dataset summary.
Arn (string) --
The Amazon Resource Name (ARN) of the dataset.
DataSetId (string) --
The ID of the dataset.
Name (string) --
A display name for the dataset.
CreatedTime (datetime) --
The time that this dataset was created.
LastUpdatedTime (datetime) --
The last time that this dataset was updated.
ImportMode (string) --
A value that indicates whether you want to import the data into SPICE.
RowLevelPermissionDataSet (dict) --
The row-level security configuration for the dataset.
Namespace (string) --
The namespace associated with the dataset that contains permissions for RLS.
Arn (string) --
The Amazon Resource Name (ARN) of the dataset that contains permissions for RLS.
PermissionPolicy (string) --
The type of permissions to use when interpreting the permissions for RLS. DENY_ACCESS is included for backward compatibility only.
FormatVersion (string) --
The user or group rules associated with the dataset that contains permissions for RLS.
By default, FormatVersion is VERSION_1 . When FormatVersion is VERSION_1 , UserName and GroupName are required. When FormatVersion is VERSION_2 , UserARN and GroupARN are required, and Namespace must not exist.
Status (string) --
The status of the row-level security permission dataset. If enabled, the status is ENABLED . If disabled, the status is DISABLED .
RowLevelPermissionTagConfigurationApplied (boolean) --
Whether or not the row level permission tags are applied.
ColumnLevelPermissionRulesApplied (boolean) --
A value that indicates if the dataset has column level permission configured.
NextToken (string) --
A pagination token that can be used in a subsequent request.
Status (integer) --
The HTTP status of the request.
RequestId (string) --
The Amazon Web Services request ID for this operation.
{'Credentials': {'CredentialPair': {'AlternateDataSourceParameters': {'AthenaParameters': {'RoleArn': 'string'},
'DatabricksParameters': {'Host': 'string',
'Port': 'integer',
'SqlEndpointPath': 'string'}}}},
'DataSourceParameters': {'AthenaParameters': {'RoleArn': 'string'},
'DatabricksParameters': {'Host': 'string',
'Port': 'integer',
'SqlEndpointPath': 'string'}},
'Type': {'DATABRICKS'}}
Creates a data source.
See also: AWS API Documentation
Request Syntax
client.create_data_source(
AwsAccountId='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',
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'
}
},
'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'
}
},
Credentials={
'CredentialPair': {
'Username': 'string',
'Password': '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'
}
},
'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'
}
},
]
},
'CopySourceArn': 'string',
'SecretArn': 'string'
},
Permissions=[
{
'Principal': 'string',
'Actions': [
'string',
]
},
],
VpcConnectionProperties={
'VpcConnectionArn': 'string'
},
SslProperties={
'DisableSsl': True|False
},
Tags=[
{
'Key': 'string',
'Value': 'string'
},
]
)
string
[REQUIRED]
The Amazon Web Services account ID.
string
[REQUIRED]
An ID for the data source. This ID is unique per Amazon Web Services Region for each Amazon Web Services account.
string
[REQUIRED]
A display name for the data source.
string
[REQUIRED]
The type of the data source. To return a list of all data sources, use ListDataSources .
Use AMAZON_ELASTICSEARCH for Amazon OpenSearch Service.
dict
The parameters that Amazon QuickSight uses to connect to your underlying source.
AmazonElasticsearchParameters (dict) --
The parameters for OpenSearch.
Domain (string) -- [REQUIRED]
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) -- [REQUIRED]
Host.
Port (integer) -- [REQUIRED]
Port.
Database (string) -- [REQUIRED]
Database.
AuroraPostgreSqlParameters (dict) --
The parameters for Amazon Aurora.
Host (string) -- [REQUIRED]
The Amazon Aurora PostgreSQL-Compatible host to connect to.
Port (integer) -- [REQUIRED]
The port that Amazon Aurora PostgreSQL is listening on.
Database (string) -- [REQUIRED]
The Amazon Aurora PostgreSQL database to connect to.
AwsIotAnalyticsParameters (dict) --
The parameters for IoT Analytics.
DataSetName (string) -- [REQUIRED]
Dataset name.
JiraParameters (dict) --
The parameters for Jira.
SiteBaseUrl (string) -- [REQUIRED]
The base URL of the Jira site.
MariaDbParameters (dict) --
The parameters for MariaDB.
Host (string) -- [REQUIRED]
Host.
Port (integer) -- [REQUIRED]
Port.
Database (string) -- [REQUIRED]
Database.
MySqlParameters (dict) --
The parameters for MySQL.
Host (string) -- [REQUIRED]
Host.
Port (integer) -- [REQUIRED]
Port.
Database (string) -- [REQUIRED]
Database.
OracleParameters (dict) --
The parameters for Oracle.
Host (string) -- [REQUIRED]
An Oracle host.
Port (integer) -- [REQUIRED]
Port.
Database (string) -- [REQUIRED]
Database.
PostgreSqlParameters (dict) --
The parameters for PostgreSQL.
Host (string) -- [REQUIRED]
Host.
Port (integer) -- [REQUIRED]
Port.
Database (string) -- [REQUIRED]
Database.
PrestoParameters (dict) --
The parameters for Presto.
Host (string) -- [REQUIRED]
Host.
Port (integer) -- [REQUIRED]
Port.
Catalog (string) -- [REQUIRED]
Catalog.
RdsParameters (dict) --
The parameters for Amazon RDS.
InstanceId (string) -- [REQUIRED]
Instance ID.
Database (string) -- [REQUIRED]
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) -- [REQUIRED]
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) -- [REQUIRED]
Location of the Amazon S3 manifest file. This is NULL if the manifest file was uploaded into Amazon QuickSight.
Bucket (string) -- [REQUIRED]
Amazon S3 bucket.
Key (string) -- [REQUIRED]
Amazon S3 key that identifies an object.
ServiceNowParameters (dict) --
The parameters for ServiceNow.
SiteBaseUrl (string) -- [REQUIRED]
URL of the base site.
SnowflakeParameters (dict) --
The parameters for Snowflake.
Host (string) -- [REQUIRED]
Host.
Database (string) -- [REQUIRED]
Database.
Warehouse (string) -- [REQUIRED]
Warehouse.
SparkParameters (dict) --
The parameters for Spark.
Host (string) -- [REQUIRED]
Host.
Port (integer) -- [REQUIRED]
Port.
SqlServerParameters (dict) --
The parameters for SQL Server.
Host (string) -- [REQUIRED]
Host.
Port (integer) -- [REQUIRED]
Port.
Database (string) -- [REQUIRED]
Database.
TeradataParameters (dict) --
The parameters for Teradata.
Host (string) -- [REQUIRED]
Host.
Port (integer) -- [REQUIRED]
Port.
Database (string) -- [REQUIRED]
Database.
TwitterParameters (dict) --
The parameters for Twitter.
Query (string) -- [REQUIRED]
Twitter query string.
MaxRows (integer) -- [REQUIRED]
Maximum number of rows to query Twitter.
AmazonOpenSearchParameters (dict) --
The parameters for OpenSearch.
Domain (string) -- [REQUIRED]
The OpenSearch domain.
ExasolParameters (dict) --
The parameters for Exasol.
Host (string) -- [REQUIRED]
The hostname or IP address of the Exasol data source.
Port (integer) -- [REQUIRED]
The port for the Exasol data source.
DatabricksParameters (dict) --
The required parameters that are needed to connect to a Databricks data source.
Host (string) -- [REQUIRED]
The host name of the Databricks data source.
Port (integer) -- [REQUIRED]
The port for the Databricks data source.
SqlEndpointPath (string) -- [REQUIRED]
The HTTP path of the Databricks data source.
dict
The credentials Amazon QuickSight that uses to connect to your underlying source. Currently, only credentials based on user name and password are supported.
CredentialPair (dict) --
Credential pair. For more information, see `` CredentialPair `` .
Username (string) -- [REQUIRED]
User name.
Password (string) -- [REQUIRED]
Password.
AlternateDataSourceParameters (list) --
A set of alternate data source parameters that you want to share for these credentials. 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 new data source with the existing credentials. If the AlternateDataSourceParameters list is null, the DataSourceParameters originally used with these Credentials is 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) -- [REQUIRED]
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) -- [REQUIRED]
Host.
Port (integer) -- [REQUIRED]
Port.
Database (string) -- [REQUIRED]
Database.
AuroraPostgreSqlParameters (dict) --
The parameters for Amazon Aurora.
Host (string) -- [REQUIRED]
The Amazon Aurora PostgreSQL-Compatible host to connect to.
Port (integer) -- [REQUIRED]
The port that Amazon Aurora PostgreSQL is listening on.
Database (string) -- [REQUIRED]
The Amazon Aurora PostgreSQL database to connect to.
AwsIotAnalyticsParameters (dict) --
The parameters for IoT Analytics.
DataSetName (string) -- [REQUIRED]
Dataset name.
JiraParameters (dict) --
The parameters for Jira.
SiteBaseUrl (string) -- [REQUIRED]
The base URL of the Jira site.
MariaDbParameters (dict) --
The parameters for MariaDB.
Host (string) -- [REQUIRED]
Host.
Port (integer) -- [REQUIRED]
Port.
Database (string) -- [REQUIRED]
Database.
MySqlParameters (dict) --
The parameters for MySQL.
Host (string) -- [REQUIRED]
Host.
Port (integer) -- [REQUIRED]
Port.
Database (string) -- [REQUIRED]
Database.
OracleParameters (dict) --
The parameters for Oracle.
Host (string) -- [REQUIRED]
An Oracle host.
Port (integer) -- [REQUIRED]
Port.
Database (string) -- [REQUIRED]
Database.
PostgreSqlParameters (dict) --
The parameters for PostgreSQL.
Host (string) -- [REQUIRED]
Host.
Port (integer) -- [REQUIRED]
Port.
Database (string) -- [REQUIRED]
Database.
PrestoParameters (dict) --
The parameters for Presto.
Host (string) -- [REQUIRED]
Host.
Port (integer) -- [REQUIRED]
Port.
Catalog (string) -- [REQUIRED]
Catalog.
RdsParameters (dict) --
The parameters for Amazon RDS.
InstanceId (string) -- [REQUIRED]
Instance ID.
Database (string) -- [REQUIRED]
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) -- [REQUIRED]
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) -- [REQUIRED]
Location of the Amazon S3 manifest file. This is NULL if the manifest file was uploaded into Amazon QuickSight.
Bucket (string) -- [REQUIRED]
Amazon S3 bucket.
Key (string) -- [REQUIRED]
Amazon S3 key that identifies an object.
ServiceNowParameters (dict) --
The parameters for ServiceNow.
SiteBaseUrl (string) -- [REQUIRED]
URL of the base site.
SnowflakeParameters (dict) --
The parameters for Snowflake.
Host (string) -- [REQUIRED]
Host.
Database (string) -- [REQUIRED]
Database.
Warehouse (string) -- [REQUIRED]
Warehouse.
SparkParameters (dict) --
The parameters for Spark.
Host (string) -- [REQUIRED]
Host.
Port (integer) -- [REQUIRED]
Port.
SqlServerParameters (dict) --
The parameters for SQL Server.
Host (string) -- [REQUIRED]
Host.
Port (integer) -- [REQUIRED]
Port.
Database (string) -- [REQUIRED]
Database.
TeradataParameters (dict) --
The parameters for Teradata.
Host (string) -- [REQUIRED]
Host.
Port (integer) -- [REQUIRED]
Port.
Database (string) -- [REQUIRED]
Database.
TwitterParameters (dict) --
The parameters for Twitter.
Query (string) -- [REQUIRED]
Twitter query string.
MaxRows (integer) -- [REQUIRED]
Maximum number of rows to query Twitter.
AmazonOpenSearchParameters (dict) --
The parameters for OpenSearch.
Domain (string) -- [REQUIRED]
The OpenSearch domain.
ExasolParameters (dict) --
The parameters for Exasol.
Host (string) -- [REQUIRED]
The hostname or IP address of the Exasol data source.
Port (integer) -- [REQUIRED]
The port for the Exasol data source.
DatabricksParameters (dict) --
The required parameters that are needed to connect to a Databricks data source.
Host (string) -- [REQUIRED]
The host name of the Databricks data source.
Port (integer) -- [REQUIRED]
The port for the Databricks data source.
SqlEndpointPath (string) -- [REQUIRED]
The HTTP path of the Databricks data source.
CopySourceArn (string) --
The Amazon Resource Name (ARN) of a data source that has the credential pair that you want to use. When CopySourceArn is not null, the credential pair from the data source in the ARN is used as the credentials for the DataSourceCredentials structure.
SecretArn (string) --
The Amazon Resource Name (ARN) of the secret associated with the data source in Amazon Secrets Manager.
list
A list of resource permissions on the data source.
(dict) --
Permission for the resource.
Principal (string) -- [REQUIRED]
The Amazon Resource Name (ARN) of the principal. This can be one of the following:
The ARN of an Amazon QuickSight user or group associated with a data source or dataset. (This is common.)
The ARN of an Amazon QuickSight user, group, or namespace associated with an analysis, dashboard, template, or theme. (This is common.)
The ARN of an Amazon Web Services account root: This is an IAM ARN rather than a QuickSight ARN. Use this option only to share resources (templates) across Amazon Web Services accounts. (This is less common.)
Actions (list) -- [REQUIRED]
The IAM action to grant or revoke permissions on.
(string) --
dict
Use this parameter only when you want Amazon QuickSight to use a VPC connection when connecting to your underlying source.
VpcConnectionArn (string) -- [REQUIRED]
The Amazon Resource Name (ARN) for the VPC connection.
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.
list
Contains a map of the key-value pairs for the resource tag or tags assigned to the data source.
(dict) --
The key or keys of the key-value pairs for the resource tag or tags assigned to the resource.
Key (string) -- [REQUIRED]
Tag key.
Value (string) -- [REQUIRED]
Tag value.
dict
Response Syntax
{
'Arn': 'string',
'DataSourceId': 'string',
'CreationStatus': 'CREATION_IN_PROGRESS'|'CREATION_SUCCESSFUL'|'CREATION_FAILED'|'UPDATE_IN_PROGRESS'|'UPDATE_SUCCESSFUL'|'UPDATE_FAILED'|'DELETED',
'RequestId': 'string',
'Status': 123
}
Response Structure
(dict) --
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.
CreationStatus (string) --
The status of creating the data source.
RequestId (string) --
The Amazon Web Services request ID for this operation.
Status (integer) --
The HTTP status of the request.
{'AccountSettings': {'TerminationProtectionEnabled': 'boolean'}}
Describes the settings that were used when your Amazon QuickSight subscription was first created in this Amazon Web Services account.
See also: AWS API Documentation
Request Syntax
client.describe_account_settings(
AwsAccountId='string'
)
string
[REQUIRED]
The ID for the Amazon Web Services account that contains the settings that you want to list.
dict
Response Syntax
{
'AccountSettings': {
'AccountName': 'string',
'Edition': 'STANDARD'|'ENTERPRISE'|'ENTERPRISE_AND_Q',
'DefaultNamespace': 'string',
'NotificationEmail': 'string',
'PublicSharingEnabled': True|False,
'TerminationProtectionEnabled': True|False
},
'RequestId': 'string',
'Status': 123
}
Response Structure
(dict) --
AccountSettings (dict) --
The Amazon QuickSight settings for this Amazon Web Services account. This information includes the edition of Amazon Amazon QuickSight that you subscribed to (Standard or Enterprise) and the notification email for the Amazon QuickSight subscription.
In the QuickSight console, the Amazon QuickSight subscription is sometimes referred to as a QuickSight "account" even though it's technically not an account by itself. Instead, it's a subscription to the Amazon QuickSight service for your Amazon Web Services account. The edition that you subscribe to applies to Amazon QuickSight in every Amazon Web Services Region where you use it.
AccountName (string) --
The "account name" you provided for the Amazon QuickSight subscription in your Amazon Web Services account. You create this name when you sign up for Amazon QuickSight. It is unique in all of Amazon Web Services and it appears only when users sign in.
Edition (string) --
The edition of Amazon QuickSight that you're currently subscribed to: Enterprise edition or Standard edition.
DefaultNamespace (string) --
The default Amazon QuickSight namespace for your Amazon Web Services account.
NotificationEmail (string) --
The main notification email for your Amazon QuickSight subscription.
PublicSharingEnabled (boolean) --
A Boolean value that indicates whether public sharing is turned on for an Amazon QuickSight account. For more information about turning on public sharing, see UpdatePublicSharingSettings .
TerminationProtectionEnabled (boolean) --
A boolean value that determines whether or not an Amazon QuickSight account can be deleted. A True value doesn't allow the account to be deleted and results in an error message if a user tries to make a DeleteAccountSubsctiption request. A False value will allow the ccount to be deleted.
RequestId (string) --
The Amazon Web Services request ID for this operation.
Status (integer) --
The HTTP status of the request.
{'DataSource': {'AlternateDataSourceParameters': {'AthenaParameters': {'RoleArn': 'string'},
'DatabricksParameters': {'Host': 'string',
'Port': 'integer',
'SqlEndpointPath': 'string'}},
'DataSourceParameters': {'AthenaParameters': {'RoleArn': 'string'},
'DatabricksParameters': {'Host': 'string',
'Port': 'integer',
'SqlEndpointPath': 'string'}},
'Type': {'DATABRICKS'}}}
Describes a data source.
See also: AWS API Documentation
Request Syntax
client.describe_data_source(
AwsAccountId='string',
DataSourceId='string'
)
string
[REQUIRED]
The Amazon Web Services account ID.
string
[REQUIRED]
The ID of the data source. This ID is unique per Amazon Web Services Region for each Amazon Web Services account.
dict
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'
}
},
'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'
}
},
'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.
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.
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.
{'ExperienceConfiguration': {'QSearchBar': {'InitialTopicId': 'string'}}}
Response {'AnonymousUserArn': 'string'}
Generates an embed URL that you can use to embed an Amazon QuickSight dashboard or visual in your website, without having to register any reader users. Before you use this action, make sure that you have configured the dashboards and permissions.
The following rules apply to the generated URL:
It contains a temporary bearer token. It is valid for 5 minutes after it is generated. Once redeemed within this period, it cannot be re-used again.
The URL validity period should not be confused with the actual session lifetime that can be customized using the `` SessionLifetimeInMinutes `` parameter. The resulting user session is valid for 15 minutes (minimum) to 10 hours (maximum). The default session duration is 10 hours.
You are charged only when the URL is used or there is interaction with Amazon QuickSight.
For more information, see Embedded Analytics in the Amazon QuickSight User Guide .
For more information about the high-level steps for embedding and for an interactive demo of the ways you can customize embedding, visit the Amazon QuickSight Developer Portal .
See also: AWS API Documentation
Request Syntax
client.generate_embed_url_for_anonymous_user(
AwsAccountId='string',
SessionLifetimeInMinutes=123,
Namespace='string',
SessionTags=[
{
'Key': 'string',
'Value': 'string'
},
],
AuthorizedResourceArns=[
'string',
],
ExperienceConfiguration={
'Dashboard': {
'InitialDashboardId': 'string'
},
'DashboardVisual': {
'InitialDashboardVisualId': {
'DashboardId': 'string',
'SheetId': 'string',
'VisualId': 'string'
}
},
'QSearchBar': {
'InitialTopicId': 'string'
}
},
AllowedDomains=[
'string',
]
)
string
[REQUIRED]
The ID for the Amazon Web Services account that contains the dashboard that you're embedding.
integer
How many minutes the session is valid. The session lifetime must be in [15-600] minutes range.
string
[REQUIRED]
The Amazon QuickSight namespace that the anonymous user virtually belongs to. If you are not using an Amazon QuickSight custom namespace, set this to default .
list
The session tags used for row-level security. Before you use this parameter, make sure that you have configured the relevant datasets using the DataSet$RowLevelPermissionTagConfiguration parameter so that session tags can be used to provide row-level security.
These are not the tags used for the Amazon Web Services resource tagging feature. For more information, see Using Row-Level Security (RLS) with Tags in the Amazon QuickSight User Guide .
(dict) --
The key-value pair used for the row-level security tags feature.
Key (string) -- [REQUIRED]
The key for the tag.
Value (string) -- [REQUIRED]
The value that you want to assign the tag.
list
[REQUIRED]
The Amazon Resource Names (ARNs) for the Amazon QuickSight resources that the user is authorized to access during the lifetime of the session. If you choose Dashboard embedding experience, pass the list of dashboard ARNs in the account that you want the user to be able to view. Currently, you can pass up to 25 dashboard ARNs in each API call.
(string) --
dict
[REQUIRED]
The configuration of the experience that you are embedding.
Dashboard (dict) --
The type of embedding experience. In this case, Amazon QuickSight dashboards.
InitialDashboardId (string) -- [REQUIRED]
The dashboard ID for the dashboard that you want the user to see first. This ID is included in the output URL. When the URL in response is accessed, Amazon QuickSight renders this dashboard.
The Amazon Resource Name (ARN) of this dashboard must be included in the AuthorizedResourceArns parameter. Otherwise, the request will fail with InvalidParameterValueException .
DashboardVisual (dict) --
The type of embedding experience. In this case, Amazon QuickSight visuals.
InitialDashboardVisualId (dict) -- [REQUIRED]
The visual ID for the visual that you want the user to see. This ID is included in the output URL. When the URL in response is accessed, Amazon QuickSight renders this visual.
The Amazon Resource Name (ARN) of the dashboard that the visual belongs to must be included in the AuthorizedResourceArns parameter. Otherwise, the request will fail with InvalidParameterValueException .
DashboardId (string) -- [REQUIRED]
The ID of the dashboard that has the visual that you want to embed. The DashboardId can be found in the IDs for developers section of the Embed visual pane of the visual's on-visual menu of the Amazon QuickSight console. You can also get the DashboardId with a ListDashboards API operation.
SheetId (string) -- [REQUIRED]
The ID of the sheet that the has visual that you want to embed. The SheetId can be found in the IDs for developers section of the Embed visual pane of the visual's on-visual menu of the Amazon QuickSight console.
VisualId (string) -- [REQUIRED]
The ID of the visual that you want to embed. The VisualID can be found in the IDs for developers section of the Embed visual pane of the visual's on-visual menu of the Amazon QuickSight console.
QSearchBar (dict) --
The Q search bar that you want to use for anonymous user embedding.
InitialTopicId (string) -- [REQUIRED]
The QuickSight Q topic ID of the topic that you want the anonymous user to see first. This ID is included in the output URL. When the URL in response is accessed, Amazon QuickSight renders the Q search bar with this topic pre-selected.
The Amazon Resource Name (ARN) of this Q topic must be included in the AuthorizedResourceArns parameter. Otherwise, the request will fail with InvalidParameterValueException .
list
The domains that you want to add to the allow list for access to the generated URL that is then embedded. This optional parameter overrides the static domains that are configured in the Manage QuickSight menu in the Amazon QuickSight console. Instead, it allows only the domains that you include in this parameter. You can list up to three domains or subdomains in each API call.
To include all subdomains under a specific domain to the allow list, use * . For example, https://*.sapp.amazon.com includes all subdomains under https://sapp.amazon.com .
(string) --
dict
Response Syntax
{
'EmbedUrl': 'string',
'Status': 123,
'RequestId': 'string',
'AnonymousUserArn': 'string'
}
Response Structure
(dict) --
EmbedUrl (string) --
The embed URL for the dashboard.
Status (integer) --
The HTTP status of the request.
RequestId (string) --
The Amazon Web Services request ID for this operation.
AnonymousUserArn (string) --
The Amazon Resource Name (ARN) to use for the anonymous Amazon QuickSight user.
{'DataSources': {'AlternateDataSourceParameters': {'AthenaParameters': {'RoleArn': 'string'},
'DatabricksParameters': {'Host': 'string',
'Port': 'integer',
'SqlEndpointPath': 'string'}},
'DataSourceParameters': {'AthenaParameters': {'RoleArn': 'string'},
'DatabricksParameters': {'Host': 'string',
'Port': 'integer',
'SqlEndpointPath': 'string'}},
'Type': {'DATABRICKS'}}}
Lists data sources in current Amazon Web Services Region that belong to this Amazon Web Services account.
See also: AWS API Documentation
Request Syntax
client.list_data_sources(
AwsAccountId='string',
NextToken='string',
MaxResults=123
)
string
[REQUIRED]
The Amazon Web Services account ID.
string
The token for the next set of results, or null if there are no more results.
integer
The maximum number of results to be returned per request.
dict
Response Syntax
{
'DataSources': [
{
'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'
}
},
'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'
}
},
'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'
},
],
'NextToken': 'string',
'RequestId': 'string',
'Status': 123
}
Response Structure
(dict) --
DataSources (list) --
A list of data sources.
(dict) --
The structure of a 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.
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.
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.
NextToken (string) --
The token for the next set of results, or null if there are no more results.
RequestId (string) --
The Amazon Web Services request ID for this operation.
Status (integer) --
The HTTP status of the request.
{'Filters': {'Name': {'ANALYSIS_NAME',
'DIRECT_QUICKSIGHT_OWNER',
'DIRECT_QUICKSIGHT_SOLE_OWNER',
'DIRECT_QUICKSIGHT_VIEWER_OR_OWNER',
'QUICKSIGHT_OWNER',
'QUICKSIGHT_VIEWER_OR_OWNER'},
'Operator': {'StringLike'}}}
Searches for analyses that belong to the user specified in the filter.
Note
This operation is eventually consistent. The results are best effort and may not reflect very recent updates and changes.
See also: AWS API Documentation
Request Syntax
client.search_analyses(
AwsAccountId='string',
Filters=[
{
'Operator': 'StringEquals'|'StringLike',
'Name': 'QUICKSIGHT_USER'|'QUICKSIGHT_VIEWER_OR_OWNER'|'DIRECT_QUICKSIGHT_VIEWER_OR_OWNER'|'QUICKSIGHT_OWNER'|'DIRECT_QUICKSIGHT_OWNER'|'DIRECT_QUICKSIGHT_SOLE_OWNER'|'ANALYSIS_NAME',
'Value': 'string'
},
],
NextToken='string',
MaxResults=123
)
string
[REQUIRED]
The ID of the Amazon Web Services account that contains the analyses that you're searching for.
list
[REQUIRED]
The structure for the search filters that you want to apply to your search.
(dict) --
A filter that you apply when searching for one or more analyses.
Operator (string) --
The comparison operator that you want to use as a filter, for example "Operator": "StringEquals" . Valid values are "StringEquals" and "StringLike" .
If you set the operator value to "StringEquals" , you need to provide an ownership related filter in the "NAME" field and the arn of the user or group whose folders you want to search in the "Value" field. For example, "Name":"DIRECT_QUICKSIGHT_OWNER", "Operator": "StringEquals", "Value": "arn:aws:quicksight:us-east-1:1:user/default/UserName1" .
If you set the value to "StringLike" , you need to provide the name of the folders you are searching for. For example, "Name":"ANALYSIS_NAME", "Operator": "StringLike", "Value": "Test" . The "StringLike" operator only supports the NAME value ANALYSIS_NAME .
Name (string) --
The name of the value that you want to use as a filter, for example "Name": "QUICKSIGHT_OWNER" .
Valid values are defined as follows:
QUICKSIGHT_VIEWER_OR_OWNER : Provide an ARN of a user or group, and any analyses with that ARN listed as one of the analysis' owners or viewers are returned. Implicit permissions from folders or groups are considered.
QUICKSIGHT_OWNER : Provide an ARN of a user or group, and any analyses with that ARN listed as one of the owners of the analyses are returned. Implicit permissions from folders or groups are considered.
DIRECT_QUICKSIGHT_SOLE_OWNER : Provide an ARN of a user or group, and any analyses with that ARN listed as the only owner of the analysis are returned. Implicit permissions from folders or groups are not considered.
DIRECT_QUICKSIGHT_OWNER : Provide an ARN of a user or group, and any analyses with that ARN listed as one of the owners of the analyses are returned. Implicit permissions from folders or groups are not considered.
DIRECT_QUICKSIGHT_VIEWER_OR_OWNER : Provide an ARN of a user or group, and any analyses with that ARN listed as one of the owners or viewers of the analyses are returned. Implicit permissions from folders or groups are not considered.
ANALYSIS_NAME : Any analyses whose names have a substring match to this value will be returned.
Value (string) --
The value of the named item, in this case QUICKSIGHT_USER , that you want to use as a filter, for example "Value" . An example is "arn:aws:quicksight:us-east-1:1:user/default/UserName1" .
string
A pagination token that can be used in a subsequent request.
integer
The maximum number of results to return.
dict
Response Syntax
{
'AnalysisSummaryList': [
{
'Arn': 'string',
'AnalysisId': 'string',
'Name': 'string',
'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)
},
],
'NextToken': 'string',
'Status': 123,
'RequestId': 'string'
}
Response Structure
(dict) --
AnalysisSummaryList (list) --
Metadata describing the analyses that you searched for.
(dict) --
The summary metadata that describes an analysis.
Arn (string) --
The Amazon Resource Name (ARN) for the analysis.
AnalysisId (string) --
The ID of the analysis. This ID displays in the URL.
Name (string) --
The name of the analysis. This name is displayed in the Amazon QuickSight console.
Status (string) --
The last known status for the analysis.
CreatedTime (datetime) --
The time that the analysis was created.
LastUpdatedTime (datetime) --
The time that the analysis was last updated.
NextToken (string) --
A pagination token that can be used in a subsequent request.
Status (integer) --
The HTTP status of the request.
RequestId (string) --
The Amazon Web Services request ID for this operation.
{'Filters': {'Name': {'DASHBOARD_NAME',
'DIRECT_QUICKSIGHT_OWNER',
'DIRECT_QUICKSIGHT_SOLE_OWNER',
'DIRECT_QUICKSIGHT_VIEWER_OR_OWNER',
'QUICKSIGHT_OWNER',
'QUICKSIGHT_VIEWER_OR_OWNER'},
'Operator': {'StringLike'}}}
Searches for dashboards that belong to a user.
Note
This operation is eventually consistent. The results are best effort and may not reflect very recent updates and changes.
See also: AWS API Documentation
Request Syntax
client.search_dashboards(
AwsAccountId='string',
Filters=[
{
'Operator': 'StringEquals'|'StringLike',
'Name': 'QUICKSIGHT_USER'|'QUICKSIGHT_VIEWER_OR_OWNER'|'DIRECT_QUICKSIGHT_VIEWER_OR_OWNER'|'QUICKSIGHT_OWNER'|'DIRECT_QUICKSIGHT_OWNER'|'DIRECT_QUICKSIGHT_SOLE_OWNER'|'DASHBOARD_NAME',
'Value': 'string'
},
],
NextToken='string',
MaxResults=123
)
string
[REQUIRED]
The ID of the Amazon Web Services account that contains the user whose dashboards you're searching for.
list
[REQUIRED]
The filters to apply to the search. Currently, you can search only by user name, for example, "Filters": [ { "Name": "QUICKSIGHT_USER", "Operator": "StringEquals", "Value": "arn:aws:quicksight:us-east-1:1:user/default/UserName1" } ]
(dict) --
A filter that you apply when searching for dashboards.
Operator (string) -- [REQUIRED]
The comparison operator that you want to use as a filter, for example "Operator": "StringEquals" . Valid values are "StringEquals" and "StringLike" .
If you set the operator value to "StringEquals" , you need to provide an ownership related filter in the "NAME" field and the arn of the user or group whose folders you want to search in the "Value" field. For example, "Name":"DIRECT_QUICKSIGHT_OWNER", "Operator": "StringEquals", "Value": "arn:aws:quicksight:us-east-1:1:user/default/UserName1" .
If you set the value to "StringLike" , you need to provide the name of the folders you are searching for. For example, "Name":"DASHBOARD_NAME", "Operator": "StringLike", "Value": "Test" . The "StringLike" operator only supports the NAME value DASHBOARD_NAME .
Name (string) --
The name of the value that you want to use as a filter, for example, "Name": "QUICKSIGHT_OWNER" .
Valid values are defined as follows:
QUICKSIGHT_VIEWER_OR_OWNER : Provide an ARN of a user or group, and any dashboards with that ARN listed as one of the dashboards's owners or viewers are returned. Implicit permissions from folders or groups are considered.
QUICKSIGHT_OWNER : Provide an ARN of a user or group, and any dashboards with that ARN listed as one of the owners of the dashboards are returned. Implicit permissions from folders or groups are considered.
DIRECT_QUICKSIGHT_SOLE_OWNER : Provide an ARN of a user or group, and any dashboards with that ARN listed as the only owner of the dashboard are returned. Implicit permissions from folders or groups are not considered.
DIRECT_QUICKSIGHT_OWNER : Provide an ARN of a user or group, and any dashboards with that ARN listed as one of the owners of the dashboards are returned. Implicit permissions from folders or groups are not considered.
DIRECT_QUICKSIGHT_VIEWER_OR_OWNER : Provide an ARN of a user or group, and any dashboards with that ARN listed as one of the owners or viewers of the dashboards are returned. Implicit permissions from folders or groups are not considered.
DASHBOARD_NAME : Any dashboards whose names have a substring match to this value will be returned.
Value (string) --
The value of the named item, in this case QUICKSIGHT_USER , that you want to use as a filter, for example, "Value": "arn:aws:quicksight:us-east-1:1:user/default/UserName1" .
string
The token for the next set of results, or null if there are no more results.
integer
The maximum number of results to be returned per request.
dict
Response Syntax
{
'DashboardSummaryList': [
{
'Arn': 'string',
'DashboardId': 'string',
'Name': 'string',
'CreatedTime': datetime(2015, 1, 1),
'LastUpdatedTime': datetime(2015, 1, 1),
'PublishedVersionNumber': 123,
'LastPublishedTime': datetime(2015, 1, 1)
},
],
'NextToken': 'string',
'Status': 123,
'RequestId': 'string'
}
Response Structure
(dict) --
DashboardSummaryList (list) --
The list of dashboards owned by the user specified in Filters in your request.
(dict) --
Dashboard summary.
Arn (string) --
The Amazon Resource Name (ARN) of the resource.
DashboardId (string) --
Dashboard ID.
Name (string) --
A display name for the dashboard.
CreatedTime (datetime) --
The time that this dashboard was created.
LastUpdatedTime (datetime) --
The last time that this dashboard was updated.
PublishedVersionNumber (integer) --
Published version number.
LastPublishedTime (datetime) --
The last time that this dashboard was published.
NextToken (string) --
The token for the next set of results, or null if there are no more results.
Status (integer) --
The HTTP status of the request.
RequestId (string) --
The Amazon Web Services request ID for this operation.
{'Filters': {'Name': {'DIRECT_QUICKSIGHT_OWNER',
'DIRECT_QUICKSIGHT_SOLE_OWNER',
'DIRECT_QUICKSIGHT_VIEWER_OR_OWNER',
'FOLDER_NAME',
'QUICKSIGHT_OWNER',
'QUICKSIGHT_VIEWER_OR_OWNER'},
'Operator': {'StringLike'}}}
Searches the subfolders in a folder.
See also: AWS API Documentation
Request Syntax
client.search_folders(
AwsAccountId='string',
Filters=[
{
'Operator': 'StringEquals'|'StringLike',
'Name': 'PARENT_FOLDER_ARN'|'DIRECT_QUICKSIGHT_OWNER'|'DIRECT_QUICKSIGHT_SOLE_OWNER'|'DIRECT_QUICKSIGHT_VIEWER_OR_OWNER'|'QUICKSIGHT_OWNER'|'QUICKSIGHT_VIEWER_OR_OWNER'|'FOLDER_NAME',
'Value': 'string'
},
],
NextToken='string',
MaxResults=123
)
string
[REQUIRED]
The ID for the Amazon Web Services account that contains the folder.
list
[REQUIRED]
The filters to apply to the search. Currently, you can search only by the parent folder ARN. For example, "Filters": [ { "Name": "PARENT_FOLDER_ARN", "Operator": "StringEquals", "Value": "arn:aws:quicksight:us-east-1:1:folder/folderId" } ] .
(dict) --
A filter to use to search an Amazon QuickSight folder.
Operator (string) --
The comparison operator that you want to use as a filter, for example "Operator": "StringEquals" . Valid values are "StringEquals" and "StringLike" .
If you set the operator value to "StringEquals" , you need to provide an ownership related filter in the "NAME" field and the arn of the user or group whose folders you want to search in the "Value" field. For example, "Name":"DIRECT_QUICKSIGHT_OWNER", "Operator": "StringEquals", "Value": "arn:aws:quicksight:us-east-1:1:user/default/UserName1" .
If you set the value to "StringLike" , you need to provide the name of the folders you are searching for. For example, "Name":"FOLDER_NAME", "Operator": "StringLike", "Value": "Test" . The "StringLike" operator only supports the NAME value FOLDER_NAME .
Name (string) --
The name of a value that you want to use in the filter. For example, "Name": "QUICKSIGHT_OWNER" .
Valid values are defined as follows:
QUICKSIGHT_VIEWER_OR_OWNER : Provide an ARN of a user or group, and any folders with that ARN listed as one of the folder's owners or viewers are returned. Implicit permissions from folders or groups are considered.
QUICKSIGHT_OWNER : Provide an ARN of a user or group, and any folders with that ARN listed as one of the owners of the folders are returned. Implicit permissions from folders or groups are considered.
DIRECT_QUICKSIGHT_SOLE_OWNER : Provide an ARN of a user or group, and any folders with that ARN listed as the only owner of the folder are returned. Implicit permissions from folders or groups are not considered.
DIRECT_QUICKSIGHT_OWNER : Provide an ARN of a user or group, and any folders with that ARN listed as one of the owners of the folders are returned. Implicit permissions from folders or groups are not considered.
DIRECT_QUICKSIGHT_VIEWER_OR_OWNER : Provide an ARN of a user or group, and any folders with that ARN listed as one of the owners or viewers of the folders are returned. Implicit permissions from folders or groups are not considered.
FOLDER_NAME : Any folders whose names have a substring match to this value will be returned.
PARENT_FOLDER_ARN : Provide an ARN of a folder, and any folders that are directly under that parent folder are returned. If you choose to use this option and leave the value blank, all root-level folders in the account are returned.
Value (string) --
The value of the named item (in this example, PARENT_FOLDER_ARN ), that you want to use as a filter. For example, "Value": "arn:aws:quicksight:us-east-1:1:folder/folderId" .
string
The token for the next set of results, or null if there are no more results.
integer
The maximum number of results to be returned per request.
dict
Response Syntax
{
'Status': 123,
'FolderSummaryList': [
{
'Arn': 'string',
'FolderId': 'string',
'Name': 'string',
'FolderType': 'SHARED',
'CreatedTime': datetime(2015, 1, 1),
'LastUpdatedTime': datetime(2015, 1, 1)
},
],
'NextToken': 'string',
'RequestId': 'string'
}
Response Structure
(dict) --
Status (integer) --
The HTTP status of the request.
FolderSummaryList (list) --
A structure that contains all of the folders in the Amazon Web Services account. This structure provides basic information about the folders.
(dict) --
A summary of information about an existing Amazon QuickSight folder.
Arn (string) --
The Amazon Resource Name (ARN) of the folder.
FolderId (string) --
The ID of the folder.
Name (string) --
The display name of the folder.
FolderType (string) --
The type of folder.
CreatedTime (datetime) --
The time that the folder was created.
LastUpdatedTime (datetime) --
The time that the folder was last updated.
NextToken (string) --
The token for the next set of results, or null if there are no more results.
RequestId (string) --
The Amazon Web Services request ID for this operation.
{'TerminationProtectionEnabled': 'boolean'}
Updates the Amazon QuickSight settings in your Amazon Web Services account.
See also: AWS API Documentation
Request Syntax
client.update_account_settings(
AwsAccountId='string',
DefaultNamespace='string',
NotificationEmail='string',
TerminationProtectionEnabled=True|False
)
string
[REQUIRED]
The ID for the Amazon Web Services account that contains the Amazon QuickSight settings that you want to list.
string
[REQUIRED]
The default namespace for this Amazon Web Services account. Currently, the default is default . Identity and Access Management (IAM) users that register for the first time with Amazon QuickSight provide an email address that becomes associated with the default namespace.
string
The email address that you want Amazon QuickSight to send notifications to regarding your Amazon Web Services account or Amazon QuickSight subscription.
boolean
A boolean value that determines whether or not an Amazon QuickSight account can be deleted. A True value doesn't allow the account to be deleted and results in an error message if a user tries to make a DeleteAccountSubscription request. A False value will allow the account to be deleted.
dict
Response Syntax
{
'RequestId': 'string',
'Status': 123
}
Response Structure
(dict) --
RequestId (string) --
The Amazon Web Services request ID for this operation.
Status (integer) --
The HTTP status of the request.
{'Credentials': {'CredentialPair': {'AlternateDataSourceParameters': {'AthenaParameters': {'RoleArn': 'string'},
'DatabricksParameters': {'Host': 'string',
'Port': 'integer',
'SqlEndpointPath': 'string'}}}},
'DataSourceParameters': {'AthenaParameters': {'RoleArn': 'string'},
'DatabricksParameters': {'Host': 'string',
'Port': 'integer',
'SqlEndpointPath': 'string'}}}
Updates a data source.
See also: AWS API Documentation
Request Syntax
client.update_data_source(
AwsAccountId='string',
DataSourceId='string',
Name='string',
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'
}
},
'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'
}
},
Credentials={
'CredentialPair': {
'Username': 'string',
'Password': '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'
}
},
'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'
}
},
]
},
'CopySourceArn': 'string',
'SecretArn': 'string'
},
VpcConnectionProperties={
'VpcConnectionArn': 'string'
},
SslProperties={
'DisableSsl': True|False
}
)
string
[REQUIRED]
The Amazon Web Services account ID.
string
[REQUIRED]
The ID of the data source. This ID is unique per Amazon Web Services Region for each Amazon Web Services account.
string
[REQUIRED]
A display name for the data source.
dict
The parameters that Amazon QuickSight uses to connect to your underlying source.
AmazonElasticsearchParameters (dict) --
The parameters for OpenSearch.
Domain (string) -- [REQUIRED]
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) -- [REQUIRED]
Host.
Port (integer) -- [REQUIRED]
Port.
Database (string) -- [REQUIRED]
Database.
AuroraPostgreSqlParameters (dict) --
The parameters for Amazon Aurora.
Host (string) -- [REQUIRED]
The Amazon Aurora PostgreSQL-Compatible host to connect to.
Port (integer) -- [REQUIRED]
The port that Amazon Aurora PostgreSQL is listening on.
Database (string) -- [REQUIRED]
The Amazon Aurora PostgreSQL database to connect to.
AwsIotAnalyticsParameters (dict) --
The parameters for IoT Analytics.
DataSetName (string) -- [REQUIRED]
Dataset name.
JiraParameters (dict) --
The parameters for Jira.
SiteBaseUrl (string) -- [REQUIRED]
The base URL of the Jira site.
MariaDbParameters (dict) --
The parameters for MariaDB.
Host (string) -- [REQUIRED]
Host.
Port (integer) -- [REQUIRED]
Port.
Database (string) -- [REQUIRED]
Database.
MySqlParameters (dict) --
The parameters for MySQL.
Host (string) -- [REQUIRED]
Host.
Port (integer) -- [REQUIRED]
Port.
Database (string) -- [REQUIRED]
Database.
OracleParameters (dict) --
The parameters for Oracle.
Host (string) -- [REQUIRED]
An Oracle host.
Port (integer) -- [REQUIRED]
Port.
Database (string) -- [REQUIRED]
Database.
PostgreSqlParameters (dict) --
The parameters for PostgreSQL.
Host (string) -- [REQUIRED]
Host.
Port (integer) -- [REQUIRED]
Port.
Database (string) -- [REQUIRED]
Database.
PrestoParameters (dict) --
The parameters for Presto.
Host (string) -- [REQUIRED]
Host.
Port (integer) -- [REQUIRED]
Port.
Catalog (string) -- [REQUIRED]
Catalog.
RdsParameters (dict) --
The parameters for Amazon RDS.
InstanceId (string) -- [REQUIRED]
Instance ID.
Database (string) -- [REQUIRED]
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) -- [REQUIRED]
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) -- [REQUIRED]
Location of the Amazon S3 manifest file. This is NULL if the manifest file was uploaded into Amazon QuickSight.
Bucket (string) -- [REQUIRED]
Amazon S3 bucket.
Key (string) -- [REQUIRED]
Amazon S3 key that identifies an object.
ServiceNowParameters (dict) --
The parameters for ServiceNow.
SiteBaseUrl (string) -- [REQUIRED]
URL of the base site.
SnowflakeParameters (dict) --
The parameters for Snowflake.
Host (string) -- [REQUIRED]
Host.
Database (string) -- [REQUIRED]
Database.
Warehouse (string) -- [REQUIRED]
Warehouse.
SparkParameters (dict) --
The parameters for Spark.
Host (string) -- [REQUIRED]
Host.
Port (integer) -- [REQUIRED]
Port.
SqlServerParameters (dict) --
The parameters for SQL Server.
Host (string) -- [REQUIRED]
Host.
Port (integer) -- [REQUIRED]
Port.
Database (string) -- [REQUIRED]
Database.
TeradataParameters (dict) --
The parameters for Teradata.
Host (string) -- [REQUIRED]
Host.
Port (integer) -- [REQUIRED]
Port.
Database (string) -- [REQUIRED]
Database.
TwitterParameters (dict) --
The parameters for Twitter.
Query (string) -- [REQUIRED]
Twitter query string.
MaxRows (integer) -- [REQUIRED]
Maximum number of rows to query Twitter.
AmazonOpenSearchParameters (dict) --
The parameters for OpenSearch.
Domain (string) -- [REQUIRED]
The OpenSearch domain.
ExasolParameters (dict) --
The parameters for Exasol.
Host (string) -- [REQUIRED]
The hostname or IP address of the Exasol data source.
Port (integer) -- [REQUIRED]
The port for the Exasol data source.
DatabricksParameters (dict) --
The required parameters that are needed to connect to a Databricks data source.
Host (string) -- [REQUIRED]
The host name of the Databricks data source.
Port (integer) -- [REQUIRED]
The port for the Databricks data source.
SqlEndpointPath (string) -- [REQUIRED]
The HTTP path of the Databricks data source.
dict
The credentials that Amazon QuickSight that uses to connect to your underlying source. Currently, only credentials based on user name and password are supported.
CredentialPair (dict) --
Credential pair. For more information, see `` CredentialPair `` .
Username (string) -- [REQUIRED]
User name.
Password (string) -- [REQUIRED]
Password.
AlternateDataSourceParameters (list) --
A set of alternate data source parameters that you want to share for these credentials. 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 new data source with the existing credentials. If the AlternateDataSourceParameters list is null, the DataSourceParameters originally used with these Credentials is 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) -- [REQUIRED]
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) -- [REQUIRED]
Host.
Port (integer) -- [REQUIRED]
Port.
Database (string) -- [REQUIRED]
Database.
AuroraPostgreSqlParameters (dict) --
The parameters for Amazon Aurora.
Host (string) -- [REQUIRED]
The Amazon Aurora PostgreSQL-Compatible host to connect to.
Port (integer) -- [REQUIRED]
The port that Amazon Aurora PostgreSQL is listening on.
Database (string) -- [REQUIRED]
The Amazon Aurora PostgreSQL database to connect to.
AwsIotAnalyticsParameters (dict) --
The parameters for IoT Analytics.
DataSetName (string) -- [REQUIRED]
Dataset name.
JiraParameters (dict) --
The parameters for Jira.
SiteBaseUrl (string) -- [REQUIRED]
The base URL of the Jira site.
MariaDbParameters (dict) --
The parameters for MariaDB.
Host (string) -- [REQUIRED]
Host.
Port (integer) -- [REQUIRED]
Port.
Database (string) -- [REQUIRED]
Database.
MySqlParameters (dict) --
The parameters for MySQL.
Host (string) -- [REQUIRED]
Host.
Port (integer) -- [REQUIRED]
Port.
Database (string) -- [REQUIRED]
Database.
OracleParameters (dict) --
The parameters for Oracle.
Host (string) -- [REQUIRED]
An Oracle host.
Port (integer) -- [REQUIRED]
Port.
Database (string) -- [REQUIRED]
Database.
PostgreSqlParameters (dict) --
The parameters for PostgreSQL.
Host (string) -- [REQUIRED]
Host.
Port (integer) -- [REQUIRED]
Port.
Database (string) -- [REQUIRED]
Database.
PrestoParameters (dict) --
The parameters for Presto.
Host (string) -- [REQUIRED]
Host.
Port (integer) -- [REQUIRED]
Port.
Catalog (string) -- [REQUIRED]
Catalog.
RdsParameters (dict) --
The parameters for Amazon RDS.
InstanceId (string) -- [REQUIRED]
Instance ID.
Database (string) -- [REQUIRED]
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) -- [REQUIRED]
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) -- [REQUIRED]
Location of the Amazon S3 manifest file. This is NULL if the manifest file was uploaded into Amazon QuickSight.
Bucket (string) -- [REQUIRED]
Amazon S3 bucket.
Key (string) -- [REQUIRED]
Amazon S3 key that identifies an object.
ServiceNowParameters (dict) --
The parameters for ServiceNow.
SiteBaseUrl (string) -- [REQUIRED]
URL of the base site.
SnowflakeParameters (dict) --
The parameters for Snowflake.
Host (string) -- [REQUIRED]
Host.
Database (string) -- [REQUIRED]
Database.
Warehouse (string) -- [REQUIRED]
Warehouse.
SparkParameters (dict) --
The parameters for Spark.
Host (string) -- [REQUIRED]
Host.
Port (integer) -- [REQUIRED]
Port.
SqlServerParameters (dict) --
The parameters for SQL Server.
Host (string) -- [REQUIRED]
Host.
Port (integer) -- [REQUIRED]
Port.
Database (string) -- [REQUIRED]
Database.
TeradataParameters (dict) --
The parameters for Teradata.
Host (string) -- [REQUIRED]
Host.
Port (integer) -- [REQUIRED]
Port.
Database (string) -- [REQUIRED]
Database.
TwitterParameters (dict) --
The parameters for Twitter.
Query (string) -- [REQUIRED]
Twitter query string.
MaxRows (integer) -- [REQUIRED]
Maximum number of rows to query Twitter.
AmazonOpenSearchParameters (dict) --
The parameters for OpenSearch.
Domain (string) -- [REQUIRED]
The OpenSearch domain.
ExasolParameters (dict) --
The parameters for Exasol.
Host (string) -- [REQUIRED]
The hostname or IP address of the Exasol data source.
Port (integer) -- [REQUIRED]
The port for the Exasol data source.
DatabricksParameters (dict) --
The required parameters that are needed to connect to a Databricks data source.
Host (string) -- [REQUIRED]
The host name of the Databricks data source.
Port (integer) -- [REQUIRED]
The port for the Databricks data source.
SqlEndpointPath (string) -- [REQUIRED]
The HTTP path of the Databricks data source.
CopySourceArn (string) --
The Amazon Resource Name (ARN) of a data source that has the credential pair that you want to use. When CopySourceArn is not null, the credential pair from the data source in the ARN is used as the credentials for the DataSourceCredentials structure.
SecretArn (string) --
The Amazon Resource Name (ARN) of the secret associated with the data source in Amazon Secrets Manager.
dict
Use this parameter only when you want Amazon QuickSight to use a VPC connection when connecting to your underlying source.
VpcConnectionArn (string) -- [REQUIRED]
The Amazon Resource Name (ARN) for the VPC connection.
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.
dict
Response Syntax
{
'Arn': 'string',
'DataSourceId': 'string',
'UpdateStatus': 'CREATION_IN_PROGRESS'|'CREATION_SUCCESSFUL'|'CREATION_FAILED'|'UPDATE_IN_PROGRESS'|'UPDATE_SUCCESSFUL'|'UPDATE_FAILED'|'DELETED',
'RequestId': 'string',
'Status': 123
}
Response Structure
(dict) --
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.
UpdateStatus (string) --
The update status of the data source's last update.
RequestId (string) --
The Amazon Web Services request ID for this operation.
Status (integer) --
The HTTP status of the request.