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

# KinesisVideoWebRTCStorageClient 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.

# Exceptions.exceptions usage example

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

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

# Exceptions.exceptions type checking example

from mypy_boto3_kinesis_video_webrtc_storage.client import Exceptions

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

Methods

can_paginate

Type annotations and code completion for boto3.client("kinesis-video-webrtc-storage").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("kinesis-video-webrtc-storage").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:
    ...

join_storage_session

Before using this API, you must call the GetSignalingChannelEndpoint API to request the WEBRTC endpoint.

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

# join_storage_session method definition

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

1. See EmptyResponseMetadataTypeDef

# join_storage_session method usage example with argument unpacking

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

parent.join_storage_session(**kwargs)

1. See JoinStorageSessionInputRequestTypeDef

join_storage_session_as_viewer

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

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

# join_storage_session_as_viewer method definition

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

1. See EmptyResponseMetadataTypeDef

# join_storage_session_as_viewer method usage example with argument unpacking

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

parent.join_storage_session_as_viewer(**kwargs)

1. See JoinStorageSessionAsViewerInputRequestTypeDef