Update wiki Home page for aws-comprehend-sink
parent
18388af02c
commit
e06f3949f1
44
Home.md
44
Home.md
@ -1,21 +1,37 @@
|
|||||||
# Deploy the Project on CamelX Platform
|
# AWS Comprehend Sink
|
||||||
|
|
||||||
Deploy on CamelX Platform in three steps
|
Send data to AWS Comprehend for natural language processing.
|
||||||
|
|
||||||
## Step 1: Create a release
|
## Metadata
|
||||||
From the project space, click on **"Create a release"**
|
|
||||||
|
|
||||||
The new version is automatically available in the list
|
| Property | Value |
|
||||||
|
|----------|-------|
|
||||||
|
| Type | sink |
|
||||||
|
| Group | AWS Comprehend |
|
||||||
|
| Namespace | AWS |
|
||||||
|
| Support Level | Preview |
|
||||||
|
| Provider | Apache Software Foundation |
|
||||||
|
|
||||||
## Step 2: Deploy
|
## Properties
|
||||||
Click on **"Deploy"**
|
|
||||||
|
|
||||||
- **Version:** Select the desired release
|
| Name | Type | Required | Default | Description |
|
||||||
- **Environment:** Choose `Development`, `Staging`, or `Production`
|
|------|------|----------|---------|-------------|
|
||||||
- **Configuration:** Select the configuration source
|
| `operation` | string | | `detectDominantLanguage` | The operation to perform on the input text. |
|
||||||
- **Resources:** Set CPU and Memory
|
| `languageCode` | string | | | The language code of the input text. Required for all operations except detectDominantLanguage. Use a 2-letter ISO 639-1 code (e.g., 'en' for English, 'es' for Spanish). |
|
||||||
|
| `endpointArn` | string | | | The Amazon Resource Name (ARN) of the endpoint to use for document classification. Required for classifyDocument operation. |
|
||||||
|
| `accessKey` | string | | | The access key obtained from AWS. |
|
||||||
|
| `secretKey` | string | | | The secret key obtained from AWS. |
|
||||||
|
| `region` | string | ✓ | | The AWS region to access. |
|
||||||
|
| `useDefaultCredentialsProvider` | boolean | | `false` | If true, the Comprehend client loads credentials through a default credentials provider. If false, it uses the basic authentication method (access key and secret key). |
|
||||||
|
| `useProfileCredentialsProvider` | boolean | | `false` | Set whether the Comprehend client should expect to load credentials through a profile credentials provider. |
|
||||||
|
| `useSessionCredentials` | boolean | | `false` | Set whether the Comprehend 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 Comprehend. |
|
||||||
|
| `profileCredentialsName` | string | | | If using a profile credentials provider this parameter sets the profile name. |
|
||||||
|
| `sessionToken` | string | | | Amazon AWS Session Token used when the user needs to assume an IAM role. |
|
||||||
|
| `uriEndpointOverride` | string | | | The overriding endpoint URI. To use this option, you must also select the `overrideEndpoint` option. |
|
||||||
|
| `overrideEndpoint` | boolean | | `false` | Select this option to override the endpoint URI. To use this option, you must also provide a URI for the `uriEndpointOverride` option. |
|
||||||
|
|
||||||
## Step 3: Expose
|
## Dependencies
|
||||||
Enable **"Expose"**
|
|
||||||
|
|
||||||
Choose an **API Gateway** (Internal, Public, etc.)
|
- `camel:core`
|
||||||
|
- `camel:aws2-comprehend`
|
||||||
|
- `camel:kamelet`
|
||||||
|
|||||||
Loading…
Reference in New Issue
Block a user