DynamoDBStreamsClient#
Index > DynamoDBStreams > DynamoDBStreamsClient
Auto-generated documentation for DynamoDBStreams type annotations stubs module types-aiobotocore-dynamodbstreams.
DynamoDBStreamsClient#
Type annotations and code completion for session.create_client("dynamodbstreams")
boto3 documentation
DynamoDBStreamsClient usage example
from aiobotocore.session import get_session
from types_aiobotocore_dynamodbstreams.client import DynamoDBStreamsClient
session = get_session()
async with session.create_client("dynamodbstreams") as client:
client: DynamoDBStreamsClient
Exceptions#
aiobotocore
client exceptions are generated in runtime.
This class provides code completion for session.create_client("dynamodbstreams").exceptions
structure.
DynamoDBStreamsClient.exceptions usage example
async with session.create_client("dynamodbstreams") as client:
try:
do_something(client)
except (
client.ClientError,
client.ExpiredIteratorException,
client.InternalServerError,
client.LimitExceededException,
client.ResourceNotFoundException,
client.TrimmedDataAccessException,
) as e:
print(e)
DynamoDBStreamsClient usage type checking example
from types_aiobotocore_dynamodbstreams.client import Exceptions
def handle_error(exc: Exceptions.ClientError) -> None:
...
Methods#
can_paginate#
Check if an operation can be paginated.
Type annotations and code completion for session.create_client("dynamodbstreams").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.create_client("dynamodbstreams").close
method.
boto3 documentation
# close method definition
await def close(
self,
) -> None:
...
describe_stream#
Returns information about a stream, including the current status of the stream, its Amazon Resource Name (ARN), the composition of its shards, and its corresponding DynamoDB table.
Type annotations and code completion for session.create_client("dynamodbstreams").describe_stream
method.
boto3 documentation
# describe_stream method definition
await def describe_stream(
self,
*,
StreamArn: str,
Limit: int = ...,
ExclusiveStartShardId: str = ...,
) -> DescribeStreamOutputTypeDef: # (1)
...
# describe_stream method usage example with argument unpacking
kwargs: DescribeStreamInputRequestTypeDef = { # (1)
"StreamArn": ...,
}
parent.describe_stream(**kwargs)
generate_presigned_url#
Generate a presigned url given a client, its method, and arguments.
Type annotations and code completion for session.create_client("dynamodbstreams").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#
Retrieves the stream records from a given shard.
Type annotations and code completion for session.create_client("dynamodbstreams").get_records
method.
boto3 documentation
# get_records method definition
await def get_records(
self,
*,
ShardIterator: str,
Limit: int = ...,
) -> GetRecordsOutputTypeDef: # (1)
...
# get_records method usage example with argument unpacking
kwargs: GetRecordsInputRequestTypeDef = { # (1)
"ShardIterator": ...,
}
parent.get_records(**kwargs)
get_shard_iterator#
Returns a shard iterator.
Type annotations and code completion for session.create_client("dynamodbstreams").get_shard_iterator
method.
boto3 documentation
# get_shard_iterator method definition
await def get_shard_iterator(
self,
*,
StreamArn: str,
ShardId: str,
ShardIteratorType: ShardIteratorTypeType, # (1)
SequenceNumber: str = ...,
) -> GetShardIteratorOutputTypeDef: # (2)
...
# get_shard_iterator method usage example with argument unpacking
kwargs: GetShardIteratorInputRequestTypeDef = { # (1)
"StreamArn": ...,
"ShardId": ...,
"ShardIteratorType": ...,
}
parent.get_shard_iterator(**kwargs)
list_streams#
Returns an array of stream ARNs associated with the current account and endpoint.
Type annotations and code completion for session.create_client("dynamodbstreams").list_streams
method.
boto3 documentation
# list_streams method definition
await def list_streams(
self,
*,
TableName: str = ...,
Limit: int = ...,
ExclusiveStartStreamArn: str = ...,
) -> ListStreamsOutputTypeDef: # (1)
...
# list_streams method usage example with argument unpacking
kwargs: ListStreamsInputRequestTypeDef = { # (1)
"TableName": ...,
}
parent.list_streams(**kwargs)
__aenter__#
Type annotations and code completion for session.create_client("dynamodbstreams").__aenter__
method.
boto3 documentation
# __aenter__ method definition
await def __aenter__(
self,
) -> DynamoDBStreamsClient:
...
__aexit__#
Type annotations and code completion for session.create_client("dynamodbstreams").__aexit__
method.
boto3 documentation
# __aexit__ method definition
await def __aexit__(
self,
exc_type: Any,
exc_val: Any,
exc_tb: Any,
) -> Any:
...