Skip to content

get_messaging_session_endpoint async

get_messaging_session_endpoint(
    *,
    config_overrides: Optional[AsyncChimeSDKMessagingClientConfig] = None,
    network_type: Optional[NetworkType] = None,
) -> GetMessagingSessionEndpointResponse

The details of the endpoint for the messaging session.

Parameters:

  • network_type (Optional[NetworkType], default: None ) –

    The type of network for the messaging session endpoint. Either IPv4 only or dual-stack (IPv4 and IPv6).

Raises:

Source code in docs_src/capo_chime_sdk_messaging/_services/async_chime_sdk_messaging.py
async def get_messaging_session_endpoint(
    self,
    *,
    config_overrides: Optional[AsyncChimeSDKMessagingClientConfig] = None,
    network_type: Optional[
        "capo_chime_sdk_messaging.types.network_type.NetworkType"
    ] = None,
) -> "capo_chime_sdk_messaging.types.get_messaging_session_endpoint_response.GetMessagingSessionEndpointResponse":
    """<p>The details of the endpoint for the messaging session.</p>

    Args:
        network_type: <p>The type of network for the messaging session endpoint. Either IPv4 only or dual-stack (IPv4 and IPv6).</p>

    Raises:
        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.
    """

    async def _handler(
        req: "AsyncOperationRequest[capo_chime_sdk_messaging.types.get_messaging_session_endpoint_request.GetMessagingSessionEndpointRequest]",
    ) -> AsyncOperationResponse[
        "capo_chime_sdk_messaging.types.get_messaging_session_endpoint_response.GetMessagingSessionEndpointResponse"
    ]:
        import capo_chime_sdk_messaging._operations.chime_messaging_service.get_messaging_session_endpoint

        (
            output,
            http_response,
        ) = await capo_chime_sdk_messaging._operations.chime_messaging_service.get_messaging_session_endpoint.async_get_messaging_session_endpoint(
            req.options, req.input
        )
        return AsyncOperationResponse(output=output, response=http_response)

    interceptors_, options_ = self.operation_options(
        config_overrides, OperationLogging("GetMessagingSessionEndpoint")
    )
    input_: capo_chime_sdk_messaging.types.get_messaging_session_endpoint_request.GetMessagingSessionEndpointRequest = {}
    if network_type is not None:
        input_["network_type"] = network_type

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