2023/11/16 - Amazon QuickSight - 6 new11 updated api methods
Changes Custom permission support for QuickSight roles; Three new datasources STARBURST, TRINO, BIGQUERY; Lenient mode changes the default behavior to allow for exporting and importing with certain UI allowed errors, Support for permissions and tags export and import.
Lists all groups that are associated with a role.
See also: AWS API Documentation
Request Syntax
client.list_role_memberships(
Role='ADMIN'|'AUTHOR'|'READER',
NextToken='string',
MaxResults=123,
AwsAccountId='string',
Namespace='string'
)
string
[REQUIRED]
The name of the role.
string
A pagination token that can be used in a subsequent request.
integer
The maximum number of results to return.
string
[REQUIRED]
The ID for the Amazon Web Services account that you want to create a group in. The Amazon Web Services account ID that you provide must be the same Amazon Web Services account that contains your Amazon QuickSight account.
string
[REQUIRED]
The namespace that includes the role.
dict
Response Syntax
{
'MembersList': [
'string',
],
'NextToken': 'string',
'RequestId': 'string',
'Status': 123
}
Response Structure
(dict) --
MembersList (list) --
The list of groups associated with a role
(string) --
NextToken (string) --
A pagination token that can be used in a subsequent request.
RequestId (string) --
The Amazon Web Services request ID for this operation.
Status (integer) --
The HTTP status of the request.
Describes all custom permissions that are mapped to a role.
See also: AWS API Documentation
Request Syntax
client.describe_role_custom_permission(
Role='ADMIN'|'AUTHOR'|'READER',
AwsAccountId='string',
Namespace='string'
)
string
[REQUIRED]
The name of the role whose permissions you want described.
string
[REQUIRED]
The ID for the Amazon Web Services account that you want to create a group in. The Amazon Web Services account ID that you provide must be the same Amazon Web Services account that contains your Amazon QuickSight account.
string
[REQUIRED]
The namespace that contains the role.
dict
Response Syntax
{
'CustomPermissionsName': 'string',
'RequestId': 'string',
'Status': 123
}
Response Structure
(dict) --
CustomPermissionsName (string) --
The name of the custom permission that is described.
RequestId (string) --
The Amazon Web Services request ID for this operation.
Status (integer) --
The HTTP status of the request.
Removes custom permissions from the role.
See also: AWS API Documentation
Request Syntax
client.delete_role_custom_permission(
Role='ADMIN'|'AUTHOR'|'READER',
AwsAccountId='string',
Namespace='string'
)
string
[REQUIRED]
The role that you want to remove permissions from.
string
[REQUIRED]
The ID for the Amazon Web Services account that the group is in. Currently, you use the ID for the Amazon Web Services account that contains your Amazon QuickSight account.
string
[REQUIRED]
The namespace that includes the role.
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 CreateRoleMembership to add an existing Amazon QuickSight group to an existing role.
See also: AWS API Documentation
Request Syntax
client.create_role_membership(
MemberName='string',
AwsAccountId='string',
Namespace='string',
Role='ADMIN'|'AUTHOR'|'READER'
)
string
[REQUIRED]
The name of the group that you want to add to the role.
string
[REQUIRED]
The ID for the Amazon Web Services account that you want to create a group in. The Amazon Web Services account ID that you provide must be the same Amazon Web Services account that contains your Amazon QuickSight account.
string
[REQUIRED]
The namespace that the role belongs to.
string
[REQUIRED]
The role that you want to add a group to.
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.
Removes a group from a role.
See also: AWS API Documentation
Request Syntax
client.delete_role_membership(
MemberName='string',
Role='ADMIN'|'AUTHOR'|'READER',
AwsAccountId='string',
Namespace='string'
)
string
[REQUIRED]
The name of the group.
string
[REQUIRED]
The role that you want to remove permissions from.
string
[REQUIRED]
The ID for the Amazon Web Services account that you want to create a group in. The Amazon Web Services account ID that you provide must be the same Amazon Web Services account that contains your Amazon QuickSight account.
string
[REQUIRED]
The namespace that contains the role.
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.
Updates the custom permissions that are associated with a role.
See also: AWS API Documentation
Request Syntax
client.update_role_custom_permission(
CustomPermissionsName='string',
Role='ADMIN'|'AUTHOR'|'READER',
AwsAccountId='string',
Namespace='string'
)
string
[REQUIRED]
The name of the custom permission that you want to update the role with.
string
[REQUIRED]
The name of role tht you want to update.
string
[REQUIRED]
The ID for the Amazon Web Services account that you want to create a group in. The Amazon Web Services account ID that you provide must be the same Amazon Web Services account that contains your Amazon QuickSight account.
string
[REQUIRED]
The namespace that contains the role that you want to update.
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.
{'LinkSharingConfiguration': {'Permissions': [{'Actions': ['string'],
'Principal': 'string'}]}}
Creates a dashboard from either a template or directly with a DashboardDefinition. To first create a template, see the CreateTemplate API operation.
A dashboard is an entity in Amazon QuickSight that identifies Amazon QuickSight reports, created from analyses. You can share Amazon QuickSight dashboards. With the right permissions, you can create scheduled email reports from them. If you have the correct permissions, you can create a dashboard from a template that exists in a different Amazon Web Services account.
See also: AWS API Documentation
Request Syntax
# This section is too large to render. # Please see the AWS API Documentation linked below.Parameters
# This section is too large to render. # Please see the AWS API Documentation linked below.
dict
Response Syntax
{
'Arn': 'string',
'VersionArn': 'string',
'DashboardId': 'string',
'CreationStatus': 'CREATION_IN_PROGRESS'|'CREATION_SUCCESSFUL'|'CREATION_FAILED'|'UPDATE_IN_PROGRESS'|'UPDATE_SUCCESSFUL'|'UPDATE_FAILED'|'DELETED',
'Status': 123,
'RequestId': 'string'
}
Response Structure
(dict) --
Arn (string) --
The ARN of the dashboard.
VersionArn (string) --
The ARN of the dashboard, including the version number of the first version that is created.
DashboardId (string) --
The ID for the dashboard.
CreationStatus (string) --
The status of the dashboard creation request.
Status (integer) --
The HTTP status of the request.
RequestId (string) --
The Amazon Web Services request ID for this operation.
{'Credentials': {'CredentialPair': {'AlternateDataSourceParameters': {'BigQueryParameters': {'DataSetRegion': 'string',
'ProjectId': 'string'}}}},
'DataSourceParameters': {'BigQueryParameters': {'DataSetRegion': 'string',
'ProjectId': 'string'}},
'Type': {'STARBURST', 'BIGQUERY', 'TRINO'}}
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'|'STARBURST'|'TRINO'|'BIGQUERY',
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',
'IAMParameters': {
'RoleArn': 'string',
'DatabaseUser': 'string',
'DatabaseGroups': [
'string',
],
'AutoCreateDatabaseUser': True|False
}
},
'S3Parameters': {
'ManifestFileLocation': {
'Bucket': 'string',
'Key': 'string'
},
'RoleArn': 'string'
},
'ServiceNowParameters': {
'SiteBaseUrl': 'string'
},
'SnowflakeParameters': {
'Host': 'string',
'Database': 'string',
'Warehouse': 'string'
},
'SparkParameters': {
'Host': 'string',
'Port': 123
},
'SqlServerParameters': {
'Host': 'string',
'Port': 123,
'Database': 'string'
},
'TeradataParameters': {
'Host': 'string',
'Port': 123,
'Database': 'string'
},
'TwitterParameters': {
'Query': 'string',
'MaxRows': 123
},
'AmazonOpenSearchParameters': {
'Domain': 'string'
},
'ExasolParameters': {
'Host': 'string',
'Port': 123
},
'DatabricksParameters': {
'Host': 'string',
'Port': 123,
'SqlEndpointPath': 'string'
},
'StarburstParameters': {
'Host': 'string',
'Port': 123,
'Catalog': 'string',
'ProductType': 'GALAXY'|'ENTERPRISE'
},
'TrinoParameters': {
'Host': 'string',
'Port': 123,
'Catalog': 'string'
},
'BigQueryParameters': {
'ProjectId': 'string',
'DataSetRegion': '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',
'IAMParameters': {
'RoleArn': 'string',
'DatabaseUser': 'string',
'DatabaseGroups': [
'string',
],
'AutoCreateDatabaseUser': True|False
}
},
'S3Parameters': {
'ManifestFileLocation': {
'Bucket': 'string',
'Key': 'string'
},
'RoleArn': 'string'
},
'ServiceNowParameters': {
'SiteBaseUrl': 'string'
},
'SnowflakeParameters': {
'Host': 'string',
'Database': 'string',
'Warehouse': 'string'
},
'SparkParameters': {
'Host': 'string',
'Port': 123
},
'SqlServerParameters': {
'Host': 'string',
'Port': 123,
'Database': 'string'
},
'TeradataParameters': {
'Host': 'string',
'Port': 123,
'Database': 'string'
},
'TwitterParameters': {
'Query': 'string',
'MaxRows': 123
},
'AmazonOpenSearchParameters': {
'Domain': 'string'
},
'ExasolParameters': {
'Host': 'string',
'Port': 123
},
'DatabricksParameters': {
'Host': 'string',
'Port': 123,
'SqlEndpointPath': 'string'
},
'StarburstParameters': {
'Host': 'string',
'Port': 123,
'Catalog': 'string',
'ProductType': 'GALAXY'|'ENTERPRISE'
},
'TrinoParameters': {
'Host': 'string',
'Port': 123,
'Catalog': 'string'
},
'BigQueryParameters': {
'ProjectId': 'string',
'DataSetRegion': 'string'
}
},
]
},
'CopySourceArn': 'string',
'SecretArn': 'string'
},
Permissions=[
{
'Principal': 'string',
'Actions': [
'string',
]
},
],
VpcConnectionProperties={
'VpcConnectionArn': 'string'
},
SslProperties={
'DisableSsl': True|False
},
Tags=[
{
'Key': 'string',
'Value': 'string'
},
],
FolderArns=[
'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]
The port.
Database (string) -- [REQUIRED]
The 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.
IAMParameters (dict) --
An optional parameter that uses IAM authentication to grant Amazon QuickSight access to your cluster. This parameter can be used instead of DataSourceCredentials.
RoleArn (string) -- [REQUIRED]
Use the RoleArn structure to allow Amazon QuickSight to call redshift:GetClusterCredentials on your cluster. The calling principal must have iam:PassRole access to pass the role to Amazon QuickSight. The role's trust policy must allow the Amazon QuickSight service principal to assume the role.
DatabaseUser (string) -- [REQUIRED]
The user whose permissions and group memberships will be used by Amazon QuickSight to access the cluster. If this user already exists in your database, Amazon QuickSight is granted the same permissions that the user has. If the user doesn't exist, set the value of AutoCreateDatabaseUser to True to create a new user with PUBLIC permissions.
DatabaseGroups (list) --
A list of groups whose permissions will be granted to Amazon QuickSight to access the cluster. These permissions are combined with the permissions granted to Amazon QuickSight by the DatabaseUser. If you choose to include this parameter, the RoleArn must grant access to redshift:JoinGroup.
(string) --
AutoCreateDatabaseUser (boolean) --
Automatically creates a database user. If your database doesn't have a DatabaseUser, set this parameter to True. If there is no DatabaseUser, Amazon QuickSight can't connect to your cluster. The RoleArn that you use for this operation must grant access to redshift:CreateClusterUser to successfully create the user.
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.
RoleArn (string) --
Use the RoleArn structure to override an account-wide role for a specific S3 data source. For example, say an account administrator has turned off all S3 access with an account-wide role. The administrator can then use RoleArn to bypass the account-wide role and allow S3 access for the single S3 data source that is specified in the structure, even if the account-wide role forbidding S3 access is still active.
ServiceNowParameters (dict) --
The parameters for ServiceNow.
SiteBaseUrl (string) -- [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 parameters that are required 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.
StarburstParameters (dict) --
The parameters that are required to connect to a Starburst data source.
Host (string) -- [REQUIRED]
The host name of the Starburst data source.
Port (integer) -- [REQUIRED]
The port for the Starburst data source.
Catalog (string) -- [REQUIRED]
The catalog name for the Starburst data source.
ProductType (string) --
The product type for the Starburst data source.
TrinoParameters (dict) --
The parameters that are required to connect to a Trino data source.
Host (string) -- [REQUIRED]
The host name of the Trino data source.
Port (integer) -- [REQUIRED]
The port for the Trino data source.
Catalog (string) -- [REQUIRED]
The catalog name for the Trino data source.
BigQueryParameters (dict) --
The parameters that are required to connect to a Google BigQuery data source.
ProjectId (string) -- [REQUIRED]
The Google Cloud Platform project ID where your datasource was created.
DataSetRegion (string) --
The storage location where you create a Google BigQuery 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]
The port.
Database (string) -- [REQUIRED]
The 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.
IAMParameters (dict) --
An optional parameter that uses IAM authentication to grant Amazon QuickSight access to your cluster. This parameter can be used instead of DataSourceCredentials.
RoleArn (string) -- [REQUIRED]
Use the RoleArn structure to allow Amazon QuickSight to call redshift:GetClusterCredentials on your cluster. The calling principal must have iam:PassRole access to pass the role to Amazon QuickSight. The role's trust policy must allow the Amazon QuickSight service principal to assume the role.
DatabaseUser (string) -- [REQUIRED]
The user whose permissions and group memberships will be used by Amazon QuickSight to access the cluster. If this user already exists in your database, Amazon QuickSight is granted the same permissions that the user has. If the user doesn't exist, set the value of AutoCreateDatabaseUser to True to create a new user with PUBLIC permissions.
DatabaseGroups (list) --
A list of groups whose permissions will be granted to Amazon QuickSight to access the cluster. These permissions are combined with the permissions granted to Amazon QuickSight by the DatabaseUser. If you choose to include this parameter, the RoleArn must grant access to redshift:JoinGroup.
(string) --
AutoCreateDatabaseUser (boolean) --
Automatically creates a database user. If your database doesn't have a DatabaseUser, set this parameter to True. If there is no DatabaseUser, Amazon QuickSight can't connect to your cluster. The RoleArn that you use for this operation must grant access to redshift:CreateClusterUser to successfully create the user.
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.
RoleArn (string) --
Use the RoleArn structure to override an account-wide role for a specific S3 data source. For example, say an account administrator has turned off all S3 access with an account-wide role. The administrator can then use RoleArn to bypass the account-wide role and allow S3 access for the single S3 data source that is specified in the structure, even if the account-wide role forbidding S3 access is still active.
ServiceNowParameters (dict) --
The parameters for ServiceNow.
SiteBaseUrl (string) -- [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 parameters that are required 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.
StarburstParameters (dict) --
The parameters that are required to connect to a Starburst data source.
Host (string) -- [REQUIRED]
The host name of the Starburst data source.
Port (integer) -- [REQUIRED]
The port for the Starburst data source.
Catalog (string) -- [REQUIRED]
The catalog name for the Starburst data source.
ProductType (string) --
The product type for the Starburst data source.
TrinoParameters (dict) --
The parameters that are required to connect to a Trino data source.
Host (string) -- [REQUIRED]
The host name of the Trino data source.
Port (integer) -- [REQUIRED]
The port for the Trino data source.
Catalog (string) -- [REQUIRED]
The catalog name for the Trino data source.
BigQueryParameters (dict) --
The parameters that are required to connect to a Google BigQuery data source.
ProjectId (string) -- [REQUIRED]
The Google Cloud Platform project ID where your datasource was created.
DataSetRegion (string) --
The storage location where you create a Google BigQuery 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.
list
When you create the data source, Amazon QuickSight adds the data source to these folders.
(string) --
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.
{'IncludePermissions': 'boolean',
'IncludeTags': 'boolean',
'ValidationStrategy': {'StrictModeForAllResources': 'boolean'},
'Warnings': [{'Arn': 'string', 'Message': 'string'}]}
Describes an existing export job.
Poll job descriptions after a job starts to know the status of the job. When a job succeeds, a URL is provided to download the exported assets' data from. Download URLs are valid for five minutes after they are generated. You can call the DescribeAssetBundleExportJob API for a new download URL as needed.
Job descriptions are available for 14 days after the job starts.
See also: AWS API Documentation
Request Syntax
client.describe_asset_bundle_export_job(
AwsAccountId='string',
AssetBundleExportJobId='string'
)
string
[REQUIRED]
The ID of the Amazon Web Services account the export job is executed in.
string
[REQUIRED]
The ID of the job that you want described. The job ID is set when you start a new job with a StartAssetBundleExportJob API call.
dict
Response Syntax
{
'JobStatus': 'QUEUED_FOR_IMMEDIATE_EXECUTION'|'IN_PROGRESS'|'SUCCESSFUL'|'FAILED',
'DownloadUrl': 'string',
'Errors': [
{
'Arn': 'string',
'Type': 'string',
'Message': 'string'
},
],
'Arn': 'string',
'CreatedTime': datetime(2015, 1, 1),
'AssetBundleExportJobId': 'string',
'AwsAccountId': 'string',
'ResourceArns': [
'string',
],
'IncludeAllDependencies': True|False,
'ExportFormat': 'CLOUDFORMATION_JSON'|'QUICKSIGHT_JSON',
'CloudFormationOverridePropertyConfiguration': {
'ResourceIdOverrideConfiguration': {
'PrefixForAllResources': True|False
},
'VPCConnections': [
{
'Arn': 'string',
'Properties': [
'Name'|'DnsResolvers'|'RoleArn',
]
},
],
'RefreshSchedules': [
{
'Arn': 'string',
'Properties': [
'StartAfterDateTime',
]
},
],
'DataSources': [
{
'Arn': 'string',
'Properties': [
'Name'|'DisableSsl'|'SecretArn'|'Username'|'Password'|'Domain'|'WorkGroup'|'Host'|'Port'|'Database'|'DataSetName'|'Catalog'|'InstanceId'|'ClusterId'|'ManifestFileLocation'|'Warehouse'|'RoleArn',
]
},
],
'DataSets': [
{
'Arn': 'string',
'Properties': [
'Name',
]
},
],
'Themes': [
{
'Arn': 'string',
'Properties': [
'Name',
]
},
],
'Analyses': [
{
'Arn': 'string',
'Properties': [
'Name',
]
},
],
'Dashboards': [
{
'Arn': 'string',
'Properties': [
'Name',
]
},
]
},
'RequestId': 'string',
'Status': 123,
'IncludePermissions': True|False,
'IncludeTags': True|False,
'ValidationStrategy': {
'StrictModeForAllResources': True|False
},
'Warnings': [
{
'Arn': 'string',
'Message': 'string'
},
]
}
Response Structure
(dict) --
JobStatus (string) --
Indicates the status of a job through its queuing and execution.
Poll this DescribeAssetBundleExportApi until JobStatus is either SUCCESSFUL or FAILED.
DownloadUrl (string) --
The URL to download the exported asset bundle data from.
This URL is available only after the job has succeeded. This URL is valid for 5 minutes after issuance. Call DescribeAssetBundleExportJob again for a fresh URL if needed.
The downloaded asset bundle is a zip file named assetbundle-{jobId}.qs. The file has a .qs extension.
This URL can't be used in a StartAssetBundleImportJob API call and should only be used for download purposes.
Errors (list) --
An array of error records that describes any failures that occurred during the export job processing.
Error records accumulate while the job runs. The complete set of error records is available after the job has completed and failed.
(dict) --
Describes an error that occurred during an Asset Bundle export job.
Arn (string) --
The ARN of the resource whose processing caused an error.
Type (string) --
The specific error type of the error that occurred.
Message (string) --
A description of the error.
Arn (string) --
The Amazon Resource Name (ARN) for the export job.
CreatedTime (datetime) --
The time that the export job was created.
AssetBundleExportJobId (string) --
The ID of the job. The job ID is set when you start a new job with a StartAssetBundleExportJob API call.
AwsAccountId (string) --
The ID of the Amazon Web Services account that the export job was executed in.
ResourceArns (list) --
A list of resource ARNs that exported with the job.
(string) --
IncludeAllDependencies (boolean) --
The include dependencies flag.
ExportFormat (string) --
The format of the exported asset bundle. A QUICKSIGHT_JSON formatted file can be used to make a StartAssetBundleImportJob API call. A CLOUDFORMATION_JSON formatted file can be used in the CloudFormation console and with the CloudFormation APIs.
CloudFormationOverridePropertyConfiguration (dict) --
The CloudFormation override property configuration for the export job.
ResourceIdOverrideConfiguration (dict) --
An optional list of structures that control how resource IDs are parameterized in the returned CloudFormation template.
PrefixForAllResources (boolean) --
An option to request a CloudFormation variable for a prefix to be prepended to each resource's ID before import. The prefix is only added to the asset IDs and does not change the name of the asset.
VPCConnections (list) --
An optional list of structures that control how VPCConnection resources are parameterized in the returned CloudFormation template.
(dict) --
Controls how a specific VPCConnection resource is parameterized in the outputted CloudFormation template.
Arn (string) --
The ARN of the specific VPCConnection resource whose override properties are configured in this structure.
Properties (list) --
A list of VPCConnection resource properties to generate variables for in the returned CloudFormation template.
(string) --
RefreshSchedules (list) --
An optional list of structures that control how RefreshSchedule resources are parameterized in the returned CloudFormation template.
(dict) --
Controls how a specific RefreshSchedule resource is parameterized in the returned CloudFormation template.
Arn (string) --
The ARN of the specific RefreshSchedule resource whose override properties are configured in this structure.
Properties (list) --
A list of RefreshSchedule resource properties to generate variables for in the returned CloudFormation template.
(string) --
DataSources (list) --
An optional list of structures that control how DataSource resources are parameterized in the returned CloudFormation template.
(dict) --
Controls how a specific DataSource resource is parameterized in the returned CloudFormation template.
Arn (string) --
The ARN of the specific DataSource resource whose override properties are configured in this structure.
Properties (list) --
A list of DataSource resource properties to generate variables for in the returned CloudFormation template.
(string) --
DataSets (list) --
An optional list of structures that control how DataSet resources are parameterized in the returned CloudFormation template.
(dict) --
Controls how a specific DataSet resource is parameterized in the returned CloudFormation template.
Arn (string) --
The ARN of the specific DataSet resource whose override properties are configured in this structure.
Properties (list) --
A list of DataSet resource properties to generate variables for in the returned CloudFormation template.
(string) --
Themes (list) --
An optional list of structures that control how Theme resources are parameterized in the returned CloudFormation template.
(dict) --
Controls how a specific Theme resource is parameterized in the returned CloudFormation template.
Arn (string) --
The ARN of the specific Theme resource whose override properties are configured in this structure.
Properties (list) --
A list of Theme resource properties to generate variables for in the returned CloudFormation template.
(string) --
Analyses (list) --
An optional list of structures that control how Analysis resources are parameterized in the returned CloudFormation template.
(dict) --
Controls how a specific Analysis resource is parameterized in the returned CloudFormation template.
Arn (string) --
The ARN of the specific Analysis resource whose override properties are configured in this structure.
Properties (list) --
A list of Analysis resource properties to generate variables for in the returned CloudFormation template.
(string) --
Dashboards (list) --
An optional list of structures that control how Dashboard resources are parameterized in the returned CloudFormation template.
(dict) --
Controls how a specific Dashboard resource is parameterized in the returned CloudFormation template.
Arn (string) --
The ARN of the specific Dashboard resource whose override properties are configured in this structure.
Properties (list) --
A list of Dashboard resource properties to generate variables for in the returned CloudFormation template.
(string) --
RequestId (string) --
The Amazon Web Services request ID for this operation.
Status (integer) --
The HTTP status of the response.
IncludePermissions (boolean) --
The include permissions flag.
IncludeTags (boolean) --
The include tags flag.
ValidationStrategy (dict) --
The validation strategy that is used to export the analysis or dashboard.
StrictModeForAllResources (boolean) --
A Boolean value that indicates whether to export resources under strict or lenient mode.
Warnings (list) --
An array of warning records that describe the analysis or dashboard that is exported. This array includes UI errors that can be skipped during the validation process.
This property only appears if StrictModeForAllResources in ValidationStrategy is set to FALSE.
(dict) --
Describes a warning that occurred during an Asset Bundle export job.
Arn (string) --
The ARN of the resource whose processing caused a warning.
Message (string) --
A description of the warning.
{'OverrideParameters': {'DataSources': {'DataSourceParameters': {'BigQueryParameters': {'DataSetRegion': 'string',
'ProjectId': 'string'}}}},
'OverridePermissions': {'Analyses': [{'AnalysisIds': ['string'],
'Permissions': {'Actions': ['string'],
'Principals': ['string']}}],
'Dashboards': [{'DashboardIds': ['string'],
'LinkSharingConfiguration': {'Permissions': {'Actions': ['string'],
'Principals': ['string']}},
'Permissions': {'Actions': ['string'],
'Principals': ['string']}}],
'DataSets': [{'DataSetIds': ['string'],
'Permissions': {'Actions': ['string'],
'Principals': ['string']}}],
'DataSources': [{'DataSourceIds': ['string'],
'Permissions': {'Actions': ['string'],
'Principals': ['string']}}],
'Themes': [{'Permissions': {'Actions': ['string'],
'Principals': ['string']},
'ThemeIds': ['string']}]},
'OverrideTags': {'Analyses': [{'AnalysisIds': ['string'],
'Tags': [{'Key': 'string',
'Value': 'string'}]}],
'Dashboards': [{'DashboardIds': ['string'],
'Tags': [{'Key': 'string',
'Value': 'string'}]}],
'DataSets': [{'DataSetIds': ['string'],
'Tags': [{'Key': 'string',
'Value': 'string'}]}],
'DataSources': [{'DataSourceIds': ['string'],
'Tags': [{'Key': 'string',
'Value': 'string'}]}],
'Themes': [{'Tags': [{'Key': 'string', 'Value': 'string'}],
'ThemeIds': ['string']}],
'VPCConnections': [{'Tags': [{'Key': 'string',
'Value': 'string'}],
'VPCConnectionIds': ['string']}]},
'OverrideValidationStrategy': {'StrictModeForAllResources': 'boolean'}}
Describes an existing import job.
Poll job descriptions after starting a job to know when it has succeeded or failed. Job descriptions are available for 14 days after job starts.
See also: AWS API Documentation
Request Syntax
client.describe_asset_bundle_import_job(
AwsAccountId='string',
AssetBundleImportJobId='string'
)
string
[REQUIRED]
The ID of the Amazon Web Services account the import job was executed in.
string
[REQUIRED]
The ID of the job. The job ID is set when you start a new job with a StartAssetBundleImportJob API call.
dict
Response Syntax
{
'JobStatus': 'QUEUED_FOR_IMMEDIATE_EXECUTION'|'IN_PROGRESS'|'SUCCESSFUL'|'FAILED'|'FAILED_ROLLBACK_IN_PROGRESS'|'FAILED_ROLLBACK_COMPLETED'|'FAILED_ROLLBACK_ERROR',
'Errors': [
{
'Arn': 'string',
'Type': 'string',
'Message': 'string'
},
],
'RollbackErrors': [
{
'Arn': 'string',
'Type': 'string',
'Message': 'string'
},
],
'Arn': 'string',
'CreatedTime': datetime(2015, 1, 1),
'AssetBundleImportJobId': 'string',
'AwsAccountId': 'string',
'AssetBundleImportSource': {
'Body': 'string',
'S3Uri': 'string'
},
'OverrideParameters': {
'ResourceIdOverrideConfiguration': {
'PrefixForAllResources': 'string'
},
'VPCConnections': [
{
'VPCConnectionId': 'string',
'Name': 'string',
'SubnetIds': [
'string',
],
'SecurityGroupIds': [
'string',
],
'DnsResolvers': [
'string',
],
'RoleArn': 'string'
},
],
'RefreshSchedules': [
{
'DataSetId': 'string',
'ScheduleId': 'string',
'StartAfterDateTime': datetime(2015, 1, 1)
},
],
'DataSources': [
{
'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',
'IAMParameters': {
'RoleArn': 'string',
'DatabaseUser': 'string',
'DatabaseGroups': [
'string',
],
'AutoCreateDatabaseUser': True|False
}
},
'S3Parameters': {
'ManifestFileLocation': {
'Bucket': 'string',
'Key': 'string'
},
'RoleArn': 'string'
},
'ServiceNowParameters': {
'SiteBaseUrl': 'string'
},
'SnowflakeParameters': {
'Host': 'string',
'Database': 'string',
'Warehouse': 'string'
},
'SparkParameters': {
'Host': 'string',
'Port': 123
},
'SqlServerParameters': {
'Host': 'string',
'Port': 123,
'Database': 'string'
},
'TeradataParameters': {
'Host': 'string',
'Port': 123,
'Database': 'string'
},
'TwitterParameters': {
'Query': 'string',
'MaxRows': 123
},
'AmazonOpenSearchParameters': {
'Domain': 'string'
},
'ExasolParameters': {
'Host': 'string',
'Port': 123
},
'DatabricksParameters': {
'Host': 'string',
'Port': 123,
'SqlEndpointPath': 'string'
},
'StarburstParameters': {
'Host': 'string',
'Port': 123,
'Catalog': 'string',
'ProductType': 'GALAXY'|'ENTERPRISE'
},
'TrinoParameters': {
'Host': 'string',
'Port': 123,
'Catalog': 'string'
},
'BigQueryParameters': {
'ProjectId': 'string',
'DataSetRegion': 'string'
}
},
'VpcConnectionProperties': {
'VpcConnectionArn': 'string'
},
'SslProperties': {
'DisableSsl': True|False
},
'Credentials': {
'CredentialPair': {
'Username': 'string',
'Password': 'string'
},
'SecretArn': 'string'
}
},
],
'DataSets': [
{
'DataSetId': 'string',
'Name': 'string'
},
],
'Themes': [
{
'ThemeId': 'string',
'Name': 'string'
},
],
'Analyses': [
{
'AnalysisId': 'string',
'Name': 'string'
},
],
'Dashboards': [
{
'DashboardId': 'string',
'Name': 'string'
},
]
},
'FailureAction': 'DO_NOTHING'|'ROLLBACK',
'RequestId': 'string',
'Status': 123,
'OverridePermissions': {
'DataSources': [
{
'DataSourceIds': [
'string',
],
'Permissions': {
'Principals': [
'string',
],
'Actions': [
'string',
]
}
},
],
'DataSets': [
{
'DataSetIds': [
'string',
],
'Permissions': {
'Principals': [
'string',
],
'Actions': [
'string',
]
}
},
],
'Themes': [
{
'ThemeIds': [
'string',
],
'Permissions': {
'Principals': [
'string',
],
'Actions': [
'string',
]
}
},
],
'Analyses': [
{
'AnalysisIds': [
'string',
],
'Permissions': {
'Principals': [
'string',
],
'Actions': [
'string',
]
}
},
],
'Dashboards': [
{
'DashboardIds': [
'string',
],
'Permissions': {
'Principals': [
'string',
],
'Actions': [
'string',
]
},
'LinkSharingConfiguration': {
'Permissions': {
'Principals': [
'string',
],
'Actions': [
'string',
]
}
}
},
]
},
'OverrideTags': {
'VPCConnections': [
{
'VPCConnectionIds': [
'string',
],
'Tags': [
{
'Key': 'string',
'Value': 'string'
},
]
},
],
'DataSources': [
{
'DataSourceIds': [
'string',
],
'Tags': [
{
'Key': 'string',
'Value': 'string'
},
]
},
],
'DataSets': [
{
'DataSetIds': [
'string',
],
'Tags': [
{
'Key': 'string',
'Value': 'string'
},
]
},
],
'Themes': [
{
'ThemeIds': [
'string',
],
'Tags': [
{
'Key': 'string',
'Value': 'string'
},
]
},
],
'Analyses': [
{
'AnalysisIds': [
'string',
],
'Tags': [
{
'Key': 'string',
'Value': 'string'
},
]
},
],
'Dashboards': [
{
'DashboardIds': [
'string',
],
'Tags': [
{
'Key': 'string',
'Value': 'string'
},
]
},
]
},
'OverrideValidationStrategy': {
'StrictModeForAllResources': True|False
}
}
Response Structure
(dict) --
JobStatus (string) --
Indicates the status of a job through its queuing and execution.
Poll the DescribeAssetBundleImport API until JobStatus returns one of the following values:
SUCCESSFUL
FAILED
FAILED_ROLLBACK_COMPLETED
FAILED_ROLLBACK_ERROR
Errors (list) --
An array of error records that describes any failures that occurred during the export job processing.
Error records accumulate while the job is still running. The complete set of error records is available after the job has completed and failed.
(dict) --
Describes an error that occurred within an Asset Bundle import execution.
Arn (string) --
The ARN of the resource whose processing caused an error.
Type (string) --
The specific error type or the error that occurred.
Message (string) --
A description of the error.
RollbackErrors (list) --
An array of error records that describes any failures that occurred while an import job was attempting a rollback.
Error records accumulate while the job is still running. The complete set of error records is available after the job has completed and failed.
(dict) --
Describes an error that occurred within an Asset Bundle import execution.
Arn (string) --
The ARN of the resource whose processing caused an error.
Type (string) --
The specific error type or the error that occurred.
Message (string) --
A description of the error.
Arn (string) --
The Amazon Resource Name (ARN) for the import job.
CreatedTime (datetime) --
The time that the import job was created.
AssetBundleImportJobId (string) --
The ID of the job. The job ID is set when you start a new job with a StartAssetBundleImportJob API call.
AwsAccountId (string) --
The ID of the Amazon Web Services account the import job was executed in.
AssetBundleImportSource (dict) --
The source of the asset bundle zip file that contains the data that is imported by the job.
Body (string) --
An HTTPS download URL for the provided asset bundle that you optionally provided at the start of the import job. This URL is valid for five minutes after issuance. Call DescribeAssetBundleExportJob again for a fresh URL if needed. The downloaded asset bundle is a .qs zip file.
S3Uri (string) --
The Amazon S3 URI that you provided at the start of the import job.
OverrideParameters (dict) --
Optional overrides that are applied to the resource configuration before import.
ResourceIdOverrideConfiguration (dict) --
An optional structure that configures resource ID overrides to be applied within the import job.
PrefixForAllResources (string) --
An option to request a CloudFormation variable for a prefix to be prepended to each resource's ID before import. The prefix is only added to the asset IDs and does not change the name of the asset.
VPCConnections (list) --
A list of overrides for any VPCConnection resources that are present in the asset bundle that is imported.
(dict) --
The override parameters for a single VPC connection that is imported.
VPCConnectionId (string) --
The ID of the VPC Connection to apply overrides to.
Name (string) --
A new name for the VPC connection.
SubnetIds (list) --
A list of new subnet IDs for the VPC connection you are importing. This field is required if you are importing the VPC connection from another Amazon Web Services account or Region.
(string) --
SecurityGroupIds (list) --
A new security group ID for the VPC connection you are importing. This field is required if you are importing the VPC connection from another Amazon Web Services account or Region.
(string) --
DnsResolvers (list) --
An optional override of DNS resolvers to be used by the VPC connection.
(string) --
RoleArn (string) --
An optional override of the role ARN to be used by the VPC connection.
RefreshSchedules (list) --
A list of overrides for any RefreshSchedule resources that are present in the asset bundle that is imported.
(dict) --
A list of overrides for a specific RefreshsSchedule resource that is present in the asset bundle that is imported.
DataSetId (string) --
A partial identifier for the specific RefreshSchedule resource that is being overridden. This structure is used together with the ScheduleID structure.
ScheduleId (string) --
A partial identifier for the specific RefreshSchedule resource being overridden. This structure is used together with the DataSetId structure.
StartAfterDateTime (datetime) --
An override for the StartAfterDateTime of a RefreshSchedule. Make sure that the StartAfterDateTime is set to a time that takes place in the future.
DataSources (list) --
A list of overrides for any DataSource resources that are present in the asset bundle that is imported.
(dict) --
The override parameters for a single data source that is being imported.
DataSourceId (string) --
The ID of the data source to apply overrides to.
Name (string) --
A new name for the data source.
DataSourceParameters (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) --
The port.
Database (string) --
The 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.
IAMParameters (dict) --
An optional parameter that uses IAM authentication to grant Amazon QuickSight access to your cluster. This parameter can be used instead of DataSourceCredentials.
RoleArn (string) --
Use the RoleArn structure to allow Amazon QuickSight to call redshift:GetClusterCredentials on your cluster. The calling principal must have iam:PassRole access to pass the role to Amazon QuickSight. The role's trust policy must allow the Amazon QuickSight service principal to assume the role.
DatabaseUser (string) --
The user whose permissions and group memberships will be used by Amazon QuickSight to access the cluster. If this user already exists in your database, Amazon QuickSight is granted the same permissions that the user has. If the user doesn't exist, set the value of AutoCreateDatabaseUser to True to create a new user with PUBLIC permissions.
DatabaseGroups (list) --
A list of groups whose permissions will be granted to Amazon QuickSight to access the cluster. These permissions are combined with the permissions granted to Amazon QuickSight by the DatabaseUser. If you choose to include this parameter, the RoleArn must grant access to redshift:JoinGroup.
(string) --
AutoCreateDatabaseUser (boolean) --
Automatically creates a database user. If your database doesn't have a DatabaseUser, set this parameter to True. If there is no DatabaseUser, Amazon QuickSight can't connect to your cluster. The RoleArn that you use for this operation must grant access to redshift:CreateClusterUser to successfully create the user.
S3Parameters (dict) --
The parameters for S3.
ManifestFileLocation (dict) --
Location of the Amazon S3 manifest file. This is NULL if the manifest file was uploaded into Amazon QuickSight.
Bucket (string) --
Amazon S3 bucket.
Key (string) --
Amazon S3 key that identifies an object.
RoleArn (string) --
Use the RoleArn structure to override an account-wide role for a specific S3 data source. For example, say an account administrator has turned off all S3 access with an account-wide role. The administrator can then use RoleArn to bypass the account-wide role and allow S3 access for the single S3 data source that is specified in the structure, even if the account-wide role forbidding S3 access is still active.
ServiceNowParameters (dict) --
The parameters for ServiceNow.
SiteBaseUrl (string) --
URL of the base site.
SnowflakeParameters (dict) --
The parameters for Snowflake.
Host (string) --
Host.
Database (string) --
Database.
Warehouse (string) --
Warehouse.
SparkParameters (dict) --
The parameters for Spark.
Host (string) --
Host.
Port (integer) --
Port.
SqlServerParameters (dict) --
The parameters for SQL Server.
Host (string) --
Host.
Port (integer) --
Port.
Database (string) --
Database.
TeradataParameters (dict) --
The parameters for Teradata.
Host (string) --
Host.
Port (integer) --
Port.
Database (string) --
Database.
TwitterParameters (dict) --
The parameters for Twitter.
Query (string) --
Twitter query string.
MaxRows (integer) --
Maximum number of rows to query Twitter.
AmazonOpenSearchParameters (dict) --
The parameters for OpenSearch.
Domain (string) --
The OpenSearch domain.
ExasolParameters (dict) --
The parameters for Exasol.
Host (string) --
The hostname or IP address of the Exasol data source.
Port (integer) --
The port for the Exasol data source.
DatabricksParameters (dict) --
The parameters that are required 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.
StarburstParameters (dict) --
The parameters that are required to connect to a Starburst data source.
Host (string) --
The host name of the Starburst data source.
Port (integer) --
The port for the Starburst data source.
Catalog (string) --
The catalog name for the Starburst data source.
ProductType (string) --
The product type for the Starburst data source.
TrinoParameters (dict) --
The parameters that are required to connect to a Trino data source.
Host (string) --
The host name of the Trino data source.
Port (integer) --
The port for the Trino data source.
Catalog (string) --
The catalog name for the Trino data source.
BigQueryParameters (dict) --
The parameters that are required to connect to a Google BigQuery data source.
ProjectId (string) --
The Google Cloud Platform project ID where your datasource was created.
DataSetRegion (string) --
The storage location where you create a Google BigQuery data source.
VpcConnectionProperties (dict) --
VPC connection properties.
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 data source.
DisableSsl (boolean) --
A Boolean option to control whether SSL should be disabled.
Credentials (dict) --
An optional structure that provides the credentials to be used to create the imported data source.
CredentialPair (dict) --
A username and password credential pair to be used to create the imported data source. Keep this field blank if you are using a Secrets Manager secret to provide credentials.
Username (string) --
The username for the data source connection.
Password (string) --
The password for the data source connection.
SecretArn (string) --
The ARN of the Secrets Manager secret that's used to create the imported data source. Keep this field blank, unless you are using a secret in place of a credential pair.
DataSets (list) --
A list of overrides for any DataSet resources that are present in the asset bundle that is imported.
(dict) --
The override parameters for a single dataset that is being imported.
DataSetId (string) --
The ID of the dataset to apply overrides to.
Name (string) --
A new name for the dataset.
Themes (list) --
A list of overrides for any Theme resources that are present in the asset bundle that is imported.
(dict) --
The override parameters for a single theme that is imported.
ThemeId (string) --
The ID of the theme to apply overrides to.
Name (string) --
A new name for the theme.
Analyses (list) --
A list of overrides for any Analysis resources that are present in the asset bundle that is imported.
(dict) --
The override parameters for a single analysis that is being imported.
AnalysisId (string) --
The ID of the analysis that you ant to apply overrides to.
Name (string) --
A new name for the analysis.
Dashboards (list) --
A list of overrides for any Dashboard resources that are present in the asset bundle that is imported.
(dict) --
The override parameters for a single dashboard that is being imported.
DashboardId (string) --
The ID of the dashboard that you want to apply overrides to.
Name (string) --
A new name for the dashboard.
FailureAction (string) --
The failure action for the import job.
RequestId (string) --
The Amazon Web Services request ID for this operation.
Status (integer) --
The HTTP status of the response.
OverridePermissions (dict) --
Optional permission overrides that are applied to the resource configuration before import.
DataSources (list) --
A list of permissions overrides for any DataSource resources that are present in the asset bundle that is imported.
(dict) --
An object that contains a list of permissions to be applied to a list of data source IDs.
DataSourceIds (list) --
A list of data source IDs that you want to apply overrides to. You can use * to override all data sources in this asset bundle.
(string) --
Permissions (dict) --
A list of permissions for the data source that you want to apply overrides to.
Principals (list) --
A list of principals to grant permissions on.
(string) --
Actions (list) --
A list of IAM actions to grant permissions on.
(string) --
DataSets (list) --
A list of permissions overrides for any DataSet resources that are present in the asset bundle that is imported.
(dict) --
An object that contains a list of permissions to be applied to a list of dataset IDs.
DataSetIds (list) --
A list of dataset IDs that you want to apply overrides to. You can use * to override all datasets in this asset bundle.
(string) --
Permissions (dict) --
A list of permissions for the datasets that you want to apply overrides to.
Principals (list) --
A list of principals to grant permissions on.
(string) --
Actions (list) --
A list of IAM actions to grant permissions on.
(string) --
Themes (list) --
A list of permissions overrides for any Theme resources that are present in the asset bundle that is imported.
(dict) --
An object that contains a list of permissions to be applied to a list of theme IDs.
ThemeIds (list) --
A list of theme IDs that you want to apply overrides to. You can use * to override all themes in this asset bundle.
(string) --
Permissions (dict) --
A list of permissions for the themes that you want to apply overrides to.
Principals (list) --
A list of principals to grant permissions on.
(string) --
Actions (list) --
A list of IAM actions to grant permissions on.
(string) --
Analyses (list) --
A list of permissions overrides for any Analysis resources that are present in the asset bundle that is imported.
(dict) --
An object that contains a list of permissions to be applied to a list of analysis IDs.
AnalysisIds (list) --
A list of analysis IDs that you want to apply overrides to. You can use * to override all analyses in this asset bundle.
(string) --
Permissions (dict) --
A list of permissions for the analyses that you want to apply overrides to.
Principals (list) --
A list of principals to grant permissions on.
(string) --
Actions (list) --
A list of IAM actions to grant permissions on.
(string) --
Dashboards (list) --
A list of permissions overrides for any Dashboard resources that are present in the asset bundle that is imported.
(dict) --
An object that contains a list of permissions to be applied to a list of dashboard IDs.
DashboardIds (list) --
A list of dashboard IDs that you want to apply overrides to. You can use * to override all dashboards in this asset bundle.
(string) --
Permissions (dict) --
A list of permissions for the dashboards that you want to apply overrides to.
Principals (list) --
A list of principals to grant permissions on.
(string) --
Actions (list) --
A list of IAM actions to grant permissions on.
(string) --
LinkSharingConfiguration (dict) --
A structure that contains the link sharing configurations that you want to apply overrides to.
Permissions (dict) --
A list of link sharing permissions for the dashboards that you want to apply overrides to.
Principals (list) --
A list of principals to grant permissions on.
(string) --
Actions (list) --
A list of IAM actions to grant permissions on.
(string) --
OverrideTags (dict) --
Optional tag overrides that are applied to the resource configuration before import.
VPCConnections (list) --
A list of tag overrides for any VPCConnection resources that are present in the asset bundle that is imported.
(dict) --
An object that contains a list of tags to be assigned to a list of VPC connection IDs.
VPCConnectionIds (list) --
A list of VPC connection IDs that you want to apply overrides to. You can use * to override all VPC connections in this asset bundle.
(string) --
Tags (list) --
A list of tags for the VPC connections that you want to apply overrides to.
(dict) --
The key or keys of the key-value pairs for the resource tag or tags assigned to the resource.
Key (string) --
Tag key.
Value (string) --
Tag value.
DataSources (list) --
A list of tag overrides for any DataSource resources that are present in the asset bundle that is imported.
(dict) --
An object that contains a list of tags to be assigned to a list of data source IDs.
DataSourceIds (list) --
A list of data source IDs that you want to apply overrides to. You can use * to override all data sources in this asset bundle.
(string) --
Tags (list) --
A list of tags for the data source that you want to apply overrides to.
(dict) --
The key or keys of the key-value pairs for the resource tag or tags assigned to the resource.
Key (string) --
Tag key.
Value (string) --
Tag value.
DataSets (list) --
A list of tag overrides for any DataSet resources that are present in the asset bundle that is imported.
(dict) --
An object that contains a list of tags to be assigned to a list of dataset IDs.
DataSetIds (list) --
A list of dataset IDs that you want to apply overrides to. You can use * to override all datasets in this asset bundle.
(string) --
Tags (list) --
A list of tags for the datasets that you want to apply overrides to.
(dict) --
The key or keys of the key-value pairs for the resource tag or tags assigned to the resource.
Key (string) --
Tag key.
Value (string) --
Tag value.
Themes (list) --
A list of tag overrides for any Theme resources that are present in the asset bundle that is imported.
(dict) --
An object that contains a list of tags to be assigned to a list of theme IDs.
ThemeIds (list) --
A list of theme IDs that you want to apply overrides to. You can use * to override all themes in this asset bundle.
(string) --
Tags (list) --
A list of tags for the themes that you want to apply overrides to.
(dict) --
The key or keys of the key-value pairs for the resource tag or tags assigned to the resource.
Key (string) --
Tag key.
Value (string) --
Tag value.
Analyses (list) --
A list of tag overrides for any Analysis resources that are present in the asset bundle that is imported.
(dict) --
An object that contains a list of tags to be assigned to a list of analysis IDs.
AnalysisIds (list) --
A list of analysis IDs that you want to apply overrides to. You can use * to override all analyses in this asset bundle.
(string) --
Tags (list) --
A list of tags for the analyses that you want to apply overrides to.
(dict) --
The key or keys of the key-value pairs for the resource tag or tags assigned to the resource.
Key (string) --
Tag key.
Value (string) --
Tag value.
Dashboards (list) --
A list of tag overrides for any Dashboard resources that are present in the asset bundle that is imported.
(dict) --
An object that contains a list of tags to be assigned to a list of dashboard IDs.
DashboardIds (list) --
A list of dashboard IDs that you want to apply overrides to. You can use * to override all dashboards in this asset bundle.
(string) --
Tags (list) --
A list of tags for the dashboards that you want to apply overrides to.
(dict) --
The key or keys of the key-value pairs for the resource tag or tags assigned to the resource.
Key (string) --
Tag key.
Value (string) --
Tag value.
OverrideValidationStrategy (dict) --
An optional validation strategy override for all analyses and dashboards to be applied to the resource configuration before import.
StrictModeForAllResources (boolean) --
A Boolean value that indicates whether to import all analyses and dashboards under strict or lenient mode.
{'DataSource': {'AlternateDataSourceParameters': {'BigQueryParameters': {'DataSetRegion': 'string',
'ProjectId': 'string'}},
'DataSourceParameters': {'BigQueryParameters': {'DataSetRegion': 'string',
'ProjectId': 'string'}},
'Type': {'STARBURST', 'BIGQUERY', 'TRINO'}}}
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'|'STARBURST'|'TRINO'|'BIGQUERY',
'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',
'IAMParameters': {
'RoleArn': 'string',
'DatabaseUser': 'string',
'DatabaseGroups': [
'string',
],
'AutoCreateDatabaseUser': True|False
}
},
'S3Parameters': {
'ManifestFileLocation': {
'Bucket': 'string',
'Key': 'string'
},
'RoleArn': 'string'
},
'ServiceNowParameters': {
'SiteBaseUrl': 'string'
},
'SnowflakeParameters': {
'Host': 'string',
'Database': 'string',
'Warehouse': 'string'
},
'SparkParameters': {
'Host': 'string',
'Port': 123
},
'SqlServerParameters': {
'Host': 'string',
'Port': 123,
'Database': 'string'
},
'TeradataParameters': {
'Host': 'string',
'Port': 123,
'Database': 'string'
},
'TwitterParameters': {
'Query': 'string',
'MaxRows': 123
},
'AmazonOpenSearchParameters': {
'Domain': 'string'
},
'ExasolParameters': {
'Host': 'string',
'Port': 123
},
'DatabricksParameters': {
'Host': 'string',
'Port': 123,
'SqlEndpointPath': 'string'
},
'StarburstParameters': {
'Host': 'string',
'Port': 123,
'Catalog': 'string',
'ProductType': 'GALAXY'|'ENTERPRISE'
},
'TrinoParameters': {
'Host': 'string',
'Port': 123,
'Catalog': 'string'
},
'BigQueryParameters': {
'ProjectId': 'string',
'DataSetRegion': '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',
'IAMParameters': {
'RoleArn': 'string',
'DatabaseUser': 'string',
'DatabaseGroups': [
'string',
],
'AutoCreateDatabaseUser': True|False
}
},
'S3Parameters': {
'ManifestFileLocation': {
'Bucket': 'string',
'Key': 'string'
},
'RoleArn': 'string'
},
'ServiceNowParameters': {
'SiteBaseUrl': 'string'
},
'SnowflakeParameters': {
'Host': 'string',
'Database': 'string',
'Warehouse': 'string'
},
'SparkParameters': {
'Host': 'string',
'Port': 123
},
'SqlServerParameters': {
'Host': 'string',
'Port': 123,
'Database': 'string'
},
'TeradataParameters': {
'Host': 'string',
'Port': 123,
'Database': 'string'
},
'TwitterParameters': {
'Query': 'string',
'MaxRows': 123
},
'AmazonOpenSearchParameters': {
'Domain': 'string'
},
'ExasolParameters': {
'Host': 'string',
'Port': 123
},
'DatabricksParameters': {
'Host': 'string',
'Port': 123,
'SqlEndpointPath': 'string'
},
'StarburstParameters': {
'Host': 'string',
'Port': 123,
'Catalog': 'string',
'ProductType': 'GALAXY'|'ENTERPRISE'
},
'TrinoParameters': {
'Host': 'string',
'Port': 123,
'Catalog': 'string'
},
'BigQueryParameters': {
'ProjectId': 'string',
'DataSetRegion': '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) --
The port.
Database (string) --
The 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.
IAMParameters (dict) --
An optional parameter that uses IAM authentication to grant Amazon QuickSight access to your cluster. This parameter can be used instead of DataSourceCredentials.
RoleArn (string) --
Use the RoleArn structure to allow Amazon QuickSight to call redshift:GetClusterCredentials on your cluster. The calling principal must have iam:PassRole access to pass the role to Amazon QuickSight. The role's trust policy must allow the Amazon QuickSight service principal to assume the role.
DatabaseUser (string) --
The user whose permissions and group memberships will be used by Amazon QuickSight to access the cluster. If this user already exists in your database, Amazon QuickSight is granted the same permissions that the user has. If the user doesn't exist, set the value of AutoCreateDatabaseUser to True to create a new user with PUBLIC permissions.
DatabaseGroups (list) --
A list of groups whose permissions will be granted to Amazon QuickSight to access the cluster. These permissions are combined with the permissions granted to Amazon QuickSight by the DatabaseUser. If you choose to include this parameter, the RoleArn must grant access to redshift:JoinGroup.
(string) --
AutoCreateDatabaseUser (boolean) --
Automatically creates a database user. If your database doesn't have a DatabaseUser, set this parameter to True. If there is no DatabaseUser, Amazon QuickSight can't connect to your cluster. The RoleArn that you use for this operation must grant access to redshift:CreateClusterUser to successfully create the user.
S3Parameters (dict) --
The parameters for S3.
ManifestFileLocation (dict) --
Location of the Amazon S3 manifest file. This is NULL if the manifest file was uploaded into Amazon QuickSight.
Bucket (string) --
Amazon S3 bucket.
Key (string) --
Amazon S3 key that identifies an object.
RoleArn (string) --
Use the RoleArn structure to override an account-wide role for a specific S3 data source. For example, say an account administrator has turned off all S3 access with an account-wide role. The administrator can then use RoleArn to bypass the account-wide role and allow S3 access for the single S3 data source that is specified in the structure, even if the account-wide role forbidding S3 access is still active.
ServiceNowParameters (dict) --
The parameters for ServiceNow.
SiteBaseUrl (string) --
URL of the base site.
SnowflakeParameters (dict) --
The parameters for Snowflake.
Host (string) --
Host.
Database (string) --
Database.
Warehouse (string) --
Warehouse.
SparkParameters (dict) --
The parameters for Spark.
Host (string) --
Host.
Port (integer) --
Port.
SqlServerParameters (dict) --
The parameters for SQL Server.
Host (string) --
Host.
Port (integer) --
Port.
Database (string) --
Database.
TeradataParameters (dict) --
The parameters for Teradata.
Host (string) --
Host.
Port (integer) --
Port.
Database (string) --
Database.
TwitterParameters (dict) --
The parameters for Twitter.
Query (string) --
Twitter query string.
MaxRows (integer) --
Maximum number of rows to query Twitter.
AmazonOpenSearchParameters (dict) --
The parameters for OpenSearch.
Domain (string) --
The OpenSearch domain.
ExasolParameters (dict) --
The parameters for Exasol.
Host (string) --
The hostname or IP address of the Exasol data source.
Port (integer) --
The port for the Exasol data source.
DatabricksParameters (dict) --
The parameters that are required 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.
StarburstParameters (dict) --
The parameters that are required to connect to a Starburst data source.
Host (string) --
The host name of the Starburst data source.
Port (integer) --
The port for the Starburst data source.
Catalog (string) --
The catalog name for the Starburst data source.
ProductType (string) --
The product type for the Starburst data source.
TrinoParameters (dict) --
The parameters that are required to connect to a Trino data source.
Host (string) --
The host name of the Trino data source.
Port (integer) --
The port for the Trino data source.
Catalog (string) --
The catalog name for the Trino data source.
BigQueryParameters (dict) --
The parameters that are required to connect to a Google BigQuery data source.
ProjectId (string) --
The Google Cloud Platform project ID where your datasource was created.
DataSetRegion (string) --
The storage location where you create a Google BigQuery 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) --
The port.
Database (string) --
The 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.
IAMParameters (dict) --
An optional parameter that uses IAM authentication to grant Amazon QuickSight access to your cluster. This parameter can be used instead of DataSourceCredentials.
RoleArn (string) --
Use the RoleArn structure to allow Amazon QuickSight to call redshift:GetClusterCredentials on your cluster. The calling principal must have iam:PassRole access to pass the role to Amazon QuickSight. The role's trust policy must allow the Amazon QuickSight service principal to assume the role.
DatabaseUser (string) --
The user whose permissions and group memberships will be used by Amazon QuickSight to access the cluster. If this user already exists in your database, Amazon QuickSight is granted the same permissions that the user has. If the user doesn't exist, set the value of AutoCreateDatabaseUser to True to create a new user with PUBLIC permissions.
DatabaseGroups (list) --
A list of groups whose permissions will be granted to Amazon QuickSight to access the cluster. These permissions are combined with the permissions granted to Amazon QuickSight by the DatabaseUser. If you choose to include this parameter, the RoleArn must grant access to redshift:JoinGroup.
(string) --
AutoCreateDatabaseUser (boolean) --
Automatically creates a database user. If your database doesn't have a DatabaseUser, set this parameter to True. If there is no DatabaseUser, Amazon QuickSight can't connect to your cluster. The RoleArn that you use for this operation must grant access to redshift:CreateClusterUser to successfully create the user.
S3Parameters (dict) --
The parameters for S3.
ManifestFileLocation (dict) --
Location of the Amazon S3 manifest file. This is NULL if the manifest file was uploaded into Amazon QuickSight.
Bucket (string) --
Amazon S3 bucket.
Key (string) --
Amazon S3 key that identifies an object.
RoleArn (string) --
Use the RoleArn structure to override an account-wide role for a specific S3 data source. For example, say an account administrator has turned off all S3 access with an account-wide role. The administrator can then use RoleArn to bypass the account-wide role and allow S3 access for the single S3 data source that is specified in the structure, even if the account-wide role forbidding S3 access is still active.
ServiceNowParameters (dict) --
The parameters for ServiceNow.
SiteBaseUrl (string) --
URL of the base site.
SnowflakeParameters (dict) --
The parameters for Snowflake.
Host (string) --
Host.
Database (string) --
Database.
Warehouse (string) --
Warehouse.
SparkParameters (dict) --
The parameters for Spark.
Host (string) --
Host.
Port (integer) --
Port.
SqlServerParameters (dict) --
The parameters for SQL Server.
Host (string) --
Host.
Port (integer) --
Port.
Database (string) --
Database.
TeradataParameters (dict) --
The parameters for Teradata.
Host (string) --
Host.
Port (integer) --
Port.
Database (string) --
Database.
TwitterParameters (dict) --
The parameters for Twitter.
Query (string) --
Twitter query string.
MaxRows (integer) --
Maximum number of rows to query Twitter.
AmazonOpenSearchParameters (dict) --
The parameters for OpenSearch.
Domain (string) --
The OpenSearch domain.
ExasolParameters (dict) --
The parameters for Exasol.
Host (string) --
The hostname or IP address of the Exasol data source.
Port (integer) --
The port for the Exasol data source.
DatabricksParameters (dict) --
The parameters that are required 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.
StarburstParameters (dict) --
The parameters that are required to connect to a Starburst data source.
Host (string) --
The host name of the Starburst data source.
Port (integer) --
The port for the Starburst data source.
Catalog (string) --
The catalog name for the Starburst data source.
ProductType (string) --
The product type for the Starburst data source.
TrinoParameters (dict) --
The parameters that are required to connect to a Trino data source.
Host (string) --
The host name of the Trino data source.
Port (integer) --
The port for the Trino data source.
Catalog (string) --
The catalog name for the Trino data source.
BigQueryParameters (dict) --
The parameters that are required to connect to a Google BigQuery data source.
ProjectId (string) --
The Google Cloud Platform project ID where your datasource was created.
DataSetRegion (string) --
The storage location where you create a Google BigQuery 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.
{'AssetBundleExportJobSummaryList': {'IncludePermissions': 'boolean',
'IncludeTags': 'boolean'}}
Lists all asset bundle export jobs that have been taken place in the last 14 days. Jobs created more than 14 days ago are deleted forever and are not returned. If you are using the same job ID for multiple jobs, ListAssetBundleExportJobs only returns the most recent job that uses the repeated job ID.
See also: AWS API Documentation
Request Syntax
client.list_asset_bundle_export_jobs(
AwsAccountId='string',
NextToken='string',
MaxResults=123
)
string
[REQUIRED]
The ID of the Amazon Web Services account that the export jobs were executed in.
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
{
'AssetBundleExportJobSummaryList': [
{
'JobStatus': 'QUEUED_FOR_IMMEDIATE_EXECUTION'|'IN_PROGRESS'|'SUCCESSFUL'|'FAILED',
'Arn': 'string',
'CreatedTime': datetime(2015, 1, 1),
'AssetBundleExportJobId': 'string',
'IncludeAllDependencies': True|False,
'ExportFormat': 'CLOUDFORMATION_JSON'|'QUICKSIGHT_JSON',
'IncludePermissions': True|False,
'IncludeTags': True|False
},
],
'NextToken': 'string',
'RequestId': 'string',
'Status': 123
}
Response Structure
(dict) --
AssetBundleExportJobSummaryList (list) --
A list of export job summaries.
(dict) --
A summary of the export job that includes details of the job's configuration and its current status.
JobStatus (string) --
The current status of the export job.
Arn (string) --
The ARN of the export job.
CreatedTime (datetime) --
The time that the export job was created.
AssetBundleExportJobId (string) --
The ID of the export job.
IncludeAllDependencies (boolean) --
The flag that determines the inclusion of resource dependencies in the returned asset bundle.
ExportFormat (string) --
The format for the export job.
IncludePermissions (boolean) --
The flag that determines the inclusion of permissions associated with each resource ARN.
IncludeTags (boolean) --
The flag that determines the inclusion of tags associated with each resource ARN.
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.
{'DataSources': {'AlternateDataSourceParameters': {'BigQueryParameters': {'DataSetRegion': 'string',
'ProjectId': 'string'}},
'DataSourceParameters': {'BigQueryParameters': {'DataSetRegion': 'string',
'ProjectId': 'string'}},
'Type': {'STARBURST', 'BIGQUERY', 'TRINO'}}}
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'|'STARBURST'|'TRINO'|'BIGQUERY',
'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',
'IAMParameters': {
'RoleArn': 'string',
'DatabaseUser': 'string',
'DatabaseGroups': [
'string',
],
'AutoCreateDatabaseUser': True|False
}
},
'S3Parameters': {
'ManifestFileLocation': {
'Bucket': 'string',
'Key': 'string'
},
'RoleArn': 'string'
},
'ServiceNowParameters': {
'SiteBaseUrl': 'string'
},
'SnowflakeParameters': {
'Host': 'string',
'Database': 'string',
'Warehouse': 'string'
},
'SparkParameters': {
'Host': 'string',
'Port': 123
},
'SqlServerParameters': {
'Host': 'string',
'Port': 123,
'Database': 'string'
},
'TeradataParameters': {
'Host': 'string',
'Port': 123,
'Database': 'string'
},
'TwitterParameters': {
'Query': 'string',
'MaxRows': 123
},
'AmazonOpenSearchParameters': {
'Domain': 'string'
},
'ExasolParameters': {
'Host': 'string',
'Port': 123
},
'DatabricksParameters': {
'Host': 'string',
'Port': 123,
'SqlEndpointPath': 'string'
},
'StarburstParameters': {
'Host': 'string',
'Port': 123,
'Catalog': 'string',
'ProductType': 'GALAXY'|'ENTERPRISE'
},
'TrinoParameters': {
'Host': 'string',
'Port': 123,
'Catalog': 'string'
},
'BigQueryParameters': {
'ProjectId': 'string',
'DataSetRegion': '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',
'IAMParameters': {
'RoleArn': 'string',
'DatabaseUser': 'string',
'DatabaseGroups': [
'string',
],
'AutoCreateDatabaseUser': True|False
}
},
'S3Parameters': {
'ManifestFileLocation': {
'Bucket': 'string',
'Key': 'string'
},
'RoleArn': 'string'
},
'ServiceNowParameters': {
'SiteBaseUrl': 'string'
},
'SnowflakeParameters': {
'Host': 'string',
'Database': 'string',
'Warehouse': 'string'
},
'SparkParameters': {
'Host': 'string',
'Port': 123
},
'SqlServerParameters': {
'Host': 'string',
'Port': 123,
'Database': 'string'
},
'TeradataParameters': {
'Host': 'string',
'Port': 123,
'Database': 'string'
},
'TwitterParameters': {
'Query': 'string',
'MaxRows': 123
},
'AmazonOpenSearchParameters': {
'Domain': 'string'
},
'ExasolParameters': {
'Host': 'string',
'Port': 123
},
'DatabricksParameters': {
'Host': 'string',
'Port': 123,
'SqlEndpointPath': 'string'
},
'StarburstParameters': {
'Host': 'string',
'Port': 123,
'Catalog': 'string',
'ProductType': 'GALAXY'|'ENTERPRISE'
},
'TrinoParameters': {
'Host': 'string',
'Port': 123,
'Catalog': 'string'
},
'BigQueryParameters': {
'ProjectId': 'string',
'DataSetRegion': '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) --
The port.
Database (string) --
The 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.
IAMParameters (dict) --
An optional parameter that uses IAM authentication to grant Amazon QuickSight access to your cluster. This parameter can be used instead of DataSourceCredentials.
RoleArn (string) --
Use the RoleArn structure to allow Amazon QuickSight to call redshift:GetClusterCredentials on your cluster. The calling principal must have iam:PassRole access to pass the role to Amazon QuickSight. The role's trust policy must allow the Amazon QuickSight service principal to assume the role.
DatabaseUser (string) --
The user whose permissions and group memberships will be used by Amazon QuickSight to access the cluster. If this user already exists in your database, Amazon QuickSight is granted the same permissions that the user has. If the user doesn't exist, set the value of AutoCreateDatabaseUser to True to create a new user with PUBLIC permissions.
DatabaseGroups (list) --
A list of groups whose permissions will be granted to Amazon QuickSight to access the cluster. These permissions are combined with the permissions granted to Amazon QuickSight by the DatabaseUser. If you choose to include this parameter, the RoleArn must grant access to redshift:JoinGroup.
(string) --
AutoCreateDatabaseUser (boolean) --
Automatically creates a database user. If your database doesn't have a DatabaseUser, set this parameter to True. If there is no DatabaseUser, Amazon QuickSight can't connect to your cluster. The RoleArn that you use for this operation must grant access to redshift:CreateClusterUser to successfully create the user.
S3Parameters (dict) --
The parameters for S3.
ManifestFileLocation (dict) --
Location of the Amazon S3 manifest file. This is NULL if the manifest file was uploaded into Amazon QuickSight.
Bucket (string) --
Amazon S3 bucket.
Key (string) --
Amazon S3 key that identifies an object.
RoleArn (string) --
Use the RoleArn structure to override an account-wide role for a specific S3 data source. For example, say an account administrator has turned off all S3 access with an account-wide role. The administrator can then use RoleArn to bypass the account-wide role and allow S3 access for the single S3 data source that is specified in the structure, even if the account-wide role forbidding S3 access is still active.
ServiceNowParameters (dict) --
The parameters for ServiceNow.
SiteBaseUrl (string) --
URL of the base site.
SnowflakeParameters (dict) --
The parameters for Snowflake.
Host (string) --
Host.
Database (string) --
Database.
Warehouse (string) --
Warehouse.
SparkParameters (dict) --
The parameters for Spark.
Host (string) --
Host.
Port (integer) --
Port.
SqlServerParameters (dict) --
The parameters for SQL Server.
Host (string) --
Host.
Port (integer) --
Port.
Database (string) --
Database.
TeradataParameters (dict) --
The parameters for Teradata.
Host (string) --
Host.
Port (integer) --
Port.
Database (string) --
Database.
TwitterParameters (dict) --
The parameters for Twitter.
Query (string) --
Twitter query string.
MaxRows (integer) --
Maximum number of rows to query Twitter.
AmazonOpenSearchParameters (dict) --
The parameters for OpenSearch.
Domain (string) --
The OpenSearch domain.
ExasolParameters (dict) --
The parameters for Exasol.
Host (string) --
The hostname or IP address of the Exasol data source.
Port (integer) --
The port for the Exasol data source.
DatabricksParameters (dict) --
The parameters that are required 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.
StarburstParameters (dict) --
The parameters that are required to connect to a Starburst data source.
Host (string) --
The host name of the Starburst data source.
Port (integer) --
The port for the Starburst data source.
Catalog (string) --
The catalog name for the Starburst data source.
ProductType (string) --
The product type for the Starburst data source.
TrinoParameters (dict) --
The parameters that are required to connect to a Trino data source.
Host (string) --
The host name of the Trino data source.
Port (integer) --
The port for the Trino data source.
Catalog (string) --
The catalog name for the Trino data source.
BigQueryParameters (dict) --
The parameters that are required to connect to a Google BigQuery data source.
ProjectId (string) --
The Google Cloud Platform project ID where your datasource was created.
DataSetRegion (string) --
The storage location where you create a Google BigQuery 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) --
The port.
Database (string) --
The 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.
IAMParameters (dict) --
An optional parameter that uses IAM authentication to grant Amazon QuickSight access to your cluster. This parameter can be used instead of DataSourceCredentials.
RoleArn (string) --
Use the RoleArn structure to allow Amazon QuickSight to call redshift:GetClusterCredentials on your cluster. The calling principal must have iam:PassRole access to pass the role to Amazon QuickSight. The role's trust policy must allow the Amazon QuickSight service principal to assume the role.
DatabaseUser (string) --
The user whose permissions and group memberships will be used by Amazon QuickSight to access the cluster. If this user already exists in your database, Amazon QuickSight is granted the same permissions that the user has. If the user doesn't exist, set the value of AutoCreateDatabaseUser to True to create a new user with PUBLIC permissions.
DatabaseGroups (list) --
A list of groups whose permissions will be granted to Amazon QuickSight to access the cluster. These permissions are combined with the permissions granted to Amazon QuickSight by the DatabaseUser. If you choose to include this parameter, the RoleArn must grant access to redshift:JoinGroup.
(string) --
AutoCreateDatabaseUser (boolean) --
Automatically creates a database user. If your database doesn't have a DatabaseUser, set this parameter to True. If there is no DatabaseUser, Amazon QuickSight can't connect to your cluster. The RoleArn that you use for this operation must grant access to redshift:CreateClusterUser to successfully create the user.
S3Parameters (dict) --
The parameters for S3.
ManifestFileLocation (dict) --
Location of the Amazon S3 manifest file. This is NULL if the manifest file was uploaded into Amazon QuickSight.
Bucket (string) --
Amazon S3 bucket.
Key (string) --
Amazon S3 key that identifies an object.
RoleArn (string) --
Use the RoleArn structure to override an account-wide role for a specific S3 data source. For example, say an account administrator has turned off all S3 access with an account-wide role. The administrator can then use RoleArn to bypass the account-wide role and allow S3 access for the single S3 data source that is specified in the structure, even if the account-wide role forbidding S3 access is still active.
ServiceNowParameters (dict) --
The parameters for ServiceNow.
SiteBaseUrl (string) --
URL of the base site.
SnowflakeParameters (dict) --
The parameters for Snowflake.
Host (string) --
Host.
Database (string) --
Database.
Warehouse (string) --
Warehouse.
SparkParameters (dict) --
The parameters for Spark.
Host (string) --
Host.
Port (integer) --
Port.
SqlServerParameters (dict) --
The parameters for SQL Server.
Host (string) --
Host.
Port (integer) --
Port.
Database (string) --
Database.
TeradataParameters (dict) --
The parameters for Teradata.
Host (string) --
Host.
Port (integer) --
Port.
Database (string) --
Database.
TwitterParameters (dict) --
The parameters for Twitter.
Query (string) --
Twitter query string.
MaxRows (integer) --
Maximum number of rows to query Twitter.
AmazonOpenSearchParameters (dict) --
The parameters for OpenSearch.
Domain (string) --
The OpenSearch domain.
ExasolParameters (dict) --
The parameters for Exasol.
Host (string) --
The hostname or IP address of the Exasol data source.
Port (integer) --
The port for the Exasol data source.
DatabricksParameters (dict) --
The parameters that are required 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.
StarburstParameters (dict) --
The parameters that are required to connect to a Starburst data source.
Host (string) --
The host name of the Starburst data source.
Port (integer) --
The port for the Starburst data source.
Catalog (string) --
The catalog name for the Starburst data source.
ProductType (string) --
The product type for the Starburst data source.
TrinoParameters (dict) --
The parameters that are required to connect to a Trino data source.
Host (string) --
The host name of the Trino data source.
Port (integer) --
The port for the Trino data source.
Catalog (string) --
The catalog name for the Trino data source.
BigQueryParameters (dict) --
The parameters that are required to connect to a Google BigQuery data source.
ProjectId (string) --
The Google Cloud Platform project ID where your datasource was created.
DataSetRegion (string) --
The storage location where you create a Google BigQuery 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.
{'DataSourceSummaries': {'Type': {'STARBURST', 'BIGQUERY', 'TRINO'}}}
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'|'STARBURST'|'TRINO'|'BIGQUERY',
'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.
{'IncludePermissions': 'boolean',
'IncludeTags': 'boolean',
'ValidationStrategy': {'StrictModeForAllResources': 'boolean'}}
Starts an Asset Bundle export job.
An Asset Bundle export job exports specified Amazon QuickSight assets. You can also choose to export any asset dependencies in the same job. Export jobs run asynchronously and can be polled with a DescribeAssetBundleExportJob API call. When a job is successfully completed, a download URL that contains the exported assets is returned. The URL is valid for 5 minutes and can be refreshed with a DescribeAssetBundleExportJob API call. Each Amazon QuickSight account can run up to 5 export jobs concurrently.
The API caller must have the necessary permissions in their IAM role to access each resource before the resources can be exported.
See also: AWS API Documentation
Request Syntax
client.start_asset_bundle_export_job(
AwsAccountId='string',
AssetBundleExportJobId='string',
ResourceArns=[
'string',
],
IncludeAllDependencies=True|False,
ExportFormat='CLOUDFORMATION_JSON'|'QUICKSIGHT_JSON',
CloudFormationOverridePropertyConfiguration={
'ResourceIdOverrideConfiguration': {
'PrefixForAllResources': True|False
},
'VPCConnections': [
{
'Arn': 'string',
'Properties': [
'Name'|'DnsResolvers'|'RoleArn',
]
},
],
'RefreshSchedules': [
{
'Arn': 'string',
'Properties': [
'StartAfterDateTime',
]
},
],
'DataSources': [
{
'Arn': 'string',
'Properties': [
'Name'|'DisableSsl'|'SecretArn'|'Username'|'Password'|'Domain'|'WorkGroup'|'Host'|'Port'|'Database'|'DataSetName'|'Catalog'|'InstanceId'|'ClusterId'|'ManifestFileLocation'|'Warehouse'|'RoleArn',
]
},
],
'DataSets': [
{
'Arn': 'string',
'Properties': [
'Name',
]
},
],
'Themes': [
{
'Arn': 'string',
'Properties': [
'Name',
]
},
],
'Analyses': [
{
'Arn': 'string',
'Properties': [
'Name',
]
},
],
'Dashboards': [
{
'Arn': 'string',
'Properties': [
'Name',
]
},
]
},
IncludePermissions=True|False,
IncludeTags=True|False,
ValidationStrategy={
'StrictModeForAllResources': True|False
}
)
string
[REQUIRED]
The ID of the Amazon Web Services account to export assets from.
string
[REQUIRED]
The ID of the job. This ID is unique while the job is running. After the job is completed, you can reuse this ID for another job.
list
[REQUIRED]
An array of resource ARNs to export. The following resources are supported.
Analysis
Dashboard
DataSet
DataSource
RefreshSchedule
Theme
VPCConnection
The API caller must have the necessary permissions in their IAM role to access each resource before the resources can be exported.
(string) --
boolean
A Boolean that determines whether all dependencies of each resource ARN are recursively exported with the job. For example, say you provided a Dashboard ARN to the ResourceArns parameter. If you set IncludeAllDependencies to TRUE, any theme, dataset, and data source resource that is a dependency of the dashboard is also exported.
string
[REQUIRED]
The export data format.
dict
An optional collection of structures that generate CloudFormation parameters to override the existing resource property values when the resource is exported to a new CloudFormation template.
Use this field if the ExportFormat field of a StartAssetBundleExportJobRequest API call is set to CLOUDFORMATION_JSON.
ResourceIdOverrideConfiguration (dict) --
An optional list of structures that control how resource IDs are parameterized in the returned CloudFormation template.
PrefixForAllResources (boolean) --
An option to request a CloudFormation variable for a prefix to be prepended to each resource's ID before import. The prefix is only added to the asset IDs and does not change the name of the asset.
VPCConnections (list) --
An optional list of structures that control how VPCConnection resources are parameterized in the returned CloudFormation template.
(dict) --
Controls how a specific VPCConnection resource is parameterized in the outputted CloudFormation template.
Arn (string) -- [REQUIRED]
The ARN of the specific VPCConnection resource whose override properties are configured in this structure.
Properties (list) -- [REQUIRED]
A list of VPCConnection resource properties to generate variables for in the returned CloudFormation template.
(string) --
RefreshSchedules (list) --
An optional list of structures that control how RefreshSchedule resources are parameterized in the returned CloudFormation template.
(dict) --
Controls how a specific RefreshSchedule resource is parameterized in the returned CloudFormation template.
Arn (string) -- [REQUIRED]
The ARN of the specific RefreshSchedule resource whose override properties are configured in this structure.
Properties (list) -- [REQUIRED]
A list of RefreshSchedule resource properties to generate variables for in the returned CloudFormation template.
(string) --
DataSources (list) --
An optional list of structures that control how DataSource resources are parameterized in the returned CloudFormation template.
(dict) --
Controls how a specific DataSource resource is parameterized in the returned CloudFormation template.
Arn (string) -- [REQUIRED]
The ARN of the specific DataSource resource whose override properties are configured in this structure.
Properties (list) -- [REQUIRED]
A list of DataSource resource properties to generate variables for in the returned CloudFormation template.
(string) --
DataSets (list) --
An optional list of structures that control how DataSet resources are parameterized in the returned CloudFormation template.
(dict) --
Controls how a specific DataSet resource is parameterized in the returned CloudFormation template.
Arn (string) -- [REQUIRED]
The ARN of the specific DataSet resource whose override properties are configured in this structure.
Properties (list) -- [REQUIRED]
A list of DataSet resource properties to generate variables for in the returned CloudFormation template.
(string) --
Themes (list) --
An optional list of structures that control how Theme resources are parameterized in the returned CloudFormation template.
(dict) --
Controls how a specific Theme resource is parameterized in the returned CloudFormation template.
Arn (string) -- [REQUIRED]
The ARN of the specific Theme resource whose override properties are configured in this structure.
Properties (list) -- [REQUIRED]
A list of Theme resource properties to generate variables for in the returned CloudFormation template.
(string) --
Analyses (list) --
An optional list of structures that control how Analysis resources are parameterized in the returned CloudFormation template.
(dict) --
Controls how a specific Analysis resource is parameterized in the returned CloudFormation template.
Arn (string) -- [REQUIRED]
The ARN of the specific Analysis resource whose override properties are configured in this structure.
Properties (list) -- [REQUIRED]
A list of Analysis resource properties to generate variables for in the returned CloudFormation template.
(string) --
Dashboards (list) --
An optional list of structures that control how Dashboard resources are parameterized in the returned CloudFormation template.
(dict) --
Controls how a specific Dashboard resource is parameterized in the returned CloudFormation template.
Arn (string) -- [REQUIRED]
The ARN of the specific Dashboard resource whose override properties are configured in this structure.
Properties (list) -- [REQUIRED]
A list of Dashboard resource properties to generate variables for in the returned CloudFormation template.
(string) --
boolean
A Boolean that determines whether all permissions for each resource ARN are exported with the job. If you set IncludePermissions to TRUE, any permissions associated with each resource are exported.
boolean
A Boolean that determines whether all tags for each resource ARN are exported with the job. If you set IncludeTags to TRUE, any tags associated with each resource are exported.
dict
An optional parameter that determines which validation strategy to use for the export job. If StrictModeForAllResources is set to TRUE, strict validation for every error is enforced. If it is set to FALSE, validation is skipped for specific UI errors that are shown as warnings. The default value for StrictModeForAllResources is FALSE.
StrictModeForAllResources (boolean) --
A Boolean value that indicates whether to export resources under strict or lenient mode.
dict
Response Syntax
{
'Arn': 'string',
'AssetBundleExportJobId': 'string',
'RequestId': 'string',
'Status': 123
}
Response Structure
(dict) --
Arn (string) --
The Amazon Resource Name (ARN) for the export job.
AssetBundleExportJobId (string) --
The ID of the job. This ID is unique while the job is running. After the job is completed, you can reuse this ID for another job.
RequestId (string) --
The Amazon Web Services response ID for this operation.
Status (integer) --
The HTTP status of the response.
{'OverrideParameters': {'DataSources': {'DataSourceParameters': {'BigQueryParameters': {'DataSetRegion': 'string',
'ProjectId': 'string'}}}},
'OverridePermissions': {'Analyses': [{'AnalysisIds': ['string'],
'Permissions': {'Actions': ['string'],
'Principals': ['string']}}],
'Dashboards': [{'DashboardIds': ['string'],
'LinkSharingConfiguration': {'Permissions': {'Actions': ['string'],
'Principals': ['string']}},
'Permissions': {'Actions': ['string'],
'Principals': ['string']}}],
'DataSets': [{'DataSetIds': ['string'],
'Permissions': {'Actions': ['string'],
'Principals': ['string']}}],
'DataSources': [{'DataSourceIds': ['string'],
'Permissions': {'Actions': ['string'],
'Principals': ['string']}}],
'Themes': [{'Permissions': {'Actions': ['string'],
'Principals': ['string']},
'ThemeIds': ['string']}]},
'OverrideTags': {'Analyses': [{'AnalysisIds': ['string'],
'Tags': [{'Key': 'string',
'Value': 'string'}]}],
'Dashboards': [{'DashboardIds': ['string'],
'Tags': [{'Key': 'string',
'Value': 'string'}]}],
'DataSets': [{'DataSetIds': ['string'],
'Tags': [{'Key': 'string',
'Value': 'string'}]}],
'DataSources': [{'DataSourceIds': ['string'],
'Tags': [{'Key': 'string',
'Value': 'string'}]}],
'Themes': [{'Tags': [{'Key': 'string', 'Value': 'string'}],
'ThemeIds': ['string']}],
'VPCConnections': [{'Tags': [{'Key': 'string',
'Value': 'string'}],
'VPCConnectionIds': ['string']}]},
'OverrideValidationStrategy': {'StrictModeForAllResources': 'boolean'}}
Starts an Asset Bundle import job.
An Asset Bundle import job imports specified Amazon QuickSight assets into an Amazon QuickSight account. You can also choose to import a naming prefix and specified configuration overrides. The assets that are contained in the bundle file that you provide are used to create or update a new or existing asset in your Amazon QuickSight account. Each Amazon QuickSight account can run up to 5 import jobs concurrently.
The API caller must have the necessary "create", "describe", and "update" permissions in their IAM role to access each resource type that is contained in the bundle file before the resources can be imported.
See also: AWS API Documentation
Request Syntax
client.start_asset_bundle_import_job(
AwsAccountId='string',
AssetBundleImportJobId='string',
AssetBundleImportSource={
'Body': b'bytes',
'S3Uri': 'string'
},
OverrideParameters={
'ResourceIdOverrideConfiguration': {
'PrefixForAllResources': 'string'
},
'VPCConnections': [
{
'VPCConnectionId': 'string',
'Name': 'string',
'SubnetIds': [
'string',
],
'SecurityGroupIds': [
'string',
],
'DnsResolvers': [
'string',
],
'RoleArn': 'string'
},
],
'RefreshSchedules': [
{
'DataSetId': 'string',
'ScheduleId': 'string',
'StartAfterDateTime': datetime(2015, 1, 1)
},
],
'DataSources': [
{
'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',
'IAMParameters': {
'RoleArn': 'string',
'DatabaseUser': 'string',
'DatabaseGroups': [
'string',
],
'AutoCreateDatabaseUser': True|False
}
},
'S3Parameters': {
'ManifestFileLocation': {
'Bucket': 'string',
'Key': 'string'
},
'RoleArn': 'string'
},
'ServiceNowParameters': {
'SiteBaseUrl': 'string'
},
'SnowflakeParameters': {
'Host': 'string',
'Database': 'string',
'Warehouse': 'string'
},
'SparkParameters': {
'Host': 'string',
'Port': 123
},
'SqlServerParameters': {
'Host': 'string',
'Port': 123,
'Database': 'string'
},
'TeradataParameters': {
'Host': 'string',
'Port': 123,
'Database': 'string'
},
'TwitterParameters': {
'Query': 'string',
'MaxRows': 123
},
'AmazonOpenSearchParameters': {
'Domain': 'string'
},
'ExasolParameters': {
'Host': 'string',
'Port': 123
},
'DatabricksParameters': {
'Host': 'string',
'Port': 123,
'SqlEndpointPath': 'string'
},
'StarburstParameters': {
'Host': 'string',
'Port': 123,
'Catalog': 'string',
'ProductType': 'GALAXY'|'ENTERPRISE'
},
'TrinoParameters': {
'Host': 'string',
'Port': 123,
'Catalog': 'string'
},
'BigQueryParameters': {
'ProjectId': 'string',
'DataSetRegion': 'string'
}
},
'VpcConnectionProperties': {
'VpcConnectionArn': 'string'
},
'SslProperties': {
'DisableSsl': True|False
},
'Credentials': {
'CredentialPair': {
'Username': 'string',
'Password': 'string'
},
'SecretArn': 'string'
}
},
],
'DataSets': [
{
'DataSetId': 'string',
'Name': 'string'
},
],
'Themes': [
{
'ThemeId': 'string',
'Name': 'string'
},
],
'Analyses': [
{
'AnalysisId': 'string',
'Name': 'string'
},
],
'Dashboards': [
{
'DashboardId': 'string',
'Name': 'string'
},
]
},
FailureAction='DO_NOTHING'|'ROLLBACK',
OverridePermissions={
'DataSources': [
{
'DataSourceIds': [
'string',
],
'Permissions': {
'Principals': [
'string',
],
'Actions': [
'string',
]
}
},
],
'DataSets': [
{
'DataSetIds': [
'string',
],
'Permissions': {
'Principals': [
'string',
],
'Actions': [
'string',
]
}
},
],
'Themes': [
{
'ThemeIds': [
'string',
],
'Permissions': {
'Principals': [
'string',
],
'Actions': [
'string',
]
}
},
],
'Analyses': [
{
'AnalysisIds': [
'string',
],
'Permissions': {
'Principals': [
'string',
],
'Actions': [
'string',
]
}
},
],
'Dashboards': [
{
'DashboardIds': [
'string',
],
'Permissions': {
'Principals': [
'string',
],
'Actions': [
'string',
]
},
'LinkSharingConfiguration': {
'Permissions': {
'Principals': [
'string',
],
'Actions': [
'string',
]
}
}
},
]
},
OverrideTags={
'VPCConnections': [
{
'VPCConnectionIds': [
'string',
],
'Tags': [
{
'Key': 'string',
'Value': 'string'
},
]
},
],
'DataSources': [
{
'DataSourceIds': [
'string',
],
'Tags': [
{
'Key': 'string',
'Value': 'string'
},
]
},
],
'DataSets': [
{
'DataSetIds': [
'string',
],
'Tags': [
{
'Key': 'string',
'Value': 'string'
},
]
},
],
'Themes': [
{
'ThemeIds': [
'string',
],
'Tags': [
{
'Key': 'string',
'Value': 'string'
},
]
},
],
'Analyses': [
{
'AnalysisIds': [
'string',
],
'Tags': [
{
'Key': 'string',
'Value': 'string'
},
]
},
],
'Dashboards': [
{
'DashboardIds': [
'string',
],
'Tags': [
{
'Key': 'string',
'Value': 'string'
},
]
},
]
},
OverrideValidationStrategy={
'StrictModeForAllResources': True|False
}
)
string
[REQUIRED]
The ID of the Amazon Web Services account to import assets into.
string
[REQUIRED]
The ID of the job. This ID is unique while the job is running. After the job is completed, you can reuse this ID for another job.
dict
[REQUIRED]
The source of the asset bundle zip file that contains the data that you want to import. The file must be in QUICKSIGHT_JSON format.
Body (bytes) --
The bytes of the base64 encoded asset bundle import zip file. This file can't exceed 20 MB.
If you are calling the API operations from the Amazon Web Services SDK for Java, JavaScript, Python, or PHP, the SDK encodes base64 automatically to allow the direct setting of the zip file's bytes. If you are using an SDK for a different language or receiving related errors, try to base64 encode your data.
S3Uri (string) --
The Amazon S3 URI for an asset bundle import file that exists in an Amazon S3 bucket that the caller has read access to. The file must be a zip format file and can't exceed 20 MB.
dict
Optional overrides that are applied to the resource configuration before import.
ResourceIdOverrideConfiguration (dict) --
An optional structure that configures resource ID overrides to be applied within the import job.
PrefixForAllResources (string) --
An option to request a CloudFormation variable for a prefix to be prepended to each resource's ID before import. The prefix is only added to the asset IDs and does not change the name of the asset.
VPCConnections (list) --
A list of overrides for any VPCConnection resources that are present in the asset bundle that is imported.
(dict) --
The override parameters for a single VPC connection that is imported.
VPCConnectionId (string) -- [REQUIRED]
The ID of the VPC Connection to apply overrides to.
Name (string) --
A new name for the VPC connection.
SubnetIds (list) --
A list of new subnet IDs for the VPC connection you are importing. This field is required if you are importing the VPC connection from another Amazon Web Services account or Region.
(string) --
SecurityGroupIds (list) --
A new security group ID for the VPC connection you are importing. This field is required if you are importing the VPC connection from another Amazon Web Services account or Region.
(string) --
DnsResolvers (list) --
An optional override of DNS resolvers to be used by the VPC connection.
(string) --
RoleArn (string) --
An optional override of the role ARN to be used by the VPC connection.
RefreshSchedules (list) --
A list of overrides for any RefreshSchedule resources that are present in the asset bundle that is imported.
(dict) --
A list of overrides for a specific RefreshsSchedule resource that is present in the asset bundle that is imported.
DataSetId (string) -- [REQUIRED]
A partial identifier for the specific RefreshSchedule resource that is being overridden. This structure is used together with the ScheduleID structure.
ScheduleId (string) -- [REQUIRED]
A partial identifier for the specific RefreshSchedule resource being overridden. This structure is used together with the DataSetId structure.
StartAfterDateTime (datetime) --
An override for the StartAfterDateTime of a RefreshSchedule. Make sure that the StartAfterDateTime is set to a time that takes place in the future.
DataSources (list) --
A list of overrides for any DataSource resources that are present in the asset bundle that is imported.
(dict) --
The override parameters for a single data source that is being imported.
DataSourceId (string) -- [REQUIRED]
The ID of the data source to apply overrides to.
Name (string) --
A new name for the data source.
DataSourceParameters (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]
The port.
Database (string) -- [REQUIRED]
The 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.
IAMParameters (dict) --
An optional parameter that uses IAM authentication to grant Amazon QuickSight access to your cluster. This parameter can be used instead of DataSourceCredentials.
RoleArn (string) -- [REQUIRED]
Use the RoleArn structure to allow Amazon QuickSight to call redshift:GetClusterCredentials on your cluster. The calling principal must have iam:PassRole access to pass the role to Amazon QuickSight. The role's trust policy must allow the Amazon QuickSight service principal to assume the role.
DatabaseUser (string) -- [REQUIRED]
The user whose permissions and group memberships will be used by Amazon QuickSight to access the cluster. If this user already exists in your database, Amazon QuickSight is granted the same permissions that the user has. If the user doesn't exist, set the value of AutoCreateDatabaseUser to True to create a new user with PUBLIC permissions.
DatabaseGroups (list) --
A list of groups whose permissions will be granted to Amazon QuickSight to access the cluster. These permissions are combined with the permissions granted to Amazon QuickSight by the DatabaseUser. If you choose to include this parameter, the RoleArn must grant access to redshift:JoinGroup.
(string) --
AutoCreateDatabaseUser (boolean) --
Automatically creates a database user. If your database doesn't have a DatabaseUser, set this parameter to True. If there is no DatabaseUser, Amazon QuickSight can't connect to your cluster. The RoleArn that you use for this operation must grant access to redshift:CreateClusterUser to successfully create the user.
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.
RoleArn (string) --
Use the RoleArn structure to override an account-wide role for a specific S3 data source. For example, say an account administrator has turned off all S3 access with an account-wide role. The administrator can then use RoleArn to bypass the account-wide role and allow S3 access for the single S3 data source that is specified in the structure, even if the account-wide role forbidding S3 access is still active.
ServiceNowParameters (dict) --
The parameters for ServiceNow.
SiteBaseUrl (string) -- [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 parameters that are required 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.
StarburstParameters (dict) --
The parameters that are required to connect to a Starburst data source.
Host (string) -- [REQUIRED]
The host name of the Starburst data source.
Port (integer) -- [REQUIRED]
The port for the Starburst data source.
Catalog (string) -- [REQUIRED]
The catalog name for the Starburst data source.
ProductType (string) --
The product type for the Starburst data source.
TrinoParameters (dict) --
The parameters that are required to connect to a Trino data source.
Host (string) -- [REQUIRED]
The host name of the Trino data source.
Port (integer) -- [REQUIRED]
The port for the Trino data source.
Catalog (string) -- [REQUIRED]
The catalog name for the Trino data source.
BigQueryParameters (dict) --
The parameters that are required to connect to a Google BigQuery data source.
ProjectId (string) -- [REQUIRED]
The Google Cloud Platform project ID where your datasource was created.
DataSetRegion (string) --
The storage location where you create a Google BigQuery data source.
VpcConnectionProperties (dict) --
VPC connection properties.
VpcConnectionArn (string) -- [REQUIRED]
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 data source.
DisableSsl (boolean) --
A Boolean option to control whether SSL should be disabled.
Credentials (dict) --
An optional structure that provides the credentials to be used to create the imported data source.
CredentialPair (dict) --
A username and password credential pair to be used to create the imported data source. Keep this field blank if you are using a Secrets Manager secret to provide credentials.
Username (string) -- [REQUIRED]
The username for the data source connection.
Password (string) -- [REQUIRED]
The password for the data source connection.
SecretArn (string) --
The ARN of the Secrets Manager secret that's used to create the imported data source. Keep this field blank, unless you are using a secret in place of a credential pair.
DataSets (list) --
A list of overrides for any DataSet resources that are present in the asset bundle that is imported.
(dict) --
The override parameters for a single dataset that is being imported.
DataSetId (string) -- [REQUIRED]
The ID of the dataset to apply overrides to.
Name (string) --
A new name for the dataset.
Themes (list) --
A list of overrides for any Theme resources that are present in the asset bundle that is imported.
(dict) --
The override parameters for a single theme that is imported.
ThemeId (string) -- [REQUIRED]
The ID of the theme to apply overrides to.
Name (string) --
A new name for the theme.
Analyses (list) --
A list of overrides for any Analysis resources that are present in the asset bundle that is imported.
(dict) --
The override parameters for a single analysis that is being imported.
AnalysisId (string) -- [REQUIRED]
The ID of the analysis that you ant to apply overrides to.
Name (string) --
A new name for the analysis.
Dashboards (list) --
A list of overrides for any Dashboard resources that are present in the asset bundle that is imported.
(dict) --
The override parameters for a single dashboard that is being imported.
DashboardId (string) -- [REQUIRED]
The ID of the dashboard that you want to apply overrides to.
Name (string) --
A new name for the dashboard.
string
The failure action for the import job.
If you choose ROLLBACK, failed import jobs will attempt to undo any asset changes caused by the failed job.
If you choose DO_NOTHING, failed import jobs will not attempt to roll back any asset changes caused by the failed job, possibly keeping the Amazon QuickSight account in an inconsistent state.
dict
Optional permission overrides that are applied to the resource configuration before import.
DataSources (list) --
A list of permissions overrides for any DataSource resources that are present in the asset bundle that is imported.
(dict) --
An object that contains a list of permissions to be applied to a list of data source IDs.
DataSourceIds (list) -- [REQUIRED]
A list of data source IDs that you want to apply overrides to. You can use * to override all data sources in this asset bundle.
(string) --
Permissions (dict) -- [REQUIRED]
A list of permissions for the data source that you want to apply overrides to.
Principals (list) -- [REQUIRED]
A list of principals to grant permissions on.
(string) --
Actions (list) -- [REQUIRED]
A list of IAM actions to grant permissions on.
(string) --
DataSets (list) --
A list of permissions overrides for any DataSet resources that are present in the asset bundle that is imported.
(dict) --
An object that contains a list of permissions to be applied to a list of dataset IDs.
DataSetIds (list) -- [REQUIRED]
A list of dataset IDs that you want to apply overrides to. You can use * to override all datasets in this asset bundle.
(string) --
Permissions (dict) -- [REQUIRED]
A list of permissions for the datasets that you want to apply overrides to.
Principals (list) -- [REQUIRED]
A list of principals to grant permissions on.
(string) --
Actions (list) -- [REQUIRED]
A list of IAM actions to grant permissions on.
(string) --
Themes (list) --
A list of permissions overrides for any Theme resources that are present in the asset bundle that is imported.
(dict) --
An object that contains a list of permissions to be applied to a list of theme IDs.
ThemeIds (list) -- [REQUIRED]
A list of theme IDs that you want to apply overrides to. You can use * to override all themes in this asset bundle.
(string) --
Permissions (dict) -- [REQUIRED]
A list of permissions for the themes that you want to apply overrides to.
Principals (list) -- [REQUIRED]
A list of principals to grant permissions on.
(string) --
Actions (list) -- [REQUIRED]
A list of IAM actions to grant permissions on.
(string) --
Analyses (list) --
A list of permissions overrides for any Analysis resources that are present in the asset bundle that is imported.
(dict) --
An object that contains a list of permissions to be applied to a list of analysis IDs.
AnalysisIds (list) -- [REQUIRED]
A list of analysis IDs that you want to apply overrides to. You can use * to override all analyses in this asset bundle.
(string) --
Permissions (dict) -- [REQUIRED]
A list of permissions for the analyses that you want to apply overrides to.
Principals (list) -- [REQUIRED]
A list of principals to grant permissions on.
(string) --
Actions (list) -- [REQUIRED]
A list of IAM actions to grant permissions on.
(string) --
Dashboards (list) --
A list of permissions overrides for any Dashboard resources that are present in the asset bundle that is imported.
(dict) --
An object that contains a list of permissions to be applied to a list of dashboard IDs.
DashboardIds (list) -- [REQUIRED]
A list of dashboard IDs that you want to apply overrides to. You can use * to override all dashboards in this asset bundle.
(string) --
Permissions (dict) --
A list of permissions for the dashboards that you want to apply overrides to.
Principals (list) -- [REQUIRED]
A list of principals to grant permissions on.
(string) --
Actions (list) -- [REQUIRED]
A list of IAM actions to grant permissions on.
(string) --
LinkSharingConfiguration (dict) --
A structure that contains the link sharing configurations that you want to apply overrides to.
Permissions (dict) --
A list of link sharing permissions for the dashboards that you want to apply overrides to.
Principals (list) -- [REQUIRED]
A list of principals to grant permissions on.
(string) --
Actions (list) -- [REQUIRED]
A list of IAM actions to grant permissions on.
(string) --
dict
Optional tag overrides that are applied to the resource configuration before import.
VPCConnections (list) --
A list of tag overrides for any VPCConnection resources that are present in the asset bundle that is imported.
(dict) --
An object that contains a list of tags to be assigned to a list of VPC connection IDs.
VPCConnectionIds (list) -- [REQUIRED]
A list of VPC connection IDs that you want to apply overrides to. You can use * to override all VPC connections in this asset bundle.
(string) --
Tags (list) -- [REQUIRED]
A list of tags for the VPC connections that you want to apply overrides to.
(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.
DataSources (list) --
A list of tag overrides for any DataSource resources that are present in the asset bundle that is imported.
(dict) --
An object that contains a list of tags to be assigned to a list of data source IDs.
DataSourceIds (list) -- [REQUIRED]
A list of data source IDs that you want to apply overrides to. You can use * to override all data sources in this asset bundle.
(string) --
Tags (list) -- [REQUIRED]
A list of tags for the data source that you want to apply overrides to.
(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.
DataSets (list) --
A list of tag overrides for any DataSet resources that are present in the asset bundle that is imported.
(dict) --
An object that contains a list of tags to be assigned to a list of dataset IDs.
DataSetIds (list) -- [REQUIRED]
A list of dataset IDs that you want to apply overrides to. You can use * to override all datasets in this asset bundle.
(string) --
Tags (list) -- [REQUIRED]
A list of tags for the datasets that you want to apply overrides to.
(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.
Themes (list) --
A list of tag overrides for any Theme resources that are present in the asset bundle that is imported.
(dict) --
An object that contains a list of tags to be assigned to a list of theme IDs.
ThemeIds (list) -- [REQUIRED]
A list of theme IDs that you want to apply overrides to. You can use * to override all themes in this asset bundle.
(string) --
Tags (list) -- [REQUIRED]
A list of tags for the themes that you want to apply overrides to.
(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.
Analyses (list) --
A list of tag overrides for any Analysis resources that are present in the asset bundle that is imported.
(dict) --
An object that contains a list of tags to be assigned to a list of analysis IDs.
AnalysisIds (list) -- [REQUIRED]
A list of analysis IDs that you want to apply overrides to. You can use * to override all analyses in this asset bundle.
(string) --
Tags (list) -- [REQUIRED]
A list of tags for the analyses that you want to apply overrides to.
(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.
Dashboards (list) --
A list of tag overrides for any Dashboard resources that are present in the asset bundle that is imported.
(dict) --
An object that contains a list of tags to be assigned to a list of dashboard IDs.
DashboardIds (list) -- [REQUIRED]
A list of dashboard IDs that you want to apply overrides to. You can use * to override all dashboards in this asset bundle.
(string) --
Tags (list) -- [REQUIRED]
A list of tags for the dashboards that you want to apply overrides to.
(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
An optional validation strategy override for all analyses and dashboards that is applied to the resource configuration before import.
StrictModeForAllResources (boolean) --
A Boolean value that indicates whether to import all analyses and dashboards under strict or lenient mode.
dict
Response Syntax
{
'Arn': 'string',
'AssetBundleImportJobId': 'string',
'RequestId': 'string',
'Status': 123
}
Response Structure
(dict) --
Arn (string) --
The Amazon Resource Name (ARN) for the import job.
AssetBundleImportJobId (string) --
The ID of the job. This ID is unique while the job is running. After the job is completed, you can reuse this ID for another job.
RequestId (string) --
The Amazon Web Services response ID for this operation.
Status (integer) --
The HTTP status of the response.
{'Credentials': {'CredentialPair': {'AlternateDataSourceParameters': {'BigQueryParameters': {'DataSetRegion': 'string',
'ProjectId': 'string'}}}},
'DataSourceParameters': {'BigQueryParameters': {'DataSetRegion': 'string',
'ProjectId': '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',
'IAMParameters': {
'RoleArn': 'string',
'DatabaseUser': 'string',
'DatabaseGroups': [
'string',
],
'AutoCreateDatabaseUser': True|False
}
},
'S3Parameters': {
'ManifestFileLocation': {
'Bucket': 'string',
'Key': 'string'
},
'RoleArn': 'string'
},
'ServiceNowParameters': {
'SiteBaseUrl': 'string'
},
'SnowflakeParameters': {
'Host': 'string',
'Database': 'string',
'Warehouse': 'string'
},
'SparkParameters': {
'Host': 'string',
'Port': 123
},
'SqlServerParameters': {
'Host': 'string',
'Port': 123,
'Database': 'string'
},
'TeradataParameters': {
'Host': 'string',
'Port': 123,
'Database': 'string'
},
'TwitterParameters': {
'Query': 'string',
'MaxRows': 123
},
'AmazonOpenSearchParameters': {
'Domain': 'string'
},
'ExasolParameters': {
'Host': 'string',
'Port': 123
},
'DatabricksParameters': {
'Host': 'string',
'Port': 123,
'SqlEndpointPath': 'string'
},
'StarburstParameters': {
'Host': 'string',
'Port': 123,
'Catalog': 'string',
'ProductType': 'GALAXY'|'ENTERPRISE'
},
'TrinoParameters': {
'Host': 'string',
'Port': 123,
'Catalog': 'string'
},
'BigQueryParameters': {
'ProjectId': 'string',
'DataSetRegion': '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',
'IAMParameters': {
'RoleArn': 'string',
'DatabaseUser': 'string',
'DatabaseGroups': [
'string',
],
'AutoCreateDatabaseUser': True|False
}
},
'S3Parameters': {
'ManifestFileLocation': {
'Bucket': 'string',
'Key': 'string'
},
'RoleArn': 'string'
},
'ServiceNowParameters': {
'SiteBaseUrl': 'string'
},
'SnowflakeParameters': {
'Host': 'string',
'Database': 'string',
'Warehouse': 'string'
},
'SparkParameters': {
'Host': 'string',
'Port': 123
},
'SqlServerParameters': {
'Host': 'string',
'Port': 123,
'Database': 'string'
},
'TeradataParameters': {
'Host': 'string',
'Port': 123,
'Database': 'string'
},
'TwitterParameters': {
'Query': 'string',
'MaxRows': 123
},
'AmazonOpenSearchParameters': {
'Domain': 'string'
},
'ExasolParameters': {
'Host': 'string',
'Port': 123
},
'DatabricksParameters': {
'Host': 'string',
'Port': 123,
'SqlEndpointPath': 'string'
},
'StarburstParameters': {
'Host': 'string',
'Port': 123,
'Catalog': 'string',
'ProductType': 'GALAXY'|'ENTERPRISE'
},
'TrinoParameters': {
'Host': 'string',
'Port': 123,
'Catalog': 'string'
},
'BigQueryParameters': {
'ProjectId': 'string',
'DataSetRegion': '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]
The port.
Database (string) -- [REQUIRED]
The 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.
IAMParameters (dict) --
An optional parameter that uses IAM authentication to grant Amazon QuickSight access to your cluster. This parameter can be used instead of DataSourceCredentials.
RoleArn (string) -- [REQUIRED]
Use the RoleArn structure to allow Amazon QuickSight to call redshift:GetClusterCredentials on your cluster. The calling principal must have iam:PassRole access to pass the role to Amazon QuickSight. The role's trust policy must allow the Amazon QuickSight service principal to assume the role.
DatabaseUser (string) -- [REQUIRED]
The user whose permissions and group memberships will be used by Amazon QuickSight to access the cluster. If this user already exists in your database, Amazon QuickSight is granted the same permissions that the user has. If the user doesn't exist, set the value of AutoCreateDatabaseUser to True to create a new user with PUBLIC permissions.
DatabaseGroups (list) --
A list of groups whose permissions will be granted to Amazon QuickSight to access the cluster. These permissions are combined with the permissions granted to Amazon QuickSight by the DatabaseUser. If you choose to include this parameter, the RoleArn must grant access to redshift:JoinGroup.
(string) --
AutoCreateDatabaseUser (boolean) --
Automatically creates a database user. If your database doesn't have a DatabaseUser, set this parameter to True. If there is no DatabaseUser, Amazon QuickSight can't connect to your cluster. The RoleArn that you use for this operation must grant access to redshift:CreateClusterUser to successfully create the user.
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.
RoleArn (string) --
Use the RoleArn structure to override an account-wide role for a specific S3 data source. For example, say an account administrator has turned off all S3 access with an account-wide role. The administrator can then use RoleArn to bypass the account-wide role and allow S3 access for the single S3 data source that is specified in the structure, even if the account-wide role forbidding S3 access is still active.
ServiceNowParameters (dict) --
The parameters for ServiceNow.
SiteBaseUrl (string) -- [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 parameters that are required 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.
StarburstParameters (dict) --
The parameters that are required to connect to a Starburst data source.
Host (string) -- [REQUIRED]
The host name of the Starburst data source.
Port (integer) -- [REQUIRED]
The port for the Starburst data source.
Catalog (string) -- [REQUIRED]
The catalog name for the Starburst data source.
ProductType (string) --
The product type for the Starburst data source.
TrinoParameters (dict) --
The parameters that are required to connect to a Trino data source.
Host (string) -- [REQUIRED]
The host name of the Trino data source.
Port (integer) -- [REQUIRED]
The port for the Trino data source.
Catalog (string) -- [REQUIRED]
The catalog name for the Trino data source.
BigQueryParameters (dict) --
The parameters that are required to connect to a Google BigQuery data source.
ProjectId (string) -- [REQUIRED]
The Google Cloud Platform project ID where your datasource was created.
DataSetRegion (string) --
The storage location where you create a Google BigQuery 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]
The port.
Database (string) -- [REQUIRED]
The 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.
IAMParameters (dict) --
An optional parameter that uses IAM authentication to grant Amazon QuickSight access to your cluster. This parameter can be used instead of DataSourceCredentials.
RoleArn (string) -- [REQUIRED]
Use the RoleArn structure to allow Amazon QuickSight to call redshift:GetClusterCredentials on your cluster. The calling principal must have iam:PassRole access to pass the role to Amazon QuickSight. The role's trust policy must allow the Amazon QuickSight service principal to assume the role.
DatabaseUser (string) -- [REQUIRED]
The user whose permissions and group memberships will be used by Amazon QuickSight to access the cluster. If this user already exists in your database, Amazon QuickSight is granted the same permissions that the user has. If the user doesn't exist, set the value of AutoCreateDatabaseUser to True to create a new user with PUBLIC permissions.
DatabaseGroups (list) --
A list of groups whose permissions will be granted to Amazon QuickSight to access the cluster. These permissions are combined with the permissions granted to Amazon QuickSight by the DatabaseUser. If you choose to include this parameter, the RoleArn must grant access to redshift:JoinGroup.
(string) --
AutoCreateDatabaseUser (boolean) --
Automatically creates a database user. If your database doesn't have a DatabaseUser, set this parameter to True. If there is no DatabaseUser, Amazon QuickSight can't connect to your cluster. The RoleArn that you use for this operation must grant access to redshift:CreateClusterUser to successfully create the user.
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.
RoleArn (string) --
Use the RoleArn structure to override an account-wide role for a specific S3 data source. For example, say an account administrator has turned off all S3 access with an account-wide role. The administrator can then use RoleArn to bypass the account-wide role and allow S3 access for the single S3 data source that is specified in the structure, even if the account-wide role forbidding S3 access is still active.
ServiceNowParameters (dict) --
The parameters for ServiceNow.
SiteBaseUrl (string) -- [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 parameters that are required 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.
StarburstParameters (dict) --
The parameters that are required to connect to a Starburst data source.
Host (string) -- [REQUIRED]
The host name of the Starburst data source.
Port (integer) -- [REQUIRED]
The port for the Starburst data source.
Catalog (string) -- [REQUIRED]
The catalog name for the Starburst data source.
ProductType (string) --
The product type for the Starburst data source.
TrinoParameters (dict) --
The parameters that are required to connect to a Trino data source.
Host (string) -- [REQUIRED]
The host name of the Trino data source.
Port (integer) -- [REQUIRED]
The port for the Trino data source.
Catalog (string) -- [REQUIRED]
The catalog name for the Trino data source.
BigQueryParameters (dict) --
The parameters that are required to connect to a Google BigQuery data source.
ProjectId (string) -- [REQUIRED]
The Google Cloud Platform project ID where your datasource was created.
DataSetRegion (string) --
The storage location where you create a Google BigQuery 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.