This is an automated email from the ASF dual-hosted git repository.
acosentino pushed a commit to branch main
in repository https://gitbox.apache.org/repos/asf/camel.git
The following commit(s) were added to refs/heads/main by this push:
new 4e3cdf83455 CAMEL-22178 - Added docs for AWS Textract (#19211)
4e3cdf83455 is described below
commit 4e3cdf834557f04c405f366140c95ecd3e65ad9e
Author: Andrea Cosentino <anco...@gmail.com>
AuthorDate: Tue Sep 16 16:04:34 2025 +0200
CAMEL-22178 - Added docs for AWS Textract (#19211)
Signed-off-by: Andrea Cosentino <anco...@gmail.com>
---
.../src/main/docs/aws2-textract-component.adoc | 101 +++++++++++++++++++++
docs/components/modules/ROOT/nav.adoc | 1 +
.../ROOT/pages/aws2-textract-component.adoc | 1 +
3 files changed, 103 insertions(+)
diff --git
a/components/camel-aws/camel-aws2-textract/src/main/docs/aws2-textract-component.adoc
b/components/camel-aws/camel-aws2-textract/src/main/docs/aws2-textract-component.adoc
new file mode 100644
index 00000000000..8a788781da7
--- /dev/null
+++
b/components/camel-aws/camel-aws2-textract/src/main/docs/aws2-textract-component.adoc
@@ -0,0 +1,101 @@
+= AWS Textract Component
+:doctitle: AWS Textract
+:shortname: aws2-textract
+:artifactid: camel-aws2-textract
+:description: Extract text and data from documents using AWS Textract and AWS
SDK version 2.x.
+:since: 4.15
+:supportlevel: Preview
+:tabs-sync-option:
+:component-header: Only producer is supported
+//Manually maintained attributes
+:group: AWS
+:camel-spring-boot-name: aws2-textract
+
+*Since Camel {since}*
+
+*{component-header}*
+
+The AWS2 Textract component supports extracting text and data from documents
+https://aws.amazon.com/textract/[AWS Textract]
+
+Prerequisites
+
+You must have a valid Amazon Web Services developer account, and be
+signed up to use Amazon Textract. More information is available at
+https://aws.amazon.com/textract/[Amazon Textract].
+
+== URI Format
+
+-------------------------
+aws2-textract://label[?options]
+-------------------------
+
+You can append query options to the URI in the following format:
+
+`?options=value&option2=value&...`
+
+
+// component-configure options: START
+
+// component-configure options: END
+
+// component options: START
+include::partial$component-configure-options.adoc[]
+include::partial$component-endpoint-options.adoc[]
+// component options: END
+
+// endpoint options: START
+
+// endpoint options: END
+
+
+Required Textract component options
+
+You have to provide the amazonTextractClient in the
+Registry or your accessKey and secretKey to access
+the https://aws.amazon.com/textract/[Amazon Textract] service.
+
+// component headers: START
+include::partial$component-endpoint-headers.adoc[]
+// component headers: END
+
+== Usage
+
+=== Static credentials, Default Credential Provider and Profile Credentials
Provider
+
+You have the possibility of avoiding the usage of explicit static credentials
by specifying the useDefaultCredentialsProvider option and set it to true.
+
+The order of evaluation for Default Credentials Provider is the following:
+
+ - Java system properties - `aws.accessKeyId` and `aws.secretKey`
+ - Environment variables - `AWS_ACCESS_KEY_ID` and `AWS_SECRET_ACCESS_KEY`.
+ - Web Identity Token from AWS STS.
+ - The shared credentials and config files.
+ - Amazon ECS container credentials - loaded from the Amazon ECS if the
environment variable `AWS_CONTAINER_CREDENTIALS_RELATIVE_URI` is set.
+ - Amazon EC2 Instance profile credentials.
+
+You have also the possibility of using Profile Credentials Provider, by
specifying the useProfileCredentialsProvider option to true and
profileCredentialsName to the profile name.
+
+Only one of static, default and profile credentials could be used at the same
time.
+
+For more information about this you can look at
https://docs.aws.amazon.com/sdk-for-java/latest/developer-guide/credentials.html[AWS
credentials documentation]
+
+== Dependencies
+
+Maven users will need to add the following dependency to their pom.xml.
+
+*pom.xml*
+
+[source,xml]
+---------------------------------------
+<dependency>
+ <groupId>org.apache.camel</groupId>
+ <artifactId>camel-aws2-textract</artifactId>
+ <version>${camel-version}</version>
+</dependency>
+---------------------------------------
+
+where `$\{camel-version}` must be replaced by the actual version of Camel.
+
+
+include::spring-boot:partial$starter.adoc[]
diff --git a/docs/components/modules/ROOT/nav.adoc
b/docs/components/modules/ROOT/nav.adoc
index 0cf9d612d74..21eb8240f36 100644
--- a/docs/components/modules/ROOT/nav.adoc
+++ b/docs/components/modules/ROOT/nav.adoc
@@ -56,6 +56,7 @@
*** xref:aws2-sns-component.adoc[AWS Simple Notification System (SNS)]
*** xref:aws2-sqs-component.adoc[AWS Simple Queue Service (SQS)]
*** xref:aws2-step-functions-component.adoc[AWS StepFunctions]
+*** xref:aws2-textract-component.adoc[AWS Textract]
*** xref:aws2-timestream-component.adoc[AWS Timestream]
*** xref:aws2-translate-component.adoc[AWS Translate]
*** xref:pqc-component.adoc[PQC Algorithms]
diff --git a/docs/components/modules/ROOT/pages/aws2-textract-component.adoc
b/docs/components/modules/ROOT/pages/aws2-textract-component.adoc
new file mode 120000
index 00000000000..5823d4fae35
--- /dev/null
+++ b/docs/components/modules/ROOT/pages/aws2-textract-component.adoc
@@ -0,0 +1 @@
+../../../../../components/camel-aws/camel-aws2-textract/src/main/docs/aws2-textract-component.adoc
\ No newline at end of file
