Skip to main content
The S3 Sink command (Command Type: 1202) sends the job result to the sink service, which uploads it to an S3 bucket. The full object key is: {keyPrefix}/{YYYY}/{MM}/{DD}/{uuid}.json.

Command Type

Command Type ID: 1202

Parameters

ParameterTypeDescriptionRequired
bucketstringDestination S3 bucket nameYes
keyPrefixstringPrefix prepended to every uploaded object keyYes
compressbooleanWhen true, gzip-compresses the payload before upload (key uses .json.gz extension)No
dataSegmentToSendstringWhich part of the data to send. Possible values: "fullData", "data". Defaults to "fullData"No

Usage Examples

Upload to S3

{
  "command": "s3-sink",
  "params": {
    "bucket": "my-data-bucket",
    "keyPrefix": "events/football"
  }
}

Upload Compressed

{
  "command": "s3-sink",
  "params": {
    "bucket": "my-data-bucket",
    "keyPrefix": "odds/live",
    "compress": true,
    "dataSegmentToSend": "data"
  }
}