Skip to main content

Call S3 method

Action ID: tools.amazon_s3.call_method Instantiate a S3 client and call a S3 method. Reference: https://boto3.amazonaws.com/v1/documentation/api/latest/guide/s3-example-download-file.html

Secrets

Optional secrets:
  • amazon_s3: optional values AWS_ACCESS_KEY_ID, AWS_SECRET_ACCESS_KEY, AWS_REGION, AWS_PROFILE, AWS_ROLE_ARN.

Input fields

method_name
string
required
S3 method name.
params
object
required
S3 method parameters.

Copy S3 objects

Action ID: tools.amazon_s3.copy_objects Copy S3 objects from one bucket to another. Reference: https://boto3.amazonaws.com/v1/documentation/api/latest/reference/services/s3.html#S3.Client.copy_object

Secrets

Optional secrets:
  • amazon_s3: optional values AWS_ACCESS_KEY_ID, AWS_SECRET_ACCESS_KEY, AWS_REGION, AWS_PROFILE, AWS_ROLE_ARN.

Input fields

dst_bucket
string
required
Destination S3 bucket name.
prefix
string
required
Prefix to filter objects (e.g., ‘manuals_’ for keys starting with ‘manuals_’).
src_bucket
string
required
Source S3 bucket name.
endpoint_url
string | null
Endpoint URL for the AWS S3 service.Default: null.

Delete S3 object

Action ID: tools.amazon_s3.delete_object Delete an object from S3. Reference: https://boto3.amazonaws.com/v1/documentation/api/latest/reference/services/s3.html#S3.Client.delete_object

Secrets

Optional secrets:
  • amazon_s3: optional values AWS_ACCESS_KEY_ID, AWS_SECRET_ACCESS_KEY, AWS_REGION, AWS_PROFILE, AWS_ROLE_ARN.

Input fields

bucket
string
required
S3 bucket name.
key
string
required
S3 object key.
endpoint_url
string | null
Endpoint URL for the AWS S3 service.Default: null.

Get S3 object

Action ID: tools.amazon_s3.get_object Download an object from S3 and return its body as a string. Reference: https://boto3.amazonaws.com/v1/documentation/api/latest/reference/services/s3.html#S3.Client.get_object

Secrets

Optional secrets:
  • amazon_s3: optional values AWS_ACCESS_KEY_ID, AWS_SECRET_ACCESS_KEY, AWS_REGION, AWS_PROFILE, AWS_ROLE_ARN.

Input fields

bucket
string
required
S3 bucket name.
key
string
required
S3 object key.
endpoint_url
string | null
Endpoint URL for the AWS S3 service.Default: null.

Get S3 objects

Action ID: tools.amazon_s3.get_objects Download multiple S3 objects and return their bodies as strings. Reference: https://boto3.amazonaws.com/v1/documentation/api/latest/reference/services/s3.html#S3.Client.get_object

Secrets

Optional secrets:
  • amazon_s3: optional values AWS_ACCESS_KEY_ID, AWS_SECRET_ACCESS_KEY, AWS_REGION, AWS_PROFILE, AWS_ROLE_ARN.

Input fields

bucket
string
required
S3 bucket name.
keys
array[string]
required
S3 object keys.
endpoint_url
string | null
Endpoint URL for the AWS S3 service.Default: null.

List S3 objects

Action ID: tools.amazon_s3.list_objects List objects in an S3 bucket. Reference: https://boto3.amazonaws.com/v1/documentation/api/latest/reference/services/s3.html#S3.Client.list_objects_v2

Secrets

Optional secrets:
  • amazon_s3: optional values AWS_ACCESS_KEY_ID, AWS_SECRET_ACCESS_KEY, AWS_REGION, AWS_PROFILE, AWS_ROLE_ARN.

Input fields

bucket
string
required
S3 bucket name.
endpoint_url
string | null
Endpoint URL for the AWS S3 service.Default: null.
limit
integer
Maximum number of objects to return.Default: 1000.
prefix
string | null
S3 object key prefix.Default: null.

Parse S3 URI

Action ID: tools.amazon_s3.parse_uri Parse an S3 URI into bucket name and object key. Reference: https://boto3.amazonaws.com/v1/documentation/api/latest/guide/s3-example-download-file.html

Secrets

Optional secrets:
  • amazon_s3: optional values AWS_ACCESS_KEY_ID, AWS_SECRET_ACCESS_KEY, AWS_REGION, AWS_PROFILE, AWS_ROLE_ARN.

Input fields

uri
string
required

Put S3 object

Action ID: tools.amazon_s3.put_object Uploads an object to S3. The object key is validated and content decoded. Reference: https://boto3.amazonaws.com/v1/documentation/api/latest/reference/services/s3.html#S3.Client.put_object

Secrets

Optional secrets:
  • amazon_s3: optional values AWS_ACCESS_KEY_ID, AWS_SECRET_ACCESS_KEY, AWS_REGION, AWS_PROFILE, AWS_ROLE_ARN.

Input fields

bucket
string
required
S3 bucket name.
file_data
string
required
Base64 encoded content of the file to upload.
key
string
required
S3 object key.
endpoint_url
string | null
Endpoint URL for the AWS S3 service.Default: null.