GET
/
streams
/
{stream}
curl --request GET \
  --url https://{basin}.b.aws.s2.dev/v1/streams/{stream} \
  --header 'Authorization: Bearer <token>'
{
  "require_client_timestamps": true,
  "retention_policy": null,
  "storage_class": null,
  "uncapped_client_timestamps": true
}

Authorizations

​
Authorization
string
header
required

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

Path Parameters

​
stream
string
required

Stream name, which must be unique within the basin. It can be an arbitrary string upto 512 characters. Backslash (/) is recommended as a delimiter for hierarchical naming.

Response

200
application/json
​
require_client_timestamps
boolean | null

Controls how to handle timestamps when they are not provided by the client. If this is false (or not set), the record's arrival time in milliseconds since Unix epoch will be assigned as its timestamp. If this is true, then any append without a client-specified timestamp will be rejected as invalid.

​
retention_policy
object | null

Retention policy for the stream. If unspecified, the default is to retain records for 7 days.

​
storage_class
enum<string> | null

Storage class for recent writes. This is the main cost:performance knob in S2.

Available options:
standard,
express
​
uncapped_client_timestamps
boolean | null

Allow client timestamps to exceed the arrival time in milliseconds since Unix epoch. If this is false (or not set), client timestamps will be capped at the arrival time.