Skip to content

get_user_endpoints 

get_user_endpoints(
    application_id: __string,
    user_id: __string,
    *,
    config_overrides: Optional[PinpointClientConfig] = None,
) -> GetUserEndpointsResponse

Retrieves information about all the endpoints that are associated with a specific user ID.

Parameters:

  • application_id (__string) –

    The unique identifier for the application. This identifier is displayed as the Project ID on the Amazon Pinpoint console.

  • user_id (__string) –

    The unique identifier for the user.

Raises:

Source code in docs_src/capo_pinpoint/_services/pinpoint.py 
4946
4947
4948
4949
4950
4951
4952
4953
4954
4955
4956
4957
4958
4959
4960
4961
4962
4963
4964
4965
4966
4967
4968
4969
4970
4971
4972
4973
4974
4975
4976
4977
4978
4979
4980
4981
4982
4983
4984
4985
4986
4987
4988
4989
4990
4991
4992
4993
4994
4995
4996
4997
4998
def get_user_endpoints(
    self,
    application_id: "capo_pinpoint.types.__string.__string",
    user_id: "capo_pinpoint.types.__string.__string",
    *,
    config_overrides: Optional[PinpointClientConfig] = None,
) -> "capo_pinpoint.types.get_user_endpoints_response.GetUserEndpointsResponse":
    """<p>Retrieves information about all the endpoints that are associated with a specific user ID.</p>

    Args:
        application_id: <p>The unique identifier for the application. This identifier is displayed as the <b>Project ID</b> on the Amazon Pinpoint console.</p>
        user_id: <p>The unique identifier for the user.</p>

    Raises:
        capo_pinpoint.errors.bad_request_exception.BadRequestException: <p>Provides information about an API request or response.</p>
        capo_pinpoint.errors.forbidden_exception.ForbiddenException: <p>Provides information about an API request or response.</p>
        capo_pinpoint.errors.internal_server_error_exception.InternalServerErrorException: <p>Provides information about an API request or response.</p>
        capo_pinpoint.errors.method_not_allowed_exception.MethodNotAllowedException: <p>Provides information about an API request or response.</p>
        capo_pinpoint.errors.not_found_exception.NotFoundException: <p>Provides information about an API request or response.</p>
        capo_pinpoint.errors.payload_too_large_exception.PayloadTooLargeException: <p>Provides information about an API request or response.</p>
        capo_pinpoint.errors.too_many_requests_exception.TooManyRequestsException: <p>Provides information about an API request or response.</p>
        capo_pinpoint.errors.UnknownServiceError: The service returned an error code this client does not model.
    """

    def _handler(
        req: "OperationRequest[capo_pinpoint.types.get_user_endpoints_request.GetUserEndpointsRequest]",
    ) -> OperationResponse[
        "capo_pinpoint.types.get_user_endpoints_response.GetUserEndpointsResponse"
    ]:
        import capo_pinpoint._operations.pinpoint.get_user_endpoints

        output, http_response = (
            capo_pinpoint._operations.pinpoint.get_user_endpoints.get_user_endpoints(
                req.options, req.input
            )
        )
        return OperationResponse(output=output, response=http_response)

    interceptors_, options_ = self.operation_options(
        config_overrides, OperationLogging("GetUserEndpoints")
    )
    input_: capo_pinpoint.types.get_user_endpoints_request.GetUserEndpointsRequest = {
        "application_id": application_id,
        "user_id": user_id,
    }

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