Update stream configuration.

PATCH

streams

{stream}

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

{
  "require_client_timestamps": true,
  "retention_policy": null,
  "storage_class": "unspecified"
}

Authorizations

Authorization

string

header

required

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

Path Parameters

stream

string

required

Name of the stream.

Body

application/json

Stream configuration.

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 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>

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

Available options:

unspecified,

standard,

express

Response

200