Skip to content

get_channel

get_channel(
    space_id: SpaceId,
    channel_id: ChannelId,
    *,
    config_overrides: Optional[repostspaceClientConfig] = None,
) -> GetChannelOutput

Displays information about a channel in a private re:Post.

Parameters:

  • space_id (SpaceId) –

    The unique ID of the private re:Post.

  • channel_id (ChannelId) –

    The unique ID of the private re:Post channel.

Raises:

Examples:

GetChannel

>>> client.get_channel(space_id='SP1234567890abcdefghijkl', channel_id='WS1234567890abcdefghijkl')
Source code in docs_src/capo_repostspace/_services/repostspace.py
def get_channel(
    self,
    space_id: "capo_repostspace.types.space_id.SpaceId",
    channel_id: "capo_repostspace.types.channel_id.ChannelId",
    *,
    config_overrides: Optional[repostspaceClientConfig] = None,
) -> "capo_repostspace.types.get_channel_output.GetChannelOutput":
    """<p>Displays information about a channel in a private re:Post.</p>

    Args:
        space_id: <p>The unique ID of the private re:Post.</p>
        channel_id: <p>The unique ID of the private re:Post channel.</p>

    Raises:
        capo_repostspace.errors.access_denied_exception.AccessDeniedException: <p>User does not have sufficient access to perform this action.</p>
        capo_repostspace.errors.internal_server_exception.InternalServerException: <p>Unexpected error during processing of request.</p>
        capo_repostspace.errors.resource_not_found_exception.ResourceNotFoundException: <p>Request references a resource which does not exist.</p>
        capo_repostspace.errors.throttling_exception.ThrottlingException: <p>Request was denied due to request throttling.</p>
        capo_repostspace.errors.validation_exception.ValidationException: <p>The input fails to satisfy the constraints specified by an AWS service.</p>
        capo_repostspace.errors.UnknownServiceError: The service returned an error code this client does not model.

    Examples:
        GetChannel

        >>> client.get_channel(space_id='SP1234567890abcdefghijkl', channel_id='WS1234567890abcdefghijkl')
    """

    def _handler(
        req: "OperationRequest[capo_repostspace.types.get_channel_input.GetChannelInput]",
    ) -> OperationResponse[
        "capo_repostspace.types.get_channel_output.GetChannelOutput"
    ]:
        import capo_repostspace._operations.repost_space.get_channel

        output, http_response = (
            capo_repostspace._operations.repost_space.get_channel.get_channel(
                req.options, req.input
            )
        )
        return OperationResponse(output=output, response=http_response)

    def _redact_output(
        output: "capo_repostspace.types.get_channel_output.GetChannelOutput",
    ) -> dict[str, Any]:
        import capo_repostspace.types.get_channel_output

        return capo_repostspace.types.get_channel_output.redact_sensitive(output)

    interceptors_, options_ = self.operation_options(
        config_overrides,
        OperationLogging("GetChannel", redact_output=_redact_output),
    )
    input_: capo_repostspace.types.get_channel_input.GetChannelInput = {
        "space_id": space_id,
        "channel_id": channel_id,
    }

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