Get basin configuration.

curl --request GET \
  --url https://aws.s2.dev/v1/basins/{basin} \
  --header 'Authorization: Bearer <token>'

{
  "create_stream_on_append": true,
  "create_stream_on_read": true,
  "default_stream_config": "<unknown>"
}

GET

basins

{basin}

Get basin configuration.

curl --request GET \
  --url https://aws.s2.dev/v1/basins/{basin} \
  --header 'Authorization: Bearer <token>'

{
  "create_stream_on_append": true,
  "create_stream_on_read": true,
  "default_stream_config": "<unknown>"
}

Authorizations

Authorization

string

header

required

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

Path Parameters

basin

string

required

Basin name.

Required string length: 1 - 48

Response

create_stream_on_append

boolean

Create stream on append if it doesn't exist, using the default stream configuration.

create_stream_on_read

boolean

Create stream on read if it doesn't exist, using the default stream configuration.

default_stream_config

object

Default stream configuration.

Show child attributes

default_stream_config.delete_on_empty

object

Delete-on-empty configuration.

Show child attributes

default_stream_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

default_stream_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

default_stream_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

default_stream_config.storage_class

null | enum<string>

Storage class for recent writes.

Available options:

standard,

express

default_stream_config.timestamping

object

Timestamping behavior.

Show child attributes

default_stream_config.timestamping.mode

null | enum<string>

Timestamping mode for appends that influences how timestamps are handled.

Available options:

client-prefer,

client-require,

arrival

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

create create / reconfigure

⌘I

records

access tokens

streams

basins

metrics

Get basin configuration.

Authorizations

Path Parameters

Response