CloudDirectory / Client / disable_directory

disable_directory#

CloudDirectory.Client.disable_directory(**kwargs)#

Disables the specified directory. Disabled directories cannot be read or written to. Only enabled directories can be disabled. Disabled directories may be reenabled.

See also: AWS API Documentation

Request Syntax

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

DirectoryArn (string) –

[REQUIRED]

The ARN of the directory to disable.

Return type:

dict

Returns:

Response Syntax

{
    'DirectoryArn': 'string'
}

Response Structure

  • (dict) –

    • DirectoryArn (string) –

      The ARN of the directory that has been disabled.

Exceptions

  • CloudDirectory.Client.exceptions.ResourceNotFoundException

  • CloudDirectory.Client.exceptions.DirectoryDeletedException

  • CloudDirectory.Client.exceptions.InternalServiceException

  • CloudDirectory.Client.exceptions.ValidationException

  • CloudDirectory.Client.exceptions.LimitExceededException

  • CloudDirectory.Client.exceptions.AccessDeniedException

  • CloudDirectory.Client.exceptions.RetryableConflictException

  • CloudDirectory.Client.exceptions.InvalidArnException