DirectoryService / Client / accept_shared_directory

accept_shared_directory#

DirectoryService.Client.accept_shared_directory(**kwargs)#

Accepts a directory sharing request that was sent from the directory owner account.

See also: AWS API Documentation

Request Syntax

response = client.accept_shared_directory(
    SharedDirectoryId='string'
)
Parameters:

SharedDirectoryId (string) –

[REQUIRED]

Identifier of the shared directory in the directory consumer account. This identifier is different for each directory owner account.

Return type:

dict

Returns:

Response Syntax

{
    'SharedDirectory': {
        '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)
    }
}

Response Structure

  • (dict) –

    • SharedDirectory (dict) –

      The shared directory in the directory consumer account.

      • 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.

Exceptions

  • DirectoryService.Client.exceptions.InvalidParameterException

  • DirectoryService.Client.exceptions.EntityDoesNotExistException

  • DirectoryService.Client.exceptions.DirectoryAlreadySharedException

  • DirectoryService.Client.exceptions.ClientException

  • DirectoryService.Client.exceptions.ServiceException