Skip to content

ListDomainsInput

Source code in docs_src/capo_swf/types/list_domains_input.py
class ListDomainsInput(TypedDict, closed=True):
    next_page_token: NotRequired["capo_swf.types.page_token.PageToken"]
    """<p>If <code>NextPageToken</code> is returned there are more results available. The value of <code>NextPageToken</code> is a unique pagination token for each page. Make the call again using the returned token to retrieve the next page. Keep all other arguments unchanged. Each pagination token expires after 24 hours. Using an expired pagination token will return a <code>400</code> error: "<code>Specified token has exceeded its maximum lifetime</code>". </p> <p>The configured <code>maximumPageSize</code> determines how many results can be returned in a single call. </p>"""
    registration_status: "capo_swf.types.registration_status.RegistrationStatus"
    """<p>Specifies the registration status of the domains to list.</p>"""
    maximum_page_size: "capo_swf.types.page_size.PageSize"
    """<p>The maximum number of results that are returned per call. Use <code>nextPageToken</code> to obtain further pages of results. </p>"""
    reverse_order: "capo_swf.types.reverse_order.ReverseOrder"
    """<p>When set to <code>true</code>, returns the results in reverse order. By default, the results are returned in ascending alphabetical order by <code>name</code> of the domains.</p>"""

maximum_page_size instance-attribute

maximum_page_size: PageSize

The maximum number of results that are returned per call. Use nextPageToken to obtain further pages of results.

next_page_token instance-attribute

next_page_token: NotRequired[PageToken]

If NextPageToken is returned there are more results available. The value of NextPageToken is a unique pagination token for each page. Make the call again using the returned token to retrieve the next page. Keep all other arguments unchanged. Each pagination token expires after 24 hours. Using an expired pagination token will return a 400 error: "Specified token has exceeded its maximum lifetime".

The configured maximumPageSize determines how many results can be returned in a single call.

registration_status instance-attribute

registration_status: RegistrationStatus

Specifies the registration status of the domains to list.

reverse_order instance-attribute

reverse_order: ReverseOrder

When set to true, returns the results in reverse order. By default, the results are returned in ascending alphabetical order by name of the domains.