Amazon S3 Uploader

This package contains a node that facilitates the uploading of files to Amazon S3. The s3_file_uploader node provides an action interface for uploading a set of files to Amazon S3. For more information on actions see the actionlib documentation. Examples for using the UploadFiles action server can be found below. The action server can take one upload request at a time. If the uploader is currently working on an upload request it will reject any new requests.

AWS Credentials

You will need to create an AWS Account and configure the credentials to be able to communicate with AWS services. You may find AWS Configuration and Credential Files helpful.

This node will require the following AWS account IAM role permissions:

• s3:PutObject for the bucket specified in the config file.

Usage

Resource Setup

• Create a bucket in Amazon S3.

Running the node

• Build the s3_file_uploader package following the instructions in the main README.
• Configure AWS credentials.
• Change the node configuration with the S3 Bucket that files should be uploaded to. Note that this bucket must be in the same region as in the node configuration.

• Launch the node with

    roslaunch s3_file_uploader s3_file_uploader.launch s3_bucket:=<BUCKET_NAME>
  

Simple Upload File Test

A simple example of an action client to interact with this node is provided. Create a dummy file to use an example to upload:

    echo "Hello World!" > /tmp/hello_world.txt

Then source the ROS workspace, and the example client can be run with python examples/s3_file_uploader_client.py. The action server can also be invoked via the rostopic command line tool:

    rostopic pub /s3_file_uploader/UploadFiles/goal file_uploader_msgs/UploadFilesActionGoal "{goal: { files:['/tmp/hello_world.txt'], upload_location: 'rosbags/test' } }"

After the action is completed, the contents of /tmp/hello_world.txt wil be available at s3://<BUCKET_NAME>/rosbags/test/hello_world.txt.

s3_file_uploader node

Launch and Configuration File Parameters

Actions

Action Name: ~/UploadFiles

Goal | Key | Type | Description | | — | —- | ———– | | files | string[] | A list of absolute paths to files to be uploaded (Note that these paths must be accessible by the s3_file_uploader node) | | upload_location | string | The S3 Key prefix of the files to be uploaded |

Result | Key | Type | Description | | — | —- | ———– | | result_code | uint16 | The error code returned from S3 (The enum list can be found here) | | files_uploaded | string[] | The list of files that were successfully uploaded |

Note goals also have a message field that will contain more details on the result of the action

Feedback | Key | Type | Description | | — | —- | ———– | | num_uploaded | uint16 | The number of files that have been uploaded from this request so far | | num_remaining | uint16 | The number of files that are remaining in this upload request |

Changelog for package s3_file_uploader

1.0.1 (2020-07-01)

• Address build error on ROS buildfarm (#135) try to fix buildfarm build error and iterate on bloom release
• Contributors: Miaofei Mei