Reconfigure a stream.

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

{
  "delete_on_empty": "<unknown>",
  "retention_policy": "<unknown>",
  "storage_class": "<unknown>",
  "timestamping": "<unknown>"
}

PATCH

streams

{stream}

Reconfigure a stream.

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

{
  "delete_on_empty": "<unknown>",
  "retention_policy": "<unknown>",
  "storage_class": "<unknown>",
  "timestamping": "<unknown>"
}

Authorizations

Authorization

string

header

required

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

Path Parameters

stream

string

required

Stream name.

Required string length: 1 - 512

Body

application/json

delete_on_empty

object

Delete-on-empty configuration.

Show child attributes

delete_on_empty.min_age_secs

integer<int64> | null

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

Required range: x >= 0

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

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

storage_class

null | enum<string>

Storage class for recent writes.

Available options:

standard,

express

timestamping

object

Timestamping behavior.

Show child attributes

timestamping.mode

null | enum<string>

Timestamping mode for appends that influences how timestamps are handled.

Available options:

client-prefer,

client-require,

arrival

timestamping.uncapped

boolean | null

Allow client-specified timestamps to exceed the arrival time.

Response

delete_on_empty

object

Delete-on-empty configuration.

Show child attributes

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

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

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

storage_class

null | enum<string>

Storage class for recent writes.

Available options:

standard,

express

timestamping

object

Timestamping behavior.

Show child attributes

timestamping.mode

null | enum<string>

Timestamping mode for appends that influences how timestamps are handled.

Available options:

client-prefer,

client-require,

arrival

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.

delete list

⌘I

records

access tokens

streams

basins

metrics

Reconfigure a stream.

Authorizations

Path Parameters

Body

Response