AWS S3

Description

Interact with AWS S3 objects and buckets

Component key: aws-s3

Authorization Methods

AWS S3 requires one of the following authorization methods.

KeyNameDescription
api_key_secretAPI Key / SecretAPI Key / Secret Combination

Actions

Copy an object

Copy an object in S3 from one location to another

Action key: copyObject

Inputs

KeyTypeDefaultRequiredComments
awsRegionSTRINGNoneTrueAWS Region (e.g. 'us-west-2')
destinationBucketSTRINGNoneTrueBucket to move files to
destinationKeySTRINGNoneTrueThe key of the destination object
sourceBucketSTRINGNoneTrueBucket to move files from
sourceKeySTRINGNoneTrueThe key of the source object

Delete an Object in a Bucket

Delete an Object within an S3 Bucket

Action key: deleteObject

Inputs

KeyTypeDefaultRequiredComments
awsRegionSTRINGNoneTrueAWS Region (e.g. 'us-west-2')
bucketSTRINGNoneTrueName of an S3 Bucket
objectKeySTRINGNoneTrueThe S3 Object Key (e.g. path/to/file.txt)

Get an object

Get the contents of an object

Action key: getObject

Inputs

KeyTypeDefaultRequiredComments
awsRegionSTRINGNoneTrueAWS Region (e.g. 'us-west-2')
bucketSTRINGNoneTrueName of an S3 Bucket
objectKeySTRINGNoneTrueThe S3 Object Key (e.g. path/to/file.txt)

List Objects in a Bucket

List Objects in a Bucket

Action key: listObjects

Inputs

KeyTypeDefaultRequiredComments
awsRegionSTRINGNoneTrueAWS Region (e.g. 'us-west-2')
bucketSTRINGNoneTrueName of an S3 Bucket
prefixSTRINGFalseList only objects prefixed with this string, (e.g. 'path/to/files/')

Put an object

Write an object to S3

Action key: putObject

Inputs

KeyTypeDefaultRequiredComments
awsRegionSTRINGNoneTrueAWS Region (e.g. 'us-west-2')
bucketSTRINGNoneTrueName of an S3 Bucket
fileContentsDATANoneTrueBinary file data or a string
objectKeySTRINGNoneTrueThe S3 Object Key (e.g. path/to/file.txt)
taggingSTRINGFalseObject Tags (e.g. 'key1=value1[&key2=value2]')
note

File Contents can be a reference to a binary file. For example, if you have an HTTP Get action pull a .png image, you can reference outputs.httpget.all to write the .png to S3. Or, it can be simple text, like 'Hello World'

AWS Developer Documentation

An AWS IAM access key pair is required to interact with AWS S3.

The access_key_id and secret_access_key can saved into Prismatic's credential store using the API Key / Secret authorization method as the API Key and API Secret respectively.

Last updated on