AWS S3 actions

preview

We're still working on this feature, but we'd love for you to try it out!

This feature is currently provided as part of a preview program pursuant to our pre-release policies.

This page provides a comprehensive reference for aws s3 actions available in the workflow automation actions catalog. These actions enable you to s3 bucket and object operations.

Prerequisites

Before using AWS actions in workflow automation, ensure you have:

An AWS account with appropriate permissions.
AWS credentials configured (IAM user credentials, IAM role ARN, or session credentials).
The necessary IAM permissions for the specific AWS services you plan to use.

See Set up AWS credentials for information on how to create IAM users and IAM roles, and set up static and session AWS credentials for integration with workflow automation AWS actions.

The listObjectsV2 method returns some or all (up to 1,000) of the objects in a bucket. It is a more modern and recommended version of list_objects.

Input Field	Optionality	Type	Example
awsRoleArn	Optional	String	`arn:aws:iam::123456789012:role/my-workflow-role`
awsAccessKeyId	Optional	String	`${{ :secrets:<awsAccessKeyId> }}`
awsSecretAccessKey	Optional	String	`${{ :secrets:<awsSecretAccessKey> }}`
awsSessionToken	Optional	String	`${{ :secrets:<awsSessionToken> }}`
region	Required	String	`"us-east-2"`
bucket	Required	String	"`examplebucket`"
prefix	Optional	String	"`path/to/folder/`"
maxKeys	Optional	Integer	`100`
continuationToken	Optional	String	`some-token`
parameters	Optional	Map	`{ "Delimiter": "/" }`
selectors	Optional	List	`[{\"name\": \"response\", \"expression\": \".response\"}, {\"name\": \"success\", \"expression\": \".success\"}, {\"name\": \"errorMessage\", \"expression\": \".errorMessage\"}]`

Input Field	Type
EncodingType	String
FetchOwner	Boolean
StartAfter	String
RequestPayer	String
ExpectedBucketOwner	String
OptionalObjectAttributes	List
Delimiter	String

Output Field	Type	Example
response	object	{ 'IsTruncated': True\|False, 'Contents': [ { 'Key': 'string', 'LastModified': datetime(2015, 1, 1), 'ETag': 'string', 'ChecksumAlgorithm': [ 'CRC32'\|'CRC32C'\|'SHA1'\|'SHA256'\|'CRC64NVME', ], 'ChecksumType': 'COMPOSITE'\|'FULL_OBJECT', 'Size': 123, 'StorageClass': 'STANDARD'\|'REDUCED_REDUNDANCY'\|'GLACIER'\|'STANDARD_IA'\|'ONEZONE_IA'\|'INTELLIGENT_TIERING'\|'DEEP_ARCHIVE'\|'OUTPOSTS'\|'GLACIER_IR'\|'SNOW'\|'EXPRESS_ONEZONE'\|'FSX_OPENZFS', 'Owner': { 'DisplayName': 'string', 'ID': 'string' }, 'RestoreStatus': { 'IsRestoreInProgress': True\|False, 'RestoreExpiryDate': datetime(2015, 1, 1) } }, ], 'Name': 'string', 'Prefix': 'string', 'Delimiter': 'string', 'MaxKeys': 123, 'CommonPrefixes': [ { 'Prefix': 'string' }, ], 'EncodingType': 'url', 'KeyCount': 123, 'ContinuationToken': 'string', 'NextContinuationToken': 'string', 'StartAfter': 'string', 'RequestCharged': 'requester' } Response syntax can be referred to in the list_objects_v2 - Boto3 1.40.52 documentation
success	Boolean	`success: true \| false`
errorMessage	String	`errorMessage: "Parameter validation failed:\nInvalid bucket name \"s3-activity-test \": Bucket name must match the regex \"^[a-zA-Z0-9.\\-_]{1,255}$\" or be an ARN matching the regex \"^arn:(aws).:(s3\|s3-object-lambda):[a-z\\-0-9]:[0-9]{12}:accesspoint[/:][a-zA-Z0-9\\-.]{1,63}$\|^arn:(aws).*:s3-outposts:[a-z\\-0-9]+:[0-9]{12}:outpost[/:][a-zA-Z0-9\\-]{1,63}[/:]accesspoint[/:][a-zA-Z0-9\\-]{1,63}$\""`

Output Field

Type

Example

response

object

{
      'IsTruncated': True|False,
      'Contents': [
          {
              'Key': 'string',
              'LastModified': datetime(2015, 1, 1),
              'ETag': 'string',
              'ChecksumAlgorithm': [
                  'CRC32'|'CRC32C'|'SHA1'|'SHA256'|'CRC64NVME',
              ],
              'ChecksumType': 'COMPOSITE'|'FULL_OBJECT',
              'Size': 123,
              'StorageClass': 'STANDARD'|'REDUCED_REDUNDANCY'|'GLACIER'|'STANDARD_IA'|'ONEZONE_IA'|'INTELLIGENT_TIERING'|'DEEP_ARCHIVE'|'OUTPOSTS'|'GLACIER_IR'|'SNOW'|'EXPRESS_ONEZONE'|'FSX_OPENZFS',
              'Owner': {
                  'DisplayName': 'string',
                  'ID': 'string'
              },
              'RestoreStatus': {
                  'IsRestoreInProgress': True|False,
                  'RestoreExpiryDate': datetime(2015, 1, 1)
              }
          },
      ],
      'Name': 'string',
      'Prefix': 'string',
      'Delimiter': 'string',
      'MaxKeys': 123,
      'CommonPrefixes': [
          {
              'Prefix': 'string'
          },
      ],
      'EncodingType': 'url',
      'KeyCount': 123,
      'ContinuationToken': 'string',
      'NextContinuationToken': 'string',
      'StartAfter': 'string',
      'RequestCharged': 'requester'
  }

Response syntax can be referred to in the list_objects_v2 - Boto3 1.40.52 documentation

success

Boolean

success: true | false

errorMessage

String

errorMessage: "Parameter validation failed:\nInvalid bucket name \"s3-activity-test \": Bucket name must match the regex \"^[a-zA-Z0-9.\\-_]{1,255}$\" or be an ARN matching the regex \"^arn:(aws).:(s3|s3-object-lambda):[a-z\\-0-9]:[0-9]{12}:accesspoint[/:][a-zA-Z0-9\\-.]{1,63}$|^arn:(aws).*:s3-outposts:[a-z\\-0-9]+:[0-9]{12}:outpost[/:][a-zA-Z0-9\\-]{1,63}[/:]accesspoint[/:][a-zA-Z0-9\\-]{1,63}$\""

Workflow example
`name: aws-s3-list-objects-v2 description: 'List Objects in an AWS S3 Bucket' steps: - name: aws_s3_listObjectsV2_1 type: action action: aws.s3.listObjectsV2 version: '1' inputs: awsRoleArn: "arn:aws:iam::123456789012:role/my-workflow-role" region: "us-east-2" bucket: "examplebucket" prefix: "path/to/folder/" maxKeys: 100 continuationToken: "some-token" next: end`

Workflow example

name: aws-s3-list-objects-v2
  description: 'List Objects in an AWS S3 Bucket'
          
  steps:
      - name: aws_s3_listObjectsV2_1
      type: action
      action: aws.s3.listObjectsV2
      version: '1'
      inputs:
          awsRoleArn: "arn:aws:iam::123456789012:role/my-workflow-role"
          region: "us-east-2"
          bucket: "examplebucket"
          prefix: "path/to/folder/"
          maxKeys: 100
          continuationToken: "some-token"
      next: end

The deleteObject method permanently removes a single object from a bucket. For versioned buckets, this operation inserts a delete marker, which hides the object without permanently deleting it unless a VersionId is specified.

Input Field	Optionality	Type	Example
awsRoleArn	Optional	String	`arn:aws:iam::123456789012:role/my-workflow-role`
awsAccessKeyId	Optional	String	`${{ :secrets:<awsAccessKeyId> }}`
awsSecretAccessKey	Optional	String	`${{ :secrets:<awsSecretAccessKey> }}`
awsSessionToken	Optional	String	`${{ :secrets:<awsSessionToken> }}`
region	Required	String	`"us-east-2"`
bucket	Required	String	"`examplebucket`"
key	Required	String	"`path/to/object.txt`"
parameters	Optional	Map	`{ "RequestPayer": "test", "BypassGovernanceRetention": false "VersionId":"testVersion", "MFA":"Test" }`
selectors	Optional	List	`[{\"name\": \"response\", \"expression\": \".response\"}, {\"name\": \"success\", \"expression\": \".success\"}, {\"name\": \"errorMessage\", \"expression\": \".errorMessage\"}]`

Output Field	Type	Example
response	object
success	Boolean	`success: true \| false`
errorMessage	String	`errorMessage: "Parameter validation failed:\nInvalid bucket name \"s3-activity-test \": Bucket name must match the regex \"^[a-zA-Z0-9.\\-_]{1,255}$\" or be an ARN matching the regex \"^arn:(aws).:(s3\|s3-object-lambda):[a-z\\-0-9]:[0-9]{12}:accesspoint[/:][a-zA-Z0-9\\-.]{1,63}$\|^arn:(aws).*:s3-outposts:[a-z\\-0-9]+:[0-9]{12}:outpost[/:][a-zA-Z0-9\\-]{1,63}[/:]accesspoint[/:][a-zA-Z0-9\\-]{1,63}$\""`

Workflow example
`name: aws-s3-delete-object description: 'Delete an AWS S3 Object' steps: - name: aws_s3_deleteObject_1 type: action action: aws.s3.deleteObject version: '1' inputs: awsRoleArn: "arn:aws:iam::123456789012:role/my-workflow-role" region: "us-west-2" bucket: "my-bucket" key: "path/to/object.txt" next: end`

Workflow example

name: aws-s3-delete-object
description: 'Delete an AWS S3 Object'

steps:
  - name: aws_s3_deleteObject_1
    type: action
    action: aws.s3.deleteObject
    version: '1'
    inputs:
      awsRoleArn: "arn:aws:iam::123456789012:role/my-workflow-role"
      region: "us-west-2"
      bucket: "my-bucket"
      key: "path/to/object.txt"
    next: end

Adds an object to a 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.

Input Field	Optionality	Type	Example
awsRoleArn	Optional	String	`arn:aws:iam::123456789012:role/my-workflow-role`
awsAccessKeyId	Optional	String	`${{ :secrets:<awsAccessKeyId> }}`
awsSecretAccessKey	Optional	String	`${{ :secrets:<awsSecretAccessKey> }}`
awsSessionToken	Optional	String	`${{ :secrets:<awsSessionToken> }}`
region	Required	String	`"us-east-2"`
bucket	Required	String	"`examplebucket`"
key	Required	String	"`path/to/object.txt`"
body	Required	String	`file content`
contentType	Required	String	"`plain/text`"
tagging	Optional	String	`"key1=value1"`
parameters	Optional	Map	`{ "ServerSideEncryption": "AES256", "Metadata": { 'metadata1': 'value1', 'metadata2': 'value2', } }`
selectors	Optional	List	`[{\"name\": \"response\", \"expression\": \".response\"}, {\"name\": \"success\", \"expression\": \".success\"}, {\"name\": \"errorMessage\", \"expression\": \".errorMessage\"}]`

Input Field	Type
RequestPayer	String
ACL	String
CacheControl	String
ContentDisposition	String
ContentEncoding	String
ContentLanguage	String
ContentLength	Int
ContentMD5	String
ChecksumAlgorithm	String
ChecksumCRC32	String
ChecksumCRC32C	String
ChecksumCRC64NVME	String
ChecksumSHA1	String
ChecksumSHA256	String
Expires	Map
IfMatch	String
IfNoneMatch	String
GrantFullControl	String
GrantRead	String
GrantReadACP	String
GrantWriteACP	String
WriteOffsetBytes	Int
ServerSideEncryption	String
StorageClass	String
WebsiteRedirectLocation	String
SSECustomerAlgorithm	String
SSECustomerKey	String
SSEKMSKeyId	String
SSEKMSEncryptionContext	String
BucketKeyEnabled	Boolean
RequestPayer	String
ObjectLockMode	String
ObjectLockRetainUntilDate	Map
ObjectLockLegalHoldStatus	String
ExpectedBucketOwner	String
Metadata	Map

Output Field	Type	Example
response	object	{ 'Expiration': 'string', 'ETag': 'string', 'ChecksumCRC32': 'string', 'ChecksumCRC32C': 'string', 'ChecksumCRC64NVME': 'string', 'ChecksumSHA1': 'string', 'ChecksumSHA256': 'string', 'ChecksumType': 'COMPOSITE'\|'FULL_OBJECT', 'ServerSideEncryption': 'AES256'\|'aws:fsx'\|'aws:kms'\|'aws:kms:dsse', 'VersionId': 'string', 'SSECustomerAlgorithm': 'string', 'SSECustomerKeyMD5': 'string', 'SSEKMSKeyId': 'string', 'SSEKMSEncryptionContext': 'string', 'BucketKeyEnabled': True\|False, 'Size': 123, 'RequestCharged': 'requester' } Response syntax can be referred put_object - Boto3 1.40.59 documentation
success	Boolean	`success: true \| false`
errorMessage	String	`errorMessage: "An error occurred (NoSuchBucket) when calling the PutObject operation: The specified bucket does not exist"`

Output Field

Type

Example

response

object

{
  'Expiration': 'string',
  'ETag': 'string',
  'ChecksumCRC32': 'string',
  'ChecksumCRC32C': 'string',
  'ChecksumCRC64NVME': 'string',
  'ChecksumSHA1': 'string',
  'ChecksumSHA256': 'string',
  'ChecksumType': 'COMPOSITE'|'FULL_OBJECT',
  'ServerSideEncryption': 'AES256'|'aws:fsx'|'aws:kms'|'aws:kms:dsse',
  'VersionId': 'string',
  'SSECustomerAlgorithm': 'string',
  'SSECustomerKeyMD5': 'string',
  'SSEKMSKeyId': 'string',
  'SSEKMSEncryptionContext': 'string',
  'BucketKeyEnabled': True|False,
  'Size': 123,
  'RequestCharged': 'requester'
  }

Response syntax can be referred put_object - Boto3 1.40.59 documentation

success

Boolean

success: true | false

errorMessage

String

errorMessage: "An error occurred (NoSuchBucket) when calling the PutObject operation: The specified bucket does not exist"

Workflow example
`name: s3-put-object description: 'Put an AWS S3 Object' steps: - name: aws_s3_putObject_1 type: action action: aws.s3.putObject version: '1' inputs: awsRoleArn: "arn:aws:iam::123456789012:role/my-workflow-role" region: "us-east-2" bucket: "examplebucket" key: "path/to/object.txt" body: "Hello world" contentType: "plain/text" tagging: "key1=value1" next: end`

Workflow example

name: s3-put-object
  description: 'Put an AWS S3 Object'

  steps:
      - name: aws_s3_putObject_1
      type: action
      action: aws.s3.putObject
      version: '1'
      inputs:
          awsRoleArn: "arn:aws:iam::123456789012:role/my-workflow-role"
          region: "us-east-2"
          bucket: "examplebucket"
          key: "path/to/object.txt"
          body: "Hello world"
          contentType: "plain/text"
          tagging: "key1=value1"
      next: end

In the GetObject request, specify the full key name for the object.

Input Field	Optionality	Type	Example
awsRoleArn	Optional	String	`arn:aws:iam::123456789012:role/my-workflow-role`
awsAccessKeyId	Optional	String	`${{ :secrets:<awsAccessKeyId> }}`
awsSecretAccessKey	Optional	String	`${{ :secrets:<awsSecretAccessKey> }}`
awsSessionToken	Optional	String	`${{ :secrets:<awsSessionToken> }}`
region	Required	String	`"us-east-2"`
bucket	Required	String	"`examplebucket`"
key	Required	String	"`path/to/object.txt`"
versionId	Optional	String	`"some-version-id"`
range	Optional	String	`bytes=0-99`
parameters	Optional	Map	`{ "ChecksumMode": "ENABLED", "ExpectedBucketOwner": "test-user" }`
selectors	Optional	List	`[{\"name\": \"response\", \"expression\": \".response\"}, {\"name\": \"success\", \"expression\": \".success\"}, {\"name\": \"errorMessage\", \"expression\": \".errorMessage\"}]`

Important

The action will fail if the object is more than 100kb.

Input Field	Type
IfMatch	String
IfModifiedSince	Map
IfNoneMatch	String
IfUnmodifiedSince	Map
ResponseCacheControl	String
ResponseContentDisposition	String
ResponseContentEncoding	String
ResponseContentLanguage	String
ResponseContentType	String
ResponseExpires	Map
SSECustomerAlgorithm	String
SSECustomerKey	String
RequestPayer	String
PartNumber	Int
ExpectedBucketOwner	String
ChecksumMode	String

Output Field	Type	Example
response	object	{ 'Body': StreamingBody(), 'DeleteMarker': True\|False, 'AcceptRanges': 'string', 'Expiration': 'string', 'Restore': 'string', 'LastModified': datetime(2015, 1, 1), 'ContentLength': 123, 'ETag': 'string', 'ChecksumCRC32': 'string', 'ChecksumCRC32C': 'string', 'ChecksumCRC64NVME': 'string', 'ChecksumSHA1': 'string', 'ChecksumSHA256': 'string', 'ChecksumType': 'COMPOSITE'\|'FULL_OBJECT', 'MissingMeta': 123, 'VersionId': 'string', 'CacheControl': 'string', 'ContentDisposition': 'string', 'ContentEncoding': 'string', 'ContentLanguage': 'string', 'ContentRange': 'string', 'ContentType': 'string', 'Expires': datetime(2015, 1, 1), 'ExpiresString': 'string', 'WebsiteRedirectLocation': 'string', 'ServerSideEncryption': 'AES256'\|'aws:fsx'\|'aws:kms'\|'aws:kms:dsse', 'Metadata': { 'string': 'string' }, 'SSECustomerAlgorithm': 'string', 'SSECustomerKeyMD5': 'string', 'SSEKMSKeyId': 'string', 'BucketKeyEnabled': True\|False, 'StorageClass': 'STANDARD'\|'REDUCED_REDUNDANCY'\|'STANDARD_IA'\|'ONEZONE_IA'\|'INTELLIGENT_TIERING'\|'GLACIER'\|'DEEP_ARCHIVE'\|'OUTPOSTS'\|'GLACIER_IR'\|'SNOW'\|'EXPRESS_ONEZONE'\|'FSX_OPENZFS', 'RequestCharged': 'requester', 'ReplicationStatus': 'COMPLETE'\|'PENDING'\|'FAILED'\|'REPLICA'\|'COMPLETED', 'PartsCount': 123, 'TagCount': 123, 'ObjectLockMode': 'GOVERNANCE'\|'COMPLIANCE', 'ObjectLockRetainUntilDate': datetime(2015, 1, 1), 'ObjectLockLegalHoldStatus': 'ON'\|'OFF' } Response syntax can be referred to in the get_object - Boto3 1.40.59 documentation
success	Boolean	`success: true \| false`
errorMessage	String	`errorMessage: "An error occurred (InvalidArgument) when calling the GetObject operation: Invalid version id specified"`

Output Field

Type

Example

response

object

{
  'Body': StreamingBody(),
  'DeleteMarker': True|False,
  'AcceptRanges': 'string',
  'Expiration': 'string',
  'Restore': 'string',
  'LastModified': datetime(2015, 1, 1),
  'ContentLength': 123,
  'ETag': 'string',
  'ChecksumCRC32': 'string',
  'ChecksumCRC32C': 'string',
  'ChecksumCRC64NVME': 'string',
  'ChecksumSHA1': 'string',
  'ChecksumSHA256': 'string',
  'ChecksumType': 'COMPOSITE'|'FULL_OBJECT',
  'MissingMeta': 123,
  'VersionId': 'string',
  'CacheControl': 'string',
  'ContentDisposition': 'string',
  'ContentEncoding': 'string',
  'ContentLanguage': 'string',
  'ContentRange': 'string',
  'ContentType': 'string',
  'Expires': datetime(2015, 1, 1),
  'ExpiresString': 'string',
  'WebsiteRedirectLocation': 'string',
  'ServerSideEncryption': 'AES256'|'aws:fsx'|'aws:kms'|'aws:kms:dsse',
  'Metadata': {
      'string': 'string'
  },
  'SSECustomerAlgorithm': 'string',
  'SSECustomerKeyMD5': 'string',
  'SSEKMSKeyId': 'string',
  'BucketKeyEnabled': True|False,
  'StorageClass': 'STANDARD'|'REDUCED_REDUNDANCY'|'STANDARD_IA'|'ONEZONE_IA'|'INTELLIGENT_TIERING'|'GLACIER'|'DEEP_ARCHIVE'|'OUTPOSTS'|'GLACIER_IR'|'SNOW'|'EXPRESS_ONEZONE'|'FSX_OPENZFS',
  'RequestCharged': 'requester',
  'ReplicationStatus': 'COMPLETE'|'PENDING'|'FAILED'|'REPLICA'|'COMPLETED',
  'PartsCount': 123,
  'TagCount': 123,
  'ObjectLockMode': 'GOVERNANCE'|'COMPLIANCE',
  'ObjectLockRetainUntilDate': datetime(2015, 1, 1),
  'ObjectLockLegalHoldStatus': 'ON'|'OFF'
  }

Response syntax can be referred to in the get_object - Boto3 1.40.59 documentation

success

Boolean

success: true | false

errorMessage

String

errorMessage: "An error occurred (InvalidArgument) when calling the GetObject operation: Invalid version id specified"

name: s3-get-object
  description: 'Get an AWS S3 Object'

  steps:
      - name: aws_s3_getObject_1
      type: action
      action: aws.s3.getObject
      version: '1'
      inputs:
          awsRoleArn: "arn:aws:iam::123456789012:role/my-workflow-role"
          region: "us-east-2"
          bucket: "examplebucket"
          key: "path/to/object.txt"
      next: end

preview

Prerequisites

List objects in an AWS S3 bucket

List of inputs which are optional and not considered in the action catalog

Response syntax

Delete object

List of inputs which are optional and not considered in the action catalog

Response syntax

Adds an object to AWS S3 bucket

List of inputs which are optional and not considered in the action catalog. Should be part of

Response syntax

Get object

Important

Retrieve an object from a AWS S3 bucket

Response syntax

Input Field	Type
RequestPayer	String
BypassGovernanceRetention	Boolean
ExpectedBucketOwner	String
IfMatch	String
IfMatchLastModifiedTime	Map
IfMatchSize	Int
VersionId	String
MFA	String

AWS S3 actions

preview

Prerequisites.css-21sua1{background:none;border:none;width:0;padding:0;}

Response syntax

Delete object

Response syntax

Adds an object to AWS S3 bucket

Response syntax

Get object

Response syntax

Prerequisites