ConnectHealth / Client / delete_domain

delete_domain

ConnectHealth.Client.delete_domain(**kwargs)

Deletes a Domain and all associated resources.

See also: AWS API Documentation

Request Syntax

response = client.delete_domain(
    domainId='string'
)
Parameters:

domainId (string) –

[REQUIRED]

The id of the Domain to delete

Return type:

dict

Returns:

Response Syntax

{
    'domainId': 'string',
    'arn': 'string',
    'status': 'ACTIVE'|'DELETING'|'DELETED'
}

Response Structure

  • (dict) –

    • domainId (string) –

      The id of the Domain requested for deletion

    • arn (string) –

      The ARN of the Domain that was requested for deletion

    • status (string) –

      Current status of Domain

Exceptions