Skip to content

Api Gateway  >  Operations  >  get_domain_names

get_domain_names

Operation

get_domain_names async

get_domain_names(input: GetDomainNamesInput, plugins: list[Plugin] | None = None) -> GetDomainNamesOutput

Represents a collection of DomainName resources.

Parameters:

Name Type Description Default
input GetDomainNamesInput

An instance of GetDomainNamesInput.

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
GetDomainNamesOutput

An instance of GetDomainNamesOutput.

Input

GetDomainNamesInput dataclass

Request to describe a collection of DomainName resources.

Attributes

limit class-attribute instance-attribute
limit: int | None = None

The maximum number of returned results per page. The default value is 25 and the maximum value is 500.

position class-attribute instance-attribute
position: str | None = None

The current pagination position in the paged result set.

resource_owner class-attribute instance-attribute
resource_owner: ResourceOwner | None = None

The owner of the domain name access association.

Output

GetDomainNamesOutput dataclass

Represents a collection of DomainName resources.

Attributes

items class-attribute instance-attribute
items: list[DomainName] | None = None

The current page of elements from this collection.

position class-attribute instance-attribute
position: str | None = None

The current pagination position in the paged result set.