AWS S3 Reader
Description
AWS S3 Reader is used to read stream data from an Amazon S3 object store. Within Orchestra, the data is then contained in an Orchestra message.
Creation
To create an AWS S3 Reader, follow the steps described in the general description of Channels.
Configuration
The dialog to configure the Amazon S3 object reader looks like:
 |
|---|
| Base view of the channel AWS S3 Reader |
In the S3 connection combo box, you must select an Amazon S3 connection
-
In the Access Key combo box, you must select a User credential of type Technical login. It must have a username/password authentication containing the access key id and the access key secret used to authenticate against the Amazon object store.
-
From the Operation combo box, you can select LOOKUP, DOWNLOAD, GET_TAGS or LIST.
-
In the Call timeout you can configure the amount of time that the Client will be given to complete the call. The timeout feature doesn't have strict guarantees on how quickly a request will be aborted if the timeout is exceeded. The typical case is that the request is aborted within a few milliseconds, but occasionally there are requests that aren't aborted until several seconds after the timer has been breached.
Depending on the selected operation, the channel will have different parameters:
DOWNLOAD
This operation downloads an Object from the S3 bucket. In Orchestra the object is represented as an Orchestra message.
| Parameter Name | Description |
|---|---|
| BUCKET_NAME | If the option Bucket name as parameter is selected an additional input parameter BUCKET_NAME is available. In this case you must provide the name of the bucket as parameter. |
| OBJECT_NAME | The identifier of the object to read. |
| MSG | Output parameter. Receives the content of the object. Depending on the content type, a JSON message, a structured (XML) message or a binary message is created. |
| ETAG | A unique ID of the object content. In most cases, the MD5 checksum of the content. |
| VERSION_ID | If the option Objects are versioned is selected an additional input parameter VERSION_ID is available. In this case the parameter denotes the version of the Object you want to read. The version of the read object is also returned as the value of the VERSION_ID output parameter. |
LOOKUP
This operation checks if an object with the given name exists in the bucket. If it doesn't exist null is returned, otherwise a small message containing meta information about the object is returned.
| Parameter Name | Description |
|---|---|
| BUCKET_NAME | If the option Bucket name as parameter is selected an additional input parameter BUCKET_NAME is available. In this case you must provide the name of the bucket as parameter. |
| OBJECT_NAME | The identifier of the object to lookup. |
| VERSION_ID | If the option Objects are versioned is selected an additional input parameter VERSION_ID is available. In this case the parameter denotes the version of the Object you want to read. |
| MSG | The result message. If no object with the given OBJECT_NAME exists then null is returned. Otherwise, a JSON message containing a JSON object is returned. It contains the Bucket-Name, the Object-Name, ETag, Version-ID, Content-Type, Content-Length, Last-Modified timestamp and other properties of the s3 object. |
GET_TAGS
This operation returns the tags assigned to a certain S3 object. Tags are simple key value pairs. The tags are returned as a JSON message containing a JSON object. The JSON object contains the tags assigned to the s3 object.
| Parameter Name | Description |
|---|---|
| BUCKET_NAME | If the option Bucket name as parameter is selected an additional input parameter BUCKET_NAME is available. In this case you must provide the name of the bucket as parameter. |
| OBJECT_NAME | The identifier of the object whose Tags you want to read. |
| VERSION_ID | If the option Objects are versioned is selected an additional input parameter VERSION_ID is available. In this case the parameter denotes the version of the Object. |
| MSG | Output parameter. A JSON message containing a JSON object. It contains the tags which are assigned to the s3 object, that is a sequence of key value pairs. |
LIST
This operation queries information about Objects in a bucket. it returns a JSON message containing an array of JSON objects. Each array element contains some properties of an s3 object in the bucket.
| Parameter Name | Description |
|---|---|
| BUCKET_NAME | If the option Bucket name as parameter is selected an additional input parameter BUCKET_NAME is available. In this case you must provide the name of the bucket as parameter. |
| NAME_PREFIX | You can optionally provide a prefix to limit the objects you want to read. The name of each object to be contained in the resulting list must start with that prefix. |
| MSG | The result message. It is a JSON message containing a JSON array. Each array element is an object containing the objectId, eTag, lastModified timestamp and storageClass of the s3 object. |