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

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.

Body

application/json
​
delete_on_empty
object | null

Delete-on-empty configuration.

​
retention_policy
object | null

Retention policy for the stream. If unspecified, the default is to retain records for 7 days. Age in seconds for automatic trimming of records older than this threshold. This must be set to a value greater than 0 seconds. (While S2 is in public preview, this is capped at 28 days. Let us know if you'd like the cap removed.)

​
storage_class
enum<string> | null

Storage class for recent writes.

Available options:
standard,
express
​
timestamping
object | null

Timestamping behavior.

Response

​
delete_on_empty
object | null

Delete-on-empty configuration.

​
retention_policy
object | null

Retention policy for the stream. If unspecified, the default is to retain records for 7 days. Age in seconds for automatic trimming of records older than this threshold. This must be set to a value greater than 0 seconds. (While S2 is in public preview, this is capped at 28 days. Let us know if you'd like the cap removed.)

​
storage_class
enum<string> | null

Storage class for recent writes.

Available options:
standard,
express
​
timestamping
object | null

Timestamping behavior.