DirectoryService / Client / describe_shared_directories

describe_shared_directories#

DirectoryService.Client.describe_shared_directories(**kwargs)#

Returns the shared directories in your account.

Request Syntax

response = client.describe_shared_directories(
    OwnerDirectoryId='string',
    SharedDirectoryIds=[
        'string',
    ],
    NextToken='string',
    Limit=123
)

Parameters:

OwnerDirectoryId (string) –
[REQUIRED]

Returns the identifier of the directory in the directory owner account.
SharedDirectoryIds (list) –
A list of identifiers of all shared directories in your account.
- (string) –
NextToken (string) – The DescribeSharedDirectoriesResult.NextToken value from a previous call to DescribeSharedDirectories. Pass null if this is the first call.
Limit (integer) – The number of shared directories to return in the response object.

Return type:

dict

Returns:

Response Syntax

{
    'SharedDirectories': [
        {
            'OwnerAccountId': 'string',
            'OwnerDirectoryId': 'string',
            'ShareMethod': 'ORGANIZATIONS'|'HANDSHAKE',
            'SharedAccountId': 'string',
            'SharedDirectoryId': 'string',
            'ShareStatus': 'Shared'|'PendingAcceptance'|'Rejected'|'Rejecting'|'RejectFailed'|'Sharing'|'ShareFailed'|'Deleted'|'Deleting',
            'ShareNotes': 'string',
            'CreatedDateTime': datetime(2015, 1, 1),
            'LastUpdatedDateTime': datetime(2015, 1, 1)
        },
    ],
    'NextToken': 'string'
}

Response Structure

(dict) –
- SharedDirectories (list) –
  
  A list of all shared directories in your account.
  - (dict) –
    
    Details about the shared directory in the directory owner account for which the share request in the directory consumer account has been accepted.
    - OwnerAccountId (string) –
      
      Identifier of the directory owner account, which contains the directory that has been shared to the consumer account.
    - OwnerDirectoryId (string) –
      
      Identifier of the directory in the directory owner account.
    - ShareMethod (string) –
      
      The method used when sharing a directory to determine whether the directory should be shared within your Amazon Web Services organization ( ORGANIZATIONS) or with any Amazon Web Services account by sending a shared directory request ( HANDSHAKE).
    - SharedAccountId (string) –
      
      Identifier of the directory consumer account that has access to the shared directory ( OwnerDirectoryId) in the directory owner account.
    - SharedDirectoryId (string) –
      
      Identifier of the shared directory in the directory consumer account. This identifier is different for each directory owner account.
    - ShareStatus (string) –
      
      Current directory status of the shared Managed Microsoft AD directory.
    - ShareNotes (string) –
      
      A directory share request that is sent by the directory owner to the directory consumer. The request includes a typed message to help the directory consumer administrator determine whether to approve or reject the share invitation.
    - CreatedDateTime (datetime) –
      
      The date and time that the shared directory was created.
    - LastUpdatedDateTime (datetime) –
      
      The date and time that the shared directory was last updated.
- NextToken (string) –
  
  If not null, token that indicates that more results are available. Pass this value for the NextToken parameter in a subsequent call to DescribeSharedDirectories to retrieve the next set of items.

Exceptions

DirectoryService.Client.exceptions.EntityDoesNotExistException
DirectoryService.Client.exceptions.InvalidNextTokenException
DirectoryService.Client.exceptions.InvalidParameterException
DirectoryService.Client.exceptions.UnsupportedOperationException
DirectoryService.Client.exceptions.ClientException
DirectoryService.Client.exceptions.ServiceException