Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

docs(aws-s3): add documentation for the new aws s3 connector #4746

Open
wants to merge 5 commits into
base: main
Choose a base branch
from
Open
Changes from 2 commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
31 changes: 19 additions & 12 deletions docs/components/connectors/out-of-the-box-connectors/amazon-s3.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,8 @@ title: Amazon S3 Connector
description: Interact with Amazon S3 services from your BPMN process.
---

The **Amazon S3 Connector** is an outbound Connector that allows you to interact with [Amazon Simple Storage Service (Amazon S3)](https://aws.amazon.com/S3/) from your BPMN process.
The **Amazon S3 Connector** is an outbound Connector that allows you to interact
with [Amazon Simple Storage Service (Amazon S3)](https://aws.amazon.com/S3/) from your BPMN process.

## Prerequisites

Expand All @@ -20,7 +21,8 @@ The key will need the following permissions:
Learn more about Amazon S3 in the [Amazon Simple Storage Service Documentation](https://docs.aws.amazon.com/s3/).

:::note
Use Camunda secrets to store credentials and avoid exposing sensitive information from the process. See [managing secrets](/components/console/manage-clusters/manage-secrets.md).
Use Camunda secrets to store credentials and avoid exposing sensitive information from the process.
See [managing secrets](/components/console/manage-clusters/manage-secrets.md).
:::

## Create an Amazon Bedrock Connector task
Expand All @@ -33,7 +35,8 @@ import ConnectorTask from '../../../components/react-components/connector-task.m

Select an authentication type from the **Authentication** dropdown.

- **Credentials** (SaaS/Self-Managed): Select this option if you have a valid pair of access and secret keys provided by your AWS account administrator. This option is supported for both SaaS and Self-Managed users.
- **Credentials** (SaaS/Self-Managed): Select this option if you have a valid pair of access and secret keys provided by
your AWS account administrator. This option is supported for both SaaS and Self-Managed users.

- **Default Credentials Chain** (Hybrid/Self-Managed only): Select this option if your system is
configured as an implicit authentication mechanism, such as role-based authentication, credentials supplied via
Expand Down Expand Up @@ -70,11 +73,11 @@ Upload a document. The incoming document must be a reference from the previous p

#### Parameters

| Parameter | Description |
| :----------- | :----------------------------------------------------------------------------------------------------- |
| `AWS bucket` | The targeted AWS S3 bucket where the document should be uploaded. |
| `AWS key` | The key of the document that uniquely identifies the object in an Amazon S3 bucket. |
| `Document` | The document that should be uploaded to S3, provided as a FEEL expression with the document reference. |
| Parameter | Description |
| :----------- | :----------------------------------------------------------------------------------------------------------------------------------------------- |
| `AWS bucket` | The targeted AWS S3 bucket where the document should be uploaded. |
| `AWS key` | (Optional) The key of the document that uniquely identifies the object in an Amazon S3 bucket. Will fallback to the document filename if not set |
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
| `AWS key` | (Optional) The key of the document that uniquely identifies the object in an Amazon S3 bucket. Will fallback to the document filename if not set |
| `AWS key` | (Optional) The key of the document that uniquely identifies the object in an Amazon S3 bucket. Will fallback to the document filename if not set. |

| `Document` | The document that should be uploaded to S3, provided as a FEEL expression with the document reference. |

:::info
To learn more about Friendly Enough Expression Language (FEEL) expressions,
Expand Down Expand Up @@ -124,9 +127,13 @@ The following JSON response is returned after a successful document download ope

- `bucket`: Echoes back the bucket of the uploaded document.
- `key`: Echoes back the unique key of the uploaded document.
- `document`: The document. This is always null if `Create document` is set to `false`, as no document reference is created.
- `content`: The content of the downloaded document, shown as JSON, text, or base64 raw bytes depending on
the content-type.
- `element`: Represents the document in the workflow. The behavior changes based on the `Create document` setting:
- If `Create document` is set to `false`:
- For `String` content type: `element` will contain the string content of the document.
- For `Json` content type: `element` will contain the JSON content of the document.
- For other content types: `element` will contain the raw bytes of the document, encoded in base64.
- If `Create document` is set to `true`:
- `element` will contain a document reference, rather than the document content itself.

#### Example Response

Expand All @@ -144,7 +151,7 @@ The following examples show a successful download operation response:
"size": 311032,
"fileName": "305a4816-b3df-4724-acd3-010478a54add.webp"
},
"documentType": "camunda"
"camunda.document.type": "camunda"
},
"content": null
}
Expand Down
Loading