Skip to content

list_domains

Operation

list_domains

list_domains(request: ListDomainsInput | ListDomainsInputDict | None = None, /, *, plugins: list[Plugin] | None = None, **kwargs: Unpack[ListDomainsInputDict]) -> ListDomainsOutput

Lists Domains for a given account.

Parameters:

Name Type Description Default
request ListDomainsInput | ListDomainsInputDict | None

The input as a model or dictionary. Pass this or keyword arguments, not both.

None
plugins list[Plugin] | None

A list of callables that modify the configuration dynamically. Changes made by these plugins only apply for the duration of the operation execution and will not affect any other operation invocations.

None
**kwargs Unpack[ListDomainsInputDict]

The input fields as keyword arguments.

{}

Returns:

Type Description
ListDomainsOutput

An instance of ListDomainsOutput.

list_domains async

list_domains(request: ListDomainsInput | ListDomainsInputDict | None = None, /, *, plugins: list[Plugin] | None = None, **kwargs: Unpack[ListDomainsInputDict]) -> ListDomainsOutput

Lists Domains for a given account.

Parameters:

Name Type Description Default
request ListDomainsInput | ListDomainsInputDict | None

The input as a model or dictionary. Pass this or keyword arguments, not both.

None
plugins list[Plugin] | None

A list of callables that modify the configuration dynamically. Changes made by these plugins only apply for the duration of the operation execution and will not affect any other operation invocations.

None
**kwargs Unpack[ListDomainsInputDict]

The input fields as keyword arguments.

{}

Returns:

Type Description
ListDomainsOutput

An instance of ListDomainsOutput.

Input

Pass the input as keyword arguments, a positional dictionary, or a positional model object. Pass plugins separately as a keyword argument.

ListDomainsInputDict

Bases: TypedDict

Dictionary form of ListDomainsInput.

Attributes

max_results instance-attribute
max_results: int | None

Maximum number of results to return.

next_token instance-attribute
next_token: str | None

Token for pagination.

status instance-attribute
status: str | None

Filter by Domain status.

ListDomainsInput dataclass

Bases: _SerdeShape

Dataclass for ListDomainsInput structure.

Attributes

max_results class-attribute instance-attribute
max_results: int | None = ...

Maximum number of results to return.

next_token class-attribute instance-attribute
next_token: str | None = ...

Token for pagination.

status class-attribute instance-attribute
status: str | None = ...

Filter by Domain status.

Output

ListDomainsOutput dataclass

Bases: _SerdeShape

Dataclass for ListDomainsOutput structure.

Attributes

domains instance-attribute
domains: list[DomainSummary]

List of Domains.

next_token class-attribute instance-attribute
next_token: str | None = ...

Token for the next page of results.

response_metadata class-attribute instance-attribute
response_metadata: ResponseMetadata = ...

Metadata about the response that produced this output. Use this to recover the request identifiers a service's support team needs in order to investigate a call. Members of the metadata are individually optional.