KinesisClient

Index > Kinesis > KinesisClient

Auto-generated documentation for Kinesis type annotations stubs module mypy-boto3-kinesis.

KinesisClient

Type annotations and code completion for boto3.client("kinesis"). boto3 documentation

# KinesisClient usage example

from boto3.session import Session
from mypy_boto3_kinesis.client import KinesisClient

def get_kinesis_client() -> KinesisClient:
    return Session().client("kinesis")

Exceptions

boto3 client exceptions are generated in runtime. This class provides code completion for boto3.client("kinesis").exceptions structure.

# Exceptions.exceptions usage example

client = boto3.client("kinesis")

try:
    do_something(client)
except (
    client.exceptions.AccessDeniedException,
    client.exceptions.ClientError,
    client.exceptions.ExpiredIteratorException,
    client.exceptions.ExpiredNextTokenException,
    client.exceptions.InternalFailureException,
    client.exceptions.InvalidArgumentException,
    client.exceptions.KMSAccessDeniedException,
    client.exceptions.KMSDisabledException,
    client.exceptions.KMSInvalidStateException,
    client.exceptions.KMSNotFoundException,
    client.exceptions.KMSOptInRequired,
    client.exceptions.KMSThrottlingException,
    client.exceptions.LimitExceededException,
    client.exceptions.ProvisionedThroughputExceededException,
    client.exceptions.ResourceInUseException,
    client.exceptions.ResourceNotFoundException,
    client.exceptions.ValidationException,
) as e:
    print(e)

# Exceptions.exceptions type checking example

from mypy_boto3_kinesis.client import Exceptions

def handle_error(exc: Exceptions.AccessDeniedException) -> None:
    ...

Methods

can_paginate

Type annotations and code completion for boto3.client("kinesis").can_paginate method. boto3 documentation

# can_paginate method definition

def can_paginate(
    self,
    operation_name: str,
) -> bool:
    ...

generate_presigned_url

Type annotations and code completion for boto3.client("kinesis").generate_presigned_url method. boto3 documentation

# generate_presigned_url method definition

def generate_presigned_url(
    self,
    ClientMethod: str,
    Params: Mapping[str, Any] = ...,
    ExpiresIn: int = 3600,
    HttpMethod: str = ...,
) -> str:
    ...

add_tags_to_stream

Adds or updates tags for the specified Kinesis data stream.

Type annotations and code completion for boto3.client("kinesis").add_tags_to_stream method. boto3 documentation

# add_tags_to_stream method definition

def add_tags_to_stream(
    self,
    *,
    Tags: Mapping[str, str],
    StreamName: str = ...,
    StreamARN: str = ...,
) -> EmptyResponseMetadataTypeDef:  # (1)
    ...

1. See EmptyResponseMetadataTypeDef

# add_tags_to_stream method usage example with argument unpacking

kwargs: AddTagsToStreamInputRequestTypeDef = {  # (1)
    "Tags": ...,
}

parent.add_tags_to_stream(**kwargs)

1. See AddTagsToStreamInputRequestTypeDef

create_stream

Creates a Kinesis data stream.

Type annotations and code completion for boto3.client("kinesis").create_stream method. boto3 documentation

# create_stream method definition

def create_stream(
    self,
    *,
    StreamName: str,
    ShardCount: int = ...,
    StreamModeDetails: StreamModeDetailsTypeDef = ...,  # (1)
    Tags: Mapping[str, str] = ...,
) -> EmptyResponseMetadataTypeDef:  # (2)
    ...

1. See StreamModeDetailsTypeDef
2. See EmptyResponseMetadataTypeDef

# create_stream method usage example with argument unpacking

kwargs: CreateStreamInputRequestTypeDef = {  # (1)
    "StreamName": ...,
}

parent.create_stream(**kwargs)

1. See CreateStreamInputRequestTypeDef

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.

Type annotations and code completion for boto3.client("kinesis").decrease_stream_retention_period method. boto3 documentation

# decrease_stream_retention_period method definition

def decrease_stream_retention_period(
    self,
    *,
    RetentionPeriodHours: int,
    StreamName: str = ...,
    StreamARN: str = ...,
) -> EmptyResponseMetadataTypeDef:  # (1)
    ...

1. See EmptyResponseMetadataTypeDef

# decrease_stream_retention_period method usage example with argument unpacking

kwargs: DecreaseStreamRetentionPeriodInputRequestTypeDef = {  # (1)
    "RetentionPeriodHours": ...,
}

parent.decrease_stream_retention_period(**kwargs)

1. See DecreaseStreamRetentionPeriodInputRequestTypeDef

delete_resource_policy

Delete a policy for the specified data stream or consumer.

Type annotations and code completion for boto3.client("kinesis").delete_resource_policy method. boto3 documentation

# delete_resource_policy method definition

def delete_resource_policy(
    self,
    *,
    ResourceARN: str,
) -> EmptyResponseMetadataTypeDef:  # (1)
    ...

1. See EmptyResponseMetadataTypeDef

# delete_resource_policy method usage example with argument unpacking

kwargs: DeleteResourcePolicyInputRequestTypeDef = {  # (1)
    "ResourceARN": ...,
}

parent.delete_resource_policy(**kwargs)

1. See DeleteResourcePolicyInputRequestTypeDef

delete_stream

Deletes a Kinesis data stream and all its shards and data.

Type annotations and code completion for boto3.client("kinesis").delete_stream method. boto3 documentation

# delete_stream method definition

def delete_stream(
    self,
    *,
    StreamName: str = ...,
    EnforceConsumerDeletion: bool = ...,
    StreamARN: str = ...,
) -> EmptyResponseMetadataTypeDef:  # (1)
    ...

1. See EmptyResponseMetadataTypeDef

# delete_stream method usage example with argument unpacking

kwargs: DeleteStreamInputRequestTypeDef = {  # (1)
    "StreamName": ...,
}

parent.delete_stream(**kwargs)

1. See DeleteStreamInputRequestTypeDef

deregister_stream_consumer

To deregister a consumer, provide its ARN.

Type annotations and code completion for boto3.client("kinesis").deregister_stream_consumer method. boto3 documentation

# deregister_stream_consumer method definition

def deregister_stream_consumer(
    self,
    *,
    StreamARN: str = ...,
    ConsumerName: str = ...,
    ConsumerARN: str = ...,
) -> EmptyResponseMetadataTypeDef:  # (1)
    ...

1. See EmptyResponseMetadataTypeDef

# deregister_stream_consumer method usage example with argument unpacking

kwargs: DeregisterStreamConsumerInputRequestTypeDef = {  # (1)
    "StreamARN": ...,
}

parent.deregister_stream_consumer(**kwargs)

1. See DeregisterStreamConsumerInputRequestTypeDef

describe_limits

Describes the shard limits and usage for the account.

Type annotations and code completion for boto3.client("kinesis").describe_limits method. boto3 documentation

# describe_limits method definition

def describe_limits(
    self,
) -> DescribeLimitsOutputTypeDef:  # (1)
    ...

1. See DescribeLimitsOutputTypeDef

describe_stream

Describes the specified Kinesis data stream.

Type annotations and code completion for boto3.client("kinesis").describe_stream method. boto3 documentation

# describe_stream method definition

def describe_stream(
    self,
    *,
    StreamName: str = ...,
    Limit: int = ...,
    ExclusiveStartShardId: str = ...,
    StreamARN: str = ...,
) -> DescribeStreamOutputTypeDef:  # (1)
    ...

1. See DescribeStreamOutputTypeDef

# describe_stream method usage example with argument unpacking

kwargs: DescribeStreamInputRequestTypeDef = {  # (1)
    "StreamName": ...,
}

parent.describe_stream(**kwargs)

1. See DescribeStreamInputRequestTypeDef

describe_stream_consumer

To get the description of a registered consumer, provide the ARN of the consumer.

Type annotations and code completion for boto3.client("kinesis").describe_stream_consumer method. boto3 documentation

# describe_stream_consumer method definition

def describe_stream_consumer(
    self,
    *,
    StreamARN: str = ...,
    ConsumerName: str = ...,
    ConsumerARN: str = ...,
) -> DescribeStreamConsumerOutputTypeDef:  # (1)
    ...

1. See DescribeStreamConsumerOutputTypeDef

# describe_stream_consumer method usage example with argument unpacking

kwargs: DescribeStreamConsumerInputRequestTypeDef = {  # (1)
    "StreamARN": ...,
}

parent.describe_stream_consumer(**kwargs)

1. See DescribeStreamConsumerInputRequestTypeDef

describe_stream_summary

Provides a summarized description of the specified Kinesis data stream without the shard list.

Type annotations and code completion for boto3.client("kinesis").describe_stream_summary method. boto3 documentation

# describe_stream_summary method definition

def describe_stream_summary(
    self,
    *,
    StreamName: str = ...,
    StreamARN: str = ...,
) -> DescribeStreamSummaryOutputTypeDef:  # (1)
    ...

1. See DescribeStreamSummaryOutputTypeDef

# describe_stream_summary method usage example with argument unpacking

kwargs: DescribeStreamSummaryInputRequestTypeDef = {  # (1)
    "StreamName": ...,
}

parent.describe_stream_summary(**kwargs)

1. See DescribeStreamSummaryInputRequestTypeDef

disable_enhanced_monitoring

Disables enhanced monitoring.

Type annotations and code completion for boto3.client("kinesis").disable_enhanced_monitoring method. boto3 documentation

# disable_enhanced_monitoring method definition

def disable_enhanced_monitoring(
    self,
    *,
    ShardLevelMetrics: Sequence[MetricsNameType],  # (1)
    StreamName: str = ...,
    StreamARN: str = ...,
) -> EnhancedMonitoringOutputTypeDef:  # (2)
    ...

1. See MetricsNameType
2. See EnhancedMonitoringOutputTypeDef

# disable_enhanced_monitoring method usage example with argument unpacking

kwargs: DisableEnhancedMonitoringInputRequestTypeDef = {  # (1)
    "ShardLevelMetrics": ...,
}

parent.disable_enhanced_monitoring(**kwargs)

1. See DisableEnhancedMonitoringInputRequestTypeDef

enable_enhanced_monitoring

Enables enhanced Kinesis data stream monitoring for shard-level metrics.

Type annotations and code completion for boto3.client("kinesis").enable_enhanced_monitoring method. boto3 documentation

# enable_enhanced_monitoring method definition

def enable_enhanced_monitoring(
    self,
    *,
    ShardLevelMetrics: Sequence[MetricsNameType],  # (1)
    StreamName: str = ...,
    StreamARN: str = ...,
) -> EnhancedMonitoringOutputTypeDef:  # (2)
    ...

1. See MetricsNameType
2. See EnhancedMonitoringOutputTypeDef

# enable_enhanced_monitoring method usage example with argument unpacking

kwargs: EnableEnhancedMonitoringInputRequestTypeDef = {  # (1)
    "ShardLevelMetrics": ...,
}

parent.enable_enhanced_monitoring(**kwargs)

1. See EnableEnhancedMonitoringInputRequestTypeDef

get_records

Gets data records from a Kinesis data stream's shard.

Type annotations and code completion for boto3.client("kinesis").get_records method. boto3 documentation

# get_records method definition

def get_records(
    self,
    *,
    ShardIterator: str,
    Limit: int = ...,
    StreamARN: str = ...,
) -> GetRecordsOutputTypeDef:  # (1)
    ...

1. See GetRecordsOutputTypeDef

# get_records method usage example with argument unpacking

kwargs: GetRecordsInputRequestTypeDef = {  # (1)
    "ShardIterator": ...,
}

parent.get_records(**kwargs)

1. See GetRecordsInputRequestTypeDef

get_resource_policy

Returns a policy attached to the specified data stream or consumer.

Type annotations and code completion for boto3.client("kinesis").get_resource_policy method. boto3 documentation

# get_resource_policy method definition

def get_resource_policy(
    self,
    *,
    ResourceARN: str,
) -> GetResourcePolicyOutputTypeDef:  # (1)
    ...

1. See GetResourcePolicyOutputTypeDef

# get_resource_policy method usage example with argument unpacking

kwargs: GetResourcePolicyInputRequestTypeDef = {  # (1)
    "ResourceARN": ...,
}

parent.get_resource_policy(**kwargs)

1. See GetResourcePolicyInputRequestTypeDef

get_shard_iterator

Gets an Amazon Kinesis shard iterator.

Type annotations and code completion for boto3.client("kinesis").get_shard_iterator method. boto3 documentation

# get_shard_iterator method definition

def get_shard_iterator(
    self,
    *,
    ShardId: str,
    ShardIteratorType: ShardIteratorTypeType,  # (1)
    StreamName: str = ...,
    StartingSequenceNumber: str = ...,
    Timestamp: TimestampTypeDef = ...,
    StreamARN: str = ...,
) -> GetShardIteratorOutputTypeDef:  # (2)
    ...

1. See ShardIteratorTypeType
2. See GetShardIteratorOutputTypeDef

# get_shard_iterator method usage example with argument unpacking

kwargs: GetShardIteratorInputRequestTypeDef = {  # (1)
    "ShardId": ...,
    "ShardIteratorType": ...,
}

parent.get_shard_iterator(**kwargs)

1. See GetShardIteratorInputRequestTypeDef

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.

Type annotations and code completion for boto3.client("kinesis").increase_stream_retention_period method. boto3 documentation

# increase_stream_retention_period method definition

def increase_stream_retention_period(
    self,
    *,
    RetentionPeriodHours: int,
    StreamName: str = ...,
    StreamARN: str = ...,
) -> EmptyResponseMetadataTypeDef:  # (1)
    ...

1. See EmptyResponseMetadataTypeDef

# increase_stream_retention_period method usage example with argument unpacking

kwargs: IncreaseStreamRetentionPeriodInputRequestTypeDef = {  # (1)
    "RetentionPeriodHours": ...,
}

parent.increase_stream_retention_period(**kwargs)

1. See IncreaseStreamRetentionPeriodInputRequestTypeDef

list_shards

Lists the shards in a stream and provides information about each shard.

Type annotations and code completion for boto3.client("kinesis").list_shards method. boto3 documentation

# list_shards method definition

def list_shards(
    self,
    *,
    StreamName: str = ...,
    NextToken: str = ...,
    ExclusiveStartShardId: str = ...,
    MaxResults: int = ...,
    StreamCreationTimestamp: TimestampTypeDef = ...,
    ShardFilter: ShardFilterTypeDef = ...,  # (1)
    StreamARN: str = ...,
) -> ListShardsOutputTypeDef:  # (2)
    ...

1. See ShardFilterTypeDef
2. See ListShardsOutputTypeDef

# list_shards method usage example with argument unpacking

kwargs: ListShardsInputRequestTypeDef = {  # (1)
    "StreamName": ...,
}

parent.list_shards(**kwargs)

1. See ListShardsInputRequestTypeDef

list_stream_consumers

Lists the consumers registered to receive data from a stream using enhanced fan-out, and provides information about each consumer.

Type annotations and code completion for boto3.client("kinesis").list_stream_consumers method. boto3 documentation

# list_stream_consumers method definition

def list_stream_consumers(
    self,
    *,
    StreamARN: str,
    NextToken: str = ...,
    MaxResults: int = ...,
    StreamCreationTimestamp: TimestampTypeDef = ...,
) -> ListStreamConsumersOutputTypeDef:  # (1)
    ...

1. See ListStreamConsumersOutputTypeDef

# list_stream_consumers method usage example with argument unpacking

kwargs: ListStreamConsumersInputRequestTypeDef = {  # (1)
    "StreamARN": ...,
}

parent.list_stream_consumers(**kwargs)

1. See ListStreamConsumersInputRequestTypeDef

list_streams

Lists your Kinesis data streams.

Type annotations and code completion for boto3.client("kinesis").list_streams method. boto3 documentation

# list_streams method definition

def list_streams(
    self,
    *,
    Limit: int = ...,
    ExclusiveStartStreamName: str = ...,
    NextToken: str = ...,
) -> ListStreamsOutputTypeDef:  # (1)
    ...

1. See ListStreamsOutputTypeDef

# list_streams method usage example with argument unpacking

kwargs: ListStreamsInputRequestTypeDef = {  # (1)
    "Limit": ...,
}

parent.list_streams(**kwargs)

1. See ListStreamsInputRequestTypeDef

list_tags_for_stream

Lists the tags for the specified Kinesis data stream.

Type annotations and code completion for boto3.client("kinesis").list_tags_for_stream method. boto3 documentation

# list_tags_for_stream method definition

def list_tags_for_stream(
    self,
    *,
    StreamName: str = ...,
    ExclusiveStartTagKey: str = ...,
    Limit: int = ...,
    StreamARN: str = ...,
) -> ListTagsForStreamOutputTypeDef:  # (1)
    ...

1. See ListTagsForStreamOutputTypeDef

# list_tags_for_stream method usage example with argument unpacking

kwargs: ListTagsForStreamInputRequestTypeDef = {  # (1)
    "StreamName": ...,
}

parent.list_tags_for_stream(**kwargs)

1. See ListTagsForStreamInputRequestTypeDef

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.

Type annotations and code completion for boto3.client("kinesis").merge_shards method. boto3 documentation

# merge_shards method definition

def merge_shards(
    self,
    *,
    ShardToMerge: str,
    AdjacentShardToMerge: str,
    StreamName: str = ...,
    StreamARN: str = ...,
) -> EmptyResponseMetadataTypeDef:  # (1)
    ...

1. See EmptyResponseMetadataTypeDef

# merge_shards method usage example with argument unpacking

kwargs: MergeShardsInputRequestTypeDef = {  # (1)
    "ShardToMerge": ...,
    "AdjacentShardToMerge": ...,
}

parent.merge_shards(**kwargs)

1. See MergeShardsInputRequestTypeDef

put_record

Writes a single data record into an Amazon Kinesis data stream.

Type annotations and code completion for boto3.client("kinesis").put_record method. boto3 documentation

# put_record method definition

def put_record(
    self,
    *,
    Data: BlobTypeDef,
    PartitionKey: str,
    StreamName: str = ...,
    ExplicitHashKey: str = ...,
    SequenceNumberForOrdering: str = ...,
    StreamARN: str = ...,
) -> PutRecordOutputTypeDef:  # (1)
    ...

1. See PutRecordOutputTypeDef

# put_record method usage example with argument unpacking

kwargs: PutRecordInputRequestTypeDef = {  # (1)
    "Data": ...,
    "PartitionKey": ...,
}

parent.put_record(**kwargs)

1. See PutRecordInputRequestTypeDef

put_records

Writes multiple data records into a Kinesis data stream in a single call (also referred to as a PutRecords request).

Type annotations and code completion for boto3.client("kinesis").put_records method. boto3 documentation

# put_records method definition

def put_records(
    self,
    *,
    Records: Sequence[PutRecordsRequestEntryTypeDef],  # (1)
    StreamName: str = ...,
    StreamARN: str = ...,
) -> PutRecordsOutputTypeDef:  # (2)
    ...

1. See PutRecordsRequestEntryTypeDef
2. See PutRecordsOutputTypeDef

# put_records method usage example with argument unpacking

kwargs: PutRecordsInputRequestTypeDef = {  # (1)
    "Records": ...,
}

parent.put_records(**kwargs)

1. See PutRecordsInputRequestTypeDef

put_resource_policy

Attaches a resource-based policy to a data stream or registered consumer.

Type annotations and code completion for boto3.client("kinesis").put_resource_policy method. boto3 documentation

# put_resource_policy method definition

def put_resource_policy(
    self,
    *,
    ResourceARN: str,
    Policy: str,
) -> EmptyResponseMetadataTypeDef:  # (1)
    ...

1. See EmptyResponseMetadataTypeDef

# put_resource_policy method usage example with argument unpacking

kwargs: PutResourcePolicyInputRequestTypeDef = {  # (1)
    "ResourceARN": ...,
    "Policy": ...,
}

parent.put_resource_policy(**kwargs)

1. See PutResourcePolicyInputRequestTypeDef

register_stream_consumer

Registers a consumer with a Kinesis data stream.

Type annotations and code completion for boto3.client("kinesis").register_stream_consumer method. boto3 documentation

# register_stream_consumer method definition

def register_stream_consumer(
    self,
    *,
    StreamARN: str,
    ConsumerName: str,
) -> RegisterStreamConsumerOutputTypeDef:  # (1)
    ...

1. See RegisterStreamConsumerOutputTypeDef

# register_stream_consumer method usage example with argument unpacking

kwargs: RegisterStreamConsumerInputRequestTypeDef = {  # (1)
    "StreamARN": ...,
    "ConsumerName": ...,
}

parent.register_stream_consumer(**kwargs)

1. See RegisterStreamConsumerInputRequestTypeDef

remove_tags_from_stream

Removes tags from the specified Kinesis data stream.

Type annotations and code completion for boto3.client("kinesis").remove_tags_from_stream method. boto3 documentation

# remove_tags_from_stream method definition

def remove_tags_from_stream(
    self,
    *,
    TagKeys: Sequence[str],
    StreamName: str = ...,
    StreamARN: str = ...,
) -> EmptyResponseMetadataTypeDef:  # (1)
    ...

1. See EmptyResponseMetadataTypeDef

# remove_tags_from_stream method usage example with argument unpacking

kwargs: RemoveTagsFromStreamInputRequestTypeDef = {  # (1)
    "TagKeys": ...,
}

parent.remove_tags_from_stream(**kwargs)

1. See RemoveTagsFromStreamInputRequestTypeDef

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.

Type annotations and code completion for boto3.client("kinesis").split_shard method. boto3 documentation

# split_shard method definition

def split_shard(
    self,
    *,
    ShardToSplit: str,
    NewStartingHashKey: str,
    StreamName: str = ...,
    StreamARN: str = ...,
) -> EmptyResponseMetadataTypeDef:  # (1)
    ...

1. See EmptyResponseMetadataTypeDef

# split_shard method usage example with argument unpacking

kwargs: SplitShardInputRequestTypeDef = {  # (1)
    "ShardToSplit": ...,
    "NewStartingHashKey": ...,
}

parent.split_shard(**kwargs)

1. See SplitShardInputRequestTypeDef

start_stream_encryption

Enables or updates server-side encryption using an Amazon Web Services KMS key for a specified stream.

Type annotations and code completion for boto3.client("kinesis").start_stream_encryption method. boto3 documentation

# start_stream_encryption method definition

def start_stream_encryption(
    self,
    *,
    EncryptionType: EncryptionTypeType,  # (1)
    KeyId: str,
    StreamName: str = ...,
    StreamARN: str = ...,
) -> EmptyResponseMetadataTypeDef:  # (2)
    ...

1. See EncryptionTypeType
2. See EmptyResponseMetadataTypeDef

# start_stream_encryption method usage example with argument unpacking

kwargs: StartStreamEncryptionInputRequestTypeDef = {  # (1)
    "EncryptionType": ...,
    "KeyId": ...,
}

parent.start_stream_encryption(**kwargs)

1. See StartStreamEncryptionInputRequestTypeDef

stop_stream_encryption

Disables server-side encryption for a specified stream.

Type annotations and code completion for boto3.client("kinesis").stop_stream_encryption method. boto3 documentation

# stop_stream_encryption method definition

def stop_stream_encryption(
    self,
    *,
    EncryptionType: EncryptionTypeType,  # (1)
    KeyId: str,
    StreamName: str = ...,
    StreamARN: str = ...,
) -> EmptyResponseMetadataTypeDef:  # (2)
    ...

1. See EncryptionTypeType
2. See EmptyResponseMetadataTypeDef

# stop_stream_encryption method usage example with argument unpacking

kwargs: StopStreamEncryptionInputRequestTypeDef = {  # (1)
    "EncryptionType": ...,
    "KeyId": ...,
}

parent.stop_stream_encryption(**kwargs)

1. See StopStreamEncryptionInputRequestTypeDef

subscribe_to_shard

This operation establishes an HTTP/2 connection between the consumer you specify in the ConsumerARN parameter and the shard you specify in the ShardId parameter.

Type annotations and code completion for boto3.client("kinesis").subscribe_to_shard method. boto3 documentation

# subscribe_to_shard method definition

def subscribe_to_shard(
    self,
    *,
    ConsumerARN: str,
    ShardId: str,
    StartingPosition: StartingPositionTypeDef,  # (1)
) -> SubscribeToShardOutputTypeDef:  # (2)
    ...

1. See StartingPositionTypeDef
2. See SubscribeToShardOutputTypeDef

# subscribe_to_shard method usage example with argument unpacking

kwargs: SubscribeToShardInputRequestTypeDef = {  # (1)
    "ConsumerARN": ...,
    "ShardId": ...,
    "StartingPosition": ...,
}

parent.subscribe_to_shard(**kwargs)

1. See SubscribeToShardInputRequestTypeDef

update_shard_count

Updates the shard count of the specified stream to the specified number of shards.

Type annotations and code completion for boto3.client("kinesis").update_shard_count method. boto3 documentation

# update_shard_count method definition

def update_shard_count(
    self,
    *,
    TargetShardCount: int,
    ScalingType: ScalingTypeType,  # (1)
    StreamName: str = ...,
    StreamARN: str = ...,
) -> UpdateShardCountOutputTypeDef:  # (2)
    ...

1. See ScalingTypeType
2. See UpdateShardCountOutputTypeDef

# update_shard_count method usage example with argument unpacking

kwargs: UpdateShardCountInputRequestTypeDef = {  # (1)
    "TargetShardCount": ...,
    "ScalingType": ...,
}

parent.update_shard_count(**kwargs)

1. See UpdateShardCountInputRequestTypeDef

update_stream_mode

Updates the capacity mode of the data stream.

Type annotations and code completion for boto3.client("kinesis").update_stream_mode method. boto3 documentation

# update_stream_mode method definition

def update_stream_mode(
    self,
    *,
    StreamARN: str,
    StreamModeDetails: StreamModeDetailsTypeDef,  # (1)
) -> EmptyResponseMetadataTypeDef:  # (2)
    ...

1. See StreamModeDetailsTypeDef
2. See EmptyResponseMetadataTypeDef

# update_stream_mode method usage example with argument unpacking

kwargs: UpdateStreamModeInputRequestTypeDef = {  # (1)
    "StreamARN": ...,
    "StreamModeDetails": ...,
}

parent.update_stream_mode(**kwargs)

1. See UpdateStreamModeInputRequestTypeDef

get_paginator

Type annotations and code completion for boto3.client("kinesis").get_paginator method with overloads.

• client.get_paginator("describe_stream") -> DescribeStreamPaginator
• client.get_paginator("list_shards") -> ListShardsPaginator
• client.get_paginator("list_stream_consumers") -> ListStreamConsumersPaginator
• client.get_paginator("list_streams") -> ListStreamsPaginator

get_waiter

Type annotations and code completion for boto3.client("kinesis").get_waiter method with overloads.

• client.get_waiter("stream_exists") -> StreamExistsWaiter
• client.get_waiter("stream_not_exists") -> StreamNotExistsWaiter