Skip to content

KinesisVideoClient#

Index > KinesisVideo > KinesisVideoClient

Auto-generated documentation for KinesisVideo type annotations stubs module mypy-boto3-kinesisvideo.

KinesisVideoClient#

Type annotations and code completion for boto3.client("kinesisvideo"). boto3 documentation

# KinesisVideoClient usage example

from boto3.session import Session
from mypy_boto3_kinesisvideo.client import KinesisVideoClient

def get_kinesisvideo_client() -> KinesisVideoClient:
    return Session().client("kinesisvideo")

Exceptions#

boto3 client exceptions are generated in runtime. This class provides code completion for boto3.client("kinesisvideo").exceptions structure.

# Exceptions.exceptions usage example

client = boto3.client("kinesisvideo")

try:
    do_something(client)
except (
    client.exceptions.AccessDeniedException,
    client.exceptions.AccountChannelLimitExceededException,
    client.exceptions.AccountStreamLimitExceededException,
    client.exceptions.ClientError,
    client.exceptions.ClientLimitExceededException,
    client.exceptions.DeviceStreamLimitExceededException,
    client.exceptions.InvalidArgumentException,
    client.exceptions.InvalidDeviceException,
    client.exceptions.InvalidResourceFormatException,
    client.exceptions.NoDataRetentionException,
    client.exceptions.NotAuthorizedException,
    client.exceptions.ResourceInUseException,
    client.exceptions.ResourceNotFoundException,
    client.exceptions.StreamEdgeConfigurationNotFoundException,
    client.exceptions.TagsPerResourceExceededLimitException,
    client.exceptions.VersionMismatchException,
) as e:
    print(e)
# Exceptions.exceptions type checking example

from mypy_boto3_kinesisvideo.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("kinesisvideo").can_paginate method. boto3 documentation

# can_paginate method definition

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

close#

Closes underlying endpoint connections.

Type annotations and code completion for boto3.client("kinesisvideo").close method. boto3 documentation

# close method definition

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

create_signaling_channel#

Creates a signaling channel.

Type annotations and code completion for boto3.client("kinesisvideo").create_signaling_channel method. boto3 documentation

# create_signaling_channel method definition

def create_signaling_channel(
    self,
    *,
    ChannelName: str,
    ChannelType: ChannelTypeType = ...,  # (1)
    SingleMasterConfiguration: SingleMasterConfigurationTypeDef = ...,  # (2)
    Tags: Sequence[TagTypeDef] = ...,  # (3)
) -> CreateSignalingChannelOutputTypeDef:  # (4)
    ...
  1. See ChannelTypeType
  2. See SingleMasterConfigurationTypeDef
  3. See TagTypeDef
  4. See CreateSignalingChannelOutputTypeDef 
# create_signaling_channel method usage example with argument unpacking

kwargs: CreateSignalingChannelInputRequestTypeDef = {  # (1)
    "ChannelName": ...,
}

parent.create_signaling_channel(**kwargs)
  1. See CreateSignalingChannelInputRequestTypeDef

create_stream#

Creates a new Kinesis video stream.

Type annotations and code completion for boto3.client("kinesisvideo").create_stream method. boto3 documentation

# create_stream method definition

def create_stream(
    self,
    *,
    StreamName: str,
    DeviceName: str = ...,
    MediaType: str = ...,
    KmsKeyId: str = ...,
    DataRetentionInHours: int = ...,
    Tags: Mapping[str, str] = ...,
) -> CreateStreamOutputTypeDef:  # (1)
    ...
  1. See CreateStreamOutputTypeDef 
# create_stream method usage example with argument unpacking

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

parent.create_stream(**kwargs)
  1. See CreateStreamInputRequestTypeDef

delete_edge_configuration#

An asynchronous API that deletes a stream’s existing edge configuration, as well as the corresponding media from the Edge Agent.

Type annotations and code completion for boto3.client("kinesisvideo").delete_edge_configuration method. boto3 documentation

# delete_edge_configuration method definition

def delete_edge_configuration(
    self,
    *,
    StreamName: str = ...,
    StreamARN: str = ...,
) -> Dict[str, Any]:
    ...
# delete_edge_configuration method usage example with argument unpacking

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

parent.delete_edge_configuration(**kwargs)
  1. See DeleteEdgeConfigurationInputRequestTypeDef

delete_signaling_channel#

Deletes a specified signaling channel.

Type annotations and code completion for boto3.client("kinesisvideo").delete_signaling_channel method. boto3 documentation

# delete_signaling_channel method definition

def delete_signaling_channel(
    self,
    *,
    ChannelARN: str,
    CurrentVersion: str = ...,
) -> Dict[str, Any]:
    ...
# delete_signaling_channel method usage example with argument unpacking

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

parent.delete_signaling_channel(**kwargs)
  1. See DeleteSignalingChannelInputRequestTypeDef

delete_stream#

Deletes a Kinesis video stream and the data contained in the stream.

Type annotations and code completion for boto3.client("kinesisvideo").delete_stream method. boto3 documentation

# delete_stream method definition

def delete_stream(
    self,
    *,
    StreamARN: str,
    CurrentVersion: str = ...,
) -> Dict[str, Any]:
    ...
# delete_stream method usage example with argument unpacking

kwargs: DeleteStreamInputRequestTypeDef = {  # (1)
    "StreamARN": ...,
}

parent.delete_stream(**kwargs)
  1. See DeleteStreamInputRequestTypeDef

describe_edge_configuration#

Describes a stream’s edge configuration that was set using the StartEdgeConfigurationUpdate API and the latest status of the edge agent's recorder and uploader jobs.

Type annotations and code completion for boto3.client("kinesisvideo").describe_edge_configuration method. boto3 documentation

# describe_edge_configuration method definition

def describe_edge_configuration(
    self,
    *,
    StreamName: str = ...,
    StreamARN: str = ...,
) -> DescribeEdgeConfigurationOutputTypeDef:  # (1)
    ...
  1. See DescribeEdgeConfigurationOutputTypeDef 
# describe_edge_configuration method usage example with argument unpacking

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

parent.describe_edge_configuration(**kwargs)
  1. See DescribeEdgeConfigurationInputRequestTypeDef

describe_image_generation_configuration#

Gets the ImageGenerationConfiguration for a given Kinesis video stream.

Type annotations and code completion for boto3.client("kinesisvideo").describe_image_generation_configuration method. boto3 documentation

# describe_image_generation_configuration method definition

def describe_image_generation_configuration(
    self,
    *,
    StreamName: str = ...,
    StreamARN: str = ...,
) -> DescribeImageGenerationConfigurationOutputTypeDef:  # (1)
    ...
  1. See DescribeImageGenerationConfigurationOutputTypeDef 
# describe_image_generation_configuration method usage example with argument unpacking

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

parent.describe_image_generation_configuration(**kwargs)
  1. See DescribeImageGenerationConfigurationInputRequestTypeDef

describe_mapped_resource_configuration#

Returns the most current information about the stream.

Type annotations and code completion for boto3.client("kinesisvideo").describe_mapped_resource_configuration method. boto3 documentation

# describe_mapped_resource_configuration method definition

def describe_mapped_resource_configuration(
    self,
    *,
    StreamName: str = ...,
    StreamARN: str = ...,
    MaxResults: int = ...,
    NextToken: str = ...,
) -> DescribeMappedResourceConfigurationOutputTypeDef:  # (1)
    ...
  1. See DescribeMappedResourceConfigurationOutputTypeDef 
# describe_mapped_resource_configuration method usage example with argument unpacking

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

parent.describe_mapped_resource_configuration(**kwargs)
  1. See DescribeMappedResourceConfigurationInputRequestTypeDef

describe_media_storage_configuration#

Returns the most current information about the channel.

Type annotations and code completion for boto3.client("kinesisvideo").describe_media_storage_configuration method. boto3 documentation

# describe_media_storage_configuration method definition

def describe_media_storage_configuration(
    self,
    *,
    ChannelName: str = ...,
    ChannelARN: str = ...,
) -> DescribeMediaStorageConfigurationOutputTypeDef:  # (1)
    ...
  1. See DescribeMediaStorageConfigurationOutputTypeDef 
# describe_media_storage_configuration method usage example with argument unpacking

kwargs: DescribeMediaStorageConfigurationInputRequestTypeDef = {  # (1)
    "ChannelName": ...,
}

parent.describe_media_storage_configuration(**kwargs)
  1. See DescribeMediaStorageConfigurationInputRequestTypeDef

describe_notification_configuration#

Gets the NotificationConfiguration for a given Kinesis video stream.

Type annotations and code completion for boto3.client("kinesisvideo").describe_notification_configuration method. boto3 documentation

# describe_notification_configuration method definition

def describe_notification_configuration(
    self,
    *,
    StreamName: str = ...,
    StreamARN: str = ...,
) -> DescribeNotificationConfigurationOutputTypeDef:  # (1)
    ...
  1. See DescribeNotificationConfigurationOutputTypeDef 
# describe_notification_configuration method usage example with argument unpacking

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

parent.describe_notification_configuration(**kwargs)
  1. See DescribeNotificationConfigurationInputRequestTypeDef

describe_signaling_channel#

Returns the most current information about the signaling channel.

Type annotations and code completion for boto3.client("kinesisvideo").describe_signaling_channel method. boto3 documentation

# describe_signaling_channel method definition

def describe_signaling_channel(
    self,
    *,
    ChannelName: str = ...,
    ChannelARN: str = ...,
) -> DescribeSignalingChannelOutputTypeDef:  # (1)
    ...
  1. See DescribeSignalingChannelOutputTypeDef 
# describe_signaling_channel method usage example with argument unpacking

kwargs: DescribeSignalingChannelInputRequestTypeDef = {  # (1)
    "ChannelName": ...,
}

parent.describe_signaling_channel(**kwargs)
  1. See DescribeSignalingChannelInputRequestTypeDef

describe_stream#

Returns the most current information about the specified stream.

Type annotations and code completion for boto3.client("kinesisvideo").describe_stream method. boto3 documentation

# describe_stream method definition

def describe_stream(
    self,
    *,
    StreamName: str = ...,
    StreamARN: str = ...,
) -> DescribeStreamOutputTypeDef:  # (1)
    ...
  1. See DescribeStreamOutputTypeDef 
# describe_stream method usage example with argument unpacking

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

parent.describe_stream(**kwargs)
  1. See DescribeStreamInputRequestTypeDef

generate_presigned_url#

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

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

get_data_endpoint#

Gets an endpoint for a specified stream for either reading or writing.

Type annotations and code completion for boto3.client("kinesisvideo").get_data_endpoint method. boto3 documentation

# get_data_endpoint method definition

def get_data_endpoint(
    self,
    *,
    APIName: APINameType,  # (1)
    StreamName: str = ...,
    StreamARN: str = ...,
) -> GetDataEndpointOutputTypeDef:  # (2)
    ...
  1. See APINameType
  2. See GetDataEndpointOutputTypeDef 
# get_data_endpoint method usage example with argument unpacking

kwargs: GetDataEndpointInputRequestTypeDef = {  # (1)
    "APIName": ...,
}

parent.get_data_endpoint(**kwargs)
  1. See GetDataEndpointInputRequestTypeDef

get_signaling_channel_endpoint#

Provides an endpoint for the specified signaling channel to send and receive messages.

Type annotations and code completion for boto3.client("kinesisvideo").get_signaling_channel_endpoint method. boto3 documentation

# get_signaling_channel_endpoint method definition

def get_signaling_channel_endpoint(
    self,
    *,
    ChannelARN: str,
    SingleMasterChannelEndpointConfiguration: SingleMasterChannelEndpointConfigurationTypeDef = ...,  # (1)
) -> GetSignalingC