Skip to content

Connecthealth  >  Operations  >  delete_domain

delete_domain

Operation

delete_domain async

delete_domain(input: DeleteDomainInput, plugins: list[Plugin] | None = None) -> DeleteDomainOutput

Deletes a Domain and all associated resources.

Parameters:

Name Type Description Default
input DeleteDomainInput

An instance of DeleteDomainInput.

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
DeleteDomainOutput

An instance of DeleteDomainOutput.

Input

DeleteDomainInput dataclass

Dataclass for DeleteDomainInput structure.

Attributes

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

The id of the Domain to delete

Output

DeleteDomainOutput dataclass

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

status instance-attribute
status: DomainStatus

Current status of Domain