GET
/
streams
/
{stream}
/
records
curl --request GET \
  --url https://{basin}.b.aws.s2.dev/v1alpha/streams/{stream}/records \
  --header 'Authorization: Bearer <token>'
{
  "batch": {
    "records": [
      {
        "body": "<string>",
        "headers": [
          {
            "name": "<string>",
            "value": "<string>"
          }
        ],
        "seq_num": 1,
        "timestamp": 1
      }
    ]
  }
}

Authorizations

​
Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Headers

​
s2-format
enum<string>
default:json

json: utf-8 plaintext data. json-binsafe: base64 encoded binary data.

Available options:
json,
json-binsafe

Path Parameters

​
stream
string
required

Name of the stream.

Query Parameters

​
start_seq_num
integer

Starting sequence number (inclusive).

Required range: x >= 0
​
limit
object

Limit on how many records can be returned upto a maximum of 1000, or 1MiB of metered bytes.

Response

200
application/json

Reply which can be a batch of records, or a sequence number if the request could not be satisfied.

​
batch
object
required

Batch of records. This batch can be empty only if a ReadLimit was provided in the associated read request, but the first record that could have been returned would violate the limit.