paws (version 0.1.12)

kinesis: Amazon Kinesis

Description

Amazon Kinesis Data Streams Service API Reference

Amazon Kinesis Data Streams is a managed service that scales elastically for real-time processing of streaming big data.

Usage

kinesis(config = list())

Value

A client for the service. You can call the service's operations using syntax like svc$operation(...), where svc is the name you've assigned to the client. The available operations are listed in the Operations section.

Arguments

config

Optional configuration of credentials, endpoint, and/or region.

Service syntax

svc <- kinesis(
  config = list(
    credentials = list(
      creds = list(
        access_key_id = "string",
        secret_access_key = "string",
        session_token = "string"
      ),
      profile = "string"
    ),
    endpoint = "string",
    region = "string"
  )
)

Operations

add_tags_to_stream	Adds or updates tags for the specified Kinesis data stream
create_stream	Creates a Kinesis data stream
decrease_stream_retention_period	Decreases the Kinesis data stream's retention period, which is the length of time data records are accessible after they are added to the stream
delete_stream	Deletes a Kinesis data stream and all its shards and data
deregister_stream_consumer	To deregister a consumer, provide its ARN
describe_limits	Describes the shard limits and usage for the account
describe_stream	Describes the specified Kinesis data stream
describe_stream_consumer	To get the description of a registered consumer, provide the ARN of the consumer
describe_stream_summary	Provides a summarized description of the specified Kinesis data stream without the shard list
disable_enhanced_monitoring	Disables enhanced monitoring
enable_enhanced_monitoring	Enables enhanced Kinesis data stream monitoring for shard-level metrics
get_records	Gets data records from a Kinesis data stream's shard
get_shard_iterator	Gets an Amazon Kinesis shard iterator
increase_stream_retention_period	Increases the Kinesis data stream's retention period, which is the length of time data records are accessible after they are added to the stream
list_shards	Lists the shards in a stream and provides information about each shard
list_stream_consumers	Lists the consumers registered to receive data from a stream using enhanced fan-out, and provides information about each consumer
list_streams	Lists your Kinesis data streams
list_tags_for_stream	Lists the tags for the specified Kinesis data stream
merge_shards	Merges two adjacent shards in a Kinesis data stream and combines them into a single shard to reduce the stream's capacity to ingest and transport data
put_record	Writes a single data record into an Amazon Kinesis data stream
put_records	Writes multiple data records into a Kinesis data stream in a single call (also referred to as a PutRecords request)
register_stream_consumer	Registers a consumer with a Kinesis data stream
remove_tags_from_stream	Removes tags from the specified Kinesis data stream
split_shard	Splits a shard into two new shards in the Kinesis data stream, to increase the stream's capacity to ingest and transport data
start_stream_encryption	Enables or updates server-side encryption using an AWS KMS key for a specified stream
stop_stream_encryption	Disables server-side encryption for a specified stream
update_shard_count	Updates the shard count of the specified stream to the specified number of shards

Examples

if (FALSE) {
svc <- kinesis()
svc$add_tags_to_stream(
  Foo = 123
)
}