KinesisVideoSignalingChannelsClient

Index > KinesisVideoSignalingChannels > KinesisVideoSignalingChannelsClient

Auto-generated documentation for KinesisVideoSignalingChannels type annotations stubs module types-aiobotocore-kinesis-video-signaling.

KinesisVideoSignalingChannelsClient

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

Usage example

from aioboto3.session import Session
from types_aiobotocore_kinesis_video_signaling.client import KinesisVideoSignalingChannelsClient

session = Session()
async with session.client("kinesis-video-signaling") as client:
    client: KinesisVideoSignalingChannelsClient

Exceptions

aioboto3 client exceptions are generated in runtime. This class provides code completion for session.client("kinesis-video-signaling").exceptions structure.

Usage example

async with session.client("kinesis-video-signaling") as client:
    try:
        do_something(client)
    except (
            client.ClientError,
        client.ClientLimitExceededException,
        client.InvalidArgumentException,
        client.InvalidClientException,
        client.NotAuthorizedException,
        client.ResourceNotFoundException,
        client.SessionExpiredException,
    ) as e:
        print(e)

Type checking example

from types_aiobotocore_kinesis_video_signaling.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 session.client("kinesis-video-signaling").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 session.client("kinesis-video-signaling").close method. boto3 documentation

Method definition

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

generate_presigned_url

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

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

Method definition

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

get_ice_server_config

Gets the Interactive Connectivity Establishment (ICE) server configuration information, including URIs, username, and password which can be used to configure the WebRTC connection.

Type annotations and code completion for session.client("kinesis-video-signaling").get_ice_server_config method. boto3 documentation

Method definition

await def get_ice_server_config(
    self,
    *,
    ChannelARN: str,
    ClientId: str = ...,
    Service: ServiceType = ...,  # (1)
    Username: str = ...,
) -> GetIceServerConfigResponseTypeDef:  # (2)
    ...

1. See ServiceType
2. See GetIceServerConfigResponseTypeDef

Usage example with kwargs

kwargs: GetIceServerConfigRequestRequestTypeDef = {  # (1)
    "ChannelARN": ...,
}

parent.get_ice_server_config(**kwargs)

1. See GetIceServerConfigRequestRequestTypeDef

send_alexa_offer_to_master

This API allows you to connect WebRTC-enabled devices with Alexa display devices.

Type annotations and code completion for session.client("kinesis-video-signaling").send_alexa_offer_to_master method. boto3 documentation

Method definition

await def send_alexa_offer_to_master(
    self,
    *,
    ChannelARN: str,
    SenderClientId: str,
    MessagePayload: str,
) -> SendAlexaOfferToMasterResponseTypeDef:  # (1)
    ...

1. See SendAlexaOfferToMasterResponseTypeDef

Usage example with kwargs

kwargs: SendAlexaOfferToMasterRequestRequestTypeDef = {  # (1)
    "ChannelARN": ...,
    "SenderClientId": ...,
    "MessagePayload": ...,
}

parent.send_alexa_offer_to_master(**kwargs)

1. See SendAlexaOfferToMasterRequestRequestTypeDef

__aenter__

Type annotations and code completion for session.client("kinesis-video-signaling").__aenter__ method. boto3 documentation

Method definition

await def __aenter__(
    self,
) -> KinesisVideoSignalingChannelsClient:
    ...

__aexit__

Type annotations and code completion for session.client("kinesis-video-signaling").__aexit__ method. boto3 documentation

Method definition

await def __aexit__(
    self,
    exc_type: Any,
    exc_val: Any,
    exc_tb: Any,
) -> Any:
    ...