AWS Athena

Access AWS Athena.

What’s inside

AWS Athena component, URI syntax: aws2-athena:label

Please refer to the above links for usage and configuration details.

Maven coordinates

<dependency>
    <groupId>org.apache.camel.springboot</groupId>
    <artifactId>camel-aws2-athena-starter</artifactId>
</dependency>

Spring Boot Auto-Configuration

The starter supports 40 options, which are listed below.

Name	Description	Default	Type
camel.component.aws2-athena.access-key	Amazon AWS Access Key.		String
camel.component.aws2-athena.amazon-athena-client	The AmazonAthena instance to use as the client. The option is a software.amazon.awssdk.services.athena.AthenaClient type.		AthenaClient
camel.component.aws2-athena.autowired-enabled	Whether autowiring is enabled. This is used for automatic autowiring options (the option must be marked as autowired) by looking up in the registry to find if there is a single instance of matching type, which then gets configured on the component. This can be used for automatic configuring JDBC data sources, JMS connection factories, AWS Clients, etc.	true	Boolean
camel.component.aws2-athena.client-request-token	A unique string to ensure issues queries are idempotent. It is unlikely you will need to set this.		String
camel.component.aws2-athena.configuration	The component configuration. The option is a org.apache.camel.component.aws2.athena.Athena2Configuration type.		Athena2Configuration
camel.component.aws2-athena.database	The Athena database to use.		String
camel.component.aws2-athena.delay	Milliseconds before the next poll for query execution status. See the section Waiting for Query Completion and Retrying Failed Queries to learn more.	2000	Long
camel.component.aws2-athena.enabled	Whether to enable auto configuration of the aws2-athena component. This is enabled by default.		Boolean
camel.component.aws2-athena.encryption-option	The encryption type to use when storing query results in S3. One of SSE_S3, SSE_KMS, or CSE_KMS.		EncryptionOption
camel.component.aws2-athena.health-check-consumer-enabled	Used for enabling or disabling all consumer based health checks from this component	true	Boolean
camel.component.aws2-athena.health-check-producer-enabled	Used for enabling or disabling all producer based health checks from this component. Notice: Camel has by default disabled all producer based health-checks. You can turn on producer checks globally by setting camel.health.producersEnabled=true.	true	Boolean
camel.component.aws2-athena.include-trace	Include useful trace information at the beginning of queries as an SQL comment (prefixed with --).	false	Boolean
camel.component.aws2-athena.initial-delay	Milliseconds before the first poll for query execution status. See the section Waiting for Query Completion and Retrying Failed Queries to learn more.	1000	Long
camel.component.aws2-athena.kms-key	For SSE-KMS and CSE-KMS, this is the KMS key ARN or ID.		String
camel.component.aws2-athena.lazy-start-producer	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.	false	Boolean
camel.component.aws2-athena.max-attempts	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.	1	Integer
camel.component.aws2-athena.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.		Integer
camel.component.aws2-athena.next-token	Pagination token to use in the case where the response from the previous request was truncated.		String
camel.component.aws2-athena.operation	The Athena API function to call.	startqueryexecution	Athena2Operations
camel.component.aws2-athena.output-location	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.		String
camel.component.aws2-athena.output-type	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).	streamlist	Athena2OutputType
camel.component.aws2-athena.override-endpoint	Set the need for overriding the endpoint. This option needs to be used in combination with the uriEndpointOverride option	false	Boolean
camel.component.aws2-athena.profile-credentials-name	If using a profile credentials provider, this parameter will set the profile name		String
camel.component.aws2-athena.proxy-host	To define a proxy host when instantiating the Athena client.		String
camel.component.aws2-athena.proxy-port	To define a proxy port when instantiating the Athena client.		Integer
camel.component.aws2-athena.proxy-protocol	To define a proxy protocol when instantiating the Athena client.	https	Protocol
camel.component.aws2-athena.query-execution-id	The unique ID identifying the query execution.		String
camel.component.aws2-athena.query-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.		String
camel.component.aws2-athena.region	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).		String
camel.component.aws2-athena.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. See the section Waiting for Query Completion and Retrying Failed Queries to learn more.	true	Boolean
camel.component.aws2-athena.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). See the section Waiting for Query Completion and Retrying Failed Queries to learn more.	never	String
camel.component.aws2-athena.secret-key	Amazon AWS Secret Key.		String
camel.component.aws2-athena.session-token	Amazon AWS Session Token used when the user needs to assume an IAM role		String
camel.component.aws2-athena.trust-all-certificates	If we want to trust all certificates in case of overriding the endpoint	false	Boolean
camel.component.aws2-athena.uri-endpoint-override	Set the overriding uri endpoint. This option needs to be used in combination with overrideEndpoint option		String
camel.component.aws2-athena.use-default-credentials-provider	Set whether the Athena client should expect to load credentials through a default credentials provider or to expect static credentials to be passed in	false	Boolean
camel.component.aws2-athena.use-profile-credentials-provider	Set whether the Athena client should expect to load credentials through a profile credentials provider.	false	Boolean
camel.component.aws2-athena.use-session-credentials	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.	false	Boolean
camel.component.aws2-athena.wait-timeout	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.	0	Long
camel.component.aws2-athena.work-group	The workgroup to use for running the query.		String

Name

Description

Default

Type

camel.component.aws2-athena.access-key

Amazon AWS Access Key.

String

camel.component.aws2-athena.amazon-athena-client

The AmazonAthena instance to use as the client. The option is a software.amazon.awssdk.services.athena.AthenaClient type.

AthenaClient

camel.component.aws2-athena.autowired-enabled

Whether autowiring is enabled. This is used for automatic autowiring options (the option must be marked as autowired) by looking up in the registry to find if there is a single instance of matching type, which then gets configured on the component. This can be used for automatic configuring JDBC data sources, JMS connection factories, AWS Clients, etc.

true

Boolean

camel.component.aws2-athena.client-request-token

A unique string to ensure issues queries are idempotent. It is unlikely you will need to set this.

String

camel.component.aws2-athena.configuration

The component configuration. The option is a org.apache.camel.component.aws2.athena.Athena2Configuration type.

Athena2Configuration

camel.component.aws2-athena.database

The Athena database to use.

String

camel.component.aws2-athena.delay

Milliseconds before the next poll for query execution status. See the section Waiting for Query Completion and Retrying Failed Queries to learn more.

2000

Long

camel.component.aws2-athena.enabled

Whether to enable auto configuration of the aws2-athena component. This is enabled by default.

Boolean

camel.component.aws2-athena.encryption-option

The encryption type to use when storing query results in S3. One of SSE_S3, SSE_KMS, or CSE_KMS.

EncryptionOption

camel.component.aws2-athena.health-check-consumer-enabled

Used for enabling or disabling all consumer based health checks from this component

true

Boolean

camel.component.aws2-athena.health-check-producer-enabled

Used for enabling or disabling all producer based health checks from this component. Notice: Camel has by default disabled all producer based health-checks. You can turn on producer checks globally by setting camel.health.producersEnabled=true.

true

Boolean

camel.component.aws2-athena.include-trace

Include useful trace information at the beginning of queries as an SQL comment (prefixed with --).

false

Boolean

camel.component.aws2-athena.initial-delay

Milliseconds before the first poll for query execution status. See the section Waiting for Query Completion and Retrying Failed Queries to learn more.

1000

Long

camel.component.aws2-athena.kms-key

For SSE-KMS and CSE-KMS, this is the KMS key ARN or ID.

String

camel.component.aws2-athena.lazy-start-producer

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.

false

Boolean

camel.component.aws2-athena.max-attempts

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.

Integer

camel.component.aws2-athena.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.

Integer

camel.component.aws2-athena.next-token

Pagination token to use in the case where the response from the previous request was truncated.

String

camel.component.aws2-athena.operation

The Athena API function to call.

startqueryexecution

Athena2Operations

camel.component.aws2-athena.output-location

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.

String

camel.component.aws2-athena.output-type

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).

streamlist

Athena2OutputType

camel.component.aws2-athena.override-endpoint

Set the need for overriding the endpoint. This option needs to be used in combination with the uriEndpointOverride option

false

Boolean

camel.component.aws2-athena.profile-credentials-name

If using a profile credentials provider, this parameter will set the profile name

String

camel.component.aws2-athena.proxy-host

To define a proxy host when instantiating the Athena client.

String

camel.component.aws2-athena.proxy-port

To define a proxy port when instantiating the Athena client.

Integer

camel.component.aws2-athena.proxy-protocol

To define a proxy protocol when instantiating the Athena client.

https

Protocol

camel.component.aws2-athena.query-execution-id

The unique ID identifying the query execution.

String

camel.component.aws2-athena.query-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.

String

camel.component.aws2-athena.region

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).

String

camel.component.aws2-athena.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. See the section Waiting for Query Completion and Retrying Failed Queries to learn more.

true

Boolean

camel.component.aws2-athena.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). See the section Waiting for Query Completion and Retrying Failed Queries to learn more.

never

String

camel.component.aws2-athena.secret-key

Amazon AWS Secret Key.

String

camel.component.aws2-athena.session-token

Amazon AWS Session Token used when the user needs to assume an IAM role

String

camel.component.aws2-athena.trust-all-certificates

If we want to trust all certificates in case of overriding the endpoint

false

Boolean

camel.component.aws2-athena.uri-endpoint-override

Set the overriding uri endpoint. This option needs to be used in combination with overrideEndpoint option

String

camel.component.aws2-athena.use-default-credentials-provider

Set whether the Athena client should expect to load credentials through a default credentials provider or to expect static credentials to be passed in

false

Boolean

camel.component.aws2-athena.use-profile-credentials-provider

Set whether the Athena client should expect to load credentials through a profile credentials provider.

false

Boolean

camel.component.aws2-athena.use-session-credentials

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.

false

Boolean

camel.component.aws2-athena.wait-timeout

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.

Long

camel.component.aws2-athena.work-group

The workgroup to use for running the query.

String