Skip to content

API Gateway  >  Operations  >  delete_domain_name

delete_domain_name

Operation

delete_domain_name async 

delete_domain_name(input: DeleteDomainNameInput, plugins: list[Plugin] | None = None) -> DeleteDomainNameOutput

Deletes the DomainName resource.

Parameters:

Name Type Description Default
input DeleteDomainNameInput

An instance of DeleteDomainNameInput.

 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
DeleteDomainNameOutput

An instance of DeleteDomainNameOutput.

Input

DeleteDomainNameInput dataclass

A request to delete the DomainName resource.

Attributes

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

The name of the DomainName resource to be deleted.

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

The identifier for the domain name resource. Supported only for private custom domain names.

Output

DeleteDomainNameOutput dataclass

Dataclass for DeleteDomainNameOutput structure.

Attributes

response_metadata class-attribute instance-attribute 
response_metadata: ResponseMetadata = field(default=EMPTY_RESPONSE_METADATA, repr=False, compare=False)

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.