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

KafkaConnectService overview

Added in v1.0.0


Table of contents


constructors

makeKafkaConnectService

Signature

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

Added in v1.0.0

models

KafkaConnectService (class)

Signature

export declare class KafkaConnectService

Added in v1.0.0

KafkaConnectService$ (interface)

Signature

export interface KafkaConnectService$ {
  /**
   * @see {@link CreateConnectorCommand}
   */
  createConnector(
    args: CreateConnectorCommandInput,
    options?: HttpHandlerOptions
  ): Effect.Effect<
    CreateConnectorCommandOutput,
    | Cause.TimeoutError
    | SdkError
    | BadRequestError
    | ConflictError
    | ForbiddenError
    | InternalServerError
    | NotFoundError
    | ServiceUnavailableError
    | TooManyRequestsError
    | UnauthorizedError
  >

  /**
   * @see {@link CreateCustomPluginCommand}
   */
  createCustomPlugin(
    args: CreateCustomPluginCommandInput,
    options?: HttpHandlerOptions
  ): Effect.Effect<
    CreateCustomPluginCommandOutput,
    | Cause.TimeoutError
    | SdkError
    | BadRequestError
    | ConflictError
    | ForbiddenError
    | InternalServerError
    | NotFoundError
    | ServiceUnavailableError
    | TooManyRequestsError
    | UnauthorizedError
  >

  /**
   * @see {@link CreateWorkerConfigurationCommand}
   */
  createWorkerConfiguration(
    args: CreateWorkerConfigurationCommandInput,
    options?: HttpHandlerOptions
  ): Effect.Effect<
    CreateWorkerConfigurationCommandOutput,
    | Cause.TimeoutError
    | SdkError
    | BadRequestError
    | ConflictError
    | ForbiddenError
    | InternalServerError
    | NotFoundError
    | ServiceUnavailableError
    | TooManyRequestsError
    | UnauthorizedError
  >

  /**
   * @see {@link DeleteConnectorCommand}
   */
  deleteConnector(
    args: DeleteConnectorCommandInput,
    options?: HttpHandlerOptions
  ): Effect.Effect<
    DeleteConnectorCommandOutput,
    | Cause.TimeoutError
    | SdkError
    | BadRequestError
    | ForbiddenError
    | InternalServerError
    | NotFoundError
    | ServiceUnavailableError
    | TooManyRequestsError
    | UnauthorizedError
  >

  /**
   * @see {@link DeleteCustomPluginCommand}
   */
  deleteCustomPlugin(
    args: DeleteCustomPluginCommandInput,
    options?: HttpHandlerOptions
  ): Effect.Effect<
    DeleteCustomPluginCommandOutput,
    | Cause.TimeoutError
    | SdkError
    | BadRequestError
    | ForbiddenError
    | InternalServerError
    | NotFoundError
    | ServiceUnavailableError
    | TooManyRequestsError
    | UnauthorizedError
  >

  /**
   * @see {@link DeleteWorkerConfigurationCommand}
   */
  deleteWorkerConfiguration(
    args: DeleteWorkerConfigurationCommandInput,
    options?: HttpHandlerOptions
  ): Effect.Effect<
    DeleteWorkerConfigurationCommandOutput,
    | Cause.TimeoutError
    | SdkError
    | BadRequestError
    | ForbiddenError
    | InternalServerError
    | NotFoundError
    | ServiceUnavailableError
    | TooManyRequestsError
    | UnauthorizedError
  >

  /**
   * @see {@link DescribeConnectorCommand}
   */
  describeConnector(
    args: DescribeConnectorCommandInput,
    options?: HttpHandlerOptions
  ): Effect.Effect<
    DescribeConnectorCommandOutput,
    | Cause.TimeoutError
    | SdkError
    | BadRequestError
    | ForbiddenError
    | InternalServerError
    | NotFoundError
    | ServiceUnavailableError
    | TooManyRequestsError
    | UnauthorizedError
  >

  /**
   * @see {@link DescribeConnectorOperationCommand}
   */
  describeConnectorOperation(
    args: DescribeConnectorOperationCommandInput,
    options?: HttpHandlerOptions
  ): Effect.Effect<
    DescribeConnectorOperationCommandOutput,
    | Cause.TimeoutError
    | SdkError
    | BadRequestError
    | ForbiddenError
    | InternalServerError
    | NotFoundError
    | ServiceUnavailableError
    | TooManyRequestsError
    | UnauthorizedError
  >

  /**
   * @see {@link DescribeCustomPluginCommand}
   */
  describeCustomPlugin(
    args: DescribeCustomPluginCommandInput,
    options?: HttpHandlerOptions
  ): Effect.Effect<
    DescribeCustomPluginCommandOutput,
    | Cause.TimeoutError
    | SdkError
    | BadRequestError
    | ForbiddenError
    | InternalServerError
    | NotFoundError
    | ServiceUnavailableError
    | TooManyRequestsError
    | UnauthorizedError
  >

  /**
   * @see {@link DescribeWorkerConfigurationCommand}
   */
  describeWorkerConfiguration(
    args: DescribeWorkerConfigurationCommandInput,
    options?: HttpHandlerOptions
  ): Effect.Effect<
    DescribeWorkerConfigurationCommandOutput,
    | Cause.TimeoutError
    | SdkError
    | BadRequestError
    | ForbiddenError
    | InternalServerError
    | NotFoundError
    | ServiceUnavailableError
    | TooManyRequestsError
    | UnauthorizedError
  >

  /**
   * @see {@link ListConnectorOperationsCommand}
   */
  listConnectorOperations(
    args: ListConnectorOperationsCommandInput,
    options?: HttpHandlerOptions
  ): Effect.Effect<
    ListConnectorOperationsCommandOutput,
    | Cause.TimeoutError
    | SdkError
    | BadRequestError
    | ForbiddenError
    | InternalServerError
    | NotFoundError
    | ServiceUnavailableError
    | TooManyRequestsError
    | UnauthorizedError
  >

  listConnectorOperationsStream(
    args: ListConnectorOperationsCommandInput,
    options?: HttpHandlerOptions
  ): Stream.Stream<
    ListConnectorOperationsCommandOutput,
    | Cause.TimeoutError
    | SdkError
    | BadRequestError
    | ForbiddenError
    | InternalServerError
    | NotFoundError
    | ServiceUnavailableError
    | TooManyRequestsError
    | UnauthorizedError
  >

  /**
   * @see {@link ListConnectorsCommand}
   */
  listConnectors(
    args: ListConnectorsCommandInput,
    options?: HttpHandlerOptions
  ): Effect.Effect<
    ListConnectorsCommandOutput,
    | Cause.TimeoutError
    | SdkError
    | BadRequestError
    | ForbiddenError
    | InternalServerError
    | NotFoundError
    | ServiceUnavailableError
    | TooManyRequestsError
    | UnauthorizedError
  >

  listConnectorsStream(
    args: ListConnectorsCommandInput,
    options?: HttpHandlerOptions
  ): Stream.Stream<
    ListConnectorsCommandOutput,
    | Cause.TimeoutError
    | SdkError
    | BadRequestError
    | ForbiddenError
    | InternalServerError
    | NotFoundError
    | ServiceUnavailableError
    | TooManyRequestsError
    | UnauthorizedError
  >

  /**
   * @see {@link ListCustomPluginsCommand}
   */
  listCustomPlugins(
    args: ListCustomPluginsCommandInput,
    options?: HttpHandlerOptions
  ): Effect.Effect<
    ListCustomPluginsCommandOutput,
    | Cause.TimeoutError
    | SdkError
    | BadRequestError
    | ForbiddenError
    | InternalServerError
    | NotFoundError
    | ServiceUnavailableError
    | TooManyRequestsError
    | UnauthorizedError
  >

  listCustomPluginsStream(
    args: ListCustomPluginsCommandInput,
    options?: HttpHandlerOptions
  ): Stream.Stream<
    ListCustomPluginsCommandOutput,
    | Cause.TimeoutError
    | SdkError
    | BadRequestError
    | ForbiddenError
    | InternalServerError
    | NotFoundError
    | ServiceUnavailableError
    | TooManyRequestsError
    | UnauthorizedError
  >

  /**
   * @see {@link ListTagsForResourceCommand}
   */
  listTagsForResource(
    args: ListTagsForResourceCommandInput,
    options?: HttpHandlerOptions
  ): Effect.Effect<
    ListTagsForResourceCommandOutput,
    | Cause.TimeoutError
    | SdkError
    | BadRequestError
    | ForbiddenError
    | InternalServerError
    | NotFoundError
    | ServiceUnavailableError
    | TooManyRequestsError
    | UnauthorizedError
  >

  /**
   * @see {@link ListWorkerConfigurationsCommand}
   */
  listWorkerConfigurations(
    args: ListWorkerConfigurationsCommandInput,
    options?: HttpHandlerOptions
  ): Effect.Effect<
    ListWorkerConfigurationsCommandOutput,
    | Cause.TimeoutError
    | SdkError
    | BadRequestError
    | ForbiddenError
    | InternalServerError
    | NotFoundError
    | ServiceUnavailableError
    | TooManyRequestsError
    | UnauthorizedError
  >

  listWorkerConfigurationsStream(
    args: ListWorkerConfigurationsCommandInput,
    options?: HttpHandlerOptions
  ): Stream.Stream<
    ListWorkerConfigurationsCommandOutput,
    | Cause.TimeoutError
    | SdkError
    | BadRequestError
    | ForbiddenError
    | InternalServerError
    | NotFoundError
    | ServiceUnavailableError
    | TooManyRequestsError
    | UnauthorizedError
  >

  /**
   * @see {@link RestartConnectorCommand}
   */
  restartConnector(
    args: RestartConnectorCommandInput,
    options?: HttpHandlerOptions
  ): Effect.Effect<
    RestartConnectorCommandOutput,
    | Cause.TimeoutError
    | SdkError
    | BadRequestError
    | ForbiddenError
    | InternalServerError
    | NotFoundError
    | ServiceUnavailableError
    | TooManyRequestsError
    | UnauthorizedError
  >

  /**
   * @see {@link TagResourceCommand}
   */
  tagResource(
    args: TagResourceCommandInput,
    options?: HttpHandlerOptions
  ): Effect.Effect<
    TagResourceCommandOutput,
    | Cause.TimeoutError
    | SdkError
    | BadRequestError
    | ConflictError
    | ForbiddenError
    | InternalServerError
    | NotFoundError
    | ServiceUnavailableError
    | TooManyRequestsError
    | UnauthorizedError
  >

  /**
   * @see {@link UntagResourceCommand}
   */
  untagResource(
    args: UntagResourceCommandInput,
    options?: HttpHandlerOptions
  ): Effect.Effect<
    UntagResourceCommandOutput,
    | Cause.TimeoutError
    | SdkError
    | BadRequestError
    | ForbiddenError
    | InternalServerError
    | NotFoundError
    | ServiceUnavailableError
    | TooManyRequestsError
    | UnauthorizedError
  >

  /**
   * @see {@link UpdateConnectorCommand}
   */
  updateConnector(
    args: UpdateConnectorCommandInput,
    options?: HttpHandlerOptions
  ): Effect.Effect<
    UpdateConnectorCommandOutput,
    | Cause.TimeoutError
    | SdkError
    | BadRequestError
    | ForbiddenError
    | InternalServerError
    | NotFoundError
    | ServiceUnavailableError
    | TooManyRequestsError
    | UnauthorizedError
  >
}

Added in v1.0.0

utils

KafkaConnectService (namespace)

Added in v1.0.0

Config (interface)

Signature

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

Added in v1.0.0

Type (type alias)

Signature

export type Type = KafkaConnectService$

Added in v1.0.0