Skip to content

phone_number_validate

phone_number_validate(
    *,
    config_overrides: Optional[PinpointClientConfig] = None,
    number_validate_request: Optional[NumberValidateRequest] = None,
) -> PhoneNumberValidateResponse

Retrieves information about a phone number.

Raises:

Source code in docs_src/capo_pinpoint/_services/pinpoint.py
def phone_number_validate(
    self,
    *,
    config_overrides: Optional[PinpointClientConfig] = None,
    number_validate_request: Optional[
        "capo_pinpoint.types.number_validate_request.NumberValidateRequest"
    ] = None,
) -> (
    "capo_pinpoint.types.phone_number_validate_response.PhoneNumberValidateResponse"
):
    """<p>Retrieves information about a phone number.</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.phone_number_validate_request.PhoneNumberValidateRequest]",
    ) -> OperationResponse[
        "capo_pinpoint.types.phone_number_validate_response.PhoneNumberValidateResponse"
    ]:
        import capo_pinpoint._operations.pinpoint.phone_number_validate

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

    interceptors_, options_ = self.operation_options(
        config_overrides, OperationLogging("PhoneNumberValidate")
    )
    input_: capo_pinpoint.types.phone_number_validate_request.PhoneNumberValidateRequest = {}
    if number_validate_request is not None:
        input_["number_validate_request"] = number_validate_request

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