2020/06/26 - Amazon QuickSight - 4 updated api methods
Changes Update quicksight client to latest version
{'Credentials': {'CopySourceArn': 'string',
'CredentialPair': {'AlternateDataSourceParameters': [{'AmazonElasticsearchParameters': {'Domain': 'string'},
'AthenaParameters': {'WorkGroup': 'string'},
'AuroraParameters': {'Database': 'string',
'Host': 'string',
'Port': 'integer'},
'AuroraPostgreSqlParameters': {'Database': 'string',
'Host': 'string',
'Port': 'integer'},
'AwsIotAnalyticsParameters': {'DataSetName': 'string'},
'JiraParameters': {'SiteBaseUrl': 'string'},
'MariaDbParameters': {'Database': 'string',
'Host': 'string',
'Port': 'integer'},
'MySqlParameters': {'Database': 'string',
'Host': 'string',
'Port': 'integer'},
'PostgreSqlParameters': {'Database': 'string',
'Host': 'string',
'Port': 'integer'},
'PrestoParameters': {'Catalog': 'string',
'Host': 'string',
'Port': 'integer'},
'RdsParameters': {'Database': 'string',
'InstanceId': 'string'},
'RedshiftParameters': {'ClusterId': 'string',
'Database': 'string',
'Host': 'string',
'Port': 'integer'},
'S3Parameters': {'ManifestFileLocation': {'Bucket': 'string',
'Key': 'string'}},
'ServiceNowParameters': {'SiteBaseUrl': 'string'},
'SnowflakeParameters': {'Database': 'string',
'Host': 'string',
'Warehouse': 'string'},
'SparkParameters': {'Host': 'string',
'Port': 'integer'},
'SqlServerParameters': {'Database': 'string',
'Host': 'string',
'Port': 'integer'},
'TeradataParameters': {'Database': 'string',
'Host': 'string',
'Port': 'integer'},
'TwitterParameters': {'MaxRows': 'integer',
'Query': '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'|'POSTGRESQL'|'PRESTO'|'REDSHIFT'|'S3'|'SALESFORCE'|'SERVICENOW'|'SNOWFLAKE'|'SPARK'|'SQLSERVER'|'TERADATA'|'TWITTER',
DataSourceParameters={
'AmazonElasticsearchParameters': {
'Domain': 'string'
},
'AthenaParameters': {
'WorkGroup': 'string'
},
'AuroraParameters': {
'Host': 'string',
'Port': 123,
'Database': 'string'
},
'AuroraPostgreSqlParameters': {
'Host': 'string',
'Port': 123,
'Database': 'string'
},
'AwsIotAnalyticsParameters': {
'DataSetName': 'string'
},
'JiraParameters': {
'SiteBaseUrl': 'string'
},
'MariaDbParameters': {
'Host': 'string',
'Port': 123,
'Database': 'string'
},
'MySqlParameters': {
'Host': 'string',
'Port': 123,
'Database': 'string'
},
'PostgreSqlParameters': {
'Host': 'string',
'Port': 123,
'Database': 'string'
},
'PrestoParameters': {
'Host': 'string',
'Port': 123,
'Catalog': 'string'
},
'RdsParameters': {
'InstanceId': 'string',
'Database': 'string'
},
'RedshiftParameters': {
'Host': 'string',
'Port': 123,
'Database': 'string',
'ClusterId': 'string'
},
'S3Parameters': {
'ManifestFileLocation': {
'Bucket': 'string',
'Key': 'string'
}
},
'ServiceNowParameters': {
'SiteBaseUrl': 'string'
},
'SnowflakeParameters': {
'Host': 'string',
'Database': 'string',
'Warehouse': 'string'
},
'SparkParameters': {
'Host': 'string',
'Port': 123
},
'SqlServerParameters': {
'Host': 'string',
'Port': 123,
'Database': 'string'
},
'TeradataParameters': {
'Host': 'string',
'Port': 123,
'Database': 'string'
},
'TwitterParameters': {
'Query': 'string',
'MaxRows': 123
}
},
Credentials={
'CredentialPair': {
'Username': 'string',
'Password': 'string',
'AlternateDataSourceParameters': [
{
'AmazonElasticsearchParameters': {
'Domain': 'string'
},
'AthenaParameters': {
'WorkGroup': 'string'
},
'AuroraParameters': {
'Host': 'string',
'Port': 123,
'Database': 'string'
},
'AuroraPostgreSqlParameters': {
'Host': 'string',
'Port': 123,
'Database': 'string'
},
'AwsIotAnalyticsParameters': {
'DataSetName': 'string'
},
'JiraParameters': {
'SiteBaseUrl': 'string'
},
'MariaDbParameters': {
'Host': 'string',
'Port': 123,
'Database': 'string'
},
'MySqlParameters': {
'Host': 'string',
'Port': 123,
'Database': 'string'
},
'PostgreSqlParameters': {
'Host': 'string',
'Port': 123,
'Database': 'string'
},
'PrestoParameters': {
'Host': 'string',
'Port': 123,
'Catalog': 'string'
},
'RdsParameters': {
'InstanceId': 'string',
'Database': 'string'
},
'RedshiftParameters': {
'Host': 'string',
'Port': 123,
'Database': 'string',
'ClusterId': 'string'
},
'S3Parameters': {
'ManifestFileLocation': {
'Bucket': 'string',
'Key': 'string'
}
},
'ServiceNowParameters': {
'SiteBaseUrl': 'string'
},
'SnowflakeParameters': {
'Host': 'string',
'Database': 'string',
'Warehouse': 'string'
},
'SparkParameters': {
'Host': 'string',
'Port': 123
},
'SqlServerParameters': {
'Host': 'string',
'Port': 123,
'Database': 'string'
},
'TeradataParameters': {
'Host': 'string',
'Port': 123,
'Database': 'string'
},
'TwitterParameters': {
'Query': 'string',
'MaxRows': 123
}
},
]
},
'CopySourceArn': 'string'
},
Permissions=[
{
'Principal': 'string',
'Actions': [
'string',
]
},
],
VpcConnectionProperties={
'VpcConnectionArn': 'string'
},
SslProperties={
'DisableSsl': True|False
},
Tags=[
{
'Key': 'string',
'Value': 'string'
},
]
)
string
[REQUIRED]
The AWS account ID.
string
[REQUIRED]
An ID for the data source. This ID is unique per AWS Region for each AWS account.
string
[REQUIRED]
A display name for the data source.
string
[REQUIRED]
The type of the data source. Currently, the supported types for this operation are: ATHENA, AURORA, AURORA_POSTGRESQL, MARIADB, MYSQL, POSTGRESQL, PRESTO, REDSHIFT, S3, SNOWFLAKE, SPARK, SQLSERVER, TERADATA. Use ListDataSources to return a list of all data sources.
dict
The parameters that QuickSight uses to connect to your underlying source.
AmazonElasticsearchParameters (dict) --
Amazon Elasticsearch Service parameters.
Domain (string) -- [REQUIRED]
The Amazon Elasticsearch Service domain.
AthenaParameters (dict) --
Amazon Athena parameters.
WorkGroup (string) --
The workgroup that Amazon Athena uses.
AuroraParameters (dict) --
Amazon Aurora MySQL parameters.
Host (string) -- [REQUIRED]
Host.
Port (integer) -- [REQUIRED]
Port.
Database (string) -- [REQUIRED]
Database.
AuroraPostgreSqlParameters (dict) --
Aurora PostgreSQL parameters.
Host (string) -- [REQUIRED]
Host.
Port (integer) -- [REQUIRED]
Port.
Database (string) -- [REQUIRED]
Database.
AwsIotAnalyticsParameters (dict) --
AWS IoT Analytics parameters.
DataSetName (string) -- [REQUIRED]
Dataset name.
JiraParameters (dict) --
Jira parameters.
SiteBaseUrl (string) -- [REQUIRED]
The base URL of the Jira site.
MariaDbParameters (dict) --
MariaDB parameters.
Host (string) -- [REQUIRED]
Host.
Port (integer) -- [REQUIRED]
Port.
Database (string) -- [REQUIRED]
Database.
MySqlParameters (dict) --
MySQL parameters.
Host (string) -- [REQUIRED]
Host.
Port (integer) -- [REQUIRED]
Port.
Database (string) -- [REQUIRED]
Database.
PostgreSqlParameters (dict) --
PostgreSQL parameters.
Host (string) -- [REQUIRED]
Host.
Port (integer) -- [REQUIRED]
Port.
Database (string) -- [REQUIRED]
Database.
PrestoParameters (dict) --
Presto parameters.
Host (string) -- [REQUIRED]
Host.
Port (integer) -- [REQUIRED]
Port.
Catalog (string) -- [REQUIRED]
Catalog.
RdsParameters (dict) --
Amazon RDS parameters.
InstanceId (string) -- [REQUIRED]
Instance ID.
Database (string) -- [REQUIRED]
Database.
RedshiftParameters (dict) --
Amazon Redshift parameters.
Host (string) --
Host. This field can be blank if ClusterId is provided.
Port (integer) --
Port. This field can be blank if the ClusterId is provided.
Database (string) -- [REQUIRED]
Database.
ClusterId (string) --
Cluster ID. This field can be blank if the Host and Port are provided.
S3Parameters (dict) --
S3 parameters.
ManifestFileLocation (dict) -- [REQUIRED]
Location of the Amazon S3 manifest file. This is NULL if the manifest file was uploaded in the console.
Bucket (string) -- [REQUIRED]
Amazon S3 bucket.
Key (string) -- [REQUIRED]
Amazon S3 key that identifies an object.
ServiceNowParameters (dict) --
ServiceNow parameters.
SiteBaseUrl (string) -- [REQUIRED]
URL of the base site.
SnowflakeParameters (dict) --
Snowflake parameters.
Host (string) -- [REQUIRED]
Host.
Database (string) -- [REQUIRED]
Database.
Warehouse (string) -- [REQUIRED]
Warehouse.
SparkParameters (dict) --
Spark parameters.
Host (string) -- [REQUIRED]
Host.
Port (integer) -- [REQUIRED]
Port.
SqlServerParameters (dict) --
SQL Server parameters.
Host (string) -- [REQUIRED]
Host.
Port (integer) -- [REQUIRED]
Port.
Database (string) -- [REQUIRED]
Database.
TeradataParameters (dict) --
Teradata parameters.
Host (string) -- [REQUIRED]
Host.
Port (integer) -- [REQUIRED]
Port.
Database (string) -- [REQUIRED]
Database.
TwitterParameters (dict) --
Twitter parameters.
Query (string) -- [REQUIRED]
Twitter query string.
MaxRows (integer) -- [REQUIRED]
Maximum number of rows to query Twitter.
dict
The credentials QuickSight that uses to connect to your underlying source. Currently, only credentials based on user name and password are supported.
CredentialPair (dict) --
Credential pair. For more information, see CredentialPair.
Username (string) -- [REQUIRED]
User name.
Password (string) -- [REQUIRED]
Password.
AlternateDataSourceParameters (list) --
A set of alternate data source parameters that you want to share for these credentials. The credentials are applied in tandem with the data source parameters when you copy a data source by using a create or update request. The API compares the DataSourceParameters structure that's in the request with the structures in the AlternateDataSourceParameters allowlist. If the structures are an exact match, the request is allowed to use the new data source with the existing credentials. If the AlternateDataSourceParameters list is null, the DataSourceParameters originally used with these Credentials is automatically allowed.
(dict) --
The parameters that Amazon QuickSight uses to connect to your underlying data source. This is a variant type structure. For this structure to be valid, only one of the attributes can be non-null.
AmazonElasticsearchParameters (dict) --
Amazon Elasticsearch Service parameters.
Domain (string) -- [REQUIRED]
The Amazon Elasticsearch Service domain.
AthenaParameters (dict) --
Amazon Athena parameters.
WorkGroup (string) --
The workgroup that Amazon Athena uses.
AuroraParameters (dict) --
Amazon Aurora MySQL parameters.
Host (string) -- [REQUIRED]
Host.
Port (integer) -- [REQUIRED]
Port.
Database (string) -- [REQUIRED]
Database.
AuroraPostgreSqlParameters (dict) --
Aurora PostgreSQL parameters.
Host (string) -- [REQUIRED]
Host.
Port (integer) -- [REQUIRED]
Port.
Database (string) -- [REQUIRED]
Database.
AwsIotAnalyticsParameters (dict) --
AWS IoT Analytics parameters.
DataSetName (string) -- [REQUIRED]
Dataset name.
JiraParameters (dict) --
Jira parameters.
SiteBaseUrl (string) -- [REQUIRED]
The base URL of the Jira site.
MariaDbParameters (dict) --
MariaDB parameters.
Host (string) -- [REQUIRED]
Host.
Port (integer) -- [REQUIRED]
Port.
Database (string) -- [REQUIRED]
Database.
MySqlParameters (dict) --
MySQL parameters.
Host (string) -- [REQUIRED]
Host.
Port (integer) -- [REQUIRED]
Port.
Database (string) -- [REQUIRED]
Database.
PostgreSqlParameters (dict) --
PostgreSQL parameters.
Host (string) -- [REQUIRED]
Host.
Port (integer) -- [REQUIRED]
Port.
Database (string) -- [REQUIRED]
Database.
PrestoParameters (dict) --
Presto parameters.
Host (string) -- [REQUIRED]
Host.
Port (integer) -- [REQUIRED]
Port.
Catalog (string) -- [REQUIRED]
Catalog.
RdsParameters (dict) --
Amazon RDS parameters.
InstanceId (string) -- [REQUIRED]
Instance ID.
Database (string) -- [REQUIRED]
Database.
RedshiftParameters (dict) --
Amazon Redshift parameters.
Host (string) --
Host. This field can be blank if ClusterId is provided.
Port (integer) --
Port. This field can be blank if the ClusterId is provided.
Database (string) -- [REQUIRED]
Database.
ClusterId (string) --
Cluster ID. This field can be blank if the Host and Port are provided.
S3Parameters (dict) --
S3 parameters.
ManifestFileLocation (dict) -- [REQUIRED]
Location of the Amazon S3 manifest file. This is NULL if the manifest file was uploaded in the console.
Bucket (string) -- [REQUIRED]
Amazon S3 bucket.
Key (string) -- [REQUIRED]
Amazon S3 key that identifies an object.
ServiceNowParameters (dict) --
ServiceNow parameters.
SiteBaseUrl (string) -- [REQUIRED]
URL of the base site.
SnowflakeParameters (dict) --
Snowflake parameters.
Host (string) -- [REQUIRED]
Host.
Database (string) -- [REQUIRED]
Database.
Warehouse (string) -- [REQUIRED]
Warehouse.
SparkParameters (dict) --
Spark parameters.
Host (string) -- [REQUIRED]
Host.
Port (integer) -- [REQUIRED]
Port.
SqlServerParameters (dict) --
SQL Server parameters.
Host (string) -- [REQUIRED]
Host.
Port (integer) -- [REQUIRED]
Port.
Database (string) -- [REQUIRED]
Database.
TeradataParameters (dict) --
Teradata parameters.
Host (string) -- [REQUIRED]
Host.
Port (integer) -- [REQUIRED]
Port.
Database (string) -- [REQUIRED]
Database.
TwitterParameters (dict) --
Twitter parameters.
Query (string) -- [REQUIRED]
Twitter query string.
MaxRows (integer) -- [REQUIRED]
Maximum number of rows to query Twitter.
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.
list
A list of resource permissions on the data source.
(dict) --
Permission for the resource.
Principal (string) -- [REQUIRED]
The Amazon Resource Name (ARN) of an Amazon QuickSight user or group, or an IAM ARN. If you are using cross-account resource sharing, this is the IAM ARN of an account root. Otherwise, it is the ARN of a QuickSight user or group. .
Actions (list) -- [REQUIRED]
The action to grant or revoke permissions on, for example "quicksight:DescribeDashboard".
(string) --
dict
Use this parameter only when you want QuickSight to use a VPC connection when connecting to your underlying source.
VpcConnectionArn (string) -- [REQUIRED]
The Amazon Resource Name (ARN) for the VPC connection.
dict
Secure Socket Layer (SSL) properties that apply when QuickSight connects to your underlying source.
DisableSsl (boolean) --
A Boolean option to control whether SSL should be disabled.
list
Contains a map of the key-value pairs for the resource tag or tags assigned to the data source.
(dict) --
The key or keys of the key-value pairs for the resource tag or tags assigned to the resource.
Key (string) -- [REQUIRED]
Tag key.
Value (string) -- [REQUIRED]
Tag value.
dict
Response Syntax
{
'Arn': 'string',
'DataSourceId': 'string',
'CreationStatus': 'CREATION_IN_PROGRESS'|'CREATION_SUCCESSFUL'|'CREATION_FAILED'|'UPDATE_IN_PROGRESS'|'UPDATE_SUCCESSFUL'|'UPDATE_FAILED',
'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 AWS Region for each AWS account.
CreationStatus (string) --
The status of creating the data source.
RequestId (string) --
The AWS request ID for this operation.
Status (integer) --
The HTTP status of the request.
{'DataSource': {'AlternateDataSourceParameters': [{'AmazonElasticsearchParameters': {'Domain': 'string'},
'AthenaParameters': {'WorkGroup': 'string'},
'AuroraParameters': {'Database': 'string',
'Host': 'string',
'Port': 'integer'},
'AuroraPostgreSqlParameters': {'Database': 'string',
'Host': 'string',
'Port': 'integer'},
'AwsIotAnalyticsParameters': {'DataSetName': 'string'},
'JiraParameters': {'SiteBaseUrl': 'string'},
'MariaDbParameters': {'Database': 'string',
'Host': 'string',
'Port': 'integer'},
'MySqlParameters': {'Database': 'string',
'Host': 'string',
'Port': 'integer'},
'PostgreSqlParameters': {'Database': 'string',
'Host': 'string',
'Port': 'integer'},
'PrestoParameters': {'Catalog': 'string',
'Host': 'string',
'Port': 'integer'},
'RdsParameters': {'Database': 'string',
'InstanceId': 'string'},
'RedshiftParameters': {'ClusterId': 'string',
'Database': 'string',
'Host': 'string',
'Port': 'integer'},
'S3Parameters': {'ManifestFileLocation': {'Bucket': 'string',
'Key': 'string'}},
'ServiceNowParameters': {'SiteBaseUrl': 'string'},
'SnowflakeParameters': {'Database': 'string',
'Host': 'string',
'Warehouse': 'string'},
'SparkParameters': {'Host': 'string',
'Port': 'integer'},
'SqlServerParameters': {'Database': 'string',
'Host': 'string',
'Port': 'integer'},
'TeradataParameters': {'Database': 'string',
'Host': 'string',
'Port': 'integer'},
'TwitterParameters': {'MaxRows': 'integer',
'Query': 'string'}}],
'ErrorInfo': {'Type': {'ACCESS_DENIED',
'COPY_SOURCE_NOT_FOUND'}}}}
Describes a data source.
See also: AWS API Documentation
Request Syntax
client.describe_data_source(
AwsAccountId='string',
DataSourceId='string'
)
string
[REQUIRED]
The AWS account ID.
string
[REQUIRED]
The ID of the data source. This ID is unique per AWS Region for each AWS 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'|'POSTGRESQL'|'PRESTO'|'REDSHIFT'|'S3'|'SALESFORCE'|'SERVICENOW'|'SNOWFLAKE'|'SPARK'|'SQLSERVER'|'TERADATA'|'TWITTER',
'Status': 'CREATION_IN_PROGRESS'|'CREATION_SUCCESSFUL'|'CREATION_FAILED'|'UPDATE_IN_PROGRESS'|'UPDATE_SUCCESSFUL'|'UPDATE_FAILED',
'CreatedTime': datetime(2015, 1, 1),
'LastUpdatedTime': datetime(2015, 1, 1),
'DataSourceParameters': {
'AmazonElasticsearchParameters': {
'Domain': 'string'
},
'AthenaParameters': {
'WorkGroup': 'string'
},
'AuroraParameters': {
'Host': 'string',
'Port': 123,
'Database': 'string'
},
'AuroraPostgreSqlParameters': {
'Host': 'string',
'Port': 123,
'Database': 'string'
},
'AwsIotAnalyticsParameters': {
'DataSetName': 'string'
},
'JiraParameters': {
'SiteBaseUrl': 'string'
},
'MariaDbParameters': {
'Host': 'string',
'Port': 123,
'Database': 'string'
},
'MySqlParameters': {
'Host': 'string',
'Port': 123,
'Database': 'string'
},
'PostgreSqlParameters': {
'Host': 'string',
'Port': 123,
'Database': 'string'
},
'PrestoParameters': {
'Host': 'string',
'Port': 123,
'Catalog': 'string'
},
'RdsParameters': {
'InstanceId': 'string',
'Database': 'string'
},
'RedshiftParameters': {
'Host': 'string',
'Port': 123,
'Database': 'string',
'ClusterId': 'string'
},
'S3Parameters': {
'ManifestFileLocation': {
'Bucket': 'string',
'Key': 'string'
}
},
'ServiceNowParameters': {
'SiteBaseUrl': 'string'
},
'SnowflakeParameters': {
'Host': 'string',
'Database': 'string',
'Warehouse': 'string'
},
'SparkParameters': {
'Host': 'string',
'Port': 123
},
'SqlServerParameters': {
'Host': 'string',
'Port': 123,
'Database': 'string'
},
'TeradataParameters': {
'Host': 'string',
'Port': 123,
'Database': 'string'
},
'TwitterParameters': {
'Query': 'string',
'MaxRows': 123
}
},
'AlternateDataSourceParameters': [
{
'AmazonElasticsearchParameters': {
'Domain': 'string'
},
'AthenaParameters': {
'WorkGroup': 'string'
},
'AuroraParameters': {
'Host': 'string',
'Port': 123,
'Database': 'string'
},
'AuroraPostgreSqlParameters': {
'Host': 'string',
'Port': 123,
'Database': 'string'
},
'AwsIotAnalyticsParameters': {
'DataSetName': 'string'
},
'JiraParameters': {
'SiteBaseUrl': 'string'
},
'MariaDbParameters': {
'Host': 'string',
'Port': 123,
'Database': 'string'
},
'MySqlParameters': {
'Host': 'string',
'Port': 123,
'Database': 'string'
},
'PostgreSqlParameters': {
'Host': 'string',
'Port': 123,
'Database': 'string'
},
'PrestoParameters': {
'Host': 'string',
'Port': 123,
'Catalog': 'string'
},
'RdsParameters': {
'InstanceId': 'string',
'Database': 'string'
},
'RedshiftParameters': {
'Host': 'string',
'Port': 123,
'Database': 'string',
'ClusterId': 'string'
},
'S3Parameters': {
'ManifestFileLocation': {
'Bucket': 'string',
'Key': 'string'
}
},
'ServiceNowParameters': {
'SiteBaseUrl': 'string'
},
'SnowflakeParameters': {
'Host': 'string',
'Database': 'string',
'Warehouse': 'string'
},
'SparkParameters': {
'Host': 'string',
'Port': 123
},
'SqlServerParameters': {
'Host': 'string',
'Port': 123,
'Database': 'string'
},
'TeradataParameters': {
'Host': 'string',
'Port': 123,
'Database': 'string'
},
'TwitterParameters': {
'Query': 'string',
'MaxRows': 123
}
},
],
'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'
}
},
'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 AWS Region for each AWS account.
Name (string) --
A display name for the data source.
Type (string) --
The type of the data source. This type indicates which database engine the data source connects to.
Status (string) --
The HTTP status of the request.
CreatedTime (datetime) --
The time that this data source was created.
LastUpdatedTime (datetime) --
The last time that this data source was updated.
DataSourceParameters (dict) --
The parameters that Amazon QuickSight uses to connect to your underlying source. This is a variant type structure. For this structure to be valid, only one of the attributes can be non-null.
AmazonElasticsearchParameters (dict) --
Amazon Elasticsearch Service parameters.
Domain (string) --
The Amazon Elasticsearch Service domain.
AthenaParameters (dict) --
Amazon Athena parameters.
WorkGroup (string) --
The workgroup that Amazon Athena uses.
AuroraParameters (dict) --
Amazon Aurora MySQL parameters.
Host (string) --
Host.
Port (integer) --
Port.
Database (string) --
Database.
AuroraPostgreSqlParameters (dict) --
Aurora PostgreSQL parameters.
Host (string) --
Host.
Port (integer) --
Port.
Database (string) --
Database.
AwsIotAnalyticsParameters (dict) --
AWS IoT Analytics parameters.
DataSetName (string) --
Dataset name.
JiraParameters (dict) --
Jira parameters.
SiteBaseUrl (string) --
The base URL of the Jira site.
MariaDbParameters (dict) --
MariaDB parameters.
Host (string) --
Host.
Port (integer) --
Port.
Database (string) --
Database.
MySqlParameters (dict) --
MySQL parameters.
Host (string) --
Host.
Port (integer) --
Port.
Database (string) --
Database.
PostgreSqlParameters (dict) --
PostgreSQL parameters.
Host (string) --
Host.
Port (integer) --
Port.
Database (string) --
Database.
PrestoParameters (dict) --
Presto parameters.
Host (string) --
Host.
Port (integer) --
Port.
Catalog (string) --
Catalog.
RdsParameters (dict) --
Amazon RDS parameters.
InstanceId (string) --
Instance ID.
Database (string) --
Database.
RedshiftParameters (dict) --
Amazon Redshift parameters.
Host (string) --
Host. This field can be blank if ClusterId is provided.
Port (integer) --
Port. This field can be blank if the ClusterId is provided.
Database (string) --
Database.
ClusterId (string) --
Cluster ID. This field can be blank if the Host and Port are provided.
S3Parameters (dict) --
S3 parameters.
ManifestFileLocation (dict) --
Location of the Amazon S3 manifest file. This is NULL if the manifest file was uploaded in the console.
Bucket (string) --
Amazon S3 bucket.
Key (string) --
Amazon S3 key that identifies an object.
ServiceNowParameters (dict) --
ServiceNow parameters.
SiteBaseUrl (string) --
URL of the base site.
SnowflakeParameters (dict) --
Snowflake parameters.
Host (string) --
Host.
Database (string) --
Database.
Warehouse (string) --
Warehouse.
SparkParameters (dict) --
Spark parameters.
Host (string) --
Host.
Port (integer) --
Port.
SqlServerParameters (dict) --
SQL Server parameters.
Host (string) --
Host.
Port (integer) --
Port.
Database (string) --
Database.
TeradataParameters (dict) --
Teradata parameters.
Host (string) --
Host.
Port (integer) --
Port.
Database (string) --
Database.
TwitterParameters (dict) --
Twitter parameters.
Query (string) --
Twitter query string.
MaxRows (integer) --
Maximum number of rows to query Twitter.
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 compares the DataSourceParameters structure that's in the request with the structures in the AlternateDataSourceParameters allowlist. If the structures are an exact match, the request is allowed to use the credentials from this existing data source. If the AlternateDataSourceParameters list is null, the Credentials originally used with this DataSourceParameters are automatically allowed.
(dict) --
The parameters that Amazon QuickSight uses to connect to your underlying data source. This is a variant type structure. For this structure to be valid, only one of the attributes can be non-null.
AmazonElasticsearchParameters (dict) --
Amazon Elasticsearch Service parameters.
Domain (string) --
The Amazon Elasticsearch Service domain.
AthenaParameters (dict) --
Amazon Athena parameters.
WorkGroup (string) --
The workgroup that Amazon Athena uses.
AuroraParameters (dict) --
Amazon Aurora MySQL parameters.
Host (string) --
Host.
Port (integer) --
Port.
Database (string) --
Database.
AuroraPostgreSqlParameters (dict) --
Aurora PostgreSQL parameters.
Host (string) --
Host.
Port (integer) --
Port.
Database (string) --
Database.
AwsIotAnalyticsParameters (dict) --
AWS IoT Analytics parameters.
DataSetName (string) --
Dataset name.
JiraParameters (dict) --
Jira parameters.
SiteBaseUrl (string) --
The base URL of the Jira site.
MariaDbParameters (dict) --
MariaDB parameters.
Host (string) --
Host.
Port (integer) --
Port.
Database (string) --
Database.
MySqlParameters (dict) --
MySQL parameters.
Host (string) --
Host.
Port (integer) --
Port.
Database (string) --
Database.
PostgreSqlParameters (dict) --
PostgreSQL parameters.
Host (string) --
Host.
Port (integer) --
Port.
Database (string) --
Database.
PrestoParameters (dict) --
Presto parameters.
Host (string) --
Host.
Port (integer) --
Port.
Catalog (string) --
Catalog.
RdsParameters (dict) --
Amazon RDS parameters.
InstanceId (string) --
Instance ID.
Database (string) --
Database.
RedshiftParameters (dict) --
Amazon Redshift parameters.
Host (string) --
Host. This field can be blank if ClusterId is provided.
Port (integer) --
Port. This field can be blank if the ClusterId is provided.
Database (string) --
Database.
ClusterId (string) --
Cluster ID. This field can be blank if the Host and Port are provided.
S3Parameters (dict) --
S3 parameters.
ManifestFileLocation (dict) --
Location of the Amazon S3 manifest file. This is NULL if the manifest file was uploaded in the console.
Bucket (string) --
Amazon S3 bucket.
Key (string) --
Amazon S3 key that identifies an object.
ServiceNowParameters (dict) --
ServiceNow parameters.
SiteBaseUrl (string) --
URL of the base site.
SnowflakeParameters (dict) --
Snowflake parameters.
Host (string) --
Host.
Database (string) --
Database.
Warehouse (string) --
Warehouse.
SparkParameters (dict) --
Spark parameters.
Host (string) --
Host.
Port (integer) --
Port.
SqlServerParameters (dict) --
SQL Server parameters.
Host (string) --
Host.
Port (integer) --
Port.
Database (string) --
Database.
TeradataParameters (dict) --
Teradata parameters.
Host (string) --
Host.
Port (integer) --
Port.
Database (string) --
Database.
TwitterParameters (dict) --
Twitter parameters.
Query (string) --
Twitter query string.
MaxRows (integer) --
Maximum number of rows to query Twitter.
VpcConnectionProperties (dict) --
The VPC connection information. You need to use this parameter only when you want QuickSight to use a VPC connection when connecting to your underlying source.
VpcConnectionArn (string) --
The Amazon Resource Name (ARN) for the VPC connection.
SslProperties (dict) --
Secure Socket Layer (SSL) properties that apply when QuickSight connects to your underlying source.
DisableSsl (boolean) --
A Boolean option to control whether SSL should be disabled.
ErrorInfo (dict) --
Error information from the last update or the creation of the data source.
Type (string) --
Error type.
Message (string) --
Error message.
RequestId (string) --
The AWS request ID for this operation.
Status (integer) --
The HTTP status of the request.
{'DataSources': {'AlternateDataSourceParameters': [{'AmazonElasticsearchParameters': {'Domain': 'string'},
'AthenaParameters': {'WorkGroup': 'string'},
'AuroraParameters': {'Database': 'string',
'Host': 'string',
'Port': 'integer'},
'AuroraPostgreSqlParameters': {'Database': 'string',
'Host': 'string',
'Port': 'integer'},
'AwsIotAnalyticsParameters': {'DataSetName': 'string'},
'JiraParameters': {'SiteBaseUrl': 'string'},
'MariaDbParameters': {'Database': 'string',
'Host': 'string',
'Port': 'integer'},
'MySqlParameters': {'Database': 'string',
'Host': 'string',
'Port': 'integer'},
'PostgreSqlParameters': {'Database': 'string',
'Host': 'string',
'Port': 'integer'},
'PrestoParameters': {'Catalog': 'string',
'Host': 'string',
'Port': 'integer'},
'RdsParameters': {'Database': 'string',
'InstanceId': 'string'},
'RedshiftParameters': {'ClusterId': 'string',
'Database': 'string',
'Host': 'string',
'Port': 'integer'},
'S3Parameters': {'ManifestFileLocation': {'Bucket': 'string',
'Key': 'string'}},
'ServiceNowParameters': {'SiteBaseUrl': 'string'},
'SnowflakeParameters': {'Database': 'string',
'Host': 'string',
'Warehouse': 'string'},
'SparkParameters': {'Host': 'string',
'Port': 'integer'},
'SqlServerParameters': {'Database': 'string',
'Host': 'string',
'Port': 'integer'},
'TeradataParameters': {'Database': 'string',
'Host': 'string',
'Port': 'integer'},
'TwitterParameters': {'MaxRows': 'integer',
'Query': 'string'}}],
'ErrorInfo': {'Type': {'ACCESS_DENIED',
'COPY_SOURCE_NOT_FOUND'}}}}
Lists data sources in current AWS Region that belong to this AWS account.
See also: AWS API Documentation
Request Syntax
client.list_data_sources(
AwsAccountId='string',
NextToken='string',
MaxResults=123
)
string
[REQUIRED]
The AWS 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'|'POSTGRESQL'|'PRESTO'|'REDSHIFT'|'S3'|'SALESFORCE'|'SERVICENOW'|'SNOWFLAKE'|'SPARK'|'SQLSERVER'|'TERADATA'|'TWITTER',
'Status': 'CREATION_IN_PROGRESS'|'CREATION_SUCCESSFUL'|'CREATION_FAILED'|'UPDATE_IN_PROGRESS'|'UPDATE_SUCCESSFUL'|'UPDATE_FAILED',
'CreatedTime': datetime(2015, 1, 1),
'LastUpdatedTime': datetime(2015, 1, 1),
'DataSourceParameters': {
'AmazonElasticsearchParameters': {
'Domain': 'string'
},
'AthenaParameters': {
'WorkGroup': 'string'
},
'AuroraParameters': {
'Host': 'string',
'Port': 123,
'Database': 'string'
},
'AuroraPostgreSqlParameters': {
'Host': 'string',
'Port': 123,
'Database': 'string'
},
'AwsIotAnalyticsParameters': {
'DataSetName': 'string'
},
'JiraParameters': {
'SiteBaseUrl': 'string'
},
'MariaDbParameters': {
'Host': 'string',
'Port': 123,
'Database': 'string'
},
'MySqlParameters': {
'Host': 'string',
'Port': 123,
'Database': 'string'
},
'PostgreSqlParameters': {
'Host': 'string',
'Port': 123,
'Database': 'string'
},
'PrestoParameters': {
'Host': 'string',
'Port': 123,
'Catalog': 'string'
},
'RdsParameters': {
'InstanceId': 'string',
'Database': 'string'
},
'RedshiftParameters': {
'Host': 'string',
'Port': 123,
'Database': 'string',
'ClusterId': 'string'
},
'S3Parameters': {
'ManifestFileLocation': {
'Bucket': 'string',
'Key': 'string'
}
},
'ServiceNowParameters': {
'SiteBaseUrl': 'string'
},
'SnowflakeParameters': {
'Host': 'string',
'Database': 'string',
'Warehouse': 'string'
},
'SparkParameters': {
'Host': 'string',
'Port': 123
},
'SqlServerParameters': {
'Host': 'string',
'Port': 123,
'Database': 'string'
},
'TeradataParameters': {
'Host': 'string',
'Port': 123,
'Database': 'string'
},
'TwitterParameters': {
'Query': 'string',
'MaxRows': 123
}
},
'AlternateDataSourceParameters': [
{
'AmazonElasticsearchParameters': {
'Domain': 'string'
},
'AthenaParameters': {
'WorkGroup': 'string'
},
'AuroraParameters': {
'Host': 'string',
'Port': 123,
'Database': 'string'
},
'AuroraPostgreSqlParameters': {
'Host': 'string',
'Port': 123,
'Database': 'string'
},
'AwsIotAnalyticsParameters': {
'DataSetName': 'string'
},
'JiraParameters': {
'SiteBaseUrl': 'string'
},
'MariaDbParameters': {
'Host': 'string',
'Port': 123,
'Database': 'string'
},
'MySqlParameters': {
'Host': 'string',
'Port': 123,
'Database': 'string'
},
'PostgreSqlParameters': {
'Host': 'string',
'Port': 123,
'Database': 'string'
},
'PrestoParameters': {
'Host': 'string',
'Port': 123,
'Catalog': 'string'
},
'RdsParameters': {
'InstanceId': 'string',
'Database': 'string'
},
'RedshiftParameters': {
'Host': 'string',
'Port': 123,
'Database': 'string',
'ClusterId': 'string'
},
'S3Parameters': {
'ManifestFileLocation': {
'Bucket': 'string',
'Key': 'string'
}
},
'ServiceNowParameters': {
'SiteBaseUrl': 'string'
},
'SnowflakeParameters': {
'Host': 'string',
'Database': 'string',
'Warehouse': 'string'
},
'SparkParameters': {
'Host': 'string',
'Port': 123
},
'SqlServerParameters': {
'Host': 'string',
'Port': 123,
'Database': 'string'
},
'TeradataParameters': {
'Host': 'string',
'Port': 123,
'Database': 'string'
},
'TwitterParameters': {
'Query': 'string',
'MaxRows': 123
}
},
],
'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'
}
},
],
'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 AWS Region for each AWS account.
Name (string) --
A display name for the data source.
Type (string) --
The type of the data source. This type indicates which database engine the data source connects to.
Status (string) --
The HTTP status of the request.
CreatedTime (datetime) --
The time that this data source was created.
LastUpdatedTime (datetime) --
The last time that this data source was updated.
DataSourceParameters (dict) --
The parameters that Amazon QuickSight uses to connect to your underlying source. This is a variant type structure. For this structure to be valid, only one of the attributes can be non-null.
AmazonElasticsearchParameters (dict) --
Amazon Elasticsearch Service parameters.
Domain (string) --
The Amazon Elasticsearch Service domain.
AthenaParameters (dict) --
Amazon Athena parameters.
WorkGroup (string) --
The workgroup that Amazon Athena uses.
AuroraParameters (dict) --
Amazon Aurora MySQL parameters.
Host (string) --
Host.
Port (integer) --
Port.
Database (string) --
Database.
AuroraPostgreSqlParameters (dict) --
Aurora PostgreSQL parameters.
Host (string) --
Host.
Port (integer) --
Port.
Database (string) --
Database.
AwsIotAnalyticsParameters (dict) --
AWS IoT Analytics parameters.
DataSetName (string) --
Dataset name.
JiraParameters (dict) --
Jira parameters.
SiteBaseUrl (string) --
The base URL of the Jira site.
MariaDbParameters (dict) --
MariaDB parameters.
Host (string) --
Host.
Port (integer) --
Port.
Database (string) --
Database.
MySqlParameters (dict) --
MySQL parameters.
Host (string) --
Host.
Port (integer) --
Port.
Database (string) --
Database.
PostgreSqlParameters (dict) --
PostgreSQL parameters.
Host (string) --
Host.
Port (integer) --
Port.
Database (string) --
Database.
PrestoParameters (dict) --
Presto parameters.
Host (string) --
Host.
Port (integer) --
Port.
Catalog (string) --
Catalog.
RdsParameters (dict) --
Amazon RDS parameters.
InstanceId (string) --
Instance ID.
Database (string) --
Database.
RedshiftParameters (dict) --
Amazon Redshift parameters.
Host (string) --
Host. This field can be blank if ClusterId is provided.
Port (integer) --
Port. This field can be blank if the ClusterId is provided.
Database (string) --
Database.
ClusterId (string) --
Cluster ID. This field can be blank if the Host and Port are provided.
S3Parameters (dict) --
S3 parameters.
ManifestFileLocation (dict) --
Location of the Amazon S3 manifest file. This is NULL if the manifest file was uploaded in the console.
Bucket (string) --
Amazon S3 bucket.
Key (string) --
Amazon S3 key that identifies an object.
ServiceNowParameters (dict) --
ServiceNow parameters.
SiteBaseUrl (string) --
URL of the base site.
SnowflakeParameters (dict) --
Snowflake parameters.
Host (string) --
Host.
Database (string) --
Database.
Warehouse (string) --
Warehouse.
SparkParameters (dict) --
Spark parameters.
Host (string) --
Host.
Port (integer) --
Port.
SqlServerParameters (dict) --
SQL Server parameters.
Host (string) --
Host.
Port (integer) --
Port.
Database (string) --
Database.
TeradataParameters (dict) --
Teradata parameters.
Host (string) --
Host.
Port (integer) --
Port.
Database (string) --
Database.
TwitterParameters (dict) --
Twitter parameters.
Query (string) --
Twitter query string.
MaxRows (integer) --
Maximum number of rows to query Twitter.
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 compares the DataSourceParameters structure that's in the request with the structures in the AlternateDataSourceParameters allowlist. If the structures are an exact match, the request is allowed to use the credentials from this existing data source. If the AlternateDataSourceParameters list is null, the Credentials originally used with this DataSourceParameters are automatically allowed.
(dict) --
The parameters that Amazon QuickSight uses to connect to your underlying data source. This is a variant type structure. For this structure to be valid, only one of the attributes can be non-null.
AmazonElasticsearchParameters (dict) --
Amazon Elasticsearch Service parameters.
Domain (string) --
The Amazon Elasticsearch Service domain.
AthenaParameters (dict) --
Amazon Athena parameters.
WorkGroup (string) --
The workgroup that Amazon Athena uses.
AuroraParameters (dict) --
Amazon Aurora MySQL parameters.
Host (string) --
Host.
Port (integer) --
Port.
Database (string) --
Database.
AuroraPostgreSqlParameters (dict) --
Aurora PostgreSQL parameters.
Host (string) --
Host.
Port (integer) --
Port.
Database (string) --
Database.
AwsIotAnalyticsParameters (dict) --
AWS IoT Analytics parameters.
DataSetName (string) --
Dataset name.
JiraParameters (dict) --
Jira parameters.
SiteBaseUrl (string) --
The base URL of the Jira site.
MariaDbParameters (dict) --
MariaDB parameters.
Host (string) --
Host.
Port (integer) --
Port.
Database (string) --
Database.
MySqlParameters (dict) --
MySQL parameters.
Host (string) --
Host.
Port (integer) --
Port.
Database (string) --
Database.
PostgreSqlParameters (dict) --
PostgreSQL parameters.
Host (string) --
Host.
Port (integer) --
Port.
Database (string) --
Database.
PrestoParameters (dict) --
Presto parameters.
Host (string) --
Host.
Port (integer) --
Port.
Catalog (string) --
Catalog.
RdsParameters (dict) --
Amazon RDS parameters.
InstanceId (string) --
Instance ID.
Database (string) --
Database.
RedshiftParameters (dict) --
Amazon Redshift parameters.
Host (string) --
Host. This field can be blank if ClusterId is provided.
Port (integer) --
Port. This field can be blank if the ClusterId is provided.
Database (string) --
Database.
ClusterId (string) --
Cluster ID. This field can be blank if the Host and Port are provided.
S3Parameters (dict) --
S3 parameters.
ManifestFileLocation (dict) --
Location of the Amazon S3 manifest file. This is NULL if the manifest file was uploaded in the console.
Bucket (string) --
Amazon S3 bucket.
Key (string) --
Amazon S3 key that identifies an object.
ServiceNowParameters (dict) --
ServiceNow parameters.
SiteBaseUrl (string) --
URL of the base site.
SnowflakeParameters (dict) --
Snowflake parameters.
Host (string) --
Host.
Database (string) --
Database.
Warehouse (string) --
Warehouse.
SparkParameters (dict) --
Spark parameters.
Host (string) --
Host.
Port (integer) --
Port.
SqlServerParameters (dict) --
SQL Server parameters.
Host (string) --
Host.
Port (integer) --
Port.
Database (string) --
Database.
TeradataParameters (dict) --
Teradata parameters.
Host (string) --
Host.
Port (integer) --
Port.
Database (string) --
Database.
TwitterParameters (dict) --
Twitter parameters.
Query (string) --
Twitter query string.
MaxRows (integer) --
Maximum number of rows to query Twitter.
VpcConnectionProperties (dict) --
The VPC connection information. You need to use this parameter only when you want QuickSight to use a VPC connection when connecting to your underlying source.
VpcConnectionArn (string) --
The Amazon Resource Name (ARN) for the VPC connection.
SslProperties (dict) --
Secure Socket Layer (SSL) properties that apply when QuickSight connects to your underlying source.
DisableSsl (boolean) --
A Boolean option to control whether SSL should be disabled.
ErrorInfo (dict) --
Error information from the last update or the creation of the data source.
Type (string) --
Error type.
Message (string) --
Error message.
NextToken (string) --
The token for the next set of results, or null if there are no more results.
RequestId (string) --
The AWS request ID for this operation.
Status (integer) --
The HTTP status of the request.
{'Credentials': {'CopySourceArn': 'string',
'CredentialPair': {'AlternateDataSourceParameters': [{'AmazonElasticsearchParameters': {'Domain': 'string'},
'AthenaParameters': {'WorkGroup': 'string'},
'AuroraParameters': {'Database': 'string',
'Host': 'string',
'Port': 'integer'},
'AuroraPostgreSqlParameters': {'Database': 'string',
'Host': 'string',
'Port': 'integer'},
'AwsIotAnalyticsParameters': {'DataSetName': 'string'},
'JiraParameters': {'SiteBaseUrl': 'string'},
'MariaDbParameters': {'Database': 'string',
'Host': 'string',
'Port': 'integer'},
'MySqlParameters': {'Database': 'string',
'Host': 'string',
'Port': 'integer'},
'PostgreSqlParameters': {'Database': 'string',
'Host': 'string',
'Port': 'integer'},
'PrestoParameters': {'Catalog': 'string',
'Host': 'string',
'Port': 'integer'},
'RdsParameters': {'Database': 'string',
'InstanceId': 'string'},
'RedshiftParameters': {'ClusterId': 'string',
'Database': 'string',
'Host': 'string',
'Port': 'integer'},
'S3Parameters': {'ManifestFileLocation': {'Bucket': 'string',
'Key': 'string'}},
'ServiceNowParameters': {'SiteBaseUrl': 'string'},
'SnowflakeParameters': {'Database': 'string',
'Host': 'string',
'Warehouse': 'string'},
'SparkParameters': {'Host': 'string',
'Port': 'integer'},
'SqlServerParameters': {'Database': 'string',
'Host': 'string',
'Port': 'integer'},
'TeradataParameters': {'Database': 'string',
'Host': 'string',
'Port': 'integer'},
'TwitterParameters': {'MaxRows': 'integer',
'Query': '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'
},
'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'
},
'PostgreSqlParameters': {
'Host': 'string',
'Port': 123,
'Database': 'string'
},
'PrestoParameters': {
'Host': 'string',
'Port': 123,
'Catalog': 'string'
},
'RdsParameters': {
'InstanceId': 'string',
'Database': 'string'
},
'RedshiftParameters': {
'Host': 'string',
'Port': 123,
'Database': 'string',
'ClusterId': 'string'
},
'S3Parameters': {
'ManifestFileLocation': {
'Bucket': 'string',
'Key': 'string'
}
},
'ServiceNowParameters': {
'SiteBaseUrl': 'string'
},
'SnowflakeParameters': {
'Host': 'string',
'Database': 'string',
'Warehouse': 'string'
},
'SparkParameters': {
'Host': 'string',
'Port': 123
},
'SqlServerParameters': {
'Host': 'string',
'Port': 123,
'Database': 'string'
},
'TeradataParameters': {
'Host': 'string',
'Port': 123,
'Database': 'string'
},
'TwitterParameters': {
'Query': 'string',
'MaxRows': 123
}
},
Credentials={
'CredentialPair': {
'Username': 'string',
'Password': 'string',
'AlternateDataSourceParameters': [
{
'AmazonElasticsearchParameters': {
'Domain': 'string'
},
'AthenaParameters': {
'WorkGroup': 'string'
},
'AuroraParameters': {
'Host': 'string',
'Port': 123,
'Database': 'string'
},
'AuroraPostgreSqlParameters': {
'Host': 'string',
'Port': 123,
'Database': 'string'
},
'AwsIotAnalyticsParameters': {
'DataSetName': 'string'
},
'JiraParameters': {
'SiteBaseUrl': 'string'
},
'MariaDbParameters': {
'Host': 'string',
'Port': 123,
'Database': 'string'
},
'MySqlParameters': {
'Host': 'string',
'Port': 123,
'Database': 'string'
},
'PostgreSqlParameters': {
'Host': 'string',
'Port': 123,
'Database': 'string'
},
'PrestoParameters': {
'Host': 'string',
'Port': 123,
'Catalog': 'string'
},
'RdsParameters': {
'InstanceId': 'string',
'Database': 'string'
},
'RedshiftParameters': {
'Host': 'string',
'Port': 123,
'Database': 'string',
'ClusterId': 'string'
},
'S3Parameters': {
'ManifestFileLocation': {
'Bucket': 'string',
'Key': 'string'
}
},
'ServiceNowParameters': {
'SiteBaseUrl': 'string'
},
'SnowflakeParameters': {
'Host': 'string',
'Database': 'string',
'Warehouse': 'string'
},
'SparkParameters': {
'Host': 'string',
'Port': 123
},
'SqlServerParameters': {
'Host': 'string',
'Port': 123,
'Database': 'string'
},
'TeradataParameters': {
'Host': 'string',
'Port': 123,
'Database': 'string'
},
'TwitterParameters': {
'Query': 'string',
'MaxRows': 123
}
},
]
},
'CopySourceArn': 'string'
},
VpcConnectionProperties={
'VpcConnectionArn': 'string'
},
SslProperties={
'DisableSsl': True|False
}
)
string
[REQUIRED]
The AWS account ID.
string
[REQUIRED]
The ID of the data source. This ID is unique per AWS Region for each AWS account.
string
[REQUIRED]
A display name for the data source.
dict
The parameters that QuickSight uses to connect to your underlying source.
AmazonElasticsearchParameters (dict) --
Amazon Elasticsearch Service parameters.
Domain (string) -- [REQUIRED]
The Amazon Elasticsearch Service domain.
AthenaParameters (dict) --
Amazon Athena parameters.
WorkGroup (string) --
The workgroup that Amazon Athena uses.
AuroraParameters (dict) --
Amazon Aurora MySQL parameters.
Host (string) -- [REQUIRED]
Host.
Port (integer) -- [REQUIRED]
Port.
Database (string) -- [REQUIRED]
Database.
AuroraPostgreSqlParameters (dict) --
Aurora PostgreSQL parameters.
Host (string) -- [REQUIRED]
Host.
Port (integer) -- [REQUIRED]
Port.
Database (string) -- [REQUIRED]
Database.
AwsIotAnalyticsParameters (dict) --
AWS IoT Analytics parameters.
DataSetName (string) -- [REQUIRED]
Dataset name.
JiraParameters (dict) --
Jira parameters.
SiteBaseUrl (string) -- [REQUIRED]
The base URL of the Jira site.
MariaDbParameters (dict) --
MariaDB parameters.
Host (string) -- [REQUIRED]
Host.
Port (integer) -- [REQUIRED]
Port.
Database (string) -- [REQUIRED]
Database.
MySqlParameters (dict) --
MySQL parameters.
Host (string) -- [REQUIRED]
Host.
Port (integer) -- [REQUIRED]
Port.
Database (string) -- [REQUIRED]
Database.
PostgreSqlParameters (dict) --
PostgreSQL parameters.
Host (string) -- [REQUIRED]
Host.
Port (integer) -- [REQUIRED]
Port.
Database (string) -- [REQUIRED]
Database.
PrestoParameters (dict) --
Presto parameters.
Host (string) -- [REQUIRED]
Host.
Port (integer) -- [REQUIRED]
Port.
Catalog (string) -- [REQUIRED]
Catalog.
RdsParameters (dict) --
Amazon RDS parameters.
InstanceId (string) -- [REQUIRED]
Instance ID.
Database (string) -- [REQUIRED]
Database.
RedshiftParameters (dict) --
Amazon Redshift parameters.
Host (string) --
Host. This field can be blank if ClusterId is provided.
Port (integer) --
Port. This field can be blank if the ClusterId is provided.
Database (string) -- [REQUIRED]
Database.
ClusterId (string) --
Cluster ID. This field can be blank if the Host and Port are provided.
S3Parameters (dict) --
S3 parameters.
ManifestFileLocation (dict) -- [REQUIRED]
Location of the Amazon S3 manifest file. This is NULL if the manifest file was uploaded in the console.
Bucket (string) -- [REQUIRED]
Amazon S3 bucket.
Key (string) -- [REQUIRED]
Amazon S3 key that identifies an object.
ServiceNowParameters (dict) --
ServiceNow parameters.
SiteBaseUrl (string) -- [REQUIRED]
URL of the base site.
SnowflakeParameters (dict) --
Snowflake parameters.
Host (string) -- [REQUIRED]
Host.
Database (string) -- [REQUIRED]
Database.
Warehouse (string) -- [REQUIRED]
Warehouse.
SparkParameters (dict) --
Spark parameters.
Host (string) -- [REQUIRED]
Host.
Port (integer) -- [REQUIRED]
Port.
SqlServerParameters (dict) --
SQL Server parameters.
Host (string) -- [REQUIRED]
Host.
Port (integer) -- [REQUIRED]
Port.
Database (string) -- [REQUIRED]
Database.
TeradataParameters (dict) --
Teradata parameters.
Host (string) -- [REQUIRED]
Host.
Port (integer) -- [REQUIRED]
Port.
Database (string) -- [REQUIRED]
Database.
TwitterParameters (dict) --
Twitter parameters.
Query (string) -- [REQUIRED]
Twitter query string.
MaxRows (integer) -- [REQUIRED]
Maximum number of rows to query Twitter.
dict
The credentials that QuickSight that uses to connect to your underlying source. Currently, only credentials based on user name and password are supported.
CredentialPair (dict) --
Credential pair. For more information, see CredentialPair.
Username (string) -- [REQUIRED]
User name.
Password (string) -- [REQUIRED]
Password.
AlternateDataSourceParameters (list) --
A set of alternate data source parameters that you want to share for these credentials. The credentials are applied in tandem with the data source parameters when you copy a data source by using a create or update request. The API compares the DataSourceParameters structure that's in the request with the structures in the AlternateDataSourceParameters allowlist. If the structures are an exact match, the request is allowed to use the new data source with the existing credentials. If the AlternateDataSourceParameters list is null, the DataSourceParameters originally used with these Credentials is automatically allowed.
(dict) --
The parameters that Amazon QuickSight uses to connect to your underlying data source. This is a variant type structure. For this structure to be valid, only one of the attributes can be non-null.
AmazonElasticsearchParameters (dict) --
Amazon Elasticsearch Service parameters.
Domain (string) -- [REQUIRED]
The Amazon Elasticsearch Service domain.
AthenaParameters (dict) --
Amazon Athena parameters.
WorkGroup (string) --
The workgroup that Amazon Athena uses.
AuroraParameters (dict) --
Amazon Aurora MySQL parameters.
Host (string) -- [REQUIRED]
Host.
Port (integer) -- [REQUIRED]
Port.
Database (string) -- [REQUIRED]
Database.
AuroraPostgreSqlParameters (dict) --
Aurora PostgreSQL parameters.
Host (string) -- [REQUIRED]
Host.
Port (integer) -- [REQUIRED]
Port.
Database (string) -- [REQUIRED]
Database.
AwsIotAnalyticsParameters (dict) --
AWS IoT Analytics parameters.
DataSetName (string) -- [REQUIRED]
Dataset name.
JiraParameters (dict) --
Jira parameters.
SiteBaseUrl (string) -- [REQUIRED]
The base URL of the Jira site.
MariaDbParameters (dict) --
MariaDB parameters.
Host (string) -- [REQUIRED]
Host.
Port (integer) -- [REQUIRED]
Port.
Database (string) -- [REQUIRED]
Database.
MySqlParameters (dict) --
MySQL parameters.
Host (string) -- [REQUIRED]
Host.
Port (integer) -- [REQUIRED]
Port.
Database (string) -- [REQUIRED]
Database.
PostgreSqlParameters (dict) --
PostgreSQL parameters.
Host (string) -- [REQUIRED]
Host.
Port (integer) -- [REQUIRED]
Port.
Database (string) -- [REQUIRED]
Database.
PrestoParameters (dict) --
Presto parameters.
Host (string) -- [REQUIRED]
Host.
Port (integer) -- [REQUIRED]
Port.
Catalog (string) -- [REQUIRED]
Catalog.
RdsParameters (dict) --
Amazon RDS parameters.
InstanceId (string) -- [REQUIRED]
Instance ID.
Database (string) -- [REQUIRED]
Database.
RedshiftParameters (dict) --
Amazon Redshift parameters.
Host (string) --
Host. This field can be blank if ClusterId is provided.
Port (integer) --
Port. This field can be blank if the ClusterId is provided.
Database (string) -- [REQUIRED]
Database.
ClusterId (string) --
Cluster ID. This field can be blank if the Host and Port are provided.
S3Parameters (dict) --
S3 parameters.
ManifestFileLocation (dict) -- [REQUIRED]
Location of the Amazon S3 manifest file. This is NULL if the manifest file was uploaded in the console.
Bucket (string) -- [REQUIRED]
Amazon S3 bucket.
Key (string) -- [REQUIRED]
Amazon S3 key that identifies an object.
ServiceNowParameters (dict) --
ServiceNow parameters.
SiteBaseUrl (string) -- [REQUIRED]
URL of the base site.
SnowflakeParameters (dict) --
Snowflake parameters.
Host (string) -- [REQUIRED]
Host.
Database (string) -- [REQUIRED]
Database.
Warehouse (string) -- [REQUIRED]
Warehouse.
SparkParameters (dict) --
Spark parameters.
Host (string) -- [REQUIRED]
Host.
Port (integer) -- [REQUIRED]
Port.
SqlServerParameters (dict) --
SQL Server parameters.
Host (string) -- [REQUIRED]
Host.
Port (integer) -- [REQUIRED]
Port.
Database (string) -- [REQUIRED]
Database.
TeradataParameters (dict) --
Teradata parameters.
Host (string) -- [REQUIRED]
Host.
Port (integer) -- [REQUIRED]
Port.
Database (string) -- [REQUIRED]
Database.
TwitterParameters (dict) --
Twitter parameters.
Query (string) -- [REQUIRED]
Twitter query string.
MaxRows (integer) -- [REQUIRED]
Maximum number of rows to query Twitter.
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.
dict
Use this parameter only when you want QuickSight to use a VPC connection when connecting to your underlying source.
VpcConnectionArn (string) -- [REQUIRED]
The Amazon Resource Name (ARN) for the VPC connection.
dict
Secure Socket Layer (SSL) properties that apply when QuickSight connects to your underlying source.
DisableSsl (boolean) --
A Boolean option to control whether SSL should be disabled.
dict
Response Syntax
{
'Arn': 'string',
'DataSourceId': 'string',
'UpdateStatus': 'CREATION_IN_PROGRESS'|'CREATION_SUCCESSFUL'|'CREATION_FAILED'|'UPDATE_IN_PROGRESS'|'UPDATE_SUCCESSFUL'|'UPDATE_FAILED',
'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 AWS Region for each AWS account.
UpdateStatus (string) --
The update status of the data source's last update.
RequestId (string) --
The AWS request ID for this operation.
Status (integer) --
The HTTP status of the request.