QuickSight / Paginator / ListFolders


class QuickSight.Paginator.ListFolders#
paginator = client.get_paginator('list_folders')

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

See also: AWS API Documentation

Request Syntax

response_iterator = paginator.paginate(
        'MaxItems': 123,
        'PageSize': 123,
        'StartingToken': 'string'
  • AwsAccountId (string) –


    The ID for the Amazon Web Services account that contains 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:



Response Syntax

    'Status': 123,
    'FolderSummaryList': [
            'Arn': 'string',
            'FolderId': 'string',
            'Name': 'string',
            'FolderType': 'SHARED'|'RESTRICTED',
            'CreatedTime': datetime(2015, 1, 1),
            'LastUpdatedTime': datetime(2015, 1, 1),
            'SharingModel': 'ACCOUNT'|'NAMESPACE'
    'RequestId': 'string'

Response Structure

  • (dict) –

    • Status (integer) –

      The HTTP status of the request.

    • FolderSummaryList (list) –

      A structure that contains all of the folders in the Amazon Web Services account. This structure provides basic information about the folders.

      • (dict) –

        A summary of information about an existing Amazon QuickSight folder.

        • Arn (string) –

          The Amazon Resource Name (ARN) of the folder.

        • FolderId (string) –

          The ID of the folder.

        • Name (string) –

          The display name of the folder.

        • FolderType (string) –

          The type of folder.

        • CreatedTime (datetime) –

          The time that the folder was created.

        • LastUpdatedTime (datetime) –

          The time that the folder was last updated.

        • SharingModel (string) –

          The sharing scope of the folder.

    • RequestId (string) –

      The Amazon Web Services request ID for this operation.