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

KinesisService overview

Added in v1.0.0


Table of contents


constructors

makeKinesisService

Signature

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

Added in v1.0.0

models

KinesisService (class)

Signature

export declare class KinesisService

Added in v1.0.0

KinesisService$ (interface)

Signature

export interface KinesisService$ {
  /**
   * @see {@link AddTagsToStreamCommand}
   */
  addTagsToStream(
    args: AddTagsToStreamCommandInput,
    options?: HttpHandlerOptions
  ): Effect.Effect<
    AddTagsToStreamCommandOutput,
    | Cause.TimeoutError
    | SdkError
    | AccessDeniedError
    | InvalidArgumentError
    | LimitExceededError
    | ResourceInUseError
    | ResourceNotFoundError
  >

  /**
   * @see {@link CreateChannelCommand}
   */
  createChannel(
    args: CreateChannelCommandInput,
    options?: HttpHandlerOptions
  ): Effect.Effect<
    CreateChannelCommandOutput,
    | Cause.TimeoutError
    | SdkError
    | AccessDeniedError
    | InvalidArgumentError
    | KMSAccessDeniedError
    | KMSDisabledError
    | KMSInvalidStateError
    | KMSNotFoundError
    | KMSOptInRequiredError
    | KMSThrottlingError
    | LimitExceededError
    | ResourceInUseError
    | ResourceNotFoundError
    | ValidationError
  >

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

  /**
   * @see {@link DecreaseStreamRetentionPeriodCommand}
   */
  decreaseStreamRetentionPeriod(
    args: DecreaseStreamRetentionPeriodCommandInput,
    options?: HttpHandlerOptions
  ): Effect.Effect<
    DecreaseStreamRetentionPeriodCommandOutput,
    | Cause.TimeoutError
    | SdkError
    | AccessDeniedError
    | InvalidArgumentError
    | LimitExceededError
    | ResourceInUseError
    | ResourceNotFoundError
  >

  /**
   * @see {@link DeleteChannelCommand}
   */
  deleteChannel(
    args: DeleteChannelCommandInput,
    options?: HttpHandlerOptions
  ): Effect.Effect<
    DeleteChannelCommandOutput,
    | Cause.TimeoutError
    | SdkError
    | AccessDeniedError
    | InvalidArgumentError
    | LimitExceededError
    | ResourceNotFoundError
    | ValidationError
  >

  /**
   * @see {@link DeleteResourcePolicyCommand}
   */
  deleteResourcePolicy(
    args: DeleteResourcePolicyCommandInput,
    options?: HttpHandlerOptions
  ): Effect.Effect<
    DeleteResourcePolicyCommandOutput,
    | Cause.TimeoutError
    | SdkError
    | AccessDeniedError
    | InvalidArgumentError
    | LimitExceededError
    | ResourceInUseError
    | ResourceNotFoundError
  >

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

  /**
   * @see {@link DeregisterStreamConsumerCommand}
   */
  deregisterStreamConsumer(
    args: DeregisterStreamConsumerCommandInput,
    options?: HttpHandlerOptions
  ): Effect.Effect<
    DeregisterStreamConsumerCommandOutput,
    Cause.TimeoutError | SdkError | InvalidArgumentError | LimitExceededError | ResourceNotFoundError
  >

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

  /**
   * @see {@link DescribeChannelCommand}
   */
  describeChannel(
    args: DescribeChannelCommandInput,
    options?: HttpHandlerOptions
  ): Effect.Effect<
    DescribeChannelCommandOutput,
    | Cause.TimeoutError
    | SdkError
    | AccessDeniedError
    | InvalidArgumentError
    | LimitExceededError
    | ResourceNotFoundError
    | ValidationError
  >

  /**
   * @see {@link DescribeLimitsCommand}
   */
  describeLimits(
    args: DescribeLimitsCommandInput,
    options?: HttpHandlerOptions
  ): Effect.Effect<DescribeLimitsCommandOutput, Cause.TimeoutError | SdkError | LimitExceededError>

  /**
   * @see {@link DescribeStreamCommand}
   */
  describeStream(
    args: DescribeStreamCommandInput,
    options?: HttpHandlerOptions
  ): Effect.Effect<
    DescribeStreamCommandOutput,
    | Cause.TimeoutError
    | SdkError
    | AccessDeniedError
    | InvalidArgumentError
    | LimitExceededError
    | ResourceNotFoundError
  >

  /**
   * @see {@link DescribeStreamConsumerCommand}
   */
  describeStreamConsumer(
    args: DescribeStreamConsumerCommandInput,
    options?: HttpHandlerOptions
  ): Effect.Effect<
    DescribeStreamConsumerCommandOutput,
    Cause.TimeoutError | SdkError | InvalidArgumentError | LimitExceededError | ResourceNotFoundError
  >

  /**
   * @see {@link DescribeStreamSummaryCommand}
   */
  describeStreamSummary(
    args: DescribeStreamSummaryCommandInput,
    options?: HttpHandlerOptions
  ): Effect.Effect<
    DescribeStreamSummaryCommandOutput,
    | Cause.TimeoutError
    | SdkError
    | AccessDeniedError
    | InvalidArgumentError
    | LimitExceededError
    | ResourceNotFoundError
  >

  /**
   * @see {@link DisableEnhancedMonitoringCommand}
   */
  disableEnhancedMonitoring(
    args: DisableEnhancedMonitoringCommandInput,
    options?: HttpHandlerOptions
  ): Effect.Effect<
    DisableEnhancedMonitoringCommandOutput,
    | Cause.TimeoutError
    | SdkError
    | AccessDeniedError
    | InvalidArgumentError
    | LimitExceededError
    | ResourceInUseError
    | ResourceNotFoundError
  >

  /**
   * @see {@link EnableEnhancedMonitoringCommand}
   */
  enableEnhancedMonitoring(
    args: EnableEnhancedMonitoringCommandInput,
    options?: HttpHandlerOptions
  ): Effect.Effect<
    EnableEnhancedMonitoringCommandOutput,
    | Cause.TimeoutError
    | SdkError
    | AccessDeniedError
    | InvalidArgumentError
    | LimitExceededError
    | ResourceInUseError
    | ResourceNotFoundError
  >

  /**
   * @see {@link GetRecordsCommand}
   */
  getRecords(
    args: GetRecordsCommandInput,
    options?: HttpHandlerOptions
  ): Effect.Effect<
    GetRecordsCommandOutput,
    | Cause.TimeoutError
    | SdkError
    | AccessDeniedError
    | DryRunOperationError
    | ExpiredIteratorError
    | InternalFailureError
    | InvalidArgumentError
    | KMSAccessDeniedError
    | KMSDisabledError
    | KMSInvalidStateError
    | KMSNotFoundError
    | KMSOptInRequiredError
    | KMSThrottlingError
    | ProvisionedThroughputExceededError
    | ResourceNotFoundError
  >

  /**
   * @see {@link GetResourcePolicyCommand}
   */
  getResourcePolicy(
    args: GetResourcePolicyCommandInput,
    options?: HttpHandlerOptions
  ): Effect.Effect<
    GetResourcePolicyCommandOutput,
    | Cause.TimeoutError
    | SdkError
    | AccessDeniedError
    | InvalidArgumentError
    | LimitExceededError
    | ResourceInUseError
    | ResourceNotFoundError
  >

  /**
   * @see {@link GetShardIteratorCommand}
   */
  getShardIterator(
    args: GetShardIteratorCommandInput,
    options?: HttpHandlerOptions
  ): Effect.Effect<
    GetShardIteratorCommandOutput,
    | Cause.TimeoutError
    | SdkError
    | AccessDeniedError
    | DryRunOperationError
    | InternalFailureError
    | InvalidArgumentError
    | ProvisionedThroughputExceededError
    | ResourceNotFoundError
  >

  /**
   * @see {@link IncreaseStreamRetentionPeriodCommand}
   */
  increaseStreamRetentionPeriod(
    args: IncreaseStreamRetentionPeriodCommandInput,
    options?: HttpHandlerOptions
  ): Effect.Effect<
    IncreaseStreamRetentionPeriodCommandOutput,
    | Cause.TimeoutError
    | SdkError
    | AccessDeniedError
    | InvalidArgumentError
    | LimitExceededError
    | ResourceInUseError
    | ResourceNotFoundError
  >

  /**
   * @see {@link ListChannelsCommand}
   */
  listChannels(
    args: ListChannelsCommandInput,
    options?: HttpHandlerOptions
  ): Effect.Effect<
    ListChannelsCommandOutput,
    | Cause.TimeoutError
    | SdkError
    | AccessDeniedError
    | ExpiredNextTokenError
    | InvalidArgumentError
    | LimitExceededError
    | ValidationError
  >

  listChannelsStream(
    args: ListChannelsCommandInput,
    options?: HttpHandlerOptions
  ): Stream.Stream<
    ListChannelsCommandOutput,
    | Cause.TimeoutError
    | SdkError
    | AccessDeniedError
    | ExpiredNextTokenError
    | InvalidArgumentError
    | LimitExceededError
    | ValidationError
  >

  /**
   * @see {@link ListShardsCommand}
   */
  listShards(
    args: ListShardsCommandInput,
    options?: HttpHandlerOptions
  ): Effect.Effect<
    ListShardsCommandOutput,
    | Cause.TimeoutError
    | SdkError
    | AccessDeniedError
    | ExpiredNextTokenError
    | InvalidArgumentError
    | LimitExceededError
    | ResourceInUseError
    | ResourceNotFoundError
  >

  /**
   * @see {@link ListStreamConsumersCommand}
   */
  listStreamConsumers(
    args: ListStreamConsumersCommandInput,
    options?: HttpHandlerOptions
  ): Effect.Effect<
    ListStreamConsumersCommandOutput,
    | Cause.TimeoutError
    | SdkError
    | ExpiredNextTokenError
    | InvalidArgumentError
    | LimitExceededError
    | ResourceInUseError
    | ResourceNotFoundError
  >

  listStreamConsumersStream(
    args: ListStreamConsumersCommandInput,
    options?: HttpHandlerOptions
  ): Stream.Stream<
    ListStreamConsumersCommandOutput,
    | Cause.TimeoutError
    | SdkError
    | ExpiredNextTokenError
    | InvalidArgumentError
    | LimitExceededError
    | ResourceInUseError
    | ResourceNotFoundError
  >

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

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

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

  /**
   * @see {@link ListTagsForStreamCommand}
   */
  listTagsForStream(
    args: ListTagsForStreamCommandInput,
    options?: HttpHandlerOptions
  ): Effect.Effect<
    ListTagsForStreamCommandOutput,
    | Cause.TimeoutError
    | SdkError
    | AccessDeniedError
    | InvalidArgumentError
    | LimitExceededError
    | ResourceNotFoundError
  >

  /**
   * @see {@link MergeShardsCommand}
   */
  mergeShards(
    args: MergeShardsCommandInput,
    options?: HttpHandlerOptions
  ): Effect.Effect<
    MergeShardsCommandOutput,
    | Cause.TimeoutError
    | SdkError
    | AccessDeniedError
    | InvalidArgumentError
    | LimitExceededError
    | ResourceInUseError
    | ResourceNotFoundError
    | ValidationError
  >

  /**
   * @see {@link PutRecordCommand}
   */
  putRecord(
    args: PutRecordCommandInput,
    options?: HttpHandlerOptions
  ): Effect.Effect<
    PutRecordCommandOutput,
    | Cause.TimeoutError
    | SdkError
    | AccessDeniedError
    | DryRunOperationError
    | InternalFailureError
    | InvalidArgumentError
    | KMSAccessDeniedError
    | KMSDisabledError
    | KMSInvalidStateError
    | KMSNotFoundError
    | KMSOptInRequiredError
    | KMSThrottlingError
    | ProvisionedThroughputExceededError
    | ResourceNotFoundError
  >

  /**
   * @see {@link PutRecordsCommand}
   */
  putRecords(
    args: PutRecordsCommandInput,
    options?: HttpHandlerOptions
  ): Effect.Effect<
    PutRecordsCommandOutput,
    | Cause.TimeoutError
    | SdkError
    | AccessDeniedError
    | DryRunOperationError
    | InternalFailureError
    | InvalidArgumentError
    | KMSAccessDeniedError
    | KMSDisabledError
    | KMSInvalidStateError
    | KMSNotFoundError
    | KMSOptInRequiredError
    | KMSThrottlingError
    | ProvisionedThroughputExceededError
    | ResourceNotFoundError
  >

  /**
   * @see {@link PutResourcePolicyCommand}
   */
  putResourcePolicy(
    args: PutResourcePolicyCommandInput,
    options?: HttpHandlerOptions
  ): Effect.Effect<
    PutResourcePolicyCommandOutput,
    | Cause.TimeoutError
    | SdkError
    | AccessDeniedError
    | InvalidArgumentError
    | LimitExceededError
    | ResourceInUseError
    | ResourceNotFoundError
  >

  /**
   * @see {@link RegisterStreamConsumerCommand}
   */
  registerStreamConsumer(
    args: RegisterStreamConsumerCommandInput,
    options?: HttpHandlerOptions
  ): Effect.Effect<
    RegisterStreamConsumerCommandOutput,
    | Cause.TimeoutError
    | SdkError
    | InvalidArgumentError
    | LimitExceededError
    | ResourceInUseError
    | ResourceNotFoundError
  >

  /**
   * @see {@link RemoveTagsFromStreamCommand}
   */
  removeTagsFromStream(
    args: RemoveTagsFromStreamCommandInput,
    options?: HttpHandlerOptions
  ): Effect.Effect<
    RemoveTagsFromStreamCommandOutput,
    | Cause.TimeoutError
    | SdkError
    | AccessDeniedError
    | InvalidArgumentError
    | LimitExceededError
    | ResourceInUseError
    | ResourceNotFoundError
  >

  /**
   * @see {@link SplitShardCommand}
   */
  splitShard(
    args: SplitShardCommandInput,
    options?: HttpHandlerOptions
  ): Effect.Effect<
    SplitShardCommandOutput,
    | Cause.TimeoutError
    | SdkError
    | AccessDeniedError
    | InvalidArgumentError
    | LimitExceededError
    | ResourceInUseError
    | ResourceNotFoundError
    | ValidationError
  >

  /**
   * @see {@link StartStreamEncryptionCommand}
   */
  startStreamEncryption(
    args: StartStreamEncryptionCommandInput,
    options?: HttpHandlerOptions
  ): Effect.Effect<
    StartStreamEncryptionCommandOutput,
    | Cause.TimeoutError
    | SdkError
    | AccessDeniedError
    | InvalidArgumentError
    | KMSAccessDeniedError
    | KMSDisabledError
    | KMSInvalidStateError
    | KMSNotFoundError
    | KMSOptInRequiredError
    | KMSThrottlingError
    | LimitExceededError
    | ResourceInUseError
    | ResourceNotFoundError
  >

  /**
   * @see {@link StopStreamEncryptionCommand}
   */
  stopStreamEncryption(
    args: StopStreamEncryptionCommandInput,
    options?: HttpHandlerOptions
  ): Effect.Effect<
    StopStreamEncryptionCommandOutput,
    | Cause.TimeoutError
    | SdkError
    | AccessDeniedError
    | InvalidArgumentError
    | LimitExceededError
    | ResourceInUseError
    | ResourceNotFoundError
  >

  /**
   * @see {@link SubscribeToShardCommand}
   */
  subscribeToShard(
    args: SubscribeToShardCommandInput,
    options?: HttpHandlerOptions
  ): Effect.Effect<
    SubscribeToShardCommandOutput,
    | Cause.TimeoutError
    | SdkError
    | AccessDeniedError
    | DryRunOperationError
    | InvalidArgumentError
    | LimitExceededError
    | ResourceInUseError
    | ResourceNotFoundError
  >

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

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

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

  /**
   * @see {@link UpdateChannelCommand}
   */
  updateChannel(
    args: UpdateChannelCommandInput,
    options?: HttpHandlerOptions
  ): Effect.Effect<
    UpdateChannelCommandOutput,
    | Cause.TimeoutError
    | SdkError
    | AccessDeniedError
    | InvalidArgumentError
    | LimitExceededError
    | ResourceInUseError
    | ResourceNotFoundError
    | ValidationError
  >

  /**
   * @see {@link UpdateMaxRecordSizeCommand}
   */
  updateMaxRecordSize(
    args: UpdateMaxRecordSizeCommandInput,
    options?: HttpHandlerOptions
  ): Effect.Effect<
    UpdateMaxRecordSizeCommandOutput,
    | Cause.TimeoutError
    | SdkError
    | AccessDeniedError
    | InvalidArgumentError
    | LimitExceededError
    | ResourceInUseError
    | ResourceNotFoundError
    | ValidationError
  >

  /**
   * @see {@link UpdateShardCountCommand}
   */
  updateShardCount(
    args: UpdateShardCountCommandInput,
    options?: HttpHandlerOptions
  ): Effect.Effect<
    UpdateShardCountCommandOutput,
    | Cause.TimeoutError
    | SdkError
    | AccessDeniedError
    | InvalidArgumentError
    | LimitExceededError
    | ResourceInUseError
    | ResourceNotFoundError
    | ValidationError
  >

  /**
   * @see {@link UpdateStreamModeCommand}
   */
  updateStreamMode(
    args: UpdateStreamModeCommandInput,
    options?: HttpHandlerOptions
  ): Effect.Effect<
    UpdateStreamModeCommandOutput,
    | Cause.TimeoutError
    | SdkError
    | InvalidArgumentError
    | LimitExceededError
    | ResourceInUseError
    | ResourceNotFoundError
    | ValidationError
  >

  /**
   * @see {@link UpdateStreamRecordDistributionStrategyCommand}
   */
  updateStreamRecordDistributionStrategy(
    args: UpdateStreamRecordDistributionStrategyCommandInput,
    options?: HttpHandlerOptions
  ): Effect.Effect<
    UpdateStreamRecordDistributionStrategyCommandOutput,
    | Cause.TimeoutError
    | SdkError
    | AccessDeniedError
    | InvalidArgumentError
    | LimitExceededError
    | ResourceInUseError
    | ResourceNotFoundError
    | ValidationError
  >

  /**
   * @see {@link UpdateStreamWarmThroughputCommand}
   */
  updateStreamWarmThroughput(
    args: UpdateStreamWarmThroughputCommandInput,
    options?: HttpHandlerOptions
  ): Effect.Effect<
    UpdateStreamWarmThroughputCommandOutput,
    | Cause.TimeoutError
    | SdkError
    | AccessDeniedError
    | InvalidArgumentError
    | LimitExceededError
    | ResourceInUseError
    | ResourceNotFoundError
    | ValidationError
  >
}

Added in v1.0.0

utils

KinesisService (namespace)

Added in v1.0.0

Config (interface)

Signature

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

Added in v1.0.0

Type (type alias)

Signature

export type Type = KinesisService$

Added in v1.0.0