Create a stream.

curl --request POST \
  --url https://aws.s2.dev/v1/streams \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "stream": "<string>",
  "config": "<unknown>"
}
'

{
  "created_at": "<string>",
  "name": "<string>",
  "deleted_at": "<string>"
}

POST

streams

Create a stream.

curl --request POST \
  --url https://aws.s2.dev/v1/streams \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "stream": "<string>",
  "config": "<unknown>"
}
'

{
  "created_at": "<string>",
  "name": "<string>",
  "deleted_at": "<string>"
}

Authorizations

Authorization

string

header

required

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

Headers

s2-request-token

string

Client-specified request token for idempotent retries.

Body

application/json

stream

string

required

Stream name that is unique to the basin. It can be between 1 and 512 bytes in length.

Required string length: 1 - 512

config

object

Stream configuration.

Show child attributes

config.delete_on_empty

object

Delete-on-empty configuration.

Show child attributes

config.delete_on_empty.min_age_secs

integer<int64>

Minimum age in seconds before an empty stream can be deleted. Set to 0 (default) to disable delete-on-empty (don't delete automatically).

Required range: x >= 0

config.retention_policy

object

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

Option 1
Option 2

Show child attributes

config.retention_policy.age

integer<int64>

required

Age in seconds for automatic trimming of records older than this threshold. This must be set to a value greater than 0 seconds.

Required range: x >= 0

config.storage_class

null | enum<string>

Storage class for recent writes.

Available options:

standard,

express

config.timestamping

object

Timestamping behavior.

Show child attributes

config.timestamping.mode

null | enum<string>

Timestamping mode for appends that influences how timestamps are handled.

Available options:

client-prefer,

client-require,

arrival

config.timestamping.uncapped

boolean | null

Allow client-specified timestamps to exceed the arrival time. If this is false or not set, client timestamps will be capped at the arrival time.

Response

created_at

string<time>

required

Creation time in ISO 8601 format.

name

string

required

Stream name.

Required string length: 1 - 512

deleted_at

string<time> | null

Deletion time in ISO 8601 format, if the stream is being deleted.

list get config

⌘I

records

access tokens

streams

basins

metrics

Create a stream.

Authorizations

Headers

Body

Response