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

TimestreamQueryService overview

Added in v1.0.0


Table of contents


constructors

makeTimestreamQueryService

Signature

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

Added in v1.0.0

models

TimestreamQueryService (class)

Signature

export declare class TimestreamQueryService

Added in v1.0.0

TimestreamQueryService$ (interface)

Signature

export interface TimestreamQueryService$ {
  /**
   * @see {@link CancelQueryCommand}
   */
  cancelQuery(
    args: CancelQueryCommandInput,
    options?: HttpHandlerOptions
  ): Effect.Effect<
    CancelQueryCommandOutput,
    | Cause.TimeoutError
    | SdkError
    | AccessDeniedError
    | InternalServerError
    | InvalidEndpointError
    | ThrottlingError
    | ValidationError
  >

  /**
   * @see {@link CreateScheduledQueryCommand}
   */
  createScheduledQuery(
    args: CreateScheduledQueryCommandInput,
    options?: HttpHandlerOptions
  ): Effect.Effect<
    CreateScheduledQueryCommandOutput,
    | Cause.TimeoutError
    | SdkError
    | AccessDeniedError
    | ConflictError
    | InternalServerError
    | InvalidEndpointError
    | ServiceQuotaExceededError
    | ThrottlingError
    | ValidationError
  >

  /**
   * @see {@link DeleteScheduledQueryCommand}
   */
  deleteScheduledQuery(
    args: DeleteScheduledQueryCommandInput,
    options?: HttpHandlerOptions
  ): Effect.Effect<
    DeleteScheduledQueryCommandOutput,
    | Cause.TimeoutError
    | SdkError
    | AccessDeniedError
    | InternalServerError
    | InvalidEndpointError
    | ResourceNotFoundError
    | ThrottlingError
    | ValidationError
  >

  /**
   * @see {@link DescribeAccountSettingsCommand}
   */
  describeAccountSettings(
    args: DescribeAccountSettingsCommandInput,
    options?: HttpHandlerOptions
  ): Effect.Effect<
    DescribeAccountSettingsCommandOutput,
    Cause.TimeoutError | SdkError | AccessDeniedError | InternalServerError | InvalidEndpointError | ThrottlingError
  >

  /**
   * @see {@link DescribeEndpointsCommand}
   */
  describeEndpoints(
    args: DescribeEndpointsCommandInput,
    options?: HttpHandlerOptions
  ): Effect.Effect<
    DescribeEndpointsCommandOutput,
    Cause.TimeoutError | SdkError | InternalServerError | ThrottlingError | ValidationError
  >

  /**
   * @see {@link DescribeScheduledQueryCommand}
   */
  describeScheduledQuery(
    args: DescribeScheduledQueryCommandInput,
    options?: HttpHandlerOptions
  ): Effect.Effect<
    DescribeScheduledQueryCommandOutput,
    | Cause.TimeoutError
    | SdkError
    | AccessDeniedError
    | InternalServerError
    | InvalidEndpointError
    | ResourceNotFoundError
    | ThrottlingError
    | ValidationError
  >

  /**
   * @see {@link ExecuteScheduledQueryCommand}
   */
  executeScheduledQuery(
    args: ExecuteScheduledQueryCommandInput,
    options?: HttpHandlerOptions
  ): Effect.Effect<
    ExecuteScheduledQueryCommandOutput,
    | Cause.TimeoutError
    | SdkError
    | AccessDeniedError
    | InternalServerError
    | InvalidEndpointError
    | ResourceNotFoundError
    | ThrottlingError
    | ValidationError
  >

  /**
   * @see {@link ListScheduledQueriesCommand}
   */
  listScheduledQueries(
    args: ListScheduledQueriesCommandInput,
    options?: HttpHandlerOptions
  ): Effect.Effect<
    ListScheduledQueriesCommandOutput,
    | Cause.TimeoutError
    | SdkError
    | AccessDeniedError
    | InternalServerError
    | InvalidEndpointError
    | ThrottlingError
    | ValidationError
  >

  listScheduledQueriesStream(
    args: ListScheduledQueriesCommandInput,
    options?: HttpHandlerOptions
  ): Stream.Stream<
    ListScheduledQueriesCommandOutput,
    | Cause.TimeoutError
    | SdkError
    | AccessDeniedError
    | InternalServerError
    | InvalidEndpointError
    | ThrottlingError
    | ValidationError
  >

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

  listTagsForResourceStream(
    args: ListTagsForResourceCommandInput,
    options?: HttpHandlerOptions
  ): Stream.Stream<
    ListTagsForResourceCommandOutput,
    Cause.TimeoutError | SdkError | InvalidEndpointError | ResourceNotFoundError | ThrottlingError | ValidationError
  >

  /**
   * @see {@link PrepareQueryCommand}
   */
  prepareQuery(
    args: PrepareQueryCommandInput,
    options?: HttpHandlerOptions
  ): Effect.Effect<
    PrepareQueryCommandOutput,
    | Cause.TimeoutError
    | SdkError
    | AccessDeniedError
    | InternalServerError
    | InvalidEndpointError
    | ThrottlingError
    | ValidationError
  >

  /**
   * @see {@link QueryCommand}
   */
  query(
    args: QueryCommandInput,
    options?: HttpHandlerOptions
  ): Effect.Effect<
    QueryCommandOutput,
    | Cause.TimeoutError
    | SdkError
    | AccessDeniedError
    | ConflictError
    | InternalServerError
    | InvalidEndpointError
    | QueryExecutionError
    | ThrottlingError
    | ValidationError
  >

  queryStream(
    args: QueryCommandInput,
    options?: HttpHandlerOptions
  ): Stream.Stream<
    QueryCommandOutput,
    | Cause.TimeoutError
    | SdkError
    | AccessDeniedError
    | ConflictError
    | InternalServerError
    | InvalidEndpointError
    | QueryExecutionError
    | ThrottlingError
    | ValidationError
  >

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

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

  /**
   * @see {@link UpdateAccountSettingsCommand}
   */
  updateAccountSettings(
    args: UpdateAccountSettingsCommandInput,
    options?: HttpHandlerOptions
  ): Effect.Effect<
    UpdateAccountSettingsCommandOutput,
    | Cause.TimeoutError
    | SdkError
    | AccessDeniedError
    | InternalServerError
    | InvalidEndpointError
    | ThrottlingError
    | ValidationError
  >

  /**
   * @see {@link UpdateScheduledQueryCommand}
   */
  updateScheduledQuery(
    args: UpdateScheduledQueryCommandInput,
    options?: HttpHandlerOptions
  ): Effect.Effect<
    UpdateScheduledQueryCommandOutput,
    | Cause.TimeoutError
    | SdkError
    | AccessDeniedError
    | InternalServerError
    | InvalidEndpointError
    | ResourceNotFoundError
    | ThrottlingError
    | ValidationError
  >
}

Added in v1.0.0

utils

TimestreamQueryService (namespace)

Added in v1.0.0

Config (interface)

Signature

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

Added in v1.0.0

Type (type alias)

Signature

export type Type = TimestreamQueryService$

Added in v1.0.0