MediaLive / Client / describe_thumbnails

describe_thumbnails#

MediaLive.Client.describe_thumbnails(**kwargs)#

Describe the latest thumbnails data.

Request Syntax

response = client.describe_thumbnails(
    ChannelId='string',
    PipelineId='string',
    ThumbnailType='string'
)

Parameters:

ChannelId (string) – [REQUIRED] Unique ID of the channel
PipelineId (string) – [REQUIRED] Pipeline ID (“0” or “1”)
ThumbnailType (string) – [REQUIRED] thumbnail type

Return type:

dict

Returns:

Response Syntax

{
    'ThumbnailDetails': [
        {
            'PipelineId': 'string',
            'Thumbnails': [
                {
                    'Body': 'string',
                    'ContentType': 'string',
                    'ThumbnailType': 'UNSPECIFIED'|'CURRENT_ACTIVE',
                    'TimeStamp': datetime(2015, 1, 1)
                },
            ]
        },
    ]
}

Response Structure

(dict) – An array of thumbnails for the channel. Each member contains the thumbnail data for one pipeline.
- ThumbnailDetails (list) – Placeholder documentation for __listOfThumbnailDetail
  - (dict) – Thumbnail details for one pipeline of a running channel.
    - PipelineId (string) – Pipeline ID
    - Thumbnails (list) – thumbnails of a single pipeline
      - (dict) – Details of a single thumbnail
        
        Body (string) – The binary data for the latest thumbnail.
        
        ContentType (string) – The content type for the latest thumbnail.
        
        ThumbnailType (string) – Thumbnail Type
        
        TimeStamp (datetime) – Time stamp for the latest thumbnail.

Exceptions

MediaLive.Client.exceptions.BadRequestException
MediaLive.Client.exceptions.InternalServerErrorException
MediaLive.Client.exceptions.ForbiddenException
MediaLive.Client.exceptions.BadGatewayException
MediaLive.Client.exceptions.NotFoundException
MediaLive.Client.exceptions.GatewayTimeoutException
MediaLive.Client.exceptions.TooManyRequestsException
MediaLive.Client.exceptions.ConflictException