Skip to content

get_dedicated_ip async

get_dedicated_ip(
    ip: Ip, *, config_overrides: Optional[AsyncPinpointEmailClientConfig] = None
) -> GetDedicatedIpResponse

Get information about a dedicated IP address, including the name of the dedicated IP pool that it's associated with, as well information about the automatic warm-up process for the address.

Parameters:

  • ip (Ip) –

    The IP address that you want to obtain more information about. The value you specify has to be a dedicated IP address that's assocaited with your Amazon Pinpoint account.

Raises:

Source code in docs_src/capo_pinpoint_email/_services/async_pinpoint_email.py
async def get_dedicated_ip(
    self,
    ip: "capo_pinpoint_email.types.ip.Ip",
    *,
    config_overrides: Optional[AsyncPinpointEmailClientConfig] = None,
) -> "capo_pinpoint_email.types.get_dedicated_ip_response.GetDedicatedIpResponse":
    """<p>Get information about a dedicated IP address, including the name of the dedicated IP pool that it's associated with, as well information about the automatic warm-up process for the address.</p>

    Args:
        ip: <p>The IP address that you want to obtain more information about. The value you specify has to be a dedicated IP address that's assocaited with your Amazon Pinpoint account.</p>

    Raises:
        capo_pinpoint_email.errors.bad_request_exception.BadRequestException: <p>The input you provided is invalid.</p>
        capo_pinpoint_email.errors.not_found_exception.NotFoundException: <p>The resource you attempted to access doesn't exist.</p>
        capo_pinpoint_email.errors.too_many_requests_exception.TooManyRequestsException: <p>Too many requests have been made to the operation.</p>
        capo_pinpoint_email.errors.UnknownServiceError: The service returned an error code this client does not model.
    """

    async def _handler(
        req: "AsyncOperationRequest[capo_pinpoint_email.types.get_dedicated_ip_request.GetDedicatedIpRequest]",
    ) -> AsyncOperationResponse[
        "capo_pinpoint_email.types.get_dedicated_ip_response.GetDedicatedIpResponse"
    ]:
        import capo_pinpoint_email._operations.amazon_pinpoint_email_service.get_dedicated_ip

        (
            output,
            http_response,
        ) = await capo_pinpoint_email._operations.amazon_pinpoint_email_service.get_dedicated_ip.async_get_dedicated_ip(
            req.options, req.input
        )
        return AsyncOperationResponse(output=output, response=http_response)

    interceptors_, options_ = self.operation_options(
        config_overrides, OperationLogging("GetDedicatedIp")
    )
    input_: capo_pinpoint_email.types.get_dedicated_ip_request.GetDedicatedIpRequest = {
        "ip": ip
    }

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