Skip to content

delete_domain_name

Operation

delete_domain_name

delete_domain_name(request: DeleteDomainNameInput | DeleteDomainNameInputDict | None = None, /, *, plugins: list[Plugin] | None = None, **kwargs: Unpack[DeleteDomainNameInputDict]) -> DeleteDomainNameOutput

Deletes the DomainName resource.

Parameters:

Name Type Description Default
request DeleteDomainNameInput | DeleteDomainNameInputDict | 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[DeleteDomainNameInputDict]

The input fields as keyword arguments.

{}

Returns:

Type Description
DeleteDomainNameOutput

An instance of DeleteDomainNameOutput.

delete_domain_name async

delete_domain_name(request: DeleteDomainNameInput | DeleteDomainNameInputDict | None = None, /, *, plugins: list[Plugin] | None = None, **kwargs: Unpack[DeleteDomainNameInputDict]) -> DeleteDomainNameOutput

Deletes the DomainName resource.

Parameters:

Name Type Description Default
request DeleteDomainNameInput | DeleteDomainNameInputDict | 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[DeleteDomainNameInputDict]

The input fields as keyword arguments.

{}

Returns:

Type Description
DeleteDomainNameOutput

An instance of DeleteDomainNameOutput.

Input

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

DeleteDomainNameInputDict

Bases: TypedDict

Dictionary form of DeleteDomainNameInput.

Attributes

domain_name instance-attribute
domain_name: Required[str]

The name of the DomainName resource to be deleted.

domain_name_id instance-attribute
domain_name_id: str | None

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

DeleteDomainNameInput dataclass

Bases: _SerdeShape

A request to delete the DomainName resource.

Attributes

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

The name of the DomainName resource to be deleted.

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

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

Output

DeleteDomainNameOutput dataclass

Bases: _SerdeShape

Dataclass for DeleteDomainNameOutput structure.

Attributes

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.