Typed dictionaries#
Index > KinesisVideoArchivedMedia > Typed dictionaries
Auto-generated documentation for KinesisVideoArchivedMedia type annotations stubs module mypy-boto3-kinesis-video-archived-media.
ClipTimestampRangeTypeDef#
# ClipTimestampRangeTypeDef usage example
from mypy_boto3_kinesis_video_archived_media.type_defs import ClipTimestampRangeTypeDef
def get_value() -> ClipTimestampRangeTypeDef:
return {
"StartTimestamp": ...,
"EndTimestamp": ...,
}
# ClipTimestampRangeTypeDef definition
class ClipTimestampRangeTypeDef(TypedDict):
StartTimestamp: Union[datetime, str],
EndTimestamp: Union[datetime, str],
DASHTimestampRangeTypeDef#
# DASHTimestampRangeTypeDef usage example
from mypy_boto3_kinesis_video_archived_media.type_defs import DASHTimestampRangeTypeDef
def get_value() -> DASHTimestampRangeTypeDef:
return {
"StartTimestamp": ...,
}
# DASHTimestampRangeTypeDef definition
class DASHTimestampRangeTypeDef(TypedDict):
StartTimestamp: NotRequired[Union[datetime, str]],
EndTimestamp: NotRequired[Union[datetime, str]],
TimestampRangeTypeDef#
# TimestampRangeTypeDef usage example
from mypy_boto3_kinesis_video_archived_media.type_defs import TimestampRangeTypeDef
def get_value() -> TimestampRangeTypeDef:
return {
"StartTimestamp": ...,
"EndTimestamp": ...,
}
# TimestampRangeTypeDef definition
class TimestampRangeTypeDef(TypedDict):
StartTimestamp: Union[datetime, str],
EndTimestamp: Union[datetime, str],
FragmentTypeDef#
# FragmentTypeDef usage example
from mypy_boto3_kinesis_video_archived_media.type_defs import FragmentTypeDef
def get_value() -> FragmentTypeDef:
return {
"FragmentNumber": ...,
}
# FragmentTypeDef definition
class FragmentTypeDef(TypedDict):
FragmentNumber: NotRequired[str],
FragmentSizeInBytes: NotRequired[int],
ProducerTimestamp: NotRequired[datetime],
ServerTimestamp: NotRequired[datetime],
FragmentLengthInMilliseconds: NotRequired[int],
GetClipOutputTypeDef#
# GetClipOutputTypeDef usage example
from mypy_boto3_kinesis_video_archived_media.type_defs import GetClipOutputTypeDef
def get_value() -> GetClipOutputTypeDef:
return {
"ContentType": ...,
"Payload": ...,
"ResponseMetadata": ...,
}
# GetClipOutputTypeDef definition
class GetClipOutputTypeDef(TypedDict):
ContentType: str,
Payload: StreamingBody,
ResponseMetadata: ResponseMetadataTypeDef, # (1)
GetDASHStreamingSessionURLOutputTypeDef#
# GetDASHStreamingSessionURLOutputTypeDef usage example
from mypy_boto3_kinesis_video_archived_media.type_defs import GetDASHStreamingSessionURLOutputTypeDef
def get_value() -> GetDASHStreamingSessionURLOutputTypeDef:
return {
"DASHStreamingSessionURL": ...,
"ResponseMetadata": ...,
}
# GetDASHStreamingSessionURLOutputTypeDef definition
class GetDASHStreamingSessionURLOutputTypeDef(TypedDict):
DASHStreamingSessionURL: str,
ResponseMetadata: ResponseMetadataTypeDef, # (1)
GetHLSStreamingSessionURLOutputTypeDef#
# GetHLSStreamingSessionURLOutputTypeDef usage example
from mypy_boto3_kinesis_video_archived_media.type_defs import GetHLSStreamingSessionURLOutputTypeDef
def get_value() -> GetHLSStreamingSessionURLOutputTypeDef:
return {
"HLSStreamingSessionURL": ...,
"ResponseMetadata": ...,
}
# GetHLSStreamingSessionURLOutputTypeDef definition
class GetHLSStreamingSessionURLOutputTypeDef(TypedDict):
HLSStreamingSessionURL: str,
ResponseMetadata: ResponseMetadataTypeDef, # (1)
GetImagesInputGetImagesPaginateTypeDef#
# GetImagesInputGetImagesPaginateTypeDef usage example
from mypy_boto3_kinesis_video_archived_media.type_defs import GetImagesInputGetImagesPaginateTypeDef
def get_value() -> GetImagesInputGetImagesPaginateTypeDef:
return {
"ImageSelectorType": ...,
"StartTimestamp": ...,
"EndTimestamp": ...,
"SamplingInterval": ...,
"Format": ...,
}
# GetImagesInputGetImagesPaginateTypeDef definition
class GetImagesInputGetImagesPaginateTypeDef(TypedDict):
ImageSelectorType: ImageSelectorTypeType, # (1)
StartTimestamp: Union[datetime, str],
EndTimestamp: Union[datetime, str],
SamplingInterval: int,
Format: FormatType, # (2)
StreamName: NotRequired[str],
StreamARN: NotRequired[str],
FormatConfig: NotRequired[Mapping[FormatConfigKeyType, str]], # (3)
WidthPixels: NotRequired[int],
HeightPixels: NotRequired[int],
PaginationConfig: NotRequired[PaginatorConfigTypeDef], # (4)
- See ImageSelectorTypeType
- See FormatType
- See FormatConfigKeyType
- See PaginatorConfigTypeDef
GetImagesInputRequestTypeDef#
# GetImagesInputRequestTypeDef usage example
from mypy_boto3_kinesis_video_archived_media.type_defs import GetImagesInputRequestTypeDef
def get_value() -> GetImagesInputRequestTypeDef:
return {
"ImageSelectorType": ...,
"StartTimestamp": ...,
"EndTimestamp": ...,
"SamplingInterval": ...,
"Format": ...,
}
# GetImagesInputRequestTypeDef definition
class GetImagesInputRequestTypeDef(TypedDict):
ImageSelectorType: ImageSelectorTypeType, # (1)
StartTimestamp: Union[datetime, str],
EndTimestamp: Union[datetime, str],
SamplingInterval: int,
Format: FormatType, # (2)
StreamName: NotRequired[str],
StreamARN: NotRequired[str],
FormatConfig: NotRequired[Mapping[FormatConfigKeyType, str]], # (3)
WidthPixels: NotRequired[int],
HeightPixels: NotRequired[int],
MaxResults: NotRequired[int],
NextToken: NotRequired[str],
- See ImageSelectorTypeType
- See FormatType
- See FormatConfigKeyType
ImageTypeDef#
# ImageTypeDef usage example
from mypy_boto3_kinesis_video_archived_media.type_defs import ImageTypeDef
def get_value() -> ImageTypeDef:
return {
"TimeStamp": ...,
}
# ImageTypeDef definition
class ImageTypeDef(TypedDict):
TimeStamp: NotRequired[datetime],
Error: NotRequired[ImageErrorType], # (1)
ImageContent: NotRequired[str],
- See ImageErrorType
GetMediaForFragmentListInputRequestTypeDef#
# GetMediaForFragmentListInputRequestTypeDef usage example
from mypy_boto3_kinesis_video_archived_media.type_defs import GetMediaForFragmentListInputRequestTypeDef
def get_value() -> GetMediaForFragmentListInputRequestTypeDef:
return {
"Fragments": ...,
}
# GetMediaForFragmentListInputRequestTypeDef definition
class GetMediaForFragmentListInputRequestTypeDef(TypedDict):
Fragments: Sequence[str],
StreamName: NotRequired[str],
StreamARN: NotRequired[str],
GetMediaForFragmentListOutputTypeDef#
# GetMediaForFragmentListOutputTypeDef usage example
from mypy_boto3_kinesis_video_archived_media.type_defs import GetMediaForFragmentListOutputTypeDef
def get_value() -> GetMediaForFragmentListOutputTypeDef:
return {
"ContentType": ...,
"Payload": ...,
"ResponseMetadata": ...,
}
# GetMediaForFragmentListOutputTypeDef definition
class GetMediaForFragmentListOutputTypeDef(TypedDict):
ContentType: str,
Payload: StreamingBody,
ResponseMetadata: ResponseMetadataTypeDef, # (1)
HLSTimestampRangeTypeDef#
# HLSTimestampRangeTypeDef usage example
from mypy_boto3_kinesis_video_archived_media.type_defs import HLSTimestampRangeTypeDef
def get_value() -> HLSTimestampRangeTypeDef:
return {
"StartTimestamp": ...,
}
# HLSTimestampRangeTypeDef definition
class HLSTimestampRangeTypeDef(TypedDict):
StartTimestamp: NotRequired[Union[datetime, str]],
EndTimestamp: NotRequired[Union[datetime, str]],
PaginatorConfigTypeDef#
# PaginatorConfigTypeDef usage example
from mypy_boto3_kinesis_video_archived_media.type_defs import PaginatorConfigTypeDef
def get_value() -> PaginatorConfigTypeDef:
return {
"MaxItems": ...,
}
# PaginatorConfigTypeDef definition
class PaginatorConfigTypeDef(TypedDict):
MaxItems: NotRequired[int],
PageSize: NotRequired[int],
StartingToken: NotRequired[str],
ResponseMetadataTypeDef#
# ResponseMetadataTypeDef usage example
from mypy_boto3_kinesis_video_archived_media.type_defs import ResponseMetadataTypeDef
def get_value() -> ResponseMetadataTypeDef:
return {
"RequestId": ...,
"HostId": ...,
"HTTPStatusCode": ...,
"HTTPHeaders": ...,
"RetryAttempts": ...,
}
# ResponseMetadataTypeDef definition
class ResponseMetadataTypeDef(TypedDict):
RequestId: str,
HostId: str,
HTTPStatusCode: int,
HTTPHeaders: Dict[str, str],
RetryAttempts: int,
ClipFragmentSelectorTypeDef#
# ClipFragmentSelectorTypeDef usage example
from mypy_boto3_kinesis_video_archived_media.type_defs import ClipFragmentSelectorTypeDef
def get_value() -> ClipFragmentSelectorTypeDef:
return {
"FragmentSelectorType": ...,
"TimestampRange": ...,
}
# ClipFragmentSelectorTypeDef definition
class ClipFragmentSelectorTypeDef(TypedDict):
FragmentSelectorType: ClipFragmentSelectorTypeType, # (1)
TimestampRange: ClipTimestampRangeTypeDef, # (2)
DASHFragmentSelectorTypeDef#
# DASHFragmentSelectorTypeDef usage example
from mypy_boto3_kinesis_video_archived_media.type_defs import DASHFragmentSelectorTypeDef
def get_value() -> DASHFragmentSelectorTypeDef:
return {
"FragmentSelectorType": ...,
}
# DASHFragmentSelectorTypeDef definition
class DASHFragmentSelectorTypeDef(TypedDict):
FragmentSelectorType: NotRequired[DASHFragmentSelectorTypeType], # (1)
TimestampRange: NotRequired[DASHTimestampRangeTypeDef], # (2)
FragmentSelectorTypeDef#
# FragmentSelectorTypeDef usage example
from mypy_boto3_kinesis_video_archived_media.type_defs import FragmentSelectorTypeDef
def get_value() -> FragmentSelectorTypeDef:
return {
"FragmentSelectorType": ...,
"TimestampRange": ...,
}
# FragmentSelectorTypeDef definition
class FragmentSelectorTypeDef(TypedDict):
FragmentSelectorType: FragmentSelectorTypeType, # (1)
TimestampRange: TimestampRangeTypeDef, # (2)
ListFragmentsOutputTypeDef#
# ListFragmentsOutputTypeDef usage example
from mypy_boto3_kinesis_video_archived_media.type_defs import ListFragmentsOutputTypeDef
def get_value() -> ListFragmentsOutputTypeDef:
return {
"Fragments": ...,
"NextToken": ...,
"ResponseMetadata": ...,
}
# ListFragmentsOutputTypeDef definition
class ListFragmentsOutputTypeDef(TypedDict):
Fragments: List[FragmentTypeDef], # (1)
NextToken: str,
ResponseMetadata: ResponseMetadataTypeDef, # (2)
GetImagesOutputTypeDef#
# GetImagesOutputTypeDef usage example
from mypy_boto3_kinesis_video_archived_media.type_defs import GetImagesOutputTypeDef
def get_value() -> GetImagesOutputTypeDef:
return {
"Images": ...,
"NextToken": ...,
"ResponseMetadata": ...,
}
# GetImagesOutputTypeDef definition
class GetImagesOutputTypeDef(TypedDict):
Images: List[ImageTypeDef], # (1)
NextToken: str,
ResponseMetadata: ResponseMetadataTypeDef, # (2)
- See ImageTypeDef
- See ResponseMetadataTypeDef
HLSFragmentSelectorTypeDef#
# HLSFragmentSelectorTypeDef usage example
from mypy_boto3_kinesis_video_archived_media.type_defs import HLSFragmentSelectorTypeDef
def get_value() -> HLSFragmentSelectorTypeDef:
return {
"FragmentSelectorType": ...,
}
# HLSFragmentSelectorTypeDef definition
class HLSFragmentSelectorTypeDef(TypedDict):
FragmentSelectorType: NotRequired[HLSFragmentSelectorTypeType], # (1)
TimestampRange: NotRequired[HLSTimestampRangeTypeDef], # (2)
GetClipInputRequestTypeDef#
# GetClipInputRequestTypeDef usage example
from mypy_boto3_kinesis_video_archived_media.type_defs import GetClipInputRequestTypeDef
def get_value() -> GetClipInputRequestTypeDef:
return {
"ClipFragmentSelector": ...,
}
# GetClipInputRequestTypeDef definition
class GetClipInputRequestTypeDef(TypedDict):
ClipFragmentSelector: ClipFragmentSelectorTypeDef, # (1)
StreamName: NotRequired[str],
StreamARN: NotRequired[str],
GetDASHStreamingSessionURLInputRequestTypeDef#
# GetDASHStreamingSessionURLInputRequestTypeDef usage example
from mypy_boto3_kinesis_video_archived_media.type_defs import GetDASHStreamingSessionURLInputRequestTypeDef
def get_value() -> GetDASHStreamingSessionURLInputRequestTypeDef:
return {
"StreamName": ...,
}
# GetDASHStreamingSessionURLInputRequestTypeDef definition
class GetDASHStreamingSessionURLInputRequestTypeDef(TypedDict):
StreamName: NotRequired[str],
StreamARN: NotRequired[str],
PlaybackMode: NotRequired[DASHPlaybackModeType], # (1)
DisplayFragmentTimestamp: NotRequired[DASHDisplayFragmentTimestampType], # (2)
DisplayFragmentNumber: NotRequired[DASHDisplayFragmentNumberType], # (3)
DASHFragmentSelector: NotRequired[DASHFragmentSelectorTypeDef], # (4)
Expires: NotRequired[int],
MaxManifestFragmentResults: NotRequired[int],
- See DASHPlaybackModeType
- See DASHDisplayFragmentTimestampType
- See DASHDisplayFragmentNumberType
- See DASHFragmentSelectorTypeDef
ListFragmentsInputListFragmentsPaginateTypeDef#
# ListFragmentsInputListFragmentsPaginateTypeDef usage example
from mypy_boto3_kinesis_video_archived_media.type_defs import ListFragmentsInputListFragmentsPaginateTypeDef
def get_value() -> ListFragmentsInputListFragmentsPaginateTypeDef:
return {
"StreamName": ...,
}
# ListFragmentsInputListFragmentsPaginateTypeDef definition
class ListFragmentsInputListFragmentsPaginateTypeDef(TypedDict):
StreamName: NotRequired[str],
StreamARN: NotRequired[str],
FragmentSelector: NotRequired[FragmentSelectorTypeDef], # (1)
PaginationConfig: NotRequired[PaginatorConfigTypeDef], # (2)
ListFragmentsInputRequestTypeDef#
# ListFragmentsInputRequestTypeDef usage example
from mypy_boto3_kinesis_video_archived_media.type_defs import ListFragmentsInputRequestTypeDef
def get_value() -> ListFragmentsInputRequestTypeDef:
return {
"StreamName": ...,
}
# ListFragmentsInputRequestTypeDef definition
class ListFragmentsInputRequestTypeDef(TypedDict):
StreamName: NotRequired[str],
StreamARN: NotRequired[str],
MaxResults: NotRequired[int],
NextToken: NotRequired[str],
FragmentSelector: NotRequired[FragmentSelectorTypeDef], # (1)
GetHLSStreamingSessionURLInputRequestTypeDef#
# GetHLSStreamingSessionURLInputRequestTypeDef usage example
from mypy_boto3_kinesis_video_archived_media.type_defs import GetHLSStreamingSessionURLInputRequestTypeDef
def get_value() -> GetHLSStreamingSessionURLInputRequestTypeDef:
return {
"StreamName": ...,
}
# GetHLSStreamingSessionURLInputRequestTypeDef definition
class GetHLSStreamingSessionURLInputRequestTypeDef(TypedDict):
StreamName: NotRequired[str],
StreamARN: NotRequired[str],
PlaybackMode: NotRequired[HLSPlaybackModeType], # (1)
HLSFragmentSelector: NotRequired[HLSFragmentSelectorTypeDef], # (2)
ContainerFormat: NotRequired[ContainerFormatType], # (3)
DiscontinuityMode: NotRequired[HLSDiscontinuityModeType], # (4)
DisplayFragmentTimestamp: NotRequired[HLSDisplayFragmentTimestampType], # (5)
Expires: NotRequired[int],
MaxMediaPlaylistFragmentResults: NotRequired[int],