Skip to content

describe_program

describe_program(
    channel_name: __string,
    program_name: __string,
    *,
    config_overrides: Optional[MediaTailorClientConfig] = None,
) -> DescribeProgramResponse

Describes a program within a channel. For information about programs, see Working with programs in the MediaTailor User Guide.

Parameters:

  • channel_name (__string) –

    The name of the channel associated with this Program.

  • program_name (__string) –

    The name of the program.

Raises:

Source code in docs_src/capo_mediatailor/_services/media_tailor.py
def describe_program(
    self,
    channel_name: "capo_mediatailor.types.__string.__string",
    program_name: "capo_mediatailor.types.__string.__string",
    *,
    config_overrides: Optional[MediaTailorClientConfig] = None,
) -> "capo_mediatailor.types.describe_program_response.DescribeProgramResponse":
    """<p>Describes a program within a channel. For information about programs, see <a href="https://docs.aws.amazon.com/mediatailor/latest/ug/channel-assembly-programs.html">Working with programs</a> in the <i>MediaTailor User Guide</i>.</p>

    Args:
        channel_name: <p>The name of the channel associated with this Program.</p>
        program_name: <p>The name of the program.</p>

    Raises:
        capo_mediatailor.errors.UnknownServiceError: The service returned an error code this client does not model.
    """

    def _handler(
        req: "OperationRequest[capo_mediatailor.types.describe_program_request.DescribeProgramRequest]",
    ) -> OperationResponse[
        "capo_mediatailor.types.describe_program_response.DescribeProgramResponse"
    ]:
        import capo_mediatailor._operations.media_tailor.describe_program

        output, http_response = (
            capo_mediatailor._operations.media_tailor.describe_program.describe_program(
                req.options, req.input
            )
        )
        return OperationResponse(output=output, response=http_response)

    interceptors_, options_ = self.operation_options(
        config_overrides, OperationLogging("DescribeProgram")
    )
    input_: capo_mediatailor.types.describe_program_request.DescribeProgramRequest = {
        "channel_name": channel_name,
        "program_name": program_name,
    }

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