KinesisVideoWebRTCStorageClient

Index > KinesisVideoWebRTCStorage > KinesisVideoWebRTCStorageClient

Auto-generated documentation for KinesisVideoWebRTCStorage type annotations stubs module mypy-boto3-kinesis-video-webrtc-storage.

KinesisVideoWebRTCStorageClient

Type annotations and code completion for boto3.client("kinesis-video-webrtc-storage"). boto3 documentation

Usage example

from boto3.session import Session
from mypy_boto3_kinesis_video_webrtc_storage.client import KinesisVideoWebRTCStorageClient

def get_kinesis-video-webrtc-storage_client() -> KinesisVideoWebRTCStorageClient:
    return Session().client("kinesis-video-webrtc-storage")

Exceptions

boto3 client exceptions are generated in runtime. This class provides code completion for boto3.client("kinesis-video-webrtc-storage").exceptions structure.

Usage example

client = boto3.client("kinesis-video-webrtc-storage")

try:
    do_something(client)
except (
    client.AccessDeniedException,
    client.ClientError,
    client.ClientLimitExceededException,
    client.InvalidArgumentException,
    client.ResourceNotFoundException,
) as e:
    print(e)

Type checking example

from mypy_boto3_kinesis_video_webrtc_storage.client import Exceptions

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

Methods

can_paginate

Check if an operation can be paginated.

Type annotations and code completion for boto3.client("kinesis-video-webrtc-storage").can_paginate method. boto3 documentation

Method definition

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

close

Closes underlying endpoint connections.

Type annotations and code completion for boto3.client("kinesis-video-webrtc-storage").close method. boto3 documentation

Method definition

def close(
    self,
) -> None:
    ...

generate_presigned_url

Generate a presigned url given a client, its method, and arguments.

Type annotations and code completion for boto3.client("kinesis-video-webrtc-storage").generate_presigned_url method. boto3 documentation

Method definition

def generate_presigned_url(
    self,
    ClientMethod: str,
    Params: Mapping[str, Any] = ...,
    ExpiresIn: int = 3600,
    HttpMethod: str = ...,
) -> str:
    ...

join_storage_session

Join the ongoing one way-video and/or multi-way audio WebRTC session as a video producing device for an input channel.

Type annotations and code completion for boto3.client("kinesis-video-webrtc-storage").join_storage_session method. boto3 documentation

Method definition

def join_storage_session(
    self,
    *,
    channelArn: str,
) -> EmptyResponseMetadataTypeDef:  # (1)
    ...

See EmptyResponseMetadataTypeDef

Usage example with kwargs

kwargs: JoinStorageSessionInputRequestTypeDef = {  # (1)
    "channelArn": ...,
}

parent.join_storage_session(**kwargs)

See JoinStorageSessionInputRequestTypeDef