KinesisVideoArchivedMediaClient

Index > KinesisVideoArchivedMedia > KinesisVideoArchivedMediaClient

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

KinesisVideoArchivedMediaClient

Type annotations and code completion for boto3.client("kinesis-video-archived-media"). boto3 documentation

# KinesisVideoArchivedMediaClient usage example

from boto3.session import Session
from mypy_boto3_kinesis_video_archived_media.client import KinesisVideoArchivedMediaClient

def get_kinesis-video-archived-media_client() -> KinesisVideoArchivedMediaClient:
    return Session().client("kinesis-video-archived-media")

Exceptions

boto3 client exceptions are generated in runtime. This class provides code completion for boto3.client("kinesis-video-archived-media").exceptions structure.

# Exceptions.exceptions usage example

client = boto3.client("kinesis-video-archived-media")

try:
    do_something(client)
except (
    client.exceptions.ClientError,
    client.exceptions.ClientLimitExceededException,
    client.exceptions.InvalidArgumentException,
    client.exceptions.InvalidCodecPrivateDataException,
    client.exceptions.InvalidMediaFrameException,
    client.exceptions.MissingCodecPrivateDataException,
    client.exceptions.NoDataRetentionException,
    client.exceptions.NotAuthorizedException,
    client.exceptions.ResourceNotFoundException,
    client.exceptions.UnsupportedStreamMediaTypeException,
) as e:
    print(e)

# Exceptions.exceptions type checking example

from mypy_boto3_kinesis_video_archived_media.client import Exceptions

def handle_error(exc: Exceptions.ClientError) -> None:
    ...

Methods

can_paginate

Check if an operation can be paginated.

Type annotations and code completion for boto3.client("kinesis-video-archived-media").can_paginate method. boto3 documentation

# can_paginate method definition

def can_paginate(
    self,
    operation_name: str,
) -> bool:
    ...

close

Closes underlying endpoint connections.

Type annotations and code completion for boto3.client("kinesis-video-archived-media").close method. boto3 documentation

# close method definition

def close(
    self,
) -> None:
    ...

generate_presigned_url

Generate a presigned url given a client, its method, and arguments.

Type annotations and code completion for boto3.client("kinesis-video-archived-media").generate_presigned_url method. boto3 documentation

# generate_presigned_url method definition

def generate_presigned_url(
    self,
    ClientMethod: str,
    Params: Mapping[str, Any] = ...,
    ExpiresIn: int = 3600,
    HttpMethod: str = ...,
) -> str:
    ...

get_clip

Downloads an MP4 file (clip) containing the archived, on-demand media from the specified video stream over the specified time range.

Type annotations and code completion for boto3.client("kinesis-video-archived-media").get_clip method. boto3 documentation

# get_clip method definition

def get_clip(
    self,
    *,
    ClipFragmentSelector: ClipFragmentSelectorTypeDef,  # (1)
    StreamName: str = ...,
    StreamARN: str = ...,
) -> GetClipOutputTypeDef:  # (2)
    ...

1. See ClipFragmentSelectorTypeDef
2. See GetClipOutputTypeDef

# get_clip method usage example with argument unpacking

kwargs: GetClipInputRequestTypeDef = {  # (1)
    "ClipFragmentSelector": ...,
}

parent.get_clip(**kwargs)

1. See GetClipInputRequestTypeDef

get_dash_streaming_session_url

Retrieves an MPEG Dynamic Adaptive Streaming over HTTP (DASH) URL for the stream.

Type annotations and code completion for boto3.client("kinesis-video-archived-media").get_dash_streaming_session_url method. boto3 documentation

# get_dash_streaming_session_url method definition

def get_dash_streaming_session_url(
    self,
    *,
    StreamName: str = ...,
    StreamARN: str = ...,
    PlaybackMode: DASHPlaybackModeType = ...,  # (1)
    DisplayFragmentTimestamp: DASHDisplayFragmentTimestampType = ...,  # (2)
    DisplayFragmentNumber: DASHDisplayFragmentNumberType = ...,  # (3)
    DASHFragmentSelector: DASHFragmentSelectorTypeDef = ...,  # (4)
    Expires: int = ...,
    MaxManifestFragmentResults: int = ...,
) -> GetDASHStreamingSessionURLOutputTypeDef:  # (5)
    ...

1. See DASHPlaybackModeType
2. See DASHDisplayFragmentTimestampType
3. See DASHDisplayFragmentNumberType
4. See DASHFragmentSelectorTypeDef
5. See GetDASHStreamingSessionURLOutputTypeDef

# get_dash_streaming_session_url method usage example with argument unpacking

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

parent.get_dash_streaming_session_url(**kwargs)

1. See GetDASHStreamingSessionURLInputRequestTypeDef

get_hls_streaming_session_url

Retrieves an HTTP Live Streaming (HLS) URL for the stream.

Type annotations and code completion for boto3.client("kinesis-video-archived-media").get_hls_streaming_session_url method. boto3 documentation

# get_hls_streaming_session_url method definition

def get_hls_streaming_session_url(
    self,
    *,
    StreamName: str = ...,
    StreamARN: str = ...,
    PlaybackMode: HLSPlaybackModeType = ...,  # (1)
    HLSFragmentSelector: HLSFragmentSelectorTypeDef = ...,  # (2)
    ContainerFormat: ContainerFormatType = ...,  # (3)
    DiscontinuityMode: HLSDiscontinuityModeType = ...,  # (4)
    DisplayFragmentTimestamp: HLSDisplayFragmentTimestampType = ...,  # (5)
    Expires: int = ...,
    MaxMediaPlaylistFragmentResults: int = ...,
) -> GetHLSStreamingSessionURLOutputTypeDef:  # (6)
    ...

1. See HLSPlaybackModeType
2. See HLSFragmentSelectorTypeDef
3. See ContainerFormatType
4. See HLSDiscontinuityModeType
5. See HLSDisplayFragmentTimestampType
6. See GetHLSStreamingSessionURLOutputTypeDef

# get_hls_streaming_session_url method usage example with argument unpacking

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

parent.get_hls_streaming_session_url(**kwargs)

1. See GetHLSStreamingSessionURLInputRequestTypeDef

get_images

Retrieves a list of images corresponding to each timestamp for a given time range, sampling interval, and image format configuration.

Type annotations and code completion for boto3.client("kinesis-video-archived-media").get_images method. boto3 documentation

# get_images method definition

def get_images(
    self,
    *,
    ImageSelectorType: ImageSelectorTypeType,  # (1)
    StartTimestamp: TimestampTypeDef,
    EndTimestamp: TimestampTypeDef,
    Format: FormatType,  # (2)
    StreamName: str = ...,
    StreamARN: str = ...,
    SamplingInterval: int = ...,
    FormatConfig: Mapping[FormatConfigKeyType, str] = ...,  # (3)
    WidthPixels: int = ...,
    HeightPixels: int = ...,
    MaxResults: int = ...,
    NextToken: str = ...,
) -> GetImagesOutputTypeDef:  # (4)
    ...

1. See ImageSelectorTypeType
2. See FormatType
3. See FormatConfigKeyType
4. See GetImagesOutputTypeDef

# get_images method usage example with argument unpacking

kwargs: GetImagesInputRequestTypeDef = {  # (1)
    "ImageSelectorType": ...,
    "StartTimestamp": ...,
    "EndTimestamp": ...,
    "Format": ...,
}

parent.get_images(**kwargs)

1. See GetImagesInputRequestTypeDef

get_media_for_fragment_list

Gets media for a list of fragments (specified by fragment number) from the archived data in an Amazon Kinesis video stream.

Type annotations and code completion for boto3.client("kinesis-video-archived-media").get_media_for_fragment_list method. boto3 documentation

# get_media_for_fragment_list method definition

def get_media_for_fragment_list(
    self,
    *,
    Fragments: Sequence[str],
    StreamName: str = ...,
    StreamARN: str = ...,
) -> GetMediaForFragmentListOutputTypeDef:  # (1)
    ...

1. See GetMediaForFragmentListOutputTypeDef

# get_media_for_fragment_list method usage example with argument unpacking

kwargs: GetMediaForFragmentListInputRequestTypeDef = {  # (1)
    "Fragments": ...,
}

parent.get_media_for_fragment_list(**kwargs)

1. See GetMediaForFragmentListInputRequestTypeDef

list_fragments

Returns a list of Fragment objects from the specified stream and timestamp range within the archived data.

Type annotations and code completion for boto3.client("kinesis-video-archived-media").list_fragments method. boto3 documentation

# list_fragments method definition

def list_fragments(
    self,
    *,
    StreamName: str = ...,
    StreamARN: str = ...,
    MaxResults: int = ...,
    NextToken: str = ...,
    FragmentSelector: FragmentSelectorTypeDef = ...,  # (1)
) -> ListFragmentsOutputTypeDef:  # (2)
    ...

1. See FragmentSelectorTypeDef
2. See ListFragmentsOutputTypeDef

# list_fragments method usage example with argument unpacking

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

parent.list_fragments(**kwargs)

1. See ListFragmentsInputRequestTypeDef

get_paginator

Type annotations and code completion for boto3.client("kinesis-video-archived-media").get_paginator method with overloads.

• client.get_paginator("get_images") -> GetImagesPaginator
• client.get_paginator("list_fragments") -> ListFragmentsPaginator