Skip to main content Link Search Menu Expand Document (external link)

DSQLService overview

Added in v1.0.0


Table of contents


constructors

makeDSQLService

Signature

export declare const makeDSQLService: Effect.Effect<any, unknown, unknown>

Added in v1.0.0

models

DSQLService (class)

Signature

export declare class DSQLService

Added in v1.0.0

DSQLService$ (interface)

Signature

export interface DSQLService$ {
  /**
   * @see {@link CreateClusterCommand}
   */
  createCluster(
    args: CreateClusterCommandInput,
    options?: HttpHandlerOptions
  ): Effect.Effect<
    CreateClusterCommandOutput,
    Cause.TimeoutError | SdkError | ConflictError | ServiceQuotaExceededError | ValidationError
  >

  /**
   * @see {@link CreateStreamCommand}
   */
  createStream(
    args: CreateStreamCommandInput,
    options?: HttpHandlerOptions
  ): Effect.Effect<
    CreateStreamCommandOutput,
    Cause.TimeoutError | SdkError | ConflictError | ResourceNotFoundError | ServiceQuotaExceededError | ValidationError
  >

  /**
   * @see {@link DeleteClusterCommand}
   */
  deleteCluster(
    args: DeleteClusterCommandInput,
    options?: HttpHandlerOptions
  ): Effect.Effect<DeleteClusterCommandOutput, Cause.TimeoutError | SdkError | ConflictError | ResourceNotFoundError>

  /**
   * @see {@link DeleteClusterPolicyCommand}
   */
  deleteClusterPolicy(
    args: DeleteClusterPolicyCommandInput,
    options?: HttpHandlerOptions
  ): Effect.Effect<
    DeleteClusterPolicyCommandOutput,
    Cause.TimeoutError | SdkError | ConflictError | ResourceNotFoundError | ValidationError
  >

  /**
   * @see {@link DeleteStreamCommand}
   */
  deleteStream(
    args: DeleteStreamCommandInput,
    options?: HttpHandlerOptions
  ): Effect.Effect<DeleteStreamCommandOutput, Cause.TimeoutError | SdkError | ConflictError | ResourceNotFoundError>

  /**
   * @see {@link GetClusterCommand}
   */
  getCluster(
    args: GetClusterCommandInput,
    options?: HttpHandlerOptions
  ): Effect.Effect<GetClusterCommandOutput, Cause.TimeoutError | SdkError | ResourceNotFoundError>

  /**
   * @see {@link GetClusterPolicyCommand}
   */
  getClusterPolicy(
    args: GetClusterPolicyCommandInput,
    options?: HttpHandlerOptions
  ): Effect.Effect<
    GetClusterPolicyCommandOutput,
    Cause.TimeoutError | SdkError | ResourceNotFoundError | ValidationError
  >

  /**
   * @see {@link GetStreamCommand}
   */
  getStream(
    args: GetStreamCommandInput,
    options?: HttpHandlerOptions
  ): Effect.Effect<GetStreamCommandOutput, Cause.TimeoutError | SdkError | ResourceNotFoundError>

  /**
   * @see {@link GetVpcEndpointServiceNameCommand}
   */
  getVpcEndpointServiceName(
    args: GetVpcEndpointServiceNameCommandInput,
    options?: HttpHandlerOptions
  ): Effect.Effect<
    GetVpcEndpointServiceNameCommandOutput,
    Cause.TimeoutError | SdkError | InternalServerError | ResourceNotFoundError | ThrottlingError | ValidationError
  >

  /**
   * @see {@link ListClustersCommand}
   */
  listClusters(
    args: ListClustersCommandInput,
    options?: HttpHandlerOptions
  ): Effect.Effect<ListClustersCommandOutput, Cause.TimeoutError | SdkError | ResourceNotFoundError>

  listClustersStream(
    args: ListClustersCommandInput,
    options?: HttpHandlerOptions
  ): Stream.Stream<ListClustersCommandOutput, Cause.TimeoutError | SdkError | ResourceNotFoundError>

  /**
   * @see {@link ListStreamsCommand}
   */
  listStreams(
    args: ListStreamsCommandInput,
    options?: HttpHandlerOptions
  ): Effect.Effect<ListStreamsCommandOutput, Cause.TimeoutError | SdkError | ResourceNotFoundError>

  listStreamsStream(
    args: ListStreamsCommandInput,
    options?: HttpHandlerOptions
  ): Stream.Stream<ListStreamsCommandOutput, Cause.TimeoutError | SdkError | ResourceNotFoundError>

  /**
   * @see {@link ListTagsForResourceCommand}
   */
  listTagsForResource(
    args: ListTagsForResourceCommandInput,
    options?: HttpHandlerOptions
  ): Effect.Effect<ListTagsForResourceCommandOutput, Cause.TimeoutError | SdkError | ResourceNotFoundError>

  /**
   * @see {@link PutClusterPolicyCommand}
   */
  putClusterPolicy(
    args: PutClusterPolicyCommandInput,
    options?: HttpHandlerOptions
  ): Effect.Effect<
    PutClusterPolicyCommandOutput,
    Cause.TimeoutError | SdkError | ConflictError | ResourceNotFoundError | ValidationError
  >

  /**
   * @see {@link TagResourceCommand}
   */
  tagResource(
    args: TagResourceCommandInput,
    options?: HttpHandlerOptions
  ): Effect.Effect<
    TagResourceCommandOutput,
    Cause.TimeoutError | SdkError | ResourceNotFoundError | ServiceQuotaExceededError
  >

  /**
   * @see {@link UntagResourceCommand}
   */
  untagResource(
    args: UntagResourceCommandInput,
    options?: HttpHandlerOptions
  ): Effect.Effect<UntagResourceCommandOutput, Cause.TimeoutError | SdkError | ResourceNotFoundError>

  /**
   * @see {@link UpdateClusterCommand}
   */
  updateCluster(
    args: UpdateClusterCommandInput,
    options?: HttpHandlerOptions
  ): Effect.Effect<
    UpdateClusterCommandOutput,
    Cause.TimeoutError | SdkError | ConflictError | ResourceNotFoundError | ValidationError
  >
}

Added in v1.0.0

utils

DSQLService (namespace)

Added in v1.0.0

Config (interface)

Signature

export interface Config extends Omit<DSQLClientConfig, "logger"> {
  readonly logger?: ServiceLogger.ServiceLoggerConstructorProps | true
}

Added in v1.0.0

Type (type alias)

Signature

export type Type = DSQLService$

Added in v1.0.0