Contact Free trial Login

Amazon S3 Connector Reference - Mule 4

Support Category: Select

Amazon S3 Connector Version 5.4

Anypoint Connector for Amazon S3 (Amazon S3 Connector) provides connectivity to the Amazon S3 API, enabling you to interface with Amazon S3 to store objects, download and use data with other AWS services, and build applications that require internet storage.

Configurations


Configuration

Parameters

Name Type Description Default Value Required

Name

String

The name for this configuration. Connectors reference the configuration with this name.

x

Connection

The connection types to provide to this configuration.

x

Expiration Policy

Configures the minimum amount of time that a dynamic configuration instance can remain idle before Mule considers it eligible for expiration. This does not mean that the platform expires the instance at the exact moment that it becomes eligible. Mule purges the instances as appropriate.

Connection Types

Basic
Parameters
Name Type Description Default Value Required

S3 Compatible Storage URL

String

The URL to connect to in case an S3 compatible storage is used. If blank, the default AWS S3 one will be used.

Connection Timeout

Number

The amount of time to wait (in milliseconds) when initially establishing a connection before the connector gives up and times out. A value of 0 means infinity and is not recommended.

50000

Max Connections

Number

Sets the maximum number of allowed open HTTP connections.

Socket Timeout

Number

The amount of time to wait (in milliseconds) for data to be transferred over an established, open connection before the connection times out. A value of 0 means infinity and is not recommended.

50000

Access Key

String

The access key provided by Amazon.

x

Secret Key

String

The secret key provided by Amazon.

x

Try Default AWSCredentials Provider Chain

Boolean

Set this field to true to obtain credentials from the AWS environment, See: https://docs.aws.amazon.com/sdk-for-java/v2/developer-guide/credentials.html

false

Region Endpoint

String

Set the topic region endpoint.

US_EAST_1

TLS Configuration

TLS

Reconnection

When the application is deployed, a connectivity test is performed on all connectors. If set to true, deployment fails if the test doesn’t pass after exhausting the associated reconnection strategy

Host

String

The optional proxy host.

Port

Number

The optional proxy port.

Username

String

The optional proxy username.

Password

String

The optional proxy password.

Domain

String

The optional proxy domain.

Workstation

String

The optional proxy workstation.

Role
Parameters
Name Type Description Default Value Required

Role ARN

String

The Role ARN unique identifies role to assume to gain cross account access.

x

S3 Compatible Storage URL

String

The URL to connect to in case an S3 compatible storage is used. If blank, the default AWS S3 one will be used.

Connection Timeout

Number

The amount of time to wait (in milliseconds) when initially establishing a connection before the connector gives up and times out. A value of 0 means infinity and is not recommended.

50000

Max Connections

Number

Sets the maximum number of allowed open HTTP connections.

Socket Timeout

Number

The amount of time to wait (in milliseconds) for data to be transferred over an established, open connection before the connection times out. A value of 0 means infinity and is not recommended.

50000

Access Key

String

The access key provided by Amazon.

x

Secret Key

String

The secret key provided by Amazon.

x

Try Default AWSCredentials Provider Chain

Boolean

Set this field to true to obtain credentials from the AWS environment, See: https://docs.aws.amazon.com/sdk-for-java/v2/developer-guide/credentials.html

false

Region Endpoint

String

Set the topic region endpoint.

US_EAST_1

TLS Configuration

TLS

Reconnection

When the application is deployed, a connectivity test is performed on all connectors. If set to true, deployment fails if the test doesn’t pass after exhausting the associated reconnection strategy

Host

String

The optional proxy host.

Port

Number

The optional proxy port.

Username

String

The optional proxy username.

Password

String

The optional proxy password.

Domain

String

The optional proxy domain.

Workstation

String

The optional proxy workstation.

Operations

Associated Sources

Abort Multipart Upload

<s3:abort-multipart-upload>

Aborts a multipart upload.

After a multipart upload is aborted, no additional parts can be uploaded using that upload ID. The storage consumed by any previously uploaded parts will be freed. However, if any part uploads are currently in progress, those part uploads may or may not succeed. As a result, it may be necessary to abort a given multipart upload multiple times to completely free all storage consumed by all parts.

Parameters

Name Type Description Default Value Required

Configuration

String

The name of the configuration to use.

x

Bucket Name

String

The name of the bucket containing the multipart upload to abort.

x

Key

String

The key of the multipart upload to abort.

x

Upload Id

String

The ID of the upload to abort.

x

Reconnection Strategy

A retry strategy in case of connectivity errors.

For Configurations

Throws

Complete Multipart Upload

<s3:complete-multipart-upload>

Completes a multipart upload by assembling previously uploaded parts.

Parameters

Name Type Description Default Value Required

Configuration

String

The name of the configuration to use.

x

Bucket Name

String

The name of the bucket containing the multipart upload to complete.

x

Key

String

The key under which the multipart upload to complete is stored.

x

Upload Id

String

The ID of the multipart upload to complete.

x

Part ETags

Array of Part E Tag

The list of part numbers and ETags that identify the individual parts of the multipart upload to complete.

#[payload]

Target Variable

String

The name of a variable to store the operation’s output.

Target Value

String

An expression to evaluate against the operation’s output and store the expression outcome in the target variable

#[payload]

Reconnection Strategy

A retry strategy in case of connectivity errors.

For Configurations

Throws

Copy Object

<s3:copy-object>

Copies a source object to a new destination.

To copy an object, the caller’s account must have read access to the source object and write access to the destination bucket. By default, all object metadata for the source object are copied to the new destination object, unless new object metadata in the specified is provided.

The AccessControlList is not copied to the new object, and, unless another ACL specified, PRIVATE is assumed. If no destination bucket is specified, the same that the source bucket is used - local copy. Destination object’s Content-Type HTTP header would be set with the specified value and if it is passed null, then the default MIME type application/octet-stream would be set.

Parameters

Name Type Description Default Value Required

Configuration

String

The name of the configuration to use.

x

Source Bucket Name

String

The source object’s bucket

x

Source Key

String

The source object’s key

x

Source Version Id

String

The specific version of the source object to copy, if versioning is enabled. Left unspecified if the latest version is desired, or versioning is not enabled.

Destination Bucket Name

String

The destination object’s bucket. If none provided, a local copy is performed, that is, it is copied within the same bucket.

Destination Key

String

The destination object’s key

x

Canned ACL

Enumeration, one of:

  • AUTHENTICATED_READ

  • BUCKET_OWNER_FULL_CONTROL

  • BUCKET_OWNER_READ

  • LOG_DELIVERY_WRITE

  • PRIVATE

  • PUBLIC_READ

  • PUBLIC_READ_WRITE

The ACL of the destination object.

PRIVATE

Destination Storage Class

Enumeration, one of:

  • GLACIER

  • INTELLIGENT_TIERING

  • ONEZONE_IA

  • REDUCED_REDUNDANCY

  • STANDARD

  • STANDARD_IA

one of StorageClass enumerated values, defaults to StorageClass#STANDARD

STANDARD

Destination User Metadata

Object

The new metadata of the destination object, that if specified, overrides that copied from the source object

Modified Since

DateTime

The modified constraint that restricts this request to executing only if the object has been modified after the specified date. This constraint is specified but does not match, no copy is performed

Unmodified Since

DateTime

The unmodified constraint that restricts this request to executing only if the object has not been modified after this date. This constraint is specified but does not match, no copy is performed

Encryption

String

Encryption method for server-side encryption. Supported value AES256.

Content Type

String

The destination object’s Content-Type HTTP header

Target Variable

String

The name of a variable to store the operation’s output.

Target Value

String

An expression to evaluate against the operation’s output and store the expression outcome in the target variable

#[payload]

Reconnection Strategy

A retry strategy in case of connectivity errors.

Output

Type

For Configurations

Throws

Create Bucket

<s3:create-bucket>

Creates a new bucket. The connector must not be configured as anonymous for this operation to succeed.

Bucket names must be unique across all of Amazon S3, that is, among all their users. Bucket ownership is similar to the ownership of Internet domain names. Within Amazon S3, only a single user owns each bucket. Once a uniquely named bucket is created in Amazon S3, organize and name the objects within the bucket in any way. Ownership of the bucket is retained as long as the owner has an Amazon S3 account.

To conform with DNS requirements, buckets names must: not contain underscores, be between 3 and 63 characters long, not end with a dash, not contain adjacent periods, not contain dashes next to periods and not contain uppercase characters.

Do not make bucket create or delete calls in the high availability code path of an application. Create or delete buckets in a separate initialization or setup.

Parameters

Name Type Description Default Value Required

Configuration

String

The name of the configuration to use.

x

Bucket Name

String

The bucket to create. It must not exist yet.

x

Region

Enumeration, one of:

  • AP_MUMBAI

  • AP_OSAKA_LOCAL

  • AP_SEOUL

  • AP_SINGAPORE

  • AP_SYDNEY

  • AP_TOKYO

  • CA_CENTRAL

  • CN_BEIJING

  • CN_Northwest_1

  • EU_FRANKFURT

  • EU_IRELAND

  • EU_LONDON

  • EU_NORTH_1

  • EU_PARIS

  • SA_SAOPAULO

  • US_EAST_2

  • US_GOVCLOUD

  • US_STANDARD

  • US_WEST

  • US_WEST_2

The region where to create the new bucket

US_STANDARD

Canned ACL

Enumeration, one of:

  • AUTHENTICATED_READ

  • BUCKET_OWNER_FULL_CONTROL

  • BUCKET_OWNER_READ

  • LOG_DELIVERY_WRITE

  • PRIVATE

  • PUBLIC_READ

  • PUBLIC_READ_WRITE

The access control list of the new bucket

PRIVATE

Target Variable

String

The name of a variable to store the operation’s output.

Target Value

String

An expression to evaluate against the operation’s output and store the expression outcome in the target variable

#[payload]

Reconnection Strategy

A retry strategy in case of connectivity errors.

Output

Type

For Configurations

Throws

Create Object

<s3:create-object>

Uploads an object to S3. Supported contents are InputStreams, Strings, byte arrays, and Files.

Parameters

Name Type Description Default Value Required

Configuration

String

The name of the configuration to use.

x

Bucket Name

String

The object’s bucket

x

Key

String

The object’s key

x

Object Content

Binary

The content to be uploaded to S3, capable of creating a PutObjectRequest.

#[payload]

Canned ACL

Enumeration, one of:

  • AUTHENTICATED_READ

  • BUCKET_OWNER_FULL_CONTROL

  • BUCKET_OWNER_READ

  • LOG_DELIVERY_WRITE

  • PRIVATE

  • PUBLIC_READ

  • PUBLIC_READ_WRITE

The access control list of the new object

PRIVATE

Kms Master Key

String

Encrypt objects uploaded to S3 buckets with AWS KMS master key

User Metadata

Object

Last Modified

DateTime

Content Length

Number

The Content-Length HTTP header indicating the size of the associated object in bytes.

0

Content Type

String

The Content-Type HTTP header indicating the type of content stored in the associated object.

Content Language

String

The Content-Language HTTP header which describes the natural language(s) of the intended audience for the enclosed entity.

Content Encoding

String

The optional Content-Encoding HTTP header specifying what content encodings have been applied to the object and what decoding mechanisms must be applied to obtain the media-type referenced by the Content-Type field.

Cache Control

String

The optional Cache-Control HTTP header which allows the user to specify caching behavior along the HTTP request/reply chain.

Content MD5

String

The base64 encoded 128-bit MD5 digest of the associated object (content - not including headers) according to RFC 1864.

Content Disposition

String

The optional Content-Disposition HTTP header, which specifies presentational information such as the recommended filename for the object to be saved as.

Etag

String

The entity tag is a hash of the object.

Version Id

String

The version ID of the associated Amazon S3 object if available.

Sse Algorithm

String

Specifies the server-side encryption algorithm to use when Amazon S3 creates an object.

Sse Customer Algorithm

String

Specifies the algorithm to use to when encrypting the object.

Sse Customer Key Md5

String

Specifies the base64-encoded 128-bit MD5 digest of the encryption key according to RFC 1321. Amazon S3 uses this header for a message integrity check to ensure that the encryption key was transmitted without error.

Expiration Time

DateTime

The expiration time for the object.

Expiration Time Rule Id

String

The rule ID of object’s expiration configuration.

Restore Expiration Time

DateTime

The new restore expiration time for the object.

Ongoing Restore

Boolean

Sets the boolean value which indicates whether there is ongoing restore request.

false

Http Expires Date

DateTime

Set the date when the object is no longer cacheable.

Storage Class

Enumeration, one of:

  • GLACIER

  • INTELLIGENT_TIERING

  • ONEZONE_IA

  • REDUCED_REDUNDANCY

  • STANDARD

  • STANDARD_IA

The storage class of the object.

STANDARD

Sse Aws Kms Key Id

String

The AWS Key Management System key ID used for Server Side Encryption of the Amazon S3 object.

Requester Charged

Boolean

If a bucket is enabled for Requester Pays, then any attempt of operation from it without Requester Pays enabled will result in a 403 error and the bucket owner will be charged for the request. Enabling Requester Pays disables the ability to have anonymous access to bucket.

false

Replication Status

String

The replication status of the object if it is from a bucket that is the source or destination in a cross-region replication.

Target Variable

String

The name of a variable to store the operation’s output.

Target Value

String

An expression to evaluate against the operation’s output and store the expression outcome in the target variable

#[payload]

Reconnection Strategy

A retry strategy in case of connectivity errors.

Output

Type

For Configurations

Throws

Create Object Presigned URI

<s3:create-object-presigned-uri>

Returns a presigned URL for accessing an Amazon S3 object. The presigned URL can be shared to other users, allowing access to the resource without providing an account’s AWS security credentials.

Parameters

Name Type Description Default Value Required

Configuration

String

The name of the configuration to use.

x

Bucket Name

String

The name of the bucket involved in this request.

x

Key

String

The key of the object involved in this request.

x

Expiration

DateTime

The expiration date at which point the new presigned URL will no longer be accepted by Amazon S3.

Content MD5

String

The expected content-md5 header of the request.

Content Type

String

The expected content-type of the request.

Method

Enumeration, one of:

  • GET

  • POST

  • PUT

  • DELETE

  • HEAD

  • PATCH

The HTTP method (GET, PUT, DELETE, HEAD) to use in this request.

PUT

Sse S3 Encryption

Enumeration, one of:

  • AES256

  • KMS

The encryption method (KMS, AES256) to use for the presigned URL.

Target Variable

String

The name of a variable to store the operation’s output.

Target Value

String

An expression to evaluate against the operation’s output and store the expression outcome in the target variable

#[payload]

Reconnection Strategy

A retry strategy in case of connectivity errors.

Output

Type

String

For Configurations

Throws

Delete Bucket

<s3:delete-bucket>

Deletes the specified bucket. All objects (and all object versions, if versioning was ever enabled) in the bucket must be deleted before the bucket itself can be deleted; this restriction can be relaxed by specifying the attribute force="true".

Parameters

Name Type Description Default Value Required

Configuration

String

The name of the configuration to use.

x

Bucket Name

String

The bucket to delete

x

Force

Boolean

optional true if the bucket must be deleted even if it is not empty, false if operation should fail in such scenario.

false

Reconnection Strategy

A retry strategy in case of connectivity errors.

For Configurations

Throws

Delete Bucket CORS Configuration

<s3:delete-bucket-cors-configuration>

Deletes the cross origin configuration (CORS) information set for the bucket.

To use this operation, you must have permission to perform the s3:PutCORSConfiguration action. The bucket owner has this permission by default and can grant this permission to others.

Parameters

Name Type Description Default Value Required

Configuration

String

The name of the configuration to use.

x

Bucket Name

String

The bucket to delete Cross Origin Configuration.

x

Reconnection Strategy

A retry strategy in case of connectivity errors.

For Configurations

Throws

Delete Bucket Lifecycle Configuration

<s3:delete-bucket-lifecycle-configuration>

Deletes the lifecycle configuration from the specified bucket.

Amazon S3 removes all the lifecycle configuration rules in the lifecycle subresource associated with the bucket.

Your objects never expire, and Amazon S3 no longer automatically deletes any objects on the basis of rules contained in the deleted lifecycle configuration.

Parameters

Name Type Description Default Value Required

Configuration

String

The name of the configuration to use.

x

Bucket Name

String

The bucket whose lifecycle configuration to delete.

x

Reconnection Strategy

A retry strategy in case of connectivity errors.

For Configurations

Throws

Delete Bucket Policy

<s3:delete-bucket-policy>

Deletes the bucket’s policy.

Only the owner of the bucket can delete the bucket policy.

Bucket policies provide access control management at the bucket level for both the bucket resource and contained object resources.

Parameters

Name Type Description Default Value Required

Configuration

String

The name of the configuration to use.

x

Bucket Name

String

The bucket whose policy to delete

x

Reconnection Strategy

A retry strategy in case of connectivity errors.

For Configurations

Throws

Delete Bucket Tagging Configuration

<s3:delete-bucket-tagging-configuration>

Deletes the tagging configuration associated with the specified bucket.

By default, the bucket owner has this permission and can grant this permission to others.

Parameters

Name Type Description Default Value Required

Configuration

String

The name of the configuration to use.

x

Bucket Name

String

The bucket whose tag to delete.

x

Reconnection Strategy

A retry strategy in case of connectivity errors.

For Configurations

Throws

Delete Bucket Website Configuration

<s3:delete-bucket-website-configuration>

Removes the website configuration for a bucket.

This operation requires the DeleteBucketWebsite permission. By default, only the bucket owner can delete the website configuration attached to a bucket. However, bucket owners can grant other users permission to delete the website configuration by writing a bucket policy granting them the S3:DeleteBucketWebsite permission.

Calling this operation on a bucket with no website configuration does not fail, but calling this operation a bucket that does not exist does.

Parameters

Name Type Description Default Value Required

Configuration

String

The name of the configuration to use.

x

Bucket Name

String

The bucket whose website configuration to delete

x

Reconnection Strategy

A retry strategy in case of connectivity errors.

For Configurations

Throws

Delete Object

<s3:delete-object>

Deletes a given object.

Only the owner of the bucket containing the version can perform this operation. If a version is specified, versioning must be enabled, and once deleted, there is no method to restore such version. Otherwise, once deleted, the object can only be restored if versioning was enabled when the object was deleted.

If attempting to delete an object that does not exist, Amazon S3 returns a success message instead of an error message.

Parameters

Name Type Description Default Value Required

Configuration

String

The name of the configuration to use.

x

Bucket Name

String

The object’s bucket

x

Key

String

The object’s key

x

Version Id

String

The specific version of the object to delete, if versioning is enabled.

Reconnection Strategy

A retry strategy in case of connectivity errors.

For Configurations

Throws

Delete Objects

<s3:delete-objects>

Deletes multiple objects in a single bucket from S3. Version of the keys is optional.

In some cases, some objects will be successfully deleted, while some attempts will cause an error. If any object in the request cannot be deleted, this method throws a com.amazonaws.services.s3.model.MultiObjectDeleteException with details of the error.

Parameters

Name Type Description Default Value Required

Configuration

String

The name of the configuration to use.

x

Bucket Name

String

The objects bucket name

x

Keys

Array of Key Version

The objects keys, version is optional

x

Reconnection Strategy

A retry strategy in case of connectivity errors.

For Configurations

Throws

Get Bucket ACL

<s3:get-bucket-acl>

Answers the access control list of the specified bucket.

Parameters

Name Type Description Default Value Required

Configuration

String

The name of the configuration to use.

x

Bucket Name

String

The bucket whose ACL to retrieve.

x

Target Variable

String

The name of a variable to store the operation’s output.

Target Value

String

An expression to evaluate against the operation’s output and store the expression outcome in the target variable

#[payload]

Reconnection Strategy

A retry strategy in case of connectivity errors.

Output

Type

Array of Grant

Attributes Type

For Configurations

Throws

Get Bucket CORS Configuration

<s3:get-bucket-cors-configuration>

Answers the cross origin configuration (CORS) configuration information set for the bucket.

Parameters

Name Type Description Default Value Required

Configuration

String

The name of the configuration to use.

x

Bucket Name

String

The bucket whose CORS to retrieve.

x

Target Variable

String

The name of a variable to store the operation’s output.

Target Value

String

An expression to evaluate against the operation’s output and store the expression outcome in the target variable

#[payload]

Reconnection Strategy

A retry strategy in case of connectivity errors.

Output

Type

Array of CORS Rule

For Configurations

Throws

Get Bucket Lifecycle Configuration

<s3:get-bucket-lifecycle-configuration>

Returns the lifecycle configuration information set on the bucket.

Parameters

Name Type Description Default Value Required

Configuration

String

The name of the configuration to use.

x

Bucket Name

String

The bucket whose lifecycle configuration information to retrieve.

x

Target Variable

String

The name of a variable to store the operation’s output.

Target Value

String

An expression to evaluate against the operation’s output and store the expression outcome in the target variable

#[payload]

Reconnection Strategy

A retry strategy in case of connectivity errors.

Output

Type

Array of BLC Rule

For Configurations

Throws

Get Bucket Location

<s3:get-bucket-location>

Gets the geographical region where Amazon S3 stores the specified bucket.

Parameters

Name Type Description Default Value Required

Configuration

String

The name of the configuration to use.

x

Bucket Name

String

The target bucket name.

x

Target Variable

String

The name of a variable to store the operation’s output.

Target Value

String

An expression to evaluate against the operation’s output and store the expression outcome in the target variable

#[payload]

Reconnection Strategy

A retry strategy in case of connectivity errors.

Output

Type

String

For Configurations

Throws

Get Bucket Logging Configuration

<s3:get-bucket-logging-configuration>

Answers the logging status of a bucket and the permissions users have to view and modify that status.

Parameters

Name Type Description Default Value Required

Configuration

String

The name of the configuration to use.

x

Bucket Name

String

The bucket whose logging status to retrieve.

x

Target Variable

String

The name of a variable to store the operation’s output.

Target Value

String

An expression to evaluate against the operation’s output and store the expression outcome in the target variable

#[payload]

Reconnection Strategy

A retry strategy in case of connectivity errors.

For Configurations

Throws

Get Bucket Notification Configuration

<s3:get-bucket-notification-configuration>

Returns the notification configuration of a bucket. Currently only topic configuration is supported.

Parameters

Name Type Description Default Value Required

Configuration

String

The name of the configuration to use.

x

Bucket Name

String

The bucket whose notification configuration to retrieve.

x

Target Variable

String

The name of a variable to store the operation’s output.

Target Value

String

An expression to evaluate against the operation’s output and store the expression outcome in the target variable

#[payload]

Reconnection Strategy

A retry strategy in case of connectivity errors.

Output

Type

Object

For Configurations

Throws

Get Bucket Policy

<s3:get-bucket-policy>

Answers the policy for the given bucket. Only the owner of the bucket can retrieve it. If no policy has been set for the bucket, then a null policy text field will be returned.

Parameters

Name Type Description Default Value Required

Configuration

String

The name of the configuration to use.

x

Bucket Name

String

The bucket whose policy to retrieve

x

Target Variable

String

The name of a variable to store the operation’s output.

Target Value

String

An expression to evaluate against the operation’s output and store the expression outcome in the target variable

#[payload]

Reconnection Strategy

A retry strategy in case of connectivity errors.

Output

Type

String

For Configurations

Throws

Get Bucket Tagging Configuration

<s3:get-bucket-tagging-configuration>

Returns the tag set associated with the bucket.

Parameters

Name Type Description Default Value Required

Configuration

String

The name of the configuration to use.

x

Bucket Name

String

The bucket whose tagging configuration to retrieve.

x

Target Variable

String

The name of a variable to store the operation’s output.

Target Value

String

An expression to evaluate against the operation’s output and store the expression outcome in the target variable

#[payload]

Reconnection Strategy

A retry strategy in case of connectivity errors.

Output

Type

Array of Object

For Configurations

Throws

Get Bucket Versioning Configuration

<s3:get-bucket-versioning-configuration>

Returns the versioning configuration for the specified bucket.

Parameters

Name Type Description Default Value Required

Configuration

String

The name of the configuration to use.

x

Bucket Name

String

The bucket whose versioning configuration will be retrieved.

x

Target Variable

String

The name of a variable to store the operation’s output.

Target Value

String

An expression to evaluate against the operation’s output and store the expression outcome in the target variable

#[payload]

Reconnection Strategy

A retry strategy in case of connectivity errors.

Output

Type

Enumeration, one of:

  • OFF

  • ENABLED

  • SUSPENDED

For Configurations

Throws

Get Bucket Website Configuration

<s3:get-bucket-website-configuration>

Answers the website of the given bucket. This operation requires the GetBucketWebsite permission.

By default, only the bucket owner can read the bucket website configuration. However, bucket owners can allow other users to read the website configuration by writing a bucket policy granting them the GetBucketWebsite permission.

Parameters

Name Type Description Default Value Required

Configuration

String

The name of the configuration to use.

x

Bucket Name

String

The target bucket’s name

x

Target Variable

String

The name of a variable to store the operation’s output.

Target Value

String

An expression to evaluate against the operation’s output and store the expression outcome in the target variable

#[payload]

Reconnection Strategy

A retry strategy in case of connectivity errors.

For Configurations

Throws

Get Object

<s3:get-object>

Gets the object stored in Amazon S3 under the specified bucket and key. Returns null if the specified constraints weren’t met. To get an object from Amazon S3, the caller must have com.amazonaws.services.s3.model.Permission#Read access to the object.

Callers should be very careful when using this method; the returned Amazon S3 object contains a direct stream of data from the HTTP connection. The underlying HTTP connection cannot be closed until the user finishes reading the data and closes the stream.

Regarding conditional get constraints, Amazon S3 will ignore any dates occurring in the future.

Parameters

Name Type Description Default Value Required

Configuration

String

The name of the configuration to use.

x

Bucket Name

String

The object’s bucket

x

Key

String

The object’s key

x

Version Id

String

The specific version of the object to get its contents, if versioning is enabled. Left unspecified if the latest version is desired, or versioning is not enabled.

Modified Since

DateTime

The modified constraint that restricts this request to executing only if the object has been modified after the specified date.

Unmodified Since

DateTime

The unmodified constraint that restricts this request to executing only if the object has not been modified after this date.

Output Mime Type

String

The mime type of the payload that this operation outputs.

Output Encoding

String

The encoding of the payload that this operation outputs.

Streaming Strategy

Configure to use repeatable streams.

Target Variable

String

The name of a variable to store the operation’s output.

Target Value

String

An expression to evaluate against the operation’s output and store the expression outcome in the target variable

#[payload]

Reconnection Strategy

A retry strategy in case of connectivity errors.

Output

Type

Binary

Attributes Type

For Configurations

Throws

Get Object ACL

<s3:get-object-acl>

Returns the access control list (ACL) of an object. By default, GET returns ACL information about the current version of an object. To return ACL information about a different version, use the versionId attribute.

Parameters

Name Type Description Default Value Required

Configuration

String

The name of the configuration to use.

x

Bucket Name

String

The object’s bucket

x

Key

String

The object’s key

x

Version Id

String

The object’s version id

Target Variable

String

The name of a variable to store the operation’s output.

Target Value

String

An expression to evaluate against the operation’s output and store the expression outcome in the target variable

#[payload]

Reconnection Strategy

A retry strategy in case of connectivity errors.

Output

Type

Array of Grant

Attributes Type

For Configurations

Throws

Get Object Metadata

<s3:get-object-metadata>

Gets only the object metadata stored in Amazon S3 under the specified bucket and key. To get an object metadata from Amazon S3, the caller must have com.amazonaws.services.s3.model.Permission#Read access to the object.

Parameters

Name Type Description Default Value Required

Configuration

String

The name of the configuration to use.

x

Bucket Name

String

The object’s bucket

x

Key

String

The object’s key

x

Version Id

String

The specific version of the object to get its contents, if versioning is enabled. Left unspecified if the latest version is desired, or versioning is not enabled.

Target Variable

String

The name of a variable to store the operation’s output.

Target Value

String

An expression to evaluate against the operation’s output and store the expression outcome in the target variable

#[payload]

Reconnection Strategy

A retry strategy in case of connectivity errors.

For Configurations

Throws

Initiate Multipart Upload

<s3:initiate-multipart-upload>

Initiates a multipart upload and returns an upload ID. This upload ID is used to associate all the parts in the specific multipart upload. You specify this upload ID in each of your subsequent upload part requests. You also include this upload ID in the final request to either complete or abort the multipart upload request.

Parameters

Name Type Description Default Value Required

Configuration

String

The name of the configuration to use.

x

Bucket Name

String

The name of the bucket in which to create the new multipart upload.

x

Key

String

The key by which to store the new multipart upload.

x

Object Metadata

The additional information about the new object being created, such as content type, content encoding, user metadata, etc.

Canned ACL

Enumeration, one of:

  • AUTHENTICATED_READ

  • BUCKET_OWNER_FULL_CONTROL

  • BUCKET_OWNER_READ

  • LOG_DELIVERY_WRITE

  • PRIVATE

  • PUBLIC_READ

  • PUBLIC_READ_WRITE

The optional canned Access Control List (ACL) to set permissions for the new object created when the multipart upload is completed.

PRIVATE

Redirect Location

String

Gets the optional redirect location for the new object.

Target Variable

String

The name of a variable to store the operation’s output.

Target Value

String

An expression to evaluate against the operation’s output and store the expression outcome in the target variable

#[payload]

Reconnection Strategy

A retry strategy in case of connectivity errors.

Output

Type

String

For Configurations

Throws

List Buckets

<s3:list-buckets>

Answers a list of all Amazon S3 buckets that the authenticated sender of the request owns. Users must authenticate with a valid AWS Access Key ID that is registered with Amazon S3. Anonymous requests cannot list buckets, and users cannot list buckets that they did not create.

Parameters

Name Type Description Default Value Required

Configuration

String

The name of the configuration to use.

x

Region

Enumeration, one of:

  • AP_MUMBAI

  • AP_OSAKA_LOCAL

  • AP_SEOUL

  • AP_SINGAPORE

  • AP_SYDNEY

  • AP_TOKYO

  • CA_CENTRAL

  • CN_BEIJING

  • CN_Northwest_1

  • EU_FRANKFURT

  • EU_IRELAND

  • EU_LONDON

  • EU_NORTH_1

  • EU_PARIS

  • SA_SAOPAULO

  • US_EAST_2

  • US_GOVCLOUD

  • US_STANDARD

  • US_WEST

  • US_WEST_2

The region from where to list the buckets.

Target Variable

String

The name of a variable to store the operation’s output.

Target Value

String

An expression to evaluate against the operation’s output and store the expression outcome in the target variable

#[payload]

Reconnection Strategy

A retry strategy in case of connectivity errors.

Output

Type

Array of Bucket

For Configurations

Throws

List Multipart Uploads

<s3:list-multipart-uploads>

Lists in-progress multipart uploads. An in-progress multipart upload is a multipart upload that has been initiated, using the InitiateMultipartUpload request, but has not yet been completed or aborted.

Parameters

Name Type Description Default Value Required

Configuration

String

The name of the configuration to use.

x

Bucket Name

String

The name of the bucket containing the uploads to list.

x

Delimiter

String

The optional delimiter parameter that causes multipart uploads for keys that contain the same string between the prefix and the first occurrence of the delimiter to be combined into a single result element

Encoding Type

String

The optional encodingType parameter indicating the encoding method to be applied on the response.

Key Marker

String

The optional key marker indicating where in the results to begin listing.

Max Uploads

Number

The optional maximum number of uploads to return, or null if no maximum number of uploads has been set for this request.

Prefix

String

The optional prefix parameter that restricts the response to multipart uploads for keys that begin with the specified prefix.

Upload Id Marker

String

The optional upload ID marker indicating where in the results to begin listing.

Target Variable

String

The name of a variable to store the operation’s output.

Target Value

String

An expression to evaluate against the operation’s output and store the expression outcome in the target variable

#[payload]

Reconnection Strategy

A retry strategy in case of connectivity errors.

For Configurations

Throws

List Objects

<s3:list-objects>

Lazily lists all objects for a given prefix. As S3 does not limit in any way the number of objects. Such a listing can retrieve an arbitrary amount of objects, and may need to perform extra calls to the API while it is iterated.

Parameters

Name Type Description Default Value Required

Configuration

String

The name of the configuration to use.

x

Bucket Name

String

The target bucket’s name

x

Prefix

String

The prefix of the objects to be listed. If unspecified, all objects are listed

Marker

String

where in the bucket to begin listing. The list will only include keys that occur lexicographically after the marker

Delimiter

String

causes keys that contain the same string between a prefix and the first occurrence of the delimiter to be rolled up into a single result element. These rolled-up keys are not returned elsewhere in the response. The most commonly used delimiter is "/", which simulates a hierarchical organization similar to a file system directory structure.

Max Keys

Number

The maximum number of keys to include in the response. If maxKeys is not specified, Amazon S3 will limit the number of results in the response.

Encoding Type

Enumeration, one of:

  • NOT_ENCODED

  • URL

The encoding method to be applied on the response.

NOT_ENCODED

Streaming Strategy

Configure to use repeatable streams.

Target Variable

String

The name of a variable to store the operation’s output.

Target Value

String

An expression to evaluate against the operation’s output and store the expression outcome in the target variable

#[payload]

Reconnection Strategy

A retry strategy in case of connectivity errors.

Output

Type

For Configurations

Throws

List Parts

<s3:list-parts>

Lists the parts that have been uploaded for a specific multipart upload.

Parameters

Name Type Description Default Value Required

Configuration

String

The name of the configuration to use.

x

Bucket Name

String

The name of the bucket containing the multipart upload whose parts are being listed.

x

Key

String

The key of the associated multipart upload whose parts are being listed.

x

Upload Id

String

The ID of the multipart upload whose parts are being listed.

x

Encoding Type

String

The optional encodingType parameter indicating the encoding method to be applied on the response.

Max Parts

Number

The optional maximum number of parts to be returned in the part listing.

Part Number Marker

Number

The optional part number marker indicating where in the results to being listing parts.

Target Variable

String

The name of a variable to store the operation’s output.

Target Value

String

An expression to evaluate against the operation’s output and store the expression outcome in the target variable

#[payload]

Reconnection Strategy

A retry strategy in case of connectivity errors.

Output

Type

For Configurations

Throws

List Versions

<s3:list-versions>

Lazily lists all object versions for a given bucket that has versioning enabled. As S3 does not limit in any way the number of objects, such listing can retrieve an arbitrary amount of object versions, and may need to perform extra calls to the api while it is iterated.

Parameters

Name Type Description Default Value Required

Configuration

String

The name of the configuration to use.

x

Bucket Name

String

The target bucket’s name

x

Prefix

String

optional parameter restricting the response to keys which begin with the specified prefix. You can use prefixes to separate a bucket into different sets of keys in a way similar to how a file system uses folders.

Key Marker

String

Where in the sorted list of all versions in the specified bucket to begin returning results. Results are always ordered first lexicographically (that is, alphabetically) and then from most recent version to least recent version. If a keyMarker is used without a versionIdMarker, results begin immediately after that key’s last version. When a keyMarker is used with a versionIdMarker, results begin immediately after the version with the specified key and version ID.

Version Id Marker

String

Where in the sorted list of all versions in the specified bucket to begin returning results. Results are always ordered first lexicographically (that is, alphabetically) and then from most recent version to least recent version. A keyMarker must be specified when specifying a versionIdMarker. Results begin immediately after the version with the specified key and version ID.

Delimiter

String

causes keys that contain the same string between the prefix and the first occurrence of the delimiter to be rolled up into a single result element in the list. These rolled-up keys are not returned elsewhere in the response. The most commonly used delimiter is "/", which simulates a hierarchical organization similar to a file system directory structure.

Max Results

Number

The maximum number of results to include in the response.

Encoding Type

Enumeration, one of:

  • NOT_ENCODED

  • URL

The encoding method to be applied on the response. An object key can contain any Unicode character; however, XML 1.0 parser cannot parse some characters, such as characters with an ASCII value from 0 to 10. For characters that are not supported in XML 1.0, you can add this parameter to request that Amazon S3 encode the keys in the response.

NOT_ENCODED

Streaming Strategy

Configure to use repeatable streams.

Target Variable

String

The name of a variable to store the operation’s output.

Target Value

String

An expression to evaluate against the operation’s output and store the expression outcome in the target variable

#[payload]

Reconnection Strategy

A retry strategy in case of connectivity errors.

Output

Type

For Configurations

Throws

Set Bucket ACL

<s3:set-bucket-acl>

Set the permissions on an existing bucket using access control lists (ACL).

Parameters

Name Type Description Default Value Required

Configuration

String

The name of the configuration to use.

x

Bucket Name

String

The bucket name

x

Owner

The owner of the ACL.

x

Grants

Array of Grant

The grants of the ACL.

#[payload]

Reconnection Strategy

A retry strategy in case of connectivity errors.

For Configurations

Throws

Set Bucket CORS Configuration

<s3:set-bucket-cors-configuration>

Sets the cross origin configuration (CORS) configuration for your bucket. If the configuration exists, Amazon S3 replaces it.

Parameters

Name Type Description Default Value Required

Configuration

String

The name of the configuration to use.

x

Bucket Name

String

The bucket name

x

Rules

Array of CORS Rule

The cross-origin rules of a bucket.

#[payload]

Reconnection Strategy

A retry strategy in case of connectivity errors.

For Configurations

Throws

Set Bucket Lifecycle Configuration

<s3:set-bucket-lifecycle-configuration>

Creates a new lifecycle configuration for the bucket or replaces an existing lifecycle configuration.

Parameters

Name Type Description Default Value Required

Configuration

String

The name of the configuration to use.

x

Bucket Name

String

The bucket name

x

Lifecycle Configuration Rules

Array of BLC Rule

The lifecycle configuration rules of a bucket.

#[payload]

Reconnection Strategy

A retry strategy in case of connectivity errors.

For Configurations

Throws

Set Bucket Logging Configuration

<s3:set-bucket-logging-configuration>

Set the logging parameters for a bucket and to specify permissions for who can view and modify the logging parameters.

Parameters

Name Type Description Default Value Required

Configuration

String

The name of the configuration to use.

x

Bucket Name

String

The bucket name.

x

Bucket Logging Configuration

The bucket logging configuration.

#[payload]

Reconnection Strategy

A retry strategy in case of connectivity errors.

For Configurations

Throws

Set Bucket Notification Configuration

<s3:set-bucket-notification-configuration>

Sets the notification configuration for the specified bucket. By default, new buckets have no notification configuration set.

Parameters

Name Type Description Default Value Required

Configuration

String

The name of the configuration to use.

x

Bucket Name

String

The name of the Amazon S3 bucket whose notification configuration is being set.

x

Topic Configurations

Object

The request object containing all options for setting the bucket notification configuration.

#[payload]

Reconnection Strategy

A retry strategy in case of connectivity errors.

For Configurations

Throws

Set Bucket Policy

<s3:set-bucket-policy>

Sets the bucket’s policy, overriding any previously set. Only the owner of the bucket can set a bucket policy. Bucket policies provide access control management at the bucket level for both the bucket resource and contained object resources. Only one policy can be specified per-bucket.

Parameters

Name Type Description Default Value Required

Configuration

String

The name of the configuration to use.

x

Bucket Name

String

The bucket name

x

Policy Text

String

The policy text

#[payload]

Reconnection Strategy

A retry strategy in case of connectivity errors.

For Configurations

Throws

Set Bucket Tagging Configuration

<s3:set-bucket-tagging-configuration>

Add a set of tags to an existing bucket.

Parameters

Name Type Description Default Value Required

Configuration

String

The name of the configuration to use.

x

Bucket Name

String

The bucket name

x

Tag Sets

Array of Object

A set of tags

#[payload]

Reconnection Strategy

A retry strategy in case of connectivity errors.

For Configurations

Throws

Set Bucket Versioning Configuration

<s3:set-bucket-versioning-configuration>

Sets the versioning status for the given bucket. A bucket’s versioning configuration can be in one of three possible states: Off, Enabled and Suspended. By default, new buckets are in the Off state. Once versioning is enabled for a bucket the status can never be reverted to Off.

Parameters

Name Type Description Default Value Required

Configuration

String

The name of the configuration to use.

x

Bucket Name

String

The bucket name

x

Versioning Status

Enumeration, one of:

  • OFF

  • ENABLED

  • SUSPENDED

The configuration to set.

#[payload]

Reconnection Strategy

A retry strategy in case of connectivity errors.

For Configurations

Throws

Set Bucket Website Configuration

<s3:set-bucket-website-configuration>

Sets the given bucket’s website configuration. This operation requires the PutBucketWebsite permission. By default, only the bucket owner can configure the website attached to a bucket. However, bucket owners can allow other users to set the website configuration by writing a bucket policy granting them the S3:PutBucketWebsite permission.

Parameters

Name Type Description Default Value Required

Configuration

String

The name of the configuration to use.

x

Bucket Name

String

The bucket name

x

Bucket Website Configuration

The bucket website configuration

#[payload]

Reconnection Strategy

A retry strategy in case of connectivity errors.

For Configurations

Throws

Set Object ACL

<s3:set-object-acl>

Sets the access control list (ACL) permissions for an object that already exists in a bucket

Parameters

Name Type Description Default Value Required

Configuration

String

The name of the configuration to use.

x

Bucket Name

String

The object’s bucket name

x

Key

String

The object’s key

x

Version Id

String

The specific version of the object

Owner

The owner of the ACL

x

Grants

Array of Grant

The Grants of the ACL

#[payload]

Reconnection Strategy

A retry strategy in case of connectivity errors.

For Configurations

Throws

Set Object Storage Class

<s3:set-object-storage-class>

Sets the Amazon S3 storage class for the given object. Changing the storage class of an object in a bucket that has enabled versioning creates a new version of the object with the new storage class. The existing version of the object preservers the previous storage class.

Parameters

Name Type Description Default Value Required

Configuration

String

The name of the configuration to use.

x

Bucket Name

String

The object’s bucket name

x

Key

String

The object’s key

x

Storage Class

Enumeration, one of:

  • STANDARD

  • STANDARD_IA

  • INTELLIGENT_TIERING

  • ONEZONE_IA

  • REDUCED_REDUNDANCY

  • GLACIER

The storage class to set

STANDARD

Reconnection Strategy

A retry strategy in case of connectivity errors.

For Configurations

Throws

Upload Part

<s3:upload-part>

Uploads a part in a multipart upload. You must initiate a multipart upload before you can upload any part.

Parameters

Name Type Description Default Value Required

Configuration

String

The name of the configuration to use.

x

Bucket Name

String

The name of the bucket containing the existing, initiated multipart upload, with which this new part will be associated.

x

Key

String

The key of the initiated multipart upload.

x

Upload Id

String

The ID of the existing, initiated multipart upload with which this new part will be associated.

x

Part Number

Number

The part number describing this part’s position relative to the other parts in the multipart upload.

x

Part Size

Number

The size of this part, in bytes.

x

Md5 Digest

String

optional, but recommended, MD5 hash of the content of this part.

Content

Binary

The stream containing the data to upload for the new part.

#[payload]

File Offset

Number

The optional offset in the specified file, at which to begin uploading data for this part.

Is Last Part

Boolean

True if the creator of this request has indicated this part is the last part being uploaded in a multipart upload.

false

Target Variable

String

The name of a variable to store the operation’s output.

Target Value

String

An expression to evaluate against the operation’s output and store the expression outcome in the target variable

#[payload]

Reconnection Strategy

A retry strategy in case of connectivity errors.

Output

Type

For Configurations

Throws

Upload Part Copy

<s3:upload-part-copy>

Copies a source object to a part of a multipart upload. To copy an object, the caller’s account must have read access to the source object and write access to the destination bucket.

Parameters

Name Type Description Default Value Required

Configuration

String

The name of the configuration to use.

x

Source Bucket Name

String

The name of the bucket containing the source object to be copied.

x

Source Key

String

The source bucket key under which the source object to be copied is stored.

x

Source Version Id

String

The version of the source object that was copied, if you have enabled versioning on the source bucket.

Destination Bucket Name

String

The destination bucket name which will contain the new, copied object.

x

Destination Key

String

The destination bucket key under which the new, copied object will be stored.

x

Upload Id

String

The ID of the existing, initiated multipart upload with which this new part will be associated.

x

Part Number

Number

The part number describing this part’s position relative to the other parts in the multipart upload.

x

Matching ETag Constraints

Array of String

perform a copy if the source object entity tag (ETag) matches the specified value.

Modified Since

DateTime

The optional modified constraint that restricts this request to executing only if the source object has been modified after the specified date.

Unmodified Since

DateTime

The optional unmodified constraint that restricts this request to executing only if the source object has not been modified after the specified date.

First Byte

Number

The optional first byte from the source bucket to start copy from (starts from 0).

Last Byte

Number

The optional last byte from the source bucket to copy till.

Target Variable

String

The name of a variable to store the operation’s output.

Target Value

String

An expression to evaluate against the operation’s output and store the expression outcome in the target variable

#[payload]

Reconnection Strategy

A retry strategy in case of connectivity errors.

Output

Type

For Configurations

Throws

Sources

On Deleted Object

<s3:deleted-object-trigger>

Parameters

Name Type Description Default Value Required

Configuration

String

The name of the configuration to use.

x

Bucket Name

String

x

Notification Queue Name

String

Primary Node Only

Boolean

Whether this source should only be executed on the primary node when running in Cluster

Scheduling Strategy

scheduling-strategy

Configures the scheduler that triggers the polling

x

Redelivery Policy

Defines a policy for processing the redelivery of the same message

Reconnection Strategy

A retry strategy in case of connectivity errors.

Output

Type

Attributes Type

For Configurations

On New Object

<s3:new-object-trigger>

Parameters

Name Type Description Default Value Required

Configuration

String

The name of the configuration to use.

x

Bucket Name

String

x

Notification Queue Name

String

Primary Node Only

Boolean

Whether this source should only be executed on the primary node when running in Cluster

Scheduling Strategy

scheduling-strategy

Configures the scheduler that triggers the polling

x

Redelivery Policy

Defines a policy for processing the redelivery of the same message

Reconnection Strategy

A retry strategy in case of connectivity errors.

Output

Type

Attributes Type

For Configurations

Types

TLS

Field Type Description Default Value Required

Enabled Protocols

String

A comma-separated list of protocols enabled for this context.

Enabled Cipher Suites

String

A comma-separated list of cipher suites enabled for this context.

Trust Store

Key Store

Revocation Check

Trust Store

Field Type Description Default Value Required

Path

String

The location (which will be resolved relative to the current classpath and file system, if possible) of the trust store.

Password

String

The password used to protect the trust store.

Type

String

The type of store used.

Algorithm

String

The algorithm used by the trust store.

Insecure

Boolean

If true, no certificate validations will be performed, rendering connections vulnerable to attacks. Use at your own risk.

Key Store

Field Type Description Default Value Required

Path

String

The location (which will be resolved relative to the current classpath and file system, if possible) of the key store.

Type

String

The type of store used.

Alias

String

When the key store contains many private keys, this attribute indicates the alias of the key that should be used. If not defined, the first key in the file will be used by default.

Key Password

String

The password used to protect the private key.

Password

String

The password used to protect the key store.

Algorithm

String

The algorithm used by the key store.

Standard Revocation Check

Field Type Description Default Value Required

Only End Entities

Boolean

Only verify the last element of the certificate chain.

Prefer Crls

Boolean

Try CRL instead of OCSP first.

No Fallback

Boolean

Do not use the secondary checking method (the one not selected before).

Soft Fail

Boolean

Avoid verification failure when the revocation server can not be reached or is busy.

Custom OCSP Responder

Field Type Description Default Value Required

Url

String

The URL of the OCSP responder.

Cert Alias

String

Alias of the signing certificate for the OCSP response (must be in the trust store), if present.

CRL File

Field Type Description Default Value Required

Path

String

The path to the CRL file.

Reconnection

Field Type Description Default Value Required

Fails Deployment

Boolean

When the application is deployed, a connectivity test is performed on all connectors. If set to true, deployment fails if the test doesn’t pass after exhausting the associated reconnection strategy.

Reconnection Strategy

The reconnection strategy to use.

Reconnect

Field Type Description Default Value Required

Frequency

Number

How often to reconnect (in milliseconds).

Count

Number

The number of reconnection attempts to make.

blocking

Boolean

If false, the reconnection strategy runs in a separate, non-blocking thread.

true

Reconnect Forever

Field Type Description Default Value Required

Frequency

Number

How often in milliseconds to reconnect.

blocking

Boolean

If false, the reconnection strategy runs in a separate, non-blocking thread.

true

Expiration Policy

Field Type Description Default Value Required

Max Idle Time

Number

A scalar time value for the maximum amount of time a dynamic configuration instance should be allowed to be idle before it’s considered eligible for expiration

Time Unit

Enumeration, one of:

  • DAYS

  • HOURS

  • MICROSECONDS

  • MILLISECONDS

  • MINUTES

  • NANOSECONDS

  • SECONDS

A time unit that qualifies the maxIdleTime attribute

S3 Object Summary

Field Type Description Default Value Required

E Tag

String

Bucket Name

String

Key

String

Last Modified

DateTime

Owner

Size

Number

Storage Class

String

Owner

Field Type Description Default Value Required

Display Name

String

Id

String

S3 Object Attributes

Field Type Description Default Value Required

Bucket Name

String

Cache Control

String

Content Disposition

String

Content Encoding

String

Content Language

String

Content Length

Number

Content MD5

String

Content Type

String

Etag

String

Expiration Time

DateTime

Expiration Time Rule Id

String

Http Expires Date

DateTime

Key

String

Last Modified

DateTime

Ongoing Restore

Boolean

Redirect Location

String

Replication Status

String

Requester Charged

Boolean

Restore Expiration Time

DateTime

Sse Algorithm

String

Sse Aws Kms Key Id

String

Sse Customer Algorithm

String

Sse Customer Key Md5

String

Storage Class

Enumeration, one of:

  • STANDARD

  • STANDARD_IA

  • INTELLIGENT_TIERING

  • ONEZONE_IA

  • REDUCED_REDUNDANCY

  • GLACIER

User Metadata

Object

Version Id

String

Redelivery Policy

Field Type Description Default Value Required

Max Redelivery Count

Number

The maximum number of times a message can be redelivered and processed unsuccessfully before triggering process-failed-message

Use Secure Hash

Boolean

Whether to use a secure hash algorithm to identify a redelivered message.

Message Digest Algorithm

String

The secure hashing algorithm to use. If not set, the default is SHA-256.

Id Expression

String

Defines one or more expressions to use to determine when a message has been redelivered. This property may only be set if useSecureHash is false.

Object Store

Object Store

The object store where the redelivery counter for each message is stored.

Complete Multipart Upload Result

Field Type Description Default Value Required

Bucket Name

String

E Tag

String

Expiration Time

DateTime

Expiration Time Rule Id

String

Key

String

Location

String

Version Id

String

Part E Tag

Field Type Description Default Value Required

Etag

String

Part Number

Number

Object Result

Field Type Description Default Value Required

Etag

String

Expiration Time

DateTime

Expiration Time Rule Id

String

Last Modified Date

DateTime

Version Id

String

Bucket

Field Type Description Default Value Required

Creation Date

DateTime

Name

String

Owner

Key Version

Field Type Description Default Value Required

Value

String

Version

String

Grant

Field Type Description Default Value Required

Grantee

Permission

Enumeration, one of:

  • FULL_CONTROL

  • READ

  • READ_ACP

  • WRITE

  • WRITE_ACP

Grantee

Field Type Description Default Value Required

Display Name

String

Group Uri

Enumeration, one of:

  • AllUsers

  • AuthenticatedUsers

  • LogDelivery

Identifier

String

Type Identifier

Enumeration, one of:

  • ID

  • EMAIL_ADDRESS

  • URI

Access Control List Attributes

Field Type Description Default Value Required

Owner Display Name

String

Owner Id

String

CORS Rule

Field Type Description Default Value Required

Allowed Headers

Array of String

Allowed Methods

Array of Enumeration, one of:

  • DELETE

  • GET

  • HEAD

  • POST

  • PUT

Allowed Origins

Array of String

Exposed Headers

Array of String

Id

String

Max Age Seconds

Number

BLC Rule

Field Type Description Default Value Required

Expiration Date

DateTime

Expiration In Days

Number

Id

String

Noncurrent Version Expiration In Days

Number

Noncurrent Version Transition

Prefix

String

Status

String

Transition

Noncurrent Version Transition

Field Type Description Default Value Required

Days

Number

Storage Class

Enumeration, one of:

  • STANDARD

  • STANDARD_IA

  • INTELLIGENT_TIERING

  • ONEZONE_IA

  • REDUCED_REDUNDANCY

  • GLACIER

Transition

Field Type Description Default Value Required

Date

DateTime

Days

Number

Storage Class

Enumeration, one of:

  • STANDARD

  • STANDARD_IA

  • INTELLIGENT_TIERING

  • ONEZONE_IA

  • REDUCED_REDUNDANCY

  • GLACIER

Bucket Logging Configuration

Field Type Description Default Value Required

Destination Bucket Name

String

Log File Prefix

String

Bucket Website Configuration

Field Type Description Default Value Required

Error Document

String

Index Document Suffix

String

Redirect All Requests To

Routing Rules

Array of Routing Rule

Redirect Rule

Field Type Description Default Value Required

Host Name

String

Http Redirect Code

String

Protocol

String

Replace Key Prefix With

String

Replace Key With

String

Routing Rule

Field Type Description Default Value Required

Condition

Redirect

Routing Rule Condition

Field Type Description Default Value Required

Http Error Code Returned Equals

String

Key Prefix Equals

String

Repeatable In Memory Stream

Field Type Description Default Value Required

Initial Buffer Size

Number

The amount of memory that will be allocated to consume the stream and provide random access to it. If the stream contains more data than can be fit into this buffer, then the buffer expands according to the bufferSizeIncrement attribute, with an upper limit of maxInMemorySize.

Buffer Size Increment

Number

This is by how much the buffer size expands if it exceeds its initial size. Setting a value of zero or lower means that the buffer should not expand, meaning that a STREAM_MAXIMUM_SIZE_EXCEEDED error is raised when the buffer gets full.

Max Buffer Size

Number

The maximum amount of memory to use. If more than that is used then a STREAM_MAXIMUM_SIZE_EXCEEDED error is raised. A value lower than or equal to zero means no limit.

Buffer Unit

Enumeration, one of:

  • BYTE

  • KB

  • MB

  • GB

The unit in which all these attributes are expressed

Repeatable File Store Stream

Field Type Description Default Value Required

Max In Memory Size

Number

Defines the maximum memory that the stream should use to keep data in memory. If more than that is consumed then it will start to buffer the content on disk.

Buffer Unit

Enumeration, one of:

  • BYTE

  • KB

  • MB

  • GB

The unit in which maxInMemorySize is expressed

Object Metadata Parameter Group

Field Type Description Default Value Required

User Metadata

Object

Last Modified

DateTime

Content Length

Number

0

Content Type

String

Content Language

String

Content Encoding

String

Cache Control

String

Content MD5

String

Content Disposition

String

Etag

String

Version Id

String

Sse Algorithm

String

Sse Customer Algorithm

String

Sse Customer Key Md5

String

Expiration Time

DateTime

Expiration Time Rule Id

String

Restore Expiration Time

DateTime

Ongoing Restore

Boolean

false

Http Expires Date

DateTime

Storage Class

Enumeration, one of:

  • STANDARD

  • STANDARD_IA

  • INTELLIGENT_TIERING

  • ONEZONE_IA

  • REDUCED_REDUNDANCY

  • GLACIER

STANDARD

Sse Aws Kms Key Id

String

Requester Charged

Boolean

false

Replication Status

String

Multipart Upload Listing

Field Type Description Default Value Required

Bucket Name

String

Common Prefixes

Array of String

Delimiter

String

Encoding Type

String

Key Marker

String

Max Uploads

Number

Multipart Uploads

Array of Multipart Upload

Next Key Marker

String

Next Upload Id Marker

String

Prefix

String

Truncated

Boolean

Upload Id Marker

String

Multipart Upload

Field Type Description Default Value Required

Initiated

DateTime

Initiator

Key

String

Owner

Storage Class

String

Upload Id

String

Repeatable In Memory Iterable

Field Type Description Default Value Required

Initial Buffer Size

Number

The amount of instances that is initially be allowed to be kept in memory to consume the stream and provide random access to it. If the stream contains more data than can fit into this buffer, then the buffer expands according to the bufferSizeIncrement attribute, with an upper limit of maxInMemorySize. Default value is 100 instances.

Buffer Size Increment

Number

This is by how much the buffer size expands if it exceeds its initial size. Setting a value of zero or lower means that the buffer should not expand, meaning that a STREAM_MAXIMUM_SIZE_EXCEEDED error is raised when the buffer gets full. Default value is 100 instances.

Max Buffer Size

Number

The maximum amount of memory to use. If more than that is used then a STREAM_MAXIMUM_SIZE_EXCEEDED error is raised. A value lower than or equal to zero means no limit.

Repeatable File Store Iterable

Field Type Description Default Value Required

Max In Memory Size

Number

The maximum amount of instances to keep in memory. If more than that is required, then it will start to buffer the content on disk.

Buffer Unit

Enumeration, one of:

  • BYTE

  • KB

  • MB

  • GB

The unit in which maxInMemorySize is expressed

Part Listing

Field Type Description Default Value Required

Bucket Name

String

Encoding Type

String

Initiator

Key

String

Max Parts

Number

Next Part Number Marker

Number

Owner

Part Number Marker

Number

Parts

Array of Part Summary

Storage Class

String

Truncated

Boolean

Upload Id

String

Part Summary

Field Type Description Default Value Required

E Tag

String

Last Modified

DateTime

Part Number

Number

Size

Number

S3 Version Summary

Field Type Description Default Value Required

E Tag

String

Bucket Name

String

Delete Marker

Boolean

Is Delete Marker

Boolean

Is Latest

Boolean

Key

String

Last Modified

DateTime

Latest

Boolean

Owner

Size

Number

Storage Class

String

Version Id

String

Upload Part Result

Field Type Description Default Value Required

Etag

String

Part Number

Number

Copy Part Result

Field Type Description Default Value Required

E Tag

String

Etag

String

Last Modified Date

DateTime

Part Number

Number

Version Id

String

Exception List 1

  • S3:ACCESS_DENIED

  • S3:ACCOUNT_PROBLEM

  • S3:AMBIGUOUS_GRANT_BY_EMAIL_ADDRESS

  • S3:BAD_DIGEST

  • S3:BUCKET_ALREADY_EXISTS

  • S3:BUCKET_ALREADY_OWNED_BY_YOU

  • S3:BUCKET_NOT_EMPTY

  • S3:CONNECTIVITY

  • S3:CREDENTIALS_NOT_SUPPORTED

  • S3:CROSS_LOCATION_LOGGING_PROHIBITED

  • S3:ENTITY_TOO_LARGE

  • S3:ENTITY_TOO_SMALL

  • S3:EXPIRED_TOKEN

  • S3:ILLEGAL_VERSIONING_CONFIGURATION_EXCEPTION

  • S3:INCOMPLETE_BODY

  • S3:INCORRECT_NUMBER_OF_FILES_IN_POST_REQUEST

  • S3:INLINE_DATA_TOO_LARGE

  • S3:INTERNAL_ERROR

  • S3:INVALID_ACCESS_KEY_ID

  • S3:INVALID_ADDRESSING_HEADER

  • S3:INVALID_ARGUMENT

  • S3:INVALID_BUCKET_NAME

  • S3:INVALID_BUCKET_STATE

  • S3:INVALID_DIGEST

  • S3:INVALID_ENCRYPTION_ALGORITHM_ERROR

  • S3:INVALID_LOCATION_CONSTRAINT

  • S3:INVALID_OBJECT_STATE

  • S3:INVALID_PART

  • S3:INVALID_PART_ORDER

  • S3:INVALID_PAYER

  • S3:INVALID_POLICY_DOCUMENT

  • S3:INVALID_RANGE

  • S3:INVALID_REQUEST

  • S3:INVALID_RESPONSE_PRESIGNEDURL_MALFORMED

  • S3:INVALID_SECURITY

  • S3:INVALID_SOAP_REQUEST

  • S3:INVALID_STORAGE_CLASS

  • S3:INVALID_TARGET_BUCKET_FOR_LOGGING

  • S3:INVALID_TOKEN

  • S3:INVALID_URI

  • S3:KEY_TOO_LONG

  • S3:MALFORMED_ACL_ERROR

  • S3:MALFORMED_POST_REQUEST

  • S3:MALFORMED_XML

  • S3:MAX_MESSAGE_LENGTH_EXCEEDED

  • S3:MAX_POST_PRE_DATA_LENGTH_EXCEEDED_ERROR

  • S3:METADATA_TOO_LARGE

  • S3:METHOD_NOT_ALLOWED

  • S3:MISSING_ATTACHMENT

  • S3:MISSING_CONTENT_LENGTH

  • S3:MISSING_REQUEST_BODY_ERROR

  • S3:MISSING_SECURITY_ELEMENT

  • S3:MISSING_SECURITY_HEADER

  • S3:NO_LOGGING_STATUS_FOR_KEY

  • S3:NO_SUCH_BUCKET

  • S3:NO_SUCH_BUCKET_POLICY

  • S3:NO_SUCH_KEY

  • S3:NO_SUCH_LIFECYCLE_CONFIGURATION

  • S3:NO_SUCH_UPLOAD

  • S3:NO_SUCH_VERSION

  • S3:NOT_IMPLEMENTED

  • S3:NOT_SIGNED_UP

  • S3:OPERATION_ABORTED

  • S3:PERMANENT_REDIRECT

  • S3:PRECONDITION_FAILED

  • S3:REDIRECT

  • S3:REQUEST_IS_NOT_MULTI_PART_CONTENT

  • S3:REQUEST_TIME_TOO_SKEWED

  • S3:REQUEST_TIMEOUT

  • S3:REQUEST_TORRENT_OF_BUCKET_ERROR

  • S3:RESTORE_ALREADY_IN_PROGRESS

  • S3:RETRY_EXHAUSTED

  • S3:SERVICE_UNAVAILABLE

  • S3:SIGNATURE_DOES_NOT_MATCH

  • S3:SLOW_DOWN

  • S3:TEMPORARY_REDIRECT

  • S3:TOKEN_REFRESH_REQUIRED

  • S3:TOO_MANY_BUCKETS

  • S3:UNEXPECTED_CONTENT

  • S3:UNKNOWN

  • S3:UNRESOLVABLE_GRANT_BY_EMAIL_ADDRESS

  • S3:USER_KEY_MUST_BE_SPECIFIED

Exception List 2

  • S3:ACCESS_DENIED

  • S3:ACCOUNT_PROBLEM

  • S3:AMBIGUOUS_GRANT_BY_EMAIL_ADDRESS

  • S3:BAD_DIGEST

  • S3:BUCKET_ALREADY_EXISTS

  • S3:BUCKET_ALREADY_OWNED_BY_YOU

  • S3:BUCKET_NOT_EMPTY

  • S3:CREDENTIALS_NOT_SUPPORTED

  • S3:CROSS_LOCATION_LOGGING_PROHIBITED

  • S3:ENTITY_TOO_LARGE

  • S3:ENTITY_TOO_SMALL

  • S3:EXPIRED_TOKEN

  • S3:ILLEGAL_VERSIONING_CONFIGURATION_EXCEPTION

  • S3:INCOMPLETE_BODY

  • S3:INCORRECT_NUMBER_OF_FILES_IN_POST_REQUEST

  • S3:INLINE_DATA_TOO_LARGE

  • S3:INTERNAL_ERROR

  • S3:INVALID_ACCESS_KEY_ID

  • S3:INVALID_ADDRESSING_HEADER

  • S3:INVALID_ARGUMENT

  • S3:INVALID_BUCKET_NAME

  • S3:INVALID_BUCKET_STATE

  • S3:INVALID_DIGEST

  • S3:INVALID_ENCRYPTION_ALGORITHM_ERROR

  • S3:INVALID_LOCATION_CONSTRAINT

  • S3:INVALID_OBJECT_STATE

  • S3:INVALID_PART

  • S3:INVALID_PART_ORDER

  • S3:INVALID_PAYER

  • S3:INVALID_POLICY_DOCUMENT

  • S3:INVALID_RANGE

  • S3:INVALID_REQUEST

  • S3:INVALID_RESPONSE_PRESIGNEDURL_MALFORMED

  • S3:INVALID_SECURITY

  • S3:INVALID_SOAP_REQUEST

  • S3:INVALID_STORAGE_CLASS

  • S3:INVALID_TARGET_BUCKET_FOR_LOGGING

  • S3:INVALID_TOKEN

  • S3:INVALID_URI

  • S3:KEY_TOO_LONG

  • S3:MALFORMED_ACL_ERROR

  • S3:MALFORMED_POST_REQUEST

  • S3:MALFORMED_XML

  • S3:MAX_MESSAGE_LENGTH_EXCEEDED

  • S3:MAX_POST_PRE_DATA_LENGTH_EXCEEDED_ERROR

  • S3:METADATA_TOO_LARGE

  • S3:METHOD_NOT_ALLOWED

  • S3:MISSING_ATTACHMENT

  • S3:MISSING_CONTENT_LENGTH

  • S3:MISSING_REQUEST_BODY_ERROR

  • S3:MISSING_SECURITY_ELEMENT

  • S3:MISSING_SECURITY_HEADER

  • S3:NO_LOGGING_STATUS_FOR_KEY

  • S3:NO_SUCH_BUCKET

  • S3:NO_SUCH_BUCKET_POLICY

  • S3:NO_SUCH_KEY

  • S3:NO_SUCH_LIFECYCLE_CONFIGURATION

  • S3:NO_SUCH_UPLOAD

  • S3:NO_SUCH_VERSION

  • S3:NOT_IMPLEMENTED

  • S3:NOT_SIGNED_UP

  • S3:OPERATION_ABORTED

  • S3:PERMANENT_REDIRECT

  • S3:PRECONDITION_FAILED

  • S3:REDIRECT

  • S3:REQUEST_IS_NOT_MULTI_PART_CONTENT

  • S3:REQUEST_TIME_TOO_SKEWED

  • S3:REQUEST_TIMEOUT

  • S3:REQUEST_TORRENT_OF_BUCKET_ERROR

  • S3:RESTORE_ALREADY_IN_PROGRESS

  • S3:SERVICE_UNAVAILABLE

  • S3:SIGNATURE_DOES_NOT_MATCH

  • S3:SLOW_DOWN

  • S3:TEMPORARY_REDIRECT

  • S3:TOKEN_REFRESH_REQUIRED

  • S3:TOO_MANY_BUCKETS

  • S3:UNEXPECTED_CONTENT

  • S3:UNKNOWN

  • S3:UNRESOLVABLE_GRANT_BY_EMAIL_ADDRESS

  • S3:USER_KEY_MUST_BE_SPECIFIED

We use cookies to make interactions with our websites and services easy and meaningful, to better understand how they are used and to tailor advertising. You can read more and make your cookie choices here. By continuing to use this site you are giving us your consent to do this.