Module types 

Types for interacting with S2 services.

Structs

AccessTokenId

Access token ID. Must be between 1 and 96 characters.

AccessTokenInfo

Access token information.

AccessTokenScope

Access token scope.

AppendAck

Acknowledgment to an append request.

AppendInput

Input for append requests.

AppendRecord

Record to be appended to a stream.

AppendRecordBatch

A collection of append records that can be sent together in a batch.

AppendRecordParts

Record to be appended to a stream.

BasinConfig

Basin configuration.

BasinInfo

Basin information.

BasinName

Name of a basin.

CommandRecord

A command record is a special kind of AppendRecord that can be used to send command messages.

ConvertError

Error related to conversion from one type to another.

CreateBasinRequest

Create basin request.

CreateStreamRequest

Create stream request.

DeleteBasinRequest

Delete basin request.

DeleteOnEmptyConfig

Delete-on-empty config.

DeleteStreamRequest

Delete stream request.

FencingToken

A fencing token can be enforced on append requests.

Header

Headers add structured information to a record as name-value pairs.

ListAccessTokensRequest

List access tokens request.

ListAccessTokensResponse

List access tokens response.

ListBasinsRequest

List basins request.

ListBasinsResponse

List basins response.

ListStreamsRequest

List streams request.

ListStreamsResponse

List streams response.

PermittedOperationGroups

Access permissions for a group.

ReadLimit

Limit how many records can be retrieved. If both count and bytes are specified, either limit may be hit.

ReadRequest

Read request.

ReadSessionRequest

Read session request.

ReadWritePermissions

Read/Write permissions.

ReconfigureBasinRequest

Reconfigure basin request.

ReconfigureStreamRequest

Reconfigure stream request.

SequencedRecord

Record retrieved from a stream.

SequencedRecordBatch

A batch of sequenced records.

StreamConfig

Stream configuration.

StreamInfo

Stream information.

StreamPosition

Position of a record in a stream.

TimestampingConfig

Timestamping behavior.

Enums

BasinScope

Basin scope.

BasinState

Current state of the basin.

Command

Command to send through a CommandRecord.

Operation

API operations.

ReadOutput

Batch of records or the next sequence number on the stream.

ReadStart

Starting point for read requests.

ResourceSet

Matching rule.

RetentionPolicy

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

StorageClass

Storage class for recent writes.

TimestampingMode

Timestamping mode. Note that arrival time is always in milliseconds since Unix epoch.

Traits

MeteredBytes

Metered size of the object in bytes.