​
Introduction

The S3 sink allows you to write the output of the job to an AWS S3 bucket. This is useful if you want to easily persist the output of your project API runs and easily access them later.
Only jobs support the AWS S3 sink.

​
Configuration

The S3 sink requires the following configurations:
  • Region: The S3 bucket region.
  • Bucket: The S3 bucket name.
  • Access Key ID: Access key ID for the IAM user to use the bucket. The IAM user has to have write permissions to the bucket.
  • Secret Access Key: Secret access key of the IAM user to use the bucket.
  • Prefix: A prefix added to the key of the file to be written. This can be used to define a folder where all results are stored.
  • Skip On Fail: If enabled, failed payload runs will not be written to the bucket.
  • APIs to Send: Specify which API results should be sent to the sink. If not specified, results from all APIs will be sent.

​
Output File Content

The output file is a .json file that contains the result of the API run with additional information. Check out the sink body page for more information on the output file content of the S3 sink.