aws.s3.list_objects_v2

Call AWS S3 ListObjectsV2 using a CloudConnection UUID.

Overview

Property	Value
Workflow type	Atomic
Library	Base-aws
Version	1.0

Input Schema

Field	Type	Required	Default	Description
organization_uuid	uuid	Yes	—	Authenticated organization UUID used for field resolution and connection scoping.
connection_uuid	uuid	Yes	—	AWS CloudConnection UUID for the target S3 account, scoped to the caller organization.
workflow_run_id	string	No	—	Engine DAG run ID stamped onto child steps.
region	string	No	—	AWS API endpoint region override; omit to use the connection or SDK default.
bucket	string	Yes	—	Directory buckets - When you use this operation with a directory bucket, you must use virtual-hosted-style requests in the format Bucket-name.s3express-zone-id.region-code.amazonaws.com. Path-style...
delimiter	string	No	—	A delimiter is a character that you use to group keys. CommonPrefixes is filtered out from results if it is not lexicographically greater than the StartAfter value. Directory buckets - For director...
encoding_type	string	No	—	Encoding type used by Amazon S3 to encode the object keys in the response. Responses are encoded only in UTF-8. An object key can contain any Unicode character. However, the XML 1.0 parser can't pa...
max_keys	integer	No	—	Sets the maximum number of keys returned in the response. By default, the action returns up to 1,000 key names. The response might contain fewer keys but will never contain more.
prefix	string	No	—	Limits the response to keys that begin with the specified prefix. Directory buckets - For directory buckets, only prefixes that end in a delimiter (/) are supported.
continuation_token	string	No	—	ContinuationToken indicates to Amazon S3 that the list is being continued on this bucket with a token. ContinuationToken is obfuscated and is not a real key. You can use this ContinuationToken for...
fetch_owner	boolean	No	—	The owner field is not present in ListObjectsV2 by default. If you want to return the owner field with each key in the result, then set the FetchOwner field to true. Directory buckets - For directo...
start_after	string	No	—	StartAfter is where you want Amazon S3 to start listing from. Amazon S3 starts listing after this specified key. StartAfter can be any key in the bucket. This functionality is not supported for dir...
request_payer	string	No	—	Confirms that the requester knows that she or he will be charged for the list objects request in V2 style. Bucket owners need not specify this parameter in their requests. This functionality is not...
expected_bucket_owner	string	No	—	The account ID of the expected bucket owner. If the account ID that you provide does not match the actual owner of the bucket, the request fails with the HTTP status code 403 Forbidden (access deni...
optional_object_attributes	list	No	—	Specifies the optional fields that you want returned in the response. Fields that you do not specify are not returned. This functionality is not supported for directory buckets.
provider_native_request	json	No	—	Optional provider-native request overrides for AWS parameters not yet promoted to first-class fields.

Output Schema

Field	Type	Required	Default	Description
organization_uuid	uuid	No	—	Organization UUID echoed from input.
connection_uuid	uuid	No	—	AWS CloudConnection UUID echoed from input.
region	string	No	—	AWS API endpoint region used.
service	string	No	—	AWS boto3 service/client name.
operation	string	No	—	AWS API operation invoked.
request_id	string	No	—	AWS request ID when available.
response	json	No	—	Sanitized provider response object.
items	list	No	—	Primary response item list when the API returns a collection.
result_count	integer	No	—	Count of primary response items.
next_page_token	string	No	—	Pagination token for the next page.
failure_reason	string	No	—	Human-readable failure reason.
failed_step	string	No	—	Failed logical step.
failed_layer	json	No	—	Failed DAG layer if engine supplies one.
failed_at_state	string	No	—	State where failure occurred.
error	string	No	—	Error message.
error_type	string	No	—	Error class.
failed_at	string	No	—	ISO failure timestamp.

States

State	Initial	Terminal	Success	Auto-advance	Description
pending	Yes	No	—	execute	—
completed	No	Yes	Yes	—	—
failed	No	Yes	No	—	—

State Diagram

Transitions

From	Action	To	Description
pending	execute	completed	—
* (any state)	fail	failed	—

API Usage

POST /api/workflows/start
Content-Type: application/json

{
  "workflow_type": "aws.s3.list_objects_v2",
  "initial_data": {
    "organization_uuid": "value",
    "connection_uuid": "value",
    "bucket": "value"
  }
}