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

ApiGatewayManagementApiService overview

Added in v1.0.0


Table of contents


constructors

makeApiGatewayManagementApiService

Signature

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

Added in v1.0.0

models

ApiGatewayManagementApiService (class)

Signature

export declare class ApiGatewayManagementApiService

Added in v1.0.0

ApiGatewayManagementApiService$ (interface)

Signature

export interface ApiGatewayManagementApiService$ {
  /**
   * @see {@link DeleteConnectionCommand}
   */
  deleteConnection(
    args: DeleteConnectionCommandInput,
    options?: HttpHandlerOptions
  ): Effect.Effect<
    DeleteConnectionCommandOutput,
    Cause.TimeoutError | SdkError | ForbiddenError | GoneError | LimitExceededError
  >

  /**
   * @see {@link GetConnectionCommand}
   */
  getConnection(
    args: GetConnectionCommandInput,
    options?: HttpHandlerOptions
  ): Effect.Effect<
    GetConnectionCommandOutput,
    Cause.TimeoutError | SdkError | ForbiddenError | GoneError | LimitExceededError
  >

  /**
   * @see {@link PostToConnectionCommand}
   */
  postToConnection(
    args: PostToConnectionCommandInput,
    options?: HttpHandlerOptions
  ): Effect.Effect<
    PostToConnectionCommandOutput,
    Cause.TimeoutError | SdkError | ForbiddenError | GoneError | LimitExceededError | PayloadTooLargeError
  >
}

Added in v1.0.0

utils

ApiGatewayManagementApiService (namespace)

Added in v1.0.0

Config (interface)

Signature

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

Added in v1.0.0

Type (type alias)

Signature

export type Type = ApiGatewayManagementApiService$

Added in v1.0.0