DirectoryService / Client / describe_directory_data_access

describe_directory_data_access#

DirectoryService.Client.describe_directory_data_access(**kwargs)#

Obtains status of directory data access enablement through the Directory Service Data API for the specified directory.

See also: AWS API Documentation

Request Syntax

response = client.describe_directory_data_access(
    DirectoryId='string'
)
Parameters:

DirectoryId (string) –

[REQUIRED]

The directory identifier.

Return type:

dict

Returns:

Response Syntax

{
    'DataAccessStatus': 'Disabled'|'Disabling'|'Enabled'|'Enabling'|'Failed'
}

Response Structure

  • (dict) –

    • DataAccessStatus (string) –

      The current status of data access through the Directory Service Data API.

Exceptions

  • DirectoryService.Client.exceptions.DirectoryDoesNotExistException

  • DirectoryService.Client.exceptions.UnsupportedOperationException

  • DirectoryService.Client.exceptions.AccessDeniedException

  • DirectoryService.Client.exceptions.ClientException

  • DirectoryService.Client.exceptions.ServiceException