Type definitions#
Index > KinesisVideoArchivedMedia > Type definitions
Auto-generated documentation for KinesisVideoArchivedMedia type annotations stubs module mypy-boto3-kinesis-video-archived-media.
TimestampTypeDef#
# TimestampTypeDef Union usage example
from mypy_boto3_kinesis_video_archived_media.type_defs import TimestampTypeDef
def get_value() -> TimestampTypeDef:
return ...
# TimestampTypeDef definition
TimestampTypeDef = Union[
datetime.datetime,
str,
]
FragmentTypeDef#
# FragmentTypeDef TypedDict 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.datetime],
ServerTimestamp: NotRequired[datetime.datetime],
FragmentLengthInMilliseconds: NotRequired[int],
ResponseMetadataTypeDef#
# ResponseMetadataTypeDef TypedDict usage example
from mypy_boto3_kinesis_video_archived_media.type_defs import ResponseMetadataTypeDef
def get_value() -> ResponseMetadataTypeDef:
return {
"RequestId": ...,
}
# ResponseMetadataTypeDef definition
class ResponseMetadataTypeDef(TypedDict):
RequestId: str,
HTTPStatusCode: int,
HTTPHeaders: Dict[str, str],
RetryAttempts: int,
HostId: NotRequired[str],
PaginatorConfigTypeDef#
# PaginatorConfigTypeDef TypedDict 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],
ImageTypeDef#
# ImageTypeDef TypedDict 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.datetime],
Error: NotRequired[ImageErrorType], # (1)
ImageContent: NotRequired[str],
- See ImageErrorType
GetMediaForFragmentListInputTypeDef#
# GetMediaForFragmentListInputTypeDef TypedDict usage example
from mypy_boto3_kinesis_video_archived_media.type_defs import GetMediaForFragmentListInputTypeDef
def get_value() -> GetMediaForFragmentListInputTypeDef:
return {
"Fragments": ...,
}
# GetMediaForFragmentListInputTypeDef definition
class GetMediaForFragmentListInputTypeDef(TypedDict):
Fragments: Sequence[str],
StreamName: NotRequired[str],
StreamARN: NotRequired[str],
ClipTimestampRangeTypeDef#
# ClipTimestampRangeTypeDef TypedDict usage example
from mypy_boto3_kinesis_video_archived_media.type_defs import ClipTimestampRangeTypeDef
def get_value() -> ClipTimestampRangeTypeDef:
return {
"StartTimestamp": ...,
}
# ClipTimestampRangeTypeDef definition
class ClipTimestampRangeTypeDef(TypedDict):
StartTimestamp: TimestampTypeDef,
EndTimestamp: TimestampTypeDef,
DASHTimestampRangeTypeDef#
# DASHTimestampRangeTypeDef TypedDict 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[TimestampTypeDef],
EndTimestamp: NotRequired[TimestampTypeDef],
GetImagesInputTypeDef#
# GetImagesInputTypeDef TypedDict usage example
from mypy_boto3_kinesis_video_archived_media.type_defs import GetImagesInputTypeDef
def get_value() -> GetImagesInputTypeDef:
return {
"ImageSelectorType": ...,
}
# GetImagesInputTypeDef definition
class GetImagesInputTypeDef(TypedDict):
ImageSelectorType: ImageSelectorTypeType, # (1)
StartTimestamp: TimestampTypeDef,
EndTimestamp: TimestampTypeDef,
Format: FormatType, # (2)
StreamName: NotRequired[str],
StreamARN: NotRequired[str],
SamplingInterval: NotRequired[int],
FormatConfig: NotRequired[Mapping[FormatConfigKeyType, str]], # (3)
WidthPixels: NotRequired[int],
HeightPixels: NotRequired[int],
MaxResults: NotRequired[int],
NextToken: NotRequired[str],
- See ImageSelectorTypeType
- See FormatType
- See
Mapping[Literal['JPEGQuality'], str]
HLSTimestampRangeTypeDef#
# HLSTimestampRangeTypeDef TypedDict 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[TimestampTypeDef],
EndTimestamp: NotRequired[TimestampTypeDef],
TimestampRangeTypeDef#
# TimestampRangeTypeDef TypedDict usage example
from mypy_boto3_kinesis_video_archived_media.type_defs import TimestampRangeTypeDef
def get_value() -> TimestampRangeTypeDef:
return {
"StartTimestamp": ...,
}
# TimestampRangeTypeDef definition
class TimestampRangeTypeDef(TypedDict):
StartTimestamp: TimestampTypeDef,
EndTimestamp: TimestampTypeDef,
GetClipOutputTypeDef#
# GetClipOutputTypeDef TypedDict usage example
from mypy_boto3_kinesis_video_archived_media.type_defs import GetClipOutputTypeDef
def get_value() -> GetClipOutputTypeDef:
return {
"ContentType": ...,
}
# GetClipOutputTypeDef definition
class GetClipOutputTypeDef(TypedDict):
ContentType: str,
Payload: botocore.response.StreamingBody,
ResponseMetadata: ResponseMetadataTypeDef, # (1)
GetDASHStreamingSessionURLOutputTypeDef#
# GetDASHStreamingSessionURLOutputTypeDef TypedDict usage example
from mypy_boto3_kinesis_video_archived_media.type_defs import GetDASHStreamingSessionURLOutputTypeDef
def get_value() -> GetDASHStreamingSessionURLOutputTypeDef:
return {
"DASHStreamingSessionURL": ...,
}
# GetDASHStreamingSessionURLOutputTypeDef definition
class GetDASHStreamingSessionURLOutputTypeDef(TypedDict):
DASHStreamingSessionURL: str,
ResponseMetadata: ResponseMetadataTypeDef, # (1)
GetHLSStreamingSessionURLOutputTypeDef#
# GetHLSStreamingSessionURLOutputTypeDef TypedDict usage example
from mypy_boto3_kinesis_video_archived_media.type_defs import GetHLSStreamingSessionURLOutputTypeDef
def get_value() -> GetHLSStreamingSessionURLOutputTypeDef:
return {
"HLSStreamingSessionURL": ...,
}
# GetHLSStreamingSessionURLOutputTypeDef definition
class GetHLSStreamingSessionURLOutputTypeDef(TypedDict):
HLSStreamingSessionURL: str,
ResponseMetadata: ResponseMetadataTypeDef, # (1)
GetMediaForFragmentListOutputTypeDef#
# GetMediaForFragmentListOutputTypeDef TypedDict usage example
from mypy_boto3_kinesis_video_archived_media.type_defs import GetMediaForFragmentListOutputTypeDef
def get_value() -> GetMediaForFragmentListOutputTypeDef:
return {
"ContentType": ...,
}
# GetMediaForFragmentListOutputTypeDef definition
class GetMediaForFragmentListOutputTypeDef(TypedDict):
ContentType: str,
Payload: botocore.response.StreamingBody,
ResponseMetadata: ResponseMetadataTypeDef, # (1)
ListFragmentsOutputTypeDef#
# ListFragmentsOutputTypeDef TypedDict usage example
from mypy_boto3_kinesis_video_archived_media.type_defs import ListFragmentsOutputTypeDef
def get_value() -> ListFragmentsOutputTypeDef:
return {
"Fragments": ...,
}
# ListFragmentsOutputTypeDef definition
class ListFragmentsOutputTypeDef(TypedDict):
Fragments: List[FragmentTypeDef], # (1)
ResponseMetadata: ResponseMetadataTypeDef, # (2)
NextToken: NotRequired[str],
- See
List[FragmentTypeDef]
- See ResponseMetadataTypeDef
GetImagesInputPaginateTypeDef#
# GetImagesInputPaginateTypeDef TypedDict usage example
from mypy_boto3_kinesis_video_archived_media.type_defs import GetImagesInputPaginateTypeDef
def get_value() -> GetImagesInputPaginateTypeDef:
return {
"ImageSelectorType": ...,
}
# GetImagesInputPaginateTypeDef definition
class GetImagesInputPaginateTypeDef(TypedDict):
ImageSelectorType: ImageSelectorTypeType, # (1)
StartTimestamp: TimestampTypeDef,
EndTimestamp: TimestampTypeDef,
Format: FormatType, # (2)
StreamName: NotRequired[str],
StreamARN: NotRequired[str],
SamplingInterval: NotRequired[int],
FormatConfig: NotRequired[Mapping[FormatConfigKeyType, str]], # (3)
WidthPixels: NotRequired[int],
HeightPixels: NotRequired[int],
PaginationConfig: NotRequired[PaginatorConfigTypeDef], # (4)
- See ImageSelectorTypeType
- See FormatType
- See
Mapping[Literal['JPEGQuality'], str]
- See PaginatorConfigTypeDef
GetImagesOutputTypeDef#
# GetImagesOutputTypeDef TypedDict usage example
from mypy_boto3_kinesis_video_archived_media.type_defs import GetImagesOutputTypeDef
def get_value() -> GetImagesOutputTypeDef:
return {
"Images": ...,
}
# GetImagesOutputTypeDef definition
class GetImagesOutputTypeDef(TypedDict):
Images: List[ImageTypeDef], # (1)
ResponseMetadata: ResponseMetadataTypeDef, # (2)
NextToken: NotRequired[str],
- See
List[ImageTypeDef]
- See ResponseMetadataTypeDef
ClipFragmentSelectorTypeDef#
# ClipFragmentSelectorTypeDef TypedDict usage example
from mypy_boto3_kinesis_video_archived_media.type_defs import ClipFragmentSelectorTypeDef
def get_value() -> ClipFragmentSelectorTypeDef:
return {
"FragmentSelectorType": ...,
}
# ClipFragmentSelectorTypeDef definition
class ClipFragmentSelectorTypeDef(TypedDict):
FragmentSelectorType: ClipFragmentSelectorTypeType, # (1)
TimestampRange: ClipTimestampRangeTypeDef, # (2)
DASHFragmentSelectorTypeDef#
# DASHFragmentSelectorTypeDef TypedDict 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)
HLSFragmentSelectorTypeDef#
# HLSFragmentSelectorTypeDef TypedDict 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)
FragmentSelectorTypeDef#
# FragmentSelectorTypeDef TypedDict usage example
from mypy_boto3_kinesis_video_archived_media.type_defs import FragmentSelectorTypeDef
def get_value() -> FragmentSelectorTypeDef:
return {
"FragmentSelectorType": ...,
}
# FragmentSelectorTypeDef definition
class FragmentSelectorTypeDef(TypedDict):
FragmentSelectorType: FragmentSelectorTypeType, # (1)
TimestampRange: TimestampRangeTypeDef, # (2)
GetClipInputTypeDef#
# GetClipInputTypeDef TypedDict usage example
from mypy_boto3_kinesis_video_archived_media.type_defs import GetClipInputTypeDef
def get_value() -> GetClipInputTypeDef:
return {
"ClipFragmentSelector": ...,
}
# GetClipInputTypeDef definition
class GetClipInputTypeDef(TypedDict):
ClipFragmentSelector: ClipFragmentSelectorTypeDef, # (1)
StreamName: NotRequired[str],
StreamARN: NotRequired[str],
GetDASHStreamingSessionURLInputTypeDef#
# GetDASHStreamingSessionURLInputTypeDef TypedDict usage example
from mypy_boto3_kinesis_video_archived_media.type_defs import GetDASHStreamingSessionURLInputTypeDef
def get_value() -> GetDASHStreamingSessionURLInputTypeDef:
return {
"StreamName": ...,
}
# GetDASHStreamingSessionURLInputTypeDef definition
class GetDASHStreamingSessionURLInputTypeDef(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
GetHLSStreamingSessionURLInputTypeDef#
# GetHLSStreamingSessionURLInputTypeDef TypedDict usage example
from mypy_boto3_kinesis_video_archived_media.type_defs import GetHLSStreamingSessionURLInputTypeDef
def get_value() -> GetHLSStreamingSessionURLInputTypeDef:
return {
"StreamName": ...,
}
# GetHLSStreamingSessionURLInputTypeDef definition
class GetHLSStreamingSessionURLInputTypeDef(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],
- See HLSPlaybackModeType
- See HLSFragmentSelectorTypeDef
- See ContainerFormatType
- See HLSDiscontinuityModeType
- See HLSDisplayFragmentTimestampType
ListFragmentsInputPaginateTypeDef#
# ListFragmentsInputPaginateTypeDef TypedDict usage example
from mypy_boto3_kinesis_video_archived_media.type_defs import ListFragmentsInputPaginateTypeDef
def get_value() -> ListFragmentsInputPaginateTypeDef:
return {
"StreamName": ...,
}
# ListFragmentsInputPaginateTypeDef definition
class ListFragmentsInputPaginateTypeDef(TypedDict):
StreamName: NotRequired[str],
StreamARN: NotRequired[str],
FragmentSelector: NotRequired[FragmentSelectorTypeDef], # (1)
PaginationConfig: NotRequired[PaginatorConfigTypeDef], # (2)
ListFragmentsInputTypeDef#
# ListFragmentsInputTypeDef TypedDict usage example
from mypy_boto3_kinesis_video_archived_media.type_defs import ListFragmentsInputTypeDef
def get_value() -> ListFragmentsInputTypeDef:
return {
"StreamName": ...,
}
# ListFragmentsInputTypeDef definition
class ListFragmentsInputTypeDef(TypedDict):
StreamName: NotRequired[str],
StreamARN: NotRequired[str],
MaxResults: NotRequired[int],
NextToken: NotRequired[str],
FragmentSelector: NotRequired[FragmentSelectorTypeDef], # (1)