DynamoDBStreamsClient
Index > DynamoDBStreams > DynamoDBStreamsClient
Auto-generated documentation for DynamoDBStreams type annotations stubs module mypy-boto3-dynamodbstreams.
DynamoDBStreamsClient
Type annotations and code completion for boto3.client("dynamodbstreams")
.
boto3 documentation
from boto3.session import Session
from mypy_boto3_dynamodbstreams.client import DynamoDBStreamsClient
def get_dynamodbstreams_client() -> DynamoDBStreamsClient:
return Session().client("dynamodbstreams")
Exceptions
boto3
client exceptions are generated in runtime.
This class provides code completion for boto3.client("dynamodbstreams").exceptions
structure.
client = boto3.client("dynamodbstreams")
try:
do_something(client)
except (
client.ClientError,
client.ExpiredIteratorException,
client.InternalServerError,
client.LimitExceededException,
client.ResourceNotFoundException,
client.TrimmedDataAccessException,
) as e:
print(e)
from mypy_boto3_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 boto3.client("dynamodbstreams").can_paginate
method.
boto3 documentation
close
Closes underlying endpoint connections.
Type annotations and code completion for boto3.client("dynamodbstreams").close
method.
boto3 documentation
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 boto3.client("dynamodbstreams").describe_stream
method.
boto3 documentation
def describe_stream(
self,
*,
StreamArn: str,
Limit: int = ...,
ExclusiveStartShardId: str = ...,
) -> DescribeStreamOutputTypeDef: # (1)
...
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 boto3.client("dynamodbstreams").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
Retrieves the stream records from a given shard.
Type annotations and code completion for boto3.client("dynamodbstreams").get_records
method.
boto3 documentation
def get_records(
self,
*,
ShardIterator: str,
Limit: int = ...,
) -> GetRecordsOutputTypeDef: # (1)
...
kwargs: GetRecordsInputRequestTypeDef = { # (1)
"ShardIterator": ...,
}
parent.get_records(**kwargs)
get_shard_iterator
Returns a shard iterator.
Type annotations and code completion for boto3.client("dynamodbstreams").get_shard_iterator
method.
boto3 documentation
def get_shard_iterator(
self,
*,
StreamArn: str,
ShardId: str,
ShardIteratorType: ShardIteratorTypeType, # (1)
SequenceNumber: str = ...,
) -> GetShardIteratorOutputTypeDef: # (2)
...
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 boto3.client("dynamodbstreams").list_streams
method.
boto3 documentation
def list_streams(
self,
*,
TableName: str = ...,
Limit: int = ...,
ExclusiveStartStreamArn: str = ...,
) -> ListStreamsOutputTypeDef: # (1)
...