Skip to content

get_domain_names

Operation

get_domain_names

get_domain_names(request: GetDomainNamesInput | GetDomainNamesInputDict | None = None, /, *, plugins: list[Plugin] | None = None, **kwargs: Unpack[GetDomainNamesInputDict]) -> GetDomainNamesOutput

Represents a collection of DomainName resources.

Parameters:

Name Type Description Default
request GetDomainNamesInput | GetDomainNamesInputDict | 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[GetDomainNamesInputDict]

The input fields as keyword arguments.

{}

Returns:

Type Description
GetDomainNamesOutput

An instance of GetDomainNamesOutput.

get_domain_names async

get_domain_names(request: GetDomainNamesInput | GetDomainNamesInputDict | None = None, /, *, plugins: list[Plugin] | None = None, **kwargs: Unpack[GetDomainNamesInputDict]) -> GetDomainNamesOutput

Represents a collection of DomainName resources.

Parameters:

Name Type Description Default
request GetDomainNamesInput | GetDomainNamesInputDict | 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[GetDomainNamesInputDict]

The input fields as keyword arguments.

{}

Returns:

Type Description
GetDomainNamesOutput

An instance of GetDomainNamesOutput.

Input

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

GetDomainNamesInputDict

Bases: TypedDict

Dictionary form of GetDomainNamesInput.

Attributes

limit instance-attribute
limit: int | None

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

position instance-attribute
position: str | None

The current pagination position in the paged result set.

resource_owner instance-attribute
resource_owner: str | None

The owner of the domain name access association.

GetDomainNamesInput dataclass

Bases: _SerdeShape

Request to describe a collection of DomainName resources.

Attributes

limit class-attribute instance-attribute
limit: int | 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 = ...

The current pagination position in the paged result set.

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

The owner of the domain name access association.

Output

GetDomainNamesOutput dataclass

Bases: _SerdeShape

Represents a collection of DomainName resources.

Attributes

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

The current page of elements from this collection.

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

The current pagination position in the paged result set.

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.