Skip to content

KinesisVideoMediaClient

Index > KinesisVideoMedia > KinesisVideoMediaClient

Auto-generated documentation for KinesisVideoMedia type annotations stubs module mypy-boto3-kinesis-video-media.

KinesisVideoMediaClient

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

Usage example
from boto3.session import Session
from mypy_boto3_kinesis_video_media.client import KinesisVideoMediaClient

def get_kinesis-video-media_client() -> KinesisVideoMediaClient:
    return Session().client("kinesis-video-media")

Exceptions

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

Usage example
client = boto3.client("kinesis-video-media")

try:
    do_something(client)
except (
    client.ClientError,
    client.ClientLimitExceededException,
    client.ConnectionLimitExceededException,
    client.InvalidArgumentException,
    client.InvalidEndpointException,
    client.NotAuthorizedException,
    client.ResourceNotFoundException,
) as e:
    print(e)
Type checking example
from mypy_boto3_kinesis_video_media.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 boto3.client("kinesis-video-media").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-media").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-media").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:
    ...

get_media

Use this API to retrieve media content from a Kinesis video stream.

Type annotations and code completion for boto3.client("kinesis-video-media").get_media method. boto3 documentation

Method definition
def get_media(
    self,
    *,
    StartSelector: StartSelectorTypeDef,  # (1)
    StreamName: str = ...,
    StreamARN: str = ...,
) -> GetMediaOutputTypeDef:  # (2)
    ...
  1. See StartSelectorTypeDef
  2. See GetMediaOutputTypeDef
Usage example with kwargs
kwargs: GetMediaInputRequestTypeDef = {  # (1)
    "StartSelector": ...,
}

parent.get_media(**kwargs)
  1. See GetMediaInputRequestTypeDef