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

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.

Usage example

client = boto3.client("kinesisvideo")

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

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

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

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

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

Usage example with kwargs

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

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

Usage example with kwargs

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

parent.create_stream(**kwargs)

1. See CreateStreamInputRequestTypeDef

delete_signaling_channel

Deletes a specified signaling channel.

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

Method definition

def delete_signaling_channel(
    self,
    *,
    ChannelARN: str,
    CurrentVersion: str = ...,
) -> Dict[str, Any]:
    ...

Usage example with kwargs

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

Method definition

def delete_stream(
    self,
    *,
    StreamARN: str,
    CurrentVersion: str = ...,
) -> Dict[str, Any]:
    ...

Usage example with kwargs

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.

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

Method definition

def describe_edge_configuration(
    self,
    *,
    StreamName: str = ...,
    StreamARN: str = ...,
) -> DescribeEdgeConfigurationOutputTypeDef:  # (1)
    ...

1. See DescribeEdgeConfigurationOutputTypeDef

Usage example with kwargs

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

Method definition

def describe_image_generation_configuration(
    self,
    *,
    StreamName: str = ...,
    StreamARN: str = ...,
) -> DescribeImageGenerationConfigurationOutputTypeDef:  # (1)
    ...

1. See DescribeImageGenerationConfigurationOutputTypeDef

Usage example with kwargs

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

Method definition

def describe_mapped_resource_configuration(
    self,
    *,
    StreamName: str = ...,
    StreamARN: str = ...,
    MaxResults: int = ...,
    NextToken: str = ...,
) -> DescribeMappedResourceConfigurationOutputTypeDef:  # (1)
    ...

1. See DescribeMappedResourceConfigurationOutputTypeDef

Usage example with kwargs

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

Method definition

def describe_media_storage_configuration(
    self,
    *,
    ChannelName: str = ...,
    ChannelARN: str = ...,
) -> DescribeMediaStorageConfigurationOutputTypeDef:  # (1)
    ...

1. See DescribeMediaStorageConfigurationOutputTypeDef

Usage example with kwargs

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

Method definition

def describe_notification_configuration(
    self,
    *,
    StreamName: str = ...,
    StreamARN: str = ...,
) -> DescribeNotificationConfigurationOutputTypeDef:  # (1)
    ...

1. See DescribeNotificationConfigurationOutputTypeDef

Usage example with kwargs

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

Method definition

def describe_signaling_channel(
    self,
    *,
    ChannelName: str = ...,
    ChannelARN: str = ...,
) -> DescribeSignalingChannelOutputTypeDef:  # (1)
    ...

1. See DescribeSignalingChannelOutputTypeDef

Usage example with kwargs

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

Method definition

def describe_stream(
    self,
    *,
    StreamName: str = ...,
    StreamARN: str = ...,
) -> DescribeStreamOutputTypeDef:  # (1)
    ...

1. See DescribeStreamOutputTypeDef

Usage example with kwargs

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

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

Method definition

def get_data_endpoint(
    self,
    *,
    APIName: APINameType,  # (1)
    StreamName: str = ...,
    StreamARN: str = ...,
) -> GetDataEndpointOutputTypeDef:  # (2)
    ...

1. See APINameType
2. See GetDataEndpointOutputTypeDef

Usage example with kwargs

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

Method definition

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

1. See SingleMasterChannelEndpointConfigurationTypeDef
2. See GetSignalingChannelEndpointOutputTypeDef

Usage example with kwargs

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

parent.get_signaling_channel_endpoint(**kwargs)

1. See GetSignalingChannelEndpointInputRequestTypeDef

list_signaling_channels

Returns an array of ChannelInfo objects.

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

Method definition

def list_signaling_channels(
    self,
    *,
    MaxResults: int = ...,
    NextToken: str = ...,
    ChannelNameCondition: ChannelNameConditionTypeDef = ...,  # (1)
) -> ListSignalingChannelsOutputTypeDef:  # (2)
    ...

1. See ChannelNameConditionTypeDef
2. See ListSignalingChannelsOutputTypeDef

Usage example with kwargs

kwargs: ListSignalingChannelsInputRequestTypeDef = {  # (1)
    "MaxResults": ...,
}

parent.list_signaling_channels(**kwargs)

1. See ListSignalingChannelsInputRequestTypeDef

list_streams

Returns an array of StreamInfo objects.

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

Method definition

def list_streams(
    self,
    *,
    MaxResults: int = ...,
    NextToken: str = ...,
    StreamNameCondition: StreamNameConditionTypeDef = ...,  # (1)
) -> ListStreamsOutputTypeDef:  # (2)
    ...

1. See StreamNameConditionTypeDef
2. See ListStreamsOutputTypeDef

Usage example with kwargs

kwargs: ListStreamsInputRequestTypeDef = {  # (1)
    "MaxResults": ...,
}

parent.list_streams(**kwargs)

1. See ListStreamsInputRequestTypeDef

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

Method definition

def list_tags_for_resource(
    self,
    *,
    ResourceARN: str,
    NextToken: str = ...,
) -> ListTagsForResourceOutputTypeDef:  # (1)
    ...

1. See ListTagsForResourceOutputTypeDef

Usage example with kwargs

kwargs: ListTagsForResourceInputRequestTypeDef = {  # (1)
    "ResourceARN": ...,
}

parent.list_tags_for_resource(**kwargs)

1. See ListTagsForResourceInputRequestTypeDef

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

Method definition

def list_tags_for_stream(
    self,
    *,
    NextToken: str = ...,
    StreamARN: str = ...,
    StreamName: str = ...,
) -> ListTagsForStreamOutputTypeDef:  # (1)
    ...

1. See ListTagsForStreamOutputTypeDef

Usage example with kwargs

kwargs: ListTagsForStreamInputRequestTypeDef = {  # (1)
    "NextToken": ...,
}

parent.list_tags_for_stream(**kwargs)

1. See ListTagsForStreamInputRequestTypeDef

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

Method definition

def start_edge_configuration_update(
    self,
    *,
    EdgeConfig: EdgeConfigTypeDef,  # (1)
    StreamName: str = ...,
    StreamARN: str = ...,
) -> StartEdgeConfigurationUpdateOutputTypeDef:  # (2)
    ...

1. See EdgeConfigTypeDef
2. See StartEdgeConfigurationUpdateOutputTypeDef

Usage example with kwargs

kwargs: StartEdgeConfigurationUpdateInputRequestTypeDef = {  # (1)
    "EdgeConfig": ...,
}

parent.start_edge_configuration_update(**kwargs)

1. See StartEdgeConfigurationUpdateInputRequestTypeDef

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

Method definition

def tag_resource(
    self,
    *,
    ResourceARN: str,
    Tags: Sequence[TagTypeDef],  # (1)
) -> Dict[str, Any]:
    ...

1. See TagTypeDef

Usage example with kwargs

kwargs: TagResourceInputRequestTypeDef = {  # (1)
    "ResourceARN": ...,
    "Tags": ...,
}

parent.tag_resource(**kwargs)

1. See TagResourceInputRequestTypeDef

tag_stream

Adds one or more tags to a stream.

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

Method definition

def tag_stream(
    self,
    *,
    Tags: Mapping[str, str],
    StreamARN: str = ...,
    StreamName: str = ...,
) -> Dict[str, Any]:
    ...

Usage example with kwargs

kwargs: TagStreamInputRequestTypeDef = {  # (1)
    "Tags": ...,
}

parent.tag_stream(**kwargs)

1. See TagStreamInputRequestTypeDef

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

Method definition

def untag_resource(
    self,
    *,
    ResourceARN: str,
    TagKeyList: Sequence[str],
) -> Dict[str, Any]:
    ...

Usage example with kwargs

kwargs: UntagResourceInputRequestTypeDef = {  # (1)
    "ResourceARN": ...,
    "TagKeyList": ...,
}

parent.untag_resource(**kwargs)

1. See UntagResourceInputRequestTypeDef

untag_stream

Removes one or more tags from a stream.

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

Method definition

def untag_stream(
    self,
    *,
    TagKeyList: Sequence[str],
    StreamARN: str = ...,
    StreamName: str = ...,
) -> Dict[str, Any]:
    ...

Usage example with kwargs

kwargs: UntagStreamInputRequestTypeDef = {  # (1)
    "TagKeyList": ...,
}

parent.untag_stream(**kwargs)

1. See UntagStreamInputRequestTypeDef

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

Method definition

def update_data_retention(
    self,
    *,
    CurrentVersion: str,
    Operation: UpdateDataRetentionOperationType,  # (1)
    DataRetentionChangeInHours: int,
    StreamName: str = ...,
    StreamARN: str = ...,
) -> Dict[str, Any]:
    ...

1. See UpdateDataRetentionOperationType

Usage example with kwargs

kwargs: UpdateDataRetentionInputRequestTypeDef = {  # (1)
    "CurrentVersion": ...,
    "Operation": ...,
    "DataRetentionChangeInHours": ...,
}

parent.update_data_retention(**kwargs)

1. See UpdateDataRetentionInputRequestTypeDef

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

Method definition

def update_image_generation_configuration(
    self,
    *,
    StreamName: str = ...,
    StreamARN: str = ...,
    ImageGenerationConfiguration: ImageGenerationConfigurationTypeDef = ...,  # (1)
) -> Dict[str, Any]:
    ...

1. See ImageGenerationConfigurationTypeDef

Usage example with kwargs

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

parent.update_image_generation_configuration(**kwargs)

1. See UpdateImageGenerationConfigurationInputRequestTypeDef

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

Method definition

def update_media_storage_configuration(
    self,
    *,
    ChannelARN: str,
    MediaStorageConfiguration: MediaStorageConfigurationTypeDef,  # (1)
) -> Dict[str, Any]:
    ...

1. See MediaStorageConfigurationTypeDef

Usage example with kwargs

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

parent.update_media_storage_configuration(**kwargs)

1. See UpdateMediaStorageConfigurationInputRequestTypeDef

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

Method definition

def update_notification_configuration(
    self,
    *,
    StreamName: str = ...,
    StreamARN: str = ...,
    NotificationConfiguration: NotificationConfigurationTypeDef = ...,  # (1)
) -> Dict[str, Any]:
    ...

1. See NotificationConfigurationTypeDef

Usage example with kwargs

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

parent.update_notification_configuration(**kwargs)

1. See UpdateNotificationConfigurationInputRequestTypeDef

update_signaling_channel

Updates the existing signaling channel.

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

Method definition

def update_signaling_channel(
    self,
    *,
    ChannelARN: str,
    CurrentVersion: str,
    SingleMasterConfiguration: SingleMasterConfigurationTypeDef = ...,  # (1)
) -> Dict[str, Any]:
    ...

1. See SingleMasterConfigurationTypeDef

Usage example with kwargs

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

parent.update_signaling_channel(**kwargs)

1. See UpdateSignalingChannelInputRequestTypeDef

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

Method definition

def update_stream(
    self,
    *,
    CurrentVersion: str,
    StreamName: str = ...,
    StreamARN: str = ...,
    DeviceName: str = ...,
    MediaType: str = ...,
) -> Dict[str, Any]:
    ...

Usage example with kwargs

kwargs: UpdateStreamInputRequestTypeDef = {  # (1)
    "CurrentVersion": ...,
}

parent.update_stream(**kwargs)

1. See UpdateStreamInputRequestTypeDef

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_signaling_channels") -> ListSignalingChannelsPaginator
• client.get_paginator("list_streams") -> ListStreamsPaginator