| {"component":{"kind":"component","name":"aws2-athena","title":"AWS Athena","description":"Access AWS Athena service using AWS SDK version 2.x.","deprecated":false,"firstVersion":"3.4.0","label":"cloud,database","javaType":"org.apache.camel.component.aws2.athena.Athena2Component","supportLevel":"Stable","groupId":"org.apache.camel","artifactId":"camel-aws2-athena","version":"3.18.1","scheme":"aws2-athena","extendsScheme":"","syntax":"aws2-athena:label","async":false,"api":false,"consumerOnly":false,"producerOnly":true,"lenientProperties":false},"headers":{"CamelAwsAthenaOperation":{"kind":"header","displayName":"","group":"all","label":"all","required":false,"javaType":"org.apache.camel.component.aws2.athena.Athena2Operations","enum":["getQueryExecution","getQueryResults","listQueryExecutions","startQueryExecution"],"deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"defaultValue":"startQueryExecution","description":"The operation to perform. Permitted values are getQueryExecution, getQueryResults, listQueryExecutions, startQueryExecution.","constantName":"org.apache.camel.component.aws2.athena.Athena2Constants#OPERATION"},"CamelAwsAthenaDatabase":{"kind":"header","displayName":"","group":"startQueryExecution","label":"startQueryExecution","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The Athena database to use.","constantName":"org.apache.camel.component.aws2.athena.Athena2Constants#DATABASE"},"CamelAwsAthenaQueryExecutionId":{"kind":"header","displayName":"","group":"getQueryExecution getQueryResults startQueryExecution","label":"getQueryExecution getQueryResults startQueryExecution","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The unique ID identifying the query execution.","constantName":"org.apache.camel.component.aws2.athena.Athena2Constants#QUERY_EXECUTION_ID"},"CamelAwsAthenaWorkGroup":{"kind":"header","displayName":"","group":"listQueryExecutions startQueryExecution","label":"listQueryExecutions startQueryExecution","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The workgroup to use for running the query.","constantName":"org.apache.camel.component.aws2.athena.Athena2Constants#WORK_GROUP"},"CamelAwsAthenaNextToken":{"kind":"header","displayName":"","group":"getQueryResults listQueryExecutions","label":"getQueryResults listQueryExecutions","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"Pagination token to use in the case where the response from the previous request was truncated.","constantName":"org.apache.camel.component.aws2.athena.Athena2Constants#NEXT_TOKEN"},"CamelAwsAthenaMaxResults":{"kind":"header","displayName":"","group":"getQueryResults listQueryExecutions","label":"getQueryResults listQueryExecutions","required":false,"javaType":"Integer","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"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.","constantName":"org.apache.camel.component.aws2.athena.Athena2Constants#MAX_RESULTS"},"CamelAwsAthenaIncludeTrace":{"kind":"header","displayName":"","group":"startQueryExecution","label":"startQueryExecution","required":false,"javaType":"boolean","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"Include useful trace information at the beginning of queries as an SQL comment (prefixed with --).","constantName":"org.apache.camel.component.aws2.athena.Athena2Constants#INCLUDE_TRACE"},"CamelAwsAthenaOutputLocation":{"kind":"header","displayName":"","group":"getQueryExecution getQueryResults startQueryExecution","label":"getQueryExecution getQueryResults startQueryExecution","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"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 ('/').","constantName":"org.apache.camel.component.aws2.athena.Athena2Constants#OUTPUT_LOCATION"},"CamelAwsAthenaOutputType":{"kind":"header","displayName":"","group":"getQueryResults","label":"getQueryResults","required":false,"javaType":"org.apache.camel.component.aws2.athena.Athena2OutputType","enum":["StreamList","SelectList","S3Pointer"],"deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"How query results should be returned. One of StreamList (default - return a GetQueryResultsIterable that can page through all results), SelectList (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), S3Pointer (return an S3 path pointing to the results).","constantName":"org.apache.camel.component.aws2.athena.Athena2Constants#OUTPUT_TYPE"},"CamelAwsAthenaQueryExecutionState":{"kind":"header","displayName":"","group":"getQueryExecution getQueryResults startQueryExecution","label":"getQueryExecution getQueryResults startQueryExecution","required":false,"javaType":"software.amazon.awssdk.services.athena.model.QueryExecutionState","enum":["QUEUED","RUNNING","SUCCEEDED","FAILED","CANCELLED","null"],"deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The state of the query execution.","constantName":"org.apache.camel.component.aws2.athena.Athena2Constants#QUERY_EXECUTION_STATE"},"CamelAwsAthenaClientRequestToken":{"kind":"header","displayName":"","group":"startQueryExecution","label":"startQueryExecution","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"A unique string to ensure issues queries are idempotent. It is unlikely you will need to set this.","constantName":"org.apache.camel.component.aws2.athena.Athena2Constants#CLIENT_REQUEST_TOKEN"},"CamelAwsAthenaQueryString":{"kind":"header","displayName":"","group":"startQueryExecution","label":"startQueryExecution","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The SQL query to run. Except for simple queries, prefer setting this as the body of the Exchange or as this header to avoid having to deal with URL encoding issues.","constantName":"org.apache.camel.component.aws2.athena.Athena2Constants#QUERY_STRING"},"CamelAwsAthenaEncryptionOption":{"kind":"header","displayName":"","group":"startQueryExecution","label":"startQueryExecution","required":false,"javaType":"software.amazon.awssdk.services.athena.model.EncryptionOption","enum":["SSE_S3","SSE_KMS","CSE_KMS","null"],"deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The encryption type to use when storing query results in S3.","constantName":"org.apache.camel.component.aws2.athena.Athena2Constants#ENCRYPTION_OPTION"},"CamelAwsAthenaKmsKey":{"kind":"header","displayName":"","group":"startQueryExecution","label":"startQueryExecution","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"For SSE-KMS and CSE-KMS, this is the KMS key ARN or ID.","constantName":"org.apache.camel.component.aws2.athena.Athena2Constants#KMS_KEY"},"CamelAwsAthenaWaitTimeout":{"kind":"header","displayName":"","group":"startQueryExecution","label":"startQueryExecution","required":false,"javaType":"long","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"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.","constantName":"org.apache.camel.component.aws2.athena.Athena2Constants#WAIT_TIMEOUT"},"CamelAwsAthenaInitialDelay":{"kind":"header","displayName":"","group":"startQueryExecution","label":"startQueryExecution","required":false,"javaType":"long","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"Milliseconds before the first poll for query execution status. See the section 'Waiting for Query Completion and Retrying Failed Queries' to learn more.","constantName":"org.apache.camel.component.aws2.athena.Athena2Constants#INITIAL_DELAY"},"CamelAwsAthenaDelay":{"kind":"header","displayName":"","group":"startQueryExecution","label":"startQueryExecution","required":false,"javaType":"long","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"Milliseconds before the next poll for query execution status. See the section 'Waiting for Query Completion and Retrying Failed Queries' to learn more.","constantName":"org.apache.camel.component.aws2.athena.Athena2Constants#DELAY"},"CamelAwsAthenaMaxAttempts":{"kind":"header","displayName":"","group":"startQueryExecution","label":"startQueryExecution","required":false,"javaType":"int","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"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.","constantName":"org.apache.camel.component.aws2.athena.Athena2Constants#MAX_ATTEMPTS"},"CamelAwsAthenaRetry":{"kind":"header","displayName":"","group":"startQueryExecution","label":"startQueryExecution","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"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.","constantName":"org.apache.camel.component.aws2.athena.Athena2Constants#RETRY"},"CamelAwsAthenaResetWaitTimeoutOnRetry":{"kind":"header","displayName":"","group":"startQueryExecution","label":"startQueryExecution","required":false,"javaType":"boolean","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"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.","constantName":"org.apache.camel.component.aws2.athena.Athena2Constants#RESET_WAIT_TIMEOUT_ON_RETRY"},"CamelAwsAthenaStartQueryExecutionAttempts":{"kind":"header","displayName":"","group":"startQueryExecution","label":"startQueryExecution","required":false,"javaType":"int","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"Total number of attempts made to run the query. Will be greater than 1 if the query is retried.","constantName":"org.apache.camel.component.aws2.athena.Athena2Constants#START_QUERY_EXECUTION_ATTEMPTS"},"CamelAwsAthenaStartQueryExecutionElapsedMillis":{"kind":"header","displayName":"","group":"startQueryExecution","label":"startQueryExecution","required":false,"javaType":"long","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"Total time in millis taken in startQueryExecution (mostly relevant when waiting for query completion within startQueryExecution).","constantName":"org.apache.camel.component.aws2.athena.Athena2Constants#START_QUERY_EXECUTION_ELAPSED_MILLIS"}},"properties":{"label":{"kind":"path","displayName":"Label","group":"producer","label":"producer","required":true,"type":"string","javaType":"java.lang.String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.aws2.athena.Athena2Configuration","configurationField":"configuration","description":"Logical name"},"accessKey":{"kind":"parameter","displayName":"Access Key","group":"producer","label":"producer","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":true,"configurationClass":"org.apache.camel.component.aws2.athena.Athena2Configuration","configurationField":"configuration","description":"Amazon AWS Access Key."},"amazonAthenaClient":{"kind":"parameter","displayName":"Amazon Athena Client","group":"producer","label":"","required":false,"type":"object","javaType":"software.amazon.awssdk.services.athena.AthenaClient","deprecated":false,"deprecationNote":"","autowired":true,"secret":false,"configurationClass":"org.apache.camel.component.aws2.athena.Athena2Configuration","configurationField":"configuration","description":"The AmazonAthena instance to use as the client."},"database":{"kind":"parameter","displayName":"Database","group":"producer","label":"producer","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.aws2.athena.Athena2Configuration","configurationField":"configuration","description":"The Athena database to use."},"delay":{"kind":"parameter","displayName":"Delay","group":"producer","label":"producer","required":false,"type":"integer","javaType":"long","deprecated":false,"autowired":false,"secret":false,"defaultValue":2000,"configurationClass":"org.apache.camel.component.aws2.athena.Athena2Configuration","configurationField":"configuration","description":"Milliseconds before the next poll for query execution status. See the section 'Waiting for Query Completion and Retrying Failed Queries' to learn more."},"encryptionOption":{"kind":"parameter","displayName":"Encryption Option","group":"producer","label":"producer","required":false,"type":"object","javaType":"software.amazon.awssdk.services.athena.model.EncryptionOption","enum":["SSE_S3","SSE_KMS","CSE_KMS","null"],"deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.aws2.athena.Athena2Configuration","configurationField":"configuration","description":"The encryption type to use when storing query results in S3. One of SSE_S3, SSE_KMS, or CSE_KMS."},"includeTrace":{"kind":"parameter","displayName":"Include Trace","group":"producer","label":"producer","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"configurationClass":"org.apache.camel.component.aws2.athena.Athena2Configuration","configurationField":"configuration","description":"Include useful trace information at the beginning of queries as an SQL comment (prefixed with --)."},"initialDelay":{"kind":"parameter","displayName":"Initial Delay","group":"producer","label":"producer","required":false,"type":"integer","javaType":"long","deprecated":false,"autowired":false,"secret":false,"defaultValue":1000,"configurationClass":"org.apache.camel.component.aws2.athena.Athena2Configuration","configurationField":"configuration","description":"Milliseconds before the first poll for query execution status. See the section 'Waiting for Query Completion and Retrying Failed Queries' to learn more."},"kmsKey":{"kind":"parameter","displayName":"Kms Key","group":"producer","label":"producer","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.aws2.athena.Athena2Configuration","configurationField":"configuration","description":"For SSE-KMS and CSE-KMS, this is the KMS key ARN or ID."},"maxAttempts":{"kind":"parameter","displayName":"Max Attempts","group":"producer","label":"producer","required":false,"type":"integer","javaType":"int","deprecated":false,"autowired":false,"secret":false,"defaultValue":1,"configurationClass":"org.apache.camel.component.aws2.athena.Athena2Configuration","configurationField":"configuration","description":"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":{"kind":"parameter","displayName":"Max Results","group":"producer","label":"producer","required":false,"type":"integer","javaType":"java.lang.Integer","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.aws2.athena.Athena2Configuration","configurationField":"configuration","description":"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":{"kind":"parameter","displayName":"Next Token","group":"producer","label":"producer","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.aws2.athena.Athena2Configuration","configurationField":"configuration","description":"Pagination token to use in the case where the response from the previous request was truncated."},"operation":{"kind":"parameter","displayName":"Operation","group":"producer","label":"producer","required":false,"type":"object","javaType":"org.apache.camel.component.aws2.athena.Athena2Operations","enum":["getQueryExecution","getQueryResults","listQueryExecutions","startQueryExecution"],"deprecated":false,"autowired":false,"secret":false,"defaultValue":"startQueryExecution","configurationClass":"org.apache.camel.component.aws2.athena.Athena2Configuration","configurationField":"configuration","description":"The Athena API function to call."},"outputLocation":{"kind":"parameter","displayName":"Output Location","group":"producer","label":"producer","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.aws2.athena.Athena2Configuration","configurationField":"configuration","description":"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":{"kind":"parameter","displayName":"Output Type","group":"producer","label":"producer","required":false,"type":"object","javaType":"org.apache.camel.component.aws2.athena.Athena2OutputType","enum":["StreamList","SelectList","S3Pointer"],"deprecated":false,"autowired":false,"secret":false,"defaultValue":"StreamList","configurationClass":"org.apache.camel.component.aws2.athena.Athena2Configuration","configurationField":"configuration","description":"How query results should be returned. One of StreamList (default - return a GetQueryResultsIterable that can page through all results), SelectList (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), S3Pointer (return an S3 path pointing to the results)."},"proxyHost":{"kind":"parameter","displayName":"Proxy Host","group":"producer","label":"producer","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.aws2.athena.Athena2Configuration","configurationField":"configuration","description":"To define a proxy host when instantiating the Athena client."},"proxyPort":{"kind":"parameter","displayName":"Proxy Port","group":"producer","label":"producer","required":false,"type":"integer","javaType":"java.lang.Integer","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.aws2.athena.Athena2Configuration","configurationField":"configuration","description":"To define a proxy port when instantiating the Athena client."},"proxyProtocol":{"kind":"parameter","displayName":"Proxy Protocol","group":"producer","label":"","required":false,"type":"object","javaType":"software.amazon.awssdk.core.Protocol","enum":["HTTP","HTTPS"],"deprecated":false,"autowired":false,"secret":false,"defaultValue":"HTTPS","configurationClass":"org.apache.camel.component.aws2.athena.Athena2Configuration","configurationField":"configuration","description":"To define a proxy protocol when instantiating the Athena client."},"queryExecutionId":{"kind":"parameter","displayName":"Query Execution Id","group":"producer","label":"producer","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.aws2.athena.Athena2Configuration","configurationField":"configuration","description":"The unique ID identifying the query execution."},"queryString":{"kind":"parameter","displayName":"Query String","group":"producer","label":"producer","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.aws2.athena.Athena2Configuration","configurationField":"configuration","description":"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":{"kind":"parameter","displayName":"Region","group":"producer","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.aws2.athena.Athena2Configuration","configurationField":"configuration","description":"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()."},"resetWaitTimeoutOnRetry":{"kind":"parameter","displayName":"Reset Wait Timeout On Retry","group":"producer","label":"producer","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":true,"configurationClass":"org.apache.camel.component.aws2.athena.Athena2Configuration","configurationField":"configuration","description":"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":{"kind":"parameter","displayName":"Retry","group":"producer","label":"producer","required":false,"type":"string","javaType":"java.lang.String","enum":["never","always","retryable","exhausted","generic"],"deprecated":false,"autowired":false,"secret":false,"defaultValue":"never","configurationClass":"org.apache.camel.component.aws2.athena.Athena2Configuration","configurationField":"configuration","description":"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."},"secretKey":{"kind":"parameter","displayName":"Secret Key","group":"producer","label":"producer","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":true,"configurationClass":"org.apache.camel.component.aws2.athena.Athena2Configuration","configurationField":"configuration","description":"Amazon AWS Secret Key."},"useDefaultCredentialsProvider":{"kind":"parameter","displayName":"Use Default Credentials Provider","group":"producer","label":"","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"configurationClass":"org.apache.camel.component.aws2.athena.Athena2Configuration","configurationField":"configuration","description":"Set whether the Athena client should expect to load credentials through a default credentials provider or to expect static credentials to be passed in"},"waitTimeout":{"kind":"parameter","displayName":"Wait Timeout","group":"producer","label":"producer","required":false,"type":"integer","javaType":"long","deprecated":false,"autowired":false,"secret":false,"defaultValue":0,"configurationClass":"org.apache.camel.component.aws2.athena.Athena2Configuration","configurationField":"configuration","description":"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":{"kind":"parameter","displayName":"Work Group","group":"producer","label":"producer","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.aws2.athena.Athena2Configuration","configurationField":"configuration","description":"The workgroup to use for running the query."},"lazyStartProducer":{"kind":"parameter","displayName":"Lazy Start Producer","group":"producer (advanced)","label":"producer,advanced","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"description":"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."},"clientRequestToken":{"kind":"parameter","displayName":"Client Request Token","group":"advanced","label":"advanced","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.aws2.athena.Athena2Configuration","configurationField":"configuration","description":"A unique string to ensure issues queries are idempotent. It is unlikely you will need to set this."}}} |