AWS Athena

Access AWS Athena.

Metadata

Property	Value
Scheme	`aws2-athena`
Support Level	Stable
Labels	cloud,database
Version	4.10.2

Maven Dependency

<dependency>
    <groupId>org.apache.camel</groupId>
    <artifactId>camel-aws2-athena</artifactId>
    <version>4.10.2</version>
</dependency>

Endpoint Properties

Name	Type	Required	Default	Description
`label`	string	✓		Logical name
`database`	string			The Athena database to use.
`delay`	integer		`2000`	Milliseconds before the next poll for query execution status. See the section Waiting for Query Completion and Retrying Failed Queries to learn more.
`initialDelay`	integer		`1000`	Milliseconds before the first poll for query execution status. See the section Waiting for Query Completion and Retrying Failed Queries to learn more.
`maxAttempts`	integer		`1`	Maximum number of times to attempt a query. Set to 1 to disable retries. See the section Waiting for Query Completion and Retrying Failed Queries to learn more.
`maxResults`	integer			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.
`nextToken`	string			Pagination token to use in the case where the response from the previous request was truncated.
`operation`	object		`startQueryExecution`	The Athena API function to call.
`outputLocation`	string			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.
`outputType`	object		`StreamList`	How query results should be returned. One of StreamList (default - return a GetQueryResultsIterable that can page through all results), SelectList (returns at most 1000 rows at a time, plus a NextToken value as a header than can be used for manual pagination of results), S3Pointer (return an S3 path pointing to the results).
`queryExecutionId`	string			The unique ID identifying the query execution.
`queryString`	string			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.
`region`	string			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).
`resetWaitTimeoutOnRetry`	boolean		`true`	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. See the section Waiting for Query Completion and Retrying Failed Queries to learn more.
`retry`	string		`never`	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). See the section Waiting for Query Completion and Retrying Failed Queries to learn more.
`waitTimeout`	integer		`0`	Optional max wait time in millis to wait for a successful query completion. See the section Waiting for Query Completion and Retrying Failed Queries to learn more.
`workGroup`	string			The workgroup to use for running the query.
`lazyStartProducer`	boolean		`false`	Whether the producer should be started lazy (on the first message). By starting lazy you can use this to allow CamelContext and routes to startup in situations where a producer may otherwise fail during starting and cause the route to fail being started. By deferring this startup to be lazy then the startup failure can be handled during routing messages via Camel's routing error handlers. Beware that when the first message is processed then creating and starting the producer may take a little time and prolong the total processing time of the processing.
`amazonAthenaClient`	object			The AmazonAthena instance to use as the client.
`clientRequestToken`	string			A unique string to ensure issues queries are idempotent. It is unlikely you will need to set this.
`includeTrace`	boolean		`false`	Include useful trace information at the beginning of queries as an SQL comment (prefixed with --).
`proxyHost`	string			To define a proxy host when instantiating the Athena client.
`proxyPort`	integer			To define a proxy port when instantiating the Athena client.
`proxyProtocol`	object		`HTTPS`	To define a proxy protocol when instantiating the Athena client.
`accessKey`	string			Amazon AWS Access Key.
`encryptionOption`	object			The encryption type to use when storing query results in S3. One of SSE_S3, SSE_KMS, or CSE_KMS.
`kmsKey`	string			For SSE-KMS and CSE-KMS, this is the KMS key ARN or ID.
`profileCredentialsName`	string			If using a profile credentials provider, this parameter will set the profile name
`secretKey`	string			Amazon AWS Secret Key.
`sessionToken`	string			Amazon AWS Session Token used when the user needs to assume an IAM role
`useDefaultCredentialsProvider`	boolean		`false`	Set whether the Athena client should expect to load credentials through a default credentials provider or to expect static credentials to be passed in
`useProfileCredentialsProvider`	boolean		`false`	Set whether the Athena client should expect to load credentials through a profile credentials provider.
`useSessionCredentials`	boolean		`false`	Set whether the Athena client should expect to use Session Credentials. This is useful in a situation in which the user needs to assume an IAM role for doing operations in Athena.