Skip to content
Optima docs
ConsoleIntegrationsData connectors

Amazon S3 credentials

The access keys an Amazon S3 connector needs and the bucket permissions behind them.

An Amazon S3 connector signs in with AWS access keys for an IAM user or role that can reach the bucket. Enter them under Credentials in the New connector or Edit connector dialog of Data connectors, after choosing the protocol Amazon S3. Needs the integration_editor role, or another role your administrator has given access to this area — see Licences and roles.

Fields

FieldMeaningValid valuesDefault
Endpoint (connection)The S3 endpoint. Required.For example https://s3.eu-central-1.amazonaws.comEmpty
Region (connection)The bucket's region. Required.For example eu-central-1Empty
Bucket (connection)The bucket. Required.A bucket nameEmpty
Access key idThe IAM access key id. Required.TextEmpty
Secret access keyThe matching secret. Required.TextEmpty
Session tokenOnly for temporary (STS) keys.TextEmpty

Credentials are write-only: once saved they cannot be viewed again, only replaced with Replace credentials. Replacing is complete: the fields you enter fully replace the stored credentials and blank fields are dropped. If your keys are temporary, enter the Session token again every time, or it is lost. Clear stored credentials removes them altogether.

Permissions

An importing connector needs s3:GetObject and s3:ListBucket. An exporting connector also needs s3:PutObject.

How to create the keys

In AWS open IAM → Users → Security credentials → Create access key. Leave Session token empty unless the keys are temporary.

Examples

Reading s3://acme-imports/crm/: Endpoint https://s3.eu-central-1.amazonaws.com, Region eu-central-1, Bucket acme-imports, keys from an IAM user limited to that bucket. Set the folder in the Path pattern on the Schedule tab, for example crm/*.csv.

Common problems

  • Access denied. The user lacks s3:ListBucket or s3:GetObject. An export also needs s3:PutObject.
  • Works for an hour, then fails. Temporary keys expired. Use long-lived keys or refresh them with Replace credentials.
  • Wrong region error. Region and Endpoint must point at the bucket's own region.

On this page