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
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.
client = boto3.client("kinesis")
try:
do_something(client)
except (
client.AccessDeniedException,
client.ClientError,
client.ExpiredIteratorException,
client.ExpiredNextTokenException,
client.InternalFailureException,
client.InvalidArgumentException,
client.KMSAccessDeniedException,
client.KMSDisabledException,
client.KMSInvalidStateException,
client.KMSNotFoundException,
client.KMSOptInRequired,
client.KMSThrottlingException,
client.LimitExceededException,
client.ProvisionedThroughputExceededException,
client.ResourceInUseException,
client.ResourceNotFoundException,
client.ValidationException,
) as e:
print(e)
from mypy_boto3_kinesis.client import Exceptions
def handle_error(exc: Exceptions.AccessDeniedException) -> None:
...
Methods
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
def add_tags_to_stream(
self,
*,
Tags: Mapping[str, str],
StreamName: str = ...,
StreamARN: str = ...,
) -> EmptyResponseMetadataTypeDef: # (1)
...
kwargs: AddTagsToStreamInputRequestTypeDef = { # (1)
"Tags": ...,
}
parent.add_tags_to_stream(**kwargs)
can_paginate
Check if an operation can be paginated.
Type annotations and code completion for boto3.client("kinesis").can_paginate
method.
boto3 documentation
close
Closes underlying endpoint connections.
Type annotations and code completion for boto3.client("kinesis").close
method.
boto3 documentation
create_stream
Creates a Kinesis data stream.
Type annotations and code completion for boto3.client("kinesis").create_stream
method.
boto3 documentation
def create_stream(
self,
*,
StreamName: str,
ShardCount: int = ...,
StreamModeDetails: StreamModeDetailsTypeDef = ..., # (1)
) -> EmptyResponseMetadataTypeDef: # (2)
...
kwargs: CreateStreamInputRequestTypeDef = { # (1)
"StreamName": ...,
}
parent.create_stream(**kwargs)
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
def decrease_stream_retention_period(
self,
*,
RetentionPeriodHours: int,
StreamName: str = ...,
StreamARN: str = ...,
) -> EmptyResponseMetadataTypeDef: # (1)
...
kwargs: DecreaseStreamRetentionPeriodInputRequestTypeDef = { # (1)
"RetentionPeriodHours": ...,
}
parent.decrease_stream_retention_period(**kwargs)
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
def delete_stream(
self,
*,
StreamName: str = ...,
EnforceConsumerDeletion: bool = ...,
StreamARN: str = ...,
) -> EmptyResponseMetadataTypeDef: # (1)
...
kwargs: DeleteStreamInputRequestTypeDef = { # (1)
"StreamName": ...,
}
parent.delete_stream(**kwargs)
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
def deregister_stream_consumer(
self,
*,
StreamARN: str = ...,
ConsumerName: str = ...,
ConsumerARN: str = ...,
) -> EmptyResponseMetadataTypeDef: # (1)
...
kwargs: DeregisterStreamConsumerInputRequestTypeDef = { # (1)
"StreamARN": ...,
}
parent.deregister_stream_consumer(**kwargs)
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_stream
Describes the specified Kinesis data stream.
Type annotations and code completion for boto3.client("kinesis").describe_stream
method.
boto3 documentation
def describe_stream(
self,
*,
StreamName: str = ...,
Limit: int = ...,
ExclusiveStartShardId: str = ...,
StreamARN: str = ...,
) -> DescribeStreamOutputTypeDef: # (1)
...
kwargs: DescribeStreamInputRequestTypeDef = { # (1)
"StreamName": ...,
}
parent.describe_stream(**kwargs)
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
def describe_stream_consumer(
self,
*,
StreamARN: str = ...,
ConsumerName: str = ...,
ConsumerARN: str = ...,
) -> DescribeStreamConsumerOutputTypeDef: # (1)
...
kwargs: DescribeStreamConsumerInputRequestTypeDef = { # (1)
"StreamARN": ...,
}
parent.describe_stream_consumer(**kwargs)
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
def describe_stream_summary(
self,
*,
StreamName: str = ...,
StreamARN: str = ...,
) -> DescribeStreamSummaryOutputTypeDef: # (1)
...
kwargs: DescribeStreamSummaryInputRequestTypeDef = { # (1)
"StreamName": ...,
}
parent.describe_stream_summary(**kwargs)
disable_enhanced_monitoring
Disables enhanced monitoring.
Type annotations and code completion for boto3.client("kinesis").disable_enhanced_monitoring
method.
boto3 documentation
def disable_enhanced_monitoring(
self,
*,
ShardLevelMetrics: Sequence[MetricsNameType], # (1)
StreamName: str = ...,
StreamARN: str = ...,
) -> EnhancedMonitoringOutputTypeDef: # (2)
...
kwargs: DisableEnhancedMonitoringInputRequestTypeDef = { # (1)
"ShardLevelMetrics": ...,
}
parent.disable_enhanced_monitoring(**kwargs)
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
def enable_enhanced_monitoring(
self,
*,
ShardLevelMetrics: Sequence[MetricsNameType], # (1)
StreamName: str = ...,
StreamARN: str = ...,
) -> EnhancedMonitoringOutputTypeDef: # (2)
...
kwargs: EnableEnhancedMonitoringInputRequestTypeDef = { # (1)
"ShardLevelMetrics": ...,
}
parent.enable_enhanced_monitoring(**kwargs)
generate_presigned_url
Generate a presigned url given a client, its method, and arguments.
Type annotations and code completion for boto3.client("kinesis").generate_presigned_url
method.
boto3 documentation
def generate_presigned_url(
self,
ClientMethod: str,
Params: Mapping[str, Any] = ...,
ExpiresIn: int = 3600,
HttpMethod: str = ...,
) -> str:
...
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
def get_records(
self,
*,
ShardIterator: str,
Limit: int = ...,
StreamARN: str = ...,
) -> GetRecordsOutputTypeDef: # (1)
...
kwargs: GetRecordsInputRequestTypeDef = { # (1)
"ShardIterator": ...,
}
parent.get_records(**kwargs)
get_shard_iterator
Gets an Amazon Kinesis shard iterator.
Type annotations and code completion for boto3.client("kinesis").get_shard_iterator
method.
boto3 documentation
def get_shard_iterator(
self,
*,
ShardId: str,
ShardIteratorType: ShardIteratorTypeType, # (1)
StreamName: str = ...,
StartingSequenceNumber: str = ...,
Timestamp: Union[datetime, str] = ...,
StreamARN: str = ...,
) -> GetShardIteratorOutputTypeDef: # (2)
...
kwargs: GetShardIteratorInputRequestTypeDef = { # (1)
"ShardId": ...,
"ShardIteratorType": ...,
}
parent.get_shard_iterator(**kwargs)
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
def increase_stream_retention_period(
self,
*,
RetentionPeriodHours: int,
StreamName: str = ...,
StreamARN: str = ...,
) -> EmptyResponseMetadataTypeDef: # (1)
...
kwargs: IncreaseStreamRetentionPeriodInputRequestTypeDef = { # (1)
"RetentionPeriodHours": ...,
}
parent.increase_stream_retention_period(**kwargs)
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
def list_shards(
self,
*,
StreamName: str = ...,
NextToken: str = ...,
ExclusiveStartShardId: str = ...,
MaxResults: int = ...,
StreamCreationTimestamp: Union[datetime, str] = ...,
ShardFilter: ShardFilterTypeDef = ..., # (1)
StreamARN: str = ...,
) -> ListShardsOutputTypeDef: # (2)
...
kwargs: ListShardsInputRequestTypeDef = { # (1)
"StreamName": ...,
}
parent.list_shards(**kwargs)
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
def list_stream_consumers(
self,
*,
StreamARN: str,
NextToken: str = ...,
MaxResults: int = ...,
StreamCreationTimestamp: Union[datetime, str] = ...,
) -> ListStreamConsumersOutputTypeDef: # (1)
...
kwargs: ListStreamConsumersInputRequestTypeDef = { # (1)
"StreamARN": ...,
}
parent.list_stream_consumers(**kwargs)
list_streams
Lists your Kinesis data streams.
Type annotations and code completion for boto3.client("kinesis").list_streams
method.
boto3 documentation
def list_streams(
self,
*,
Limit: int = ...,
ExclusiveStartStreamName: str = ...,
NextToken: str = ...,
) -> ListStreamsOutputTypeDef: # (1)
...
kwargs: ListStreamsInputRequestTypeDef = { # (1)
"Limit": ...,
}
parent.list_streams(**kwargs)
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
def list_tags_for_stream(
self,
*,
StreamName: str = ...,
ExclusiveStartTagKey: str = ...,
Limit: int = ...,
StreamARN: str = ...,
) -> ListTagsForStreamOutputTypeDef: # (1)
...
kwargs: ListTagsForStreamInputRequestTypeDef = { # (1)
"StreamName": ...,
}
parent.list_tags_for_stream(**kwargs)
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
def merge_shards(
self,
*,
ShardToMerge: str,
AdjacentShardToMerge: str,
StreamName: str = ...,
StreamARN: str = ...,
) -> EmptyResponseMetadataTypeDef: # (1)
...
kwargs: MergeShardsInputRequestTypeDef = { # (1)
"ShardToMerge": ...,
"AdjacentShardToMerge": ...,
}
parent.merge_shards(**kwargs)
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
def put_record(
self,
*,
Data: Union[str, bytes, IO[Any], StreamingBody],
PartitionKey: str,
StreamName: str = ...,
ExplicitHashKey: str = ...,
SequenceNumberForOrdering: str = ...,
StreamARN: str = ...,
) -> PutRecordOutputTypeDef: # (1)
...
kwargs: PutRecordInputRequestTypeDef = { # (1)
"Data": ...,
"PartitionKey": ...,
}
parent.put_record(**kwargs)
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
def put_records(
self,
*,
Records: Sequence[PutRecordsRequestEntryTypeDef], # (1)
StreamName: str = ...,
StreamARN: str = ...,
) -> PutRecordsOutputTypeDef: # (2)
...
kwargs: PutRecordsInputRequestTypeDef = { # (1)
"Records": ...,
}
parent.put_records(**kwargs)
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
def register_stream_consumer(
self,
*,
StreamARN: str,
ConsumerName: str,
) -> RegisterStreamConsumerOutputTypeDef: # (1)
...
kwargs: RegisterStreamConsumerInputRequestTypeDef = { # (1)
"StreamARN": ...,
"ConsumerName": ...,
}
parent.register_stream_consumer(**kwargs)
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
def remove_tags_from_stream(
self,
*,
TagKeys: Sequence[str],
StreamName: str = ...,
StreamARN: str = ...,
) -> EmptyResponseMetadataTypeDef: # (1)
...
kwargs: RemoveTagsFromStreamInputRequestTypeDef = { # (1)
"TagKeys": ...,
}
parent.remove_tags_from_stream(**kwargs)
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
def split_shard(
self,
*,
ShardToSplit: str,
NewStartingHashKey: str,
StreamName: str = ...,
StreamARN: str = ...,
) -> EmptyResponseMetadataTypeDef: # (1)
...
kwargs: SplitShardInputRequestTypeDef = { # (1)
"ShardToSplit": ...,
"NewStartingHashKey": ...,
}
parent.split_shard(**kwargs)
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
def start_stream_encryption(
self,
*,
EncryptionType: EncryptionTypeType, # (1)
KeyId: str,
StreamName: str = ...,
StreamARN: str = ...,
) -> EmptyResponseMetadataTypeDef: # (2)
...
kwargs: StartStreamEncryptionInputRequestTypeDef = { # (1)
"EncryptionType": ...,
"KeyId": ...,
}
parent.start_stream_encryption(**kwargs)
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
def stop_stream_encryption(
self,
*,
EncryptionType: EncryptionTypeType, # (1)
KeyId: str,
StreamName: str = ...,
StreamARN: str = ...,
) -> EmptyResponseMetadataTypeDef: # (2)
...
kwargs: StopStreamEncryptionInputRequestTypeDef = { # (1)
"EncryptionType": ...,
"KeyId": ...,
}
parent.stop_stream_encryption(**kwargs)
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
def subscribe_to_shard(
self,
*,
ConsumerARN: str,
ShardId: str,
StartingPosition: StartingPositionTypeDef, # (1)
) -> SubscribeToShardOutputTypeDef: # (2)
...
kwargs: SubscribeToShardInputRequestTypeDef = { # (1)
"ConsumerARN": ...,
"ShardId": ...,
"StartingPosition": ...,
}
parent.subscribe_to_shard(**kwargs)
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
def update_shard_count(
self,
*,
TargetShardCount: int,
ScalingType: ScalingTypeType, # (1)
StreamName: str = ...,
StreamARN: str = ...,
) -> UpdateShardCountOutputTypeDef: # (2)
...
kwargs: UpdateShardCountInputRequestTypeDef = { # (1)
"TargetShardCount": ...,
"ScalingType": ...,
}
parent.update_shard_count(**kwargs)
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
def update_stream_mode(
self,
*,
StreamARN: str,
StreamModeDetails: StreamModeDetailsTypeDef, # (1)
) -> EmptyResponseMetadataTypeDef: # (2)
...
kwargs: UpdateStreamModeInputRequestTypeDef = { # (1)
"StreamARN": ...,
"StreamModeDetails": ...,
}
parent.update_stream_mode(**kwargs)
get_paginator
Type annotations and code completion for boto3.client("kinesis").get_paginator
method with overloads.
client.get_paginator("describe_stream")
-> DescribeStreamPaginatorclient.get_paginator("list_shards")
-> ListShardsPaginatorclient.get_paginator("list_stream_consumers")
-> ListStreamConsumersPaginatorclient.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")
-> StreamExistsWaiterclient.get_waiter("stream_not_exists")
-> StreamNotExistsWaiter