Skip to content

CloudFront  >  Operations  >  delete_distribution_tenant

delete_distribution_tenant

Operation

delete_distribution_tenant async 

delete_distribution_tenant(input: DeleteDistributionTenantInput, plugins: list[Plugin] | None = None) -> DeleteDistributionTenantOutput

Deletes a distribution tenant. If you use this API operation to delete a distribution tenant that is currently enabled, the request will fail.

To delete a distribution tenant, you must first disable the distribution tenant by using the UpdateDistributionTenant API operation.

Parameters:

Name Type Description Default
input DeleteDistributionTenantInput

An instance of DeleteDistributionTenantInput.

 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
DeleteDistributionTenantOutput

An instance of DeleteDistributionTenantOutput.

Input

DeleteDistributionTenantInput dataclass

Bases: _SerdeShape

Dataclass for DeleteDistributionTenantInput structure.

Attributes

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

The ID of the distribution tenant to delete.

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

The value of the ETag header that you received when retrieving the distribution tenant. This value is returned in the response of the GetDistributionTenant API operation.

Output

DeleteDistributionTenantOutput dataclass

Bases: _SerdeShape

Dataclass for DeleteDistributionTenantOutput 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.