DirectoryService / Paginator / DescribeSharedDirectories

DescribeSharedDirectories

class DirectoryService.Paginator.DescribeSharedDirectories

paginator = client.get_paginator('describe_shared_directories')

paginate(**kwargs)

Creates an iterator that will paginate through responses from DirectoryService.Client.describe_shared_directories().

See also: AWS API Documentation

Request Syntax

response_iterator = paginator.paginate(
    OwnerDirectoryId='string',
    SharedDirectoryIds=[
        'string',
    ],
    PaginationConfig={
        'MaxItems': 123,
        'PageSize': 123,
        'StartingToken': 'string'
    }
)

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) –

• PaginationConfig (dict) –

  A dictionary that provides parameters to control pagination.

  • MaxItems (integer) –

    The total number of items to return. If the total number of items available is more than the value specified in max-items then a NextToken will be provided in the output that you can use to resume pagination.

  • PageSize (integer) –

    The size of each page.

  • StartingToken (string) –

    A token to specify where to start paginating. This is the NextToken from a previous response.

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)
        },
    ],

}

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.