Skip to content

get_domain

Operation

get_domain

get_domain(request: GetDomainInput | GetDomainInputDict | None = None, /, *, plugins: list[Plugin] | None = None, **kwargs: Unpack[GetDomainInputDict]) -> GetDomainOutput

Retrieves information about a Domain.

Parameters:

Name Type Description Default
request GetDomainInput | GetDomainInputDict | 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[GetDomainInputDict]

The input fields as keyword arguments.

{}

Returns:

Type Description
GetDomainOutput

An instance of GetDomainOutput.

get_domain async

get_domain(request: GetDomainInput | GetDomainInputDict | None = None, /, *, plugins: list[Plugin] | None = None, **kwargs: Unpack[GetDomainInputDict]) -> GetDomainOutput

Retrieves information about a Domain.

Parameters:

Name Type Description Default
request GetDomainInput | GetDomainInputDict | 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[GetDomainInputDict]

The input fields as keyword arguments.

{}

Returns:

Type Description
GetDomainOutput

An instance of GetDomainOutput.

Input

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

GetDomainInputDict

Bases: TypedDict

Dictionary form of GetDomainInput.

Attributes

domain_id instance-attribute
domain_id: Required[str]

The id of the Domain to get

GetDomainInput dataclass

Bases: _SerdeShape

Dataclass for GetDomainInput structure.

Attributes

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

The id of the Domain to get

Output

GetDomainOutput dataclass

Bases: _SerdeShape

Dataclass for GetDomainOutput structure.

Attributes

arn instance-attribute
arn: str
created_at instance-attribute
created_at: datetime
domain_id instance-attribute
domain_id: str
encryption_context class-attribute instance-attribute
encryption_context: EncryptionContext | None = ...
kms_key_arn class-attribute instance-attribute
kms_key_arn: str | None = ...
name instance-attribute
name: str
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.

status instance-attribute
status: str
tags class-attribute instance-attribute
tags: dict[str, str] | None = ...

Tags associated with the Domain

web_app_configuration class-attribute instance-attribute
web_app_configuration: WebAppConfiguration | None = ...
web_app_url class-attribute instance-attribute
web_app_url: str | None = ...