KinesisClient#
Auto-generated documentation for Kinesis type annotations stubs module types-aiobotocore-kinesis.
KinesisClient#
Type annotations and code completion for session.client("kinesis")
boto3 documentation
# KinesisClient usage example
from aioboto3.session import Session
from types_aiobotocore_kinesis.client import KinesisClient
session = Session()
async with session.client("kinesis") as client:
client: KinesisClient
Exceptions#
aioboto3
client exceptions are generated in runtime.
This class provides code completion for session.client("kinesis").exceptions
structure.
# KinesisClient.exceptions usage example
async with session.client("kinesis") as client:
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)
# KinesisClient.exceptions type checking example
from types_aiobotocore_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 session.client("kinesis").add_tags_to_stream
method.
boto3 documentation
# add_tags_to_stream method definition
await def add_tags_to_stream(
self,
*,
Tags: Mapping[str, str],
StreamName: str = ...,
StreamARN: str = ...,
) -> EmptyResponseMetadataTypeDef: # (1)
...
# add_tags_to_stream method usage example with argument unpacking
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 session.client("kinesis").can_paginate
method.
boto3 documentation
# can_paginate method definition
def can_paginate(
self,
operation_name: str,
) -> bool:
...
close#
Closes underlying endpoint connections.
Type annotations and code completion for session.client("kinesis").close
method.
boto3 documentation
# close method definition
await def close(
self,
) -> None:
...
create_stream#
Creates a Kinesis data stream.
Type annotations and code completion for session.client("kinesis").create_stream
method.
boto3 documentation
# create_stream method definition
await def create_stream(
self,
*,
StreamName: str,
ShardCount: int = ...,
StreamModeDetails: StreamModeDetailsTypeDef = ..., # (1)
) -> EmptyResponseMetadataTypeDef: # (2)
...
# create_stream method usage example with argument unpacking
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 session.client("kinesis").decrease_stream_retention_period
method.
boto3 documentation
# decrease_stream_retention_period method definition
await def decrease_stream_retention_period(
self,
*,
RetentionPeriodHours: int,
StreamName: str = ...,
StreamARN: str = ...,
) -> EmptyResponseMetadataTypeDef: # (1)
...
# decrease_stream_retention_period method usage example with argument unpacking
kwargs: DecreaseStreamRetentionPeriodInputRequestTypeDef = { # (1)
"RetentionPeriodHours": ...,
}
parent.decrease_stream_retention_period(**kwargs)
delete_resource_policy#
Delete a policy for the specified data stream or consumer.
Type annotations and code completion for session.client("kinesis").delete_resource_policy
method.
boto3 documentation
# delete_resource_policy method definition
await def delete_resource_policy(
self,
*,
ResourceARN: str,
) -> EmptyResponseMetadataTypeDef: # (1)
...
# delete_resource_policy method usage example with argument unpacking
kwargs: DeleteResourcePolicyInputRequestTypeDef = { # (1)
"ResourceARN": ...,
}
parent.delete_resource_policy(**kwargs)
delete_stream#
Deletes a Kinesis data stream and all its shards and data.
Type annotations and code completion for session.client("kinesis").delete_stream
method.
boto3 documentation
# delete_stream method definition
await def delete_stream(
self,
*,
StreamName: str = ...,
EnforceConsumerDeletion: bool = ...,
StreamARN: str = ...,
) -> EmptyResponseMetadataTypeDef: # (1)
...
# delete_stream method usage example with argument unpacking
kwargs: DeleteStreamInputRequestTypeDef = { # (1)
"StreamName": ...,
}
parent.delete_stream(**kwargs)
deregister_stream_consumer#
To deregister a consumer, provide its ARN.
Type annotations and code completion for session.client("kinesis").deregister_stream_consumer
method.
boto3 documentation
# deregister_stream_consumer method definition
await def deregister_stream_consumer(
self,
*,
StreamARN: str = ...,
ConsumerName: str = ...,
ConsumerARN: str = ...,
) -> EmptyResponseMetadataTypeDef: # (1)
...
# deregister_stream_consumer method usage example with argument unpacking
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 session.client("kinesis").describe_limits
method.
boto3 documentation
# describe_limits method definition
await def describe_limits(
self,
) -> DescribeLimitsOutputTypeDef: # (1)
...
describe_stream#
Describes the specified Kinesis data stream.
Type annotations and code completion for session.client("kinesis").describe_stream
method.
boto3 documentation
# describe_stream method definition
await def describe_stream(
self,
*,
StreamName: str = ...,
Limit: int = ...,
ExclusiveStartShardId: str = ...,
StreamARN: str = ...,
) -> DescribeStreamOutputTypeDef: # (1)
...
# describe_stream method usage example with argument unpacking
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 session.client("kinesis").describe_stream_consumer
method.
boto3 documentation
# describe_stream_consumer method definition
await def describe_stream_consumer(
self,
*,
StreamARN: str = ...,
ConsumerName: str = ...,
ConsumerARN: str = ...,
) -> DescribeStreamConsumerOutputTypeDef: # (1)
...
# describe_stream_consumer method usage example with argument unpacking
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 session.client("kinesis").describe_stream_summary
method.
boto3 documentation
# describe_stream_summary method definition
await def describe_stream_summary(
self,
*,
StreamName: str = ...,
StreamARN: str = ...,
) -> DescribeStreamSummaryOutputTypeDef: # (1)
...
# describe_stream_summary method usage example with argument unpacking
kwargs: DescribeStreamSummaryInputRequestTypeDef = { # (1)
"StreamName": ...,
}
parent.describe_stream_summary(**kwargs)
disable_enhanced_monitoring#
Disables enhanced monitoring.
Type annotations and code completion for session.client("kinesis").disable_enhanced_monitoring
method.
boto3 documentation
# disable_enhanced_monitoring method definition
await def disable_enhanced_monitoring(
self,
*,
ShardLevelMetrics: Sequence[MetricsNameType], # (1)
StreamName: str = ...,
StreamARN: str = ...,
) -> EnhancedMonitoringOutputTypeDef: # (2)
...
# disable_enhanced_monitoring method usage example with argument unpacking
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 session.client("kinesis").enable_enhanced_monitoring
method.
boto3 documentation
# enable_enhanced_monitoring method definition
await def enable_enhanced_monitoring(
self,
*,
ShardLevelMetrics: Sequence[MetricsNameType], # (1)
StreamName: str = ...,
StreamARN: str = ...,
) -> EnhancedMonitoringOutputTypeDef: # (2)
...
# enable_enhanced_monitoring method usage example with argument unpacking
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 session.client("kinesis").generate_presigned_url
method.
boto3 documentation
# generate_presigned_url method definition
await 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 session.client("kinesis").get_records
method.
boto3 documentation
# get_records method definition
await def get_records(
self,
*,
ShardIterator: str,
Limit: int = ...,
StreamARN: str = ...,
) -> GetRecordsOutputTypeDef: # (1)
...
# get_records method usage example with argument unpacking
kwargs: GetRecordsInputRequestTypeDef = { # (1)
"ShardIterator": ...,
}
parent.get_records(**kwargs)
get_resource_policy#
Returns a policy attached to the specified data stream or consumer.
Type annotations and code completion for session.client("kinesis").get_resource_policy
method.
boto3 documentation
# get_resource_policy method definition
await def get_resource_policy(
self,
*,
ResourceARN: str,
) -> GetResourcePolicyOutputTypeDef: # (1)
...
# get_resource_policy method usage example with argument unpacking
kwargs: GetResourcePolicyInputRequestTypeDef = { # (1)
"ResourceARN": ...,
}
parent.get_resource_policy(**kwargs)
get_shard_iterator#
Gets an Amazon Kinesis shard iterator.
Type annotations and code completion for session.client("kinesis").get_shard_iterator
method.
boto3 documentation
# get_shard_iterator method definition
await def get_shard_iterator(
self,
*,
ShardId: str,
ShardIteratorType: ShardIteratorTypeType, # (1)
StreamName: str = ...,
StartingSequenceNumber: str = ...,
Timestamp: Union[datetime, str] = ...,
StreamARN: str = ...,
) -> GetShardIteratorOutputTypeDef: # (2)
...
# get_shard_iterator method usage example with argument unpacking
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 session.client("kinesis").increase_stream_retention_period
method.
boto3 documentation
# increase_stream_retention_period method definition
await def increase_stream_retention_period(
self,
*,
RetentionPeriodHours: int,
StreamName: str = ...,
StreamARN: str = ...,
) -> EmptyResponseMetadataTypeDef: # (1)
...
# increase_stream_retention_period method usage example with argument unpacking
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 session.client("kinesis").list_shards
method.
boto3 documentation
# list_shards method definition
await def list_shards(
self,
*,
StreamName: str = ...,
NextToken: str = ...,
ExclusiveStartShardId: str = ...,
MaxResults: int = ...,
StreamCreationTimestamp: Union[datetime, str] = ...,
ShardFilter: ShardFilterTypeDef = ..., # (1)
StreamARN: str = ...,
) -> ListShardsOutputTypeDef: # (2)
...
# list_shards method usage example with argument unpacking
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 session.client("kinesis").list_stream_consumers
method.
boto3 documentation
# list_stream_consumers method definition
await def list_stream_consumers(
self,
*,
StreamARN: str,
NextToken: str = ...,
MaxResults: int = ...,
StreamCreationTimestamp: Union[datetime, str] = ...,
) -> ListStreamConsumersOutputTypeDef: # (1)
...
# list_stream_consumers method usage example with argument unpacking
kwargs: ListStreamConsumersInputRequestTypeDef = { # (1)
"StreamARN": ...,
}
parent.list_stream_consumers(**kwargs)
list_streams#
Lists your Kinesis data streams.
Type annotations and code completion for session.client("kinesis").list_streams
method.
boto3 documentation
# list_streams method definition
await def list_streams(
self,
*,
Limit: int = ...,
ExclusiveStartStreamName: str = ...,
NextToken: str = ...,
) -> ListStreamsOutputTypeDef: # (1)
...
# list_streams method usage example with argument unpacking
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 session.client("kinesis").list_tags_for_stream
method.
boto3 documentation
# list_tags_for_stream method definition
await def list_tags_for_stream(
self,
*,
StreamName: str = ...,
ExclusiveStartTagKey: str = ...,
Limit: int = ...,
StreamARN: str = ...,
) -> ListTagsForStreamOutputTypeDef: # (1)
...
# list_tags_for_stream method usage example with argument unpacking
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 session.client("kinesis").merge_shards
method.
boto3 documentation
# merge_shards method definition
await def merge_shards(
self,
*,
ShardToMerge: str,
AdjacentShardToMerge: str,
StreamName: str = ...,
StreamARN: str = ...,
) -> EmptyResponseMetadataTypeDef: # (1)
...
# merge_shards method usage example with argument unpacking
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 session.client("kinesis").put_record
method.
boto3 documentation
# put_record method definition
await def put_record(
self,
*,
Data: Union[str, bytes, IO[Any], StreamingBody],
PartitionKey: str,
StreamName: str = ...,
ExplicitHashKey: str = ...,
SequenceNumberForOrdering: str = ...,
StreamARN: str = ...,
) -> PutRecordOutputTypeDef: # (1)
...
# put_record method usage example with argument unpacking
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 session.client("kinesis").put_records
method.
boto3 documentation
# put_records method definition
await def put_records(
self,
*,
Records: Sequence[PutRecordsRequestEntryTypeDef], # (1)
StreamName: str = ...,
StreamARN: str = ...,
) -> PutRecordsOutputTypeDef: # (2)
...
# put_records method usage example with argument unpacking
kwargs: PutRecordsInputRequestTypeDef = { # (1)
"Records": ...,
}
parent.put_records(**kwargs)
put_resource_policy#
Attaches a resource-based policy to a data stream or registered consumer.
Type annotations and code completion for session.client("kinesis").put_resource_policy
method.
boto3 documentation
# put_resource_policy method definition
await def put_resource_policy(
self,
*,
ResourceARN: str,
Policy: str,
) -> EmptyResponseMetadataTypeDef: # (1)
...
# put_resource_policy method usage example with argument unpacking
kwargs: PutResourcePolicyInputRequestTypeDef = { # (1)
"ResourceARN": ...,
"Policy": ...,
}
parent.put_resource_policy(**kwargs)
register_stream_consumer#
Registers a consumer with a Kinesis data stream.
Type annotations and code completion for session.client("kinesis").register_stream_consumer
method.
boto3 documentation
# register_stream_consumer method definition
await def register_stream_consumer(
self,
*,
StreamARN: str,
ConsumerName: str,
) -> RegisterStreamConsumerOutputTypeDef: # (1)
...
# register_stream_consumer method usage example with argument unpacking
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 session.client("kinesis").remove_tags_from_stream
method.
boto3 documentation
# remove_tags_from_stream method definition
await def remove_tags_from_stream(
self,
*,
TagKeys: Sequence[str],
StreamName: str = ...,
StreamARN: str = ...,
) -> EmptyResponseMetadataTypeDef: # (1)
...
# remove_tags_from_stream method usage example with argument unpacking
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 session.client("kinesis").split_shard
method.
boto3 documentation
# split_shard method definition
await def split_shard(
self,
*,
ShardToSplit: str,
NewStartingHashKey: str,
StreamName: str = ...,
StreamARN: str = ...,
) -> EmptyResponseMetadataTypeDef: # (1)
...
# split_shard method usage example with argument unpacking
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 session.client("kinesis").start_stream_encryption
method.
boto3 documentation
# start_stream_encryption method definition
await def start_stream_encryption(
self,
*,
EncryptionType: EncryptionTypeType, # (1)
KeyId: str,
StreamName: str = ...,
StreamARN: str = ...,
) -> EmptyResponseMetadataTypeDef: # (2)
...
# start_stream_encryption method usage example with argument unpacking
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 session.client("kinesis").stop_stream_encryption
method.
boto3 documentation
# stop_stream_encryption method definition
await def stop_stream_encryption(
self,
*,
EncryptionType: EncryptionTypeType, # (1)
KeyId: str,
StreamName: str = ...,
StreamARN: str = ...,
) -> EmptyResponseMetadataTypeDef: # (2)
...
# stop_stream_encryption method usage example with argument unpacking
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 session.client("kinesis").subscribe_to_shard
method.
boto3 documentation
# subscribe_to_shard method definition
await def subscribe_to_shard(
self,
*,
ConsumerARN: str,
ShardId: str,
StartingPosition: StartingPositionTypeDef, # (1)
) -> SubscribeToShardOutputTypeDef: # (2)
...
# subscribe_to_shard method usage example with argument unpacking
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 session.client("kinesis").update_shard_count
method.
boto3 documentation
# update_shard_count method definition
await def update_shard_count(
self,
*,
TargetShardCount: int,
ScalingType: ScalingTypeType, # (1)
StreamName: str = ...,
StreamARN: str = ...,
) -> UpdateShardCountOutputTypeDef: # (2)
...
# update_shard_count method usage example with argument unpacking
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 session.client("kinesis").update_stream_mode
method.
boto3 documentation
# update_stream_mode method definition
await def update_stream_mode(
self,
*,
StreamARN: str,
StreamModeDetails: StreamModeDetailsTypeDef, # (1)
) -> EmptyResponseMetadataTypeDef: # (2)
...
# update_stream_mode method usage example with argument unpacking
kwargs: UpdateStreamModeInputRequestTypeDef = { # (1)
"StreamARN": ...,
"StreamModeDetails": ...,
}
parent.update_stream_mode(**kwargs)
__aenter__#
Type annotations and code completion for session.client("kinesis").__aenter__
method.
boto3 documentation
# __aenter__ method definition
await def __aenter__(
self,
) -> KinesisClient:
...
__aexit__#
Type annotations and code completion for session.client("kinesis").__aexit__
method.
boto3 documentation
# __aexit__ method definition
await def __aexit__(
self,
exc_type: Any,
exc_val: Any,
exc_tb: Any,
) -> Any:
...
get_paginator#
Type annotations and code completion for session.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 session.client("kinesis").get_waiter
method with overloads.
client.get_waiter("stream_exists")
-> StreamExistsWaiterclient.get_waiter("stream_not_exists")
-> StreamNotExistsWaiter