2026/07/10 - Amazon QuickSight - 2 new 8 updated api methods
Changes Provides CreateKnowledgeBase and UpdateKnowledgeBase APIs
Updates the properties of an existing knowledge base.
See also: AWS API Documentation
Request Syntax
client.update_knowledge_base(
AwsAccountId='string',
KnowledgeBaseId='string',
Name='string',
Description='string',
KnowledgeBaseConfiguration={
'templateConfiguration': {
'template': {...}|[...]|123|123.4|'string'|True|None
}
},
MediaExtractionConfiguration={
'imageExtractionConfiguration': {
'imageExtractionStatus': 'ENABLED'|'DISABLED'
},
'audioExtractionConfiguration': {
'audioExtractionStatus': 'ENABLED'|'DISABLED'
},
'videoExtractionConfiguration': {
'videoExtractionStatus': 'ENABLED'|'DISABLED',
'videoExtractionType': 'AUDIO_TRANSCRIPTION_ONLY'|'VISUAL_CONTENT_AND_AUDIO_TRANSCRIPTION'
}
},
IsEmailNotificationOptedForIngestionFailures=True|False,
AccessControlConfiguration={
'isACLEnabled': True|False
}
)
string
[REQUIRED]
The ID of the Amazon Web Services account that contains the knowledge base.
string
[REQUIRED]
The unique identifier for the knowledge base.
string
The name of the knowledge base. If you don't specify a name, the existing name is retained.
string
A description for the knowledge base. If you don't specify a description, the existing description is retained.
dict
The configuration settings for a knowledge base.
templateConfiguration (dict) --
The template configuration for the knowledge base.
template (:ref:`document<document>`) --
The template document that defines the knowledge base behavior.
dict
The configuration for media extraction from knowledge base documents.
imageExtractionConfiguration (dict) --
The configuration for image extraction.
imageExtractionStatus (string) -- [REQUIRED]
The status of image extraction. Valid values are ENABLED and DISABLED.
audioExtractionConfiguration (dict) --
The configuration for audio extraction.
audioExtractionStatus (string) -- [REQUIRED]
The status of audio extraction. Valid values are ENABLED and DISABLED.
videoExtractionConfiguration (dict) --
The configuration for video extraction.
videoExtractionStatus (string) -- [REQUIRED]
The status of video extraction. Valid values are ENABLED and DISABLED.
videoExtractionType (string) --
The type of video extraction to perform.
boolean
Specifies whether email notifications are enabled for ingestion failures.
dict
The access control configuration for the knowledge base. If you don't specify this parameter, the existing setting is retained.
isACLEnabled (boolean) --
Specifies whether ACLs are enabled for the knowledge base.
dict
Response Syntax
{
'KnowledgeBaseArn': 'string',
'KnowledgeBaseId': 'string',
'RequestId': 'string',
'Status': 123
}
Response Structure
(dict) --
KnowledgeBaseArn (string) --
The Amazon Resource Name (ARN) of the knowledge base.
KnowledgeBaseId (string) --
The unique identifier for the knowledge base.
RequestId (string) --
The Amazon Web Services request ID for this operation.
Status (integer) --
The HTTP status of the request.
Creates a knowledge base from a specified data source. Supported data source connector types include:
S3_KNOWLEDGE_BASE – Uses an Amazon S3 bucket as the data source.
WEB_CRAWLER – Uses web pages indexed by the built-in web crawler as the data source.
GOOGLE_DRIVE – Uses Google Drive as the data source. Supports service account authentication only.
SHAREPOINT – Uses SharePoint as the data source. Supports two-legged OAuth only.
ONE_DRIVE – Uses OneDrive as the data source. Supports two-legged OAuth only.
See also: AWS API Documentation
Request Syntax
client.create_knowledge_base(
AwsAccountId='string',
KnowledgeBaseId='string',
Name='string',
DataSourceArn='string',
KnowledgeBaseConfiguration={
'templateConfiguration': {
'template': {...}|[...]|123|123.4|'string'|True|None
}
},
Description='string',
Permissions=[
{
'Principal': 'string',
'Actions': [
'string',
]
},
],
MediaExtractionConfiguration={
'imageExtractionConfiguration': {
'imageExtractionStatus': 'ENABLED'|'DISABLED'
},
'audioExtractionConfiguration': {
'audioExtractionStatus': 'ENABLED'|'DISABLED'
},
'videoExtractionConfiguration': {
'videoExtractionStatus': 'ENABLED'|'DISABLED',
'videoExtractionType': 'AUDIO_TRANSCRIPTION_ONLY'|'VISUAL_CONTENT_AND_AUDIO_TRANSCRIPTION'
}
},
AccessControlConfiguration={
'isACLEnabled': True|False
},
PrimaryOwnerArn='string',
Tags=[
{
'Key': 'string',
'Value': 'string'
},
]
)
string
[REQUIRED]
The ID of the Amazon Web Services account that contains the knowledge base.
string
[REQUIRED]
The unique identifier for the knowledge base.
string
[REQUIRED]
The name of the knowledge base.
string
[REQUIRED]
The Amazon Resource Name (ARN) of the data source for the knowledge base.
dict
[REQUIRED]
The configuration settings for a knowledge base.
templateConfiguration (dict) --
The template configuration for the knowledge base.
template (:ref:`document<document>`) --
The template document that defines the knowledge base behavior.
string
A description for the knowledge base. If you don't specify a description, the knowledge base is created without one.
list
A list of resource permissions on the knowledge base. Each entry grants a specified Amazon QuickSight principal either owner or viewer access. If you don't specify permissions, only the primary owner (if provided) receives owner access.
(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 Quick Sight user or group associated with a data source or dataset. (This is common.)
The ARN of an Quick Sight user, group, or namespace associated with an analysis, dashboard, template, or theme. Namespace sharing is not supported for action connectors. (This is common.)
The ARN of an Amazon Web Services account root: This is an IAM ARN rather than a Quick Sight ARN. Use this option only to share resources (templates) across Amazon Web Services accounts. Account root sharing is not supported for action connectors. (This is less common.)
Actions (list) -- [REQUIRED]
The IAM action to grant or revoke permissions on.
(string) --
dict
The configuration for media extraction from knowledge base documents.
imageExtractionConfiguration (dict) --
The configuration for image extraction.
imageExtractionStatus (string) -- [REQUIRED]
The status of image extraction. Valid values are ENABLED and DISABLED.
audioExtractionConfiguration (dict) --
The configuration for audio extraction.
audioExtractionStatus (string) -- [REQUIRED]
The status of audio extraction. Valid values are ENABLED and DISABLED.
videoExtractionConfiguration (dict) --
The configuration for video extraction.
videoExtractionStatus (string) -- [REQUIRED]
The status of video extraction. Valid values are ENABLED and DISABLED.
videoExtractionType (string) --
The type of video extraction to perform.
dict
The access control configuration for the knowledge base. If you don't specify this parameter, document-level ACLs are disabled.
isACLEnabled (boolean) --
Specifies whether ACLs are enabled for the knowledge base.
string
The Amazon Resource Name (ARN) of the primary owner for the knowledge base. The specified user is always granted owner access, regardless of what is specified in the Permissions field. If you don't specify a primary owner, the knowledge base is created without one.
list
The tags to assign to the knowledge base. If you don't specify tags, the knowledge base is created without tags.
(dict) --
The key or keys of the key-value pairs for the resource tag or tags assigned to the resource.
Key (string) -- [REQUIRED]
Tag key.
Value (string) -- [REQUIRED]
Tag value.
dict
Response Syntax
{
'KnowledgeBaseArn': 'string',
'KnowledgeBaseId': 'string',
'CreationStatus': 'CREATING'|'UPDATING'|'ACTIVE'|'FAILED'|'DELETING',
'RequestId': 'string',
'Status': 123
}
Response Structure
(dict) --
KnowledgeBaseArn (string) --
The Amazon Resource Name (ARN) of the knowledge base.
KnowledgeBaseId (string) --
The unique identifier for the knowledge base.
CreationStatus (string) --
The creation status of the knowledge base.
RequestId (string) --
The Amazon Web Services request ID for this operation.
Status (integer) --
The HTTP status of the request.
{'Credentials': {'CredentialPair': {'AlternateDataSourceParameters': {'FMKBParameters': {'KnowledgeBaseArn': 'string',
'LinkedDataSourceIds': ['string']},
'GoogleDriveParameters': {'AuthType': 'THREE_LEGGED_OAUTH '
'| '
'TWO_LEGGED_OAUTH '
'| '
'SERVICE_ACCOUNT'},
'OneDriveParameters': {'AuthType': 'THREE_LEGGED_OAUTH '
'| '
'TWO_LEGGED_OAUTH '
'| '
'SERVICE_ACCOUNT',
'ClientId': 'string',
'TenantId': 'string'},
'SharePointParameters': {'AuthType': 'THREE_LEGGED_OAUTH '
'| '
'TWO_LEGGED_OAUTH '
'| '
'SERVICE_ACCOUNT',
'ClientId': 'string',
'SharePointDomain': 'string',
'TenantId': 'string'}}}},
'DataSourceParameters': {'FMKBParameters': {'KnowledgeBaseArn': 'string',
'LinkedDataSourceIds': ['string']},
'GoogleDriveParameters': {'AuthType': 'THREE_LEGGED_OAUTH '
'| '
'TWO_LEGGED_OAUTH '
'| '
'SERVICE_ACCOUNT'},
'OneDriveParameters': {'AuthType': 'THREE_LEGGED_OAUTH '
'| '
'TWO_LEGGED_OAUTH '
'| '
'SERVICE_ACCOUNT',
'ClientId': 'string',
'TenantId': 'string'},
'SharePointParameters': {'AuthType': 'THREE_LEGGED_OAUTH '
'| '
'TWO_LEGGED_OAUTH '
'| '
'SERVICE_ACCOUNT',
'ClientId': 'string',
'SharePointDomain': 'string',
'TenantId': 'string'}}}
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'|'S3_TABLES'|'SALESFORCE'|'SERVICENOW'|'SNOWFLAKE'|'SPARK'|'SQLSERVER'|'TERADATA'|'TWITTER'|'TIMESTREAM'|'AMAZON_OPENSEARCH'|'EXASOL'|'DATABRICKS'|'STARBURST'|'TRINO'|'BIGQUERY'|'GOOGLESHEETS'|'GOOGLE_DRIVE'|'CONFLUENCE'|'SHAREPOINT'|'ONE_DRIVE'|'WEB_CRAWLER'|'S3_KNOWLEDGE_BASE'|'QBUSINESS',
DataSourceParameters={
'AmazonElasticsearchParameters': {
'Domain': 'string'
},
'AthenaParameters': {
'WorkGroup': 'string',
'RoleArn': 'string',
'ConsumerAccountRoleArn': 'string',
'IdentityCenterConfiguration': {
'EnableIdentityPropagation': True|False
}
},
'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',
'UseServiceName': True|False
},
'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
},
'IdentityCenterConfiguration': {
'EnableIdentityPropagation': True|False
}
},
'S3Parameters': {
'ManifestFileLocation': {
'Bucket': 'string',
'Key': 'string'
},
'RoleArn': 'string'
},
'S3TablesParameters': {
'TableBucketArn': 'string'
},
'S3KnowledgeBaseParameters': {
'RoleArn': 'string',
'BucketUrl': 'string',
'MetadataFilesLocation': 'string'
},
'ServiceNowParameters': {
'SiteBaseUrl': 'string'
},
'SnowflakeParameters': {
'Host': 'string',
'Database': 'string',
'Warehouse': 'string',
'AuthenticationType': 'PASSWORD'|'KEYPAIR'|'TOKEN'|'X509',
'DatabaseAccessControlRole': 'string',
'OAuthParameters': {
'TokenProviderUrl': 'string',
'OAuthScope': 'string',
'IdentityProviderVpcConnectionProperties': {
'VpcConnectionArn': 'string'
},
'IdentityProviderResourceUri': 'string',
'IdentityProviderCACertificatesBundleS3Uri': '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',
'DatabaseAccessControlRole': 'string',
'AuthenticationType': 'PASSWORD'|'KEYPAIR'|'TOKEN'|'X509',
'OAuthParameters': {
'TokenProviderUrl': 'string',
'OAuthScope': 'string',
'IdentityProviderVpcConnectionProperties': {
'VpcConnectionArn': 'string'
},
'IdentityProviderResourceUri': 'string',
'IdentityProviderCACertificatesBundleS3Uri': 'string'
}
},
'TrinoParameters': {
'Host': 'string',
'Port': 123,
'Catalog': 'string'
},
'BigQueryParameters': {
'ProjectId': 'string',
'DataSetRegion': 'string'
},
'ImpalaParameters': {
'Host': 'string',
'Port': 123,
'Database': 'string',
'SqlEndpointPath': 'string'
},
'CustomConnectionParameters': {
'ConnectionType': 'string'
},
'WebCrawlerParameters': {
'WebCrawlerAuthType': 'NO_AUTH'|'BASIC_AUTH'|'FORM'|'SAML',
'UsernameFieldXpath': 'string',
'PasswordFieldXpath': 'string',
'UsernameButtonXpath': 'string',
'PasswordButtonXpath': 'string',
'LoginPageUrl': 'string',
'WebProxyHostName': 'string',
'WebProxyPortNumber': 123
},
'ConfluenceParameters': {
'ConfluenceUrl': 'string'
},
'QBusinessParameters': {
'ApplicationArn': 'string'
},
'SharePointParameters': {
'SharePointDomain': 'string',
'TenantId': 'string',
'ClientId': 'string',
'AuthType': 'THREE_LEGGED_OAUTH'|'TWO_LEGGED_OAUTH'|'SERVICE_ACCOUNT'
},
'GoogleDriveParameters': {
'AuthType': 'THREE_LEGGED_OAUTH'|'TWO_LEGGED_OAUTH'|'SERVICE_ACCOUNT'
},
'OneDriveParameters': {
'TenantId': 'string',
'ClientId': 'string',
'AuthType': 'THREE_LEGGED_OAUTH'|'TWO_LEGGED_OAUTH'|'SERVICE_ACCOUNT'
},
'FMKBParameters': {
'KnowledgeBaseArn': 'string',
'LinkedDataSourceIds': [
'string',
]
}
},
Credentials={
'CredentialPair': {
'Username': 'string',
'Password': 'string',
'AlternateDataSourceParameters': [
{
'AmazonElasticsearchParameters': {
'Domain': 'string'
},
'AthenaParameters': {
'WorkGroup': 'string',
'RoleArn': 'string',
'ConsumerAccountRoleArn': 'string',
'IdentityCenterConfiguration': {
'EnableIdentityPropagation': True|False
}
},
'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',
'UseServiceName': True|False
},
'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
},
'IdentityCenterConfiguration': {
'EnableIdentityPropagation': True|False
}
},
'S3Parameters': {
'ManifestFileLocation': {
'Bucket': 'string',
'Key': 'string'
},
'RoleArn': 'string'
},
'S3TablesParameters': {
'TableBucketArn': 'string'
},
'S3KnowledgeBaseParameters': {
'RoleArn': 'string',
'BucketUrl': 'string',
'MetadataFilesLocation': 'string'
},
'ServiceNowParameters': {
'SiteBaseUrl': 'string'
},
'SnowflakeParameters': {
'Host': 'string',
'Database': 'string',
'Warehouse': 'string',
'AuthenticationType': 'PASSWORD'|'KEYPAIR'|'TOKEN'|'X509',
'DatabaseAccessControlRole': 'string',
'OAuthParameters': {
'TokenProviderUrl': 'string',
'OAuthScope': 'string',
'IdentityProviderVpcConnectionProperties': {
'VpcConnectionArn': 'string'
},
'IdentityProviderResourceUri': 'string',
'IdentityProviderCACertificatesBundleS3Uri': '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',
'DatabaseAccessControlRole': 'string',
'AuthenticationType': 'PASSWORD'|'KEYPAIR'|'TOKEN'|'X509',
'OAuthParameters': {
'TokenProviderUrl': 'string',
'OAuthScope': 'string',
'IdentityProviderVpcConnectionProperties': {
'VpcConnectionArn': 'string'
},
'IdentityProviderResourceUri': 'string',
'IdentityProviderCACertificatesBundleS3Uri': 'string'
}
},
'TrinoParameters': {
'Host': 'string',
'Port': 123,
'Catalog': 'string'
},
'BigQueryParameters': {
'ProjectId': 'string',
'DataSetRegion': 'string'
},
'ImpalaParameters': {
'Host': 'string',
'Port': 123,
'Database': 'string',
'SqlEndpointPath': 'string'
},
'CustomConnectionParameters': {
'ConnectionType': 'string'
},
'WebCrawlerParameters': {
'WebCrawlerAuthType': 'NO_AUTH'|'BASIC_AUTH'|'FORM'|'SAML',
'UsernameFieldXpath': 'string',
'PasswordFieldXpath': 'string',
'UsernameButtonXpath': 'string',
'PasswordButtonXpath': 'string',
'LoginPageUrl': 'string',
'WebProxyHostName': 'string',
'WebProxyPortNumber': 123
},
'ConfluenceParameters': {
'ConfluenceUrl': 'string'
},
'QBusinessParameters': {
'ApplicationArn': 'string'
},
'SharePointParameters': {
'SharePointDomain': 'string',
'TenantId': 'string',
'ClientId': 'string',
'AuthType': 'THREE_LEGGED_OAUTH'|'TWO_LEGGED_OAUTH'|'SERVICE_ACCOUNT'
},
'GoogleDriveParameters': {
'AuthType': 'THREE_LEGGED_OAUTH'|'TWO_LEGGED_OAUTH'|'SERVICE_ACCOUNT'
},
'OneDriveParameters': {
'TenantId': 'string',
'ClientId': 'string',
'AuthType': 'THREE_LEGGED_OAUTH'|'TWO_LEGGED_OAUTH'|'SERVICE_ACCOUNT'
},
'FMKBParameters': {
'KnowledgeBaseArn': 'string',
'LinkedDataSourceIds': [
'string',
]
}
},
]
},
'CopySourceArn': 'string',
'SecretArn': 'string',
'KeyPairCredentials': {
'KeyPairUsername': 'string',
'PrivateKey': 'string',
'PrivateKeyPassphrase': 'string'
},
'WebProxyCredentials': {
'WebProxyUsername': 'string',
'WebProxyPassword': 'string'
},
'OAuthClientCredentials': {
'ClientId': 'string',
'ClientSecret': 'string',
'Username': '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 Quick Sight 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.
ConsumerAccountRoleArn (string) --
Use ConsumerAccountRoleArn to perform cross-account Athena access. This is an IAM role ARN in the same AWS account as the Athena resources you want to access. Provide this along with RoleArn to enable role-chaining, where Amazon Quick Sight first assumes the RoleArn and then assumes the ConsumerAccountRoleArn to access Athena resources.
IdentityCenterConfiguration (dict) --
An optional parameter that configures IAM Identity Center authentication to grant Quick Sight access to your workgroup.
This parameter can only be specified if your Quick Sight account is configured with IAM Identity Center.
EnableIdentityPropagation (boolean) --
A Boolean option that controls whether Trusted Identity Propagation should be used.
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.
UseServiceName (boolean) --
A Boolean value that indicates whether the Database uses a service name or an SID. If this value is left blank, the default value is SID. If this value is set to false, the value is SID.
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 Quick Sight access to your cluster. This parameter can be used instead of DataSourceCredentials.
RoleArn (string) -- [REQUIRED]
Use the RoleArn structure to allow Quick Sight to call redshift:GetClusterCredentials on your cluster. The calling principal must have iam:PassRole access to pass the role to Quick Sight. The role's trust policy must allow the Quick Sight service principal to assume the role.
DatabaseUser (string) --
The user whose permissions and group memberships will be used by Quick Sight to access the cluster. If this user already exists in your database, Amazon Quick Sight 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 Quick Sight to access the cluster. These permissions are combined with the permissions granted to Quick Sight 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, Quick Sight 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.
IdentityCenterConfiguration (dict) --
An optional parameter that configures IAM Identity Center authentication to grant Quick Sight access to your cluster.
This parameter can only be specified if your Quick Sight account is configured with IAM Identity Center.
EnableIdentityPropagation (boolean) --
A Boolean option that controls whether Trusted Identity Propagation should be used.
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 Quick Sight.
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.
S3TablesParameters (dict) --
The parameters for S3 Tables.
TableBucketArn (string) --
The Amazon Resource Name (ARN) of the S3 Tables bucket.
S3KnowledgeBaseParameters (dict) --
The parameters for S3 Knowledge Base.
RoleArn (string) --
Use the RoleArn structure to override an account-wide role for a specific S3 Knowledge Base 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 Knowledge Base data source that is specified in the structure, even if the account-wide role forbidding S3 access is still active.
BucketUrl (string) -- [REQUIRED]
The URL of the S3 bucket that contains the knowledge base data.
MetadataFilesLocation (string) --
The location of metadata files within the S3 bucket that describe the structure and content of the knowledge base.
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.
AuthenticationType (string) --
The authentication type that you want to use for your connection. This parameter accepts OAuth and non-OAuth authentication types.
DatabaseAccessControlRole (string) --
The database access control role.
OAuthParameters (dict) --
An object that contains information needed to create a data source connection between an Quick Sight account and Snowflake.
TokenProviderUrl (string) -- [REQUIRED]
The token endpoint URL of the identity provider.
OAuthScope (string) --
The OAuth scope.
IdentityProviderVpcConnectionProperties (dict) --
VPC connection properties.
VpcConnectionArn (string) -- [REQUIRED]
The Amazon Resource Name (ARN) for the VPC connection.
IdentityProviderResourceUri (string) --
The resource uri of the identity provider.
IdentityProviderCACertificatesBundleS3Uri (string) --
The S3 URI of the identity provider's CA certificates bundle in PEM format. Use this parameter to provide a custom CA certificate bundle for the identity provider when the default trust store does not include the required certificates.
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.
DatabaseAccessControlRole (string) --
The database access control role.
AuthenticationType (string) --
The authentication type that you want to use for your connection. This parameter accepts OAuth and non-OAuth authentication types.
OAuthParameters (dict) --
An object that contains information needed to create a data source connection between an Quick Sight account and Starburst.
TokenProviderUrl (string) -- [REQUIRED]
The token endpoint URL of the identity provider.
OAuthScope (string) --
The OAuth scope.
IdentityProviderVpcConnectionProperties (dict) --
VPC connection properties.
VpcConnectionArn (string) -- [REQUIRED]
The Amazon Resource Name (ARN) for the VPC connection.
IdentityProviderResourceUri (string) --
The resource uri of the identity provider.
IdentityProviderCACertificatesBundleS3Uri (string) --
The S3 URI of the identity provider's CA certificates bundle in PEM format. Use this parameter to provide a custom CA certificate bundle for the identity provider when the default trust store does not include the required certificates.
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.
ImpalaParameters (dict) --
The parameters for Impala.
Host (string) -- [REQUIRED]
The host name of the Impala data source.
Port (integer) -- [REQUIRED]
The port of the Impala data source.
Database (string) --
The database of the Impala data source.
SqlEndpointPath (string) -- [REQUIRED]
The HTTP path of the Impala data source.
CustomConnectionParameters (dict) --
The parameters for custom connectors.
ConnectionType (string) --
The type of custom connector.
WebCrawlerParameters (dict) --
The parameters for Web Crawler.
WebCrawlerAuthType (string) -- [REQUIRED]
The authentication type for the web crawler. The type can be one of the following:
NO_AUTH: No authentication required.
BASIC_AUTH: Basic authentication using username and password.
SAML: SAML-based authentication.
FORM: Form-based authentication.
UsernameFieldXpath (string) --
The XPath expression for locating the username field on the login page.
PasswordFieldXpath (string) --
The XPath expression for locating the password field on the login page.
UsernameButtonXpath (string) --
The XPath expression for locating the username submit button on the login page.
PasswordButtonXpath (string) --
The XPath expression for locating the password submit button on the login page.
LoginPageUrl (string) --
The URL of the login page for the web crawler to authenticate.
WebProxyHostName (string) --
The hostname of the web proxy server for the web crawler.
WebProxyPortNumber (integer) --
The port number of the web proxy server for the web crawler.
ConfluenceParameters (dict) --
The parameters for Confluence.
ConfluenceUrl (string) -- [REQUIRED]
The URL of the Confluence site to connect to.
QBusinessParameters (dict) --
The parameters for Amazon Q Business.
ApplicationArn (string) -- [REQUIRED]
The Amazon Resource Name (ARN) of the Amazon Q Business application.
SharePointParameters (dict) --
The parameters for a SharePoint data source.
SharePointDomain (string) -- [REQUIRED]
The SharePoint domain for the data source.
TenantId (string) --
The tenant ID for the SharePoint data source.
ClientId (string) --
The client ID for the SharePoint data source.
AuthType (string) --
The authentication type for the SharePoint data source. Valid values include:
TWO_LEGGED_OAUTH – Server-to-server authentication using client credentials that do not require user interaction.
THREE_LEGGED_OAUTH – Interactive OAuth that requires user consent.
GoogleDriveParameters (dict) --
The parameters for a Google Drive data source.
AuthType (string) --
The authentication type for the Google Drive data source. Valid values include:
SERVICE_ACCOUNT – Server-to-server authentication using a Google service account key.
THREE_LEGGED_OAUTH – Interactive OAuth that requires user consent.
OneDriveParameters (dict) --
The parameters for an OneDrive data source.
TenantId (string) --
The tenant ID for the OneDrive data source.
ClientId (string) --
The client ID for the OneDrive data source.
AuthType (string) --
The authentication type for the OneDrive data source. Valid values include:
TWO_LEGGED_OAUTH – Server-to-server authentication using client credentials that do not require user interaction.
THREE_LEGGED_OAUTH – Interactive OAuth that requires user consent.
FMKBParameters (dict) --
The parameters for a fully managed knowledge base data source.
KnowledgeBaseArn (string) -- [REQUIRED]
The Amazon Resource Name (ARN) of the Amazon Bedrock knowledge base.
LinkedDataSourceIds (list) --
The IDs of the linked data sources.
(string) --
dict
The credentials Amazon Quick Sight 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 Quick Sight 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.
ConsumerAccountRoleArn (string) --
Use ConsumerAccountRoleArn to perform cross-account Athena access. This is an IAM role ARN in the same AWS account as the Athena resources you want to access. Provide this along with RoleArn to enable role-chaining, where Amazon Quick Sight first assumes the RoleArn and then assumes the ConsumerAccountRoleArn to access Athena resources.
IdentityCenterConfiguration (dict) --
An optional parameter that configures IAM Identity Center authentication to grant Quick Sight access to your workgroup.
This parameter can only be specified if your Quick Sight account is configured with IAM Identity Center.
EnableIdentityPropagation (boolean) --
A Boolean option that controls whether Trusted Identity Propagation should be used.
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.
UseServiceName (boolean) --
A Boolean value that indicates whether the Database uses a service name or an SID. If this value is left blank, the default value is SID. If this value is set to false, the value is SID.
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 Quick Sight access to your cluster. This parameter can be used instead of DataSourceCredentials.
RoleArn (string) -- [REQUIRED]
Use the RoleArn structure to allow Quick Sight to call redshift:GetClusterCredentials on your cluster. The calling principal must have iam:PassRole access to pass the role to Quick Sight. The role's trust policy must allow the Quick Sight service principal to assume the role.
DatabaseUser (string) --
The user whose permissions and group memberships will be used by Quick Sight to access the cluster. If this user already exists in your database, Amazon Quick Sight 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 Quick Sight to access the cluster. These permissions are combined with the permissions granted to Quick Sight 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, Quick Sight 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.
IdentityCenterConfiguration (dict) --
An optional parameter that configures IAM Identity Center authentication to grant Quick Sight access to your cluster.
This parameter can only be specified if your Quick Sight account is configured with IAM Identity Center.
EnableIdentityPropagation (boolean) --
A Boolean option that controls whether Trusted Identity Propagation should be used.
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 Quick Sight.
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.
S3TablesParameters (dict) --
The parameters for S3 Tables.
TableBucketArn (string) --
The Amazon Resource Name (ARN) of the S3 Tables bucket.
S3KnowledgeBaseParameters (dict) --
The parameters for S3 Knowledge Base.
RoleArn (string) --
Use the RoleArn structure to override an account-wide role for a specific S3 Knowledge Base 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 Knowledge Base data source that is specified in the structure, even if the account-wide role forbidding S3 access is still active.
BucketUrl (string) -- [REQUIRED]
The URL of the S3 bucket that contains the knowledge base data.
MetadataFilesLocation (string) --
The location of metadata files within the S3 bucket that describe the structure and content of the knowledge base.
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.
AuthenticationType (string) --
The authentication type that you want to use for your connection. This parameter accepts OAuth and non-OAuth authentication types.
DatabaseAccessControlRole (string) --
The database access control role.
OAuthParameters (dict) --
An object that contains information needed to create a data source connection between an Quick Sight account and Snowflake.
TokenProviderUrl (string) -- [REQUIRED]
The token endpoint URL of the identity provider.
OAuthScope (string) --
The OAuth scope.
IdentityProviderVpcConnectionProperties (dict) --
VPC connection properties.
VpcConnectionArn (string) -- [REQUIRED]
The Amazon Resource Name (ARN) for the VPC connection.
IdentityProviderResourceUri (string) --
The resource uri of the identity provider.
IdentityProviderCACertificatesBundleS3Uri (string) --
The S3 URI of the identity provider's CA certificates bundle in PEM format. Use this parameter to provide a custom CA certificate bundle for the identity provider when the default trust store does not include the required certificates.
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.
DatabaseAccessControlRole (string) --
The database access control role.
AuthenticationType (string) --
The authentication type that you want to use for your connection. This parameter accepts OAuth and non-OAuth authentication types.
OAuthParameters (dict) --
An object that contains information needed to create a data source connection between an Quick Sight account and Starburst.
TokenProviderUrl (string) -- [REQUIRED]
The token endpoint URL of the identity provider.
OAuthScope (string) --
The OAuth scope.
IdentityProviderVpcConnectionProperties (dict) --
VPC connection properties.
VpcConnectionArn (string) -- [REQUIRED]
The Amazon Resource Name (ARN) for the VPC connection.
IdentityProviderResourceUri (string) --
The resource uri of the identity provider.
IdentityProviderCACertificatesBundleS3Uri (string) --
The S3 URI of the identity provider's CA certificates bundle in PEM format. Use this parameter to provide a custom CA certificate bundle for the identity provider when the default trust store does not include the required certificates.
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.
ImpalaParameters (dict) --
The parameters for Impala.
Host (string) -- [REQUIRED]
The host name of the Impala data source.
Port (integer) -- [REQUIRED]
The port of the Impala data source.
Database (string) --
The database of the Impala data source.
SqlEndpointPath (string) -- [REQUIRED]
The HTTP path of the Impala data source.
CustomConnectionParameters (dict) --
The parameters for custom connectors.
ConnectionType (string) --
The type of custom connector.
WebCrawlerParameters (dict) --
The parameters for Web Crawler.
WebCrawlerAuthType (string) -- [REQUIRED]
The authentication type for the web crawler. The type can be one of the following:
NO_AUTH: No authentication required.
BASIC_AUTH: Basic authentication using username and password.
SAML: SAML-based authentication.
FORM: Form-based authentication.
UsernameFieldXpath (string) --
The XPath expression for locating the username field on the login page.
PasswordFieldXpath (string) --
The XPath expression for locating the password field on the login page.
UsernameButtonXpath (string) --
The XPath expression for locating the username submit button on the login page.
PasswordButtonXpath (string) --
The XPath expression for locating the password submit button on the login page.
LoginPageUrl (string) --
The URL of the login page for the web crawler to authenticate.
WebProxyHostName (string) --
The hostname of the web proxy server for the web crawler.
WebProxyPortNumber (integer) --
The port number of the web proxy server for the web crawler.
ConfluenceParameters (dict) --
The parameters for Confluence.
ConfluenceUrl (string) -- [REQUIRED]
The URL of the Confluence site to connect to.
QBusinessParameters (dict) --
The parameters for Amazon Q Business.
ApplicationArn (string) -- [REQUIRED]
The Amazon Resource Name (ARN) of the Amazon Q Business application.
SharePointParameters (dict) --
The parameters for a SharePoint data source.
SharePointDomain (string) -- [REQUIRED]
The SharePoint domain for the data source.
TenantId (string) --
The tenant ID for the SharePoint data source.
ClientId (string) --
The client ID for the SharePoint data source.
AuthType (string) --
The authentication type for the SharePoint data source. Valid values include:
TWO_LEGGED_OAUTH – Server-to-server authentication using client credentials that do not require user interaction.
THREE_LEGGED_OAUTH – Interactive OAuth that requires user consent.
GoogleDriveParameters (dict) --
The parameters for a Google Drive data source.
AuthType (string) --
The authentication type for the Google Drive data source. Valid values include:
SERVICE_ACCOUNT – Server-to-server authentication using a Google service account key.
THREE_LEGGED_OAUTH – Interactive OAuth that requires user consent.
OneDriveParameters (dict) --
The parameters for an OneDrive data source.
TenantId (string) --
The tenant ID for the OneDrive data source.
ClientId (string) --
The client ID for the OneDrive data source.
AuthType (string) --
The authentication type for the OneDrive data source. Valid values include:
TWO_LEGGED_OAUTH – Server-to-server authentication using client credentials that do not require user interaction.
THREE_LEGGED_OAUTH – Interactive OAuth that requires user consent.
FMKBParameters (dict) --
The parameters for a fully managed knowledge base data source.
KnowledgeBaseArn (string) -- [REQUIRED]
The Amazon Resource Name (ARN) of the Amazon Bedrock knowledge base.
LinkedDataSourceIds (list) --
The IDs of the linked data sources.
(string) --
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.
KeyPairCredentials (dict) --
The credentials for connecting using key-pair.
KeyPairUsername (string) -- [REQUIRED]
Username
PrivateKey (string) -- [REQUIRED]
PrivateKey
PrivateKeyPassphrase (string) --
PrivateKeyPassphrase
WebProxyCredentials (dict) --
The credentials for connecting through a web proxy server.
WebProxyUsername (string) -- [REQUIRED]
The username for authenticating with the web proxy server.
WebProxyPassword (string) -- [REQUIRED]
The password for authenticating with the web proxy server.
OAuthClientCredentials (dict) --
The OAuth client credentials for connecting to a data source using OAuth 2.0 client credentials (2LO) authentication. For more information, see ``OAuthClientCredentials ``.
ClientId (string) --
The client ID of the OAuth 2.0 application that is registered with the data source provider.
ClientSecret (string) --
The client secret of the OAuth 2.0 application that is registered with the data source provider.
Username (string) --
The username of the account that is used for OAuth 2.0 client credentials authentication with the data source provider.
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 Quick Sight user or group associated with a data source or dataset. (This is common.)
The ARN of an Quick Sight user, group, or namespace associated with an analysis, dashboard, template, or theme. Namespace sharing is not supported for action connectors. (This is common.)
The ARN of an Amazon Web Services account root: This is an IAM ARN rather than a Quick Sight ARN. Use this option only to share resources (templates) across Amazon Web Services accounts. Account root sharing is not supported for action connectors. (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 Quick Sight 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 Quick Sight 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 Quick Sight 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.
{'OverrideParameters': {'DataSources': {'DataSourceParameters': {'FMKBParameters': {'KnowledgeBaseArn': 'string',
'LinkedDataSourceIds': ['string']},
'GoogleDriveParameters': {'AuthType': 'THREE_LEGGED_OAUTH '
'| '
'TWO_LEGGED_OAUTH '
'| '
'SERVICE_ACCOUNT'},
'OneDriveParameters': {'AuthType': 'THREE_LEGGED_OAUTH '
'| '
'TWO_LEGGED_OAUTH '
'| '
'SERVICE_ACCOUNT',
'ClientId': 'string',
'TenantId': 'string'},
'SharePointParameters': {'AuthType': 'THREE_LEGGED_OAUTH '
'| '
'TWO_LEGGED_OAUTH '
'| '
'SERVICE_ACCOUNT',
'ClientId': 'string',
'SharePointDomain': 'string',
'TenantId': 'string'}}}}}
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',
'ConsumerAccountRoleArn': 'string',
'IdentityCenterConfiguration': {
'EnableIdentityPropagation': True|False
}
},
'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',
'UseServiceName': True|False
},
'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
},
'IdentityCenterConfiguration': {
'EnableIdentityPropagation': True|False
}
},
'S3Parameters': {
'ManifestFileLocation': {
'Bucket': 'string',
'Key': 'string'
},
'RoleArn': 'string'
},
'S3TablesParameters': {
'TableBucketArn': 'string'
},
'S3KnowledgeBaseParameters': {
'RoleArn': 'string',
'BucketUrl': 'string',
'MetadataFilesLocation': 'string'
},
'ServiceNowParameters': {
'SiteBaseUrl': 'string'
},
'SnowflakeParameters': {
'Host': 'string',
'Database': 'string',
'Warehouse': 'string',
'AuthenticationType': 'PASSWORD'|'KEYPAIR'|'TOKEN'|'X509',
'DatabaseAccessControlRole': 'string',
'OAuthParameters': {
'TokenProviderUrl': 'string',
'OAuthScope': 'string',
'IdentityProviderVpcConnectionProperties': {
'VpcConnectionArn': 'string'
},
'IdentityProviderResourceUri': 'string',
'IdentityProviderCACertificatesBundleS3Uri': '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',
'DatabaseAccessControlRole': 'string',
'AuthenticationType': 'PASSWORD'|'KEYPAIR'|'TOKEN'|'X509',
'OAuthParameters': {
'TokenProviderUrl': 'string',
'OAuthScope': 'string',
'IdentityProviderVpcConnectionProperties': {
'VpcConnectionArn': 'string'
},
'IdentityProviderResourceUri': 'string',
'IdentityProviderCACertificatesBundleS3Uri': 'string'
}
},
'TrinoParameters': {
'Host': 'string',
'Port': 123,
'Catalog': 'string'
},
'BigQueryParameters': {
'ProjectId': 'string',
'DataSetRegion': 'string'
},
'ImpalaParameters': {
'Host': 'string',
'Port': 123,
'Database': 'string',
'SqlEndpointPath': 'string'
},
'CustomConnectionParameters': {
'ConnectionType': 'string'
},
'WebCrawlerParameters': {
'WebCrawlerAuthType': 'NO_AUTH'|'BASIC_AUTH'|'FORM'|'SAML',
'UsernameFieldXpath': 'string',
'PasswordFieldXpath': 'string',
'UsernameButtonXpath': 'string',
'PasswordButtonXpath': 'string',
'LoginPageUrl': 'string',
'WebProxyHostName': 'string',
'WebProxyPortNumber': 123
},
'ConfluenceParameters': {
'ConfluenceUrl': 'string'
},
'QBusinessParameters': {
'ApplicationArn': 'string'
},
'SharePointParameters': {
'SharePointDomain': 'string',
'TenantId': 'string',
'ClientId': 'string',
'AuthType': 'THREE_LEGGED_OAUTH'|'TWO_LEGGED_OAUTH'|'SERVICE_ACCOUNT'
},
'GoogleDriveParameters': {
'AuthType': 'THREE_LEGGED_OAUTH'|'TWO_LEGGED_OAUTH'|'SERVICE_ACCOUNT'
},
'OneDriveParameters': {
'TenantId': 'string',
'ClientId': 'string',
'AuthType': 'THREE_LEGGED_OAUTH'|'TWO_LEGGED_OAUTH'|'SERVICE_ACCOUNT'
},
'FMKBParameters': {
'KnowledgeBaseArn': 'string',
'LinkedDataSourceIds': [
'string',
]
}
},
'VpcConnectionProperties': {
'VpcConnectionArn': 'string'
},
'SslProperties': {
'DisableSsl': True|False
},
'Credentials': {
'CredentialPair': {
'Username': 'string',
'Password': 'string'
},
'SecretArn': 'string'
}
},
],
'DataSets': [
{
'DataSetId': 'string',
'Name': 'string',
'DataSetRefreshProperties': {
'RefreshConfiguration': {
'IncrementalRefresh': {
'LookbackWindow': {
'ColumnName': 'string',
'Size': 123,
'SizeUnit': 'HOUR'|'DAY'|'WEEK'
}
}
},
'FailureConfiguration': {
'EmailAlert': {
'AlertStatus': 'ENABLED'|'DISABLED'
}
}
}
},
],
'Themes': [
{
'ThemeId': 'string',
'Name': 'string'
},
],
'Analyses': [
{
'AnalysisId': 'string',
'Name': 'string'
},
],
'Dashboards': [
{
'DashboardId': 'string',
'Name': 'string'
},
],
'Folders': [
{
'FolderId': 'string',
'Name': 'string',
'ParentFolderArn': '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',
]
}
}
},
],
'Folders': [
{
'FolderIds': [
'string',
],
'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'
},
]
},
],
'Folders': [
{
'FolderIds': [
'string',
],
'Tags': [
{
'Key': 'string',
'Value': 'string'
},
]
},
]
},
'OverrideValidationStrategy': {
'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 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 Quick Sight 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.
ConsumerAccountRoleArn (string) --
Use ConsumerAccountRoleArn to perform cross-account Athena access. This is an IAM role ARN in the same AWS account as the Athena resources you want to access. Provide this along with RoleArn to enable role-chaining, where Amazon Quick Sight first assumes the RoleArn and then assumes the ConsumerAccountRoleArn to access Athena resources.
IdentityCenterConfiguration (dict) --
An optional parameter that configures IAM Identity Center authentication to grant Quick Sight access to your workgroup.
This parameter can only be specified if your Quick Sight account is configured with IAM Identity Center.
EnableIdentityPropagation (boolean) --
A Boolean option that controls whether Trusted Identity Propagation should be used.
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.
UseServiceName (boolean) --
A Boolean value that indicates whether the Database uses a service name or an SID. If this value is left blank, the default value is SID. If this value is set to false, the value is SID.
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 Quick Sight access to your cluster. This parameter can be used instead of DataSourceCredentials.
RoleArn (string) --
Use the RoleArn structure to allow Quick Sight to call redshift:GetClusterCredentials on your cluster. The calling principal must have iam:PassRole access to pass the role to Quick Sight. The role's trust policy must allow the Quick Sight service principal to assume the role.
DatabaseUser (string) --
The user whose permissions and group memberships will be used by Quick Sight to access the cluster. If this user already exists in your database, Amazon Quick Sight 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 Quick Sight to access the cluster. These permissions are combined with the permissions granted to Quick Sight 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, Quick Sight 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.
IdentityCenterConfiguration (dict) --
An optional parameter that configures IAM Identity Center authentication to grant Quick Sight access to your cluster.
This parameter can only be specified if your Quick Sight account is configured with IAM Identity Center.
EnableIdentityPropagation (boolean) --
A Boolean option that controls whether Trusted Identity Propagation should be used.
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 Quick Sight.
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.
S3TablesParameters (dict) --
The parameters for S3 Tables.
TableBucketArn (string) --
The Amazon Resource Name (ARN) of the S3 Tables bucket.
S3KnowledgeBaseParameters (dict) --
The parameters for S3 Knowledge Base.
RoleArn (string) --
Use the RoleArn structure to override an account-wide role for a specific S3 Knowledge Base 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 Knowledge Base data source that is specified in the structure, even if the account-wide role forbidding S3 access is still active.
BucketUrl (string) --
The URL of the S3 bucket that contains the knowledge base data.
MetadataFilesLocation (string) --
The location of metadata files within the S3 bucket that describe the structure and content of the knowledge base.
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.
AuthenticationType (string) --
The authentication type that you want to use for your connection. This parameter accepts OAuth and non-OAuth authentication types.
DatabaseAccessControlRole (string) --
The database access control role.
OAuthParameters (dict) --
An object that contains information needed to create a data source connection between an Quick Sight account and Snowflake.
TokenProviderUrl (string) --
The token endpoint URL of the identity provider.
OAuthScope (string) --
The OAuth scope.
IdentityProviderVpcConnectionProperties (dict) --
VPC connection properties.
VpcConnectionArn (string) --
The Amazon Resource Name (ARN) for the VPC connection.
IdentityProviderResourceUri (string) --
The resource uri of the identity provider.
IdentityProviderCACertificatesBundleS3Uri (string) --
The S3 URI of the identity provider's CA certificates bundle in PEM format. Use this parameter to provide a custom CA certificate bundle for the identity provider when the default trust store does not include the required certificates.
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.
DatabaseAccessControlRole (string) --
The database access control role.
AuthenticationType (string) --
The authentication type that you want to use for your connection. This parameter accepts OAuth and non-OAuth authentication types.
OAuthParameters (dict) --
An object that contains information needed to create a data source connection between an Quick Sight account and Starburst.
TokenProviderUrl (string) --
The token endpoint URL of the identity provider.
OAuthScope (string) --
The OAuth scope.
IdentityProviderVpcConnectionProperties (dict) --
VPC connection properties.
VpcConnectionArn (string) --
The Amazon Resource Name (ARN) for the VPC connection.
IdentityProviderResourceUri (string) --
The resource uri of the identity provider.
IdentityProviderCACertificatesBundleS3Uri (string) --
The S3 URI of the identity provider's CA certificates bundle in PEM format. Use this parameter to provide a custom CA certificate bundle for the identity provider when the default trust store does not include the required certificates.
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.
ImpalaParameters (dict) --
The parameters for Impala.
Host (string) --
The host name of the Impala data source.
Port (integer) --
The port of the Impala data source.
Database (string) --
The database of the Impala data source.
SqlEndpointPath (string) --
The HTTP path of the Impala data source.
CustomConnectionParameters (dict) --
The parameters for custom connectors.
ConnectionType (string) --
The type of custom connector.
WebCrawlerParameters (dict) --
The parameters for Web Crawler.
WebCrawlerAuthType (string) --
The authentication type for the web crawler. The type can be one of the following:
NO_AUTH: No authentication required.
BASIC_AUTH: Basic authentication using username and password.
SAML: SAML-based authentication.
FORM: Form-based authentication.
UsernameFieldXpath (string) --
The XPath expression for locating the username field on the login page.
PasswordFieldXpath (string) --
The XPath expression for locating the password field on the login page.
UsernameButtonXpath (string) --
The XPath expression for locating the username submit button on the login page.
PasswordButtonXpath (string) --
The XPath expression for locating the password submit button on the login page.
LoginPageUrl (string) --
The URL of the login page for the web crawler to authenticate.
WebProxyHostName (string) --
The hostname of the web proxy server for the web crawler.
WebProxyPortNumber (integer) --
The port number of the web proxy server for the web crawler.
ConfluenceParameters (dict) --
The parameters for Confluence.
ConfluenceUrl (string) --
The URL of the Confluence site to connect to.
QBusinessParameters (dict) --
The parameters for Amazon Q Business.
ApplicationArn (string) --
The Amazon Resource Name (ARN) of the Amazon Q Business application.
SharePointParameters (dict) --
The parameters for a SharePoint data source.
SharePointDomain (string) --
The SharePoint domain for the data source.
TenantId (string) --
The tenant ID for the SharePoint data source.
ClientId (string) --
The client ID for the SharePoint data source.
AuthType (string) --
The authentication type for the SharePoint data source. Valid values include:
TWO_LEGGED_OAUTH – Server-to-server authentication using client credentials that do not require user interaction.
THREE_LEGGED_OAUTH – Interactive OAuth that requires user consent.
GoogleDriveParameters (dict) --
The parameters for a Google Drive data source.
AuthType (string) --
The authentication type for the Google Drive data source. Valid values include:
SERVICE_ACCOUNT – Server-to-server authentication using a Google service account key.
THREE_LEGGED_OAUTH – Interactive OAuth that requires user consent.
OneDriveParameters (dict) --
The parameters for an OneDrive data source.
TenantId (string) --
The tenant ID for the OneDrive data source.
ClientId (string) --
The client ID for the OneDrive data source.
AuthType (string) --
The authentication type for the OneDrive data source. Valid values include:
TWO_LEGGED_OAUTH – Server-to-server authentication using client credentials that do not require user interaction.
THREE_LEGGED_OAUTH – Interactive OAuth that requires user consent.
FMKBParameters (dict) --
The parameters for a fully managed knowledge base data source.
KnowledgeBaseArn (string) --
The Amazon Resource Name (ARN) of the Amazon Bedrock knowledge base.
LinkedDataSourceIds (list) --
The IDs of the linked data sources.
(string) --
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 Quick Sight 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.
DataSetRefreshProperties (dict) --
The refresh properties of a dataset.
RefreshConfiguration (dict) --
The refresh configuration for a dataset.
IncrementalRefresh (dict) --
The incremental refresh for the dataset.
LookbackWindow (dict) --
The lookback window setup for an incremental refresh configuration.
ColumnName (string) --
The name of the lookback window column.
Size (integer) --
The lookback window column size.
SizeUnit (string) --
The size unit that is used for the lookback window column. Valid values for this structure are HOUR, DAY, and WEEK.
FailureConfiguration (dict) --
The failure configuration for a dataset.
EmailAlert (dict) --
The email alert configuration for a dataset refresh failure.
AlertStatus (string) --
The status value that determines if email alerts are sent.
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.
Folders (list) --
A list of overrides for any Folder resources that are present in the asset bundle that is imported.
(dict) --
The override parameters for a single folder that is being imported.
FolderId (string) --
The ID of the folder that you want to apply overrides to.
Name (string) --
A new name for the folder.
ParentFolderArn (string) --
A new parent folder arn. This change can only be applied if the import creates a brand new folder. Existing folders cannot be moved.
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) --
Folders (list) --
A list of permissions for the folders that you want to apply overrides to.
(dict) --
An object that contains a list of permissions to be applied to a list of folder IDs.
FolderIds (list) --
A list of folder IDs that you want to apply overrides to. You can use * to override all folders in this asset bundle.
(string) --
Permissions (dict) --
A structure that contains the permissions for the resource that you want to override in an asset bundle import job.
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.
Folders (list) --
A list of tag overrides for any Folder 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 folder IDs.
FolderIds (list) --
A list of folder IDs that you want to apply overrides to. You can use * to override all folders in this asset bundle.
(string) --
Tags (list) --
A list of tags for the folders 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.
Warnings (list) --
An array of warning records that describe all permitted errors that are encountered during the import job.
(dict) --
Describes a warning that occurred during an Asset Bundle import job.
Arn (string) --
The ARN of the resource that the warning occurred for.
Message (string) --
A description of the warning that occurred during an Asset Bundle import job.
{'DataSource': {'AlternateDataSourceParameters': {'FMKBParameters': {'KnowledgeBaseArn': 'string',
'LinkedDataSourceIds': ['string']},
'GoogleDriveParameters': {'AuthType': 'THREE_LEGGED_OAUTH '
'| '
'TWO_LEGGED_OAUTH '
'| '
'SERVICE_ACCOUNT'},
'OneDriveParameters': {'AuthType': 'THREE_LEGGED_OAUTH '
'| '
'TWO_LEGGED_OAUTH '
'| '
'SERVICE_ACCOUNT',
'ClientId': 'string',
'TenantId': 'string'},
'SharePointParameters': {'AuthType': 'THREE_LEGGED_OAUTH '
'| '
'TWO_LEGGED_OAUTH '
'| '
'SERVICE_ACCOUNT',
'ClientId': 'string',
'SharePointDomain': 'string',
'TenantId': 'string'}},
'CredentialStatus': 'CONNECTED | AUTH_FAILED | NOT_VERIFIED',
'DataSourceParameters': {'FMKBParameters': {'KnowledgeBaseArn': 'string',
'LinkedDataSourceIds': ['string']},
'GoogleDriveParameters': {'AuthType': 'THREE_LEGGED_OAUTH '
'| '
'TWO_LEGGED_OAUTH '
'| '
'SERVICE_ACCOUNT'},
'OneDriveParameters': {'AuthType': 'THREE_LEGGED_OAUTH '
'| '
'TWO_LEGGED_OAUTH '
'| '
'SERVICE_ACCOUNT',
'ClientId': 'string',
'TenantId': 'string'},
'SharePointParameters': {'AuthType': 'THREE_LEGGED_OAUTH '
'| '
'TWO_LEGGED_OAUTH '
'| '
'SERVICE_ACCOUNT',
'ClientId': 'string',
'SharePointDomain': 'string',
'TenantId': 'string'}},
'LastCredentialVerifiedAt': 'timestamp'}}
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'|'S3_TABLES'|'SALESFORCE'|'SERVICENOW'|'SNOWFLAKE'|'SPARK'|'SQLSERVER'|'TERADATA'|'TWITTER'|'TIMESTREAM'|'AMAZON_OPENSEARCH'|'EXASOL'|'DATABRICKS'|'STARBURST'|'TRINO'|'BIGQUERY'|'GOOGLESHEETS'|'GOOGLE_DRIVE'|'CONFLUENCE'|'SHAREPOINT'|'ONE_DRIVE'|'WEB_CRAWLER'|'S3_KNOWLEDGE_BASE'|'QBUSINESS',
'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',
'ConsumerAccountRoleArn': 'string',
'IdentityCenterConfiguration': {
'EnableIdentityPropagation': True|False
}
},
'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',
'UseServiceName': True|False
},
'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
},
'IdentityCenterConfiguration': {
'EnableIdentityPropagation': True|False
}
},
'S3Parameters': {
'ManifestFileLocation': {
'Bucket': 'string',
'Key': 'string'
},
'RoleArn': 'string'
},
'S3TablesParameters': {
'TableBucketArn': 'string'
},
'S3KnowledgeBaseParameters': {
'RoleArn': 'string',
'BucketUrl': 'string',
'MetadataFilesLocation': 'string'
},
'ServiceNowParameters': {
'SiteBaseUrl': 'string'
},
'SnowflakeParameters': {
'Host': 'string',
'Database': 'string',
'Warehouse': 'string',
'AuthenticationType': 'PASSWORD'|'KEYPAIR'|'TOKEN'|'X509',
'DatabaseAccessControlRole': 'string',
'OAuthParameters': {
'TokenProviderUrl': 'string',
'OAuthScope': 'string',
'IdentityProviderVpcConnectionProperties': {
'VpcConnectionArn': 'string'
},
'IdentityProviderResourceUri': 'string',
'IdentityProviderCACertificatesBundleS3Uri': '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',
'DatabaseAccessControlRole': 'string',
'AuthenticationType': 'PASSWORD'|'KEYPAIR'|'TOKEN'|'X509',
'OAuthParameters': {
'TokenProviderUrl': 'string',
'OAuthScope': 'string',
'IdentityProviderVpcConnectionProperties': {
'VpcConnectionArn': 'string'
},
'IdentityProviderResourceUri': 'string',
'IdentityProviderCACertificatesBundleS3Uri': 'string'
}
},
'TrinoParameters': {
'Host': 'string',
'Port': 123,
'Catalog': 'string'
},
'BigQueryParameters': {
'ProjectId': 'string',
'DataSetRegion': 'string'
},
'ImpalaParameters': {
'Host': 'string',
'Port': 123,
'Database': 'string',
'SqlEndpointPath': 'string'
},
'CustomConnectionParameters': {
'ConnectionType': 'string'
},
'WebCrawlerParameters': {
'WebCrawlerAuthType': 'NO_AUTH'|'BASIC_AUTH'|'FORM'|'SAML',
'UsernameFieldXpath': 'string',
'PasswordFieldXpath': 'string',
'UsernameButtonXpath': 'string',
'PasswordButtonXpath': 'string',
'LoginPageUrl': 'string',
'WebProxyHostName': 'string',
'WebProxyPortNumber': 123
},
'ConfluenceParameters': {
'ConfluenceUrl': 'string'
},
'QBusinessParameters': {
'ApplicationArn': 'string'
},
'SharePointParameters': {
'SharePointDomain': 'string',
'TenantId': 'string',
'ClientId': 'string',
'AuthType': 'THREE_LEGGED_OAUTH'|'TWO_LEGGED_OAUTH'|'SERVICE_ACCOUNT'
},
'GoogleDriveParameters': {
'AuthType': 'THREE_LEGGED_OAUTH'|'TWO_LEGGED_OAUTH'|'SERVICE_ACCOUNT'
},
'OneDriveParameters': {
'TenantId': 'string',
'ClientId': 'string',
'AuthType': 'THREE_LEGGED_OAUTH'|'TWO_LEGGED_OAUTH'|'SERVICE_ACCOUNT'
},
'FMKBParameters': {
'KnowledgeBaseArn': 'string',
'LinkedDataSourceIds': [
'string',
]
}
},
'AlternateDataSourceParameters': [
{
'AmazonElasticsearchParameters': {
'Domain': 'string'
},
'AthenaParameters': {
'WorkGroup': 'string',
'RoleArn': 'string',
'ConsumerAccountRoleArn': 'string',
'IdentityCenterConfiguration': {
'EnableIdentityPropagation': True|False
}
},
'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',
'UseServiceName': True|False
},
'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
},
'IdentityCenterConfiguration': {
'EnableIdentityPropagation': True|False
}
},
'S3Parameters': {
'ManifestFileLocation': {
'Bucket': 'string',
'Key': 'string'
},
'RoleArn': 'string'
},
'S3TablesParameters': {
'TableBucketArn': 'string'
},
'S3KnowledgeBaseParameters': {
'RoleArn': 'string',
'BucketUrl': 'string',
'MetadataFilesLocation': 'string'
},
'ServiceNowParameters': {
'SiteBaseUrl': 'string'
},
'SnowflakeParameters': {
'Host': 'string',
'Database': 'string',
'Warehouse': 'string',
'AuthenticationType': 'PASSWORD'|'KEYPAIR'|'TOKEN'|'X509',
'DatabaseAccessControlRole': 'string',
'OAuthParameters': {
'TokenProviderUrl': 'string',
'OAuthScope': 'string',
'IdentityProviderVpcConnectionProperties': {
'VpcConnectionArn': 'string'
},
'IdentityProviderResourceUri': 'string',
'IdentityProviderCACertificatesBundleS3Uri': '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',
'DatabaseAccessControlRole': 'string',
'AuthenticationType': 'PASSWORD'|'KEYPAIR'|'TOKEN'|'X509',
'OAuthParameters': {
'TokenProviderUrl': 'string',
'OAuthScope': 'string',
'IdentityProviderVpcConnectionProperties': {
'VpcConnectionArn': 'string'
},
'IdentityProviderResourceUri': 'string',
'IdentityProviderCACertificatesBundleS3Uri': 'string'
}
},
'TrinoParameters': {
'Host': 'string',
'Port': 123,
'Catalog': 'string'
},
'BigQueryParameters': {
'ProjectId': 'string',
'DataSetRegion': 'string'
},
'ImpalaParameters': {
'Host': 'string',
'Port': 123,
'Database': 'string',
'SqlEndpointPath': 'string'
},
'CustomConnectionParameters': {
'ConnectionType': 'string'
},
'WebCrawlerParameters': {
'WebCrawlerAuthType': 'NO_AUTH'|'BASIC_AUTH'|'FORM'|'SAML',
'UsernameFieldXpath': 'string',
'PasswordFieldXpath': 'string',
'UsernameButtonXpath': 'string',
'PasswordButtonXpath': 'string',
'LoginPageUrl': 'string',
'WebProxyHostName': 'string',
'WebProxyPortNumber': 123
},
'ConfluenceParameters': {
'ConfluenceUrl': 'string'
},
'QBusinessParameters': {
'ApplicationArn': 'string'
},
'SharePointParameters': {
'SharePointDomain': 'string',
'TenantId': 'string',
'ClientId': 'string',
'AuthType': 'THREE_LEGGED_OAUTH'|'TWO_LEGGED_OAUTH'|'SERVICE_ACCOUNT'
},
'GoogleDriveParameters': {
'AuthType': 'THREE_LEGGED_OAUTH'|'TWO_LEGGED_OAUTH'|'SERVICE_ACCOUNT'
},
'OneDriveParameters': {
'TenantId': 'string',
'ClientId': 'string',
'AuthType': 'THREE_LEGGED_OAUTH'|'TWO_LEGGED_OAUTH'|'SERVICE_ACCOUNT'
},
'FMKBParameters': {
'KnowledgeBaseArn': 'string',
'LinkedDataSourceIds': [
'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',
'CredentialStatus': 'CONNECTED'|'AUTH_FAILED'|'NOT_VERIFIED',
'LastCredentialVerifiedAt': datetime(2015, 1, 1)
},
'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 Quick Sight 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.
ConsumerAccountRoleArn (string) --
Use ConsumerAccountRoleArn to perform cross-account Athena access. This is an IAM role ARN in the same AWS account as the Athena resources you want to access. Provide this along with RoleArn to enable role-chaining, where Amazon Quick Sight first assumes the RoleArn and then assumes the ConsumerAccountRoleArn to access Athena resources.
IdentityCenterConfiguration (dict) --
An optional parameter that configures IAM Identity Center authentication to grant Quick Sight access to your workgroup.
This parameter can only be specified if your Quick Sight account is configured with IAM Identity Center.
EnableIdentityPropagation (boolean) --
A Boolean option that controls whether Trusted Identity Propagation should be used.
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.
UseServiceName (boolean) --
A Boolean value that indicates whether the Database uses a service name or an SID. If this value is left blank, the default value is SID. If this value is set to false, the value is SID.
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 Quick Sight access to your cluster. This parameter can be used instead of DataSourceCredentials.
RoleArn (string) --
Use the RoleArn structure to allow Quick Sight to call redshift:GetClusterCredentials on your cluster. The calling principal must have iam:PassRole access to pass the role to Quick Sight. The role's trust policy must allow the Quick Sight service principal to assume the role.
DatabaseUser (string) --
The user whose permissions and group memberships will be used by Quick Sight to access the cluster. If this user already exists in your database, Amazon Quick Sight 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 Quick Sight to access the cluster. These permissions are combined with the permissions granted to Quick Sight 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, Quick Sight 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.
IdentityCenterConfiguration (dict) --
An optional parameter that configures IAM Identity Center authentication to grant Quick Sight access to your cluster.
This parameter can only be specified if your Quick Sight account is configured with IAM Identity Center.
EnableIdentityPropagation (boolean) --
A Boolean option that controls whether Trusted Identity Propagation should be used.
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 Quick Sight.
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.
S3TablesParameters (dict) --
The parameters for S3 Tables.
TableBucketArn (string) --
The Amazon Resource Name (ARN) of the S3 Tables bucket.
S3KnowledgeBaseParameters (dict) --
The parameters for S3 Knowledge Base.
RoleArn (string) --
Use the RoleArn structure to override an account-wide role for a specific S3 Knowledge Base 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 Knowledge Base data source that is specified in the structure, even if the account-wide role forbidding S3 access is still active.
BucketUrl (string) --
The URL of the S3 bucket that contains the knowledge base data.
MetadataFilesLocation (string) --
The location of metadata files within the S3 bucket that describe the structure and content of the knowledge base.
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.
AuthenticationType (string) --
The authentication type that you want to use for your connection. This parameter accepts OAuth and non-OAuth authentication types.
DatabaseAccessControlRole (string) --
The database access control role.
OAuthParameters (dict) --
An object that contains information needed to create a data source connection between an Quick Sight account and Snowflake.
TokenProviderUrl (string) --
The token endpoint URL of the identity provider.
OAuthScope (string) --
The OAuth scope.
IdentityProviderVpcConnectionProperties (dict) --
VPC connection properties.
VpcConnectionArn (string) --
The Amazon Resource Name (ARN) for the VPC connection.
IdentityProviderResourceUri (string) --
The resource uri of the identity provider.
IdentityProviderCACertificatesBundleS3Uri (string) --
The S3 URI of the identity provider's CA certificates bundle in PEM format. Use this parameter to provide a custom CA certificate bundle for the identity provider when the default trust store does not include the required certificates.
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.
DatabaseAccessControlRole (string) --
The database access control role.
AuthenticationType (string) --
The authentication type that you want to use for your connection. This parameter accepts OAuth and non-OAuth authentication types.
OAuthParameters (dict) --
An object that contains information needed to create a data source connection between an Quick Sight account and Starburst.
TokenProviderUrl (string) --
The token endpoint URL of the identity provider.
OAuthScope (string) --
The OAuth scope.
IdentityProviderVpcConnectionProperties (dict) --
VPC connection properties.
VpcConnectionArn (string) --
The Amazon Resource Name (ARN) for the VPC connection.
IdentityProviderResourceUri (string) --
The resource uri of the identity provider.
IdentityProviderCACertificatesBundleS3Uri (string) --
The S3 URI of the identity provider's CA certificates bundle in PEM format. Use this parameter to provide a custom CA certificate bundle for the identity provider when the default trust store does not include the required certificates.
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.
ImpalaParameters (dict) --
The parameters for Impala.
Host (string) --
The host name of the Impala data source.
Port (integer) --
The port of the Impala data source.
Database (string) --
The database of the Impala data source.
SqlEndpointPath (string) --
The HTTP path of the Impala data source.
CustomConnectionParameters (dict) --
The parameters for custom connectors.
ConnectionType (string) --
The type of custom connector.
WebCrawlerParameters (dict) --
The parameters for Web Crawler.
WebCrawlerAuthType (string) --
The authentication type for the web crawler. The type can be one of the following:
NO_AUTH: No authentication required.
BASIC_AUTH: Basic authentication using username and password.
SAML: SAML-based authentication.
FORM: Form-based authentication.
UsernameFieldXpath (string) --
The XPath expression for locating the username field on the login page.
PasswordFieldXpath (string) --
The XPath expression for locating the password field on the login page.
UsernameButtonXpath (string) --
The XPath expression for locating the username submit button on the login page.
PasswordButtonXpath (string) --
The XPath expression for locating the password submit button on the login page.
LoginPageUrl (string) --
The URL of the login page for the web crawler to authenticate.
WebProxyHostName (string) --
The hostname of the web proxy server for the web crawler.
WebProxyPortNumber (integer) --
The port number of the web proxy server for the web crawler.
ConfluenceParameters (dict) --
The parameters for Confluence.
ConfluenceUrl (string) --
The URL of the Confluence site to connect to.
QBusinessParameters (dict) --
The parameters for Amazon Q Business.
ApplicationArn (string) --
The Amazon Resource Name (ARN) of the Amazon Q Business application.
SharePointParameters (dict) --
The parameters for a SharePoint data source.
SharePointDomain (string) --
The SharePoint domain for the data source.
TenantId (string) --
The tenant ID for the SharePoint data source.
ClientId (string) --
The client ID for the SharePoint data source.
AuthType (string) --
The authentication type for the SharePoint data source. Valid values include:
TWO_LEGGED_OAUTH – Server-to-server authentication using client credentials that do not require user interaction.
THREE_LEGGED_OAUTH – Interactive OAuth that requires user consent.
GoogleDriveParameters (dict) --
The parameters for a Google Drive data source.
AuthType (string) --
The authentication type for the Google Drive data source. Valid values include:
SERVICE_ACCOUNT – Server-to-server authentication using a Google service account key.
THREE_LEGGED_OAUTH – Interactive OAuth that requires user consent.
OneDriveParameters (dict) --
The parameters for an OneDrive data source.
TenantId (string) --
The tenant ID for the OneDrive data source.
ClientId (string) --
The client ID for the OneDrive data source.
AuthType (string) --
The authentication type for the OneDrive data source. Valid values include:
TWO_LEGGED_OAUTH – Server-to-server authentication using client credentials that do not require user interaction.
THREE_LEGGED_OAUTH – Interactive OAuth that requires user consent.
FMKBParameters (dict) --
The parameters for a fully managed knowledge base data source.
KnowledgeBaseArn (string) --
The Amazon Resource Name (ARN) of the Amazon Bedrock knowledge base.
LinkedDataSourceIds (list) --
The IDs of the linked data sources.
(string) --
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 Quick Sight 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.
ConsumerAccountRoleArn (string) --
Use ConsumerAccountRoleArn to perform cross-account Athena access. This is an IAM role ARN in the same AWS account as the Athena resources you want to access. Provide this along with RoleArn to enable role-chaining, where Amazon Quick Sight first assumes the RoleArn and then assumes the ConsumerAccountRoleArn to access Athena resources.
IdentityCenterConfiguration (dict) --
An optional parameter that configures IAM Identity Center authentication to grant Quick Sight access to your workgroup.
This parameter can only be specified if your Quick Sight account is configured with IAM Identity Center.
EnableIdentityPropagation (boolean) --
A Boolean option that controls whether Trusted Identity Propagation should be used.
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.
UseServiceName (boolean) --
A Boolean value that indicates whether the Database uses a service name or an SID. If this value is left blank, the default value is SID. If this value is set to false, the value is SID.
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 Quick Sight access to your cluster. This parameter can be used instead of DataSourceCredentials.
RoleArn (string) --
Use the RoleArn structure to allow Quick Sight to call redshift:GetClusterCredentials on your cluster. The calling principal must have iam:PassRole access to pass the role to Quick Sight. The role's trust policy must allow the Quick Sight service principal to assume the role.
DatabaseUser (string) --
The user whose permissions and group memberships will be used by Quick Sight to access the cluster. If this user already exists in your database, Amazon Quick Sight 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 Quick Sight to access the cluster. These permissions are combined with the permissions granted to Quick Sight 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, Quick Sight 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.
IdentityCenterConfiguration (dict) --
An optional parameter that configures IAM Identity Center authentication to grant Quick Sight access to your cluster.
This parameter can only be specified if your Quick Sight account is configured with IAM Identity Center.
EnableIdentityPropagation (boolean) --
A Boolean option that controls whether Trusted Identity Propagation should be used.
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 Quick Sight.
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.
S3TablesParameters (dict) --
The parameters for S3 Tables.
TableBucketArn (string) --
The Amazon Resource Name (ARN) of the S3 Tables bucket.
S3KnowledgeBaseParameters (dict) --
The parameters for S3 Knowledge Base.
RoleArn (string) --
Use the RoleArn structure to override an account-wide role for a specific S3 Knowledge Base 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 Knowledge Base data source that is specified in the structure, even if the account-wide role forbidding S3 access is still active.
BucketUrl (string) --
The URL of the S3 bucket that contains the knowledge base data.
MetadataFilesLocation (string) --
The location of metadata files within the S3 bucket that describe the structure and content of the knowledge base.
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.
AuthenticationType (string) --
The authentication type that you want to use for your connection. This parameter accepts OAuth and non-OAuth authentication types.
DatabaseAccessControlRole (string) --
The database access control role.
OAuthParameters (dict) --
An object that contains information needed to create a data source connection between an Quick Sight account and Snowflake.
TokenProviderUrl (string) --
The token endpoint URL of the identity provider.
OAuthScope (string) --
The OAuth scope.
IdentityProviderVpcConnectionProperties (dict) --
VPC connection properties.
VpcConnectionArn (string) --
The Amazon Resource Name (ARN) for the VPC connection.
IdentityProviderResourceUri (string) --
The resource uri of the identity provider.
IdentityProviderCACertificatesBundleS3Uri (string) --
The S3 URI of the identity provider's CA certificates bundle in PEM format. Use this parameter to provide a custom CA certificate bundle for the identity provider when the default trust store does not include the required certificates.
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.
DatabaseAccessControlRole (string) --
The database access control role.
AuthenticationType (string) --
The authentication type that you want to use for your connection. This parameter accepts OAuth and non-OAuth authentication types.
OAuthParameters (dict) --
An object that contains information needed to create a data source connection between an Quick Sight account and Starburst.
TokenProviderUrl (string) --
The token endpoint URL of the identity provider.
OAuthScope (string) --
The OAuth scope.
IdentityProviderVpcConnectionProperties (dict) --
VPC connection properties.
VpcConnectionArn (string) --
The Amazon Resource Name (ARN) for the VPC connection.
IdentityProviderResourceUri (string) --
The resource uri of the identity provider.
IdentityProviderCACertificatesBundleS3Uri (string) --
The S3 URI of the identity provider's CA certificates bundle in PEM format. Use this parameter to provide a custom CA certificate bundle for the identity provider when the default trust store does not include the required certificates.
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.
ImpalaParameters (dict) --
The parameters for Impala.
Host (string) --
The host name of the Impala data source.
Port (integer) --
The port of the Impala data source.
Database (string) --
The database of the Impala data source.
SqlEndpointPath (string) --
The HTTP path of the Impala data source.
CustomConnectionParameters (dict) --
The parameters for custom connectors.
ConnectionType (string) --
The type of custom connector.
WebCrawlerParameters (dict) --
The parameters for Web Crawler.
WebCrawlerAuthType (string) --
The authentication type for the web crawler. The type can be one of the following:
NO_AUTH: No authentication required.
BASIC_AUTH: Basic authentication using username and password.
SAML: SAML-based authentication.
FORM: Form-based authentication.
UsernameFieldXpath (string) --
The XPath expression for locating the username field on the login page.
PasswordFieldXpath (string) --
The XPath expression for locating the password field on the login page.
UsernameButtonXpath (string) --
The XPath expression for locating the username submit button on the login page.
PasswordButtonXpath (string) --
The XPath expression for locating the password submit button on the login page.
LoginPageUrl (string) --
The URL of the login page for the web crawler to authenticate.
WebProxyHostName (string) --
The hostname of the web proxy server for the web crawler.
WebProxyPortNumber (integer) --
The port number of the web proxy server for the web crawler.
ConfluenceParameters (dict) --
The parameters for Confluence.
ConfluenceUrl (string) --
The URL of the Confluence site to connect to.
QBusinessParameters (dict) --
The parameters for Amazon Q Business.
ApplicationArn (string) --
The Amazon Resource Name (ARN) of the Amazon Q Business application.
SharePointParameters (dict) --
The parameters for a SharePoint data source.
SharePointDomain (string) --
The SharePoint domain for the data source.
TenantId (string) --
The tenant ID for the SharePoint data source.
ClientId (string) --
The client ID for the SharePoint data source.
AuthType (string) --
The authentication type for the SharePoint data source. Valid values include:
TWO_LEGGED_OAUTH – Server-to-server authentication using client credentials that do not require user interaction.
THREE_LEGGED_OAUTH – Interactive OAuth that requires user consent.
GoogleDriveParameters (dict) --
The parameters for a Google Drive data source.
AuthType (string) --
The authentication type for the Google Drive data source. Valid values include:
SERVICE_ACCOUNT – Server-to-server authentication using a Google service account key.
THREE_LEGGED_OAUTH – Interactive OAuth that requires user consent.
OneDriveParameters (dict) --
The parameters for an OneDrive data source.
TenantId (string) --
The tenant ID for the OneDrive data source.
ClientId (string) --
The client ID for the OneDrive data source.
AuthType (string) --
The authentication type for the OneDrive data source. Valid values include:
TWO_LEGGED_OAUTH – Server-to-server authentication using client credentials that do not require user interaction.
THREE_LEGGED_OAUTH – Interactive OAuth that requires user consent.
FMKBParameters (dict) --
The parameters for a fully managed knowledge base data source.
KnowledgeBaseArn (string) --
The Amazon Resource Name (ARN) of the Amazon Bedrock knowledge base.
LinkedDataSourceIds (list) --
The IDs of the linked data sources.
(string) --
VpcConnectionProperties (dict) --
The VPC connection information. You need to use this parameter only when you want Quick Sight 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 Quick Sight 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.
CredentialStatus (string) --
The credential verification status of the data source. Valid values include:
CONNECTED – Credential validation succeeded.
AUTH_FAILED – Credential validation failed.
NOT_VERIFIED – Credential validation has not been performed.
LastCredentialVerifiedAt (datetime) --
The time that the credentials were last verified.
RequestId (string) --
The Amazon Web Services request ID for this operation.
Status (integer) --
The HTTP status of the request.
{'KnowledgeBase': {'AccessControlConfiguration': {'isACLEnabled': 'boolean'}}}
Describes a knowledge base.
See also: AWS API Documentation
Request Syntax
client.describe_knowledge_base(
AwsAccountId='string',
KnowledgeBaseId='string'
)
string
[REQUIRED]
The ID of the Amazon Web Services account that contains the knowledge base.
string
[REQUIRED]
The unique identifier for the knowledge base.
dict
Response Syntax
{
'KnowledgeBase': {
'KnowledgeBaseArn': 'string',
'KnowledgeBaseId': 'string',
'Name': 'string',
'Status': 'CREATING'|'UPDATING'|'ACTIVE'|'FAILED'|'DELETING',
'DataSourceArn': 'string',
'KnowledgeBaseConfiguration': {
'templateConfiguration': {
'template': {...}|[...]|123|123.4|'string'|True|None
}
},
'MediaExtractionConfiguration': {
'imageExtractionConfiguration': {
'imageExtractionStatus': 'ENABLED'|'DISABLED'
},
'audioExtractionConfiguration': {
'audioExtractionStatus': 'ENABLED'|'DISABLED'
},
'videoExtractionConfiguration': {
'videoExtractionStatus': 'ENABLED'|'DISABLED',
'videoExtractionType': 'AUDIO_TRANSCRIPTION_ONLY'|'VISUAL_CONTENT_AND_AUDIO_TRANSCRIPTION'
}
},
'AccessControlConfiguration': {
'isACLEnabled': True|False
},
'Type': 'string',
'CreatedAt': datetime(2015, 1, 1),
'UpdatedAt': datetime(2015, 1, 1),
'Description': 'string',
'IsEmailNotificationOptedForIngestionFailures': True|False,
'FirstCompletedIngestionSummary': {
'IngestionId': 'string',
'IngestionStatus': 'QUEUED'|'RUNNING'|'FAILED'|'COMPLETED'|'INCOMPLETE'|'CANCELLED'|'CANCELLING'|'TIMEOUT',
'StartTime': datetime(2015, 1, 1),
'EndTime': datetime(2015, 1, 1)
},
'FirstIncompleteIngestionSummary': {
'IngestionId': 'string',
'IngestionStatus': 'QUEUED'|'RUNNING'|'FAILED'|'COMPLETED'|'INCOMPLETE'|'CANCELLED'|'CANCELLING'|'TIMEOUT',
'StartTime': datetime(2015, 1, 1),
'EndTime': datetime(2015, 1, 1)
},
'LatestIngestionSummary': {
'IngestionId': 'string',
'IngestionStatus': 'QUEUED'|'RUNNING'|'FAILED'|'COMPLETED'|'INCOMPLETE'|'CANCELLED'|'CANCELLING'|'TIMEOUT',
'StartTime': datetime(2015, 1, 1),
'EndTime': datetime(2015, 1, 1)
},
'KnowledgeBaseSizeBytes': 123,
'DocumentCount': 123,
'PrimaryOwnerArn': 'string',
'PrimaryOwnerUsername': 'string'
},
'RequestId': 'string',
'Status': 123
}
Response Structure
(dict) --
KnowledgeBase (dict) --
The knowledge base.
KnowledgeBaseArn (string) --
The Amazon Resource Name (ARN) of the knowledge base.
KnowledgeBaseId (string) --
The unique identifier for the knowledge base.
Name (string) --
The name of the knowledge base.
Status (string) --
The status of the knowledge base.
DataSourceArn (string) --
The ARN of the data source associated with the knowledge base.
KnowledgeBaseConfiguration (dict) --
The configuration settings for the knowledge base.
templateConfiguration (dict) --
The template configuration for the knowledge base.
template (:ref:`document<document>`) --
The template document that defines the knowledge base behavior.
MediaExtractionConfiguration (dict) --
The media extraction configuration for the knowledge base.
imageExtractionConfiguration (dict) --
The configuration for image extraction.
imageExtractionStatus (string) --
The status of image extraction. Valid values are ENABLED and DISABLED.
audioExtractionConfiguration (dict) --
The configuration for audio extraction.
audioExtractionStatus (string) --
The status of audio extraction. Valid values are ENABLED and DISABLED.
videoExtractionConfiguration (dict) --
The configuration for video extraction.
videoExtractionStatus (string) --
The status of video extraction. Valid values are ENABLED and DISABLED.
videoExtractionType (string) --
The type of video extraction to perform.
AccessControlConfiguration (dict) --
The access control configuration for the knowledge base.
isACLEnabled (boolean) --
Specifies whether ACLs are enabled for the knowledge base.
Type (string) --
The type of the knowledge base.
CreatedAt (datetime) --
The date and time that the knowledge base was created.
UpdatedAt (datetime) --
The date and time that the knowledge base was last updated.
Description (string) --
The description of the knowledge base.
IsEmailNotificationOptedForIngestionFailures (boolean) --
Specifies whether email notifications are enabled for ingestion failures.
FirstCompletedIngestionSummary (dict) --
A summary of the first completed ingestion for the knowledge base.
IngestionId (string) --
The unique identifier for the ingestion job.
IngestionStatus (string) --
The status of the ingestion job.
StartTime (datetime) --
The start time of the ingestion job.
EndTime (datetime) --
The end time of the ingestion job.
FirstIncompleteIngestionSummary (dict) --
A summary of the first incomplete ingestion for the knowledge base.
IngestionId (string) --
The unique identifier for the ingestion job.
IngestionStatus (string) --
The status of the ingestion job.
StartTime (datetime) --
The start time of the ingestion job.
EndTime (datetime) --
The end time of the ingestion job.
LatestIngestionSummary (dict) --
A summary of the most recent ingestion for the knowledge base.
IngestionId (string) --
The unique identifier for the ingestion job.
IngestionStatus (string) --
The status of the ingestion job.
StartTime (datetime) --
The start time of the ingestion job.
EndTime (datetime) --
The end time of the ingestion job.
KnowledgeBaseSizeBytes (integer) --
The size of the knowledge base in bytes.
DocumentCount (integer) --
The number of documents in the knowledge base.
PrimaryOwnerArn (string) --
The ARN of the primary owner of the knowledge base.
PrimaryOwnerUsername (string) --
The username of the primary owner of the knowledge base.
RequestId (string) --
The Amazon Web Services request ID for this operation.
Status (integer) --
The HTTP status of the request.
{'DataSources': {'AlternateDataSourceParameters': {'FMKBParameters': {'KnowledgeBaseArn': 'string',
'LinkedDataSourceIds': ['string']},
'GoogleDriveParameters': {'AuthType': 'THREE_LEGGED_OAUTH '
'| '
'TWO_LEGGED_OAUTH '
'| '
'SERVICE_ACCOUNT'},
'OneDriveParameters': {'AuthType': 'THREE_LEGGED_OAUTH '
'| '
'TWO_LEGGED_OAUTH '
'| '
'SERVICE_ACCOUNT',
'ClientId': 'string',
'TenantId': 'string'},
'SharePointParameters': {'AuthType': 'THREE_LEGGED_OAUTH '
'| '
'TWO_LEGGED_OAUTH '
'| '
'SERVICE_ACCOUNT',
'ClientId': 'string',
'SharePointDomain': 'string',
'TenantId': 'string'}},
'CredentialStatus': 'CONNECTED | AUTH_FAILED | NOT_VERIFIED',
'DataSourceParameters': {'FMKBParameters': {'KnowledgeBaseArn': 'string',
'LinkedDataSourceIds': ['string']},
'GoogleDriveParameters': {'AuthType': 'THREE_LEGGED_OAUTH '
'| '
'TWO_LEGGED_OAUTH '
'| '
'SERVICE_ACCOUNT'},
'OneDriveParameters': {'AuthType': 'THREE_LEGGED_OAUTH '
'| '
'TWO_LEGGED_OAUTH '
'| '
'SERVICE_ACCOUNT',
'ClientId': 'string',
'TenantId': 'string'},
'SharePointParameters': {'AuthType': 'THREE_LEGGED_OAUTH '
'| '
'TWO_LEGGED_OAUTH '
'| '
'SERVICE_ACCOUNT',
'ClientId': 'string',
'SharePointDomain': 'string',
'TenantId': 'string'}},
'LastCredentialVerifiedAt': 'timestamp'}}
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'|'S3_TABLES'|'SALESFORCE'|'SERVICENOW'|'SNOWFLAKE'|'SPARK'|'SQLSERVER'|'TERADATA'|'TWITTER'|'TIMESTREAM'|'AMAZON_OPENSEARCH'|'EXASOL'|'DATABRICKS'|'STARBURST'|'TRINO'|'BIGQUERY'|'GOOGLESHEETS'|'GOOGLE_DRIVE'|'CONFLUENCE'|'SHAREPOINT'|'ONE_DRIVE'|'WEB_CRAWLER'|'S3_KNOWLEDGE_BASE'|'QBUSINESS',
'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',
'ConsumerAccountRoleArn': 'string',
'IdentityCenterConfiguration': {
'EnableIdentityPropagation': True|False
}
},
'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',
'UseServiceName': True|False
},
'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
},
'IdentityCenterConfiguration': {
'EnableIdentityPropagation': True|False
}
},
'S3Parameters': {
'ManifestFileLocation': {
'Bucket': 'string',
'Key': 'string'
},
'RoleArn': 'string'
},
'S3TablesParameters': {
'TableBucketArn': 'string'
},
'S3KnowledgeBaseParameters': {
'RoleArn': 'string',
'BucketUrl': 'string',
'MetadataFilesLocation': 'string'
},
'ServiceNowParameters': {
'SiteBaseUrl': 'string'
},
'SnowflakeParameters': {
'Host': 'string',
'Database': 'string',
'Warehouse': 'string',
'AuthenticationType': 'PASSWORD'|'KEYPAIR'|'TOKEN'|'X509',
'DatabaseAccessControlRole': 'string',
'OAuthParameters': {
'TokenProviderUrl': 'string',
'OAuthScope': 'string',
'IdentityProviderVpcConnectionProperties': {
'VpcConnectionArn': 'string'
},
'IdentityProviderResourceUri': 'string',
'IdentityProviderCACertificatesBundleS3Uri': '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',
'DatabaseAccessControlRole': 'string',
'AuthenticationType': 'PASSWORD'|'KEYPAIR'|'TOKEN'|'X509',
'OAuthParameters': {
'TokenProviderUrl': 'string',
'OAuthScope': 'string',
'IdentityProviderVpcConnectionProperties': {
'VpcConnectionArn': 'string'
},
'IdentityProviderResourceUri': 'string',
'IdentityProviderCACertificatesBundleS3Uri': 'string'
}
},
'TrinoParameters': {
'Host': 'string',
'Port': 123,
'Catalog': 'string'
},
'BigQueryParameters': {
'ProjectId': 'string',
'DataSetRegion': 'string'
},
'ImpalaParameters': {
'Host': 'string',
'Port': 123,
'Database': 'string',
'SqlEndpointPath': 'string'
},
'CustomConnectionParameters': {
'ConnectionType': 'string'
},
'WebCrawlerParameters': {
'WebCrawlerAuthType': 'NO_AUTH'|'BASIC_AUTH'|'FORM'|'SAML',
'UsernameFieldXpath': 'string',
'PasswordFieldXpath': 'string',
'UsernameButtonXpath': 'string',
'PasswordButtonXpath': 'string',
'LoginPageUrl': 'string',
'WebProxyHostName': 'string',
'WebProxyPortNumber': 123
},
'ConfluenceParameters': {
'ConfluenceUrl': 'string'
},
'QBusinessParameters': {
'ApplicationArn': 'string'
},
'SharePointParameters': {
'SharePointDomain': 'string',
'TenantId': 'string',
'ClientId': 'string',
'AuthType': 'THREE_LEGGED_OAUTH'|'TWO_LEGGED_OAUTH'|'SERVICE_ACCOUNT'
},
'GoogleDriveParameters': {
'AuthType': 'THREE_LEGGED_OAUTH'|'TWO_LEGGED_OAUTH'|'SERVICE_ACCOUNT'
},
'OneDriveParameters': {
'TenantId': 'string',
'ClientId': 'string',
'AuthType': 'THREE_LEGGED_OAUTH'|'TWO_LEGGED_OAUTH'|'SERVICE_ACCOUNT'
},
'FMKBParameters': {
'KnowledgeBaseArn': 'string',
'LinkedDataSourceIds': [
'string',
]
}
},
'AlternateDataSourceParameters': [
{
'AmazonElasticsearchParameters': {
'Domain': 'string'
},
'AthenaParameters': {
'WorkGroup': 'string',
'RoleArn': 'string',
'ConsumerAccountRoleArn': 'string',
'IdentityCenterConfiguration': {
'EnableIdentityPropagation': True|False
}
},
'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',
'UseServiceName': True|False
},
'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
},
'IdentityCenterConfiguration': {
'EnableIdentityPropagation': True|False
}
},
'S3Parameters': {
'ManifestFileLocation': {
'Bucket': 'string',
'Key': 'string'
},
'RoleArn': 'string'
},
'S3TablesParameters': {
'TableBucketArn': 'string'
},
'S3KnowledgeBaseParameters': {
'RoleArn': 'string',
'BucketUrl': 'string',
'MetadataFilesLocation': 'string'
},
'ServiceNowParameters': {
'SiteBaseUrl': 'string'
},
'SnowflakeParameters': {
'Host': 'string',
'Database': 'string',
'Warehouse': 'string',
'AuthenticationType': 'PASSWORD'|'KEYPAIR'|'TOKEN'|'X509',
'DatabaseAccessControlRole': 'string',
'OAuthParameters': {
'TokenProviderUrl': 'string',
'OAuthScope': 'string',
'IdentityProviderVpcConnectionProperties': {
'VpcConnectionArn': 'string'
},
'IdentityProviderResourceUri': 'string',
'IdentityProviderCACertificatesBundleS3Uri': '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',
'DatabaseAccessControlRole': 'string',
'AuthenticationType': 'PASSWORD'|'KEYPAIR'|'TOKEN'|'X509',
'OAuthParameters': {
'TokenProviderUrl': 'string',
'OAuthScope': 'string',
'IdentityProviderVpcConnectionProperties': {
'VpcConnectionArn': 'string'
},
'IdentityProviderResourceUri': 'string',
'IdentityProviderCACertificatesBundleS3Uri': 'string'
}
},
'TrinoParameters': {
'Host': 'string',
'Port': 123,
'Catalog': 'string'
},
'BigQueryParameters': {
'ProjectId': 'string',
'DataSetRegion': 'string'
},
'ImpalaParameters': {
'Host': 'string',
'Port': 123,
'Database': 'string',
'SqlEndpointPath': 'string'
},
'CustomConnectionParameters': {
'ConnectionType': 'string'
},
'WebCrawlerParameters': {
'WebCrawlerAuthType': 'NO_AUTH'|'BASIC_AUTH'|'FORM'|'SAML',
'UsernameFieldXpath': 'string',
'PasswordFieldXpath': 'string',
'UsernameButtonXpath': 'string',
'PasswordButtonXpath': 'string',
'LoginPageUrl': 'string',
'WebProxyHostName': 'string',
'WebProxyPortNumber': 123
},
'ConfluenceParameters': {
'ConfluenceUrl': 'string'
},
'QBusinessParameters': {
'ApplicationArn': 'string'
},
'SharePointParameters': {
'SharePointDomain': 'string',
'TenantId': 'string',
'ClientId': 'string',
'AuthType': 'THREE_LEGGED_OAUTH'|'TWO_LEGGED_OAUTH'|'SERVICE_ACCOUNT'
},
'GoogleDriveParameters': {
'AuthType': 'THREE_LEGGED_OAUTH'|'TWO_LEGGED_OAUTH'|'SERVICE_ACCOUNT'
},
'OneDriveParameters': {
'TenantId': 'string',
'ClientId': 'string',
'AuthType': 'THREE_LEGGED_OAUTH'|'TWO_LEGGED_OAUTH'|'SERVICE_ACCOUNT'
},
'FMKBParameters': {
'KnowledgeBaseArn': 'string',
'LinkedDataSourceIds': [
'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',
'CredentialStatus': 'CONNECTED'|'AUTH_FAILED'|'NOT_VERIFIED',
'LastCredentialVerifiedAt': datetime(2015, 1, 1)
},
],
'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 Quick Sight 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.
ConsumerAccountRoleArn (string) --
Use ConsumerAccountRoleArn to perform cross-account Athena access. This is an IAM role ARN in the same AWS account as the Athena resources you want to access. Provide this along with RoleArn to enable role-chaining, where Amazon Quick Sight first assumes the RoleArn and then assumes the ConsumerAccountRoleArn to access Athena resources.
IdentityCenterConfiguration (dict) --
An optional parameter that configures IAM Identity Center authentication to grant Quick Sight access to your workgroup.
This parameter can only be specified if your Quick Sight account is configured with IAM Identity Center.
EnableIdentityPropagation (boolean) --
A Boolean option that controls whether Trusted Identity Propagation should be used.
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.
UseServiceName (boolean) --
A Boolean value that indicates whether the Database uses a service name or an SID. If this value is left blank, the default value is SID. If this value is set to false, the value is SID.
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 Quick Sight access to your cluster. This parameter can be used instead of DataSourceCredentials.
RoleArn (string) --
Use the RoleArn structure to allow Quick Sight to call redshift:GetClusterCredentials on your cluster. The calling principal must have iam:PassRole access to pass the role to Quick Sight. The role's trust policy must allow the Quick Sight service principal to assume the role.
DatabaseUser (string) --
The user whose permissions and group memberships will be used by Quick Sight to access the cluster. If this user already exists in your database, Amazon Quick Sight 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 Quick Sight to access the cluster. These permissions are combined with the permissions granted to Quick Sight 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, Quick Sight 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.
IdentityCenterConfiguration (dict) --
An optional parameter that configures IAM Identity Center authentication to grant Quick Sight access to your cluster.
This parameter can only be specified if your Quick Sight account is configured with IAM Identity Center.
EnableIdentityPropagation (boolean) --
A Boolean option that controls whether Trusted Identity Propagation should be used.
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 Quick Sight.
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.
S3TablesParameters (dict) --
The parameters for S3 Tables.
TableBucketArn (string) --
The Amazon Resource Name (ARN) of the S3 Tables bucket.
S3KnowledgeBaseParameters (dict) --
The parameters for S3 Knowledge Base.
RoleArn (string) --
Use the RoleArn structure to override an account-wide role for a specific S3 Knowledge Base 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 Knowledge Base data source that is specified in the structure, even if the account-wide role forbidding S3 access is still active.
BucketUrl (string) --
The URL of the S3 bucket that contains the knowledge base data.
MetadataFilesLocation (string) --
The location of metadata files within the S3 bucket that describe the structure and content of the knowledge base.
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.
AuthenticationType (string) --
The authentication type that you want to use for your connection. This parameter accepts OAuth and non-OAuth authentication types.
DatabaseAccessControlRole (string) --
The database access control role.
OAuthParameters (dict) --
An object that contains information needed to create a data source connection between an Quick Sight account and Snowflake.
TokenProviderUrl (string) --
The token endpoint URL of the identity provider.
OAuthScope (string) --
The OAuth scope.
IdentityProviderVpcConnectionProperties (dict) --
VPC connection properties.
VpcConnectionArn (string) --
The Amazon Resource Name (ARN) for the VPC connection.
IdentityProviderResourceUri (string) --
The resource uri of the identity provider.
IdentityProviderCACertificatesBundleS3Uri (string) --
The S3 URI of the identity provider's CA certificates bundle in PEM format. Use this parameter to provide a custom CA certificate bundle for the identity provider when the default trust store does not include the required certificates.
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.
DatabaseAccessControlRole (string) --
The database access control role.
AuthenticationType (string) --
The authentication type that you want to use for your connection. This parameter accepts OAuth and non-OAuth authentication types.
OAuthParameters (dict) --
An object that contains information needed to create a data source connection between an Quick Sight account and Starburst.
TokenProviderUrl (string) --
The token endpoint URL of the identity provider.
OAuthScope (string) --
The OAuth scope.
IdentityProviderVpcConnectionProperties (dict) --
VPC connection properties.
VpcConnectionArn (string) --
The Amazon Resource Name (ARN) for the VPC connection.
IdentityProviderResourceUri (string) --
The resource uri of the identity provider.
IdentityProviderCACertificatesBundleS3Uri (string) --
The S3 URI of the identity provider's CA certificates bundle in PEM format. Use this parameter to provide a custom CA certificate bundle for the identity provider when the default trust store does not include the required certificates.
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.
ImpalaParameters (dict) --
The parameters for Impala.
Host (string) --
The host name of the Impala data source.
Port (integer) --
The port of the Impala data source.
Database (string) --
The database of the Impala data source.
SqlEndpointPath (string) --
The HTTP path of the Impala data source.
CustomConnectionParameters (dict) --
The parameters for custom connectors.
ConnectionType (string) --
The type of custom connector.
WebCrawlerParameters (dict) --
The parameters for Web Crawler.
WebCrawlerAuthType (string) --
The authentication type for the web crawler. The type can be one of the following:
NO_AUTH: No authentication required.
BASIC_AUTH: Basic authentication using username and password.
SAML: SAML-based authentication.
FORM: Form-based authentication.
UsernameFieldXpath (string) --
The XPath expression for locating the username field on the login page.
PasswordFieldXpath (string) --
The XPath expression for locating the password field on the login page.
UsernameButtonXpath (string) --
The XPath expression for locating the username submit button on the login page.
PasswordButtonXpath (string) --
The XPath expression for locating the password submit button on the login page.
LoginPageUrl (string) --
The URL of the login page for the web crawler to authenticate.
WebProxyHostName (string) --
The hostname of the web proxy server for the web crawler.
WebProxyPortNumber (integer) --
The port number of the web proxy server for the web crawler.
ConfluenceParameters (dict) --
The parameters for Confluence.
ConfluenceUrl (string) --
The URL of the Confluence site to connect to.
QBusinessParameters (dict) --
The parameters for Amazon Q Business.
ApplicationArn (string) --
The Amazon Resource Name (ARN) of the Amazon Q Business application.
SharePointParameters (dict) --
The parameters for a SharePoint data source.
SharePointDomain (string) --
The SharePoint domain for the data source.
TenantId (string) --
The tenant ID for the SharePoint data source.
ClientId (string) --
The client ID for the SharePoint data source.
AuthType (string) --
The authentication type for the SharePoint data source. Valid values include:
TWO_LEGGED_OAUTH – Server-to-server authentication using client credentials that do not require user interaction.
THREE_LEGGED_OAUTH – Interactive OAuth that requires user consent.
GoogleDriveParameters (dict) --
The parameters for a Google Drive data source.
AuthType (string) --
The authentication type for the Google Drive data source. Valid values include:
SERVICE_ACCOUNT – Server-to-server authentication using a Google service account key.
THREE_LEGGED_OAUTH – Interactive OAuth that requires user consent.
OneDriveParameters (dict) --
The parameters for an OneDrive data source.
TenantId (string) --
The tenant ID for the OneDrive data source.
ClientId (string) --
The client ID for the OneDrive data source.
AuthType (string) --
The authentication type for the OneDrive data source. Valid values include:
TWO_LEGGED_OAUTH – Server-to-server authentication using client credentials that do not require user interaction.
THREE_LEGGED_OAUTH – Interactive OAuth that requires user consent.
FMKBParameters (dict) --
The parameters for a fully managed knowledge base data source.
KnowledgeBaseArn (string) --
The Amazon Resource Name (ARN) of the Amazon Bedrock knowledge base.
LinkedDataSourceIds (list) --
The IDs of the linked data sources.
(string) --
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 Quick Sight 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.
ConsumerAccountRoleArn (string) --
Use ConsumerAccountRoleArn to perform cross-account Athena access. This is an IAM role ARN in the same AWS account as the Athena resources you want to access. Provide this along with RoleArn to enable role-chaining, where Amazon Quick Sight first assumes the RoleArn and then assumes the ConsumerAccountRoleArn to access Athena resources.
IdentityCenterConfiguration (dict) --
An optional parameter that configures IAM Identity Center authentication to grant Quick Sight access to your workgroup.
This parameter can only be specified if your Quick Sight account is configured with IAM Identity Center.
EnableIdentityPropagation (boolean) --
A Boolean option that controls whether Trusted Identity Propagation should be used.
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.
UseServiceName (boolean) --
A Boolean value that indicates whether the Database uses a service name or an SID. If this value is left blank, the default value is SID. If this value is set to false, the value is SID.
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 Quick Sight access to your cluster. This parameter can be used instead of DataSourceCredentials.
RoleArn (string) --
Use the RoleArn structure to allow Quick Sight to call redshift:GetClusterCredentials on your cluster. The calling principal must have iam:PassRole access to pass the role to Quick Sight. The role's trust policy must allow the Quick Sight service principal to assume the role.
DatabaseUser (string) --
The user whose permissions and group memberships will be used by Quick Sight to access the cluster. If this user already exists in your database, Amazon Quick Sight 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 Quick Sight to access the cluster. These permissions are combined with the permissions granted to Quick Sight 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, Quick Sight 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.
IdentityCenterConfiguration (dict) --
An optional parameter that configures IAM Identity Center authentication to grant Quick Sight access to your cluster.
This parameter can only be specified if your Quick Sight account is configured with IAM Identity Center.
EnableIdentityPropagation (boolean) --
A Boolean option that controls whether Trusted Identity Propagation should be used.
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 Quick Sight.
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.
S3TablesParameters (dict) --
The parameters for S3 Tables.
TableBucketArn (string) --
The Amazon Resource Name (ARN) of the S3 Tables bucket.
S3KnowledgeBaseParameters (dict) --
The parameters for S3 Knowledge Base.
RoleArn (string) --
Use the RoleArn structure to override an account-wide role for a specific S3 Knowledge Base 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 Knowledge Base data source that is specified in the structure, even if the account-wide role forbidding S3 access is still active.
BucketUrl (string) --
The URL of the S3 bucket that contains the knowledge base data.
MetadataFilesLocation (string) --
The location of metadata files within the S3 bucket that describe the structure and content of the knowledge base.
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.
AuthenticationType (string) --
The authentication type that you want to use for your connection. This parameter accepts OAuth and non-OAuth authentication types.
DatabaseAccessControlRole (string) --
The database access control role.
OAuthParameters (dict) --
An object that contains information needed to create a data source connection between an Quick Sight account and Snowflake.
TokenProviderUrl (string) --
The token endpoint URL of the identity provider.
OAuthScope (string) --
The OAuth scope.
IdentityProviderVpcConnectionProperties (dict) --
VPC connection properties.
VpcConnectionArn (string) --
The Amazon Resource Name (ARN) for the VPC connection.
IdentityProviderResourceUri (string) --
The resource uri of the identity provider.
IdentityProviderCACertificatesBundleS3Uri (string) --
The S3 URI of the identity provider's CA certificates bundle in PEM format. Use this parameter to provide a custom CA certificate bundle for the identity provider when the default trust store does not include the required certificates.
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.
DatabaseAccessControlRole (string) --
The database access control role.
AuthenticationType (string) --
The authentication type that you want to use for your connection. This parameter accepts OAuth and non-OAuth authentication types.
OAuthParameters (dict) --
An object that contains information needed to create a data source connection between an Quick Sight account and Starburst.
TokenProviderUrl (string) --
The token endpoint URL of the identity provider.
OAuthScope (string) --
The OAuth scope.
IdentityProviderVpcConnectionProperties (dict) --
VPC connection properties.
VpcConnectionArn (string) --
The Amazon Resource Name (ARN) for the VPC connection.
IdentityProviderResourceUri (string) --
The resource uri of the identity provider.
IdentityProviderCACertificatesBundleS3Uri (string) --
The S3 URI of the identity provider's CA certificates bundle in PEM format. Use this parameter to provide a custom CA certificate bundle for the identity provider when the default trust store does not include the required certificates.
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.
ImpalaParameters (dict) --
The parameters for Impala.
Host (string) --
The host name of the Impala data source.
Port (integer) --
The port of the Impala data source.
Database (string) --
The database of the Impala data source.
SqlEndpointPath (string) --
The HTTP path of the Impala data source.
CustomConnectionParameters (dict) --
The parameters for custom connectors.
ConnectionType (string) --
The type of custom connector.
WebCrawlerParameters (dict) --
The parameters for Web Crawler.
WebCrawlerAuthType (string) --
The authentication type for the web crawler. The type can be one of the following:
NO_AUTH: No authentication required.
BASIC_AUTH: Basic authentication using username and password.
SAML: SAML-based authentication.
FORM: Form-based authentication.
UsernameFieldXpath (string) --
The XPath expression for locating the username field on the login page.
PasswordFieldXpath (string) --
The XPath expression for locating the password field on the login page.
UsernameButtonXpath (string) --
The XPath expression for locating the username submit button on the login page.
PasswordButtonXpath (string) --
The XPath expression for locating the password submit button on the login page.
LoginPageUrl (string) --
The URL of the login page for the web crawler to authenticate.
WebProxyHostName (string) --
The hostname of the web proxy server for the web crawler.
WebProxyPortNumber (integer) --
The port number of the web proxy server for the web crawler.
ConfluenceParameters (dict) --
The parameters for Confluence.
ConfluenceUrl (string) --
The URL of the Confluence site to connect to.
QBusinessParameters (dict) --
The parameters for Amazon Q Business.
ApplicationArn (string) --
The Amazon Resource Name (ARN) of the Amazon Q Business application.
SharePointParameters (dict) --
The parameters for a SharePoint data source.
SharePointDomain (string) --
The SharePoint domain for the data source.
TenantId (string) --
The tenant ID for the SharePoint data source.
ClientId (string) --
The client ID for the SharePoint data source.
AuthType (string) --
The authentication type for the SharePoint data source. Valid values include:
TWO_LEGGED_OAUTH – Server-to-server authentication using client credentials that do not require user interaction.
THREE_LEGGED_OAUTH – Interactive OAuth that requires user consent.
GoogleDriveParameters (dict) --
The parameters for a Google Drive data source.
AuthType (string) --
The authentication type for the Google Drive data source. Valid values include:
SERVICE_ACCOUNT – Server-to-server authentication using a Google service account key.
THREE_LEGGED_OAUTH – Interactive OAuth that requires user consent.
OneDriveParameters (dict) --
The parameters for an OneDrive data source.
TenantId (string) --
The tenant ID for the OneDrive data source.
ClientId (string) --
The client ID for the OneDrive data source.
AuthType (string) --
The authentication type for the OneDrive data source. Valid values include:
TWO_LEGGED_OAUTH – Server-to-server authentication using client credentials that do not require user interaction.
THREE_LEGGED_OAUTH – Interactive OAuth that requires user consent.
FMKBParameters (dict) --
The parameters for a fully managed knowledge base data source.
KnowledgeBaseArn (string) --
The Amazon Resource Name (ARN) of the Amazon Bedrock knowledge base.
LinkedDataSourceIds (list) --
The IDs of the linked data sources.
(string) --
VpcConnectionProperties (dict) --
The VPC connection information. You need to use this parameter only when you want Quick Sight 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 Quick Sight 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.
CredentialStatus (string) --
The credential verification status of the data source. Valid values include:
CONNECTED – Credential validation succeeded.
AUTH_FAILED – Credential validation failed.
NOT_VERIFIED – Credential validation has not been performed.
LastCredentialVerifiedAt (datetime) --
The time that the credentials were last verified.
NextToken (string) --
The token for the next set of results, or null if there are no more results.
RequestId (string) --
The Amazon Web Services request ID for this operation.
Status (integer) --
The HTTP status of the request.
{'Filters': {'name': {'DATASOURCE_ARN'}}}
Searches for a subset of knowledge bases based on specified filters.
See also: AWS API Documentation
Request Syntax
client.search_knowledge_bases(
AwsAccountId='string',
NextToken='string',
MaxResults=123,
Filters=[
{
'name': 'KNOWLEDGE_BASE_ID'|'KNOWLEDGE_BASE_NAME'|'DIRECT_QUICKSIGHT_OWNER'|'DIRECT_QUICKSIGHT_VIEWER_OR_OWNER'|'DIRECT_QUICKSIGHT_SOLE_OWNER'|'KNOWLEDGE_BASE_SIZE_BYTES'|'PRIMARY_OWNER'|'DATASOURCE_ARN',
'operator': 'STRING_EQUALS'|'STRING_LIKE'|'GREATER_THAN_OR_EQUALS'|'LESS_THAN_OR_EQUALS',
'value': 'string'
},
],
SortBy={
'sortByField': 'KNOWLEDGE_BASE_SIZE_BYTES'|'CREATED_AT',
'sortOrder': 'ASC'|'DESC'
}
)
string
[REQUIRED]
The ID of the Amazon Web Services account that contains the knowledge base.
string
The token for the next set of results, or null if there are no more results.
integer
The maximum number of results to return.
list
The filters to apply when searching knowledge bases.
(dict) --
A filter to apply when searching knowledge bases.
name (string) -- [REQUIRED]
The name of the field to filter on.
operator (string) -- [REQUIRED]
The comparison operator to use for the filter.
value (string) -- [REQUIRED]
The value to filter on.
dict
The sort configuration for the search results.
sortByField (string) -- [REQUIRED]
The field to sort by.
sortOrder (string) -- [REQUIRED]
The sort order (ascending or descending).
dict
Response Syntax
{
'KnowledgeBaseSummaries': [
{
'KnowledgeBaseArn': 'string',
'KnowledgeBaseId': 'string',
'Name': 'string',
'Status': 'CREATING'|'UPDATING'|'ACTIVE'|'FAILED'|'DELETING',
'DataSourceArn': 'string',
'Type': 'string',
'CreatedAt': datetime(2015, 1, 1),
'UpdatedAt': datetime(2015, 1, 1),
'KnowledgeBaseSizeBytes': 123,
'DocumentCount': 123,
'PrimaryOwnerArn': 'string',
'PrimaryOwnerUsername': 'string'
},
],
'NextToken': 'string',
'RequestId': 'string',
'Status': 123
}
Response Structure
(dict) --
KnowledgeBaseSummaries (list) --
A list of knowledge base summaries.
(dict) --
A summary of a knowledge base, including its identifier, name, status, and metadata.
KnowledgeBaseArn (string) --
The Amazon Resource Name (ARN) of the knowledge base.
KnowledgeBaseId (string) --
The unique identifier for the knowledge base.
Name (string) --
The name of the knowledge base.
Status (string) --
The status of the knowledge base.
DataSourceArn (string) --
The ARN of the data source associated with the knowledge base.
Type (string) --
The type of the knowledge base.
CreatedAt (datetime) --
The date and time that the knowledge base was created.
UpdatedAt (datetime) --
The date and time that the knowledge base was last updated.
KnowledgeBaseSizeBytes (integer) --
The size of the knowledge base in bytes.
DocumentCount (integer) --
The number of documents in the knowledge base.
PrimaryOwnerArn (string) --
The ARN of the primary owner of the knowledge base.
PrimaryOwnerUsername (string) --
The username of the primary owner of the knowledge base.
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.
{'OverrideParameters': {'DataSources': {'DataSourceParameters': {'FMKBParameters': {'KnowledgeBaseArn': 'string',
'LinkedDataSourceIds': ['string']},
'GoogleDriveParameters': {'AuthType': 'THREE_LEGGED_OAUTH '
'| '
'TWO_LEGGED_OAUTH '
'| '
'SERVICE_ACCOUNT'},
'OneDriveParameters': {'AuthType': 'THREE_LEGGED_OAUTH '
'| '
'TWO_LEGGED_OAUTH '
'| '
'SERVICE_ACCOUNT',
'ClientId': 'string',
'TenantId': 'string'},
'SharePointParameters': {'AuthType': 'THREE_LEGGED_OAUTH '
'| '
'TWO_LEGGED_OAUTH '
'| '
'SERVICE_ACCOUNT',
'ClientId': 'string',
'SharePointDomain': 'string',
'TenantId': 'string'}}}}}
Starts an Asset Bundle import job.
An Asset Bundle import job imports specified Amazon Quick Sight assets into an Amazon Quick Sight 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 Quick Sight account. Each Amazon Quick Sight 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',
'ConsumerAccountRoleArn': 'string',
'IdentityCenterConfiguration': {
'EnableIdentityPropagation': True|False
}
},
'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',
'UseServiceName': True|False
},
'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
},
'IdentityCenterConfiguration': {
'EnableIdentityPropagation': True|False
}
},
'S3Parameters': {
'ManifestFileLocation': {
'Bucket': 'string',
'Key': 'string'
},
'RoleArn': 'string'
},
'S3TablesParameters': {
'TableBucketArn': 'string'
},
'S3KnowledgeBaseParameters': {
'RoleArn': 'string',
'BucketUrl': 'string',
'MetadataFilesLocation': 'string'
},
'ServiceNowParameters': {
'SiteBaseUrl': 'string'
},
'SnowflakeParameters': {
'Host': 'string',
'Database': 'string',
'Warehouse': 'string',
'AuthenticationType': 'PASSWORD'|'KEYPAIR'|'TOKEN'|'X509',
'DatabaseAccessControlRole': 'string',
'OAuthParameters': {
'TokenProviderUrl': 'string',
'OAuthScope': 'string',
'IdentityProviderVpcConnectionProperties': {
'VpcConnectionArn': 'string'
},
'IdentityProviderResourceUri': 'string',
'IdentityProviderCACertificatesBundleS3Uri': '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',
'DatabaseAccessControlRole': 'string',
'AuthenticationType': 'PASSWORD'|'KEYPAIR'|'TOKEN'|'X509',
'OAuthParameters': {
'TokenProviderUrl': 'string',
'OAuthScope': 'string',
'IdentityProviderVpcConnectionProperties': {
'VpcConnectionArn': 'string'
},
'IdentityProviderResourceUri': 'string',
'IdentityProviderCACertificatesBundleS3Uri': 'string'
}
},
'TrinoParameters': {
'Host': 'string',
'Port': 123,
'Catalog': 'string'
},
'BigQueryParameters': {
'ProjectId': 'string',
'DataSetRegion': 'string'
},
'ImpalaParameters': {
'Host': 'string',
'Port': 123,
'Database': 'string',
'SqlEndpointPath': 'string'
},
'CustomConnectionParameters': {
'ConnectionType': 'string'
},
'WebCrawlerParameters': {
'WebCrawlerAuthType': 'NO_AUTH'|'BASIC_AUTH'|'FORM'|'SAML',
'UsernameFieldXpath': 'string',
'PasswordFieldXpath': 'string',
'UsernameButtonXpath': 'string',
'PasswordButtonXpath': 'string',
'LoginPageUrl': 'string',
'WebProxyHostName': 'string',
'WebProxyPortNumber': 123
},
'ConfluenceParameters': {
'ConfluenceUrl': 'string'
},
'QBusinessParameters': {
'ApplicationArn': 'string'
},
'SharePointParameters': {
'SharePointDomain': 'string',
'TenantId': 'string',
'ClientId': 'string',
'AuthType': 'THREE_LEGGED_OAUTH'|'TWO_LEGGED_OAUTH'|'SERVICE_ACCOUNT'
},
'GoogleDriveParameters': {
'AuthType': 'THREE_LEGGED_OAUTH'|'TWO_LEGGED_OAUTH'|'SERVICE_ACCOUNT'
},
'OneDriveParameters': {
'TenantId': 'string',
'ClientId': 'string',
'AuthType': 'THREE_LEGGED_OAUTH'|'TWO_LEGGED_OAUTH'|'SERVICE_ACCOUNT'
},
'FMKBParameters': {
'KnowledgeBaseArn': 'string',
'LinkedDataSourceIds': [
'string',
]
}
},
'VpcConnectionProperties': {
'VpcConnectionArn': 'string'
},
'SslProperties': {
'DisableSsl': True|False
},
'Credentials': {
'CredentialPair': {
'Username': 'string',
'Password': 'string'
},
'SecretArn': 'string'
}
},
],
'DataSets': [
{
'DataSetId': 'string',
'Name': 'string',
'DataSetRefreshProperties': {
'RefreshConfiguration': {
'IncrementalRefresh': {
'LookbackWindow': {
'ColumnName': 'string',
'Size': 123,
'SizeUnit': 'HOUR'|'DAY'|'WEEK'
}
}
},
'FailureConfiguration': {
'EmailAlert': {
'AlertStatus': 'ENABLED'|'DISABLED'
}
}
}
},
],
'Themes': [
{
'ThemeId': 'string',
'Name': 'string'
},
],
'Analyses': [
{
'AnalysisId': 'string',
'Name': 'string'
},
],
'Dashboards': [
{
'DashboardId': 'string',
'Name': 'string'
},
],
'Folders': [
{
'FolderId': 'string',
'Name': 'string',
'ParentFolderArn': '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',
]
}
}
},
],
'Folders': [
{
'FolderIds': [
'string',
],
'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'
},
]
},
],
'Folders': [
{
'FolderIds': [
'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 the size of the file that you want to upload is more than 20 MB, add the file to your Amazon S3 bucket and use S3Uri of the file for this operation.
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 1 GB.
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 Quick Sight 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.
ConsumerAccountRoleArn (string) --
Use ConsumerAccountRoleArn to perform cross-account Athena access. This is an IAM role ARN in the same AWS account as the Athena resources you want to access. Provide this along with RoleArn to enable role-chaining, where Amazon Quick Sight first assumes the RoleArn and then assumes the ConsumerAccountRoleArn to access Athena resources.
IdentityCenterConfiguration (dict) --
An optional parameter that configures IAM Identity Center authentication to grant Quick Sight access to your workgroup.
This parameter can only be specified if your Quick Sight account is configured with IAM Identity Center.
EnableIdentityPropagation (boolean) --
A Boolean option that controls whether Trusted Identity Propagation should be used.
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.
UseServiceName (boolean) --
A Boolean value that indicates whether the Database uses a service name or an SID. If this value is left blank, the default value is SID. If this value is set to false, the value is SID.
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 Quick Sight access to your cluster. This parameter can be used instead of DataSourceCredentials.
RoleArn (string) -- [REQUIRED]
Use the RoleArn structure to allow Quick Sight to call redshift:GetClusterCredentials on your cluster. The calling principal must have iam:PassRole access to pass the role to Quick Sight. The role's trust policy must allow the Quick Sight service principal to assume the role.
DatabaseUser (string) --
The user whose permissions and group memberships will be used by Quick Sight to access the cluster. If this user already exists in your database, Amazon Quick Sight 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 Quick Sight to access the cluster. These permissions are combined with the permissions granted to Quick Sight 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, Quick Sight 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.
IdentityCenterConfiguration (dict) --
An optional parameter that configures IAM Identity Center authentication to grant Quick Sight access to your cluster.
This parameter can only be specified if your Quick Sight account is configured with IAM Identity Center.
EnableIdentityPropagation (boolean) --
A Boolean option that controls whether Trusted Identity Propagation should be used.
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 Quick Sight.
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.
S3TablesParameters (dict) --
The parameters for S3 Tables.
TableBucketArn (string) --
The Amazon Resource Name (ARN) of the S3 Tables bucket.
S3KnowledgeBaseParameters (dict) --
The parameters for S3 Knowledge Base.
RoleArn (string) --
Use the RoleArn structure to override an account-wide role for a specific S3 Knowledge Base 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 Knowledge Base data source that is specified in the structure, even if the account-wide role forbidding S3 access is still active.
BucketUrl (string) -- [REQUIRED]
The URL of the S3 bucket that contains the knowledge base data.
MetadataFilesLocation (string) --
The location of metadata files within the S3 bucket that describe the structure and content of the knowledge base.
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.
AuthenticationType (string) --
The authentication type that you want to use for your connection. This parameter accepts OAuth and non-OAuth authentication types.
DatabaseAccessControlRole (string) --
The database access control role.
OAuthParameters (dict) --
An object that contains information needed to create a data source connection between an Quick Sight account and Snowflake.
TokenProviderUrl (string) -- [REQUIRED]
The token endpoint URL of the identity provider.
OAuthScope (string) --
The OAuth scope.
IdentityProviderVpcConnectionProperties (dict) --
VPC connection properties.
VpcConnectionArn (string) -- [REQUIRED]
The Amazon Resource Name (ARN) for the VPC connection.
IdentityProviderResourceUri (string) --
The resource uri of the identity provider.
IdentityProviderCACertificatesBundleS3Uri (string) --
The S3 URI of the identity provider's CA certificates bundle in PEM format. Use this parameter to provide a custom CA certificate bundle for the identity provider when the default trust store does not include the required certificates.
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.
DatabaseAccessControlRole (string) --
The database access control role.
AuthenticationType (string) --
The authentication type that you want to use for your connection. This parameter accepts OAuth and non-OAuth authentication types.
OAuthParameters (dict) --
An object that contains information needed to create a data source connection between an Quick Sight account and Starburst.
TokenProviderUrl (string) -- [REQUIRED]
The token endpoint URL of the identity provider.
OAuthScope (string) --
The OAuth scope.
IdentityProviderVpcConnectionProperties (dict) --
VPC connection properties.
VpcConnectionArn (string) -- [REQUIRED]
The Amazon Resource Name (ARN) for the VPC connection.
IdentityProviderResourceUri (string) --
The resource uri of the identity provider.
IdentityProviderCACertificatesBundleS3Uri (string) --
The S3 URI of the identity provider's CA certificates bundle in PEM format. Use this parameter to provide a custom CA certificate bundle for the identity provider when the default trust store does not include the required certificates.
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.
ImpalaParameters (dict) --
The parameters for Impala.
Host (string) -- [REQUIRED]
The host name of the Impala data source.
Port (integer) -- [REQUIRED]
The port of the Impala data source.
Database (string) --
The database of the Impala data source.
SqlEndpointPath (string) -- [REQUIRED]
The HTTP path of the Impala data source.
CustomConnectionParameters (dict) --
The parameters for custom connectors.
ConnectionType (string) --
The type of custom connector.
WebCrawlerParameters (dict) --
The parameters for Web Crawler.
WebCrawlerAuthType (string) -- [REQUIRED]
The authentication type for the web crawler. The type can be one of the following:
NO_AUTH: No authentication required.
BASIC_AUTH: Basic authentication using username and password.
SAML: SAML-based authentication.
FORM: Form-based authentication.
UsernameFieldXpath (string) --
The XPath expression for locating the username field on the login page.
PasswordFieldXpath (string) --
The XPath expression for locating the password field on the login page.
UsernameButtonXpath (string) --
The XPath expression for locating the username submit button on the login page.
PasswordButtonXpath (string) --
The XPath expression for locating the password submit button on the login page.
LoginPageUrl (string) --
The URL of the login page for the web crawler to authenticate.
WebProxyHostName (string) --
The hostname of the web proxy server for the web crawler.
WebProxyPortNumber (integer) --
The port number of the web proxy server for the web crawler.
ConfluenceParameters (dict) --
The parameters for Confluence.
ConfluenceUrl (string) -- [REQUIRED]
The URL of the Confluence site to connect to.
QBusinessParameters (dict) --
The parameters for Amazon Q Business.
ApplicationArn (string) -- [REQUIRED]
The Amazon Resource Name (ARN) of the Amazon Q Business application.
SharePointParameters (dict) --
The parameters for a SharePoint data source.
SharePointDomain (string) -- [REQUIRED]
The SharePoint domain for the data source.
TenantId (string) --
The tenant ID for the SharePoint data source.
ClientId (string) --
The client ID for the SharePoint data source.
AuthType (string) --
The authentication type for the SharePoint data source. Valid values include:
TWO_LEGGED_OAUTH – Server-to-server authentication using client credentials that do not require user interaction.
THREE_LEGGED_OAUTH – Interactive OAuth that requires user consent.
GoogleDriveParameters (dict) --
The parameters for a Google Drive data source.
AuthType (string) --
The authentication type for the Google Drive data source. Valid values include:
SERVICE_ACCOUNT – Server-to-server authentication using a Google service account key.
THREE_LEGGED_OAUTH – Interactive OAuth that requires user consent.
OneDriveParameters (dict) --
The parameters for an OneDrive data source.
TenantId (string) --
The tenant ID for the OneDrive data source.
ClientId (string) --
The client ID for the OneDrive data source.
AuthType (string) --
The authentication type for the OneDrive data source. Valid values include:
TWO_LEGGED_OAUTH – Server-to-server authentication using client credentials that do not require user interaction.
THREE_LEGGED_OAUTH – Interactive OAuth that requires user consent.
FMKBParameters (dict) --
The parameters for a fully managed knowledge base data source.
KnowledgeBaseArn (string) -- [REQUIRED]
The Amazon Resource Name (ARN) of the Amazon Bedrock knowledge base.
LinkedDataSourceIds (list) --
The IDs of the linked data sources.
(string) --
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 Quick Sight 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.
DataSetRefreshProperties (dict) --
The refresh properties of a dataset.
RefreshConfiguration (dict) --
The refresh configuration for a dataset.
IncrementalRefresh (dict) -- [REQUIRED]
The incremental refresh for the dataset.
LookbackWindow (dict) -- [REQUIRED]
The lookback window setup for an incremental refresh configuration.
ColumnName (string) -- [REQUIRED]
The name of the lookback window column.
Size (integer) -- [REQUIRED]
The lookback window column size.
SizeUnit (string) -- [REQUIRED]
The size unit that is used for the lookback window column. Valid values for this structure are HOUR, DAY, and WEEK.
FailureConfiguration (dict) --
The failure configuration for a dataset.
EmailAlert (dict) --
The email alert configuration for a dataset refresh failure.
AlertStatus (string) --
The status value that determines if email alerts are sent.
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.
Folders (list) --
A list of overrides for any Folder resources that are present in the asset bundle that is imported.
(dict) --
The override parameters for a single folder that is being imported.
FolderId (string) -- [REQUIRED]
The ID of the folder that you want to apply overrides to.
Name (string) --
A new name for the folder.
ParentFolderArn (string) --
A new parent folder arn. This change can only be applied if the import creates a brand new folder. Existing folders cannot be moved.
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 Quick Sight 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) --
Folders (list) --
A list of permissions for the folders that you want to apply overrides to.
(dict) --
An object that contains a list of permissions to be applied to a list of folder IDs.
FolderIds (list) -- [REQUIRED]
A list of folder IDs that you want to apply overrides to. You can use * to override all folders in this asset bundle.
(string) --
Permissions (dict) --
A structure that contains the permissions for the resource that you want to override in an asset bundle import job.
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.
Folders (list) --
A list of tag overrides for any Folder 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 folder IDs.
FolderIds (list) -- [REQUIRED]
A list of folder IDs that you want to apply overrides to. You can use * to override all folders in this asset bundle.
(string) --
Tags (list) -- [REQUIRED]
A list of tags for the folders 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': {'FMKBParameters': {'KnowledgeBaseArn': 'string',
'LinkedDataSourceIds': ['string']},
'GoogleDriveParameters': {'AuthType': 'THREE_LEGGED_OAUTH '
'| '
'TWO_LEGGED_OAUTH '
'| '
'SERVICE_ACCOUNT'},
'OneDriveParameters': {'AuthType': 'THREE_LEGGED_OAUTH '
'| '
'TWO_LEGGED_OAUTH '
'| '
'SERVICE_ACCOUNT',
'ClientId': 'string',
'TenantId': 'string'},
'SharePointParameters': {'AuthType': 'THREE_LEGGED_OAUTH '
'| '
'TWO_LEGGED_OAUTH '
'| '
'SERVICE_ACCOUNT',
'ClientId': 'string',
'SharePointDomain': 'string',
'TenantId': 'string'}}}},
'DataSourceParameters': {'FMKBParameters': {'KnowledgeBaseArn': 'string',
'LinkedDataSourceIds': ['string']},
'GoogleDriveParameters': {'AuthType': 'THREE_LEGGED_OAUTH '
'| '
'TWO_LEGGED_OAUTH '
'| '
'SERVICE_ACCOUNT'},
'OneDriveParameters': {'AuthType': 'THREE_LEGGED_OAUTH '
'| '
'TWO_LEGGED_OAUTH '
'| '
'SERVICE_ACCOUNT',
'ClientId': 'string',
'TenantId': 'string'},
'SharePointParameters': {'AuthType': 'THREE_LEGGED_OAUTH '
'| '
'TWO_LEGGED_OAUTH '
'| '
'SERVICE_ACCOUNT',
'ClientId': 'string',
'SharePointDomain': 'string',
'TenantId': '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',
'ConsumerAccountRoleArn': 'string',
'IdentityCenterConfiguration': {
'EnableIdentityPropagation': True|False
}
},
'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',
'UseServiceName': True|False
},
'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
},
'IdentityCenterConfiguration': {
'EnableIdentityPropagation': True|False
}
},
'S3Parameters': {
'ManifestFileLocation': {
'Bucket': 'string',
'Key': 'string'
},
'RoleArn': 'string'
},
'S3TablesParameters': {
'TableBucketArn': 'string'
},
'S3KnowledgeBaseParameters': {
'RoleArn': 'string',
'BucketUrl': 'string',
'MetadataFilesLocation': 'string'
},
'ServiceNowParameters': {
'SiteBaseUrl': 'string'
},
'SnowflakeParameters': {
'Host': 'string',
'Database': 'string',
'Warehouse': 'string',
'AuthenticationType': 'PASSWORD'|'KEYPAIR'|'TOKEN'|'X509',
'DatabaseAccessControlRole': 'string',
'OAuthParameters': {
'TokenProviderUrl': 'string',
'OAuthScope': 'string',
'IdentityProviderVpcConnectionProperties': {
'VpcConnectionArn': 'string'
},
'IdentityProviderResourceUri': 'string',
'IdentityProviderCACertificatesBundleS3Uri': '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',
'DatabaseAccessControlRole': 'string',
'AuthenticationType': 'PASSWORD'|'KEYPAIR'|'TOKEN'|'X509',
'OAuthParameters': {
'TokenProviderUrl': 'string',
'OAuthScope': 'string',
'IdentityProviderVpcConnectionProperties': {
'VpcConnectionArn': 'string'
},
'IdentityProviderResourceUri': 'string',
'IdentityProviderCACertificatesBundleS3Uri': 'string'
}
},
'TrinoParameters': {
'Host': 'string',
'Port': 123,
'Catalog': 'string'
},
'BigQueryParameters': {
'ProjectId': 'string',
'DataSetRegion': 'string'
},
'ImpalaParameters': {
'Host': 'string',
'Port': 123,
'Database': 'string',
'SqlEndpointPath': 'string'
},
'CustomConnectionParameters': {
'ConnectionType': 'string'
},
'WebCrawlerParameters': {
'WebCrawlerAuthType': 'NO_AUTH'|'BASIC_AUTH'|'FORM'|'SAML',
'UsernameFieldXpath': 'string',
'PasswordFieldXpath': 'string',
'UsernameButtonXpath': 'string',
'PasswordButtonXpath': 'string',
'LoginPageUrl': 'string',
'WebProxyHostName': 'string',
'WebProxyPortNumber': 123
},
'ConfluenceParameters': {
'ConfluenceUrl': 'string'
},
'QBusinessParameters': {
'ApplicationArn': 'string'
},
'SharePointParameters': {
'SharePointDomain': 'string',
'TenantId': 'string',
'ClientId': 'string',
'AuthType': 'THREE_LEGGED_OAUTH'|'TWO_LEGGED_OAUTH'|'SERVICE_ACCOUNT'
},
'GoogleDriveParameters': {
'AuthType': 'THREE_LEGGED_OAUTH'|'TWO_LEGGED_OAUTH'|'SERVICE_ACCOUNT'
},
'OneDriveParameters': {
'TenantId': 'string',
'ClientId': 'string',
'AuthType': 'THREE_LEGGED_OAUTH'|'TWO_LEGGED_OAUTH'|'SERVICE_ACCOUNT'
},
'FMKBParameters': {
'KnowledgeBaseArn': 'string',
'LinkedDataSourceIds': [
'string',
]
}
},
Credentials={
'CredentialPair': {
'Username': 'string',
'Password': 'string',
'AlternateDataSourceParameters': [
{
'AmazonElasticsearchParameters': {
'Domain': 'string'
},
'AthenaParameters': {
'WorkGroup': 'string',
'RoleArn': 'string',
'ConsumerAccountRoleArn': 'string',
'IdentityCenterConfiguration': {
'EnableIdentityPropagation': True|False
}
},
'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',
'UseServiceName': True|False
},
'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
},
'IdentityCenterConfiguration': {
'EnableIdentityPropagation': True|False
}
},
'S3Parameters': {
'ManifestFileLocation': {
'Bucket': 'string',
'Key': 'string'
},
'RoleArn': 'string'
},
'S3TablesParameters': {
'TableBucketArn': 'string'
},
'S3KnowledgeBaseParameters': {
'RoleArn': 'string',
'BucketUrl': 'string',
'MetadataFilesLocation': 'string'
},
'ServiceNowParameters': {
'SiteBaseUrl': 'string'
},
'SnowflakeParameters': {
'Host': 'string',
'Database': 'string',
'Warehouse': 'string',
'AuthenticationType': 'PASSWORD'|'KEYPAIR'|'TOKEN'|'X509',
'DatabaseAccessControlRole': 'string',
'OAuthParameters': {
'TokenProviderUrl': 'string',
'OAuthScope': 'string',
'IdentityProviderVpcConnectionProperties': {
'VpcConnectionArn': 'string'
},
'IdentityProviderResourceUri': 'string',
'IdentityProviderCACertificatesBundleS3Uri': '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',
'DatabaseAccessControlRole': 'string',
'AuthenticationType': 'PASSWORD'|'KEYPAIR'|'TOKEN'|'X509',
'OAuthParameters': {
'TokenProviderUrl': 'string',
'OAuthScope': 'string',
'IdentityProviderVpcConnectionProperties': {
'VpcConnectionArn': 'string'
},
'IdentityProviderResourceUri': 'string',
'IdentityProviderCACertificatesBundleS3Uri': 'string'
}
},
'TrinoParameters': {
'Host': 'string',
'Port': 123,
'Catalog': 'string'
},
'BigQueryParameters': {
'ProjectId': 'string',
'DataSetRegion': 'string'
},
'ImpalaParameters': {
'Host': 'string',
'Port': 123,
'Database': 'string',
'SqlEndpointPath': 'string'
},
'CustomConnectionParameters': {
'ConnectionType': 'string'
},
'WebCrawlerParameters': {
'WebCrawlerAuthType': 'NO_AUTH'|'BASIC_AUTH'|'FORM'|'SAML',
'UsernameFieldXpath': 'string',
'PasswordFieldXpath': 'string',
'UsernameButtonXpath': 'string',
'PasswordButtonXpath': 'string',
'LoginPageUrl': 'string',
'WebProxyHostName': 'string',
'WebProxyPortNumber': 123
},
'ConfluenceParameters': {
'ConfluenceUrl': 'string'
},
'QBusinessParameters': {
'ApplicationArn': 'string'
},
'SharePointParameters': {
'SharePointDomain': 'string',
'TenantId': 'string',
'ClientId': 'string',
'AuthType': 'THREE_LEGGED_OAUTH'|'TWO_LEGGED_OAUTH'|'SERVICE_ACCOUNT'
},
'GoogleDriveParameters': {
'AuthType': 'THREE_LEGGED_OAUTH'|'TWO_LEGGED_OAUTH'|'SERVICE_ACCOUNT'
},
'OneDriveParameters': {
'TenantId': 'string',
'ClientId': 'string',
'AuthType': 'THREE_LEGGED_OAUTH'|'TWO_LEGGED_OAUTH'|'SERVICE_ACCOUNT'
},
'FMKBParameters': {
'KnowledgeBaseArn': 'string',
'LinkedDataSourceIds': [
'string',
]
}
},
]
},
'CopySourceArn': 'string',
'SecretArn': 'string',
'KeyPairCredentials': {
'KeyPairUsername': 'string',
'PrivateKey': 'string',
'PrivateKeyPassphrase': 'string'
},
'WebProxyCredentials': {
'WebProxyUsername': 'string',
'WebProxyPassword': 'string'
},
'OAuthClientCredentials': {
'ClientId': 'string',
'ClientSecret': 'string',
'Username': '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 Quick Sight 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.
ConsumerAccountRoleArn (string) --
Use ConsumerAccountRoleArn to perform cross-account Athena access. This is an IAM role ARN in the same AWS account as the Athena resources you want to access. Provide this along with RoleArn to enable role-chaining, where Amazon Quick Sight first assumes the RoleArn and then assumes the ConsumerAccountRoleArn to access Athena resources.
IdentityCenterConfiguration (dict) --
An optional parameter that configures IAM Identity Center authentication to grant Quick Sight access to your workgroup.
This parameter can only be specified if your Quick Sight account is configured with IAM Identity Center.
EnableIdentityPropagation (boolean) --
A Boolean option that controls whether Trusted Identity Propagation should be used.
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.
UseServiceName (boolean) --
A Boolean value that indicates whether the Database uses a service name or an SID. If this value is left blank, the default value is SID. If this value is set to false, the value is SID.
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 Quick Sight access to your cluster. This parameter can be used instead of DataSourceCredentials.
RoleArn (string) -- [REQUIRED]
Use the RoleArn structure to allow Quick Sight to call redshift:GetClusterCredentials on your cluster. The calling principal must have iam:PassRole access to pass the role to Quick Sight. The role's trust policy must allow the Quick Sight service principal to assume the role.
DatabaseUser (string) --
The user whose permissions and group memberships will be used by Quick Sight to access the cluster. If this user already exists in your database, Amazon Quick Sight 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 Quick Sight to access the cluster. These permissions are combined with the permissions granted to Quick Sight 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, Quick Sight 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.
IdentityCenterConfiguration (dict) --
An optional parameter that configures IAM Identity Center authentication to grant Quick Sight access to your cluster.
This parameter can only be specified if your Quick Sight account is configured with IAM Identity Center.
EnableIdentityPropagation (boolean) --
A Boolean option that controls whether Trusted Identity Propagation should be used.
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 Quick Sight.
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.
S3TablesParameters (dict) --
The parameters for S3 Tables.
TableBucketArn (string) --
The Amazon Resource Name (ARN) of the S3 Tables bucket.
S3KnowledgeBaseParameters (dict) --
The parameters for S3 Knowledge Base.
RoleArn (string) --
Use the RoleArn structure to override an account-wide role for a specific S3 Knowledge Base 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 Knowledge Base data source that is specified in the structure, even if the account-wide role forbidding S3 access is still active.
BucketUrl (string) -- [REQUIRED]
The URL of the S3 bucket that contains the knowledge base data.
MetadataFilesLocation (string) --
The location of metadata files within the S3 bucket that describe the structure and content of the knowledge base.
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.
AuthenticationType (string) --
The authentication type that you want to use for your connection. This parameter accepts OAuth and non-OAuth authentication types.
DatabaseAccessControlRole (string) --
The database access control role.
OAuthParameters (dict) --
An object that contains information needed to create a data source connection between an Quick Sight account and Snowflake.
TokenProviderUrl (string) -- [REQUIRED]
The token endpoint URL of the identity provider.
OAuthScope (string) --
The OAuth scope.
IdentityProviderVpcConnectionProperties (dict) --
VPC connection properties.
VpcConnectionArn (string) -- [REQUIRED]
The Amazon Resource Name (ARN) for the VPC connection.
IdentityProviderResourceUri (string) --
The resource uri of the identity provider.
IdentityProviderCACertificatesBundleS3Uri (string) --
The S3 URI of the identity provider's CA certificates bundle in PEM format. Use this parameter to provide a custom CA certificate bundle for the identity provider when the default trust store does not include the required certificates.
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.
DatabaseAccessControlRole (string) --
The database access control role.
AuthenticationType (string) --
The authentication type that you want to use for your connection. This parameter accepts OAuth and non-OAuth authentication types.
OAuthParameters (dict) --
An object that contains information needed to create a data source connection between an Quick Sight account and Starburst.
TokenProviderUrl (string) -- [REQUIRED]
The token endpoint URL of the identity provider.
OAuthScope (string) --
The OAuth scope.
IdentityProviderVpcConnectionProperties (dict) --
VPC connection properties.
VpcConnectionArn (string) -- [REQUIRED]
The Amazon Resource Name (ARN) for the VPC connection.
IdentityProviderResourceUri (string) --
The resource uri of the identity provider.
IdentityProviderCACertificatesBundleS3Uri (string) --
The S3 URI of the identity provider's CA certificates bundle in PEM format. Use this parameter to provide a custom CA certificate bundle for the identity provider when the default trust store does not include the required certificates.
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.
ImpalaParameters (dict) --
The parameters for Impala.
Host (string) -- [REQUIRED]
The host name of the Impala data source.
Port (integer) -- [REQUIRED]
The port of the Impala data source.
Database (string) --
The database of the Impala data source.
SqlEndpointPath (string) -- [REQUIRED]
The HTTP path of the Impala data source.
CustomConnectionParameters (dict) --
The parameters for custom connectors.
ConnectionType (string) --
The type of custom connector.
WebCrawlerParameters (dict) --
The parameters for Web Crawler.
WebCrawlerAuthType (string) -- [REQUIRED]
The authentication type for the web crawler. The type can be one of the following:
NO_AUTH: No authentication required.
BASIC_AUTH: Basic authentication using username and password.
SAML: SAML-based authentication.
FORM: Form-based authentication.
UsernameFieldXpath (string) --
The XPath expression for locating the username field on the login page.
PasswordFieldXpath (string) --
The XPath expression for locating the password field on the login page.
UsernameButtonXpath (string) --
The XPath expression for locating the username submit button on the login page.
PasswordButtonXpath (string) --
The XPath expression for locating the password submit button on the login page.
LoginPageUrl (string) --
The URL of the login page for the web crawler to authenticate.
WebProxyHostName (string) --
The hostname of the web proxy server for the web crawler.
WebProxyPortNumber (integer) --
The port number of the web proxy server for the web crawler.
ConfluenceParameters (dict) --
The parameters for Confluence.
ConfluenceUrl (string) -- [REQUIRED]
The URL of the Confluence site to connect to.
QBusinessParameters (dict) --
The parameters for Amazon Q Business.
ApplicationArn (string) -- [REQUIRED]
The Amazon Resource Name (ARN) of the Amazon Q Business application.
SharePointParameters (dict) --
The parameters for a SharePoint data source.
SharePointDomain (string) -- [REQUIRED]
The SharePoint domain for the data source.
TenantId (string) --
The tenant ID for the SharePoint data source.
ClientId (string) --
The client ID for the SharePoint data source.
AuthType (string) --
The authentication type for the SharePoint data source. Valid values include:
TWO_LEGGED_OAUTH – Server-to-server authentication using client credentials that do not require user interaction.
THREE_LEGGED_OAUTH – Interactive OAuth that requires user consent.
GoogleDriveParameters (dict) --
The parameters for a Google Drive data source.
AuthType (string) --
The authentication type for the Google Drive data source. Valid values include:
SERVICE_ACCOUNT – Server-to-server authentication using a Google service account key.
THREE_LEGGED_OAUTH – Interactive OAuth that requires user consent.
OneDriveParameters (dict) --
The parameters for an OneDrive data source.
TenantId (string) --
The tenant ID for the OneDrive data source.
ClientId (string) --
The client ID for the OneDrive data source.
AuthType (string) --
The authentication type for the OneDrive data source. Valid values include:
TWO_LEGGED_OAUTH – Server-to-server authentication using client credentials that do not require user interaction.
THREE_LEGGED_OAUTH – Interactive OAuth that requires user consent.
FMKBParameters (dict) --
The parameters for a fully managed knowledge base data source.
KnowledgeBaseArn (string) -- [REQUIRED]
The Amazon Resource Name (ARN) of the Amazon Bedrock knowledge base.
LinkedDataSourceIds (list) --
The IDs of the linked data sources.
(string) --
dict
The credentials that Amazon Quick Sight 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 Quick Sight 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.
ConsumerAccountRoleArn (string) --
Use ConsumerAccountRoleArn to perform cross-account Athena access. This is an IAM role ARN in the same AWS account as the Athena resources you want to access. Provide this along with RoleArn to enable role-chaining, where Amazon Quick Sight first assumes the RoleArn and then assumes the ConsumerAccountRoleArn to access Athena resources.
IdentityCenterConfiguration (dict) --
An optional parameter that configures IAM Identity Center authentication to grant Quick Sight access to your workgroup.
This parameter can only be specified if your Quick Sight account is configured with IAM Identity Center.
EnableIdentityPropagation (boolean) --
A Boolean option that controls whether Trusted Identity Propagation should be used.
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.
UseServiceName (boolean) --
A Boolean value that indicates whether the Database uses a service name or an SID. If this value is left blank, the default value is SID. If this value is set to false, the value is SID.
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 Quick Sight access to your cluster. This parameter can be used instead of DataSourceCredentials.
RoleArn (string) -- [REQUIRED]
Use the RoleArn structure to allow Quick Sight to call redshift:GetClusterCredentials on your cluster. The calling principal must have iam:PassRole access to pass the role to Quick Sight. The role's trust policy must allow the Quick Sight service principal to assume the role.
DatabaseUser (string) --
The user whose permissions and group memberships will be used by Quick Sight to access the cluster. If this user already exists in your database, Amazon Quick Sight 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 Quick Sight to access the cluster. These permissions are combined with the permissions granted to Quick Sight 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, Quick Sight 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.
IdentityCenterConfiguration (dict) --
An optional parameter that configures IAM Identity Center authentication to grant Quick Sight access to your cluster.
This parameter can only be specified if your Quick Sight account is configured with IAM Identity Center.
EnableIdentityPropagation (boolean) --
A Boolean option that controls whether Trusted Identity Propagation should be used.
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 Quick Sight.
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.
S3TablesParameters (dict) --
The parameters for S3 Tables.
TableBucketArn (string) --
The Amazon Resource Name (ARN) of the S3 Tables bucket.
S3KnowledgeBaseParameters (dict) --
The parameters for S3 Knowledge Base.
RoleArn (string) --
Use the RoleArn structure to override an account-wide role for a specific S3 Knowledge Base 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 Knowledge Base data source that is specified in the structure, even if the account-wide role forbidding S3 access is still active.
BucketUrl (string) -- [REQUIRED]
The URL of the S3 bucket that contains the knowledge base data.
MetadataFilesLocation (string) --
The location of metadata files within the S3 bucket that describe the structure and content of the knowledge base.
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.
AuthenticationType (string) --
The authentication type that you want to use for your connection. This parameter accepts OAuth and non-OAuth authentication types.
DatabaseAccessControlRole (string) --
The database access control role.
OAuthParameters (dict) --
An object that contains information needed to create a data source connection between an Quick Sight account and Snowflake.
TokenProviderUrl (string) -- [REQUIRED]
The token endpoint URL of the identity provider.
OAuthScope (string) --
The OAuth scope.
IdentityProviderVpcConnectionProperties (dict) --
VPC connection properties.
VpcConnectionArn (string) -- [REQUIRED]
The Amazon Resource Name (ARN) for the VPC connection.
IdentityProviderResourceUri (string) --
The resource uri of the identity provider.
IdentityProviderCACertificatesBundleS3Uri (string) --
The S3 URI of the identity provider's CA certificates bundle in PEM format. Use this parameter to provide a custom CA certificate bundle for the identity provider when the default trust store does not include the required certificates.
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.
DatabaseAccessControlRole (string) --
The database access control role.
AuthenticationType (string) --
The authentication type that you want to use for your connection. This parameter accepts OAuth and non-OAuth authentication types.
OAuthParameters (dict) --
An object that contains information needed to create a data source connection between an Quick Sight account and Starburst.
TokenProviderUrl (string) -- [REQUIRED]
The token endpoint URL of the identity provider.
OAuthScope (string) --
The OAuth scope.
IdentityProviderVpcConnectionProperties (dict) --
VPC connection properties.
VpcConnectionArn (string) -- [REQUIRED]
The Amazon Resource Name (ARN) for the VPC connection.
IdentityProviderResourceUri (string) --
The resource uri of the identity provider.
IdentityProviderCACertificatesBundleS3Uri (string) --
The S3 URI of the identity provider's CA certificates bundle in PEM format. Use this parameter to provide a custom CA certificate bundle for the identity provider when the default trust store does not include the required certificates.
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.
ImpalaParameters (dict) --
The parameters for Impala.
Host (string) -- [REQUIRED]
The host name of the Impala data source.
Port (integer) -- [REQUIRED]
The port of the Impala data source.
Database (string) --
The database of the Impala data source.
SqlEndpointPath (string) -- [REQUIRED]
The HTTP path of the Impala data source.
CustomConnectionParameters (dict) --
The parameters for custom connectors.
ConnectionType (string) --
The type of custom connector.
WebCrawlerParameters (dict) --
The parameters for Web Crawler.
WebCrawlerAuthType (string) -- [REQUIRED]
The authentication type for the web crawler. The type can be one of the following:
NO_AUTH: No authentication required.
BASIC_AUTH: Basic authentication using username and password.
SAML: SAML-based authentication.
FORM: Form-based authentication.
UsernameFieldXpath (string) --
The XPath expression for locating the username field on the login page.
PasswordFieldXpath (string) --
The XPath expression for locating the password field on the login page.
UsernameButtonXpath (string) --
The XPath expression for locating the username submit button on the login page.
PasswordButtonXpath (string) --
The XPath expression for locating the password submit button on the login page.
LoginPageUrl (string) --
The URL of the login page for the web crawler to authenticate.
WebProxyHostName (string) --
The hostname of the web proxy server for the web crawler.
WebProxyPortNumber (integer) --
The port number of the web proxy server for the web crawler.
ConfluenceParameters (dict) --
The parameters for Confluence.
ConfluenceUrl (string) -- [REQUIRED]
The URL of the Confluence site to connect to.
QBusinessParameters (dict) --
The parameters for Amazon Q Business.
ApplicationArn (string) -- [REQUIRED]
The Amazon Resource Name (ARN) of the Amazon Q Business application.
SharePointParameters (dict) --
The parameters for a SharePoint data source.
SharePointDomain (string) -- [REQUIRED]
The SharePoint domain for the data source.
TenantId (string) --
The tenant ID for the SharePoint data source.
ClientId (string) --
The client ID for the SharePoint data source.
AuthType (string) --
The authentication type for the SharePoint data source. Valid values include:
TWO_LEGGED_OAUTH – Server-to-server authentication using client credentials that do not require user interaction.
THREE_LEGGED_OAUTH – Interactive OAuth that requires user consent.
GoogleDriveParameters (dict) --
The parameters for a Google Drive data source.
AuthType (string) --
The authentication type for the Google Drive data source. Valid values include:
SERVICE_ACCOUNT – Server-to-server authentication using a Google service account key.
THREE_LEGGED_OAUTH – Interactive OAuth that requires user consent.
OneDriveParameters (dict) --
The parameters for an OneDrive data source.
TenantId (string) --
The tenant ID for the OneDrive data source.
ClientId (string) --
The client ID for the OneDrive data source.
AuthType (string) --
The authentication type for the OneDrive data source. Valid values include:
TWO_LEGGED_OAUTH – Server-to-server authentication using client credentials that do not require user interaction.
THREE_LEGGED_OAUTH – Interactive OAuth that requires user consent.
FMKBParameters (dict) --
The parameters for a fully managed knowledge base data source.
KnowledgeBaseArn (string) -- [REQUIRED]
The Amazon Resource Name (ARN) of the Amazon Bedrock knowledge base.
LinkedDataSourceIds (list) --
The IDs of the linked data sources.
(string) --
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.
KeyPairCredentials (dict) --
The credentials for connecting using key-pair.
KeyPairUsername (string) -- [REQUIRED]
Username
PrivateKey (string) -- [REQUIRED]
PrivateKey
PrivateKeyPassphrase (string) --
PrivateKeyPassphrase
WebProxyCredentials (dict) --
The credentials for connecting through a web proxy server.
WebProxyUsername (string) -- [REQUIRED]
The username for authenticating with the web proxy server.
WebProxyPassword (string) -- [REQUIRED]
The password for authenticating with the web proxy server.
OAuthClientCredentials (dict) --
The OAuth client credentials for connecting to a data source using OAuth 2.0 client credentials (2LO) authentication. For more information, see ``OAuthClientCredentials ``.
ClientId (string) --
The client ID of the OAuth 2.0 application that is registered with the data source provider.
ClientSecret (string) --
The client secret of the OAuth 2.0 application that is registered with the data source provider.
Username (string) --
The username of the account that is used for OAuth 2.0 client credentials authentication with the data source provider.
dict
Use this parameter only when you want Amazon Quick Sight 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 Quick Sight 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.