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

FirehoseService overview

Added in v1.0.0


Table of contents


constructors

makeFirehoseService

Signature

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

Added in v1.0.0

models

FirehoseService (class)

Signature

export declare class FirehoseService

Added in v1.0.0

FirehoseService$ (interface)

Signature

export interface FirehoseService$ {
  /**
   * @see {@link CreateDeliveryStreamCommand}
   */
  createDeliveryStream(
    args: CreateDeliveryStreamCommandInput,
    options?: HttpHandlerOptions
  ): Effect.Effect<
    CreateDeliveryStreamCommandOutput,
    | Cause.TimeoutError
    | SdkError
    | InvalidArgumentError
    | InvalidKMSResourceError
    | LimitExceededError
    | ResourceInUseError
  >

  /**
   * @see {@link DeleteDeliveryStreamCommand}
   */
  deleteDeliveryStream(
    args: DeleteDeliveryStreamCommandInput,
    options?: HttpHandlerOptions
  ): Effect.Effect<
    DeleteDeliveryStreamCommandOutput,
    Cause.TimeoutError | SdkError | ResourceInUseError | ResourceNotFoundError
  >

  /**
   * @see {@link DescribeDeliveryStreamCommand}
   */
  describeDeliveryStream(
    args: DescribeDeliveryStreamCommandInput,
    options?: HttpHandlerOptions
  ): Effect.Effect<DescribeDeliveryStreamCommandOutput, Cause.TimeoutError | SdkError | ResourceNotFoundError>

  /**
   * @see {@link ListDeliveryStreamsCommand}
   */
  listDeliveryStreams(
    args: ListDeliveryStreamsCommandInput,
    options?: HttpHandlerOptions
  ): Effect.Effect<ListDeliveryStreamsCommandOutput, Cause.TimeoutError | SdkError>

  /**
   * @see {@link ListTagsForDeliveryStreamCommand}
   */
  listTagsForDeliveryStream(
    args: ListTagsForDeliveryStreamCommandInput,
    options?: HttpHandlerOptions
  ): Effect.Effect<
    ListTagsForDeliveryStreamCommandOutput,
    Cause.TimeoutError | SdkError | InvalidArgumentError | LimitExceededError | ResourceNotFoundError
  >

  /**
   * @see {@link PutRecordCommand}
   */
  putRecord(
    args: PutRecordCommandInput,
    options?: HttpHandlerOptions
  ): Effect.Effect<
    PutRecordCommandOutput,
    | Cause.TimeoutError
    | SdkError
    | InvalidArgumentError
    | InvalidKMSResourceError
    | InvalidSourceError
    | ResourceNotFoundError
    | ServiceUnavailableError
  >

  /**
   * @see {@link PutRecordBatchCommand}
   */
  putRecordBatch(
    args: PutRecordBatchCommandInput,
    options?: HttpHandlerOptions
  ): Effect.Effect<
    PutRecordBatchCommandOutput,
    | Cause.TimeoutError
    | SdkError
    | InvalidArgumentError
    | InvalidKMSResourceError
    | InvalidSourceError
    | ResourceNotFoundError
    | ServiceUnavailableError
  >

  /**
   * @see {@link StartDeliveryStreamEncryptionCommand}
   */
  startDeliveryStreamEncryption(
    args: StartDeliveryStreamEncryptionCommandInput,
    options?: HttpHandlerOptions
  ): Effect.Effect<
    StartDeliveryStreamEncryptionCommandOutput,
    | Cause.TimeoutError
    | SdkError
    | InvalidArgumentError
    | InvalidKMSResourceError
    | LimitExceededError
    | ResourceInUseError
    | ResourceNotFoundError
  >

  /**
   * @see {@link StopDeliveryStreamEncryptionCommand}
   */
  stopDeliveryStreamEncryption(
    args: StopDeliveryStreamEncryptionCommandInput,
    options?: HttpHandlerOptions
  ): Effect.Effect<
    StopDeliveryStreamEncryptionCommandOutput,
    | Cause.TimeoutError
    | SdkError
    | InvalidArgumentError
    | LimitExceededError
    | ResourceInUseError
    | ResourceNotFoundError
  >

  /**
   * @see {@link TagDeliveryStreamCommand}
   */
  tagDeliveryStream(
    args: TagDeliveryStreamCommandInput,
    options?: HttpHandlerOptions
  ): Effect.Effect<
    TagDeliveryStreamCommandOutput,
    | Cause.TimeoutError
    | SdkError
    | InvalidArgumentError
    | LimitExceededError
    | ResourceInUseError
    | ResourceNotFoundError
  >

  /**
   * @see {@link UntagDeliveryStreamCommand}
   */
  untagDeliveryStream(
    args: UntagDeliveryStreamCommandInput,
    options?: HttpHandlerOptions
  ): Effect.Effect<
    UntagDeliveryStreamCommandOutput,
    | Cause.TimeoutError
    | SdkError
    | InvalidArgumentError
    | LimitExceededError
    | ResourceInUseError
    | ResourceNotFoundError
  >

  /**
   * @see {@link UpdateDestinationCommand}
   */
  updateDestination(
    args: UpdateDestinationCommandInput,
    options?: HttpHandlerOptions
  ): Effect.Effect<
    UpdateDestinationCommandOutput,
    | Cause.TimeoutError
    | SdkError
    | ConcurrentModificationError
    | InvalidArgumentError
    | ResourceInUseError
    | ResourceNotFoundError
  >
}

Added in v1.0.0

utils

FirehoseService (namespace)

Added in v1.0.0

Config (interface)

Signature

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

Added in v1.0.0

Type (type alias)

Signature

export type Type = FirehoseService$

Added in v1.0.0