Skip to content

get_channel async

get_channel(
    arn: ChannelArn, *, config_overrides: Optional[AsyncivsClientConfig] = None
) -> GetChannelResponse

Gets the channel configuration for the specified channel ARN. See also BatchGetChannel.

Parameters:

  • arn (ChannelArn) –

    ARN of the channel for which the configuration is to be retrieved.

Raises:

Source code in docs_src/capo_ivs/_services/async_ivs.py
async def get_channel(
    self,
    arn: "capo_ivs.types.channel_arn.ChannelArn",
    *,
    config_overrides: Optional[AsyncivsClientConfig] = None,
) -> "capo_ivs.types.get_channel_response.GetChannelResponse":
    """<p>Gets the channel configuration for the specified channel ARN. See also <a>BatchGetChannel</a>.</p>

    Args:
        arn: <p>ARN of the channel for which the configuration is to be retrieved.</p>

    Raises:
        capo_ivs.errors.access_denied_exception.AccessDeniedException: <p>User does not have sufficient access to perform this action.</p>
        capo_ivs.errors.resource_not_found_exception.ResourceNotFoundException: <p>Request references a resource which does not exist.</p>
        capo_ivs.errors.validation_exception.ValidationException: <p>The input fails to satisfy the constraints specified by an Amazon Web Services service.</p>
        capo_ivs.errors.UnknownServiceError: The service returned an error code this client does not model.
    """

    async def _handler(
        req: "AsyncOperationRequest[capo_ivs.types.get_channel_request.GetChannelRequest]",
    ) -> AsyncOperationResponse[
        "capo_ivs.types.get_channel_response.GetChannelResponse"
    ]:
        import capo_ivs._operations.amazon_interactive_video_service.get_channel

        (
            output,
            http_response,
        ) = await capo_ivs._operations.amazon_interactive_video_service.get_channel.async_get_channel(
            req.options, req.input
        )
        return AsyncOperationResponse(output=output, response=http_response)

    def _redact_output(
        output: "capo_ivs.types.get_channel_response.GetChannelResponse",
    ) -> dict[str, Any]:
        import capo_ivs.types.get_channel_response

        return capo_ivs.types.get_channel_response.redact_sensitive(output)

    interceptors_, options_ = self.operation_options(
        config_overrides,
        OperationLogging("GetChannel", redact_output=_redact_output),
    )
    input_: capo_ivs.types.get_channel_request.GetChannelRequest = {"arn": arn}

    response = await aexecute_pipeline(
        AsyncOperationRequest(input=input_, options=options_),
        handler=_handler,
        interceptors=list(interceptors_),
    )
    await response.response.aclose()
    return response.output