AWS Athena

Discover more about the AWS Athena connector and how to use it on the Digibee Integration Platform.

The content of this documentation is under revision and may change. We appreciate your understanding as we work to improve it.

AWS Athena accesses AWS Athena service using AWS SDK version 2.x.

Parameters

Take a look at the configuration parameters for the connector. Parameters supported by Double Braces expressions are marked with (DB).

General tab

Parameter	Description	Default value	Data type
Dynamic Account	When active, the connector will use the account dynamically. Otherwise, it will use the account statically.	False	Boolean
Account Name (DB)	The name of the dynamic account used by the connector. This account must have been previously configured in a Store Account connector in the pipeline for this process to take effect. It is only available if the Dynamic Account parameter is active.	N/A	String
Account	The account used by the connector. It is only available if the Dynamic Account parameter is inactive.	N/A	Account
Label (DB)	Logical name	N/A	String
Fail On Error	If the option is activated, the pipeline's execution with an error will be interrupted. Otherwise, the pipeline execution proceeds, but the result will show a false value for the "success" property.	False	Boolean

Optional tab

Parameter	Description	Default value	Data type
Database (DB)	The Athena database to use.	N/A	String
Delay	Milliseconds before the next poll for query execution status.	2000	Integer
Encryption Option	The encryption type to use when storing query results in S3.	N/A	String
Include Trace	Include useful trace information at the beginning of queries as an SQL comment (prefixed with –).	False	Boolean
Initial Delay	Milliseconds before the first poll for query execution status.	1000	Integer
Kms Key (DB)	For SSE-KMS and CSE-KMS, this is the KMS key ARN or ID.	N/A	String
Max Attempts	Maximum number of times to attempt a query. Set to 1 to disable retries.	1	Integer
Max Results	Max number of results to return for the given operation (if supported by the Athena API endpoint). If not set, will use the Athena API default for the given operation.	N/A	Integer
Next Token (DB)	Pagination token to use in the case where the response from the previous request was truncated.	N/A	String
Operation	The Athena API function to call.	Start Query Execution	String
Output Location (DB)	The location in Amazon S3 where query results are stored, such as s3://path/to/query/bucket/. Ensure this value ends with a forward slash (‘/’).	N/A	String
Output Type	How query results should be returned. One of Stream List (default - return a GetQueryResultsIterable that can page through all results), Select List (returns at most 1,000 rows at a time, plus a NextToken value as a header than can be used for manual pagination of results), S3 Pointer (return an S3 path pointing to the results).	Stream List	String
Query Execution Id (DB)	The unique ID identifying the query execution.	N/A	String
Query String (DB)	The SQL query to run. Except for simple queries, prefer setting this as the body of the Exchange or as a header using Athena2Constants.QUERY_STRING to avoid having to deal with URL encoding issues.	N/A	String
Region (DB)	The region in which Athena client needs to work. When using this parameter, the configuration will expect the lowercase name of the region (for example ap-east-1). You’ll need to use the name Region.EU_WEST_1.id().	N/A	String
Reset Wait Timeout On Retry	Reset the waitTimeout countdown in the event of a query retry. If set to true, potential max time spent waiting for queries is equal to waitTimeout x maxAttempts.	True	Boolean
Retry	Optional comma separated list of error types to retry the query for. Use Retryable to retry all retryable failure conditions (e.g. generic errors and resources exhausted), Generic to retry ‘GENERIC_INTERNAL_ERROR’ failures, Exhausted to retry queries that have exhausted resource limits, Always to always retry regardless of failure condition, or Never or null to never retry (default).	Never	String
Wait Timeout	Optional max wait time in millis to wait for a successful query completion.	0	Integer
Work Group (DB)	The workgroup to use for running the query.	N/A	String
Client Request Token (DB)	A unique string to ensure issues queries are idempotent. It is unlikely you will need to set this.	N/A	String

Headers tab

Parameter	Description	Default value	Data type
Query Execution Id (DB)	The unique ID identifying the query execution.	N/A	string
Query Execution State	The state of the query execution.	N/A	string
Delay	Milliseconds before the next poll for query execution status.	N/A	Integer
Reset Wait Timeout On Retry	Reset the waitTimeout countdown in the event of a query retry. If set to true, potential max time spent waiting for queries is equal to waitTimeout x maxAttempts.	False	boolean
Start Query Execution Attempts	Total number of attempts made to run the query. Will be greater than 1 if the query is retried.	0	Integer
Start Query Execution Elapsed Millis	Total time in millis taken in startQueryExecution (mostly relevant when waiting for query completion within startQueryExecution).	0	Integer

Documentation tab

Parameter	Description	Default value	Data type
Documentation	Section for documenting any necessary information about the connector configuration and business rules.	N/A	String