Skip to content

delete_domain

Operation

delete_domain

delete_domain(request: DeleteDomainInput | DeleteDomainInputDict | None = None, /, *, plugins: list[Plugin] | None = None, **kwargs: Unpack[DeleteDomainInputDict]) -> DeleteDomainOutput

Deletes a Domain and all associated resources.

Parameters:

Name Type Description Default
request DeleteDomainInput | DeleteDomainInputDict | 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[DeleteDomainInputDict]

The input fields as keyword arguments.

{}

Returns:

Type Description
DeleteDomainOutput

An instance of DeleteDomainOutput.

delete_domain async

delete_domain(request: DeleteDomainInput | DeleteDomainInputDict | None = None, /, *, plugins: list[Plugin] | None = None, **kwargs: Unpack[DeleteDomainInputDict]) -> DeleteDomainOutput

Deletes a Domain and all associated resources.

Parameters:

Name Type Description Default
request DeleteDomainInput | DeleteDomainInputDict | 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[DeleteDomainInputDict]

The input fields as keyword arguments.

{}

Returns:

Type Description
DeleteDomainOutput

An instance of DeleteDomainOutput.

Input

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

DeleteDomainInputDict

Bases: TypedDict

Dictionary form of DeleteDomainInput.

Attributes

domain_id instance-attribute
domain_id: Required[str]

The id of the Domain to delete

DeleteDomainInput dataclass

Bases: _SerdeShape

Dataclass for DeleteDomainInput structure.

Attributes

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

The id of the Domain to delete

Output

DeleteDomainOutput dataclass

Bases: _SerdeShape

Dataclass for DeleteDomainOutput structure.

Attributes

arn instance-attribute
arn: str

The ARN of the Domain that was requested for deletion

domain_id instance-attribute
domain_id: str

The id of the Domain requested for deletion

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

Current status of Domain