QuickSight / Paginator / ListFolderMembers

ListFolderMembers

class QuickSight.Paginator.ListFolderMembers

paginator = client.get_paginator('list_folder_members')

paginate(**kwargs)

Creates an iterator that will paginate through responses from QuickSight.Client.list_folder_members().

See also: AWS API Documentation

Request Syntax

response_iterator = paginator.paginate(
    AwsAccountId='string',
    FolderId='string',
    PaginationConfig={
        'MaxItems': 123,
        'PageSize': 123,
        'StartingToken': 'string'
    }
)

Parameters:

• AwsAccountId (string) –

  [REQUIRED]

  The ID for the Amazon Web Services account that contains the folder.

• FolderId (string) –

  [REQUIRED]

  The ID of the folder.

• 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

{
    'Status': 123,
    'FolderMemberList': [
        {
            'MemberId': 'string',
            'MemberArn': 'string'
        },
    ],
    'RequestId': 'string'
}

Response Structure

• (dict) –

  • Status (integer) –

    The HTTP status of the request.

  • FolderMemberList (list) –

    A structure that contains all of the folder members (dashboards, analyses, and datasets) in the folder.

    • (dict) –

      An object that consists of a member Amazon Resource Name (ARN) and a member ID.

      • MemberId (string) –

        The ID of the member.

      • MemberArn (string) –

        The Amazon Resource Name (ARN) of the member.

  • RequestId (string) –

    The Amazon Web Services request ID for this operation.