Amazon AWS S3

the amazon aws s3 connector allows for seamless integration with aws's secure, durable, and highly scalable object storage service amazon aws s3 is a scalable object storage service that allows users to store and retrieve any amount of data this connector enables swimlane turbine users to automate key s3 operations such as file uploads, downloads, and management of objects and buckets by integrating with amazon aws s3, swimlane turbine users can streamline data management tasks, enforce governance, and enhance incident response workflows without writing any code asset setup this integration authenticates with aws s3 using the following input values prerequisites to utilize the amazon aws s3 connector with swimlane turbine, ensure you have the following aws credentials for authentication region name the specific geographic region where the s3 bucket is hosted obtaining aws credentials to use this integration, you will need to have an aws account and obtain the necessary aws credentials you can obtain these credentials by following the steps below log in to your aws account and navigate to the iam console in the left navigation pane, click on the "users" tab and select the user for which you want to create credentials click on the "security credentials" tab, and then click on "create access key" make sure to save the access key id and secret access key in a secure location, as you will not be able to see the secret access key again after this step if you want to use an aws iam role to access the s3 bucket, you will need to have the arn of the role and an optional external id, if one was specified by the aws account administrator capabilities the aws s3 connector provides the following capabilities delete object download file get buckets get object get objects upload file configurations aws s3 authenticates using aws credentials configuration parameters parameter description type required access key aws access key, see https //docs aws amazon com/general/latest/gr/managing aws access keys html for more information string optional secret key aws secret key, see https //docs aws amazon com/general/latest/gr/managing aws access keys html for more information string optional region name the aws region where you want to create new connections string required role arn optional role arn to assume leave blank unless tasks need to assume a different role see https //docs aws amazon com/sts/latest/apireference/api assumerole html for more information string optional external id external id to assume iam role optional value used for assuming roles can be added, or removed in trusted relationships of target role string optional session token use if a session token is provided when switching roles string optional role session name defaults to sessionfromswimlane \<hash> when no value is provide string optional actions delete object removes a specified object from an amazon s3 bucket, requiring the bucket name and object key as inputs input argument name type required description bucket string required parameter for delete object key string required parameter for delete object mfa string optional parameter for delete object versionid string optional unique identifier requestpayer string optional parameter for delete object bypassgovernanceretention boolean optional parameter for delete object expectedbucketowner string optional parameter for delete object input example {"bucket" "string","key" "string","mfa" "string","versionid" "string","requestpayer" "string","bypassgovernanceretention"\ false,"expectedbucketowner" "string"} output parameter type description responsemetadata object response data responsemetadata requestid string response data responsemetadata hostid string response data responsemetadata httpstatuscode number response data responsemetadata httpheaders object response data responsemetadata httpheaders x amz id 2 string response data responsemetadata httpheaders x amz request id string response data responsemetadata httpheaders date string response data responsemetadata httpheaders server string response data responsemetadata retryattempts number response data output example {"responsemetadata" {"requestid" "string","hostid" "string","httpstatuscode" 204,"httpheaders" {"x amz id 2" "string","x amz request id" "string","date" "tue, 10 oct 2023 10 02 19 gmt","server" "amazons3"},"retryattempts" 0}} download file retrieves a specified file from an amazon aws s3 bucket using the provided bucket name and file key endpoint method get input argument name type required description bucket string required parameter for download file key string required parameter for download file input example {"bucket" "string","key" "string"} output parameter type description status code number http status code of the response reason string response reason phrase file array output field file output example {"file" {"file data" "string","filename" "example name"}} get buckets retrieve a list of all amazon aws s3 buckets available to the authenticated user output parameter type description responsemetadata object response data responsemetadata requestid string response data responsemetadata hostid string response data responsemetadata httpstatuscode number response data responsemetadata httpheaders object response data responsemetadata httpheaders x amz id 2 string response data responsemetadata httpheaders x amz request id string response data responsemetadata httpheaders date string response data responsemetadata httpheaders content type string response data responsemetadata httpheaders transfer encoding string response data responsemetadata httpheaders server string response data responsemetadata retryattempts number response data buckets array output field buckets buckets name string name of the resource buckets creationdate string date value owner object output field owner owner displayname string name of the resource owner id string unique identifier output example {"responsemetadata" {"requestid" "string","hostid" "string","httpstatuscode" 123,"httpheaders" {"x amz id 2" "string","x amz request id" "string","date" "2024 01 01t00 00 00z","content type" "string","transfer encoding" "string","server" "string"},"retryattempts" 123},"buckets" \[],"owner" {"displayname" "example name","id" "12345678 1234 1234 1234 123456789abc"}} get object retrieves a specified object from an amazon aws s3 bucket using the provided bucket name and key endpoint method get input argument name type required description bucket string required parameter for get object ifmatch string optional parameter for get object ifmodifiedsince string optional parameter for get object ifnonematch string optional parameter for get object ifunmodifiedsince string optional parameter for get object key string required parameter for get object range string optional parameter for get object responsecachecontrol string optional parameter for get object responsecontentdisposition string optional response content responsecontentencoding string optional response content responsecontentlanguage string optional response content responsecontenttype string optional type of the resource responseexpires string optional parameter for get object versionid string optional unique identifier ssecustomeralgorithm string optional parameter for get object ssecustomerkey string optional parameter for get object requestpayer string optional parameter for get object partnumber number optional parameter for get object expectedbucketowner string optional parameter for get object checksummode string optional parameter for get object input example {"bucket" "string","ifmatch" "string","ifmodifiedsince" "2015 01 01t00 00 00","ifnonematch" "string","ifunmodifiedsince" "2015 01 01t00 00 00","key" "string","range" "string","responsecachecontrol" "string","responsecontentdisposition" "string","responsecontentencoding" "string","responsecontentlanguage" "string","responsecontenttype" "string","responseexpires" "2015 01 01t00 00 00","versionid" "string","ssecustomeralgorithm" "string","ssecustomerkey" "string","requestpayer" "requester","partnumber" 123,"expectedbucketowner" "string","checksummode" "enabled"} output parameter type description status code number http status code of the response reason string response reason phrase response object output field response response deletemarker boolean output field response deletemarker response acceptranges string output field response acceptranges response expiration string output field response expiration response restore string output field response restore response lastmodified string output field response lastmodified response contentlength number response content response etag string output field response etag response checksumcrc32 string output field response checksumcrc32 response checksumcrc32c string output field response checksumcrc32c response checksumsha1 string output field response checksumsha1 response checksumsha256 string output field response checksumsha256 response missingmeta number output field response missingmeta response versionid string unique identifier response cachecontrol string output field response cachecontrol response contentdisposition string response content response contentencoding string response content response contentlanguage string response content response contentrange string response content response contenttype string type of the resource response expires string output field response expires response websiteredirectlocation string output field response websiteredirectlocation response serversideencryption string unique identifier output example {"status code" 200,"response headers"\ null,"reason" "ok","response" {"deletemarker"\ true,"acceptranges" "string","expiration" "string","restore" "string","lastmodified" "2015 01 01t00 00 00","contentlength" 123,"etag" "string","checksumcrc32" "string","checksumcrc32c" "string","checksumsha1" "string","checksumsha256" "string","missingmeta" 123,"versionid" "string","cachecontrol" "string","contentdisposition" "string"}} get objects retrieve a list of objects from a specified amazon aws s3 bucket a 'bucket' name is required endpoint method get input argument name type required description bucket string required parameter for get objects delimiter string optional parameter for get objects encodingtype string optional type of the resource maxkeys number optional parameter for get objects prefix string optional parameter for get objects continuationtoken string optional parameter for get objects fetchowner boolean optional parameter for get objects startafter string optional parameter for get objects requestpayer string optional parameter for get objects expectedbucketowner string optional parameter for get objects input example {"bucket" "my bucket","delimiter" "/","encodingtype" "url","maxkeys" 1000,"prefix" "my prefix","continuationtoken" "token","fetchowner"\ true,"startafter" "start after","requestpayer" "requester","expectedbucketowner" "expected owner"} output parameter type description responsemetadata object response data responsemetadata requestid string response data responsemetadata hostid string response data responsemetadata httpstatuscode number response data responsemetadata httpheaders object response data responsemetadata httpheaders x amz id 2 string response data responsemetadata httpheaders x amz request id string response data responsemetadata httpheaders date string response data responsemetadata httpheaders x amz bucket region string response data responsemetadata httpheaders content type string response data responsemetadata httpheaders transfer encoding string response data responsemetadata httpheaders server string response data responsemetadata retryattempts number response data istruncated boolean output field istruncated contents array response content contents key string response content contents lastmodified string response content contents etag string response content contents checksumalgorithm array response content contents size number response content contents storageclass string response content name string name of the resource prefix string output field prefix maxkeys number output field maxkeys encodingtype string type of the resource output example {"responsemetadata" {"requestid" "c5b5w1qcy041z8qz","hostid" "zcy127cyg9grhk0uekvyzsbphro2dzjefgh84prjhxh1svzgr1jdr8br+kehf/n5u8nltukw0nnlki0w\ ","httpstatuscode" 200,"httpheaders" {"x amz id 2" "zcy127cyg9grhk0uekvyzsbphro2dzjefgh84prjhxh1svzgr1jdr8br+kehf/n5u8nltukw0nnlki0w\ ","x amz request id" "c5b5w1qcy041z8qz","date" "tue, 20 may 2025 04 37 01 gmt","x amz bucket region" "ap southeast 2","content type" "application/xml","transfer encoding" "chunked","server" "amazons3"},"retryattempts" 0} upload file uploads a specified file to an amazon aws s3 bucket, requiring the file and bucket name as inputs input argument name type required description file object required file that you want to submit file file string required parameter for upload file file file name string required name of the resource bucket string required parameter for upload file object name string optional s3 object name if not specified then file name is used input example {"file" {"file" "","file name" "sample txt"},"bucket" "bucket name"} output parameter type description success boolean whether the operation was successful output example {"json body" {"success"\ true}} response headers header description example content type the media type of the resource application/json date the date and time at which the message was originated thu, 01 jan 2024 00 00 00 gmt