Skip to content

KeyspacesStreamsClient#

Index > KeyspacesStreams > KeyspacesStreamsClient

Auto-generated documentation for KeyspacesStreams type annotations stubs module types-boto3-keyspacesstreams.

KeyspacesStreamsClient#

Type annotations and code completion for boto3.client("keyspacesstreams"). boto3 documentation

# KeyspacesStreamsClient usage example

from boto3.session import Session
from types_boto3_keyspacesstreams.client import KeyspacesStreamsClient

def get_keyspacesstreams_client() -> KeyspacesStreamsClient:
    return Session().client("keyspacesstreams")

Exceptions#

boto3 client exceptions are generated in runtime. This class provides code completion for boto3.client("keyspacesstreams").exceptions structure.

# Exceptions.exceptions usage example

client = boto3.client("keyspacesstreams")

try:
    do_something(client)
except (
    client.exceptions.AccessDeniedException,
    client.exceptions.ClientError,
    client.exceptions.InternalServerException,
    client.exceptions.ResourceNotFoundException,
    client.exceptions.ThrottlingException,
    client.exceptions.ValidationException,
) as e:
    print(e)
# Exceptions.exceptions type checking example

from types_boto3_keyspacesstreams.client import Exceptions

def handle_error(exc: Exceptions.AccessDeniedException) -> None:
    ...

Methods#

can_paginate#

Type annotations and code completion for boto3.client("keyspacesstreams").can_paginate method. boto3 documentation

# can_paginate method definition

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

generate_presigned_url#

Type annotations and code completion for boto3.client("keyspacesstreams").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 data records from a specified shard in an Amazon Keyspaces data stream.

Type annotations and code completion for boto3.client("keyspacesstreams").get_records method. boto3 documentation

# get_records method definition

def get_records(
    self,
    *,
    shardIterator: str,
    maxResults: int = ...,
) -> GetRecordsOutputTypeDef:  # (1)
    ...
  1. See GetRecordsOutputTypeDef
# get_records method usage example with argument unpacking

kwargs: GetRecordsInputTypeDef = {  # (1)
    "shardIterator": ...,
}

parent.get_records(**kwargs)
  1. See GetRecordsInputTypeDef

get_shard_iterator#

Returns a shard iterator that serves as a bookmark for reading data from a specific position in an Amazon Keyspaces data stream's shard.

Type annotations and code completion for boto3.client("keyspacesstreams").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: GetShardIteratorInputTypeDef = {  # (1)
    "streamArn": ...,
    "shardId": ...,
    "shardIteratorType": ...,
}

parent.get_shard_iterator(**kwargs)
  1. See GetShardIteratorInputTypeDef

get_stream#

Returns detailed information about a specific data capture stream for an Amazon Keyspaces table.

Type annotations and code completion for boto3.client("keyspacesstreams").get_stream method. boto3 documentation

# get_stream method definition

def get_stream(
    self,
    *,
    streamArn: str,
    maxResults: int = ...,
    shardFilter: ShardFilterTypeDef = ...,  # (1)
    nextToken: str = ...,
) -> GetStreamOutputTypeDef:  # (2)
    ...
  1. See ShardFilterTypeDef
  2. See GetStreamOutputTypeDef
# get_stream method usage example with argument unpacking

kwargs: GetStreamInputTypeDef = {  # (1)
    "streamArn": ...,
}

parent.get_stream(**kwargs)
  1. See GetStreamInputTypeDef

list_streams#

Returns a list of all data capture streams associated with your Amazon Keyspaces account or for a specific keyspace or table.

Type annotations and code completion for boto3.client("keyspacesstreams").list_streams method. boto3 documentation

# list_streams method definition

def list_streams(
    self,
    *,
    keyspaceName: str = ...,
    tableName: str = ...,
    maxResults: int = ...,
    nextToken: str = ...,
) -> ListStreamsOutputTypeDef:  # (1)
    ...
  1. See ListStreamsOutputTypeDef
# list_streams method usage example with argument unpacking

kwargs: ListStreamsInputTypeDef = {  # (1)
    "keyspaceName": ...,
}

parent.list_streams(**kwargs)
  1. See ListStreamsInputTypeDef

get_paginator#

Type annotations and code completion for boto3.client("keyspacesstreams").get_paginator method with overloads.