Skip to content

Type definitions#

Index > KinesisVideoArchivedMedia > Type definitions

Auto-generated documentation for KinesisVideoArchivedMedia type annotations stubs module mypy-boto3-kinesis-video-archived-media.

TimestampTypeDef#

# TimestampTypeDef definition

TimestampTypeDef = Union[
    datetime,
    str,
]

FragmentTypeDef#

# FragmentTypeDef definition

class FragmentTypeDef(TypedDict):
    FragmentNumber: NotRequired[str],
    FragmentSizeInBytes: NotRequired[int],
    ProducerTimestamp: NotRequired[datetime],
    ServerTimestamp: NotRequired[datetime],
    FragmentLengthInMilliseconds: NotRequired[int],

ResponseMetadataTypeDef#

# ResponseMetadataTypeDef definition

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

PaginatorConfigTypeDef#

# PaginatorConfigTypeDef definition

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

ImageTypeDef#

# ImageTypeDef definition

class ImageTypeDef(TypedDict):
    TimeStamp: NotRequired[datetime],
    Error: NotRequired[ImageErrorType],  # (1)
    ImageContent: NotRequired[str],
  1. See ImageErrorType

GetMediaForFragmentListInputRequestTypeDef#

# GetMediaForFragmentListInputRequestTypeDef definition

class GetMediaForFragmentListInputRequestTypeDef(TypedDict):
    Fragments: Sequence[str],
    StreamName: NotRequired[str],
    StreamARN: NotRequired[str],

ClipTimestampRangeTypeDef#

# ClipTimestampRangeTypeDef definition

class ClipTimestampRangeTypeDef(TypedDict):
    StartTimestamp: Union[datetime, str],
    EndTimestamp: Union[datetime, str],

DASHTimestampRangeTypeDef#

# DASHTimestampRangeTypeDef definition

class DASHTimestampRangeTypeDef(TypedDict):
    StartTimestamp: NotRequired[Union[datetime, str]],
    EndTimestamp: NotRequired[Union[datetime, str]],

GetImagesInputRequestTypeDef#

# GetImagesInputRequestTypeDef definition

class GetImagesInputRequestTypeDef(TypedDict):
    ImageSelectorType: ImageSelectorTypeType,  # (1)
    StartTimestamp: Union[datetime, str],
    EndTimestamp: Union[datetime, str],
    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],
  1. See ImageSelectorTypeType
  2. See FormatType
  3. See FormatConfigKeyType

HLSTimestampRangeTypeDef#

# HLSTimestampRangeTypeDef definition

class HLSTimestampRangeTypeDef(TypedDict):
    StartTimestamp: NotRequired[Union[datetime, str]],
    EndTimestamp: NotRequired[Union[datetime, str]],

TimestampRangeTypeDef#

# TimestampRangeTypeDef definition

class TimestampRangeTypeDef(TypedDict):
    StartTimestamp: Union[datetime, str],
    EndTimestamp: Union[datetime, str],

GetClipOutputTypeDef#

# GetClipOutputTypeDef definition

class GetClipOutputTypeDef(TypedDict):
    ContentType: str,
    Payload: StreamingBody,
    ResponseMetadata: ResponseMetadataTypeDef,  # (1)
  1. See ResponseMetadataTypeDef

GetDASHStreamingSessionURLOutputTypeDef#

# GetDASHStreamingSessionURLOutputTypeDef definition

class GetDASHStreamingSessionURLOutputTypeDef(TypedDict):
    DASHStreamingSessionURL: str,
    ResponseMetadata: ResponseMetadataTypeDef,  # (1)
  1. See ResponseMetadataTypeDef

GetHLSStreamingSessionURLOutputTypeDef#

# GetHLSStreamingSessionURLOutputTypeDef definition

class GetHLSStreamingSessionURLOutputTypeDef(TypedDict):
    HLSStreamingSessionURL: str,
    ResponseMetadata: ResponseMetadataTypeDef,  # (1)
  1. See ResponseMetadataTypeDef

GetMediaForFragmentListOutputTypeDef#

# GetMediaForFragmentListOutputTypeDef definition

class GetMediaForFragmentListOutputTypeDef(TypedDict):
    ContentType: str,
    Payload: StreamingBody,
    ResponseMetadata: ResponseMetadataTypeDef,  # (1)
  1. See ResponseMetadataTypeDef

ListFragmentsOutputTypeDef#

# ListFragmentsOutputTypeDef definition

class ListFragmentsOutputTypeDef(TypedDict):
    Fragments: List[FragmentTypeDef],  # (1)
    NextToken: str,
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
  1. See FragmentTypeDef
  2. See ResponseMetadataTypeDef

GetImagesInputGetImagesPaginateTypeDef#

# GetImagesInputGetImagesPaginateTypeDef definition

class GetImagesInputGetImagesPaginateTypeDef(TypedDict):
    ImageSelectorType: ImageSelectorTypeType,  # (1)
    StartTimestamp: Union[datetime, str],
    EndTimestamp: Union[datetime, str],
    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)
  1. See ImageSelectorTypeType
  2. See FormatType
  3. See FormatConfigKeyType
  4. See PaginatorConfigTypeDef

GetImagesOutputTypeDef#

# GetImagesOutputTypeDef definition

class GetImagesOutputTypeDef(TypedDict):
    Images: List[ImageTypeDef],  # (1)
    NextToken: str,
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
  1. See ImageTypeDef
  2. See ResponseMetadataTypeDef

ClipFragmentSelectorTypeDef#

# ClipFragmentSelectorTypeDef definition

class ClipFragmentSelectorTypeDef(TypedDict):
    FragmentSelectorType: ClipFragmentSelectorTypeType,  # (1)
    TimestampRange: ClipTimestampRangeTypeDef,  # (2)
  1. See ClipFragmentSelectorTypeType
  2. See ClipTimestampRangeTypeDef

DASHFragmentSelectorTypeDef#

# DASHFragmentSelectorTypeDef definition

class DASHFragmentSelectorTypeDef(TypedDict):
    FragmentSelectorType: NotRequired[DASHFragmentSelectorTypeType],  # (1)
    TimestampRange: NotRequired[DASHTimestampRangeTypeDef],  # (2)
  1. See DASHFragmentSelectorTypeType
  2. See DASHTimestampRangeTypeDef

HLSFragmentSelectorTypeDef#

# HLSFragmentSelectorTypeDef definition

class HLSFragmentSelectorTypeDef(TypedDict):
    FragmentSelectorType: NotRequired[HLSFragmentSelectorTypeType],  # (1)
    TimestampRange: NotRequired[HLSTimestampRangeTypeDef],  # (2)
  1. See HLSFragmentSelectorTypeType
  2. See HLSTimestampRangeTypeDef

FragmentSelectorTypeDef#

# FragmentSelectorTypeDef definition

class FragmentSelectorTypeDef(TypedDict):
    FragmentSelectorType: FragmentSelectorTypeType,  # (1)
    TimestampRange: TimestampRangeTypeDef,  # (2)
  1. See FragmentSelectorTypeType
  2. See TimestampRangeTypeDef

GetClipInputRequestTypeDef#

# GetClipInputRequestTypeDef definition

class GetClipInputRequestTypeDef(TypedDict):
    ClipFragmentSelector: ClipFragmentSelectorTypeDef,  # (1)
    StreamName: NotRequired[str],
    StreamARN: NotRequired[str],
  1. See ClipFragmentSelectorTypeDef

GetDASHStreamingSessionURLInputRequestTypeDef#

# 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],
  1. See DASHPlaybackModeType
  2. See DASHDisplayFragmentTimestampType
  3. See DASHDisplayFragmentNumberType
  4. See DASHFragmentSelectorTypeDef

GetHLSStreamingSessionURLInputRequestTypeDef#

# 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],
  1. See HLSPlaybackModeType
  2. See HLSFragmentSelectorTypeDef
  3. See ContainerFormatType
  4. See HLSDiscontinuityModeType
  5. See HLSDisplayFragmentTimestampType

ListFragmentsInputListFragmentsPaginateTypeDef#

# ListFragmentsInputListFragmentsPaginateTypeDef definition

class ListFragmentsInputListFragmentsPaginateTypeDef(TypedDict):
    StreamName: NotRequired[str],
    StreamARN: NotRequired[str],
    FragmentSelector: NotRequired[FragmentSelectorTypeDef],  # (1)
    PaginationConfig: NotRequired[PaginatorConfigTypeDef],  # (2)
  1. See FragmentSelectorTypeDef
  2. See PaginatorConfigTypeDef

ListFragmentsInputRequestTypeDef#

# ListFragmentsInputRequestTypeDef definition

class ListFragmentsInputRequestTypeDef(TypedDict):
    StreamName: NotRequired[str],
    StreamARN: NotRequired[str],
    MaxResults: NotRequired[int],
    NextToken: NotRequired[str],
    FragmentSelector: NotRequired[FragmentSelectorTypeDef],  # (1)
  1. See FragmentSelectorTypeDef