Skip to main content

S3 Get Object

Retrieves an object from Amazon S3.

component image

In-ports​

s3-uri String — the location of a S3 object.

trigger <any> — triggers the S3 request.

abort <any> — aborts all pending requests.

config JSON (dynamic) — accepts a JSON object with configuration properties that can be set at runtime.

Out-ports​

response JSON — response wrapped into JSON object.

errors JSON — emits any errors that occur during action execution.

Overview​

The S3 Get Object component allows you to retrieve an object from Amazon S3. This component is part of the group of components designed to perform operations with Amazon S3.

To retrieve an object, send an S3 URI of the object to the s3-uri port. S3 URI indicates an S3 location in the format s3://amzn-s3-demo-bucket/mykey, where amzn-s3-demo-bucket is the bucket name and mykey is the key. You must have the READ access to the object (or version).

If the trigger input port is used, the component waits until an event is received before executing the action. The action is performed with each event. Errors encountered will be emitted on the errors output port. Use the abort port to cancel the execution.

If the action is successful, the service sends back an HTTP 200 response.

Settings​

Enable realtime config port​

When enabled, this setting allows the component to be configured via the config port. The port accepts a configuration object as input, enabling dynamic property updates during runtime. While using this port won't trigger component reinitialization, it may result in the loss of some previous component state.

Region (region)​

The region in which S3 client needs to work.

  • Required: Yes

Response data type (responseType)​

Determines the format of the response data. The component will automatically set the corresponding header parameters to the service request.

  • Required: No
  • Values: [arraybuffer, blob, json, text]
  • Default: blob

Range (range)​

Downloads the specified byte range of an object. For more information about the HTTP Range header, see RFC 9110.

  • Type: String
  • Required: No

Version ID (versionId)​

Version ID used to reference a specific version of the object. By default, the component returns the current version of an object.

  • Required: No

Keep always active​

Determines whether the component will remain active even if it is not connected to a visible widget or another active component.

See also​

For more information about Amazon S3, see the following: