Skip to content

describe_channel

describe_channel(
    id: __string, *, config_overrides: Optional[MediaPackageClientConfig] = None
) -> DescribeChannelResponse

Gets details about a Channel.

Parameters:

  • id (__string) –

    The ID of a Channel.

Raises:

Source code in docs_src/capo_mediapackage/_services/media_package.py
def describe_channel(
    self,
    id: "capo_mediapackage.types.__string.__string",
    *,
    config_overrides: Optional[MediaPackageClientConfig] = None,
) -> "capo_mediapackage.types.describe_channel_response.DescribeChannelResponse":
    """Gets details about a Channel.

    Args:
        id: The ID of a Channel.

    Raises:
        capo_mediapackage.errors.forbidden_exception.ForbiddenException: The client is not authorized to access the requested resource.
        capo_mediapackage.errors.internal_server_error_exception.InternalServerErrorException: An unexpected error occurred.
        capo_mediapackage.errors.not_found_exception.NotFoundException: The requested resource does not exist.
        capo_mediapackage.errors.service_unavailable_exception.ServiceUnavailableException: An unexpected error occurred.
        capo_mediapackage.errors.too_many_requests_exception.TooManyRequestsException: The client has exceeded their resource or throttling limits.
        capo_mediapackage.errors.unprocessable_entity_exception.UnprocessableEntityException: The parameters sent in the request are not valid.
        capo_mediapackage.errors.UnknownServiceError: The service returned an error code this client does not model.
    """

    def _handler(
        req: "OperationRequest[capo_mediapackage.types.describe_channel_request.DescribeChannelRequest]",
    ) -> OperationResponse[
        "capo_mediapackage.types.describe_channel_response.DescribeChannelResponse"
    ]:
        import capo_mediapackage._operations.media_package.describe_channel

        output, http_response = (
            capo_mediapackage._operations.media_package.describe_channel.describe_channel(
                req.options, req.input
            )
        )
        return OperationResponse(output=output, response=http_response)

    def _redact_output(
        output: "capo_mediapackage.types.describe_channel_response.DescribeChannelResponse",
    ) -> dict[str, Any]:
        import capo_mediapackage.types.describe_channel_response

        return capo_mediapackage.types.describe_channel_response.redact_sensitive(
            output
        )

    interceptors_, options_ = self.operation_options(
        config_overrides,
        OperationLogging("DescribeChannel", redact_output=_redact_output),
    )
    input_: capo_mediapackage.types.describe_channel_request.DescribeChannelRequest = {
        "id": id
    }

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