Main ODBC 2.x connection parameters
The following sections describe each of the main connection parameters.
Data source name
Specifies the name of your data source.
| Connection string name | Parameter type | Default value | Connection string example |
|---|---|---|---|
| DSN | Optional for DSN-less connection types | none |
DSN=AmazonAthenaOdbcUsWest1; |
Description
Contains description of your data source.
| Connection string name | Parameter type | Default value | Connection string example |
|---|---|---|---|
| Description | Optional | none |
Description=Connection to Amazon Athena us-west-1; |
Catalog
Specifies the data catalog name. For more information about catalogs, see DataCatalog in the Amazon Athena API Reference.
| Connection string name | Parameter type | Default value | Connection string example |
|---|---|---|---|
| Catalog | Optional | AwsDataCatalog |
Catalog=AwsDataCatalog; |
Region
Specifies the Amazon Web Services Region. For information about Amazon Web Services Regions, see Regions and
Availability Zones
| Connection string name | Parameter type | Default value | Connection string example |
|---|---|---|---|
| AwsRegion | Mandatory | none |
AwsRegion=us-west-1; |
Database
Specifies the database name. For more information about databases, see Database in the Amazon Athena API Reference.
| Connection string name | Parameter type | Default value | Connection string example |
|---|---|---|---|
| Schema | Optional | default |
Schema=default; |
Workgroup
Specifies the workgroup name. For more information about workgroups, see WorkGroup in the Amazon Athena API Reference.
| Connection string name | Parameter type | Default value | Connection string example |
|---|---|---|---|
| Workgroup | Optional | primary |
Workgroup=primary; |
Output location
Specifies the location in Amazon S3 where query results are stored. For more information about output location, see ResultConfiguration in the Amazon Athena API Reference.
| Connection string name | Parameter type | Default value | Connection string example |
|---|---|---|---|
| S3OutputLocation | Mandatory | none |
S3OutputLocation=s3://DOC-EXAMPLE-BUCKET/; |
Encryption options
Dialog parameter name: Encryption options
Specifies encryption option. For more information about encryption options, see EncryptionConfiguration in the Amazon Athena API Reference.
| Connection string name | Parameter type | Default value | Possible values | Connection string example |
|---|---|---|---|---|
| S3OutputEncOption | Optional | none |
NOT_SET, SSE_S3, SSE_KMS,
CSE_KMS |
S3OutputEncOption=SSE_S3; |
KMS key
Specifies a KMS key for encryption. For more information about encryption configuration for KMS Keys, see EncryptionConfiguration in the Amazon Athena API Reference.
| Connection string name | Parameter type | Default value | Connection string example |
|---|---|---|---|
| S3OutputEncKMSKey | Optional | none |
S3OutputEncKMSKey=your_key; |
Connection test
ODBC Data Source Administrator provides a Test option that you can use to test your ODBC 2.x connection to Amazon Athena. For steps, see Configuring a data source name on Windows. When you test a connection, the ODBC driver calls the GetWorkGroup Athena API action. The call uses the authentication type and corresponding credentials provider that you specified to retrieve the credentials. There is no charge for the connection test when you use the ODBC 2.x driver. The test does not generate query results in your Amazon S3 bucket.