KinesisVideoClient#
Index > KinesisVideo > KinesisVideoClient
Auto-generated documentation for KinesisVideo type annotations stubs module types-boto3-kinesisvideo.
KinesisVideoClient#
Type annotations and code completion for boto3.client("kinesisvideo").
 boto3 documentation
# KinesisVideoClient usage example
from boto3.session import Session
from types_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 types_boto3_kinesisvideo.client import Exceptions
def handle_error(exc: Exceptions.AccessDeniedException) -> None:
    ...Methods#
can_paginate#
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:
    ...generate_presigned_url#
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:
    ...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)
    ...- See ChannelTypeType
- See SingleMasterConfigurationTypeDef
- See Sequence[TagTypeDef]
- See CreateSignalingChannelOutputTypeDef
# create_signaling_channel method usage example with argument unpacking
kwargs: CreateSignalingChannelInputTypeDef = {  # (1)
    "ChannelName": ...,
}
parent.create_signaling_channel(**kwargs)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)
    ...# create_stream method usage example with argument unpacking
kwargs: CreateStreamInputTypeDef = {  # (1)
    "StreamName": ...,
}
parent.create_stream(**kwargs)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: DeleteEdgeConfigurationInputTypeDef = {  # (1)
    "StreamName": ...,
}
parent.delete_edge_configuration(**kwargs)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: DeleteSignalingChannelInputTypeDef = {  # (1)
    "ChannelARN": ...,
}
parent.delete_signaling_channel(**kwargs)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: DeleteStreamInputTypeDef = {  # (1)
    "StreamARN": ...,
}
parent.delete_stream(**kwargs)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)
    ...# describe_edge_configuration method usage example with argument unpacking
kwargs: DescribeEdgeConfigurationInputTypeDef = {  # (1)
    "StreamName": ...,
}
parent.describe_edge_configuration(**kwargs)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)
    ...# describe_image_generation_configuration method usage example with argument unpacking
kwargs: DescribeImageGenerationConfigurationInputTypeDef = {  # (1)
    "StreamName": ...,
}
parent.describe_image_generation_configuration(**kwargs)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)
    ...# describe_mapped_resource_configuration method usage example with argument unpacking
kwargs: DescribeMappedResourceConfigurationInputTypeDef = {  # (1)
    "StreamName": ...,
}
parent.describe_mapped_resource_configuration(**kwargs)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)
    ...# describe_media_storage_configuration method usage example with argument unpacking
kwargs: DescribeMediaStorageConfigurationInputTypeDef = {  # (1)
    "ChannelName": ...,
}
parent.describe_media_storage_configuration(**kwargs)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)
    ...# describe_notification_configuration method usage example with argument unpacking
kwargs: DescribeNotificationConfigurationInputTypeDef = {  # (1)
    "StreamName": ...,
}
parent.describe_notification_configuration(**kwargs)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)
    ...# describe_signaling_channel method usage example with argument unpacking
kwargs: DescribeSignalingChannelInputTypeDef = {  # (1)
    "ChannelName": ...,
}
parent.describe_signaling_channel(**kwargs)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)
    ...# describe_stream method usage example with argument unpacking
kwargs: DescribeStreamInputTypeDef = {  # (1)
    "StreamName": ...,
}
parent.describe_stream(**kwargs)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)
    ...# get_data_endpoint method usage example with argument unpacking
kwargs: GetDataEndpointInputTypeDef = {  # (1)
    "APIName": ...,
}
parent.get_data_endpoint(**kwargs)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)
) -> GetSignalingChannelEndpointOutputTypeDef:  # (2)
    ...# get_signaling_channel_endpoint method usage example with argument unpacking
kwargs: GetSignalingChannelEndpointInputTypeDef = {  # (1)
    "ChannelARN": ...,
}
parent.get_signaling_channel_endpoint(**kwargs)list_edge_agent_configurations#
Returns an array of edge configurations associated with the specified Edge Agent.
Type annotations and code completion for boto3.client("kinesisvideo").list_edge_agent_configurations method.
 boto3 documentation
# list_edge_agent_configurations method definition
def list_edge_agent_configurations(
    self,
    *,
    HubDeviceArn: str,
    MaxResults: int = ...,
    NextToken: str = ...,
) -> ListEdgeAgentConfigurationsOutputTypeDef:  # (1)
    ...# list_edge_agent_configurations method usage example with argument unpacking
kwargs: ListEdgeAgentConfigurationsInputTypeDef = {  # (1)
    "HubDeviceArn": ...,
}
parent.list_edge_agent_configurations(**kwargs)list_signaling_channels#
Returns an array of ChannelInfo objects.
Type annotations and code completion for boto3.client("kinesisvideo").list_signaling_channels method.
 boto3 documentation
# list_signaling_channels method definition
def list_signaling_channels(
    self,
    *,
    MaxResults: int = ...,
    NextToken: str = ...,
    ChannelNameCondition: ChannelNameConditionTypeDef = ...,  # (1)
) -> ListSignalingChannelsOutputTypeDef:  # (2)
    ...# list_signaling_channels method usage example with argument unpacking
kwargs: ListSignalingChannelsInputTypeDef = {  # (1)
    "MaxResults": ...,
}
parent.list_signaling_channels(**kwargs)list_streams#
Returns an array of StreamInfo objects.
Type annotations and code completion for boto3.client("kinesisvideo").list_streams method.
 boto3 documentation
# list_streams method definition
def list_streams(
    self,
    *,
    MaxResults: int = ...,
    NextToken: str = ...,
    StreamNameCondition: StreamNameConditionTypeDef = ...,  # (1)
) -> ListStreamsOutputTypeDef:  # (2)
    ...# list_streams method usage example with argument unpacking
kwargs: ListStreamsInputTypeDef = {  # (1)
    "MaxResults": ...,
}
parent.list_streams(**kwargs)list_tags_for_resource#
Returns a list of tags associated with the specified signaling channel.
Type annotations and code completion for boto3.client("kinesisvideo").list_tags_for_resource method.
 boto3 documentation
# list_tags_for_resource method definition
def list_tags_for_resource(
    self,
    *,
    ResourceARN: str,
    NextToken: str = ...,
) -> ListTagsForResourceOutputTypeDef:  # (1)
    ...# list_tags_for_resource method usage example with argument unpacking
kwargs: ListTagsForResourceInputTypeDef = {  # (1)
    "ResourceARN": ...,
}
parent.list_tags_for_resource(**kwargs)list_tags_for_stream#
Returns a list of tags associated with the specified stream.
Type annotations and code completion for boto3.client("kinesisvideo").list_tags_for_stream method.
 boto3 documentation
# list_tags_for_stream method definition
def list_tags_for_stream(
    self,
    *,
    NextToken: str = ...,
    StreamARN: str = ...,
    StreamName: str = ...,
) -> ListTagsForStreamOutputTypeDef:  # (1)
    ...# list_tags_for_stream method usage example with argument unpacking
kwargs: ListTagsForStreamInputTypeDef = {  # (1)
    "NextToken": ...,
}
parent.list_tags_for_stream(**kwargs)start_edge_configuration_update#
An asynchronous API that updates a stream's existing edge configuration.
Type annotations and code completion for boto3.client("kinesisvideo").start_edge_configuration_update method.
 boto3 documentation
# start_edge_configuration_update method definition
def start_edge_configuration_update(
    self,
    *,
    EdgeConfig: EdgeConfigTypeDef,  # (1)
    StreamName: str = ...,
    StreamARN: str = ...,
) -> StartEdgeConfigurationUpdateOutputTypeDef:  # (2)
    ...# start_edge_configuration_update method usage example with argument unpacking
kwargs: StartEdgeConfigurationUpdateInputTypeDef = {  # (1)
    "EdgeConfig": ...,
}
parent.start_edge_configuration_update(**kwargs)tag_resource#
Adds one or more tags to a signaling channel.
Type annotations and code completion for boto3.client("kinesisvideo").tag_resource method.
 boto3 documentation
# tag_resource method definition
def tag_resource(
    self,
    *,
    ResourceARN: str,
    Tags: Sequence[TagTypeDef],  # (1)
) -> Dict[str, Any]:
    ...- See Sequence[TagTypeDef]
# tag_resource method usage example with argument unpacking
kwargs: TagResourceInputTypeDef = {  # (1)
    "ResourceARN": ...,
    "Tags": ...,
}
parent.tag_resource(**kwargs)tag_stream#
Adds one or more tags to a stream.
Type annotations and code completion for boto3.client("kinesisvideo").tag_stream method.
 boto3 documentation
# tag_stream method definition
def tag_stream(
    self,
    *,
    Tags: Mapping[str, str],
    StreamARN: str = ...,
    StreamName: str = ...,
) -> Dict[str, Any]:
    ...# tag_stream method usage example with argument unpacking
kwargs: TagStreamInputTypeDef = {  # (1)
    "Tags": ...,
}
parent.tag_stream(**kwargs)untag_resource#
Removes one or more tags from a signaling channel.
Type annotations and code completion for boto3.client("kinesisvideo").untag_resource method.
 boto3 documentation
# untag_resource method definition
def untag_resource(
    self,
    *,
    ResourceARN: str,
    TagKeyList: Sequence[str],
) -> Dict[str, Any]:
    ...# untag_resource method usage example with argument unpacking
kwargs: UntagResourceInputTypeDef = {  # (1)
    "ResourceARN": ...,
    "TagKeyList": ...,
}
parent.untag_resource(**kwargs)untag_stream#
Removes one or more tags from a stream.
Type annotations and code completion for boto3.client("kinesisvideo").untag_stream method.
 boto3 documentation
# untag_stream method definition
def untag_stream(
    self,
    *,
    TagKeyList: Sequence[str],
    StreamARN: str = ...,
    StreamName: str = ...,
) -> Dict[str, Any]:
    ...# untag_stream method usage example with argument unpacking
kwargs: UntagStreamInputTypeDef = {  # (1)
    "TagKeyList": ...,
}
parent.untag_stream(**kwargs)update_data_retention#
Increases or decreases the stream's data retention period by the value that you specify.
Type annotations and code completion for boto3.client("kinesisvideo").update_data_retention method.
 boto3 documentation
# update_data_retention method definition
def update_data_retention(
    self,
    *,
    CurrentVersion: str,
    Operation: UpdateDataRetentionOperationType,  # (1)
    DataRetentionChangeInHours: int,
    StreamName: str = ...,
    StreamARN: str = ...,
) -> Dict[str, Any]:
    ...# update_data_retention method usage example with argument unpacking
kwargs: UpdateDataRetentionInputTypeDef = {  # (1)
    "CurrentVersion": ...,
    "Operation": ...,
    "DataRetentionChangeInHours": ...,
}
parent.update_data_retention(**kwargs)update_image_generation_configuration#
Updates the StreamInfo and
ImageProcessingConfiguration fields.
Type annotations and code completion for boto3.client("kinesisvideo").update_image_generation_configuration method.
 boto3 documentation
# update_image_generation_configuration method definition
def update_image_generation_configuration(
    self,
    *,
    StreamName: str = ...,
    StreamARN: str = ...,
    ImageGenerationConfiguration: ImageGenerationConfigurationUnionTypeDef = ...,  # (1)
) -> Dict[str, Any]:
    ...# update_image_generation_configuration method usage example with argument unpacking
kwargs: UpdateImageGenerationConfigurationInputTypeDef = {  # (1)
    "StreamName": ...,
}
parent.update_image_generation_configuration(**kwargs)update_media_storage_configuration#
Associates a SignalingChannel to a stream to store the media.
Type annotations and code completion for boto3.client("kinesisvideo").update_media_storage_configuration method.
 boto3 documentation
# update_media_storage_configuration method definition
def update_media_storage_configuration(
    self,
    *,
    ChannelARN: str,
    MediaStorageConfiguration: MediaStorageConfigurationTypeDef,  # (1)
) -> Dict[str, Any]:
    ...# update_media_storage_configuration method usage example with argument unpacking
kwargs: UpdateMediaStorageConfigurationInputTypeDef = {  # (1)
    "ChannelARN": ...,
    "MediaStorageConfiguration": ...,
}
parent.update_media_storage_configuration(**kwargs)update_notification_configuration#
Updates the notification information for a stream.
Type annotations and code completion for boto3.client("kinesisvideo").update_notification_configuration method.
 boto3 documentation
# update_notification_configuration method definition
def update_notification_configuration(
    self,
    *,
    StreamName: str = ...,
    StreamARN: str = ...,
    NotificationConfiguration: NotificationConfigurationTypeDef = ...,  # (1)
) -> Dict[str, Any]:
    ...# update_notification_configuration method usage example with argument unpacking
kwargs: UpdateNotificationConfigurationInputTypeDef = {  # (1)
    "StreamName": ...,
}
parent.update_notification_configuration(**kwargs)update_signaling_channel#
Updates the existing signaling channel.
Type annotations and code completion for boto3.client("kinesisvideo").update_signaling_channel method.
 boto3 documentation
# update_signaling_channel method definition
def update_signaling_channel(
    self,
    *,
    ChannelARN: str,
    CurrentVersion: str,
    SingleMasterConfiguration: SingleMasterConfigurationTypeDef = ...,  # (1)
) -> Dict[str, Any]:
    ...# update_signaling_channel method usage example with argument unpacking
kwargs: UpdateSignalingChannelInputTypeDef = {  # (1)
    "ChannelARN": ...,
    "CurrentVersion": ...,
}
parent.update_signaling_channel(**kwargs)update_stream#
Updates stream metadata, such as the device name and media type.
Type annotations and code completion for boto3.client("kinesisvideo").update_stream method.
 boto3 documentation
# update_stream method definition
def update_stream(
    self,
    *,
    CurrentVersion: str,
    StreamName: str = ...,
    StreamARN: str = ...,
    DeviceName: str = ...,
    MediaType: str = ...,
) -> Dict[str, Any]:
    ...# update_stream method usage example with argument unpacking
kwargs: UpdateStreamInputTypeDef = {  # (1)
    "CurrentVersion": ...,
}
parent.update_stream(**kwargs)get_paginator#
Type annotations and code completion for boto3.client("kinesisvideo").get_paginator method with overloads.
- client.get_paginator("describe_mapped_resource_configuration")-> DescribeMappedResourceConfigurationPaginator
- client.get_paginator("list_edge_agent_configurations")-> ListEdgeAgentConfigurationsPaginator
- client.get_paginator("list_signaling_channels")-> ListSignalingChannelsPaginator
- client.get_paginator("list_streams")-> ListStreamsPaginator