Type Alias S2ClientOptions

Configuration for constructing the top-level S2 client.

type S2ClientOptions = {
    accessToken: string;
    endpoints?: S2Endpoints | S2EndpointsInit;
    retry?: RetryConfig;
}

Properties

accessToken: string

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

Endpoint configuration for the S2 environment.

Defaults to AWS (aws.s2.dev and {basin}.b.aws.s2.dev) with the API base path inferred as /v1.

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

{ maxAttempts: 3, minDelayMillis: 100, maxDelayMillis: 1000, appendRetryPolicy: "all" }