Skip to main content

S3 List Buckets

Returns a list of all buckets owned by the authenticated sender of the request.

component image

In-ports

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 Object — list of buckets as JSON objects.

errors JSON — emits any errors that occur during execution.

Overview

The S3 List Buckets component allows you to obtain a list of all buckets owned by the authenticated requester. This component is part of a broader suite designed to perform operations with Amazon S3.

By configuring the "region" setting, you can limit the response to include only buckets within a specified region.

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.

Upon successful execution, an HTTP 200 response is returned.

Settings

Authentication

To authenticate with the target service, select an existing connection from the dropdown menu or set up a new one.

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)

Limits the response to buckets that are located in the specified AWS Region.

  • Default: aws-global
  • Required: Yes

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: