Connecthealth  >  Operations  >  list_domains

list_domains

Operation

list_domains async

list_domains(input: ListDomainsInput, plugins: list[Plugin] | None = None) -> ListDomainsOutput

Lists Domains for a given account.

Parameters:

Name	Type	Description	Default
input	ListDomainsInput	An instance of ListDomainsInput.	required
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

Returns:

Type	Description
ListDomainsOutput	An instance of ListDomainsOutput.

Input

ListDomainsInput dataclass

Dataclass for ListDomainsInput structure.

Attributes

max_results class-attribute instance-attribute

max_results: int | None = None

Maximum number of results to return.

next_token class-attribute instance-attribute

next_token: str | None = None

Token for pagination.

status class-attribute instance-attribute

status: DomainStatus | None = None

Filter by Domain status.

Output

ListDomainsOutput dataclass

Dataclass for ListDomainsOutput structure.

Attributes

domains instance-attribute

domains: list[DomainSummary]

List of Domains.

next_token class-attribute instance-attribute

next_token: str | None = None

Token for the next page of results.