CloudDirectory / Client / get_directory

get_directory#

CloudDirectory.Client.get_directory(**kwargs)#

Retrieves metadata about a directory.

Request Syntax

response = client.get_directory(
    DirectoryArn='string'
)

Parameters:

DirectoryArn (string) –

[REQUIRED]

The ARN of the directory.

Return type:

dict

Returns:

Response Syntax

{
    'Directory': {
        'Name': 'string',
        'DirectoryArn': 'string',
        'State': 'ENABLED'|'DISABLED'|'DELETED',
        'CreationDateTime': datetime(2015, 1, 1)
    }
}

Response Structure

(dict) –
- Directory (dict) –
  
  Metadata about the directory.
  - Name (string) –
    
    The name of the directory.
  - DirectoryArn (string) –
    
    The Amazon Resource Name (ARN) that is associated with the directory. For more information, see arns.
  - State (string) –
    
    The state of the directory. Can be either Enabled, Disabled, or Deleted.
  - CreationDateTime (datetime) –
    
    The date and time when the directory was created.

Exceptions

CloudDirectory.Client.exceptions.InternalServiceException
CloudDirectory.Client.exceptions.InvalidArnException
CloudDirectory.Client.exceptions.RetryableConflictException
CloudDirectory.Client.exceptions.ValidationException
CloudDirectory.Client.exceptions.LimitExceededException
CloudDirectory.Client.exceptions.AccessDeniedException