CloudDirectory / Client / delete_directory

delete_directory#

CloudDirectory.Client.delete_directory(**kwargs)#

Deletes a directory. Only disabled directories can be deleted. A deleted directory cannot be undone. Exercise extreme caution when deleting directories.

See also: AWS API Documentation

Request Syntax

response = client.delete_directory(
    DirectoryArn='string'
)
Parameters:

DirectoryArn (string) –

[REQUIRED]

The ARN of the directory to delete.

Return type:

dict

Returns:

Response Syntax

{
    'DirectoryArn': 'string'
}

Response Structure

  • (dict) –

    • DirectoryArn (string) –

      The ARN of the deleted directory.

Exceptions

  • CloudDirectory.Client.exceptions.ResourceNotFoundException

  • CloudDirectory.Client.exceptions.DirectoryNotDisabledException

  • CloudDirectory.Client.exceptions.InternalServiceException

  • CloudDirectory.Client.exceptions.ValidationException

  • CloudDirectory.Client.exceptions.LimitExceededException

  • CloudDirectory.Client.exceptions.AccessDeniedException

  • CloudDirectory.Client.exceptions.DirectoryDeletedException

  • CloudDirectory.Client.exceptions.RetryableConflictException

  • CloudDirectory.Client.exceptions.InvalidArnException