list_sub_channels ¶

def list_sub_channels(
    self,
    channel_arn: "capo_chime_sdk_messaging.types.chime_arn.ChimeArn",
    chime_bearer: "capo_chime_sdk_messaging.types.chime_arn.ChimeArn",
    *,
    config_overrides: Optional[ChimeSDKMessagingClientConfig] = None,
    max_results: Optional[
        "capo_chime_sdk_messaging.types.max_results.MaxResults"
    ] = None,
    next_token: Optional[
        "capo_chime_sdk_messaging.types.next_token.NextToken"
    ] = None,
) -> "capo_chime_sdk_messaging.types.list_sub_channels_response.ListSubChannelsResponse":
    """<p>Lists all the SubChannels in an elastic channel when given a channel ID. Available only to the app instance admins and channel moderators of elastic channels.</p>

    Args:
        channel_arn: <p>The ARN of elastic channel.</p>
        chime_bearer: <p>The <code>AppInstanceUserArn</code> of the user making the API call.</p>
        max_results: <p>The maximum number of sub-channels that you want to return.</p>
        next_token: <p>The token passed by previous API calls until all requested sub-channels are returned.</p>

    Raises:
        capo_chime_sdk_messaging.errors.bad_request_exception.BadRequestException: <p>The input parameters don't match the service's restrictions.</p>
        capo_chime_sdk_messaging.errors.forbidden_exception.ForbiddenException: <p>The client is permanently forbidden from making the request.</p>
        capo_chime_sdk_messaging.errors.service_failure_exception.ServiceFailureException: <p>The service encountered an unexpected error.</p>
        capo_chime_sdk_messaging.errors.service_unavailable_exception.ServiceUnavailableException: <p>The service is currently unavailable.</p>
        capo_chime_sdk_messaging.errors.throttled_client_exception.ThrottledClientException: <p>The client exceeded its request rate limit.</p>
        capo_chime_sdk_messaging.errors.unauthorized_client_exception.UnauthorizedClientException: <p>The client is not currently authorized to make the request.</p>
        capo_chime_sdk_messaging.errors.UnknownServiceError: The service returned an error code this client does not model.
    """

    def _handler(
        req: "OperationRequest[capo_chime_sdk_messaging.types.list_sub_channels_request.ListSubChannelsRequest]",
    ) -> OperationResponse[
        "capo_chime_sdk_messaging.types.list_sub_channels_response.ListSubChannelsResponse"
    ]:
        import capo_chime_sdk_messaging._operations.chime_messaging_service.list_sub_channels

        output, http_response = (
            capo_chime_sdk_messaging._operations.chime_messaging_service.list_sub_channels.list_sub_channels(
                req.options, req.input
            )
        )
        return OperationResponse(output=output, response=http_response)

    def _redact_input(
        input_: "capo_chime_sdk_messaging.types.list_sub_channels_request.ListSubChannelsRequest",
    ) -> dict[str, Any]:
        import capo_chime_sdk_messaging.types.list_sub_channels_request

        return capo_chime_sdk_messaging.types.list_sub_channels_request.redact_sensitive(
            input_
        )

    def _redact_output(
        output: "capo_chime_sdk_messaging.types.list_sub_channels_response.ListSubChannelsResponse",
    ) -> dict[str, Any]:
        import capo_chime_sdk_messaging.types.list_sub_channels_response

        return capo_chime_sdk_messaging.types.list_sub_channels_response.redact_sensitive(
            output
        )

    interceptors_, options_ = self.operation_options(
        config_overrides,
        OperationLogging(
            "ListSubChannels",
            redact_input=_redact_input,
            redact_output=_redact_output,
        ),
    )
    input_: capo_chime_sdk_messaging.types.list_sub_channels_request.ListSubChannelsRequest = {
        "channel_arn": channel_arn,
        "chime_bearer": chime_bearer,
    }
    if max_results is not None:
        input_["max_results"] = max_results
    if next_token is not None:
        input_["next_token"] = next_token

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