Type Alias S2ClientOptions

Configuration for constructing the top-level S2 client.

type S2ClientOptions = {
    accessToken: string;
    baseUrl?: string;
    makeBasinBaseUrl?: (basin: string) => string;
    retry?: RetryConfig;
}

Properties

accessToken: string

Access token used for HTTP Bearer authentication. Typically obtained via your S2 account or created using s2.accessTokens.issue.

baseUrl?: string

Base URL for the S2 API. Defaults to https://aws.s2.dev.

makeBasinBaseUrl?: (basin: string) => string

Function to make a basin-specific base URL. Defaults to https://{basin}.b.aws.s2.dev.

Retry configuration for handling transient failures. Applies to management operations (basins, streams, tokens) and stream operations (read, append).

{ maxAttempts: 3, retryBackoffDurationMillis: 100 }