DirectoryService / Client / share_directory

share_directory#

DirectoryService.Client.share_directory(**kwargs)#

Shares a specified directory ( DirectoryId) in your Amazon Web Services account (directory owner) with another Amazon Web Services account (directory consumer). With this operation you can use your directory from any Amazon Web Services account and from any Amazon VPC within an Amazon Web Services Region.

When you share your Managed Microsoft AD directory, Directory Service creates a shared directory in the directory consumer account. This shared directory contains the metadata to provide access to the directory within the directory owner account. The shared directory is visible in all VPCs in the directory consumer account.

The ShareMethod parameter determines whether the specified directory can be shared between Amazon Web Services accounts inside the same Amazon Web Services organization ( ORGANIZATIONS). It also determines whether you can share the directory with any other Amazon Web Services account either inside or outside of the organization ( HANDSHAKE).

The ShareNotes parameter is only used when HANDSHAKE is called, which sends a directory sharing request to the directory consumer.

See also: AWS API Documentation

Request Syntax

response = client.share_directory(
    DirectoryId='string',
    ShareNotes='string',
    ShareTarget={
        'Id': 'string',
        'Type': 'ACCOUNT'
    },
    ShareMethod='ORGANIZATIONS'|'HANDSHAKE'
)
Parameters:

  • DirectoryId (string) –

    [REQUIRED]

    Identifier of the Managed Microsoft AD directory that you want to share with other Amazon Web Services accounts.

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

  • ShareTarget (dict) –

    [REQUIRED]

    Identifier for the directory consumer account with whom the directory is to be shared.

    • Id (string) – [REQUIRED]

      Identifier of the directory consumer account.

    • Type (string) – [REQUIRED]

      Type of identifier to be used in the Id field.

  • ShareMethod (string) –

    [REQUIRED]

    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 directory sharing request ( HANDSHAKE).

Return type:

dict

Returns:

Response Syntax

{
    'SharedDirectoryId': 'string'
}

Response Structure

  • (dict) –

    • SharedDirectoryId (string) –

      Identifier of the directory that is stored in the directory consumer account that is shared from the specified directory ( DirectoryId).

Exceptions

  • DirectoryService.Client.exceptions.DirectoryAlreadySharedException

  • DirectoryService.Client.exceptions.EntityDoesNotExistException

  • DirectoryService.Client.exceptions.InvalidTargetException

  • DirectoryService.Client.exceptions.InvalidParameterException

  • DirectoryService.Client.exceptions.ClientException

  • DirectoryService.Client.exceptions.ShareLimitExceededException

  • DirectoryService.Client.exceptions.OrganizationsException

  • DirectoryService.Client.exceptions.AccessDeniedException

  • DirectoryService.Client.exceptions.UnsupportedOperationException

  • DirectoryService.Client.exceptions.ServiceException