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

# DynamoDBStreamsClient usage example

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.

# Exceptions.exceptions usage example

client = boto3.client("dynamodbstreams")

try:
    do_something(client)
except (
    client.exceptions.ClientError,
    client.exceptions.ExpiredIteratorException,
    client.exceptions.InternalServerError,
    client.exceptions.LimitExceededException,
    client.exceptions.ResourceNotFoundException,
    client.exceptions.TrimmedDataAccessException,
) as e:
    print(e)

# Exceptions.exceptions type checking example

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

# can_paginate method definition

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

close

Closes underlying endpoint connections.

Type annotations and code completion for boto3.client("dynamodbstreams").close method. boto3 documentation

# close method definition

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 boto3.client("dynamodbstreams").describe_stream method. boto3 documentation

# describe_stream method definition

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

1. See DescribeStreamOutputTypeDef

# describe_stream method usage example with argument unpacking

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

parent.describe_stream(**kwargs)

1. See DescribeStreamInputRequestTypeDef

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

# generate_presigned_url method definition

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

# get_records method definition

def get_records(
    self,
    *,
    ShardIterator: str,
    Limit: int = ...,
) -> 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_shard_iterator

Returns a shard iterator.

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

# get_shard_iterator method definition

def get_shard_iterator(
    self,
    *,
    StreamArn: str,
    ShardId: str,
    ShardIteratorType: ShardIteratorTypeType,  # (1)
    SequenceNumber: str = ...,
) -> GetShardIteratorOutputTypeDef:  # (2)
    ...

1. See ShardIteratorTypeType
2. See GetShardIteratorOutputTypeDef

# get_shard_iterator method usage example with argument unpacking

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

parent.get_shard_iterator(**kwargs)

1. See GetShardIteratorInputRequestTypeDef

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

# list_streams method definition

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

1. See ListStreamsOutputTypeDef

# list_streams method usage example with argument unpacking

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

parent.list_streams(**kwargs)

1. See ListStreamsInputRequestTypeDef