awscc.quicksight_datasource¶
Filters¶
event
reduce
value
Actions¶
delete¶
Parent base class for filters and actions.
properties:
type:
enum:
- delete
required:
- type
Permissions - quicksight:DescribeDataSource, quicksight:DescribeDataSourcePermissions, quicksight:DeleteDataSource, quicksight:ListTagsForResource
update¶
Parent base class for filters and actions.
definitions:
AmazonElasticsearchParameters:
description: <p>Amazon Elasticsearch Service parameters.</p>
properties:
Domain:
description: <p>The Amazon Elasticsearch Service domain.</p>
maxLength: 64
minLength: 1
type: string
required:
- Domain
type: object
AmazonOpenSearchParameters:
description: <p>Amazon OpenSearch Service parameters.</p>
properties:
Domain:
description: <p>The Amazon OpenSearch Service domain.</p>
maxLength: 64
minLength: 1
type: string
required:
- Domain
type: object
AthenaParameters:
description: <p>Amazon Athena parameters.</p>
properties:
WorkGroup:
description: <p>The workgroup that Amazon Athena uses.</p>
maxLength: 128
minLength: 1
type: string
type: object
AuroraParameters:
description: <p>Amazon Aurora parameters.</p>
properties:
Database:
description: <p>Database.</p>
maxLength: 128
minLength: 1
type: string
Host:
description: <p>Host.</p>
maxLength: 256
minLength: 1
type: string
Port:
description: <p>Port.</p>
maximum: 65535
minimum: 1
type: number
required:
- Database
- Host
- Port
type: object
AuroraPostgreSqlParameters:
description: <p>Amazon Aurora with PostgreSQL compatibility parameters.</p>
properties:
Database:
description: <p>Database.</p>
maxLength: 128
minLength: 1
type: string
Host:
description: <p>Host.</p>
maxLength: 256
minLength: 1
type: string
Port:
description: <p>Port.</p>
maximum: 65535
minimum: 1
type: number
required:
- Database
- Host
- Port
type: object
AwsIotAnalyticsParameters:
description: <p>AWS IoT Analytics parameters.</p>
properties:
DataSetName:
description: <p>Dataset name.</p>
maxLength: 128
minLength: 1
type: string
required:
- DataSetName
type: object
CredentialPair:
description: <p>The combination of user name and password that are used as credentials.</p>
properties:
AlternateDataSourceParameters:
description: "<p>A set of alternate data source parameters that you want to\
\ share for these\n credentials. The credentials are applied\
\ in tandem with the data source parameters when\n you copy a\
\ data source by using a create or update request. The API operation compares\n\
\ the <code>DataSourceParameters</code> structure that's in the\
\ request with the\n structures in the <code>AlternateDataSourceParameters</code>\
\ allow list. If the\n structures are an exact match, the request\
\ is allowed to use the new data source with\n the existing credentials.\
\ If the <code>AlternateDataSourceParameters</code> list is\n \
\ null, the <code>DataSourceParameters</code> originally used with these\n\
\ <code>Credentials</code> is automatically allowed.</p>"
items:
description: "<p>The parameters that Amazon QuickSight uses to connect to\
\ your underlying data source.\n This is a variant type structure.\
\ For this structure to be valid, only one of the\n attributes\
\ can be non-null.</p>"
properties:
AmazonElasticsearchParameters:
description: <p>Amazon Elasticsearch Service parameters.</p>
properties:
Domain:
description: <p>The Amazon Elasticsearch Service domain.</p>
maxLength: 64
minLength: 1
type: string
required:
- Domain
type: object
AmazonOpenSearchParameters:
description: <p>Amazon OpenSearch Service parameters.</p>
properties:
Domain:
description: <p>The Amazon OpenSearch Service domain.</p>
maxLength: 64
minLength: 1
type: string
required:
- Domain
type: object
AthenaParameters:
description: <p>Amazon Athena parameters.</p>
properties:
WorkGroup:
description: <p>The workgroup that Amazon Athena uses.</p>
maxLength: 128
minLength: 1
type: string
type: object
AuroraParameters:
description: <p>Amazon Aurora parameters.</p>
properties:
Database:
description: <p>Database.</p>
maxLength: 128
minLength: 1
type: string
Host:
description: <p>Host.</p>
maxLength: 256
minLength: 1
type: string
Port:
description: <p>Port.</p>
maximum: 65535
minimum: 1
type: number
required:
- Database
- Host
- Port
type: object
AuroraPostgreSqlParameters:
description: <p>Amazon Aurora with PostgreSQL compatibility parameters.</p>
properties:
Database:
description: <p>Database.</p>
maxLength: 128
minLength: 1
type: string
Host:
description: <p>Host.</p>
maxLength: 256
minLength: 1
type: string
Port:
description: <p>Port.</p>
maximum: 65535
minimum: 1
type: number
required:
- Database
- Host
- Port
type: object
MariaDbParameters:
description: <p>MariaDB parameters.</p>
properties:
Database:
description: <p>Database.</p>
maxLength: 128
minLength: 1
type: string
Host:
description: <p>Host.</p>
maxLength: 256
minLength: 1
type: string
Port:
description: <p>Port.</p>
maximum: 65535
minimum: 1
type: number
required:
- Database
- Host
- Port
type: object
MySqlParameters:
description: <p>MySQL parameters.</p>
properties:
Database:
description: <p>Database.</p>
maxLength: 128
minLength: 1
type: string
Host:
description: <p>Host.</p>
maxLength: 256
minLength: 1
type: string
Port:
description: <p>Port.</p>
maximum: 65535
minimum: 1
type: number
required:
- Database
- Host
- Port
type: object
OracleParameters:
properties:
Database:
maxLength: 128
minLength: 1
type: string
Host:
maxLength: 256
minLength: 1
type: string
Port:
maximum: 65535
minimum: 1
type: number
required:
- Database
- Host
- Port
type: object
PostgreSqlParameters:
description: <p>PostgreSQL parameters.</p>
properties:
Database:
description: <p>Database.</p>
maxLength: 128
minLength: 1
type: string
Host:
description: <p>Host.</p>
maxLength: 256
minLength: 1
type: string
Port:
description: <p>Port.</p>
maximum: 65535
minimum: 1
type: number
required:
- Database
- Host
- Port
type: object
PrestoParameters:
description: <p>Presto parameters.</p>
properties:
Catalog:
description: <p>Catalog.</p>
maxLength: 128
minLength: 0
type: string
Host:
description: <p>Host.</p>
maxLength: 256
minLength: 1
type: string
Port:
description: <p>Port.</p>
maximum: 65535
minimum: 1
type: number
required:
- Catalog
- Host
- Port
type: object
RdsParameters:
description: <p>Amazon RDS parameters.</p>
properties:
Database:
description: <p>Database.</p>
maxLength: 128
minLength: 1
type: string
InstanceId:
description: <p>Instance ID.</p>
maxLength: 64
minLength: 1
type: string
required:
- Database
- InstanceId
type: object
RedshiftParameters:
description: "<p>Amazon Redshift parameters. The <code>ClusterId</code>\
\ field can be blank if\n <code>Host</code> and <code>Port</code>\
\ are both set. The <code>Host</code> and\n <code>Port</code>\
\ fields can be blank if the <code>ClusterId</code> field is set.</p>"
properties:
ClusterId:
description: "<p>Cluster ID. This field can be blank if the <code>Host</code>\
\ and <code>Port</code> are\n provided.</p>"
maxLength: 64
minLength: 1
type: string
Database:
description: <p>Database.</p>
maxLength: 128
minLength: 1
type: string
Host:
description: <p>Host. This field can be blank if <code>ClusterId</code>
is provided.</p>
maxLength: 256
minLength: 1
type: string
Port:
description: <p>Port. This field can be blank if the <code>ClusterId</code>
is provided.</p>
maximum: 65535
minimum: 0
type: number
required:
- Database
type: object
S3Parameters:
description: <p>S3 parameters.</p>
properties:
ManifestFileLocation:
description: <p>Amazon S3 manifest file location.</p>
properties:
Bucket:
description: <p>Amazon S3 bucket.</p>
maxLength: 1024
minLength: 1
type: string
Key:
description: <p>Amazon S3 key that identifies an object.</p>
maxLength: 1024
minLength: 1
type: string
required:
- Bucket
- Key
type: object
required:
- ManifestFileLocation
type: object
SnowflakeParameters:
description: <p>Snowflake parameters.</p>
properties:
Database:
description: <p>Database.</p>
maxLength: 128
minLength: 1
type: string
Host:
description: <p>Host.</p>
maxLength: 256
minLength: 1
type: string
Warehouse:
description: <p>Warehouse.</p>
maxLength: 128
minLength: 0
type: string
required:
- Database
- Host
- Warehouse
type: object
SparkParameters:
description: <p>Spark parameters.</p>
properties:
Host:
description: <p>Host.</p>
maxLength: 256
minLength: 1
type: string
Port:
description: <p>Port.</p>
maximum: 65535
minimum: 1
type: number
required:
- Host
- Port
type: object
SqlServerParameters:
description: <p>SQL Server parameters.</p>
properties:
Database:
description: <p>Database.</p>
maxLength: 128
minLength: 1
type: string
Host:
description: <p>Host.</p>
maxLength: 256
minLength: 1
type: string
Port:
description: <p>Port.</p>
maximum: 65535
minimum: 1
type: number
required:
- Database
- Host
- Port
type: object
TeradataParameters:
description: <p>Teradata parameters.</p>
properties:
Database:
description: <p>Database.</p>
maxLength: 128
minLength: 1
type: string
Host:
description: <p>Host.</p>
maxLength: 256
minLength: 1
type: string
Port:
description: <p>Port.</p>
maximum: 65535
minimum: 1
type: number
required:
- Database
- Host
- Port
type: object
type: object
maxItems: 50
minItems: 1
type: array
Password:
description: <p>Password.</p>
maxLength: 1024
minLength: 1
type: string
Username:
description: <p>User name.</p>
maxLength: 64
minLength: 1
type: string
required:
- Password
- Username
type: object
DataSourceCredentials:
description: "<p>Data source credentials. This is a variant type structure. For\
\ this structure to be\n valid, only one of the attributes can be\
\ non-null.</p>"
properties:
CopySourceArn:
description: "<p>The Amazon Resource Name (ARN) of a data source that has\
\ the credential pair that you\n want to use. When <code>CopySourceArn</code>\
\ is not null, the credential pair from the\n data source in\
\ the ARN is used as the credentials for the\n <code>DataSourceCredentials</code>\
\ structure.</p>"
pattern: ^arn:[-a-z0-9]*:quicksight:[-a-z0-9]*:[0-9]{12}:datasource/.+
type: string
CredentialPair:
description: <p>The combination of user name and password that are used as
credentials.</p>
properties:
AlternateDataSourceParameters:
description: "<p>A set of alternate data source parameters that you want\
\ to share for these\n credentials. The credentials are applied\
\ in tandem with the data source parameters when\n you copy\
\ a data source by using a create or update request. The API operation\
\ compares\n the <code>DataSourceParameters</code> structure\
\ that's in the request with the\n structures in the <code>AlternateDataSourceParameters</code>\
\ allow list. If the\n structures are an exact match, the\
\ request is allowed to use the new data source with\n the\
\ existing credentials. If the <code>AlternateDataSourceParameters</code>\
\ list is\n null, the <code>DataSourceParameters</code> originally\
\ used with these\n <code>Credentials</code> is automatically\
\ allowed.</p>"
items:
description: "<p>The parameters that Amazon QuickSight uses to connect\
\ to your underlying data source.\n This is a variant type\
\ structure. For this structure to be valid, only one of the\n \
\ attributes can be non-null.</p>"
properties:
AmazonElasticsearchParameters:
description: <p>Amazon Elasticsearch Service parameters.</p>
properties:
Domain:
description: <p>The Amazon Elasticsearch Service domain.</p>
maxLength: 64
minLength: 1
type: string
required:
- Domain
type: object
AmazonOpenSearchParameters:
description: <p>Amazon OpenSearch Service parameters.</p>
properties:
Domain:
description: <p>The Amazon OpenSearch Service domain.</p>
maxLength: 64
minLength: 1
type: string
required:
- Domain
type: object
AthenaParameters:
description: <p>Amazon Athena parameters.</p>
properties:
WorkGroup:
description: <p>The workgroup that Amazon Athena uses.</p>
maxLength: 128
minLength: 1
type: string
type: object
AuroraParameters:
description: <p>Amazon Aurora parameters.</p>
properties:
Database:
description: <p>Database.</p>
maxLength: 128
minLength: 1
type: string
Host:
description: <p>Host.</p>
maxLength: 256
minLength: 1
type: string
Port:
description: <p>Port.</p>
maximum: 65535
minimum: 1
type: number
required:
- Database
- Host
- Port
type: object
AuroraPostgreSqlParameters:
description: <p>Amazon Aurora with PostgreSQL compatibility parameters.</p>
properties:
Database:
description: <p>Database.</p>
maxLength: 128
minLength: 1
type: string
Host:
description: <p>Host.</p>
maxLength: 256
minLength: 1
type: string
Port:
description: <p>Port.</p>
maximum: 65535
minimum: 1
type: number
required:
- Database
- Host
- Port
type: object
MariaDbParameters:
description: <p>MariaDB parameters.</p>
properties:
Database:
description: <p>Database.</p>
maxLength: 128
minLength: 1
type: string
Host:
description: <p>Host.</p>
maxLength: 256
minLength: 1
type: string
Port:
description: <p>Port.</p>
maximum: 65535
minimum: 1
type: number
required:
- Database
- Host
- Port
type: object
MySqlParameters:
description: <p>MySQL parameters.</p>
properties:
Database:
description: <p>Database.</p>
maxLength: 128
minLength: 1
type: string
Host:
description: <p>Host.</p>
maxLength: 256
minLength: 1
type: string
Port:
description: <p>Port.</p>
maximum: 65535
minimum: 1
type: number
required:
- Database
- Host
- Port
type: object
OracleParameters:
properties:
Database:
maxLength: 128
minLength: 1
type: string
Host:
maxLength: 256
minLength: 1
type: string
Port:
maximum: 65535
minimum: 1
type: number
required:
- Database
- Host
- Port
type: object
PostgreSqlParameters:
description: <p>PostgreSQL parameters.</p>
properties:
Database:
description: <p>Database.</p>
maxLength: 128
minLength: 1
type: string
Host:
description: <p>Host.</p>
maxLength: 256
minLength: 1
type: string
Port:
description: <p>Port.</p>
maximum: 65535
minimum: 1
type: number
required:
- Database
- Host
- Port
type: object
PrestoParameters:
description: <p>Presto parameters.</p>
properties:
Catalog:
description: <p>Catalog.</p>
maxLength: 128
minLength: 0
type: string
Host:
description: <p>Host.</p>
maxLength: 256
minLength: 1
type: string
Port:
description: <p>Port.</p>
maximum: 65535
minimum: 1
type: number
required:
- Catalog
- Host
- Port
type: object
RdsParameters:
description: <p>Amazon RDS parameters.</p>
properties:
Database:
description: <p>Database.</p>
maxLength: 128
minLength: 1
type: string
InstanceId:
description: <p>Instance ID.</p>
maxLength: 64
minLength: 1
type: string
required:
- Database
- InstanceId
type: object
RedshiftParameters:
description: "<p>Amazon Redshift parameters. The <code>ClusterId</code>\
\ field can be blank if\n <code>Host</code> and <code>Port</code>\
\ are both set. The <code>Host</code> and\n <code>Port</code>\
\ fields can be blank if the <code>ClusterId</code> field is set.</p>"
properties:
ClusterId:
description: "<p>Cluster ID. This field can be blank if the\
\ <code>Host</code> and <code>Port</code> are\n \
\ provided.</p>"
maxLength: 64
minLength: 1
type: string
Database:
description: <p>Database.</p>
maxLength: 128
minLength: 1
type: string
Host:
description: <p>Host. This field can be blank if <code>ClusterId</code>
is provided.</p>
maxLength: 256
minLength: 1
type: string
Port:
description: <p>Port. This field can be blank if the <code>ClusterId</code>
is provided.</p>
maximum: 65535
minimum: 0
type: number
required:
- Database
type: object
S3Parameters:
description: <p>S3 parameters.</p>
properties:
ManifestFileLocation:
description: <p>Amazon S3 manifest file location.</p>
properties:
Bucket:
description: <p>Amazon S3 bucket.</p>
maxLength: 1024
minLength: 1
type: string
Key:
description: <p>Amazon S3 key that identifies an object.</p>
maxLength: 1024
minLength: 1
type: string
required:
- Bucket
- Key
type: object
required:
- ManifestFileLocation
type: object
SnowflakeParameters:
description: <p>Snowflake parameters.</p>
properties:
Database:
description: <p>Database.</p>
maxLength: 128
minLength: 1
type: string
Host:
description: <p>Host.</p>
maxLength: 256
minLength: 1
type: string
Warehouse:
description: <p>Warehouse.</p>
maxLength: 128
minLength: 0
type: string
required:
- Database
- Host
- Warehouse
type: object
SparkParameters:
description: <p>Spark parameters.</p>
properties:
Host:
description: <p>Host.</p>
maxLength: 256
minLength: 1
type: string
Port:
description: <p>Port.</p>
maximum: 65535
minimum: 1
type: number
required:
- Host
- Port
type: object
SqlServerParameters:
description: <p>SQL Server parameters.</p>
properties:
Database:
description: <p>Database.</p>
maxLength: 128
minLength: 1
type: string
Host:
description: <p>Host.</p>
maxLength: 256
minLength: 1
type: string
Port:
description: <p>Port.</p>
maximum: 65535
minimum: 1
type: number
required:
- Database
- Host
- Port
type: object
TeradataParameters:
description: <p>Teradata parameters.</p>
properties:
Database:
description: <p>Database.</p>
maxLength: 128
minLength: 1
type: string
Host:
description: <p>Host.</p>
maxLength: 256
minLength: 1
type: string
Port:
description: <p>Port.</p>
maximum: 65535
minimum: 1
type: number
required:
- Database
- Host
- Port
type: object
type: object
maxItems: 50
minItems: 1
type: array
Password:
description: <p>Password.</p>
maxLength: 1024
minLength: 1
type: string
Username:
description: <p>User name.</p>
maxLength: 64
minLength: 1
type: string
required:
- Password
- Username
type: object
type: object
DataSourceErrorInfo:
description: <p>Error information for the data source creation or update.</p>
properties:
Message:
description: <p>Error message.</p>
type: string
Type:
enum:
- ACCESS_DENIED
- COPY_SOURCE_NOT_FOUND
- TIMEOUT
- ENGINE_VERSION_NOT_SUPPORTED
- UNKNOWN_HOST
- GENERIC_SQL_FAILURE
- CONFLICT
- UNKNOWN
type: string
type: object
DataSourceErrorInfoType:
enum:
- ACCESS_DENIED
- COPY_SOURCE_NOT_FOUND
- TIMEOUT
- ENGINE_VERSION_NOT_SUPPORTED
- UNKNOWN_HOST
- GENERIC_SQL_FAILURE
- CONFLICT
- UNKNOWN
type: string
DataSourceParameters:
description: "<p>The parameters that Amazon QuickSight uses to connect to your\
\ underlying data source.\n This is a variant type structure. For\
\ this structure to be valid, only one of the\n attributes can be\
\ non-null.</p>"
properties:
AmazonElasticsearchParameters:
description: <p>Amazon Elasticsearch Service parameters.</p>
properties:
Domain:
description: <p>The Amazon Elasticsearch Service domain.</p>
maxLength: 64
minLength: 1
type: string
required:
- Domain
type: object
AmazonOpenSearchParameters:
description: <p>Amazon OpenSearch Service parameters.</p>
properties:
Domain:
description: <p>The Amazon OpenSearch Service domain.</p>
maxLength: 64
minLength: 1
type: string
required:
- Domain
type: object
AthenaParameters:
description: <p>Amazon Athena parameters.</p>
properties:
WorkGroup:
description: <p>The workgroup that Amazon Athena uses.</p>
maxLength: 128
minLength: 1
type: string
type: object
AuroraParameters:
description: <p>Amazon Aurora parameters.</p>
properties:
Database:
description: <p>Database.</p>
maxLength: 128
minLength: 1
type: string
Host:
description: <p>Host.</p>
maxLength: 256
minLength: 1
type: string
Port:
description: <p>Port.</p>
maximum: 65535
minimum: 1
type: number
required:
- Database
- Host
- Port
type: object
AuroraPostgreSqlParameters:
description: <p>Amazon Aurora with PostgreSQL compatibility parameters.</p>
properties:
Database:
description: <p>Database.</p>
maxLength: 128
minLength: 1
type: string
Host:
description: <p>Host.</p>
maxLength: 256
minLength: 1
type: string
Port:
description: <p>Port.</p>
maximum: 65535
minimum: 1
type: number
required:
- Database
- Host
- Port
type: object
MariaDbParameters:
description: <p>MariaDB parameters.</p>
properties:
Database:
description: <p>Database.</p>
maxLength: 128
minLength: 1
type: string
Host:
description: <p>Host.</p>
maxLength: 256
minLength: 1
type: string
Port:
description: <p>Port.</p>
maximum: 65535
minimum: 1
type: number
required:
- Database
- Host
- Port
type: object
MySqlParameters:
description: <p>MySQL parameters.</p>
properties:
Database:
description: <p>Database.</p>
maxLength: 128
minLength: 1
type: string
Host:
description: <p>Host.</p>
maxLength: 256
minLength: 1
type: string
Port:
description: <p>Port.</p>
maximum: 65535
minimum: 1
type: number
required:
- Database
- Host
- Port
type: object
OracleParameters:
properties:
Database:
maxLength: 128
minLength: 1
type: string
Host:
maxLength: 256
minLength: 1
type: string
Port:
maximum: 65535
minimum: 1
type: number
required:
- Database
- Host
- Port
type: object
PostgreSqlParameters:
description: <p>PostgreSQL parameters.</p>
properties:
Database:
description: <p>Database.</p>
maxLength: 128
minLength: 1
type: string
Host:
description: <p>Host.</p>
maxLength: 256
minLength: 1
type: string
Port:
description: <p>Port.</p>
maximum: 65535
minimum: 1
type: number
required:
- Database
- Host
- Port
type: object
PrestoParameters:
description: <p>Presto parameters.</p>
properties:
Catalog:
description: <p>Catalog.</p>
maxLength: 128
minLength: 0
type: string
Host:
description: <p>Host.</p>
maxLength: 256
minLength: 1
type: string
Port:
description: <p>Port.</p>
maximum: 65535
minimum: 1
type: number
required:
- Catalog
- Host
- Port
type: object
RdsParameters:
description: <p>Amazon RDS parameters.</p>
properties:
Database:
description: <p>Database.</p>
maxLength: 128
minLength: 1
type: string
InstanceId:
description: <p>Instance ID.</p>
maxLength: 64
minLength: 1
type: string
required:
- Database
- InstanceId
type: object
RedshiftParameters:
description: "<p>Amazon Redshift parameters. The <code>ClusterId</code> field\
\ can be blank if\n <code>Host</code> and <code>Port</code> are\
\ both set. The <code>Host</code> and\n <code>Port</code> fields\
\ can be blank if the <code>ClusterId</code> field is set.</p>"
properties:
ClusterId:
description: "<p>Cluster ID. This field can be blank if the <code>Host</code>\
\ and <code>Port</code> are\n provided.</p>"
maxLength: 64
minLength: 1
type: string
Database:
description: <p>Database.</p>
maxLength: 128
minLength: 1
type: string
Host:
description: <p>Host. This field can be blank if <code>ClusterId</code>
is provided.</p>
maxLength: 256
minLength: 1
type: string
Port:
description: <p>Port. This field can be blank if the <code>ClusterId</code>
is provided.</p>
maximum: 65535
minimum: 0
type: number
required:
- Database
type: object
S3Parameters:
description: <p>S3 parameters.</p>
properties:
ManifestFileLocation:
description: <p>Amazon S3 manifest file location.</p>
properties:
Bucket:
description: <p>Amazon S3 bucket.</p>
maxLength: 1024
minLength: 1
type: string
Key:
description: <p>Amazon S3 key that identifies an object.</p>
maxLength: 1024
minLength: 1
type: string
required:
- Bucket
- Key
type: object
required:
- ManifestFileLocation
type: object
SnowflakeParameters:
description: <p>Snowflake parameters.</p>
properties:
Database:
description: <p>Database.</p>
maxLength: 128
minLength: 1
type: string
Host:
description: <p>Host.</p>
maxLength: 256
minLength: 1
type: string
Warehouse:
description: <p>Warehouse.</p>
maxLength: 128
minLength: 0
type: string
required:
- Database
- Host
- Warehouse
type: object
SparkParameters:
description: <p>Spark parameters.</p>
properties:
Host:
description: <p>Host.</p>
maxLength: 256
minLength: 1
type: string
Port:
description: <p>Port.</p>
maximum: 65535
minimum: 1
type: number
required:
- Host
- Port
type: object
SqlServerParameters:
description: <p>SQL Server parameters.</p>
properties:
Database:
description: <p>Database.</p>
maxLength: 128
minLength: 1
type: string
Host:
description: <p>Host.</p>
maxLength: 256
minLength: 1
type: string
Port:
description: <p>Port.</p>
maximum: 65535
minimum: 1
type: number
required:
- Database
- Host
- Port
type: object
TeradataParameters:
description: <p>Teradata parameters.</p>
properties:
Database:
description: <p>Database.</p>
maxLength: 128
minLength: 1
type: string
Host:
description: <p>Host.</p>
maxLength: 256
minLength: 1
type: string
Port:
description: <p>Port.</p>
maximum: 65535
minimum: 1
type: number
required:
- Database
- Host
- Port
type: object
type: object
DataSourceType:
enum:
- ADOBE_ANALYTICS
- AMAZON_ELASTICSEARCH
- AMAZON_OPENSEARCH
- ATHENA
- AURORA
- AURORA_POSTGRESQL
- AWS_IOT_ANALYTICS
- GITHUB
- JIRA
- MARIADB
- MYSQL
- ORACLE
- POSTGRESQL
- PRESTO
- REDSHIFT
- S3
- SALESFORCE
- SERVICENOW
- SNOWFLAKE
- SPARK
- SQLSERVER
- TERADATA
- TWITTER
- TIMESTREAM
type: string
ManifestFileLocation:
description: <p>Amazon S3 manifest file location.</p>
properties:
Bucket:
description: <p>Amazon S3 bucket.</p>
maxLength: 1024
minLength: 1
type: string
Key:
description: <p>Amazon S3 key that identifies an object.</p>
maxLength: 1024
minLength: 1
type: string
required:
- Bucket
- Key
type: object
MariaDbParameters:
description: <p>MariaDB parameters.</p>
properties:
Database:
description: <p>Database.</p>
maxLength: 128
minLength: 1
type: string
Host:
description: <p>Host.</p>
maxLength: 256
minLength: 1
type: string
Port:
description: <p>Port.</p>
maximum: 65535
minimum: 1
type: number
required:
- Database
- Host
- Port
type: object
MySqlParameters:
description: <p>MySQL parameters.</p>
properties:
Database:
description: <p>Database.</p>
maxLength: 128
minLength: 1
type: string
Host:
description: <p>Host.</p>
maxLength: 256
minLength: 1
type: string
Port:
description: <p>Port.</p>
maximum: 65535
minimum: 1
type: number
required:
- Database
- Host
- Port
type: object
OracleParameters:
properties:
Database:
maxLength: 128
minLength: 1
type: string
Host:
maxLength: 256
minLength: 1
type: string
Port:
maximum: 65535
minimum: 1
type: number
required:
- Database
- Host
- Port
type: object
PostgreSqlParameters:
description: <p>PostgreSQL parameters.</p>
properties:
Database:
description: <p>Database.</p>
maxLength: 128
minLength: 1
type: string
Host:
description: <p>Host.</p>
maxLength: 256
minLength: 1
type: string
Port:
description: <p>Port.</p>
maximum: 65535
minimum: 1
type: number
required:
- Database
- Host
- Port
type: object
PrestoParameters:
description: <p>Presto parameters.</p>
properties:
Catalog:
description: <p>Catalog.</p>
maxLength: 128
minLength: 0
type: string
Host:
description: <p>Host.</p>
maxLength: 256
minLength: 1
type: string
Port:
description: <p>Port.</p>
maximum: 65535
minimum: 1
type: number
required:
- Catalog
- Host
- Port
type: object
RdsParameters:
description: <p>Amazon RDS parameters.</p>
properties:
Database:
description: <p>Database.</p>
maxLength: 128
minLength: 1
type: string
InstanceId:
description: <p>Instance ID.</p>
maxLength: 64
minLength: 1
type: string
required:
- Database
- InstanceId
type: object
RedshiftParameters:
description: "<p>Amazon Redshift parameters. The <code>ClusterId</code> field\
\ can be blank if\n <code>Host</code> and <code>Port</code> are both\
\ set. The <code>Host</code> and\n <code>Port</code> fields can be\
\ blank if the <code>ClusterId</code> field is set.</p>"
properties:
ClusterId:
description: "<p>Cluster ID. This field can be blank if the <code>Host</code>\
\ and <code>Port</code> are\n provided.</p>"
maxLength: 64
minLength: 1
type: string
Database:
description: <p>Database.</p>
maxLength: 128
minLength: 1
type: string
Host:
description: <p>Host. This field can be blank if <code>ClusterId</code> is
provided.</p>
maxLength: 256
minLength: 1
type: string
Port:
description: <p>Port. This field can be blank if the <code>ClusterId</code>
is provided.</p>
maximum: 65535
minimum: 0
type: number
required:
- Database
type: object
ResourcePermission:
description: <p>Permission for the resource.</p>
properties:
Actions:
description: <p>The IAM action to grant or revoke permissions on.</p>
items:
type: string
maxItems: 16
minItems: 1
type: array
Principal:
description: "<p>The Amazon Resource Name (ARN) of the principal. This can\
\ be one of the\n following:</p>\n <ul>\n <li>\n\
\ <p>The ARN of an Amazon QuickSight user or group associated\
\ with a data source or dataset. (This is common.)</p>\n </li>\n\
\ <li>\n <p>The ARN of an Amazon QuickSight user,\
\ group, or namespace associated with an analysis, dashboard, template,\
\ or theme. (This is common.)</p>\n </li>\n <li>\n\
\ <p>The ARN of an AWS account root: This is an IAM ARN rather\
\ than a QuickSight\n ARN. Use this option only to share\
\ resources (templates) across AWS accounts.\n (This\
\ is less common.) </p>\n </li>\n </ul>"
maxLength: 256
minLength: 1
type: string
required:
- Actions
- Principal
type: object
ResourceStatus:
enum:
- CREATION_IN_PROGRESS
- CREATION_SUCCESSFUL
- CREATION_FAILED
- UPDATE_IN_PROGRESS
- UPDATE_SUCCESSFUL
- UPDATE_FAILED
- DELETED
type: string
S3Parameters:
description: <p>S3 parameters.</p>
properties:
ManifestFileLocation:
description: <p>Amazon S3 manifest file location.</p>
properties:
Bucket:
description: <p>Amazon S3 bucket.</p>
maxLength: 1024
minLength: 1
type: string
Key:
description: <p>Amazon S3 key that identifies an object.</p>
maxLength: 1024
minLength: 1
type: string
required:
- Bucket
- Key
type: object
required:
- ManifestFileLocation
type: object
SnowflakeParameters:
description: <p>Snowflake parameters.</p>
properties:
Database:
description: <p>Database.</p>
maxLength: 128
minLength: 1
type: string
Host:
description: <p>Host.</p>
maxLength: 256
minLength: 1
type: string
Warehouse:
description: <p>Warehouse.</p>
maxLength: 128
minLength: 0
type: string
required:
- Database
- Host
- Warehouse
type: object
SparkParameters:
description: <p>Spark parameters.</p>
properties:
Host:
description: <p>Host.</p>
maxLength: 256
minLength: 1
type: string
Port:
description: <p>Port.</p>
maximum: 65535
minimum: 1
type: number
required:
- Host
- Port
type: object
SqlServerParameters:
description: <p>SQL Server parameters.</p>
properties:
Database:
description: <p>Database.</p>
maxLength: 128
minLength: 1
type: string
Host:
description: <p>Host.</p>
maxLength: 256
minLength: 1
type: string
Port:
description: <p>Port.</p>
maximum: 65535
minimum: 1
type: number
required:
- Database
- Host
- Port
type: object
SslProperties:
description: "<p>Secure Socket Layer (SSL) properties that apply when QuickSight\
\ connects to your\n underlying data source.</p>"
properties:
DisableSsl:
description: <p>A Boolean option to control whether SSL should be disabled.</p>
type: boolean
type: object
Tag:
description: "<p>The key or keys of the key-value pairs for the resource tag or\
\ tags assigned to the\n resource.</p>"
properties:
Key:
description: <p>Tag key.</p>
maxLength: 128
minLength: 1
type: string
Value:
description: <p>Tag value.</p>
maxLength: 256
minLength: 1
type: string
required:
- Key
- Value
type: object
TeradataParameters:
description: <p>Teradata parameters.</p>
properties:
Database:
description: <p>Database.</p>
maxLength: 128
minLength: 1
type: string
Host:
description: <p>Host.</p>
maxLength: 256
minLength: 1
type: string
Port:
description: <p>Port.</p>
maximum: 65535
minimum: 1
type: number
required:
- Database
- Host
- Port
type: object
VpcConnectionProperties:
description: <p>VPC connection properties.</p>
properties:
VpcConnectionArn:
description: <p>The Amazon Resource Name (ARN) for the VPC connection.</p>
type: string
required:
- VpcConnectionArn
type: object
properties:
AlternateDataSourceParameters:
description: "<p>A set of alternate data source parameters that you want to share\
\ for the credentials\n stored with this data source. The credentials\
\ are applied in tandem with the data source\n parameters when you\
\ copy a data source by using a create or update request. The API\n \
\ operation compares the <code>DataSourceParameters</code> structure that's\
\ in the request\n with the structures in the <code>AlternateDataSourceParameters</code>\
\ allow list. If the\n structures are an exact match, the request\
\ is allowed to use the credentials from this\n existing data source.\
\ If the <code>AlternateDataSourceParameters</code> list is null,\n \
\ the <code>Credentials</code> originally used with this <code>DataSourceParameters</code>\n\
\ are automatically allowed.</p>"
items:
description: "<p>The parameters that Amazon QuickSight uses to connect to your\
\ underlying data source.\n This is a variant type structure. For\
\ this structure to be valid, only one of the\n attributes can\
\ be non-null.</p>"
properties:
AmazonElasticsearchParameters:
description: <p>Amazon Elasticsearch Service parameters.</p>
properties:
Domain:
description: <p>The Amazon Elasticsearch Service domain.</p>
maxLength: 64
minLength: 1
type: string
required:
- Domain
type: object
AmazonOpenSearchParameters:
description: <p>Amazon OpenSearch Service parameters.</p>
properties:
Domain:
description: <p>The Amazon OpenSearch Service domain.</p>
maxLength: 64
minLength: 1
type: string
required:
- Domain
type: object
AthenaParameters:
description: <p>Amazon Athena parameters.</p>
properties:
WorkGroup:
description: <p>The workgroup that Amazon Athena uses.</p>
maxLength: 128
minLength: 1
type: string
type: object
AuroraParameters:
description: <p>Amazon Aurora parameters.</p>
properties:
Database:
description: <p>Database.</p>
maxLength: 128
minLength: 1
type: string
Host:
description: <p>Host.</p>
maxLength: 256
minLength: 1
type: string
Port:
description: <p>Port.</p>
maximum: 65535
minimum: 1
type: number
required:
- Database
- Host
- Port
type: object
AuroraPostgreSqlParameters:
description: <p>Amazon Aurora with PostgreSQL compatibility parameters.</p>
properties:
Database:
description: <p>Database.</p>
maxLength: 128
minLength: 1
type: string
Host:
description: <p>Host.</p>
maxLength: 256
minLength: 1
type: string
Port:
description: <p>Port.</p>
maximum: 65535
minimum: 1
type: number
required:
- Database
- Host
- Port
type: object
MariaDbParameters:
description: <p>MariaDB parameters.</p>
properties:
Database:
description: <p>Database.</p>
maxLength: 128
minLength: 1
type: string
Host:
description: <p>Host.</p>
maxLength: 256
minLength: 1
type: string
Port:
description: <p>Port.</p>
maximum: 65535
minimum: 1
type: number
required:
- Database
- Host
- Port
type: object
MySqlParameters:
description: <p>MySQL parameters.</p>
properties:
Database:
description: <p>Database.</p>
maxLength: 128
minLength: 1
type: string
Host:
description: <p>Host.</p>
maxLength: 256
minLength: 1
type: string
Port:
description: <p>Port.</p>
maximum: 65535
minimum: 1
type: number
required:
- Database
- Host
- Port
type: object
OracleParameters:
properties:
Database:
maxLength: 128
minLength: 1
type: string
Host:
maxLength: 256
minLength: 1
type: string
Port:
maximum: 65535
minimum: 1
type: number
required:
- Database
- Host
- Port
type: object
PostgreSqlParameters:
description: <p>PostgreSQL parameters.</p>
properties:
Database:
description: <p>Database.</p>
maxLength: 128
minLength: 1
type: string
Host:
description: <p>Host.</p>
maxLength: 256
minLength: 1
type: string
Port:
description: <p>Port.</p>
maximum: 65535
minimum: 1
type: number
required:
- Database
- Host
- Port
type: object
PrestoParameters:
description: <p>Presto parameters.</p>
properties:
Catalog:
description: <p>Catalog.</p>
maxLength: 128
minLength: 0
type: string
Host:
description: <p>Host.</p>
maxLength: 256
minLength: 1
type: string
Port:
description: <p>Port.</p>
maximum: 65535
minimum: 1
type: number
required:
- Catalog
- Host
- Port
type: object
RdsParameters:
description: <p>Amazon RDS parameters.</p>
properties:
Database:
description: <p>Database.</p>
maxLength: 128
minLength: 1
type: string
InstanceId:
description: <p>Instance ID.</p>
maxLength: 64
minLength: 1
type: string
required:
- Database
- InstanceId
type: object
RedshiftParameters:
description: "<p>Amazon Redshift parameters. The <code>ClusterId</code>\
\ field can be blank if\n <code>Host</code> and <code>Port</code>\
\ are both set. The <code>Host</code> and\n <code>Port</code>\
\ fields can be blank if the <code>ClusterId</code> field is set.</p>"
properties:
ClusterId:
description: "<p>Cluster ID. This field can be blank if the <code>Host</code>\
\ and <code>Port</code> are\n provided.</p>"
maxLength: 64
minLength: 1
type: string
Database:
description: <p>Database.</p>
maxLength: 128
minLength: 1
type: string
Host:
description: <p>Host. This field can be blank if <code>ClusterId</code>
is provided.</p>
maxLength: 256
minLength: 1
type: string
Port:
description: <p>Port. This field can be blank if the <code>ClusterId</code>
is provided.</p>
maximum: 65535
minimum: 0
type: number
required:
- Database
type: object
S3Parameters:
description: <p>S3 parameters.</p>
properties:
ManifestFileLocation:
description: <p>Amazon S3 manifest file location.</p>
properties:
Bucket:
description: <p>Amazon S3 bucket.</p>
maxLength: 1024
minLength: 1
type: string
Key:
description: <p>Amazon S3 key that identifies an object.</p>
maxLength: 1024
minLength: 1
type: string
required:
- Bucket
- Key
type: object
required:
- ManifestFileLocation
type: object
SnowflakeParameters:
description: <p>Snowflake parameters.</p>
properties:
Database:
description: <p>Database.</p>
maxLength: 128
minLength: 1
type: string
Host:
description: <p>Host.</p>
maxLength: 256
minLength: 1
type: string
Warehouse:
description: <p>Warehouse.</p>
maxLength: 128
minLength: 0
type: string
required:
- Database
- Host
- Warehouse
type: object
SparkParameters:
description: <p>Spark parameters.</p>
properties:
Host:
description: <p>Host.</p>
maxLength: 256
minLength: 1
type: string
Port:
description: <p>Port.</p>
maximum: 65535
minimum: 1
type: number
required:
- Host
- Port
type: object
SqlServerParameters:
description: <p>SQL Server parameters.</p>
properties:
Database:
description: <p>Database.</p>
maxLength: 128
minLength: 1
type: string
Host:
description: <p>Host.</p>
maxLength: 256
minLength: 1
type: string
Port:
description: <p>Port.</p>
maximum: 65535
minimum: 1
type: number
required:
- Database
- Host
- Port
type: object
TeradataParameters:
description: <p>Teradata parameters.</p>
properties:
Database:
description: <p>Database.</p>
maxLength: 128
minLength: 1
type: string
Host:
description: <p>Host.</p>
maxLength: 256
minLength: 1
type: string
Port:
description: <p>Port.</p>
maximum: 65535
minimum: 1
type: number
required:
- Database
- Host
- Port
type: object
type: object
maxItems: 50
minItems: 1
type: array
Credentials:
description: "<p>Data source credentials. This is a variant type structure. For\
\ this structure to be\n valid, only one of the attributes can be\
\ non-null.</p>"
properties:
CopySourceArn:
description: "<p>The Amazon Resource Name (ARN) of a data source that has\
\ the credential pair that you\n want to use. When <code>CopySourceArn</code>\
\ is not null, the credential pair from the\n data source in\
\ the ARN is used as the credentials for the\n <code>DataSourceCredentials</code>\
\ structure.</p>"
pattern: ^arn:[-a-z0-9]*:quicksight:[-a-z0-9]*:[0-9]{12}:datasource/.+
type: string
CredentialPair:
description: <p>The combination of user name and password that are used as
credentials.</p>
properties:
AlternateDataSourceParameters:
description: "<p>A set of alternate data source parameters that you want\
\ to share for these\n credentials. The credentials are applied\
\ in tandem with the data source parameters when\n you copy\
\ a data source by using a create or update request. The API operation\
\ compares\n the <code>DataSourceParameters</code> structure\
\ that's in the request with the\n structures in the <code>AlternateDataSourceParameters</code>\
\ allow list. If the\n structures are an exact match, the\
\ request is allowed to use the new data source with\n the\
\ existing credentials. If the <code>AlternateDataSourceParameters</code>\
\ list is\n null, the <code>DataSourceParameters</code> originally\
\ used with these\n <code>Credentials</code> is automatically\
\ allowed.</p>"
items:
description: "<p>The parameters that Amazon QuickSight uses to connect\
\ to your underlying data source.\n This is a variant type\
\ structure. For this structure to be valid, only one of the\n \
\ attributes can be non-null.</p>"
properties:
AmazonElasticsearchParameters:
description: <p>Amazon Elasticsearch Service parameters.</p>
properties:
Domain:
description: <p>The Amazon Elasticsearch Service domain.</p>
maxLength: 64
minLength: 1
type: string
required:
- Domain
type: object
AmazonOpenSearchParameters:
description: <p>Amazon OpenSearch Service parameters.</p>
properties:
Domain:
description: <p>The Amazon OpenSearch Service domain.</p>
maxLength: 64
minLength: 1
type: string
required:
- Domain
type: object
AthenaParameters:
description: <p>Amazon Athena parameters.</p>
properties:
WorkGroup:
description: <p>The workgroup that Amazon Athena uses.</p>
maxLength: 128
minLength: 1
type: string
type: object
AuroraParameters:
description: <p>Amazon Aurora parameters.</p>
properties:
Database:
description: <p>Database.</p>
maxLength: 128
minLength: 1
type: string
Host:
description: <p>Host.</p>
maxLength: 256
minLength: 1
type: string
Port:
description: <p>Port.</p>
maximum: 65535
minimum: 1
type: number
required:
- Database
- Host
- Port
type: object
AuroraPostgreSqlParameters:
description: <p>Amazon Aurora with PostgreSQL compatibility parameters.</p>
properties:
Database:
description: <p>Database.</p>
maxLength: 128
minLength: 1
type: string
Host:
description: <p>Host.</p>
maxLength: 256
minLength: 1
type: string
Port:
description: <p>Port.</p>
maximum: 65535
minimum: 1
type: number
required:
- Database
- Host
- Port
type: object
MariaDbParameters:
description: <p>MariaDB parameters.</p>
properties:
Database:
description: <p>Database.</p>
maxLength: 128
minLength: 1
type: string
Host:
description: <p>Host.</p>
maxLength: 256
minLength: 1
type: string
Port:
description: <p>Port.</p>
maximum: 65535
minimum: 1
type: number
required:
- Database
- Host
- Port
type: object
MySqlParameters:
description: <p>MySQL parameters.</p>
properties:
Database:
description: <p>Database.</p>
maxLength: 128
minLength: 1
type: string
Host:
description: <p>Host.</p>
maxLength: 256
minLength: 1
type: string
Port:
description: <p>Port.</p>
maximum: 65535
minimum: 1
type: number
required:
- Database
- Host
- Port
type: object
OracleParameters:
properties:
Database:
maxLength: 128
minLength: 1
type: string
Host:
maxLength: 256
minLength: 1
type: string
Port:
maximum: 65535
minimum: 1
type: number
required:
- Database
- Host
- Port
type: object
PostgreSqlParameters:
description: <p>PostgreSQL parameters.</p>
properties:
Database:
description: <p>Database.</p>
maxLength: 128
minLength: 1
type: string
Host:
description: <p>Host.</p>
maxLength: 256
minLength: 1
type: string
Port:
description: <p>Port.</p>
maximum: 65535
minimum: 1
type: number
required:
- Database
- Host
- Port
type: object
PrestoParameters:
description: <p>Presto parameters.</p>
properties:
Catalog:
description: <p>Catalog.</p>
maxLength: 128
minLength: 0
type: string
Host:
description: <p>Host.</p>
maxLength: 256
minLength: 1
type: string
Port:
description: <p>Port.</p>
maximum: 65535
minimum: 1
type: number
required:
- Catalog
- Host
- Port
type: object
RdsParameters:
description: <p>Amazon RDS parameters.</p>
properties:
Database:
description: <p>Database.</p>
maxLength: 128
minLength: 1
type: string
InstanceId:
description: <p>Instance ID.</p>
maxLength: 64
minLength: 1
type: string
required:
- Database
- InstanceId
type: object
RedshiftParameters:
description: "<p>Amazon Redshift parameters. The <code>ClusterId</code>\
\ field can be blank if\n <code>Host</code> and <code>Port</code>\
\ are both set. The <code>Host</code> and\n <code>Port</code>\
\ fields can be blank if the <code>ClusterId</code> field is set.</p>"
properties:
ClusterId:
description: "<p>Cluster ID. This field can be blank if the\
\ <code>Host</code> and <code>Port</code> are\n \
\ provided.</p>"
maxLength: 64
minLength: 1
type: string
Database:
description: <p>Database.</p>
maxLength: 128
minLength: 1
type: string
Host:
description: <p>Host. This field can be blank if <code>ClusterId</code>
is provided.</p>
maxLength: 256
minLength: 1
type: string
Port:
description: <p>Port. This field can be blank if the <code>ClusterId</code>
is provided.</p>
maximum: 65535
minimum: 0
type: number
required:
- Database
type: object
S3Parameters:
description: <p>S3 parameters.</p>
properties:
ManifestFileLocation:
description: <p>Amazon S3 manifest file location.</p>
properties:
Bucket:
description: <p>Amazon S3 bucket.</p>
maxLength: 1024
minLength: 1
type: string
Key:
description: <p>Amazon S3 key that identifies an object.</p>
maxLength: 1024
minLength: 1
type: string
required:
- Bucket
- Key
type: object
required:
- ManifestFileLocation
type: object
SnowflakeParameters:
description: <p>Snowflake parameters.</p>
properties:
Database:
description: <p>Database.</p>
maxLength: 128
minLength: 1
type: string
Host:
description: <p>Host.</p>
maxLength: 256
minLength: 1
type: string
Warehouse:
description: <p>Warehouse.</p>
maxLength: 128
minLength: 0
type: string
required:
- Database
- Host
- Warehouse
type: object
SparkParameters:
description: <p>Spark parameters.</p>
properties:
Host:
description: <p>Host.</p>
maxLength: 256
minLength: 1
type: string
Port:
description: <p>Port.</p>
maximum: 65535
minimum: 1
type: number
required:
- Host
- Port
type: object
SqlServerParameters:
description: <p>SQL Server parameters.</p>
properties:
Database:
description: <p>Database.</p>
maxLength: 128
minLength: 1
type: string
Host:
description: <p>Host.</p>
maxLength: 256
minLength: 1
type: string
Port:
description: <p>Port.</p>
maximum: 65535
minimum: 1
type: number
required:
- Database
- Host
- Port
type: object
TeradataParameters:
description: <p>Teradata parameters.</p>
properties:
Database:
description: <p>Database.</p>
maxLength: 128
minLength: 1
type: string
Host:
description: <p>Host.</p>
maxLength: 256
minLength: 1
type: string
Port:
description: <p>Port.</p>
maximum: 65535
minimum: 1
type: number
required:
- Database
- Host
- Port
type: object
type: object
maxItems: 50
minItems: 1
type: array
Password:
description: <p>Password.</p>
maxLength: 1024
minLength: 1
type: string
Username:
description: <p>User name.</p>
maxLength: 64
minLength: 1
type: string
required:
- Password
- Username
type: object
type: object
DataSourceParameters:
description: "<p>The parameters that Amazon QuickSight uses to connect to your\
\ underlying data source.\n This is a variant type structure. For\
\ this structure to be valid, only one of the\n attributes can be\
\ non-null.</p>"
properties:
AmazonElasticsearchParameters:
description: <p>Amazon Elasticsearch Service parameters.</p>
properties:
Domain:
description: <p>The Amazon Elasticsearch Service domain.</p>
maxLength: 64
minLength: 1
type: string
required:
- Domain
type: object
AmazonOpenSearchParameters:
description: <p>Amazon OpenSearch Service parameters.</p>
properties:
Domain:
description: <p>The Amazon OpenSearch Service domain.</p>
maxLength: 64
minLength: 1
type: string
required:
- Domain
type: object
AthenaParameters:
description: <p>Amazon Athena parameters.</p>
properties:
WorkGroup:
description: <p>The workgroup that Amazon Athena uses.</p>
maxLength: 128
minLength: 1
type: string
type: object
AuroraParameters:
description: <p>Amazon Aurora parameters.</p>
properties:
Database:
description: <p>Database.</p>
maxLength: 128
minLength: 1
type: string
Host:
description: <p>Host.</p>
maxLength: 256
minLength: 1
type: string
Port:
description: <p>Port.</p>
maximum: 65535
minimum: 1
type: number
required:
- Database
- Host
- Port
type: object
AuroraPostgreSqlParameters:
description: <p>Amazon Aurora with PostgreSQL compatibility parameters.</p>
properties:
Database:
description: <p>Database.</p>
maxLength: 128
minLength: 1
type: string
Host:
description: <p>Host.</p>
maxLength: 256
minLength: 1
type: string
Port:
description: <p>Port.</p>
maximum: 65535
minimum: 1
type: number
required:
- Database
- Host
- Port
type: object
MariaDbParameters:
description: <p>MariaDB parameters.</p>
properties:
Database:
description: <p>Database.</p>
maxLength: 128
minLength: 1
type: string
Host:
description: <p>Host.</p>
maxLength: 256
minLength: 1
type: string
Port:
description: <p>Port.</p>
maximum: 65535
minimum: 1
type: number
required:
- Database
- Host
- Port
type: object
MySqlParameters:
description: <p>MySQL parameters.</p>
properties:
Database:
description: <p>Database.</p>
maxLength: 128
minLength: 1
type: string
Host:
description: <p>Host.</p>
maxLength: 256
minLength: 1
type: string
Port:
description: <p>Port.</p>
maximum: 65535
minimum: 1
type: number
required:
- Database
- Host
- Port
type: object
OracleParameters:
properties:
Database:
maxLength: 128
minLength: 1
type: string
Host:
maxLength: 256
minLength: 1
type: string
Port:
maximum: 65535
minimum: 1
type: number
required:
- Database
- Host
- Port
type: object
PostgreSqlParameters:
description: <p>PostgreSQL parameters.</p>
properties:
Database:
description: <p>Database.</p>
maxLength: 128
minLength: 1
type: string
Host:
description: <p>Host.</p>
maxLength: 256
minLength: 1
type: string
Port:
description: <p>Port.</p>
maximum: 65535
minimum: 1
type: number
required:
- Database
- Host
- Port
type: object
PrestoParameters:
description: <p>Presto parameters.</p>
properties:
Catalog:
description: <p>Catalog.</p>
maxLength: 128
minLength: 0
type: string
Host:
description: <p>Host.</p>
maxLength: 256
minLength: 1
type: string
Port:
description: <p>Port.</p>
maximum: 65535
minimum: 1
type: number
required:
- Catalog
- Host
- Port
type: object
RdsParameters:
description: <p>Amazon RDS parameters.</p>
properties:
Database:
description: <p>Database.</p>
maxLength: 128
minLength: 1
type: string
InstanceId:
description: <p>Instance ID.</p>
maxLength: 64
minLength: 1
type: string
required:
- Database
- InstanceId
type: object
RedshiftParameters:
description: "<p>Amazon Redshift parameters. The <code>ClusterId</code> field\
\ can be blank if\n <code>Host</code> and <code>Port</code> are\
\ both set. The <code>Host</code> and\n <code>Port</code> fields\
\ can be blank if the <code>ClusterId</code> field is set.</p>"
properties:
ClusterId:
description: "<p>Cluster ID. This field can be blank if the <code>Host</code>\
\ and <code>Port</code> are\n provided.</p>"
maxLength: 64
minLength: 1
type: string
Database:
description: <p>Database.</p>
maxLength: 128
minLength: 1
type: string
Host:
description: <p>Host. This field can be blank if <code>ClusterId</code>
is provided.</p>
maxLength: 256
minLength: 1
type: string
Port:
description: <p>Port. This field can be blank if the <code>ClusterId</code>
is provided.</p>
maximum: 65535
minimum: 0
type: number
required:
- Database
type: object
S3Parameters:
description: <p>S3 parameters.</p>
properties:
ManifestFileLocation:
description: <p>Amazon S3 manifest file location.</p>
properties:
Bucket:
description: <p>Amazon S3 bucket.</p>
maxLength: 1024
minLength: 1
type: string
Key:
description: <p>Amazon S3 key that identifies an object.</p>
maxLength: 1024
minLength: 1
type: string
required:
- Bucket
- Key
type: object
required:
- ManifestFileLocation
type: object
SnowflakeParameters:
description: <p>Snowflake parameters.</p>
properties:
Database:
description: <p>Database.</p>
maxLength: 128
minLength: 1
type: string
Host:
description: <p>Host.</p>
maxLength: 256
minLength: 1
type: string
Warehouse:
description: <p>Warehouse.</p>
maxLength: 128
minLength: 0
type: string
required:
- Database
- Host
- Warehouse
type: object
SparkParameters:
description: <p>Spark parameters.</p>
properties:
Host:
description: <p>Host.</p>
maxLength: 256
minLength: 1
type: string
Port:
description: <p>Port.</p>
maximum: 65535
minimum: 1
type: number
required:
- Host
- Port
type: object
SqlServerParameters:
description: <p>SQL Server parameters.</p>
properties:
Database:
description: <p>Database.</p>
maxLength: 128
minLength: 1
type: string
Host:
description: <p>Host.</p>
maxLength: 256
minLength: 1
type: string
Port:
description: <p>Port.</p>
maximum: 65535
minimum: 1
type: number
required:
- Database
- Host
- Port
type: object
TeradataParameters:
description: <p>Teradata parameters.</p>
properties:
Database:
description: <p>Database.</p>
maxLength: 128
minLength: 1
type: string
Host:
description: <p>Host.</p>
maxLength: 256
minLength: 1
type: string
Port:
description: <p>Port.</p>
maximum: 65535
minimum: 1
type: number
required:
- Database
- Host
- Port
type: object
type: object
ErrorInfo:
description: <p>Error information for the data source creation or update.</p>
properties:
Message:
description: <p>Error message.</p>
type: string
Type:
enum:
- ACCESS_DENIED
- COPY_SOURCE_NOT_FOUND
- TIMEOUT
- ENGINE_VERSION_NOT_SUPPORTED
- UNKNOWN_HOST
- GENERIC_SQL_FAILURE
- CONFLICT
- UNKNOWN
type: string
type: object
Name:
description: <p>A display name for the data source.</p>
maxLength: 128
minLength: 1
type: string
Permissions:
description: <p>A list of resource permissions on the data source.</p>
items:
description: <p>Permission for the resource.</p>
properties:
Actions:
description: <p>The IAM action to grant or revoke permissions on.</p>
items:
type: string
maxItems: 16
minItems: 1
type: array
Principal:
description: "<p>The Amazon Resource Name (ARN) of the principal. This can\
\ be one of the\n following:</p>\n <ul>\n \
\ <li>\n <p>The ARN of an Amazon QuickSight user or group\
\ associated with a data source or dataset. (This is common.)</p>\n \
\ </li>\n <li>\n <p>The ARN of an Amazon\
\ QuickSight user, group, or namespace associated with an analysis, dashboard,\
\ template, or theme. (This is common.)</p>\n </li>\n \
\ <li>\n <p>The ARN of an AWS account root: This\
\ is an IAM ARN rather than a QuickSight\n ARN. Use\
\ this option only to share resources (templates) across AWS accounts.\n\
\ (This is less common.) </p>\n </li>\n\
\ </ul>"
maxLength: 256
minLength: 1
type: string
required:
- Actions
- Principal
type: object
maxItems: 64
minItems: 1
type: array
SslProperties:
description: "<p>Secure Socket Layer (SSL) properties that apply when QuickSight\
\ connects to your\n underlying data source.</p>"
properties:
DisableSsl:
description: <p>A Boolean option to control whether SSL should be disabled.</p>
type: boolean
type: object
Tags:
description: <p>Contains a map of the key-value pairs for the resource tag or
tags assigned to the data source.</p>
items:
description: "<p>The key or keys of the key-value pairs for the resource tag\
\ or tags assigned to the\n resource.</p>"
properties:
Key:
description: <p>Tag key.</p>
maxLength: 128
minLength: 1
type: string
Value:
description: <p>Tag value.</p>
maxLength: 256
minLength: 1
type: string
required:
- Key
- Value
type: object
maxItems: 200
minItems: 1
type: array
VpcConnectionProperties:
description: <p>VPC connection properties.</p>
properties:
VpcConnectionArn:
description: <p>The Amazon Resource Name (ARN) for the VPC connection.</p>
type: string
required:
- VpcConnectionArn
type: object
type:
enum:
- update
Permissions - quicksight:DescribeDataSource, quicksight:DescribeDataSourcePermissions, quicksight:UpdateDataSource, quicksight:UpdateDataSourcePermissions, quicksight:TagResource, quicksight:UntagResource, quicksight:ListTagsForResource