Waiters

Index > Kinesis > Waiters

Auto-generated documentation for Kinesis type annotations stubs module mypy-boto3-kinesis.

StreamExistsWaiter

Type annotations and code completion for boto3.client("kinesis").get_waiter("stream_exists"). boto3 documentation

# StreamExistsWaiter usage example

from boto3.session import Session

from mypy_boto3_kinesis.waiter import StreamExistsWaiter


session = Session()

client = session.client("kinesis")  # (1)
waiter: StreamExistsWaiter = client.get_waiter("stream_exists")  # (2)
await waiter.wait(...)

1. client: KinesisClient
2. waiter: StreamExistsWaiter

wait

Type annotations and code completion for StreamExistsWaiter.wait method.

# wait method definition

def wait(
    self,
    *,
    StreamName: str = ...,
    Limit: int = ...,
    ExclusiveStartShardId: str = ...,
    StreamARN: str = ...,
    WaiterConfig: WaiterConfigTypeDef = ...,  # (1)
) -> None:
    ...

1. See WaiterConfigTypeDef

# wait method usage example with argument unpacking

kwargs: DescribeStreamInputWaitTypeDef = {  # (1)
    "StreamName": ...,
}

parent.wait(**kwargs)

1. See DescribeStreamInputWaitTypeDef

StreamNotExistsWaiter

Type annotations and code completion for boto3.client("kinesis").get_waiter("stream_not_exists"). boto3 documentation

# StreamNotExistsWaiter usage example

from boto3.session import Session

from mypy_boto3_kinesis.waiter import StreamNotExistsWaiter


session = Session()

client = session.client("kinesis")  # (1)
waiter: StreamNotExistsWaiter = client.get_waiter("stream_not_exists")  # (2)
await waiter.wait(...)

1. client: KinesisClient
2. waiter: StreamNotExistsWaiter

wait

Type annotations and code completion for StreamNotExistsWaiter.wait method.

# wait method definition

def wait(
    self,
    *,
    StreamName: str = ...,
    Limit: int = ...,
    ExclusiveStartShardId: str = ...,
    StreamARN: str = ...,
    WaiterConfig: WaiterConfigTypeDef = ...,  # (1)
) -> None:
    ...

1. See WaiterConfigTypeDef

# wait method usage example with argument unpacking

kwargs: DescribeStreamInputWaitExtraTypeDef = {  # (1)
    "StreamName": ...,
}

parent.wait(**kwargs)

1. See DescribeStreamInputWaitExtraTypeDef