Skip to content

GetDedicatedIpsRequest

Source code in docs_src/capo_pinpoint_email/types/get_dedicated_ips_request.py
class GetDedicatedIpsRequest(TypedDict, closed=True):
    pool_name: NotRequired["capo_pinpoint_email.types.pool_name.PoolName"]
    """<p>The name of the IP pool that the dedicated IP address is associated with.</p>"""
    next_token: NotRequired["capo_pinpoint_email.types.next_token.NextToken"]
    """<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: NotRequired["capo_pinpoint_email.types.max_items.MaxItems"]
    """<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>"""

next_token instance-attribute

next_token: NotRequired[NextToken]

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 instance-attribute

page_size: NotRequired[MaxItems]

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.

pool_name instance-attribute

pool_name: NotRequired[PoolName]

The name of the IP pool that the dedicated IP address is associated with.