GET
/
streams
/
{stream}
/
records
curl --request GET \
  --url https://{basin}.b.aws.s2.dev/v1/streams/{stream}/records \
  --header 'Authorization: Bearer <token>'
{
  "records": [
    {
      "body": "<string>",
      "headers": [
        [
          "<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>

Define treatment of blob fields when exchanging records as JSON. The default is raw.

Available options:
raw,
base64

Path Parameters

​
stream
string
required

Stream name.

Query Parameters

​
seq_num
integer

Start from a sequence number.

Required range: x >= 0
​
timestamp
integer

Start from a timestamp.

Required range: x >= 0
​
tail_offset
integer

Start from number of records before the tail, i.e. before the next sequence number.

Required range: x >= 0
​
count
integer

Limit total records to return.

Required range: x >= 0
​
bytes
integer

Limit total metered bytes to return.

Required range: x >= 0

Response

200
application/json

The response is of type object.