Contact Us 1-800-596-4880
  1. Homepage
  2. Amazon S3 Connector (7.0)

  3. Amazon S3 Connector Reference

All Connectors

Amazon S3 Connector 7.0 Reference - Mule 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.

Configuration

Default Configuration for Amazon S3 Connector.

Name Type Description Default Value Required

Name

String

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

x

Connection

Connection

Connection types for this configuration.

x

Name

String

ID used to reference this configuration.

x

Expiration Policy

Expiration Policy

Configures the minimum amount of time that a dynamic configuration instance can remain idle before Mule considers it eligible for expiration.

Connection (S3) Connection Type

Uses the S3 connection type, which covers both the Basic and Role connections.

Name Type Description Default Value Required

Access Key

String

Access key provided by Amazon.

x

Secret Key

String

Secret key provided by Amazon.

x

Region Endpoint

String

Topic region endpoint.

us-east-1

Connection Timeout

Number

How long the connector waits before timing out when establishing a connection to the remote service. A value of 0 means infinity and is not recommended.

50

Connection Timeout Unit

Enumeration, one of:

  • NANOSECONDS

  • MICROSECONDS

  • MILLISECONDS

  • SECONDS

  • MINUTES

  • HOURS

  • DAYS

Time unit for the Connection Timeout field.

SECONDS

Response Timeout

Number

How long Mule waits for a response to complete before the request times out.

30

Response Timeout Unit

Enumeration, one of:

  • NANOSECONDS

  • MICROSECONDS

  • MILLISECONDS

  • SECONDS

  • MINUTES

  • HOURS

  • DAYS

Time unit for the Response Timeout field.

SECONDS

Role

Role

Role configuration.

Try Default AWSCredentials Provider Chain

Boolean

If true, obtains credentials from the AWS environment. For more information, refer to Provide Temporary Credentials to the SDK .

false

Max Connections

Number

Defines the maximum number of outbound connections that are kept open at the same time. Unlimited by default.

-1

Custom Service Endpoint

String

Sets a custom service endpoint. Useful when a non-standard service endpoint is required, such as a VPC endpoint. For local connections, set this field to http://localhost:8000/.

Custom SQS Endpoint

String

Sets a custom SQS endpoint. Useful when a non-standard SQS endpoint (used by sources) is required, such as a VPC endpoint.

Proxy Configuration

Proxy

Proxy connection settings for outbound connections. This setting applies to the sources and checkpoint operation. It does not affect the put record operation.

TLS Configuration

TLS

Configures TLS. If using the HTTPS protocol, you must configure TLS.

Reconnection

Reconnection

Configures a reconnection strategy to use when a connector operation fails to connect to an external server.

Sources

You must perform additional configuration to use the sources provided by Amazon S3 Connector. Refer to the prerequisites before configuring your sources.

On Deleted Object

<s3:deleted-object-listener>

You must perform additional configuration to use the sources provided by Amazon S3 Connector. Refer to the prerequisites before configuring your sources.

Initiates a Mule flow when an object is deleted from an Amazon S3 bucket, and sends an SQS notification about the deleted object.

Name Type Description Default Value Required

Configuration

String

Name of the configuration to use.

x

Bucket Name

String

Name of the bucket to which the source listens for changes.

x

Folder

String

Name of the folder in the specified bucket.

Config Ref

ConfigurationProvider

Name of the configuration to use to execute this component.

x

Primary Node Only

Boolean

Determines whether to execute this source on only the primary node when running Mule instances in a cluster.

Scheduling Strategy

scheduling-strategy

Configures the scheduler that triggers the polling.

x

Redelivery Policy

Redelivery Policy

Defines a policy for processing the redelivery of the same message.

Queue Name

String

Amazon SQS queue name used to notify users when a new object is created or deleted in an S3 bucket.

Configuration Name

String

Specifies the name of the notification configuration to use in the source. The notification configuration must exist and must be of Event Type 's3:ObjectCreated:*' with the On New Object source and of Event Type 's3:ObjectRemoved:*' with the On Deleted Object source. Configurations with events of the same type cannot have overlapping prefix or suffix configurations.

Reconnection Strategy

Retry strategy in case of connectivity errors.

Output

Type

S3 Object Trigger Response

Associated Configurations

On New Object

<s3:new-object-listener>

You must perform additional configuration to use the sources provided by Amazon S3 Connector. Refer to the prerequisites before configuring your sources.

Initiates a Mule flow when an object is created in an Amazon S3 bucket, and sends an SQS notification about the new object.

Name Type Description Default Value Required

Configuration

String

Name of the configuration to use.

x

Bucket Name

String

Name of the bucket to which the source listens for changes.

x

Folder

String

Name of the folder in the specified bucket.

Config Ref

ConfigurationProvider

Name of the configuration to use to execute this component.

x

Primary Node Only

Boolean

Determines whether to execute this source on only the primary node when running Mule instances in a cluster.

Scheduling Strategy

scheduling-strategy

Configures the scheduler that triggers the polling.

x

Redelivery Policy

Redelivery Policy

Defines a policy for processing the redelivery of the same message.

Queue Name

String

Amazon SQS queue name used to notify users when a new object is created or deleted in an S3 bucket.

Configuration Name

String

Specifies the name of the notification configuration to use in the source. The notification configuration must exist and must be of Event Type 's3:ObjectCreated:*' with the On New Object source and of Event Type 's3:ObjectRemoved:*' with the On Deleted Object source. Configurations with events of the same type cannot have overlapping prefix or suffix configurations.

Reconnection Strategy

Retry strategy in case of connectivity errors.

Output

Type

S3 Object Trigger Response

Associated Configurations

Operations

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 might or might not succeed. As a result, it might be necessary to abort a given multipart upload multiple times to completely free all storage consumed by all parts.

To verify that all parts are removed to avoid getting charged for the part storage, call the ListParts action and ensure that the parts list is empty. For information about permissions required to use the multipart upload, refer to Multipart Upload and Permissions.

Name Type Description Default Value Required

Configuration

String

Name of the configuration to use.

x

Bucket name

String

Bucket name containing the multipart upload.

x

Object key

String

Object key for which the multipart upload is initiated.

x

Upload Id

String

Upload ID that identifies the multipart upload.

x

Config Ref

ConfigurationProvider

Name of the configuration to use to execute this component.

x

Reconnection Strategy

Retry strategy in case of connectivity errors.

Associated Configurations

Throws

  • S3:BAD_REQUEST

  • S3:CONNECTIVITY

  • S3:FORBIDDEN

  • S3:NO_SUCH_UPLOAD

  • S3:REQUEST_TIMEOUT

  • S3:RETRY_EXHAUSTED

  • S3:S3_ERROR

  • S3:SERVER_BUSY

  • S3:SERVICE_ERROR

Complete Multipart Upload

<s3:complete-multipart-upload>

Completes a multipart upload by assembling previously uploaded parts.

You first initiate the multipart upload and then upload all parts using the Upload Part operation. After successfully uploading all relevant parts of an upload, call this operation to complete the upload.

Upon receiving this request, Amazon S3 concatenates all the parts in ascending order by part number to create a new object. In the Complete Multipart Upload request, you must provide the parts list and ensure that it is complete.

This operation concatenates the parts that you provide in the list. For each part in the list, you must provide the part number and ETag value, which is returned after that part is uploaded.

Processing of a Complete Multipart Upload request could take several minutes to complete. After Amazon S3 begins processing the request, it sends an HTTP response header that specifies a 200 OK response. While processing is in progress, Amazon S3 periodically sends white space characters to keep the connection from timing out. Because a request could fail after the initial 200 OK response has been sent, it is important that you check the response body to determine whether the request succeeded.

Note that if Complete Multipart Upload fails, applications must be prepared to retry the failed requests.

Name Type Description Default Value Required

Configuration

String

Name of the configuration to use.

x

Bucket name

String

Bucket name in which the multipart upload is initiated.

x

Object key

String

Object key for which the multipart upload is initiated.

x

Upload Id

String

Upload ID that identifies the initiated multipart upload.

x

Completed Parts

Array of Multipart Part

List of completed parts.

#[payload]

Config Ref

ConfigurationProvider

Name of the configuration to use to execute this component.

x

Target Variable

String

Name of the variable that stores the operation’s output.

Target Value

String

Expression that evaluates the operation’s output. The outcome of the expression is stored in the Target Variable field.

#[payload]

Reconnection Strategy

Retry strategy in case of connectivity errors.

Output

Type

Complete Multipart Upload Response

Associated Configurations

Throws

  • S3:BAD_REQUEST

  • S3:CONNECTIVITY

  • S3:FORBIDDEN

  • S3:NO_SUCH_UPLOAD

  • S3:REQUEST_TIMEOUT

  • S3:RETRY_EXHAUSTED

  • S3:S3_ERROR

  • S3:SERVER_BUSY

  • S3:SERVICE_ERROR

Copy Object

<s3:copy-object>

Creates a copy of an object that is already stored in Amazon S3.

You can store individual objects of up to 5 TB in Amazon S3. You create a copy of your object up to 5 GB in size in a single atomic action using this API. However, to copy an object greater than 5 GB, you must use the multipart upload Upload Part - Copy API. For more information, refer to Copy Object Using the REST Multipart Upload API.

All copy requests must be authenticated. Additionally, you must have read access to the source object and write access to the destination bucket. For more information, refer to REST Authentication.

Both the region that you want to copy the object from and the region that you want to copy the object to must be enabled for your account. A copy request might return an error when Amazon S3 receives the copy request or while Amazon S3 is copying the files. If the error occurs before the copy action starts, you receive a standard Amazon S3 error. If the error occurs during the copy operation, the error response is embedded in the 200 OK response. This means that a 200 OK response can indicate either success or an error.

Design your application to parse the contents of the response and handle it appropriately. If the copy is successful, you receive a response with information about the copied object. If the request is an HTTP 1.1 request, the response is chunk encoded. Otherwise, it does not contain the Content-Length, and you must read the entire body. The copy request charge is based on the storage class and region that you specify for the destination object. For pricing information, refer to Amazon S3 pricing.

Name Type Description Default Value Required

Configuration

String

Name of the configuration to use.

x

Source bucket name

String

Name of the source bucket.

x

Source object key

String

Name of the source key.

x

Source version ID

String

Version ID of the source object.

Destination bucket name

String

Name of the destination bucket.

Destination object key

String

Key of the destination object.

Destination ACL

Enumeration, one of:

  • PRIVATE

  • PUBLIC_READ

  • PUBLIC_READ_WRITE

  • AWS_EXEC_READ

  • AUTHENTICATED_READ

  • BUCKET_OWNER_READ

  • BUCKET_OWNER_FULL_CONTROL

Access control list (ACL) settings of the copied object. The ACL is not preserved and is set to private for the user making the request. To override the default ACL setting, specify a new ACL when generating a copy request.

Destination storage class

Enumeration, one of:

  • STANDARD

  • REDUCED_REDUNDANCY

  • STANDARD_IA

  • ONEZONE_IA

  • INTELLIGENT_TIERING

  • GLACIER

  • DEEP_ARCHIVE

  • OUTPOSTS

  • GLACIER_IR

Storage class of the new object.

Destination user metadata

Object

When copying an object, you can preserve all metadata (default) or specify new metadata.

Modified since

DateTime

Copies the object only if the object is modified after the specified date.

Unmodified since

DateTime

Copies the object only if the object is not modified after the specified date.

Encryption

String

Specifies the appropriated encryption header.

ContentType

String

Standard MIME type describing the format of the object data.

Config Ref

ConfigurationProvider

Name of the configuration to use to execute this component.

x

Target Variable

String

Name of the variable that stores the operation’s output.

Target Value

String

Expression that evaluates the operation’s output. The outcome of the expression is stored in the Target Variable field.

#[payload]

Reconnection Strategy

Retry strategy in case of connectivity errors.

Output

Type

Copy Object Response

Associated Configurations

Throws

  • S3:BAD_REQUEST

  • S3:CONNECTIVITY

  • S3:FORBIDDEN

  • S3:INVALID_OBJECT_STATE

  • S3:NO_SUCH_BUCKET

  • S3:NO_SUCH_KEY

  • S3:REQUEST_TIMEOUT

  • S3:RETRY_EXHAUSTED

  • S3:S3_ERROR

  • S3:SERVER_BUSY

  • S3:SERVICE_ERROR

Create Bucket

<s3:create-bucket>

Creates a new S3 bucket. To create a bucket, you must register with Amazon S3 and have a valid AWS access key ID to authenticate requests. Anonymous requests are never allowed to create buckets. By creating the bucket, you become the bucket owner.

Name Type Description Default Value Required

Configuration

String

Name of the configuration to use.

x

Bucket Name

String

Name of the bucket.

x

Location Constraint

String

Specifies the region in which the bucket is created.

Acl

Enumeration, one of:

  • PRIVATE

  • PUBLIC_READ

  • PUBLIC_READ_WRITE

  • AUTHENTICATED_READ

Access control list (ACL) settings of the created bucket.

Config Ref

ConfigurationProvider

Name of the configuration to use to execute this component.

x

Target Variable

String

Name of the variable that stores the operation’s output.

Target Value

String

Expression that evaluates the operation’s output. The outcome of the expression is stored in the Target Variable field.

#[payload]

Reconnection Strategy

Retry strategy in case of connectivity errors.

Output

Type

String

Associated Configurations

Throws

  • S3:BAD_REQUEST

  • S3:BUCKET_ALREADY_EXISTS

  • S3:BUCKET_ALREADY_OWNED_BY_YOU

  • S3:CONNECTIVITY

  • S3:FORBIDDEN

  • S3:REQUEST_TIMEOUT

  • S3:RETRY_EXHAUSTED

  • S3:S3_ERROR

  • S3:SERVER_BUSY

  • S3:SERVICE_ERROR

Create Multipart Upload

<s3:create-multipart-upload>

Initiates a multipart upload and returns an upload ID. This upload ID is used to associate all of the parts in the specific multipart upload. You specify this upload ID in each of your subsequent upload part requests (refer to Upload Part).

You also include this upload ID in the final request to either complete or abort the multipart upload request. For more information about multipart uploads, refer to Multipart Upload Overview.

If you configure a lifecycle rule to abort incomplete multipart uploads, the upload must complete within the number of days specified in the bucket lifecycle configuration. Otherwise, the incomplete multipart upload becomes eligible for an abort action and Amazon S3 aborts the multipart upload. For more information, refer to Aborting Incomplete Multipart Uploads Using a Bucket Lifecycle Policy.

For information about the permissions required to use the multipart upload API, refer to Uploading and Copying Objects Using Multipart Upload. After you initiate a multipart upload and upload one or more parts, to stop being charged for storing the uploaded parts, you must either complete or abort the multipart upload. Amazon S3 frees up the space used to store the parts and stops charging you for storing them only after you either complete or abort a multipart upload.

Name Type Description Default Value Required

Configuration

String

Name of the configuration to use.

x

Bucket name

String

Name of the bucket in which to initiate the upload.

x

Object key

String

Object key for which the multipart upload is initiated.

x

Object metadata

Object

Object metadata.

Object ACL

Enumeration, one of:

  • PRIVATE

  • PUBLIC_READ

  • PUBLIC_READ_WRITE

  • AWS_EXEC_READ

  • AUTHENTICATED_READ

  • BUCKET_OWNER_READ

  • BUCKET_OWNER_FULL_CONTROL

Canned ACL to apply to the object.

Config Ref

ConfigurationProvider

Name of the configuration to use to execute this component.

x

Target Variable

String

Name of the variable that stores the operation’s output.

Target Value

String

Expression that evaluates the operation’s output. The outcome of the expression is stored in the Target Variable field.

#[payload]

Reconnection Strategy

Retry strategy in case of connectivity errors.

Output

Type

Create Multipart Upload Response

Associated Configurations

Throws

  • S3:BAD_REQUEST

  • S3:CONNECTIVITY

  • S3:FORBIDDEN

  • S3:REQUEST_TIMEOUT

  • S3:RETRY_EXHAUSTED

  • S3:S3_ERROR

  • S3:SERVER_BUSY

  • S3:SERVICE_ERROR

Create Object Presigned Url

<s3:create-object-presigned-url>

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

Name Type Description Default Value Required

Configuration

String

Name of the configuration to use.

x

Bucket Name

String

Name of the bucket in the request.

x

Key

String

Key of the object in the request.

x

Part Number

Number

Required if Method is UPLOAD_PART. If the content size is equal to or less than 5 MB, then Part Number is 1. If not, use a loop to increase the number (1, 2, 3, and so on).

Upload Id

String

Required if Method is ABORT_MULTIPART_UPLOAD, COMPLETE_MULTIPART_UPLOAD, or UPLOAD_PART.

Method

Enumeration, one of:

  • ABORT_MULTIPART_UPLOAD

  • COMPLETE_MULTIPART_UPLOAD

  • CREATE_MULTIPART_UPLOAD

  • GET_OBJECT

  • PUT_OBJECT

  • UPLOAD_PART

Type of object operation to presign.

PUT_OBJECT

Duration

Number

How long the presigned URL is valid.

3600

Duration Time Unit

Enumeration, one of:

  • NANOSECONDS

  • MICROSECONDS

  • MILLISECONDS

  • SECONDS

  • MINUTES

  • HOURS

  • DAYS

Time unit of the Duration field.

SECONDS

Content MD5

String

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

Content Type

String

Standard MIME type describing the format of the contents.

Sse Customer Algorithm

String

Server-side encryption (SSE) algorithm used for the presigned URL. This field is not allowed for the HTTP GET method. If you set a value for this field and use the HTTP GET method, you will receive an error.

Config Ref

ConfigurationProvider

Name of the configuration to use to execute this component.

x

Target Variable

String

Name of the variable that stores the operation’s output.

Target Value

String

Expression that evaluates the operation’s output. The outcome of the expression is stored in the Target Variable field.

#[payload]

Reconnection Strategy

Retry strategy in case of connectivity errors.

Output

Type

String

Associated Configurations

Throws

  • S3:CONNECTIVITY

  • S3:RETRY_EXHAUSTED

Delete Bucket

<s3:delete-bucket>

Deletes the S3 bucket. All objects (including all object versions and delete markers) in the bucket must be deleted before the bucket itself can be deleted.

Name Type Description Default Value Required

Configuration

String

Name of the configuration to use.

x

Bucket Name

String

Name of the bucket.

x

Config Ref

ConfigurationProvider

Name of the configuration to use to execute this component.

x

Reconnection Strategy

Retry strategy in case of connectivity errors.

Associated Configurations

Throws

  • S3:BAD_REQUEST

  • S3:CONNECTIVITY

  • S3:FORBIDDEN

  • S3:NO_SUCH_BUCKET

  • S3:REQUEST_TIMEOUT

  • S3:RETRY_EXHAUSTED

  • S3:S3_ERROR

  • S3:SERVER_BUSY

  • S3:SERVICE_ERROR

Delete Bucket Cors

<s3:delete-bucket-cors>

Deletes the Cross-Origin Resource Sharing (CORS) configuration information set for the bucket. To use this operation, you must have permission to perform the s3:PutBucketCORS action. The bucket owner has this permission by default and can grant this permission to others.

Name Type Description Default Value Required

Configuration

String

Name of the configuration to use.

x

Bucket

String

Name of the bucket.

x

Config Ref

ConfigurationProvider

Name of the configuration to use to execute this component.

x

Reconnection Strategy

Retry strategy in case of connectivity errors.

Associated Configurations

Throws

  • S3:BAD_REQUEST

  • S3:CONNECTIVITY

  • S3:FORBIDDEN

  • S3:REQUEST_TIMEOUT

  • S3:RETRY_EXHAUSTED

  • S3:S3_ERROR

  • S3:SERVER_BUSY

  • S3:SERVICE_ERROR

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.

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

There is usually some time lag before lifecycle configuration deletion is fully propagated to all the Amazon S3 systems.

Name Type Description Default Value Required

Configuration

String

Name of the configuration to use.

x

Bucket

String

Name of the bucket.

x

Config Ref

ConfigurationProvider

Name of the configuration to use to execute this component.

x

Reconnection Strategy

Retry strategy in case of connectivity errors.

Associated Configurations

Throws

  • S3:BAD_REQUEST

  • S3:CONNECTIVITY

  • S3:FORBIDDEN

  • S3:NO_SUCH_LIFECYCLE_CONFIGURATION

  • S3:REQUEST_TIMEOUT

  • S3:RETRY_EXHAUSTED

  • S3:S3_ERROR

  • S3:SERVER_BUSY

  • S3:SERVICE_ERROR

Delete Bucket Policy

<s3:delete-bucket-policy>

This implementation of the DELETE action uses the policy subresource to delete the policy of a specified bucket. If you are using an identity other than the root user of the AWS account that owns the bucket, the calling identity must have the DeleteBucketPolicy permissions on the specified bucket and must belong to the bucket owner’s account to use this operation.

If you don’t have the DeleteBucketPolicy permissions, Amazon S3 returns a 403 Access Denied error. If you have the correct permissions, but you’re not using an identity that belongs to the bucket owner’s account, Amazon S3 returns a 405 Method Not Allowed error.

Name Type Description Default Value Required

Configuration

String

Name of the configuration to use.

x

Bucket

String

Name of the bucket.

x

Config Ref

ConfigurationProvider

Name of the configuration to use to execute this component.

x

Reconnection Strategy

Retry strategy in case of connectivity errors.

Associated Configurations

Throws

  • S3:BAD_REQUEST

  • S3:CONNECTIVITY

  • S3:FORBIDDEN

  • S3:REQUEST_TIMEOUT

  • S3:RETRY_EXHAUSTED

  • S3:S3_ERROR

  • S3:SERVER_BUSY

  • S3:SERVICE_ERROR

Delete Bucket Tagging

<s3:delete-bucket-tagging>

Deletes the tags from the bucket. To use this operation, you must have permission to perform the s3:PutBucketTagging action. By default, the bucket owner has this permission and can grant this permission to others.

Name Type Description Default Value Required

Configuration

String

Name of the configuration to use.

x

Bucket

String

Name of the bucket.

x

Config Ref

ConfigurationProvider

Name of the configuration to use to execute this component.

x

Reconnection Strategy

Retry strategy in case of connectivity errors.

Associated Configurations

Throws

  • S3:BAD_REQUEST

  • S3:CONNECTIVITY

  • S3:FORBIDDEN

  • S3:REQUEST_TIMEOUT

  • S3:RETRY_EXHAUSTED

  • S3:S3_ERROR

  • S3:SERVER_BUSY

  • S3:SERVICE_ERROR

Delete Bucket Website

<s3:delete-bucket-website>

Removes the website configuration from a bucket.

Amazon S3 returns a 200 OK response upon successfully deleting a website configuration from the specified bucket. You receive a 200 OK response if the website configuration you are trying to delete does not exist on the bucket. Amazon S3 returns a 404 response if the bucket specified in the request does not exist.

This DELETE action requires the S3: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.

Name Type Description Default Value Required

Configuration

String

Name of the configuration to use.

x

Bucket

String

Name of the bucket.

x

Config Ref

ConfigurationProvider

Name of the configuration to use to execute this component.

x

Reconnection Strategy

Retry strategy in case of connectivity errors.

Associated Configurations

Throws

  • S3:BAD_REQUEST

  • S3:CONNECTIVITY

  • S3:FORBIDDEN

  • S3:REQUEST_TIMEOUT

  • S3:RETRY_EXHAUSTED

  • S3:S3_ERROR

  • S3:SERVER_BUSY

  • S3:SERVICE_ERROR

Delete Object

<s3:delete-object>

Removes the null version (if there is one) of an object and inserts a delete marker, which becomes the latest version of the object. If there isn’t a null version, Amazon S3 does not remove any objects but still responds that the command was successful.

To remove a specific version, you must be the bucket owner and you must use the version ID subresource. Using this subresource permanently deletes the version.

Name Type Description Default Value Required

Configuration

String

Name of the configuration to use.

x

Bucket name

String

Bucket name containing the object.

x

Object key

String

Object key name to delete.

x

Object version Id

String

Version ID used to reference a specific version of the object.

Config Ref

ConfigurationProvider

Name of the configuration to use to execute this component.

x

Reconnection Strategy

Retry strategy in case of connectivity errors.

Associated Configurations

Throws

  • S3:BAD_REQUEST

  • S3:CONNECTIVITY

  • S3:FORBIDDEN

  • S3:NO_SUCH_BUCKET

  • S3:REQUEST_TIMEOUT

  • S3:RETRY_EXHAUSTED

  • S3:S3_ERROR

  • S3:SERVER_BUSY

  • S3:SERVICE_ERROR

Delete Objects

<s3:delete-objects>

Enables you to delete multiple objects from a bucket using a single HTTP request. If you know the object keys that you want to delete, then this operation provides a suitable alternative to sending individual delete requests, reducing per-request overhead.

The request contains a list of up to 1000 keys that you want to delete. In the XML, you provide the object key names, and optionally, version IDs if you want to delete a specific version of the object from a versioning-enabled bucket. For each key, Amazon S3 performs a delete action and returns the result of that delete, success, or failure, in the response. If the object specified in the request is not found, Amazon S3 returns the result as deleted.

The action supports two modes for the response: verbose and quiet. By default, the action uses the verbose mode, in which the response includes the result of deletion of each key in your request. In quiet mode, the response includes only keys where the delete action encounters an error. For a successful deletion, the action does not return any information about the delete in the response body.

Name Type Description Default Value Required

Configuration

String

Name of the configuration to use.

x

Bucket name

String

Bucket name containing the objects to delete.

x

Object identifiers

Array of Object Identifier

List of the object identifiers containing object keys and versions of the object to delete.

x

Config Ref

ConfigurationProvider

Name of the configuration to use to execute this component.

x

Reconnection Strategy

Retry strategy in case of connectivity errors.

Associated Configurations

Throws

  • S3:BAD_REQUEST

  • S3:CONNECTIVITY

  • S3:FORBIDDEN

  • S3:NO_SUCH_BUCKET

  • S3:REQUEST_TIMEOUT

  • S3:RETRY_EXHAUSTED

  • S3:S3_ERROR

  • S3:SERVER_BUSY

  • S3:SERVICE_ERROR

Get Bucket Acl

<s3:get-bucket-acl>

This implementation of the GET action uses the ACL subresource to return the ACL of a bucket. To use GET to return the ACL of the bucket, you must have READ_ACP access to the bucket. If the READ_ACP permission is granted to the anonymous user, you can return the ACL of the bucket without using an authorization header.

Name Type Description Default Value Required

Configuration

String

Name of the configuration to use.

x

Bucket

String

Name of the bucket.

x

Config Ref

ConfigurationProvider

Name of the configuration to use to execute this component.

x

Target Variable

String

Name of the variable that stores the operation’s output.

Target Value

String

Expression that evaluates the operation’s output. The outcome of the expression is stored in the Target Variable field.

#[payload]

Reconnection Strategy

Retry strategy in case of connectivity errors.

Output

Type

Bucket Acl Response

Associated Configurations

Throws

  • S3:BAD_REQUEST

  • S3:CONNECTIVITY

  • S3:FORBIDDEN

  • S3:REQUEST_TIMEOUT

  • S3:RETRY_EXHAUSTED

  • S3:S3_ERROR

  • S3:SERVER_BUSY

  • S3:SERVICE_ERROR

Get Bucket Cors

<s3:get-bucket-cors>

Returns the CORS configuration information set for the bucket. To use this operation, you must have permission to perform the s3:GetBucketCORS action. By default, the bucket owner has this permission and can grant it to others.

Name Type Description Default Value Required

Configuration

String

Name of the configuration to use.

x

Bucket

String

Name of the bucket.

x

Config Ref

ConfigurationProvider

Name of the configuration to use to execute this component.

x

Target Variable

String

Name of the variable that stores the operation’s output.

Target Value

String

Expression that evaluates the operation’s output. The outcome of the expression is stored in the Target Variable field.

#[payload]

Reconnection Strategy

Retry strategy in case of connectivity errors.

Output

Type

Bucket Cors Response

Associated Configurations

Throws

  • S3:BAD_REQUEST

  • S3:CONNECTIVITY

  • S3:FORBIDDEN

  • S3:REQUEST_TIMEOUT

  • S3:RETRY_EXHAUSTED

  • S3:S3_ERROR

  • S3:SERVER_BUSY

  • S3:SERVICE_ERROR

Get Bucket Lifecycle Configuration

<s3:get-bucket-lifecycle-configuration>

Returns the lifecycle configuration information set on the bucket. To use this operation, you must have permission to perform the s3:GetLifecycleConfiguration action. The bucket owner has this permission, by default. The bucket owner can grant this permission to others.

Name Type Description Default Value Required

Configuration

String

Name of the configuration to use.

x

Bucket

String

Name of the bucket.

x

Config Ref

ConfigurationProvider

Name of the configuration to use to execute this component.

x

Target Variable

String

Name of the variable that stores the operation’s output.

Target Value

String

Expression that evaluates the operation’s output. The outcome of the expression is stored in the Target Variable field.

#[payload]

Reconnection Strategy

Retry strategy in case of connectivity errors.

Output

Type

Lifecycle Configuration

Associated Configurations

Throws

  • S3:BAD_REQUEST

  • S3:CONNECTIVITY

  • S3:FORBIDDEN

  • S3:NO_SUCH_LIFECYCLE_CONFIGURATION

  • S3:REQUEST_TIMEOUT

  • S3:RETRY_EXHAUSTED

  • S3:S3_ERROR

  • S3:SERVER_BUSY

  • S3:SERVICE_ERROR

Get Bucket Location

<s3:get-bucket-location>

Returns the region the bucket resides in. You set the bucket’s region using the Location Constraint request parameter in the Create Bucket operation. To use this implementation of the operation, you must be the bucket owner.

Name Type Description Default Value Required

Configuration

String

Name of the configuration to use.

x

Bucket

String

Name of the bucket.

x

Config Ref

ConfigurationProvider

Name of the configuration to use to execute this component.

x

Target Variable

String

Name of the variable that stores the operation’s output.

Target Value

String

Expression that evaluates the operation’s output. The outcome of the expression is stored in the Target Variable field.

#[payload]

Reconnection Strategy

Retry strategy in case of connectivity errors.

Output

Type

String

Associated Configurations

Throws

  • S3:BAD_REQUEST

  • S3:CONNECTIVITY

  • S3:FORBIDDEN

  • S3:REQUEST_TIMEOUT

  • S3:RETRY_EXHAUSTED

  • S3:S3_ERROR

  • S3:SERVER_BUSY

  • S3:SERVICE_ERROR

Get Bucket Logging

<s3:get-bucket-logging>

Returns the logging status of a bucket and the permissions users have to view and modify that status. To use GET, you must be the bucket owner.

Name Type Description Default Value Required

Configuration

String

Name of the configuration to use.

x

Bucket

String

Name of the bucket.

x

Config Ref

ConfigurationProvider

Name of the configuration to use to execute this component.

x

Target Variable

String

Name of the variable that stores the operation’s output.

Target Value

String

Expression that evaluates the operation’s output. The outcome of the expression is stored in the Target Variable field.

#[payload]

Reconnection Strategy

Retry strategy in case of connectivity errors.

Output

Type

Logging Status

Associated Configurations

Throws

  • S3:BAD_REQUEST

  • S3:CONNECTIVITY

  • S3:FORBIDDEN

  • S3:REQUEST_TIMEOUT

  • S3:RETRY_EXHAUSTED

  • S3:S3_ERROR

  • S3:SERVER_BUSY

  • S3:SERVICE_ERROR

Get Bucket Notification Configuration

<s3:get-bucket-notification-configuration>

Returns the notification configuration of a bucket. If notifications are not enabled on the bucket, the action returns an empty NotificationConfiguration element. By default, you must be the bucket owner to read the notification configuration of a bucket. However, the bucket owner can use a bucket policy to grant permission to other users to read this configuration with the s3:GetBucketNotification permission.

Name Type Description Default Value Required

Configuration

String

Name of the configuration to use.

x

Bucket

String

Name of the bucket.

x

Config Ref

ConfigurationProvider

Name of the configuration to use to execute this component.

x

Target Variable

String

Name of the variable that stores the operation’s output.

Target Value

String

Expression that evaluates the operation’s output. The outcome of the expression is stored in the Target Variable field.

#[payload]

Reconnection Strategy

Retry strategy in case of connectivity errors.

Output

Type

Bucket Notification Response

Associated Configurations

Throws

  • S3:BAD_REQUEST

  • S3:CONNECTIVITY

  • S3:FORBIDDEN

  • S3:REQUEST_TIMEOUT

  • S3:RETRY_EXHAUSTED

  • S3:S3_ERROR

  • S3:SERVER_BUSY

  • S3:SERVICE_ERROR

Get Bucket Policy

<s3:get-bucket-policy>

Returns the policy of a specified bucket. If you are using an identity other than the root user of the AWS account that owns the bucket, the calling identity must have the GetBucketPolicy permissions on the specified bucket and belong to the bucket owner’s account to use this operation.

Name Type Description Default Value Required

Configuration

String

Name of the configuration to use.

x

Bucket

String

Name of the bucket.

x

Config Ref

ConfigurationProvider

Name of the configuration to use to execute this component.

x

Target Variable

String

Name of the variable that stores the operation’s output.

Target Value

String

Expression that evaluates the operation’s output. The outcome of the expression is stored in the Target Variable field.

#[payload]

Reconnection Strategy

Retry strategy in case of connectivity errors.

Output

Type

Bucket Policy Response

Associated Configurations

Throws

  • S3:BAD_REQUEST

  • S3:CONNECTIVITY

  • S3:FORBIDDEN

  • S3:REQUEST_TIMEOUT

  • S3:RETRY_EXHAUSTED

  • S3:S3_ERROR

  • S3:SERVER_BUSY

  • S3:SERVICE_ERROR

Get Bucket Tagging

<s3:get-bucket-tagging>

Returns the tag set associated with the bucket. To use this operation, you must have permission to perform the s3:GetBucketTagging action. By default, the bucket owner has this permission and can grant this permission to others.

Name Type Description Default Value Required

Configuration

String

Name of the configuration to use.

x

Bucket

String

Name of the bucket.

x

Config Ref

ConfigurationProvider

Name of the configuration to use to execute this component.

x

Target Variable

String

Name of the variable that stores the operation’s output.

Target Value

String

Expression that evaluates the operation’s output. The outcome of the expression is stored in the Target Variable field.

#[payload]

Reconnection Strategy

Retry strategy in case of connectivity errors.

Output

Type

Bucket Tagging Response

Associated Configurations

Throws

  • S3:BAD_REQUEST

  • S3:CONNECTIVITY

  • S3:FORBIDDEN

  • S3:NO_SUCH_TAG_SET

  • S3:REQUEST_TIMEOUT

  • S3:RETRY_EXHAUSTED

  • S3:S3_ERROR

  • S3:SERVER_BUSY

  • S3:SERVICE_ERROR

Get Bucket Versioning

<s3:get-bucket-versioning>

Returns the versioning state of a bucket. To retrieve the versioning state of a bucket, you must be the bucket owner. This implementation also returns the MFA Delete status of the versioning state. If the MFA Delete status is enabled, the bucket owner must use an authentication device to change the versioning state of the bucket.

Name Type Description Default Value Required

Configuration

String

Name of the configuration to use.

x

Bucket

String

Name of the bucket.

x

Config Ref

ConfigurationProvider

Name of the configuration to use to execute this component.

x

Target Variable

String

Name of the variable that stores the operation’s output.

Target Value

String

Expression that evaluates the operation’s output. The outcome of the expression is stored in the Target Variable field.

#[payload]

Reconnection Strategy

Retry strategy in case of connectivity errors.

Output

Type

Bucket Versioning Response

Associated Configurations

Throws

  • S3:BAD_REQUEST

  • S3:CONNECTIVITY

  • S3:FORBIDDEN

  • S3:REQUEST_TIMEOUT

  • S3:RETRY_EXHAUSTED

  • S3:S3_ERROR

  • S3:SERVER_BUSY

  • S3:SERVICE_ERROR

Get Bucket Website

<s3:get-bucket-website>

Returns the website configuration for a bucket. To host a website on Amazon S3, you can configure a bucket as a website by adding a website configuration. This GET action requires the S3: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 S3:GetBucketWebsite permission.

Name Type Description Default Value Required

Configuration

String

Name of the configuration to use.

x

Bucket

String

Name of the bucket.

x

Config Ref

ConfigurationProvider

Name of the configuration to use to execute this component.

x

Target Variable

String

Name of the variable that stores the operation’s output.

Target Value

String

Expression that evaluates the operation’s output. The outcome of the expression is stored in the Target Variable field.

#[payload]

Reconnection Strategy

Retry strategy in case of connectivity errors.

Output

Type

Bucket Website Response

Associated Configurations

Throws

  • S3:BAD_REQUEST

  • S3:CONNECTIVITY

  • S3:FORBIDDEN

  • S3:REQUEST_TIMEOUT

  • S3:RETRY_EXHAUSTED

  • S3:S3_ERROR

  • S3:SERVER_BUSY

  • S3:SERVICE_ERROR

Get Object

<s3:get-object>

Retrieves objects from Amazon S3. To use GET, you must have READ access to the object. If you grant READ access to the anonymous user, you can return the object without using an authorization header. If the object you are retrieving is stored in the S3 Glacier or S3 Glacier Deep Archive storage class, or S3 Intelligent-Tiering Archive or S3 Intelligent-Tiering Deep Archive tiers, before you can retrieve the object you must first restore a copy using the Restore Object operation. Otherwise, this action returns an InvalidObjectState error. For more information about restoring archived objects, refer to Restoring Archived Objects.

Name Type Description Default Value Required

Configuration

String

Name of the configuration to use.

x

Bucket name

String

Bucket name containing the object.

x

Object key

String

Object key to get.

x

Part Number

Number

Part number of the object to read. This is a positive integer between 1 and 10,000. Specifying this number effectively performs a ranged GET request for the part specified, which is useful for downloading only a part of an object.

Range

String

Range of the bytes copied from the source object, from the first byte to the last byte.

Output Mime Type

String

MIME type of the payload that this operation outputs.

Output Encoding

String

Encoding of the payload that this operation outputs.

Config Ref

ConfigurationProvider

Name of the configuration to use to execute this component.

x

Streaming Strategy

Configures how Mule processes streams. Repeatable streams are the default behavior.

Target Variable

String

Name of the variable that stores the operation’s output.

Target Value

String

Expression that evaluates the operation’s output. The outcome of the expression is stored in the Target Variable field.

#[payload]

Reconnection Strategy

Retry strategy in case of connectivity errors.

Output

Type

Any

Attributes Type

Get Object Operation Attributes

Associated Configurations

Throws

  • S3:BAD_REQUEST

  • S3:CONNECTIVITY

  • S3:FORBIDDEN

  • S3:INVALID_OBJECT_STATE

  • S3:NO_SUCH_BUCKET

  • S3:NO_SUCH_KEY

  • S3:REQUEST_TIMEOUT

  • S3:RETRY_EXHAUSTED

  • S3:S3_ERROR

  • S3:SERVER_BUSY

  • S3:SERVICE_ERROR

Get Object ACL

<s3:get-object-acl>

Returns the ACL of an object. To use this operation, you must have s3:GetObjectAcl permissions or READ_ACP access to the object. This action is not supported by Amazon S3 on Outposts.

Name Type Description Default Value Required

Configuration

String

Name of the configuration to use.

x

Bucket name

String

Bucket name that contains the object for which to get the ACL information.

x

Object key

String

Object key for which to get the ACL information.

x

Object version Id

String

Version ID used to reference a specific version of the object.

Config Ref

ConfigurationProvider

Name of the configuration to use to execute this component.

x

Target Variable

String

Name of the variable that stores the operation’s output.

Target Value

String

Expression that evaluates the operation’s output. The outcome of the expression is stored in the Target Variable field.

#[payload]

Reconnection Strategy

Retry strategy in case of connectivity errors.

Output

Type

Get Object Acl Response

Associated Configurations

Throws

  • S3:BAD_REQUEST

  • S3:CONNECTIVITY

  • S3:FORBIDDEN

  • S3:NO_SUCH_BUCKET

  • S3:NO_SUCH_KEY

  • S3:REQUEST_TIMEOUT

  • S3:RETRY_EXHAUSTED

  • S3:S3_ERROR

  • S3:SERVER_BUSY

  • S3:SERVICE_ERROR

Get Object Attributes

<s3:get-object-attributes>

Retrieves all the metadata from an object without returning the object itself. This operation is useful if you’re interested only in an object’s metadata. To use this operation, you must have READ access to the object.

Name Type Description Default Value Required

Configuration

String

Name of the configuration to use.

x

Bucket name

String

Bucket name containing the object.

x

Object key

String

Object key.

x

Object version Id

String

Version ID used to reference a specific version of the object.

Object Attributes

Enumeration, one of:

  • E_TAG

  • CHECKSUM

  • OBJECT_PARTS

  • STORAGE_CLASS

  • OBJECT_SIZE

Specifies the fields at the root level that you want returned to the response. Fields that you do not specify are not returned.

x

Max Parts

Number

Sets the maximum number of parts to return.

Part Number Marker

Number

Specifies the part after which listing begins. Only parts with higher part numbers are listed.

Config Ref

ConfigurationProvider

Name of the configuration to use to execute this component.

x

Target Variable

String

Name of the variable that stores the operation’s output.

Target Value

String

Expression that evaluates the operation’s output. The outcome of the expression is stored in the Target Variable field.

#[payload]

Reconnection Strategy

Retry strategy in case of connectivity errors.

Output

Type

Get Object Attributes Response

Associated Configurations

Throws

  • S3:BAD_REQUEST

  • S3:CONNECTIVITY

  • S3:FORBIDDEN

  • S3:NO_SUCH_BUCKET

  • S3:NO_SUCH_KEY

  • S3:REQUEST_TIMEOUT

  • S3:RETRY_EXHAUSTED

  • S3:S3_ERROR

  • S3:SERVER_BUSY

  • S3:SERVICE_ERROR

Head Object

<s3:head-object>

The HEAD action retrieves metadata from an object without returning the object itself. This action is useful if you are interested only in an object’s metadata. To use HEAD, you must have READ access to the object. A HEAD request has the same options as a GET action on an object. The response is identical to the GET response except that there is no response body.

Name Type Description Default Value Required

Configuration

String

Name of the configuration to use.

x

Bucket name

String

Name of the bucket containing the object.

x

Object key

String

Object key.

x

Object version Id

String

Version ID used to reference a specific version of the object.

Part Number

Number

Part number of the object that is read. This is a positive integer between 1 and 10,000. Effectively performs a ranged HEAD request for the part specified. Useful for querying the size of the part and the number of parts in the object.

Config Ref

ConfigurationProvider

Name of the configuration to use to execute this component.

x

Matching ETag

String

Matches the object if its entity tag (ETag) matches the specified tag.

Not matching ETag

String

Matches the object if its entity tag (ETag) is different from the specified tag.

Modified since

DateTime

Matches the object if it was modified since the specified time.

Unmodified since

DateTime

Matches the object if it was not modified since the specified time.

Target Variable

String

Name of the variable that stores the operation’s output.

Target Value

String

Expression that evaluates the operation’s output. The outcome of the expression is stored in the Target Variable field.

#[payload]

Reconnection Strategy

Retry strategy in case of connectivity errors.

Output

Type

Head Object Response

Associated Configurations

Throws

  • S3:BAD_REQUEST

  • S3:CONNECTIVITY

  • S3:FORBIDDEN

  • S3:NO_SUCH_BUCKET

  • S3:NO_SUCH_KEY

  • S3:REQUEST_TIMEOUT

  • S3:RETRY_EXHAUSTED

  • S3:S3_ERROR

  • S3:SERVER_BUSY

  • S3:SERVICE_ERROR

List Buckets

<s3:list-buckets>

Returns a list of all buckets owned by the authenticated sender of the request. To use this operation, you must have the s3:ListAllMyBuckets permission.

Name Type Description Default Value Required

Configuration

String

Name of the configuration to use.

x

Config Ref

ConfigurationProvider

Name of the configuration to use to execute this component.

x

Target Variable

String

Name of the variable that stores the operation’s output.

Target Value

String

Expression that evaluates the operation’s output. The outcome of the expression is stored in the Target Variable field.

#[payload]

Reconnection Strategy

Retry strategy in case of connectivity errors.

Output

Type

List Buckets Response

Associated Configurations

Throws

  • S3:BAD_REQUEST

  • S3:CONNECTIVITY

  • S3:FORBIDDEN

  • S3:NO_SUCH_BUCKET

  • S3:REQUEST_TIMEOUT

  • S3:RETRY_EXHAUSTED

  • S3:S3_ERROR

  • S3:SERVER_BUSY

  • S3:SERVICE_ERROR

List Multipart Uploads

<s3:list-multipart-uploads>

This operation lists in-progress multipart uploads. An in-progress multipart upload is a multipart upload that is initiated using the Initiate Multipart Upload request, but that has not yet been completed or aborted. In the response, the uploads are sorted by key. If your application has initiated more than one multipart upload using the same object key, then uploads in the response are first sorted by key. Additionally, uploads are sorted in ascending order within each key by the upload initiation time. For information on permissions required to use the multipart upload API, refer to Multipart Upload and Permissions.

Name Type Description Default Value Required

Configuration

String

Name of the configuration to use.

x

Bucket name

String

Name of the bucket in which the multipart upload is initiated.

x

Prefix

String

Limits the response to keys that begin with the specified prefix.

Page size

Number

Sets the page size of the response.

1000

Key marker

String

Specifies the key to start with when listing parts in a bucket.

Upload Id marker

String

Specifies the upload ID to start with when listing parts in a bucket.

Config Ref

ConfigurationProvider

Name of the configuration to use to execute this component.

x

Streaming Strategy

Configures how Mule processes streams. Repeatable streams are the default behavior.

Target Variable

String

Name of the variable that stores the operation’s output.

Target Value

String

Expression that evaluates the operation’s output. The outcome of the expression is stored in the Target Variable field.

#[payload]

Reconnection Strategy

Retry strategy in case of connectivity errors.

Output

Type

Array of Multipart Upload

Associated Configurations

List Object Versions

<s3:list-object-versions>

Returns metadata about all versions of the objects in a bucket. You can also use request parameters as selection criteria to return metadata about a subset of all the object versions. To use this operation, you must have READ access to the bucket.

Name Type Description Default Value Required

Configuration

String

Name of the configuration to use.

x

Bucket name

String

Bucket name to list.

x

Delimiter

String

Character you use to group keys.

Key Marker

String

Specifies the key to start with when listing objects in a bucket.

Prefix

String

Limits the response to keys that begin with the specified prefix.

Page Size

Number

Sets the page size of the response.

1000

Version Id Marker

String

Specifies the object version you want to start listing from.

Encoding Type

Enumeration, one of:

  • URL

Encoding type used by Amazon S3 to encode object keys in the response.

Config Ref

ConfigurationProvider

Name of the configuration to use to execute this component.

x

Streaming Strategy

Configures how Mule processes streams. Repeatable streams are the default behavior.

Target Variable

String

Name of the variable that stores the operation’s output.

Target Value

String

Expression that evaluates the operation’s output. The outcome of the expression is stored in the Target Variable field.

#[payload]

Reconnection Strategy

Retry strategy in case of connectivity errors.

Output

Type

Array of Api Object Version

Associated Configurations

List Objects

<s3:list-objects>

Returns all objects in a bucket. You can use the request parameters as selection criteria to return a subset of the objects in a bucket. A 200 OK response can contain valid or invalid XML. Make sure to design your application to parse the contents of the response and handle it appropriately. Objects are returned sorted in ascending order of the respective key names in the list. To use this operation, you must have READ access to the bucket. To use this operation in an AWS Identity and Access Management (IAM) policy, you must have permissions to perform the s3:ListBucket action. The bucket owner has this permission by default and can grant this permission to others.

Name Type Description Default Value Required

Configuration

String

Name of the configuration to use.

x

Bucket name

String

Bucket name to list.

x

Delimiter

String

Character you use to group keys.

Prefix

String

Limits the response to keys that begin with the specified prefix.

Page Size

Number

Sets the page size of the response.

1000

Encoding Type

Enumeration, one of:

  • URL

Encoding type used by Amazon S3 to encode object keys in the response.

Config Ref

ConfigurationProvider

Name of the configuration to use to execute this component.

x

Streaming Strategy

Configures how Mule processes streams. Repeatable streams are the default behavior.

Target Variable

String

Name of the variable that stores the operation’s output.

Target Value

String

Expression that evaluates the operation’s output. The outcome of the expression is stored in the Target Variable field.

#[payload]

Reconnection Strategy

Retry strategy in case of connectivity errors.

Output

Type

Array of Api S3 Object

Associated Configurations

Throws

  • S3:BAD_REQUEST

  • S3:FORBIDDEN

  • S3:NO_SUCH_BUCKET

  • S3:REQUEST_TIMEOUT

  • S3:S3_ERROR

  • S3:SERVER_BUSY

  • S3:SERVICE_ERROR

List Multipart Parts

<s3:list-parts>

Lists the parts that are uploaded for a specific multipart upload. This operation must include the upload ID, which you obtain by sending the initiate multipart upload request. Refer to CreateMultipartUpload for more information.

Name Type Description Default Value Required

Configuration

String

Name of the configuration to use.

x

Bucket name

String

Name of the bucket in which the multipart upload is initiated.

x

Object key

String

Object key for which the multipart upload is initiated.

x

Upload ID

String

Upload ID identifying the multipart upload whose parts are listed.

x

Page Size

Number

Sets the page size of the response.

1000

Part number marker

Number

Specifies the part after which listing should begin. Only parts with higher part numbers are listed.

Config Ref

ConfigurationProvider

Name of the configuration to use to execute this component.

x

Streaming Strategy

Configures how Mule processes streams. Repeatable streams are the default behavior.

Target Variable

String

Name of the variable that stores the operation’s output.

Target Value

String

Expression that evaluates the operation’s output. The outcome of the expression is stored in the Target Variable field.

#[payload]

Reconnection Strategy

Retry strategy in case of connectivity errors.

Output

Type

Array of Api Object Part

Associated Configurations

Put Bucket Acl

<s3:put-bucket-acl>

Sets the permissions on an existing bucket using access control lists (ACLs). To set the ACL of a bucket, you must have the WRITE_ACP permission. You can set a bucket’s permissions in one of two ways:

  • Specify the ACL in the request body.

  • Specify permissions using request headers.

Name Type Description Default Value Required

Configuration

String

Name of the configuration to use.

x

Bucket

String

Name of the bucket.

x

Grants

Array of Grant

List of grants for this bucket.

Owner Id

String

Canonical AWS ID of the owner.

Config Ref

ConfigurationProvider

Name of the configuration to use to execute this component.

x

Reconnection Strategy

Retry strategy in case of connectivity errors.

Associated Configurations

Throws

  • S3:BAD_REQUEST

  • S3:CONNECTIVITY

  • S3:FORBIDDEN

  • S3:REQUEST_TIMEOUT

  • S3:RETRY_EXHAUSTED

  • S3:S3_ERROR

  • S3:SERVER_BUSY

  • S3:SERVICE_ERROR

Put Bucket Cors

<s3:put-bucket-cors>

Sets the CORS configuration for your bucket. If the configuration exists, Amazon S3 replaces it.

To use this operation, you need permission to perform the s3:PutBucketCORS action. By default, the bucket owner has this permission and can grant it to others.

You set this configuration on a bucket so that the bucket can service cross-origin requests. For example, you might want to enable a request whose origin is http://www.example.com to access your Amazon S3 bucket at my.example.bucket.com by using the browser’s XMLHttpRequest capability.

To enable cross-origin resource sharing (CORS) on a bucket, you add the CORS subresource to the bucket. The CORS subresource is an XML document in which you configure rules that identify origins and the HTTP methods that can be executed on your bucket. The document is limited to 64 KB in size. When Amazon S3 receives a cross-origin request (or a pre-flight OPTIONS request) against a bucket, it evaluates the CORS configuration on the bucket and uses the first CORSRule rule that matches the incoming browser request to enable a cross-origin request. For a rule to match, the following conditions must be met:

  • The request’s origin header must match the AllowedOrigin elements.

  • The request method (for example, GET, PUT, HEAD, and so on) or the Access-Control-Request-Method header for a pre-flight OPTIONS request must be one of the AllowedMethod elements. Every header specified in the Access-Control-Request-Headers request header of a pre-flight request must match an AllowedHeader element.

Name Type Description Default Value Required

Configuration

String

Name of the configuration to use.

x

Bucket

String

Name of the bucket.

x

Cors Rules

Array of Cors Rule

List of CORS rules.

x

Config Ref

ConfigurationProvider

Name of the configuration to use to execute this component.

x

Reconnection Strategy

Retry strategy in case of connectivity errors.

Associated Configurations

Throws

  • S3:BAD_REQUEST

  • S3:CONNECTIVITY

  • S3:FORBIDDEN

  • S3:REQUEST_TIMEOUT

  • S3:RETRY_EXHAUSTED

  • S3:S3_ERROR

  • S3:SERVER_BUSY

  • S3:SERVICE_ERROR

Put Bucket Lifecycle Configuration

<s3:put-bucket-lifecycle-configuration>

Creates a new lifecycle configuration for the bucket or replaces an existing lifecycle configuration. This operation overwrites an existing lifecycle configuration, so if you want to retain any configuration details, include them in the new lifecycle configuration.

Name Type Description Default Value Required

Configuration

String

Name of the configuration to use.

x

Bucket

String

Name of the bucket.

x

Lifecycle Rules

Array of Lifecycle Rule

List of lifecycle rules.

x

Config Ref

ConfigurationProvider

Name of the configuration to use to execute this component.

x

Reconnection Strategy

Retry strategy in case of connectivity errors.

Associated Configurations

Throws

  • S3:BAD_REQUEST

  • S3:CONNECTIVITY

  • S3:FORBIDDEN

  • S3:NO_SUCH_LIFECYCLE_CONFIGURATION

  • S3:REQUEST_TIMEOUT

  • S3:RETRY_EXHAUSTED

  • S3:S3_ERROR

  • S3:SERVER_BUSY

  • S3:SERVICE_ERROR

Put Bucket Logging

<s3:put-bucket-logging-configuration>

Set the logging parameters for a bucket and to specify permissions for who can view and modify the logging parameters. All logs are saved to buckets in the same AWS Region as the source bucket. To set the logging status of a bucket, you must be the bucket owner. The bucket owner is automatically granted FULL_CONTROL to all logs. Use the Grantee request element to grant access to other people. The Permissions request element specifies the kind of access the grantee has to the logs.

Name Type Description Default Value Required

Configuration

String

Name of the configuration to use.

x

Bucket

String

Name of the bucket.

x

Bucket Logging Configuration

Logging Status

Configuration of the logging behavior.

x

Config Ref

ConfigurationProvider

Name of the configuration to use to execute this component.

x

Reconnection Strategy

Retry strategy in case of connectivity errors.

Associated Configurations

Throws

  • S3:BAD_REQUEST

  • S3:CONNECTIVITY

  • S3:FORBIDDEN

  • S3:REQUEST_TIMEOUT

  • S3:RETRY_EXHAUSTED

  • S3:S3_ERROR

  • S3:SERVER_BUSY

  • S3:SERVICE_ERROR

Put Bucket Notification Configuration

<s3:put-bucket-notification-configuration>

Enables notifications of specified events for a bucket. Using this API, you can replace an existing notification configuration. The configuration is an XML file that defines the event types that you want Amazon S3 to publish and the destination where you want Amazon S3 to publish an event notification when it detects an event of the specified type. This operation replaces the existing notification configuration with the configuration you include in the request. You can disable notifications by defining an empty notificationConfiguration. By default, only the bucket owner can configure notifications on a bucket. However, bucket owners can use a bucket policy to grant permission to other users by setting this configuration with an s3:PutBucketNotification permission.

Name Type Description Default Value Required

Configuration

String

Name of the configuration to use.

x

Bucket

String

Name of the bucket.

x

Notification Configuration

Notification Configuration

Configuration of the notifications behavior.

x

Config Ref

ConfigurationProvider

Name of the configuration to use to execute this component.

x

Reconnection Strategy

Retry strategy in case of connectivity errors.

Associated Configurations

Throws

  • S3:BAD_REQUEST

  • S3:CONNECTIVITY

  • S3:FORBIDDEN

  • S3:REQUEST_TIMEOUT

  • S3:RETRY_EXHAUSTED

  • S3:S3_ERROR

  • S3:SERVER_BUSY

  • S3:SERVICE_ERROR

Put Bucket Policy

<s3:put-bucket-policy>

Applies an Amazon S3 bucket policy to an Amazon S3 bucket. If you are using an identity other than the root user of the AWS account that owns the bucket, the calling identity must have the PutBucketPolicy permissions on the specified bucket and belong to the bucket owner’s account to use this operation.

Name Type Description Default Value Required

Configuration

String

Name of the configuration to use.

x

Bucket

String

Name of the bucket.

x

Policy

Any

Policy configuration as a JSON.

x

Config Ref

ConfigurationProvider

Name of the configuration to use to execute this component.

x

Reconnection Strategy

Retry strategy in case of connectivity errors.

Associated Configurations

Throws

  • S3:BAD_REQUEST

  • S3:CONNECTIVITY

  • S3:FORBIDDEN

  • S3:REQUEST_TIMEOUT

  • S3:RETRY_EXHAUSTED

  • S3:S3_ERROR

  • S3:SERVER_BUSY

  • S3:SERVICE_ERROR

Put Bucket Tagging

<s3:put-bucket-tagging>

Sets the tags for a bucket. Use tags to organize your AWS bill to reflect your own cost structure. To do this, sign up to get your AWS account bill with tag key values included. Then, to see the cost of combined resources, organize your billing information according to resources with the same tag key values. For example, you can tag several resources with a specific application name, and then organize your billing information to see the total cost of that application across several services.

Name Type Description Default Value Required

Configuration

String

Name of the configuration to use.

x

Bucket

String

Name of the bucket.

x

Bucket Tags

Object

Bucket tags.

Config Ref

ConfigurationProvider

Name of the configuration to use to execute this component.

x

Reconnection Strategy

Retry strategy in case of connectivity errors.

Associated Configurations

Throws

  • S3:BAD_REQUEST

  • S3:CONNECTIVITY

  • S3:FORBIDDEN

  • S3:INTERNAL_ERROR

  • S3:MALFORMED_XML

  • S3:OPERATION_ABORTED

  • S3:REQUEST_TIMEOUT

  • S3:RETRY_EXHAUSTED

  • S3:S3_ERROR

  • S3:SERVER_BUSY

  • S3:SERVICE_ERROR

Put Bucket Versioning

<s3:put-bucket-versioning>

Sets the versioning state of an existing bucket.

Name Type Description Default Value Required

Configuration

String

Name of the configuration to use.

x

Bucket

String

Name of the bucket.

x

Versioning Status

Enumeration, one of:

  • Enabled

  • Suspended

Status of versioning for this bucket.

  • Enabled

    Enables versioning for the objects in the bucket. All objects added to the bucket receive a unique version ID.

  • Suspended

    Disables versioning for the objects in the bucket. All objects added to the bucket receive a null version ID. If the versioning state has never been set on a bucket, it has no versioning state, so a GetBucketVersioning request does not return a versioning state value.

Config Ref

ConfigurationProvider

Name of the configuration to use to execute this component.

x

Reconnection Strategy

Retry strategy in case of connectivity errors.

Associated Configurations

Throws

  • S3:BAD_REQUEST

  • S3:CONNECTIVITY

  • S3:FORBIDDEN

  • S3:REQUEST_TIMEOUT

  • S3:RETRY_EXHAUSTED

  • S3:S3_ERROR

  • S3:SERVER_BUSY

  • S3:SERVICE_ERROR

Put Bucket Website

<s3:put-bucket-website>

Sets the configuration of the website that is specified in the website subresource. To configure a bucket as a website, you can add this subresource on the bucket with website configuration information, such as the file name of the index document and any redirect rules.

This PUT action requires the S3: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 that grants them the S3:PutBucketWebsite permission.

Name Type Description Default Value Required

Configuration

String

Name of the configuration to use.

x

Bucket

String

Name of the bucket.

x

Website Config

Website Configuration

Website serving configuration.

Config Ref

ConfigurationProvider

Name of the configuration to use to execute this component.

x

Reconnection Strategy

Retry strategy in case of connectivity errors.

Associated Configurations

Throws

  • S3:BAD_REQUEST

  • S3:CONNECTIVITY

  • S3:FORBIDDEN

  • S3:REQUEST_TIMEOUT

  • S3:RETRY_EXHAUSTED

  • S3:S3_ERROR

  • S3:SERVER_BUSY

  • S3:SERVICE_ERROR

Put Object

<s3:put-object>

Adds an object to a bucket. You must have WRITE permissions on a bucket to add an object to it. Amazon S3 never adds partial objects; if you receive a success response, Amazon S3 adds the entire object to the bucket.

Amazon S3 is a distributed system. If it receives multiple write requests for the same object simultaneously, it overwrites all but the last object written. Amazon S3 does not provide object locking. If you need object locking, make sure to build it into your application layer or use versioning instead. To ensure that data is not corrupted traversing the network, use the Content-MD5 parameter. When you use this parameter, Amazon S3 checks the object against the provided MD5 value and, if they do not match, returns an error. Additionally, you can calculate the MD5 while putting an object to Amazon S3 and compare the returned ETag to the calculated MD5 value.

Name Type Description Default Value Required

Configuration

String

Name of the configuration to use.

x

Bucket name

String

Bucket name to which the PUT action was initiated

x

Object key

String

Object key for which the PUT action was initiated

x

Content

Any

Content of the object to upload.

#[payload]

Object ACL

Enumeration, one of:

  • PRIVATE

  • PUBLIC_READ

  • PUBLIC_READ_WRITE

  • AWS_EXEC_READ

  • AUTHENTICATED_READ

  • BUCKET_OWNER_READ

  • BUCKET_OWNER_FULL_CONTROL

Canned ACL to apply to the object.

Config Ref

ConfigurationProvider

Name of the configuration to use to execute this component.

x

User Metadata

Object

Custom user metadata.

Content Length

Number

Size of the body in bytes. This field is useful when the size of the body cannot be determined automatically.

Content Type

String

Standard MIME type describing the format of the contents.

Content Language

String

Language the content is in.

Content Encoding

String

Specifies what content encodings are applied to the object and thus what decoding mechanisms to apply to obtain the media-type referenced by the Content Type header field.

Cache Control

String

Specifies caching behavior along the request or reply chain.

Content MD5

String

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

Content Disposition

String

Specifies presentational information for the object.

Expires

DateTime

Date and time at which the object is no longer cacheable.

Storage Class

Enumeration, one of:

  • STANDARD

  • REDUCED_REDUNDANCY

  • STANDARD_IA

  • ONEZONE_IA

  • INTELLIGENT_TIERING

  • GLACIER

  • DEEP_ARCHIVE

  • OUTPOSTS

  • GLACIER_IR

Amazon S3 Storage class in which the object is located.

Request Payer

String

Confirms that the requester knows that they are charged for the request. Bucket owners do not need to specify this field in their requests. Valid value are the requesters.

Sse Customer Algorithm

String

Specifies the algorithm to use to when encrypting the object. Valid values are AES256.

aws:kms

Sse Kms Key Id

String

AWS Key Management System key ID used for Server Side Encryption of the Amazon S3 object. You must specify the Server Side Encryption field when you set the Sse Kms Key Id field.

Sse Customer Key

String

Represents a customer-provided key to use with Amazon S3 server-side encryption.

Sse Kms Key Id

String

AWS Key Management System key ID to use for server-side encryption of the Amazon S3 object. The Server Side Encryption field must be specified when this field is used.

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 is transmitted without error.

Server Side Encryption

String

Server side encryption algorithm used when storing this object in Amazon S3. This field sets the HTTP x-amz-server-side-encryption.

Target Variable

String

Name of the variable that stores the operation’s output.

Target Value

String

Expression that evaluates the operation’s output. The outcome of the expression is stored in the Target Variable field.

#[payload]

Reconnection Strategy

Retry strategy in case of connectivity errors.

Output

Type

Put Object Response

Associated Configurations

Throws

  • S3:BAD_REQUEST

  • S3:CONNECTIVITY

  • S3:FORBIDDEN

  • S3:NO_SUCH_BUCKET

  • S3:REQUEST_TIMEOUT

  • S3:RETRY_EXHAUSTED

  • S3:S3_ERROR

  • S3:SERVER_BUSY

  • S3:SERVICE_ERROR

Put Object ACL

<s3:put-object-acl>

Uses the ACL subresource to set the access control list (ACL) permissions for a new or an existing object in an S3 bucket. You must have WRITE_ACP permission to set the ACL of an object. You can set access permissions using one of the following methods:

  • Specify an Object ACL field. Amazon S3 supports a set of predefined ACLs, known as canned ACLs. Each canned ACL has a predefined set of grantees and permissions.

  • Specify a list of grants using the Grants field. You specify explicit access permissions and grantees (AWS accounts or Amazon S3 groups) who receive the permission.

Name Type Description Default Value Required

Configuration

String

Name of the configuration to use.

x

Bucket name

String

Bucket name that contains the object to which you want to attach the ACL.

x

Object key

String

Object key for which the action is initiated.

x

Content MD5

String

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

Version Id

String

Version ID used to reference a specific version of the object.

Object ACL

Enumeration, one of:

  • PRIVATE

  • PUBLIC_READ

  • PUBLIC_READ_WRITE

  • AWS_EXEC_READ

  • AUTHENTICATED_READ

  • BUCKET_OWNER_READ

  • BUCKET_OWNER_FULL_CONTROL

Canned ACL to apply to the object.

Owner

Owner

Account ID of the expected bucket owner.

Grants

Array of Grant

List of grants.

Config Ref

ConfigurationProvider

Name of the configuration to use to execute this component.

x

Target Variable

String

Name of the variable that stores the operation’s output.

Target Value

String

Expression that evaluates the operation’s output. The outcome of the expression is stored in the Target Variable field.

#[payload]

Reconnection Strategy

Retry strategy in case of connectivity errors.

Output

Type

String

Associated Configurations

Throws

  • S3:BAD_REQUEST

  • S3:CONNECTIVITY

  • S3:FORBIDDEN

  • S3:NO_SUCH_BUCKET

  • S3:NO_SUCH_KEY

  • S3:REQUEST_TIMEOUT

  • S3:RETRY_EXHAUSTED

  • S3:S3_ERROR

  • S3:SERVER_BUSY

  • S3:SERVICE_ERROR

Restore Object

<s3:restore-object>

Restores an archived copy of an object back into Amazon S3. Objects that you archive to the S3 Glacier or S3 Glacier Deep Archive storage class, and S3 Intelligent-Tiering Archive or S3 Intelligent-Tiering Deep Archive tiers are not accessible in real time.

For objects in Archive Access or Deep Archive Access tiers, you must first initiate a restore request, and then wait until the object is moved into the Frequent Access tier.

For objects in S3 Glacier or S3 Glacier Deep Archive storage classes, you must first initiate a restore request, and then wait until a temporary copy of the object is available.

To access an archived object, you must restore the object for the duration (number of days) that you specify.

To restore a specific object version, you can provide a version ID. If you don’t provide a version ID, Amazon S3 restores the current version.

Name Type Description Default Value Required

Configuration

String

Name of the configuration to use.

x

Bucket name

String

Bucket name containing the object to restore.

x

Object key

String

Object key for which the action is initiated.

x

Version Id

String

Version ID used to reference a specific version of the object.

Days

Number

Lifetime of the active copy in days. Do not use with restores that specify OutputLocation.

x

Glacier Job Tier

Enumeration, one of:

  • Standard

  • Bulk

  • Expedited

Retrieval tier at which the restore is processed.

x

Config Ref

ConfigurationProvider

Name of the configuration to use to execute this component.

x

Target Variable

String

Name of the variable that stores the operation’s output.

Target Value

String

Expression that evaluates the operation’s output. The outcome of the expression is stored in the Target Variable field.

#[payload]

Reconnection Strategy

Retry strategy in case of connectivity errors.

Output

Type

Restore Object Response

Associated Configurations

Throws

  • S3:BAD_REQUEST

  • S3:CONNECTIVITY

  • S3:FORBIDDEN

  • S3:GLACIER_EXPEDITED_RETRIEVAL_NOT_AVAILABLE

  • S3:INVALID_OBJECT_STATE

  • S3:NO_SUCH_BUCKET

  • S3:NO_SUCH_KEY

  • S3:OBJECT_ALREADY_IN_ACTIVE_TIER

  • S3:REQUEST_TIMEOUT

  • S3:RESTORE_ALREADY_IN_PROGRESS

  • S3:RETRY_EXHAUSTED

  • S3:S3_ERROR

  • S3:SERVER_BUSY

  • S3:SERVICE_ERROR

Select Object Content

<s3:select-object-content>

Filters the contents of an Amazon S3 object based on a simple structured query language (SQL) statement.

In the request, along with the SQL expression, you must also specify a data serialization format (JSON, CSV, or Apache Parquet) of the object. Amazon S3 uses this format to parse object data into records, and returns only records that match the specified SQL expression.

You must also specify the data serialization format for the response. You can use the Amazon S3 Select Object operation to query objects formatted as CSV, JSON, or Parquet files.

This operation supports the following compression types:

  • GZIP and BZIP2 for CSV and JSON files

  • Columnar compression for Parquet files using GZIP or Snappy

The Amazon S3 Select Object operation does not support whole-object compression for Parquet files.

Name Type Description Default Value Required

Configuration

String

Name of the configuration to use.

x

Bucket name

String

Bucket name containing the object content to select.

x

Object key

String

Object key containing the content to select.

x

Expression

String

Expression that is used to query the object.

x

Expression Type

String

Type of the provided expression.

x

Input Serialization

Api Input Serialization

Describes the format of the data in the object that is being queried.

x

Output Serialization

Api Output Serialization

Describes the format of the data that you want Amazon S3 to return in response.

x

Scan Range

Api Scan Range

Specifies the byte range of the object to get the records from. A record is processed when its first byte is contained by the range.

Request Progress Enabled

Boolean

Specifies if periodic request progress information must be enabled.

false

Sse Customer Algorithm

String

Server-side encryption (SSE) algorithm used to encrypt the object. This field is required only when the object is created using a checksum algorithm.

Sse Customer Key

String

Server-side encryption (SSE) customer managed key. This field is required only when the object is created using a checksum algorithm.

Sse Customer Key MD5

String

MD5 server-side encryption (SSE) customer managed key.

Output Mime Type

String

MIME type of the payload that this operation outputs.

Output Encoding

String

Encoding of the payload that this operation outputs.

Config Ref

ConfigurationProvider

Name of the configuration to use to execute this component.

x

Streaming Strategy

Configures how Mule processes streams. Repeatable streams are the default behavior.

Target Variable

String

Name of the variable that stores the operation’s output.

Target Value

String

Expression that evaluates the operation’s output. The outcome of the expression is stored in the Target Variable field.

#[payload]

Reconnection Strategy

Retry strategy in case of connectivity errors.

Output

Type

Any

Associated Configurations

Throws

  • S3:BAD_REQUEST

  • S3:CONNECTIVITY

  • S3:FORBIDDEN

  • S3:NO_SUCH_BUCKET

  • S3:NO_SUCH_KEY

  • S3:REQUEST_TIMEOUT

  • S3:RETRY_EXHAUSTED

  • S3:S3_ERROR

  • S3:SERVER_BUSY

  • S3:SERVICE_ERROR

Upload Part

<s3:upload-part>

Uploads a part in a multipart upload.

In this operation, you provide part data in your request. However, you have an option to specify your existing Amazon S3 object as a data source for the part you are uploading.

To upload a part from an existing object, use the Upload Part Copy operation. You must initiate a multipart upload (refer to Create Multipart Upload) before you can upload any part.

In response to your initiate request, Amazon S3 returns an upload ID and an unique identifier that you must include in your upload part request. Part numbers can be any number from 1 to 10,000, inclusive. A part number uniquely identifies a part and also defines its position within the object created. If you upload a new part using the same part number that is used with a previous part, the previously uploaded part is overwritten. Each part must be at least 5 MB in size, except the last part. There is no size limit on the last part of your multipart upload.

To ensure that data is not corrupted when traversing the network, specify the Content-MD5 header in the upload part request. Amazon S3 checks the part data against the provided MD5 value. If they do not match, Amazon S3 returns an error.

After you initiate a multipart upload and upload one or more parts, you must either complete or abort the multipart upload to stop getting charged for storing the uploaded parts. After you complete or abort the multipart upload, Amazon S3 frees up the parts storage and stops charging you for it.

Common Cases for the Operation

  • When you upload content of a large file in parts (for example, an FTP Connector Read operation or SFTP Connector On New or Updated File source of a Mule app), you must configure the non repeatable stream strategy in these operations. You must also specify the number of bytes to consume from the content in the Upload part > Content length field.

  • When you upload the content of many small files, you can configure either the repeatable stream or non repeatable stream strategy in the FTP or SFTP Connector operations. In the Upload part operation, you can optionally specify the entire file size in the Content length field.

Name Type Description Default Value Required

Configuration

String

Name of the configuration to use.

x

Bucket name

String

Name of the bucket in which the multipart upload is initiated.

x

Object key

String

Object key for which the multipart upload is initiated.

x

Upload Id

String

Upload ID identifying the multipart upload whose part is uploaded.

x

Part Number

Number

Part number of part uploaded. This is a positive integer between 1 and 10,000.

x

Content

Any

Object data.

x

Content MD5

String

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

Content Length

Number

Size of the body in bytes. This field is useful when the size of the body cannot be determined automatically.

Config Ref

ConfigurationProvider

Name of the configuration to use to execute this component.

x

Target Variable

String

Name of the variable that stores the operation’s output.

Target Value

String

Expression that evaluates the operation’s output. The outcome of the expression is stored in the Target Variable field.

#[payload]

Reconnection Strategy

Retry strategy in case of connectivity errors.

Output

Type

Upload Part Response

Associated Configurations

Throws

  • S3:BAD_REQUEST

  • S3:CONNECTIVITY

  • S3:FORBIDDEN

  • S3:REQUEST_TIMEOUT

  • S3:RETRY_EXHAUSTED

  • S3:S3_ERROR

  • S3:SERVER_BUSY

  • S3:SERVICE_ERROR

Upload Part Copy

<s3:upload-part-copy>

Uploads a part by copying data from an existing object as data source. The minimum allowable part size for a multipart upload is 5 MB. Instead of using an existing object as part data, you can use the Upload Part operation and provide data in your request. You must initiate a multipart upload before you can upload a part. Amazon S3 returns a unique identifier, the upload ID, that you must include in your upload part request.

Name Type Description Default Value Required

Configuration

String

Name of the configuration to use.

x

Source bucket name

String

Name of the source bucket.

x

Source object key

String

Name of the source key.

x

Destination bucket name

String

Bucket name.

x

Destination object key

String

Object key for which the multipart upload is initiated.

x

Upload Id

String

Upload ID identifying the multipart upload whose part is copied.

x

Part number

Number

Part number of part copied. This is a positive integer between 1 and 10,000.

x

Bytes range

String

Range of the bytes that are copied from the source object from the first byte to the last byte.

Config Ref

ConfigurationProvider

Name of the configuration to use to execute this component.

x

Matching ETag

String

Matches the object if its entity tag (ETag) matches the specified tag.

Not matching ETag

String

Matches the object if its entity tag (ETag) is different from the specified tag.

Modified since

DateTime

Matches the object if it was modified since the specified time.

Unmodified since

DateTime

Matches the object if it was not modified since the specified time.

Target Variable

String

Name of the variable that stores the operation’s output.

Target Value

String

Expression that evaluates the operation’s output. The outcome of the expression is stored in the Target Variable field.

#[payload]

Reconnection Strategy

Retry strategy in case of connectivity errors.

Output

Type

Upload Part Copy Response

Associated Configurations

Throws

  • S3:BAD_REQUEST

  • S3:CONNECTIVITY

  • S3:FORBIDDEN

  • S3:REQUEST_TIMEOUT

  • S3:RETRY_EXHAUSTED

  • S3:S3_ERROR

  • S3:SERVER_BUSY

  • S3:SERVICE_ERROR

Object Types

Api Checksum

Configures the API checksum type.

Field Type Description Default Value Required

Checksum CRC32

String

Checksum CRC32.

Checksum CRC32 C

String

Checksum CRC32 C.

Checksum SHA1

String

Checksum SHA1.

Checksum SHA256

String

Checksum SHA256.

Api Copy Object Result

Configures the API copy object result type.

Field Type Description Default Value Required

E Tag

String

ETag.

Checksum CRC32

String

Checksum CRC32.

Checksum CRC32 C

String

Checksum CRC32 C.

Checksum SHA1

String

Checksum SHA1.

Checksum SHA256

String

Checksum SHA256.

Last Modified

DateTime

Last modified.

Api Copy Part Result

Configures the API copy part result type.

Field Type Description Default Value Required

E Tag

String

ETag.

Checksum CRC32

String

Checksum CRC32.

Checksum CRC32 C

String

Checksum CRC32 C.

Checksum SHA1

String

Checksum SHA1.

Checksum SHA256

String

Checksum SHA256.

Last Modified

DateTime

Last modified.

Api CSV Input

Configures the API CSV input type.

Field Type Description Default Value Required

File Header Info

Enumeration, one of:

  • USE

  • IGNORE

  • NONE

File header information.

Comments

String

Comments.

Quote Escape Character

String

Quote escape character.

Record Delimiter

String

Record delimiter.

Field Delimiter

String

Field delimiter.

Quote Character

String

Quote character.

Allow Quoted Record Delimiter

Boolean

Allow quoted record delimiter.

false

Api CSV Output

Configures the API CSV output type.

Field Type Description Default Value Required

Quote Fields

Enumeration, one of:

  • ALWAYS

  • ASNEEDED

Quote fields.

Quote Escape Character

String

Quote escape character.

Record Delimiter

String

Record delimiter.

Field Delimiter

String

Field delimiter.

Quote Character

String

Quote character.

Api Get Object Attributes Parts

Configures the API get object attributes parts type.

Field Type Description Default Value Required

Max Parts

Number

Maximum parts.

Next Part Number Marker

Number

Next part number marker.

Part Number Marker

Number

Part number marker.

Parts

Array of Api Object Part

Parts.

Total Parts Count

Number

Total parts count.

Truncated

Boolean

Truncated.

Api Initiator

Configures the API initiator type.

Field Type Description Default Value Required

Id

String

ID.

Display Name

String

Display name.

Api Input Serialization

Configures the API input serialization type.

Field Type Description Default Value Required

Csv Input

Api CSV Input

CSV input.

Compression Type

Enumeration, one of:

  • NONE

  • GZIP

  • BZIP2

Compression type.

NONE

Json

Enumeration, one of:

  • DOCUMENT

  • LINES

JSON.

Parquet

Boolean

Parquet.

false

Api Object Part

Configures the API object part type.

Field Type Description Default Value Required

Checksum CRC32

String

Checksum CRC32.

Checksum CRC32 C

String

Checksum CRC32 C.

Checksum SHA1

String

Checksum SHA1.

Checksum SHA256

String

Checksum SHA256.

Part Number

Number

Part number.

Size

Number

Size.

Api Object Version

Configures the API object version type.

Field Type Description Default Value Required

E Tag

String

ETag.

Checksum Algorithm

Array of String

Checksum algorithm.

Key

String

Key.

Last Modified

DateTime

Last modified.

Latest

Boolean

Latest.

Owner

Owner

Owner.

Size

Number

Size.

Storage Class

String

Storage class.

Version Id

String

Version ID.

Api Output Serialization

Configures the API output serialization type.

Field Type Description Default Value Required

Csv Output

Api CSV Output

CSV output.

JSON Output Record Delimiter

String

JSON output record delimiter.

Api S3 Object

Configures the API S3 object type.

Field Type Description Default Value Required

E Tag

String

ETag.

Checksum Algorithm

Array of String

Checksum algorithm.

Key

String

Key.

Last Modified

DateTime

Last modified.

Owner

Owner

Owner.

Size

Number

Size.

Storage Class

String

Storage class.

Api Scan Range

Configures the API scan range type.

Field Type Description Default Value Required

Start

Number

Start.

End

Number

End.

Bucket Acl Response

Configures the bucket ACL response type.

Field Type Description Default Value Required

Owner

Owner

Owner.

x

Grants

Array of Grant

Grants.

x

Bucket Cors Response

Configures the bucket CORS reponse.

Field Type Description Default Value Required

Cors Rules

Array of Cors Rule

CORS rules.

Bucket Notification Response

Configures the bucket notification response type.

Field Type Description Default Value Required

Event Bridge

Boolean

Event bridge.

Lambda Function Configurations

Array of Lambda Function Configuration

Lambda function configurations.

Queue Configurations

Array of Queue Configuration

Queue configurations.

Topic Configurations

Array of Topic Configuration

Topic configurations.

Bucket Policy Response

Configures the bucket policy response type.

Field Type Description Default Value Required

Policy

String

Policy.

Bucket Response

Configures the bucket response type.

Field Type Description Default Value Required

Name

String

Name.

x

Creation Date

DateTime

Creation date.

x

Bucket Tagging Response

Configures the bucket tagging response type.

Field Type Description Default Value Required

Tags

Array of Tag

Tags.

Bucket Versioning Response

Configures the bucket versioning response type.

Field Type Description Default Value Required

Mfa Delete

String

MFA delete.

Status

Enumeration, one of:

  • Enabled

  • Suspended

Status.

Bucket Website Response

Configures the bucket website response type.

Field Type Description Default Value Required

Error Document Key

String

Error document key.

Index Document Suffix

String

Index document suffix.

Redirect All Requests To

Redirect Rule

Redirect all requests to.

Routing Rules

Array of Routing Rule

Routing rules.

Complete Multipart Upload Response

Configures the complete multipart upload response type.

Field Type Description Default Value Required

E Tag

String

ETag.

Bucket

String

Bucket name.

Bucket Key Enabled

Boolean

Enables the bucket key.

Expiration

String

Expiration.

Key

String

Key name.

Location

String

Location.

Request Charged

String

Request charged.

Server Side Encryption

String

Server-side encryption.

Ssekms Key Id

String

AWS SSEKMS Key ID.

Version Id

String

Version ID.

Condition

Configures the condition type.

Field Type Description Default Value Required

Http Error Code Returned Equals

String

HTTP error code returned equals.

Key Prefix Equals

String

Key prefix equals.

Copy Object Response

Configures the copy object response type.

Field Type Description Default Value Required

Bucket Key Enabled

Boolean

Enables the bucket key.

Copy Object Result

Api Copy Object Result

Copy the object result.

Copy Source Version Id

String

Copy the source version ID.

Expiration

String

Expiration.

Request Charged

String

Request charged.

Server Side Encryption

String

Server-side encryption.

Sse Customer Algorithm

String

SSE customer algorithm.

Sse Customer Key MD5

String

SSE customer key MD5.

Ssekms Encryption Context

String

SSEKMS encryption context.

Ssekms Key Id

String

SSEKMS key ID.

Version Id

String

Version ID.

Cors Rule

Configures the CORS rule type.

Field Type Description Default Value Required

Id

String

ID.

Allowed Headers

Array of String

Allowed headers.

Allowed Methods

Array of String

Allowed methods.

x

Allowed Origins

Array of String

Allowed origins.

x

Expose Headers

Array of String

Expose headers.

Max Age Seconds

Number

Maximum age of seconds.

Create Multipart Upload Response

Configures the create multipart upload response type.

Field Type Description Default Value Required

Abort Date

DateTime

Abort date.

Abort Rule Id

String

Abort rule ID.

Bucket

String

Bucket.

Bucket Key Enabled

Boolean

Enables bucket key.

Key

String

Key.

Request Charged

String

Request charged.

Server Side Encryption

String

Server-side encryption.

Sse Customer Algorithm

String

SSE customer algorithm.

Sse Customer Key MD5

String

SSE customer key MD5.

Ssekms Encryption Context

String

SSEKMS encryption context.

Ssekms Key Id

String

SSEKMS key ID.

Upload Id

String

Upload ID.

CRL File

Specifies the location of the certification revocation list (CRL) file.

Field Type Description Default Value Required

Path

String

Path to the CRL file.

Custom OCSP Responder

Configures a custom OCSP responder for certification revocation checks.

Field Type Description Default Value Required

Url

String

URL of the OCSP responder.

Cert Alias

String

Alias of the signing certificate for the OCSP response. If specified, the alias must be in the truststore.

Expiration Policy

Configures an expiration policy strategy.

Field Type Description Default Value Required

Max Idle Time

Number

Configures the maximum amount of time that a dynamic configuration instance can remain idle before Mule considers it eligible for expiration.

Time Unit

Enumeration, one of:

  • NANOSECONDS

  • MICROSECONDS

  • MILLISECONDS

  • SECONDS

  • MINUTES

  • HOURS

  • DAYS

Time unit for the Max Idle Time field.

Filter Rule

Configures the filter rule type.

Field Type Description Default Value Required

Key Name

String

Key name.

x

Value

String

Value for this type.

x

Get Object Acl Response

Configures the get object ACL response type.

Field Type Description Default Value Required

Grants

Array of Grant

Grants.

Owner

Owner

Owner.

Request Charged

String

Request charged.

Get Object Attributes Response

Configures the get object attributes response type.

Field Type Description Default Value Required

E Tag

String

ETag.

Checksum

Api Checksum

Checksum.

Delete Marker

Boolean

Delete marker.

Last Modified

DateTime

Last modified.

Object Parts

Api Get Object Attributes Parts

Object parts.

Object Size

Number

Object size.

Request Charged

String

Request charged.

Storage Class

String

Storage class.

Version Id

String

Version ID.

Get Object Operation Attributes

Configures the get object operation attributes response type.

Field Type Description Default Value Required

E Tag

String

ETag.

Accept Ranges

String

Accept ranges.

Bucket Key Enabled

Boolean

Enable bucket key.

Cache Control

String

Cache control.

Checksum CRC32

String

Checksum CRC32.

Checksum CRC32 C

String

Checksum CRC32 C.

Checksum SHA1

String

Checksum SHA1.

Checksum SHA256

String

Checksum SHA256.

Content Disposition

String

Content disposition.

Content Encoding

String

Content encoding.

Content Language

String

Content language.

Content Length

Number

Content length.

Content Range

String

Content range.

Content Type

String

Content type.

Delete Marker

Boolean

Delete marker.

Expiration

String

Expiration.

Expires

DateTime

Expires.

Last Modified

DateTime

Last modified.

Metadata

Object

Metadata.

Missing Meta

Number

Missing meta.

Object Lock Legal Hold Status

String

Object lock legal hold status.

Object Lock Mode

String

Object lock mode.

Object Lock Retain Until Date

DateTime

Object lock retain until date.

Parts Count

Number

Parts count.

Replication Status

String

Replication status.

Request Charged

String

Request charged.

Restore

String

Restore.

Server Side Encryption

String

Server-side encryption.

Sse Customer Algorithm

String

SSE customer algorithm.

Sse Customer Key MD5

String

SSE customer key MD5.

Ssekms Key Id

String

SSEKMS key ID.

Storage Class

String

Storage class.

Tag Count

Number

Tag count.

Version Id

String

Version ID.

Website Redirect Location

String

Website redirect location.

Grant

Configures the grant type.

Field Type Description Default Value Required

Grantee

Grantee

Grantee.

Permission

String

Permission.

Grantee

Configures the grantee type.

Field Type Description Default Value Required

Display Name

String

Display name.

Type

Enumeration, one of:

  • CANONICAL_USER

  • AMAZON_CUSTOMER_BY_EMAIL

  • GROUP

Type.

x

Id

String

ID.

Email Address

String

Email address.

Uri

String

URI.

Head Object Response

Configures the head object response type.

Field Type Description Default Value Required

E Tag

String

ETag.

Accept Ranges

String

Accept ranges.

Archive Status

String

Archive status.

Bucket Key Enabled

Boolean

Enable bucket key.

Cache Control

String

Cache control.

Checksum CRC32

String

Checksum CRC32.

Checksum CRC32 C

String

Checksum CRC32 C.

Checksum SHA1

String

Checksum SHA1.

Checksum SHA256

String

Checksum SHA256.

Content Disposition

String

Content disposition.

Content Encoding

String

Content encoding.

Content Language

String

Content language.

Content Length

Number

Content length.

Content Type

String

Content type.

Delete Marker

Boolean

Delete marker.

Expiration

String

Expiration.

Expires

DateTime

Expires.

Last Modified

DateTime

Last modified.

Metadata

Object

Metadata.

Missing Meta

Number

Missing meta.

Object Lock Legal Hold Status

String

Object lock legal hold status.

Object Lock Mode

String

Object lock mode.

Object Lock Retain Until Date

DateTime

Object lock retain until date.

Parts Count

Number

Parts count.

Replication Status

String

Replication status.

Request Charged

String

Request charged.

Restore

String

Restore.

Server Side Encryption

String

Server-side encryption.

Sse Customer Algorithm

String

SSE customer algorithm.

Sse Customer Key MD5

String

SSE customer key MD5.

Ssekms Key Id

String

SSEKMS key ID.

Storage Class

String

Storage class.

Version Id

String

Version ID.

Website Redirect Location

String

Website redirect location.

Keystore

Configures the keystore for the TLS protocol. The keystore you generate contains a private key and a public certificate.

Field Type Description Default Value Required

Path

String

Path to the keystore. Mule resolves the path relative to the current classpath and file system.

Type

String

Type of store.

Alias

String

Alias of the key to use when the keystore contains multiple private keys. By default, Mule uses the first key in the file.

Key Password

String

Password used to protect the private key.

Password

String

Password used to protect the keystore.

Algorithm

String

Encryption algorithm that the keystore uses.

Lambda Function Configuration

Configures the lambda function configuration type.

Field Type Description Default Value Required

Cloud Function

String

Cloud function.

x

Events

String

Events.

x

Notification Filter

Notification Configuration Filter

Notification filter.

x

Id

String

ID.

x

Lifecycle Configuration

Configures the lifecycle configuration type.

Field Type Description Default Value Required

Rules

Array of Lifecycle Rule

Rules.

Lifecycle Rule

Configures the lifecycle rule type.

Field Type Description Default Value Required

Id

String

ID.

Lifecycle Filter

Lifecycle Rule Filter

Lifecycle filter.

Status

String

Status.

x

Expiration Days

Number

Expiration days.

Expiration Date

DateTime

Expiration date.

Transitions

Array of Transition

Transitions.

Noncurrent Version Transitions

Array of Noncurrent Version Transition

Noncurrent version transitions.

Days To Abort Incomplete Multipart Upload

Number

Days to abort incomplete multipart upload.

Noncurrent Version Expiration In Days

Number

Noncurrent version expiration in days.

Lifecycle Rule Filter

Configures the lifecycle rule filter type.

Field Type Description Default Value Required

Prefix

String

Prefix.

List Buckets Response

Configures the list buckets response type.

Field Type Description Default Value Required

Buckets

Array of Bucket Response

Buckets.

Owner

Owner

Owner.

Logging Status

Configures the logging status type.

Field Type Description Default Value Required

Logging Enabled

ApiLoggingEnabled

Logging enabled.

Multipart Part

Configures the multipart part type.

Field Type Description Default Value Required

E Tag

String

ETag.

x

Part Number

Number

x

Multipart Upload

Configures the multipart upload type.

Field Type Description Default Value Required

Upload Id

String

Upload ID.

Key

String

Key.

Initiated

DateTime

Initiated.

Storage Class

Enumeration, one of:

  • STANDARD

  • REDUCED_REDUNDANCY

  • STANDARD_IA

  • ONEZONE_IA

  • INTELLIGENT_TIERING

  • GLACIER

  • DEEP_ARCHIVE

  • OUTPOSTS

  • GLACIER_IR

Storage class.

Owner

Owner

Owner.

Initiator

Api Initiator

Initiator.

Noncurrent Version Transition

Configures the noncurrent version transition type.

Field Type Description Default Value Required

Noncurrent Days

Number

Noncurrent days.

Storage Class

Enumeration, one of:

  • STANDARD

  • REDUCED_REDUNDANCY

  • STANDARD_IA

  • ONEZONE_IA

  • INTELLIGENT_TIERING

  • GLACIER

  • DEEP_ARCHIVE

  • OUTPOSTS

  • GLACIER_IR

Storage class.

Newer Noncurrent Versions

Number

Newer noncurrent versions.

Notification Configuration

Configures the notification configuration type.

Field Type Description Default Value Required

Topic Configurations

Array of Topic Configuration

Topic configurations.

Lambda Function Configurations

Array of Lambda Function Configuration

Lambda function configurations.

Queue Configurations

Array of Queue Configuration

Queue configurations.

Event Bridge

Boolean

Event bridge.

false

Notification Configuration Filter

Configures the notification configuration filter type.

Field Type Description Default Value Required

Key

S3 Key Filter

Key.

x

Object Identifier

Configures the object identifier type.

Field Type Description Default Value Required

Key

String

Key for this type.

x

Version Id

String

Version ID.

Owner

Configures the owner of an Amazon S3 bucket.

Field Type Description Default Value Required

Id

String

ID of the owner.

Display Name

String

Display name of the owner.

Proxy

Configures a proxy for outbound connections.

Field Type Description Default Value Required

Host

String

Hostname or IP address of the proxy server.

x

Port

Number

Port of the proxy server.

x

Username

String

Username to authenticate against the proxy server.

Password

String

Password to authenticate against the proxy server.

Non Proxy Hosts

Array of String

Non-proxy hosts.

Ntlm Domain

String

NTLM domain.

Put Object Response

Configures the put object response type.

Field Type Description Default Value Required

E Tag

String

ETag.

Bucket Key Enabled

Boolean

Bucket key enabled.

Checksum CRC32

String

Checksum CRC32.

Checksum CRC32 C

String

Checksum CRC32 C.

Checksum SHA1

String

Checksum SHA1.

Checksum SHA256

String

Checksum SHA256.

Expiration

String

Expiration.

Request Charged

String

Request charged.

Server Side Encryption

String

Server-side encryption.

Sse Customer Algorithm

String

SSE customer algorithm.

Sse Customer Key MD5

String

SSE customer key MD5.

Ssekms Encryption Context

String

SSEKMS encryption context.

Ssekms Key Id

String

SSEKMS key ID.

Version Id

String

Version ID.

Queue Configuration

Configures the queue configuration type.

Field Type Description Default Value Required

Queue Arn

String

Queue ARN.

x

Events

String

Events.

x

Notification Filter

Notification Configuration Filter

Notification filter.

x

Id

String

ID.

x

Reconnect

Configures a standard reconnection strategy, which specifies how often to reconnect and how many reconnection attempts the connector source or operation can make.

Field Type Description Default Value Required

Frequency

Number

How often to attempt to reconnect, in milliseconds.

Blocking

Boolean

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

Count

Number

How many reconnection attempts the Mule app can make.

Reconnect Forever

Configures a forever reconnection strategy by which the connector source or operation attempts to reconnect at a specified frequency for as long as the Mule app runs.

Field Type Description Default Value Required

Frequency

Number

How often to attempt to reconnect, in milliseconds.

Blocking

Boolean

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

Reconnection

Configures a reconnection strategy for an operation.

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

Reconnection strategy to use.

Redelivery Policy

Configures the redelivery policy for executing requests that generate errors. You can add a redelivery policy to any source in a flow.

Field Type Description Default Value Required

Max Redelivery Count

Number

Maximum number of times that a redelivered request can be processed unsuccessfully before returning a REDELIVERY_EXHAUSTED error.

Message Digest Algorithm

String

Secure hashing algorithm to use if the Use Secure Hash field is true. If the payload of the message is a Java object, Mule ignores this value and returns the value that the payload’s hashCode() returned.

Message Identifier

Redelivery Policy Message Identifier

One or more expressions that determine if a message was redelivered. This property can be set only if the Use Secure Hash field is false.

Object Store

ObjectStore

Configures the object store that stores the redelivery counter for each message.

Redelivery Policy Message Identifier

Configures how to identify a redelivered message and how to find out when the message was redelivered.

Field Type Description Default Value Required

Use Secure Hash

Boolean

If true, Mule uses a secure hash algorithm to identify a redelivered message.

Id Expression

String

One or more expressions that determine when a message was redelivered. You can set this property only if the Use Secure Hash field is false.

Redirect

Configures the redirect type.

Field Type Description Default Value Required

Host Name

String

Host name.

Http Redirect Code

String

HTTP redirect code.

Protocol

Enumeration, one of:

  • HTTP

  • HTTPS

Protocol.

Replace Key Prefix With

String

Replace key prefix.

Replace Key With

String

Replace key.

Redirect Rule

Configures the redirect rule type.

Field Type Description Default Value Required

Hostname

String

Hostname.

x

Protocol

Enumeration, one of:

  • HTTP

  • HTTPS

Protocol.

Repeatable File Store Iterable

Configures the repeatable file store iterable type.

Field Type Description Default Value Required

In Memory Objects

Number

Maximum amount of instances to keep in memory. If more than that is required, content on the disk is buffered.

Buffer Unit

Enumeration, one of:

  • BYTE

  • KB

  • MB

  • GB

Unit for the In Memory Objects field.

Repeatable File Store Stream

Configures the repeatable file-store streaming strategy by which Mule keeps a portion of the stream content in memory. If the stream content is larger than the configured buffer size, Mule backs up the buffer’s content to disk and then clears the memory.

Field Type Description Default Value Required

In Memory Size

Number

Maximum amount of memory that the stream can use for data. If the amount of memory exceeds this value, Mule buffers the content to disk. To optimize performance:

  • Configure a larger buffer size to avoid the number of times Mule needs to write the buffer on disk. This increases performance, but it also limits the number of concurrent requests your application can process, because it requires additional memory.

  • Configure a smaller buffer size to decrease memory load at the expense of response time.

Buffer Unit

Enumeration, one of:

  • BYTE

  • KB

  • MB

  • GB

Unit for the In Memory Size field.

Repeatable In Memory Iterable

Configures the repeatable in memory iterable type.

Field Type Description Default Value Required

Initial Buffer Size

Number

Amount of instances that is initially allowed to keep 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 Buffer Size Increment attribute, with an upper limit of Max In Memory Size.

100

Buffer Size Increment

Number

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

100

Max Buffer Size

Number

Maximum size of the buffer. If the buffer size exceeds this value, Mule raises a STREAM_MAXIMUM_SIZE_EXCEEDED error. A value of less than or equal to 0 means no limit.

Repeatable In Memory Stream

Configures the in-memory streaming strategy by which the request fails if the data exceeds the MAX buffer size. Always run performance tests to find the optimal buffer size for your specific use case.

Field Type Description Default Value Required

Initial Buffer Size

Number

Initial amount of memory to allocate to the data stream. If the streamed data exceeds this value, the buffer expands by Buffer Size Increment, with an upper limit of Max In Memory Size value.

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

Maximum size of the buffer. If the buffer size exceeds this value, Mule raises a STREAM_MAXIMUM_SIZE_EXCEEDED error. A value of less than or equal to 0 means no limit.

Buffer Unit

Enumeration, one of:

  • BYTE

  • KB

  • MB

  • GB

Unit for the Initial Buffer Size, Buffer Size Increment, Max Buffer Size, and Buffer Unit fields.

Restore Object Response

Configures the restore object response type.

Field Type Description Default Value Required

Request Charged

String

Request charged.

Restore Output Path

String

Restore output path.

Role

Configures the Role type.

The Role type is supported only for standalone or Runtime Fabric deployments. The Role type is not supported for CloudHub 1.0 deployments.
Field Type Description Default Value Required

Arn

String

ARN.

x

External Id

String

External ID.

Duration

Number

Duration.

3600

Duration Time Unit

Enumeration, one of:

  • NANOSECONDS

  • MICROSECONDS

  • MILLISECONDS

  • SECONDS

  • MINUTES

  • HOURS

  • DAYS

Time unit for the Duration field.

SECONDS

Referred Policy Arns

Array of String

Referred policy ARNs.

Tags

Object

Tags.

Custom Sts Endpoint

String

Custom STS endpoint.

Routing Rule

Configures the routing rule type.

Field Type Description Default Value Required

Condition

Condition

Condition.

Redirect

Redirect

Redirect.

x

S3 Key Filter

Configures the S3 key filter type.

Field Type Description Default Value Required

Filter Rules

Array of Filter Rule

Filter rules.

x

S3 Object Trigger Response

Configures the S3 object trigger response type.

Field Type Description Default Value Required

E Tag

String

ETag.

Bucket Name

String

Bucket name.

Key

String

Key.

Owner

Owner

Owner.

Sequencer

String

Sequencer.

Size

String

Size.

Version Id

String

Version ID.

Standard Revocation Check

Configures standard revocation checks for TLS certificates.

Field Type Description Default Value Required

Only End Entities

Boolean

Which elements to verify in the certificate chain:

  • true

    Verify only the last element in the certificate chain.

  • false

    Verify all elements in the certificate chain.

Prefer Crls

Boolean

How to check certificate validity:

  • true

    Check the Certification Revocation List (CRL) for certificate validity.

  • false

    Use the Online Certificate Status Protocol (OCSP) to check certificate validity.

No Fallback

Boolean

Whether to use the secondary method to check certificate validity:

  • true

    Use the method that wasn’t specified in the Prefer Crls field (the secondary method) to check certificate validity.

  • false

    Do not use the secondary method to check certificate validity.

Soft Fail

Boolean

What to do if the revocation server can’t be reached or is busy:

  • true

    Avoid verification failure.

  • false

    Allow the verification to fail.

Tag

Configures the tag type.

Field Type Description Default Value Required

Key

String

Key for this type.

x

Value

String

Value for this type.

x

TLS

Configures TLS to provide secure communications for the Mule app.

Field Type Description Default Value Required

Enabled Protocols

String

Comma-separated list of protocols enabled for this context.

Enabled Cipher Suites

String

Comma-separated list of cipher suites enabled for this context.

Trust Store

Truststore

Configures the TLS truststore.

Key Store

Keystore

Configures the TLS keystore.

Revocation Check

Configures a revocation checking mechanism.

Topic Configuration

Configures the topic configuration type.

Field Type Description Default Value Required

Topic Arn

String

Topic ARN.

x

Events

String

Events.

x

Notification Filter

Notification Configuration Filter

Notification filter.

x

Id

String

ID.

x

Transition

Configures the transition type.

Field Type Description Default Value Required

Date

DateTime

Date.

Days

Number

Days.

Storage Class

Enumeration, one of:

  • STANDARD

  • REDUCED_REDUNDANCY

  • STANDARD_IA

  • ONEZONE_IA

  • INTELLIGENT_TIERING

  • GLACIER

  • DEEP_ARCHIVE

  • OUTPOSTS

  • GLACIER_IR

Storage class.

Truststore

Configures the truststore for TLS.

Field Type Description Default Value Required

Path

String

Path to the truststore. Mule resolves the path relative to the current classpath and file system.

Password

String

Password used to protect the truststore.

Type

String

Type of store.

Algorithm

String

Encryption algorithm that the truststore uses.

Insecure

Boolean

If true, Mule stops performing certificate validations. Setting this to true can make connections vulnerable to attacks.

Upload Part Copy Response

Configures the upload part copy response type.

Field Type Description Default Value Required

Bucket Key Enabled

Boolean

Bucket key enabled.

Copy Part Result

Api Copy Part Result

Copy the part result.

Copy Source Version Id

String

Copy the source version ID.

Request Charged

String

Request charged.

Server Side Encryption

String

Server-side encryption.

Sse Customer Algorithm

String

SSE customer algorithm.

Sse Customer Key MD5

String

SSE customer key MD5.

Ssekms Key Id

String

SSEKMS key ID.

Upload Part Response

Configures the upload part response type.

Field Type Description Default Value Required

E Tag

String

ETag.

Bucket Key Enabled

Boolean

Bucket key enabled.

Request Charged

String

Request charged.

Server Side Encryption

String

Server-side encryption.

Sse Customer Algorithm

String

SSE customer algorithm.

Sse Customer Key MD5

String

SSE customer key MD5.

Ssekms Key Id

String

SSEKMS key ID.

Website Configuration

Configures the website configuration type.

Field Type Description Default Value Required

Error Document Key

String

Error document key.

Index Document Suffix

String

Index document suffix.

Redirect Rule

Redirect Rule

Redirect rule.

Routing Rules

Array of Routing Rule

Routing rules.

See Also

Back to top
View on GitHub