firehose/aws.sdk.kotlin.services.firehose

Package-level declarations

Types

Amazon Data Firehose is a fully managed service that delivers real-time streaming data to destinations such as Amazon Simple Storage Service (Amazon S3), Amazon OpenSearch Service, Amazon Redshift, Splunk, and various other supportd destinations.

Properties

SdkVersion

const val SdkVersion: String

ServiceApiVersion

const val ServiceApiVersion: String

ServiceId

const val ServiceId: String

Functions

createDeliveryStream

inline suspend fun FirehoseClient.createDeliveryStream(crossinline block: CreateDeliveryStreamRequest.Builder.() -> Unit): CreateDeliveryStreamResponse

Creates a Firehose delivery stream.

deleteDeliveryStream

inline suspend fun FirehoseClient.deleteDeliveryStream(crossinline block: DeleteDeliveryStreamRequest.Builder.() -> Unit): DeleteDeliveryStreamResponse

Deletes a delivery stream and its data.

describeDeliveryStream

inline suspend fun FirehoseClient.describeDeliveryStream(crossinline block: DescribeDeliveryStreamRequest.Builder.() -> Unit): DescribeDeliveryStreamResponse

Describes the specified delivery stream and its status. For example, after your delivery stream is created, call DescribeDeliveryStream to see whether the delivery stream is ACTIVE and therefore ready for data to be sent to it.

listDeliveryStreams

inline suspend fun FirehoseClient.listDeliveryStreams(crossinline block: ListDeliveryStreamsRequest.Builder.() -> Unit): ListDeliveryStreamsResponse

Lists your delivery streams in alphabetical order of their names.

listTagsForDeliveryStream

inline suspend fun FirehoseClient.listTagsForDeliveryStream(crossinline block: ListTagsForDeliveryStreamRequest.Builder.() -> Unit): ListTagsForDeliveryStreamResponse

Lists the tags for the specified delivery stream. This operation has a limit of five transactions per second per account.

putRecord

inline suspend fun FirehoseClient.putRecord(crossinline block: PutRecordRequest.Builder.() -> Unit): PutRecordResponse

Writes a single data record into an Amazon Firehose delivery stream. To write multiple data records into a delivery stream, use PutRecordBatch. Applications using these operations are referred to as producers.

putRecordBatch

inline suspend fun FirehoseClient.putRecordBatch(crossinline block: PutRecordBatchRequest.Builder.() -> Unit): PutRecordBatchResponse

Writes multiple data records into a delivery stream in a single call, which can achieve higher throughput per producer than when writing single records. To write single data records into a delivery stream, use PutRecord. Applications using these operations are referred to as producers.

startDeliveryStreamEncryption

inline suspend fun FirehoseClient.startDeliveryStreamEncryption(crossinline block: StartDeliveryStreamEncryptionRequest.Builder.() -> Unit): StartDeliveryStreamEncryptionResponse

Enables server-side encryption (SSE) for the delivery stream.

stopDeliveryStreamEncryption

inline suspend fun FirehoseClient.stopDeliveryStreamEncryption(crossinline block: StopDeliveryStreamEncryptionRequest.Builder.() -> Unit): StopDeliveryStreamEncryptionResponse

Disables server-side encryption (SSE) for the delivery stream.

tagDeliveryStream

inline suspend fun FirehoseClient.tagDeliveryStream(crossinline block: TagDeliveryStreamRequest.Builder.() -> Unit): TagDeliveryStreamResponse

Adds or updates tags for the specified delivery stream. A tag is a key-value pair that you can define and assign to Amazon Web Services resources. If you specify a tag that already exists, the tag value is replaced with the value that you specify in the request. Tags are metadata. For example, you can add friendly names and descriptions or other types of information that can help you distinguish the delivery stream. For more information about tags, see Using Cost Allocation Tags in the Amazon Web Services Billing and Cost Management User Guide.

untagDeliveryStream

inline suspend fun FirehoseClient.untagDeliveryStream(crossinline block: UntagDeliveryStreamRequest.Builder.() -> Unit): UntagDeliveryStreamResponse

Removes tags from the specified delivery stream. Removed tags are deleted, and you can't recover them after this operation successfully completes.

updateDestination

inline suspend fun FirehoseClient.updateDestination(crossinline block: UpdateDestinationRequest.Builder.() -> Unit): UpdateDestinationResponse

Updates the specified destination of the specified delivery stream.

withConfig

fun FirehoseClient.withConfig(block: FirehoseClient.Config.Builder.() -> Unit): FirehoseClient

Create a copy of the client with one or more configuration values overridden. This method allows the caller to perform scoped config overrides for one or more client operations.