Skip to content

Type definitions#

Index > KinesisVideo > Type definitions

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

ImageGenerationConfigurationUnionTypeDef#

# ImageGenerationConfigurationUnionTypeDef definition

ImageGenerationConfigurationUnionTypeDef = Union[
    ImageGenerationConfigurationTypeDef,  # (1)
    ImageGenerationConfigurationOutputTypeDef,  # (2)
]
  1. See ImageGenerationConfigurationTypeDef
  2. See ImageGenerationConfigurationOutputTypeDef

SingleMasterConfigurationTypeDef#

# SingleMasterConfigurationTypeDef definition

class SingleMasterConfigurationTypeDef(TypedDict):
    MessageTtlSeconds: NotRequired[int],

ChannelNameConditionTypeDef#

# ChannelNameConditionTypeDef definition

class ChannelNameConditionTypeDef(TypedDict):
    ComparisonOperator: NotRequired[ComparisonOperatorType],  # (1)
    ComparisonValue: NotRequired[str],
  1. See ComparisonOperatorType

TagTypeDef#

# TagTypeDef definition

class TagTypeDef(TypedDict):
    Key: str,
    Value: str,

ResponseMetadataTypeDef#

# ResponseMetadataTypeDef definition

class ResponseMetadataTypeDef(TypedDict):
    RequestId: str,
    HTTPStatusCode: int,
    HTTPHeaders: Dict[str, str],
    RetryAttempts: int,
    HostId: NotRequired[str],

CreateStreamInputRequestTypeDef#

# CreateStreamInputRequestTypeDef definition

class CreateStreamInputRequestTypeDef(TypedDict):
    StreamName: str,
    DeviceName: NotRequired[str],
    MediaType: NotRequired[str],
    KmsKeyId: NotRequired[str],
    DataRetentionInHours: NotRequired[int],
    Tags: NotRequired[Mapping[str, str]],

DeleteEdgeConfigurationInputRequestTypeDef#

# DeleteEdgeConfigurationInputRequestTypeDef definition

class DeleteEdgeConfigurationInputRequestTypeDef(TypedDict):
    StreamName: NotRequired[str],
    StreamARN: NotRequired[str],

DeleteSignalingChannelInputRequestTypeDef#

# DeleteSignalingChannelInputRequestTypeDef definition

class DeleteSignalingChannelInputRequestTypeDef(TypedDict):
    ChannelARN: str,
    CurrentVersion: NotRequired[str],

DeleteStreamInputRequestTypeDef#

# DeleteStreamInputRequestTypeDef definition

class DeleteStreamInputRequestTypeDef(TypedDict):
    StreamARN: str,
    CurrentVersion: NotRequired[str],

LocalSizeConfigTypeDef#

# LocalSizeConfigTypeDef definition

class LocalSizeConfigTypeDef(TypedDict):
    MaxLocalMediaSizeInMB: NotRequired[int],
    StrategyOnFullSize: NotRequired[StrategyOnFullSizeType],  # (1)
  1. See StrategyOnFullSizeType

DescribeEdgeConfigurationInputRequestTypeDef#

# DescribeEdgeConfigurationInputRequestTypeDef definition

class DescribeEdgeConfigurationInputRequestTypeDef(TypedDict):
    StreamName: NotRequired[str],
    StreamARN: NotRequired[str],

DescribeImageGenerationConfigurationInputRequestTypeDef#

# DescribeImageGenerationConfigurationInputRequestTypeDef definition

class DescribeImageGenerationConfigurationInputRequestTypeDef(TypedDict):
    StreamName: NotRequired[str],
    StreamARN: NotRequired[str],

PaginatorConfigTypeDef#

# PaginatorConfigTypeDef definition

class PaginatorConfigTypeDef(TypedDict):
    MaxItems: NotRequired[int],
    PageSize: NotRequired[int],
    StartingToken: NotRequired[str],

DescribeMappedResourceConfigurationInputRequestTypeDef#

# DescribeMappedResourceConfigurationInputRequestTypeDef definition

class DescribeMappedResourceConfigurationInputRequestTypeDef(TypedDict):
    StreamName: NotRequired[str],
    StreamARN: NotRequired[str],
    MaxResults: NotRequired[int],
    NextToken: NotRequired[str],

MappedResourceConfigurationListItemTypeDef#

# MappedResourceConfigurationListItemTypeDef definition

class MappedResourceConfigurationListItemTypeDef(TypedDict):
    Type: NotRequired[str],
    ARN: NotRequired[str],

DescribeMediaStorageConfigurationInputRequestTypeDef#

# DescribeMediaStorageConfigurationInputRequestTypeDef definition

class DescribeMediaStorageConfigurationInputRequestTypeDef(TypedDict):
    ChannelName: NotRequired[str],
    ChannelARN: NotRequired[str],

MediaStorageConfigurationTypeDef#

# MediaStorageConfigurationTypeDef definition

class MediaStorageConfigurationTypeDef(TypedDict):
    Status: MediaStorageConfigurationStatusType,  # (1)
    StreamARN: NotRequired[str],
  1. See MediaStorageConfigurationStatusType

DescribeNotificationConfigurationInputRequestTypeDef#

# DescribeNotificationConfigurationInputRequestTypeDef definition

class DescribeNotificationConfigurationInputRequestTypeDef(TypedDict):
    StreamName: NotRequired[str],
    StreamARN: NotRequired[str],

DescribeSignalingChannelInputRequestTypeDef#

# DescribeSignalingChannelInputRequestTypeDef definition

class DescribeSignalingChannelInputRequestTypeDef(TypedDict):
    ChannelName: NotRequired[str],
    ChannelARN: NotRequired[str],

DescribeStreamInputRequestTypeDef#

# DescribeStreamInputRequestTypeDef definition

class DescribeStreamInputRequestTypeDef(TypedDict):
    StreamName: NotRequired[str],
    StreamARN: NotRequired[str],

StreamInfoTypeDef#

# StreamInfoTypeDef definition

class StreamInfoTypeDef(TypedDict):
    DeviceName: NotRequired[str],
    StreamName: NotRequired[str],
    StreamARN: NotRequired[str],
    MediaType: NotRequired[str],
    KmsKeyId: NotRequired[str],
    Version: NotRequired[str],
    Status: NotRequired[StatusType],  # (1)
    CreationTime: NotRequired[datetime],
    DataRetentionInHours: NotRequired[int],
  1. See StatusType

LastRecorderStatusTypeDef#

# LastRecorderStatusTypeDef definition

class LastRecorderStatusTypeDef(TypedDict):
    JobStatusDetails: NotRequired[str],
    LastCollectedTime: NotRequired[datetime],
    LastUpdatedTime: NotRequired[datetime],
    RecorderStatus: NotRequired[RecorderStatusType],  # (1)
  1. See RecorderStatusType

LastUploaderStatusTypeDef#

# LastUploaderStatusTypeDef definition

class LastUploaderStatusTypeDef(TypedDict):
    JobStatusDetails: NotRequired[str],
    LastCollectedTime: NotRequired[datetime],
    LastUpdatedTime: NotRequired[datetime],
    UploaderStatus: NotRequired[UploaderStatusType],  # (1)
  1. See UploaderStatusType

GetDataEndpointInputRequestTypeDef#

# GetDataEndpointInputRequestTypeDef definition

class GetDataEndpointInputRequestTypeDef(TypedDict):
    APIName: APINameType,  # (1)
    StreamName: NotRequired[str],
    StreamARN: NotRequired[str],
  1. See APINameType

SingleMasterChannelEndpointConfigurationTypeDef#

# SingleMasterChannelEndpointConfigurationTypeDef definition

class SingleMasterChannelEndpointConfigurationTypeDef(TypedDict):
    Protocols: NotRequired[Sequence[ChannelProtocolType]],  # (1)
    Role: NotRequired[ChannelRoleType],  # (2)
  1. See ChannelProtocolType
  2. See ChannelRoleType

ResourceEndpointListItemTypeDef#

# ResourceEndpointListItemTypeDef definition

class ResourceEndpointListItemTypeDef(TypedDict):
    Protocol: NotRequired[ChannelProtocolType],  # (1)
    ResourceEndpoint: NotRequired[str],
  1. See ChannelProtocolType

ImageGenerationDestinationConfigTypeDef#

# ImageGenerationDestinationConfigTypeDef definition

class ImageGenerationDestinationConfigTypeDef(TypedDict):
    Uri: str,
    DestinationRegion: str,

ListEdgeAgentConfigurationsInputRequestTypeDef#

# ListEdgeAgentConfigurationsInputRequestTypeDef definition

class ListEdgeAgentConfigurationsInputRequestTypeDef(TypedDict):
    HubDeviceArn: str,
    MaxResults: NotRequired[int],
    NextToken: NotRequired[str],

StreamNameConditionTypeDef#

# StreamNameConditionTypeDef definition

class StreamNameConditionTypeDef(TypedDict):
    ComparisonOperator: NotRequired[ComparisonOperatorType],  # (1)
    ComparisonValue: NotRequired[str],
  1. See ComparisonOperatorType

ListTagsForResourceInputRequestTypeDef#

# ListTagsForResourceInputRequestTypeDef definition

class ListTagsForResourceInputRequestTypeDef(TypedDict):
    ResourceARN: str,
    NextToken: NotRequired[str],

ListTagsForStreamInputRequestTypeDef#

# ListTagsForStreamInputRequestTypeDef definition

class ListTagsForStreamInputRequestTypeDef(TypedDict):
    NextToken: NotRequired[str],
    StreamARN: NotRequired[str],
    StreamName: NotRequired[str],

MediaSourceConfigTypeDef#

# MediaSourceConfigTypeDef definition

class MediaSourceConfigTypeDef(TypedDict):
    MediaUriSecretArn: str,
    MediaUriType: MediaUriTypeType,  # (1)
  1. See MediaUriTypeType

NotificationDestinationConfigTypeDef#

# NotificationDestinationConfigTypeDef definition

class NotificationDestinationConfigTypeDef(TypedDict):
    Uri: str,

ScheduleConfigTypeDef#

# ScheduleConfigTypeDef definition

class ScheduleConfigTypeDef(TypedDict):
    ScheduleExpression: str,
    DurationInSeconds: int,

TagStreamInputRequestTypeDef#

# TagStreamInputRequestTypeDef definition

class TagStreamInputRequestTypeDef(TypedDict):
    Tags: Mapping[str, str],
    StreamARN: NotRequired[str],
    StreamName: NotRequired[str],

UntagResourceInputRequestTypeDef#

# UntagResourceInputRequestTypeDef definition

class UntagResourceInputRequestTypeDef(TypedDict):
    ResourceARN: str,
    TagKeyList: Sequence[str],

UntagStreamInputRequestTypeDef#

# UntagStreamInputRequestTypeDef definition

class UntagStreamInputRequestTypeDef(TypedDict):
    TagKeyList: Sequence[str],
    StreamARN: NotRequired[str],
    StreamName: NotRequired[str],

UpdateDataRetentionInputRequestTypeDef#

# UpdateDataRetentionInputRequestTypeDef definition

class UpdateDataRetentionInputRequestTypeDef(TypedDict):
    CurrentVersion: str,
    Operation: UpdateDataRetentionOperationType,  # (1)
    DataRetentionChangeInHours: int,
    StreamName: NotRequired[str],
    StreamARN: NotRequired[str],
  1. See UpdateDataRetentionOperationType

UpdateStreamInputRequestTypeDef#

# UpdateStreamInputRequestTypeDef definition

class UpdateStreamInputRequestTypeDef(TypedDict):
    CurrentVersion: str,
    StreamName: NotRequired[str],
    StreamARN: NotRequired[str],
    DeviceName: NotRequired[str],
    MediaType: NotRequired[str],

ChannelInfoTypeDef#

# ChannelInfoTypeDef definition

class ChannelInfoTypeDef(TypedDict):
    ChannelName: NotRequired[str],
    ChannelARN: NotRequired[str],
    ChannelType: NotRequired[ChannelTypeType],  # (1)
    ChannelStatus: NotRequired[StatusType],  # (2)
    CreationTime: NotRequired[datetime],
    SingleMasterConfiguration: NotRequired[SingleMasterConfigurationTypeDef],  # (3)
    Version: NotRequired[str],
  1. See ChannelTypeType
  2. See StatusType
  3. See SingleMasterConfigurationTypeDef

UpdateSignalingChannelInputRequestTypeDef#

# UpdateSignalingChannelInputRequestTypeDef definition

class UpdateSignalingChannelInputRequestTypeDef(TypedDict):
    ChannelARN: str,
    CurrentVersion: str,
    SingleMasterConfiguration: NotRequired[SingleMasterConfigurationTypeDef],  # (1)
  1. See SingleMasterConfigurationTypeDef

ListSignalingChannelsInputRequestTypeDef#

# ListSignalingChannelsInputRequestTypeDef definition

class ListSignalingChannelsInputRequestTypeDef(TypedDict):
    MaxResults: NotRequired[int],
    NextToken: NotRequired[str],
    ChannelNameCondition: NotRequired[ChannelNameConditionTypeDef],  # (1)
  1. See ChannelNameConditionTypeDef

CreateSignalingChannelInputRequestTypeDef#

# CreateSignalingChannelInputRequestTypeDef definition

class CreateSignalingChannelInputRequestTypeDef(TypedDict):
    ChannelName: str,
    ChannelType: NotRequired[ChannelTypeType],  # (1)
    SingleMasterConfiguration: NotRequired[SingleMasterConfigurationTypeDef],  # (2)
    Tags: NotRequired[Sequence[TagTypeDef]],  # (3)
  1. See ChannelTypeType
  2. See SingleMasterConfigurationTypeDef
  3. See TagTypeDef

TagResourceInputRequestTypeDef#

# TagResourceInputRequestTypeDef definition

class TagResourceInputRequestTypeDef(TypedDict):
    ResourceARN: str,
    Tags: Sequence[TagTypeDef],  # (1)
  1. See TagTypeDef

CreateSignalingChannelOutputTypeDef#

# CreateSignalingChannelOutputTypeDef definition

class CreateSignalingChannelOutputTypeDef(TypedDict):
    ChannelARN: str,
    ResponseMetadata: ResponseMetadataTypeDef,  # (1)
  1. See ResponseMetadataTypeDef

CreateStreamOutputTypeDef#

# CreateStreamOutputTypeDef definition

class CreateStreamOutputTypeDef(TypedDict):
    StreamARN: str,
    ResponseMetadata: ResponseMetadataTypeDef,  # (1)
  1. See ResponseMetadataTypeDef

GetDataEndpointOutputTypeDef#

# GetDataEndpointOutputTypeDef definition

class GetDataEndpointOutputTypeDef(TypedDict):
    DataEndpoint: str,
    ResponseMetadata: ResponseMetadataTypeDef,  # (1)
  1. See ResponseMetadataTypeDef

ListTagsForResourceOutputTypeDef#

# ListTagsForResourceOutputTypeDef definition

class ListTagsForResourceOutputTypeDef(TypedDict):
    Tags: Dict[str, str],
    ResponseMetadata: ResponseMetadataTypeDef,  # (1)
    NextToken: NotRequired[str],
  1. See ResponseMetadataTypeDef

ListTagsForStreamOutputTypeDef#

# ListTagsForStreamOutputTypeDef definition

class ListTagsForStreamOutputTypeDef(TypedDict):
    Tags: Dict[str, str],
    ResponseMetadata: ResponseMetadataTypeDef,  # (1)
    NextToken: NotRequired[str],
  1. See ResponseMetadataTypeDef

DeletionConfigTypeDef#

# DeletionConfigTypeDef definition

class DeletionConfigTypeDef(TypedDict):
    EdgeRetentionInHours: NotRequired[int],
    LocalSizeConfig: NotRequired[LocalSizeConfigTypeDef],  # (1)
    DeleteAfterUpload: NotRequired[bool],
  1. See