Skip to content

describe_thumbnails 

describe_thumbnails(
    channel_id: __string,
    *,
    config_overrides: Optional[MediaLiveClientConfig] = None,
    pipeline_id: Optional[__string] = None,
    thumbnail_type: Optional[__string] = None,
) -> DescribeThumbnailsResponse

Describe the latest thumbnails data.

Parameters:

  • channel_id (__string) –

    Unique ID of the channel

  • pipeline_id (Optional[__string], default: None ) –

    Pipeline ID ("0" or "1")

  • thumbnail_type (Optional[__string], default: None ) –

    thumbnail type

Raises:

Source code in docs_src/capo_medialive/_services/media_live.py 
4140
4141
4142
4143
4144
4145
4146
4147
4148
4149
4150
4151
4152
4153
4154
4155
4156
4157
4158
4159
4160
4161
4162
4163
4164
4165
4166
4167
4168
4169
4170
4171
4172
4173
4174
4175
4176
4177
4178
4179
4180
4181
4182
4183
4184
4185
4186
4187
4188
4189
4190
4191
4192
4193
4194
4195
4196
4197
4198
def describe_thumbnails(
    self,
    channel_id: "capo_medialive.types.__string.__string",
    *,
    config_overrides: Optional[MediaLiveClientConfig] = None,
    pipeline_id: Optional["capo_medialive.types.__string.__string"] = None,
    thumbnail_type: Optional["capo_medialive.types.__string.__string"] = None,
) -> "capo_medialive.types.describe_thumbnails_response.DescribeThumbnailsResponse":
    """Describe the latest thumbnails data.

    Args:
        channel_id: Unique ID of the channel
        pipeline_id: Pipeline ID ("0" or "1")
        thumbnail_type: thumbnail type

    Raises:
        capo_medialive.errors.bad_gateway_exception.BadGatewayException: Placeholder documentation for BadGatewayException
        capo_medialive.errors.bad_request_exception.BadRequestException: Placeholder documentation for BadRequestException
        capo_medialive.errors.conflict_exception.ConflictException: Placeholder documentation for ConflictException
        capo_medialive.errors.forbidden_exception.ForbiddenException: Placeholder documentation for ForbiddenException
        capo_medialive.errors.gateway_timeout_exception.GatewayTimeoutException: Placeholder documentation for GatewayTimeoutException
        capo_medialive.errors.internal_server_error_exception.InternalServerErrorException: Placeholder documentation for InternalServerErrorException
        capo_medialive.errors.not_found_exception.NotFoundException: Placeholder documentation for NotFoundException
        capo_medialive.errors.too_many_requests_exception.TooManyRequestsException: Placeholder documentation for TooManyRequestsException
        capo_medialive.errors.UnknownServiceError: The service returned an error code this client does not model.
    """

    def _handler(
        req: "OperationRequest[capo_medialive.types.describe_thumbnails_request.DescribeThumbnailsRequest]",
    ) -> OperationResponse[
        "capo_medialive.types.describe_thumbnails_response.DescribeThumbnailsResponse"
    ]:
        import capo_medialive._operations.media_live.describe_thumbnails

        output, http_response = (
            capo_medialive._operations.media_live.describe_thumbnails.describe_thumbnails(
                req.options, req.input
            )
        )
        return OperationResponse(output=output, response=http_response)

    interceptors_, options_ = self.operation_options(
        config_overrides, OperationLogging("DescribeThumbnails")
    )
    input_: capo_medialive.types.describe_thumbnails_request.DescribeThumbnailsRequest = {
        "channel_id": channel_id
    }
    if pipeline_id is not None:
        input_["pipeline_id"] = pipeline_id
    if thumbnail_type is not None:
        input_["thumbnail_type"] = thumbnail_type

    response = execute_pipeline(
        OperationRequest(input=input_, options=options_),
        handler=_handler,
        interceptors=list(interceptors_),
    )
    response.response.close()
    return response.output