Introduction
The S3 sink writes Run results to any S3-compatible storage as JSON files. This is useful for persisting results and accessing them later.Usage
S3 sinks can be used with either the Run API or the Job API. When creating a Run or Job, specify the sink type ass3 and provide the necessary S3 configuration such as bucket, accessKeyId, secretAccessKey, and region. You can also optionally provide a prefix to organize files within the bucket. See the Configuration section below for full details on available options.
Configuration
Properties
The secret access key for the S3 bucket.Example:
wJalrXUtnFFFI/K7MDENG/bsxRfiCYEXAMPLEKEYOptional prefix for the S3 objects. This can be used to organize objects within the bucket.Example:
my-prefix/List of API names to include. If not provided, results from all APIs are written.Example:
["api1", "api2"]Optional custom endpoint for the S3 bucket. This can be used for S3-compatible services.Example:
https://s3.custom-endpoint.comIf true, the S3 client will use path-style URLs instead of virtual-hosted-style URLs. This is useful for S3-compatible services that require path-style access.Example:
trueExample Configuration
File content
Each file is a.json file containing the API Run result along with additional metadata. See the sink body page for more information on the payload structure.