List the dedicated IP addresses that are associated with your Amazon Pinpoint account.
Parameters:
-
pool_name
(Optional[PoolName], default:
None
)
–
The name of the IP pool that the dedicated IP address is associated with.
-
next_token
(Optional[NextToken], default:
None
)
–
A token returned from a previous call to GetDedicatedIps to indicate the position of the dedicated IP pool in the list of IP pools.
-
page_size
(Optional[MaxItems], default:
None
)
–
The number of results to show in a single call to GetDedicatedIpsRequest. If the number of results is larger than the number you specified in this parameter, then the response includes a NextToken element, which you can use to obtain additional results.
Raises:
Source code in docs_src/capo_pinpoint_email/_services/pinpoint_email.py
| def get_dedicated_ips(
self,
*,
config_overrides: Optional[PinpointEmailClientConfig] = None,
pool_name: Optional["capo_pinpoint_email.types.pool_name.PoolName"] = None,
next_token: Optional["capo_pinpoint_email.types.next_token.NextToken"] = None,
page_size: Optional["capo_pinpoint_email.types.max_items.MaxItems"] = None,
) -> "capo_pinpoint_email.types.get_dedicated_ips_response.GetDedicatedIpsResponse":
"""<p>List the dedicated IP addresses that are associated with your Amazon Pinpoint account.</p>
Args:
pool_name: <p>The name of the IP pool that the dedicated IP address is associated with.</p>
next_token: <p>A token returned from a previous call to <code>GetDedicatedIps</code> to indicate the position of the dedicated IP pool in the list of IP pools.</p>
page_size: <p>The number of results to show in a single call to <code>GetDedicatedIpsRequest</code>. If the number of results is larger than the number you specified in this parameter, then the response includes a <code>NextToken</code> element, which you can use to obtain additional results.</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.
"""
def _handler(
req: "OperationRequest[capo_pinpoint_email.types.get_dedicated_ips_request.GetDedicatedIpsRequest]",
) -> OperationResponse[
"capo_pinpoint_email.types.get_dedicated_ips_response.GetDedicatedIpsResponse"
]:
import capo_pinpoint_email._operations.amazon_pinpoint_email_service.get_dedicated_ips
output, http_response = (
capo_pinpoint_email._operations.amazon_pinpoint_email_service.get_dedicated_ips.get_dedicated_ips(
req.options, req.input
)
)
return OperationResponse(output=output, response=http_response)
interceptors_, options_ = self.operation_options(
config_overrides, OperationLogging("GetDedicatedIps")
)
input_: capo_pinpoint_email.types.get_dedicated_ips_request.GetDedicatedIpsRequest = {}
if pool_name is not None:
input_["pool_name"] = pool_name
if next_token is not None:
input_["next_token"] = next_token
if page_size is not None:
input_["page_size"] = page_size
response = execute_pipeline(
OperationRequest(input=input_, options=options_),
handler=_handler,
interceptors=list(interceptors_),
)
response.response.close()
return response.output
|