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

KafkaService overview

Added in v1.0.0


Table of contents


constructors

makeKafkaService

Signature

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

Added in v1.0.0

models

KafkaService (class)

Signature

export declare class KafkaService

Added in v1.0.0

KafkaService$ (interface)

Signature

export interface KafkaService$ {
  /**
   * @see {@link BatchAssociateScramSecretCommand}
   */
  batchAssociateScramSecret(
    args: BatchAssociateScramSecretCommandInput,
    options?: HttpHandlerOptions
  ): Effect.Effect<
    BatchAssociateScramSecretCommandOutput,
    | Cause.TimeoutError
    | SdkError
    | BadRequestError
    | ForbiddenError
    | InternalServerError
    | NotFoundError
    | ServiceUnavailableError
    | TooManyRequestsError
    | UnauthorizedError
  >

  /**
   * @see {@link BatchDisassociateScramSecretCommand}
   */
  batchDisassociateScramSecret(
    args: BatchDisassociateScramSecretCommandInput,
    options?: HttpHandlerOptions
  ): Effect.Effect<
    BatchDisassociateScramSecretCommandOutput,
    | Cause.TimeoutError
    | SdkError
    | BadRequestError
    | ForbiddenError
    | InternalServerError
    | NotFoundError
    | ServiceUnavailableError
    | TooManyRequestsError
    | UnauthorizedError
  >

  /**
   * @see {@link CreateChannelCommand}
   */
  createChannel(
    args: CreateChannelCommandInput,
    options?: HttpHandlerOptions
  ): Effect.Effect<
    CreateChannelCommandOutput,
    | Cause.TimeoutError
    | SdkError
    | BadRequestError
    | ConflictError
    | ForbiddenError
    | InternalServerError
    | NotFoundError
    | ServiceUnavailableError
    | TooManyRequestsError
    | UnauthorizedError
  >

  /**
   * @see {@link CreateClusterCommand}
   */
  createCluster(
    args: CreateClusterCommandInput,
    options?: HttpHandlerOptions
  ): Effect.Effect<
    CreateClusterCommandOutput,
    | Cause.TimeoutError
    | SdkError
    | BadRequestError
    | ConflictError
    | ForbiddenError
    | InternalServerError
    | ServiceUnavailableError
    | TooManyRequestsError
    | UnauthorizedError
  >

  /**
   * @see {@link CreateClusterV2Command}
   */
  createClusterV2(
    args: CreateClusterV2CommandInput,
    options?: HttpHandlerOptions
  ): Effect.Effect<
    CreateClusterV2CommandOutput,
    | Cause.TimeoutError
    | SdkError
    | BadRequestError
    | ConflictError
    | ForbiddenError
    | InternalServerError
    | ServiceUnavailableError
    | TooManyRequestsError
    | UnauthorizedError
  >

  /**
   * @see {@link CreateConfigurationCommand}
   */
  createConfiguration(
    args: CreateConfigurationCommandInput,
    options?: HttpHandlerOptions
  ): Effect.Effect<
    CreateConfigurationCommandOutput,
    | Cause.TimeoutError
    | SdkError
    | BadRequestError
    | ConflictError
    | ForbiddenError
    | InternalServerError
    | ServiceUnavailableError
    | TooManyRequestsError
    | UnauthorizedError
  >

  /**
   * @see {@link CreateReplicatorCommand}
   */
  createReplicator(
    args: CreateReplicatorCommandInput,
    options?: HttpHandlerOptions
  ): Effect.Effect<
    CreateReplicatorCommandOutput,
    | Cause.TimeoutError
    | SdkError
    | BadRequestError
    | ConflictError
    | ForbiddenError
    | InternalServerError
    | NotFoundError
    | ServiceUnavailableError
    | TooManyRequestsError
    | UnauthorizedError
  >

  /**
   * @see {@link CreateTopicCommand}
   */
  createTopic(
    args: CreateTopicCommandInput,
    options?: HttpHandlerOptions
  ): Effect.Effect<
    CreateTopicCommandOutput,
    | Cause.TimeoutError
    | SdkError
    | BadRequestError
    | ClusterConnectivityError
    | ConflictError
    | ControllerMovedError
    | ForbiddenError
    | GroupSubscribedToTopicError
    | InternalServerError
    | KafkaRequestError
    | KafkaTimeoutError
    | NotControllerError
    | ReassignmentInProgressError
    | ServiceUnavailableError
    | TooManyRequestsError
    | TopicExistsError
    | UnauthorizedError
    | UnknownTopicOrPartitionError
  >

  /**
   * @see {@link CreateVpcConnectionCommand}
   */
  createVpcConnection(
    args: CreateVpcConnectionCommandInput,
    options?: HttpHandlerOptions
  ): Effect.Effect<
    CreateVpcConnectionCommandOutput,
    | Cause.TimeoutError
    | SdkError
    | BadRequestError
    | ForbiddenError
    | InternalServerError
    | ServiceUnavailableError
    | TooManyRequestsError
    | UnauthorizedError
  >

  /**
   * @see {@link DeleteChannelCommand}
   */
  deleteChannel(
    args: DeleteChannelCommandInput,
    options?: HttpHandlerOptions
  ): Effect.Effect<
    DeleteChannelCommandOutput,
    | Cause.TimeoutError
    | SdkError
    | BadRequestError
    | ForbiddenError
    | InternalServerError
    | NotFoundError
    | ServiceUnavailableError
    | TooManyRequestsError
    | UnauthorizedError
  >

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

  /**
   * @see {@link DeleteClusterPolicyCommand}
   */
  deleteClusterPolicy(
    args: DeleteClusterPolicyCommandInput,
    options?: HttpHandlerOptions
  ): Effect.Effect<
    DeleteClusterPolicyCommandOutput,
    Cause.TimeoutError | SdkError | BadRequestError | ForbiddenError | InternalServerError | NotFoundError
  >

  /**
   * @see {@link DeleteConfigurationCommand}
   */
  deleteConfiguration(
    args: DeleteConfigurationCommandInput,
    options?: HttpHandlerOptions
  ): Effect.Effect<
    DeleteConfigurationCommandOutput,
    Cause.TimeoutError | SdkError | BadRequestError | ForbiddenError | InternalServerError | NotFoundError
  >

  /**
   * @see {@link DeleteReplicatorCommand}
   */
  deleteReplicator(
    args: DeleteReplicatorCommandInput,
    options?: HttpHandlerOptions
  ): Effect.Effect<
    DeleteReplicatorCommandOutput,
    | Cause.TimeoutError
    | SdkError
    | BadRequestError
    | ForbiddenError
    | InternalServerError
    | NotFoundError
    | ServiceUnavailableError
    | TooManyRequestsError
    | UnauthorizedError
  >

  /**
   * @see {@link DeleteTopicCommand}
   */
  deleteTopic(
    args: DeleteTopicCommandInput,
    options?: HttpHandlerOptions
  ): Effect.Effect<
    DeleteTopicCommandOutput,
    | Cause.TimeoutError
    | SdkError
    | BadRequestError
    | ClusterConnectivityError
    | ControllerMovedError
    | ForbiddenError
    | GroupSubscribedToTopicError
    | InternalServerError
    | KafkaRequestError
    | KafkaTimeoutError
    | NotControllerError
    | NotFoundError
    | ReassignmentInProgressError
    | UnknownTopicOrPartitionError
  >

  /**
   * @see {@link DeleteVpcConnectionCommand}
   */
  deleteVpcConnection(
    args: DeleteVpcConnectionCommandInput,
    options?: HttpHandlerOptions
  ): Effect.Effect<
    DeleteVpcConnectionCommandOutput,
    Cause.TimeoutError | SdkError | BadRequestError | ForbiddenError | InternalServerError | NotFoundError
  >

  /**
   * @see {@link DescribeChannelCommand}
   */
  describeChannel(
    args: DescribeChannelCommandInput,
    options?: HttpHandlerOptions
  ): Effect.Effect<
    DescribeChannelCommandOutput,
    | Cause.TimeoutError
    | SdkError
    | BadRequestError
    | ForbiddenError
    | InternalServerError
    | NotFoundError
    | ServiceUnavailableError
    | TooManyRequestsError
    | UnauthorizedError
  >

  /**
   * @see {@link DescribeClusterCommand}
   */
  describeCluster(
    args: DescribeClusterCommandInput,
    options?: HttpHandlerOptions
  ): Effect.Effect<
    DescribeClusterCommandOutput,
    | Cause.TimeoutError
    | SdkError
    | BadRequestError
    | ForbiddenError
    | InternalServerError
    | NotFoundError
    | UnauthorizedError
  >

  /**
   * @see {@link DescribeClusterOperationCommand}
   */
  describeClusterOperation(
    args: DescribeClusterOperationCommandInput,
    options?: HttpHandlerOptions
  ): Effect.Effect<
    DescribeClusterOperationCommandOutput,
    | Cause.TimeoutError
    | SdkError
    | BadRequestError
    | ForbiddenError
    | InternalServerError
    | NotFoundError
    | UnauthorizedError
  >

  /**
   * @see {@link DescribeClusterOperationV2Command}
   */
  describeClusterOperationV2(
    args: DescribeClusterOperationV2CommandInput,
    options?: HttpHandlerOptions
  ): Effect.Effect<
    DescribeClusterOperationV2CommandOutput,
    | Cause.TimeoutError
    | SdkError
    | BadRequestError
    | ForbiddenError
    | InternalServerError
    | NotFoundError
    | ServiceUnavailableError
    | TooManyRequestsError
    | UnauthorizedError
  >

  /**
   * @see {@link DescribeClusterV2Command}
   */
  describeClusterV2(
    args: DescribeClusterV2CommandInput,
    options?: HttpHandlerOptions
  ): Effect.Effect<
    DescribeClusterV2CommandOutput,
    | Cause.TimeoutError
    | SdkError
    | BadRequestError
    | ForbiddenError
    | InternalServerError
    | NotFoundError
    | UnauthorizedError
  >

  /**
   * @see {@link DescribeConfigurationCommand}
   */
  describeConfiguration(
    args: DescribeConfigurationCommandInput,
    options?: HttpHandlerOptions
  ): Effect.Effect<
    DescribeConfigurationCommandOutput,
    | Cause.TimeoutError
    | SdkError
    | BadRequestError
    | ForbiddenError
    | InternalServerError
    | NotFoundError
    | ServiceUnavailableError
    | UnauthorizedError
  >

  /**
   * @see {@link DescribeConfigurationRevisionCommand}
   */
  describeConfigurationRevision(
    args: DescribeConfigurationRevisionCommandInput,
    options?: HttpHandlerOptions
  ): Effect.Effect<
    DescribeConfigurationRevisionCommandOutput,
    | Cause.TimeoutError
    | SdkError
    | BadRequestError
    | ForbiddenError
    | InternalServerError
    | NotFoundError
    | ServiceUnavailableError
    | UnauthorizedError
  >

  /**
   * @see {@link DescribeReplicatorCommand}
   */
  describeReplicator(
    args: DescribeReplicatorCommandInput,
    options?: HttpHandlerOptions
  ): Effect.Effect<
    DescribeReplicatorCommandOutput,
    | Cause.TimeoutError
    | SdkError
    | BadRequestError
    | ForbiddenError
    | InternalServerError
    | NotFoundError
    | ServiceUnavailableError
    | TooManyRequestsError
    | UnauthorizedError
  >

  /**
   * @see {@link DescribeTopicCommand}
   */
  describeTopic(
    args: DescribeTopicCommandInput,
    options?: HttpHandlerOptions
  ): Effect.Effect<
    DescribeTopicCommandOutput,
    | Cause.TimeoutError
    | SdkError
    | BadRequestError
    | ForbiddenError
    | InternalServerError
    | NotFoundError
    | UnauthorizedError
  >

  /**
   * @see {@link DescribeTopicPartitionsCommand}
   */
  describeTopicPartitions(
    args: DescribeTopicPartitionsCommandInput,
    options?: HttpHandlerOptions
  ): Effect.Effect<
    DescribeTopicPartitionsCommandOutput,
    | Cause.TimeoutError
    | SdkError
    | BadRequestError
    | ForbiddenError
    | InternalServerError
    | NotFoundError
    | UnauthorizedError
  >

  describeTopicPartitionsStream(
    args: DescribeTopicPartitionsCommandInput,
    options?: HttpHandlerOptions
  ): Stream.Stream<
    DescribeTopicPartitionsCommandOutput,
    | Cause.TimeoutError
    | SdkError
    | BadRequestError
    | ForbiddenError
    | InternalServerError
    | NotFoundError
    | UnauthorizedError
  >

  /**
   * @see {@link DescribeVpcConnectionCommand}
   */
  describeVpcConnection(
    args: DescribeVpcConnectionCommandInput,
    options?: HttpHandlerOptions
  ): Effect.Effect<
    DescribeVpcConnectionCommandOutput,
    | Cause.TimeoutError
    | SdkError
    | BadRequestError
    | ForbiddenError
    | InternalServerError
    | NotFoundError
    | ServiceUnavailableError
    | UnauthorizedError
  >

  /**
   * @see {@link GetBootstrapBrokersCommand}
   */
  getBootstrapBrokers(
    args: GetBootstrapBrokersCommandInput,
    options?: HttpHandlerOptions
  ): Effect.Effect<
    GetBootstrapBrokersCommandOutput,
    | Cause.TimeoutError
    | SdkError
    | BadRequestError
    | ConflictError
    | ForbiddenError
    | InternalServerError
    | UnauthorizedError
  >

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

  /**
   * @see {@link GetCompatibleKafkaVersionsCommand}
   */
  getCompatibleKafkaVersions(
    args: GetCompatibleKafkaVersionsCommandInput,
    options?: HttpHandlerOptions
  ): Effect.Effect<
    GetCompatibleKafkaVersionsCommandOutput,
    | Cause.TimeoutError
    | SdkError
    | BadRequestError
    | ForbiddenError
    | InternalServerError
    | NotFoundError
    | ServiceUnavailableError
    | TooManyRequestsError
    | UnauthorizedError
  >

  /**
   * @see {@link ListChannelsCommand}
   */
  listChannels(
    args: ListChannelsCommandInput,
    options?: HttpHandlerOptions
  ): Effect.Effect<
    ListChannelsCommandOutput,
    | Cause.TimeoutError
    | SdkError
    | BadRequestError
    | ForbiddenError
    | InternalServerError
    | NotFoundError
    | ServiceUnavailableError
    | TooManyRequestsError
    | UnauthorizedError
  >

  /**
   * @see {@link ListClientVpcConnectionsCommand}
   */
  listClientVpcConnections(
    args: ListClientVpcConnectionsCommandInput,
    options?: HttpHandlerOptions
  ): Effect.Effect<
    ListClientVpcConnectionsCommandOutput,
    | Cause.TimeoutError
    | SdkError
    | BadRequestError
    | ForbiddenError
    | InternalServerError
    | ServiceUnavailableError
    | UnauthorizedError
  >

  listClientVpcConnectionsStream(
    args: ListClientVpcConnectionsCommandInput,
    options?: HttpHandlerOptions
  ): Stream.Stream<
    ListClientVpcConnectionsCommandOutput,
    | Cause.TimeoutError
    | SdkError
    | BadRequestError
    | ForbiddenError
    | InternalServerError
    | ServiceUnavailableError
    | UnauthorizedError
  >

  /**
   * @see {@link ListClusterOperationsCommand}
   */
  listClusterOperations(
    args: ListClusterOperationsCommandInput,
    options?: HttpHandlerOptions
  ): Effect.Effect<
    ListClusterOperationsCommandOutput,
    Cause.TimeoutError | SdkError | BadRequestError | ForbiddenError | InternalServerError | UnauthorizedError
  >

  listClusterOperationsStream(
    args: ListClusterOperationsCommandInput,
    options?: HttpHandlerOptions
  ): Stream.Stream<
    ListClusterOperationsCommandOutput,
    Cause.TimeoutError | SdkError | BadRequestError | ForbiddenError | InternalServerError | UnauthorizedError
  >

  /**
   * @see {@link ListClusterOperationsV2Command}
   */
  listClusterOperationsV2(
    args: ListClusterOperationsV2CommandInput,
    options?: HttpHandlerOptions
  ): Effect.Effect<
    ListClusterOperationsV2CommandOutput,
    | Cause.TimeoutError
    | SdkError
    | BadRequestError
    | ForbiddenError
    | InternalServerError
    | NotFoundError
    | ServiceUnavailableError
    | TooManyRequestsError
    | UnauthorizedError
  >

  listClusterOperationsV2Stream(
    args: ListClusterOperationsV2CommandInput,
    options?: HttpHandlerOptions
  ): Stream.Stream<
    ListClusterOperationsV2CommandOutput,
    | Cause.TimeoutError
    | SdkError
    | BadRequestError
    | ForbiddenError
    | InternalServerError
    | NotFoundError
    | ServiceUnavailableError
    | TooManyRequestsError
    | UnauthorizedError
  >

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

  listClustersStream(
    args: ListClustersCommandInput,
    options?: HttpHandlerOptions
  ): Stream.Stream<
    ListClustersCommandOutput,
    Cause.TimeoutError | SdkError | BadRequestError | ForbiddenError | InternalServerError | UnauthorizedError
  >

  /**
   * @see {@link ListClustersV2Command}
   */
  listClustersV2(
    args: ListClustersV2CommandInput,
    options?: HttpHandlerOptions
  ): Effect.Effect<
    ListClustersV2CommandOutput,
    Cause.TimeoutError | SdkError | BadRequestError | ForbiddenError | InternalServerError | UnauthorizedError
  >

  listClustersV2Stream(
    args: ListClustersV2CommandInput,
    options?: HttpHandlerOptions
  ): Stream.Stream<
    ListClustersV2CommandOutput,
    Cause.TimeoutError | SdkError | BadRequestError | ForbiddenError | InternalServerError | UnauthorizedError
  >

  /**
   * @see {@link ListConfigurationRevisionsCommand}
   */
  listConfigurationRevisions(
    args: ListConfigurationRevisionsCommandInput,
    options?: HttpHandlerOptions
  ): Effect.Effect<
    ListConfigurationRevisionsCommandOutput,
    | Cause.TimeoutError
    | SdkError
    | BadRequestError
    | ForbiddenError
    | InternalServerError
    | NotFoundError
    | ServiceUnavailableError
    | UnauthorizedError
  >

  listConfigurationRevisionsStream(
    args: ListConfigurationRevisionsCommandInput,
    options?: HttpHandlerOptions
  ): Stream.Stream<
    ListConfigurationRevisionsCommandOutput,
    | Cause.TimeoutError
    | SdkError
    | BadRequestError
    | ForbiddenError
    | InternalServerError
    | NotFoundError
    | ServiceUnavailableError
    | UnauthorizedError
  >

  /**
   * @see {@link ListConfigurationsCommand}
   */
  listConfigurations(
    args: ListConfigurationsCommandInput,
    options?: HttpHandlerOptions
  ): Effect.Effect<
    ListConfigurationsCommandOutput,
    | Cause.TimeoutError
    | SdkError
    | BadRequestError
    | ForbiddenError
    | InternalServerError
    | ServiceUnavailableError
    | UnauthorizedError
  >

  listConfigurationsStream(
    args: ListConfigurationsCommandInput,
    options?: HttpHandlerOptions
  ): Stream.Stream<
    ListConfigurationsCommandOutput,
    | Cause.TimeoutError
    | SdkError
    | BadRequestError
    | ForbiddenError
    | InternalServerError
    | ServiceUnavailableError
    | UnauthorizedError
  >

  /**
   * @see {@link ListKafkaVersionsCommand}
   */
  listKafkaVersions(
    args: ListKafkaVersionsCommandInput,
    options?: HttpHandlerOptions
  ): Effect.Effect<
    ListKafkaVersionsCommandOutput,
    Cause.TimeoutError | SdkError | BadRequestError | ForbiddenError | InternalServerError | UnauthorizedError
  >

  listKafkaVersionsStream(
    args: ListKafkaVersionsCommandInput,
    options?: HttpHandlerOptions
  ): Stream.Stream<
    ListKafkaVersionsCommandOutput,
    Cause.TimeoutError | SdkError | BadRequestError | ForbiddenError | InternalServerError | UnauthorizedError
  >

  /**
   * @see {@link ListNodesCommand}
   */
  listNodes(
    args: ListNodesCommandInput,
    options?: HttpHandlerOptions
  ): Effect.Effect<
    ListNodesCommandOutput,
    Cause.TimeoutError | SdkError | BadRequestError | ForbiddenError | InternalServerError | NotFoundError
  >

  listNodesStream(
    args: ListNodesCommandInput,
    options?: HttpHandlerOptions
  ): Stream.Stream<
    ListNodesCommandOutput,
    Cause.TimeoutError | SdkError | BadRequestError | ForbiddenError | InternalServerError | NotFoundError
  >

  /**
   * @see {@link ListReplicatorsCommand}
   */
  listReplicators(
    args: ListReplicatorsCommandInput,
    options?: HttpHandlerOptions
  ): Effect.Effect<
    ListReplicatorsCommandOutput,
    | Cause.TimeoutError
    | SdkError
    | BadRequestError
    | ForbiddenError
    | InternalServerError
    | NotFoundError
    | ServiceUnavailableError
    | TooManyRequestsError
    | UnauthorizedError
  >

  listReplicatorsStream(
    args: ListReplicatorsCommandInput,
    options?: HttpHandlerOptions
  ): Stream.Stream<
    ListReplicatorsCommandOutput,
    | Cause.TimeoutError
    | SdkError
    | BadRequestError
    | ForbiddenError
    | InternalServerError
    | NotFoundError
    | ServiceUnavailableError
    | TooManyRequestsError
    | UnauthorizedError
  >

  /**
   * @see {@link ListScramSecretsCommand}
   */
  listScramSecrets(
    args: ListScramSecretsCommandInput,
    options?: HttpHandlerOptions
  ): Effect.Effect<
    ListScramSecretsCommandOutput,
    | Cause.TimeoutError
    | SdkError
    | BadRequestError
    | ForbiddenError
    | InternalServerError
    | NotFoundError
    | ServiceUnavailableError
    | TooManyRequestsError
    | UnauthorizedError
  >

  listScramSecretsStream(
    args: ListScramSecretsCommandInput,
    options?: HttpHandlerOptions
  ): Stream.Stream<
    ListScramSecretsCommandOutput,
    | 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 | InternalServerError | NotFoundError
  >

  /**
   * @see {@link ListTopicsCommand}
   */
  listTopics(
    args: ListTopicsCommandInput,
    options?: HttpHandlerOptions
  ): Effect.Effect<
    ListTopicsCommandOutput,
    | Cause.TimeoutError
    | SdkError
    | BadRequestError
    | ForbiddenError
    | InternalServerError
    | ServiceUnavailableError
    | UnauthorizedError
  >

  listTopicsStream(
    args: ListTopicsCommandInput,
    options?: HttpHandlerOptions
  ): Stream.Stream<
    ListTopicsCommandOutput,
    | Cause.TimeoutError
    | SdkError
    | BadRequestError
    | ForbiddenError
    | InternalServerError
    | ServiceUnavailableError
    | UnauthorizedError
  >

  /**
   * @see {@link ListVpcConnectionsCommand}
   */
  listVpcConnections(
    args: ListVpcConnectionsCommandInput,
    options?: HttpHandlerOptions
  ): Effect.Effect<
    ListVpcConnectionsCommandOutput,
    | Cause.TimeoutError
    | SdkError
    | BadRequestError
    | ForbiddenError
    | InternalServerError
    | ServiceUnavailableError
    | UnauthorizedError
  >

  listVpcConnectionsStream(
    args: ListVpcConnectionsCommandInput,
    options?: HttpHandlerOptions
  ): Stream.Stream<
    ListVpcConnectionsCommandOutput,
    | Cause.TimeoutError
    | SdkError
    | BadRequestError
    | ForbiddenError
    | InternalServerError
    | ServiceUnavailableError
    | UnauthorizedError
  >

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

  /**
   * @see {@link RebootBrokerCommand}
   */
  rebootBroker(
    args: RebootBrokerCommandInput,
    options?: HttpHandlerOptions
  ): Effect.Effect<
    RebootBrokerCommandOutput,
    | Cause.TimeoutError
    | SdkError
    | BadRequestError
    | ForbiddenError
    | InternalServerError
    | NotFoundError
    | ServiceUnavailableError
    | TooManyRequestsError
    | UnauthorizedError
  >

  /**
   * @see {@link RejectClientVpcConnectionCommand}
   */
  rejectClientVpcConnection(
    args: RejectClientVpcConnectionCommandInput,
    options?: HttpHandlerOptions
  ): Effect.Effect<
    RejectClientVpcConnectionCommandOutput,
    | Cause.TimeoutError
    | SdkError
    | BadRequestError
    | ForbiddenError
    | InternalServerError
    | ServiceUnavailableError
    | UnauthorizedError
  >

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

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

  /**
   * @see {@link UpdateBrokerCountCommand}
   */
  updateBrokerCount(
    args: UpdateBrokerCountCommandInput,
    options?: HttpHandlerOptions
  ): Effect.Effect<
    UpdateBrokerCountCommandOutput,
    | Cause.TimeoutError
    | SdkError
    | BadRequestError
    | ForbiddenError
    | InternalServerError
    | ServiceUnavailableError
    | UnauthorizedError
  >

  /**
   * @see {@link UpdateBrokerStorageCommand}
   */
  updateBrokerStorage(
    args: UpdateBrokerStorageCommandInput,
    options?: HttpHandlerOptions
  ): Effect.Effect<
    UpdateBrokerStorageCommandOutput,
    | Cause.TimeoutError
    | SdkError
    | BadRequestError
    | ForbiddenError
    | InternalServerError
    | ServiceUnavailableError
    | UnauthorizedError
  >

  /**
   * @see {@link UpdateBrokerTypeCommand}
   */
  updateBrokerType(
    args: UpdateBrokerTypeCommandInput,
    options?: HttpHandlerOptions
  ): Effect.Effect<
    UpdateBrokerTypeCommandOutput,
    | Cause.TimeoutError
    | SdkError
    | BadRequestError
    | ForbiddenError
    | InternalServerError
    | NotFoundError
    | ServiceUnavailableError
    | TooManyRequestsError
    | UnauthorizedError
  >

  /**
   * @see {@link UpdateChannelCommand}
   */
  updateChannel(
    args: UpdateChannelCommandInput,
    options?: HttpHandlerOptions
  ): Effect.Effect<
    UpdateChannelCommandOutput,
    | Cause.TimeoutError
    | SdkError
    | BadRequestError
    | ForbiddenError
    | InternalServerError
    | NotFoundError
    | ServiceUnavailableError
    | TooManyRequestsError
    | UnauthorizedError
  >

  /**
   * @see {@link UpdateClusterConfigurationCommand}
   */
  updateClusterConfiguration(
    args: UpdateClusterConfigurationCommandInput,
    options?: HttpHandlerOptions
  ): Effect.Effect<
    UpdateClusterConfigurationCommandOutput,
    | Cause.TimeoutError
    | SdkError
    | BadRequestError
    | ForbiddenError
    | InternalServerError
    | NotFoundError
    | ServiceUnavailableError
    | UnauthorizedError
  >

  /**
   * @see {@link UpdateClusterKafkaVersionCommand}
   */
  updateClusterKafkaVersion(
    args: UpdateClusterKafkaVersionCommandInput,
    options?: HttpHandlerOptions
  ): Effect.Effect<
    UpdateClusterKafkaVersionCommandOutput,
    | Cause.TimeoutError
    | SdkError
    | BadRequestError
    | ForbiddenError
    | InternalServerError
    | NotFoundError
    | ServiceUnavailableError
    | TooManyRequestsError
    | UnauthorizedError
  >

  /**
   * @see {@link UpdateConfigurationCommand}
   */
  updateConfiguration(
    args: UpdateConfigurationCommandInput,
    options?: HttpHandlerOptions
  ): Effect.Effect<
    UpdateConfigurationCommandOutput,
    | Cause.TimeoutError
    | SdkError
    | BadRequestError
    | ForbiddenError
    | InternalServerError
    | NotFoundError
    | ServiceUnavailableError
    | UnauthorizedError
  >

  /**
   * @see {@link UpdateConnectivityCommand}
   */
  updateConnectivity(
    args: UpdateConnectivityCommandInput,
    options?: HttpHandlerOptions
  ): Effect.Effect<
    UpdateConnectivityCommandOutput,
    | Cause.TimeoutError
    | SdkError
    | BadRequestError
    | ForbiddenError
    | InternalServerError
    | NotFoundError
    | ServiceUnavailableError
    | UnauthorizedError
  >

  /**
   * @see {@link UpdateMonitoringCommand}
   */
  updateMonitoring(
    args: UpdateMonitoringCommandInput,
    options?: HttpHandlerOptions
  ): Effect.Effect<
    UpdateMonitoringCommandOutput,
    | Cause.TimeoutError
    | SdkError
    | BadRequestError
    | ForbiddenError
    | InternalServerError
    | ServiceUnavailableError
    | UnauthorizedError
  >

  /**
   * @see {@link UpdateRebalancingCommand}
   */
  updateRebalancing(
    args: UpdateRebalancingCommandInput,
    options?: HttpHandlerOptions
  ): Effect.Effect<
    UpdateRebalancingCommandOutput,
    | Cause.TimeoutError
    | SdkError
    | BadRequestError
    | ForbiddenError
    | InternalServerError
    | NotFoundError
    | ServiceUnavailableError
    | TooManyRequestsError
    | UnauthorizedError
  >

  /**
   * @see {@link UpdateReplicationInfoCommand}
   */
  updateReplicationInfo(
    args: UpdateReplicationInfoCommandInput,
    options?: HttpHandlerOptions
  ): Effect.Effect<
    UpdateReplicationInfoCommandOutput,
    | Cause.TimeoutError
    | SdkError
    | BadRequestError
    | ForbiddenError
    | InternalServerError
    | NotFoundError
    | ServiceUnavailableError
    | TooManyRequestsError
    | UnauthorizedError
  >

  /**
   * @see {@link UpdateSecurityCommand}
   */
  updateSecurity(
    args: UpdateSecurityCommandInput,
    options?: HttpHandlerOptions
  ): Effect.Effect<
    UpdateSecurityCommandOutput,
    | Cause.TimeoutError
    | SdkError
    | BadRequestError
    | ForbiddenError
    | InternalServerError
    | NotFoundError
    | ServiceUnavailableError
    | TooManyRequestsError
    | UnauthorizedError
  >

  /**
   * @see {@link UpdateStorageCommand}
   */
  updateStorage(
    args: UpdateStorageCommandInput,
    options?: HttpHandlerOptions
  ): Effect.Effect<
    UpdateStorageCommandOutput,
    | Cause.TimeoutError
    | SdkError
    | BadRequestError
    | ForbiddenError
    | InternalServerError
    | NotFoundError
    | ServiceUnavailableError
    | TooManyRequestsError
    | UnauthorizedError
  >

  /**
   * @see {@link UpdateTopicCommand}
   */
  updateTopic(
    args: UpdateTopicCommandInput,
    options?: HttpHandlerOptions
  ): Effect.Effect<
    UpdateTopicCommandOutput,
    | Cause.TimeoutError
    | SdkError
    | BadRequestError
    | ClusterConnectivityError
    | ControllerMovedError
    | ForbiddenError
    | GroupSubscribedToTopicError
    | InternalServerError
    | KafkaRequestError
    | KafkaTimeoutError
    | NotControllerError
    | NotFoundError
    | ReassignmentInProgressError
    | ServiceUnavailableError
    | UnauthorizedError
    | UnknownTopicOrPartitionError
  >
}

Added in v1.0.0

utils

KafkaService (namespace)

Added in v1.0.0

Config (interface)

Signature

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

Added in v1.0.0

Type (type alias)

Signature

export type Type = KafkaService$

Added in v1.0.0