If you’re new to Unstructured, read this note first.Before you can create a destination connector, you must first sign in to your Unstructured account:
  • If you do not already have an Unstructured account, go to https://unstructured.io/contact and fill out the online form to indicate your interest.
  • If you already have an Unstructured account, sign in by using the URL of the sign in page that Unstructured provided to you when your Unstructured account was created.
    If you do not have this URL, contact Unstructured Sales at sales@unstructured.io.
After you sign in, the Unstructured user interface (UI) appears, which you use to get your Unstructured API key. To learn how, watch this 40-second how-to video.After you create the destination connector, add it along with a source connector to a workflow. Then run the worklow as a job. To learn how, try out the hands-on Workflow Endpoint quickstart, go directly to the quickstart notebook, or watch the two 4-minute video tutorials for the Unstructured Python SDK.You can also create destination connectors with the Unstructured user interface (UI). Learn how.If you need help, reach out to the community on Slack, or contact us directly.You are now ready to start creating a destination connector! Keep reading to learn how.
Send processed data from Unstructured to Amazon S3. The requirements are as follows. The following video shows how to fulfill the minimum set of Amazon S3 requirements: The preceding video does not show how to create an AWS account; enable anonymous access to the bucket (which is supported but not recommended); or generate an AWS STS session token for temporary access, if required by your organization’s security requirements. For more information about requirements, see the following:
  • An AWS account. Create an AWS account.
  • An S3 bucket. Create an S3 bucket. Additional approaches are in the following video and in the how-to sections at the end of this page.
  • Anonymous (supported but not recommended) or authenticated access to the bucket.
  • For authenticated bucket read access, the authenticated AWS IAM user must have at minimum the permissions of s3:ListBucket and s3:GetObject for that bucket. Learn how.
  • For bucket write access, authenticated access to the bucket must be enabled (anonymous access must not be enabled), and the authenticated AWS IAM user must have at minimum the permission of s3:PutObject for that bucket. Learn how.
  • For authenticated access, an AWS access key and secret access key for the authenticated AWS IAM user in the account. Create an AWS access key and secret access key.
  • For authenticated access in untrusted environments or enhanced security scenarios, an AWS STS session token for temporary access, in addition to an AWS access key and secret access key. Create a session token.
    AWS STS credentials can be valid for as little as 15 minutes or as long as 36 hours, depending on how the credentials were initially generated. After the expiry time, the credentials are no longer valid will no longer work with the corresponding S3 connector. You must get a new set of credentials to replace the expired ones by calling GetSessionToken in the AWS STS API. To overwrite the expired credentials with the new set:
    • For the Unstructured user interface (UI), manually update the AWS Key, AWS Secret Key, and STS Token fields in the Unstructured UI for the corresponding S3 source or destination connector.
    • For the Unstructured API, use the Unstructured Workflow Endpoint to call the update source or update destination connector operation for the corresponding S3 source or destination connector.
    • For Unstructured Ingest, change the values of --key, --secret, and --token (CLI) or key, secret, and token (Python) in your command or code for the corresponding S3 source or destination connector.
  • If the target files are in the root of the bucket, the path to the bucket, formatted as protocol://bucket/ (for example, s3://my-bucket/). If the target files are in a folder, the path to the target folder in the S3 bucket, formatted as protocol://bucket/path/to/folder/ (for example, s3://my-bucket/my-folder/).
  • If the target files are in a folder, and authenticated bucket access is enabled, make sure the authenticated AWS IAM user has authenticated access to the folder as well. Enable authenticated folder access.
To create an S3 destination connector, see the following examples. 
import os

from unstructured_client import UnstructuredClient
from unstructured_client.models.operations import CreateDestinationRequest
from unstructured_client.models.shared import (
    CreateDestinationConnector,
    DestinationConnectorType,
    S3DestinationConnectorConfigInput
)

with UnstructuredClient(api_key_auth=os.getenv("UNSTRUCTURED_API_KEY")) as client:
    response = client.destinations.create_destination(
        request=CreateDestinationRequest(
            create_destination_connector=CreateDestinationConnector(
                name="<name>",
                type=DestinationConnectorType.S3,
                config=S3DestinationConnectorConfigInput(
                    # For AWS access key ID with AWS secret access key authentication:
                    key="<key>", 
                    secret="<secret>", 

                    # For AWS STS token authentication:
                    key="<key>", 
                    secret="<secret>",
                    token="<token>", 

                    remote_url="<remote_url>",
                    endpoint_url="<endpoint-url>"
                )
            )
        )
    )

    print(response.destination_connector_information)
Replace the preceding placeholders as follows:
  • <name> (required) - A unique name for this connector.
  • For AWS access key ID with AWS secret access key authentication, or for AWS STS token authentication:
    • <key> - The AWS access key ID for the authenticated AWS IAM user (required).
    • <secret> - The AWS secret access key corresponding to the preceding AWS access key ID (required).
  • For AWS STS token authentication:
    • <token> - The AWS STS session token for temporary access (required).
  • <endpoint-url> - A custom URL, if connecting to a non-AWS S3 bucket.
  • <remote-url> (required) - The S3 URI to the bucket or folder, formatted as s3://my-bucket/ (if the files are in the bucket’s root) or s3://my-bucket/my-folder/.
  • For recursive (source connector only), set to true to access subfolders within the bucket. The default is false if not otherwise specified.