QuickSight / Paginator / SearchFolders

SearchFolders#

class QuickSight.Paginator.SearchFolders#

paginator = client.get_paginator('search_folders')

paginate(**kwargs)#

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

Request Syntax

response_iterator = paginator.paginate(
    AwsAccountId='string',
    Filters=[
        {
            'Operator': 'StringEquals'|'StringLike',
            'Name': 'PARENT_FOLDER_ARN'|'DIRECT_QUICKSIGHT_OWNER'|'DIRECT_QUICKSIGHT_SOLE_OWNER'|'DIRECT_QUICKSIGHT_VIEWER_OR_OWNER'|'QUICKSIGHT_OWNER'|'QUICKSIGHT_VIEWER_OR_OWNER'|'FOLDER_NAME',
            'Value': 'string'
        },
    ],
    PaginationConfig={
        'MaxItems': 123,
        'PageSize': 123,
        'StartingToken': 'string'
    }
)

Parameters:

AwsAccountId (string) –
[REQUIRED]

The ID for the Amazon Web Services account that contains the folder.
Filters (list) –
[REQUIRED]

The filters to apply to the search. Currently, you can search only by the parent folder ARN. For example, "Filters": [ { "Name": "PARENT_FOLDER_ARN", "Operator": "StringEquals", "Value": "arn:aws:quicksight:us-east-1:1:folder/folderId" } ].
- (dict) –
  
  A filter to use to search an Amazon QuickSight folder.
  - Operator (string) –
    
    The comparison operator that you want to use as a filter, for example "Operator": "StringEquals". Valid values are "StringEquals" and "StringLike".
    
    If you set the operator value to "StringEquals", you need to provide an ownership related filter in the "NAME" field and the arn of the user or group whose folders you want to search in the "Value" field. For example, "Name":"DIRECT_QUICKSIGHT_OWNER", "Operator": "StringEquals", "Value": "arn:aws:quicksight:us-east-1:1:user/default/UserName1".
    
    If you set the value to "StringLike", you need to provide the name of the folders you are searching for. For example, "Name":"FOLDER_NAME", "Operator": "StringLike", "Value": "Test". The "StringLike" operator only supports the NAME value FOLDER_NAME.
  - Name (string) –
    
    The name of a value that you want to use in the filter. For example, "Name": "QUICKSIGHT_OWNER".
    
    Valid values are defined as follows:
    - QUICKSIGHT_VIEWER_OR_OWNER: Provide an ARN of a user or group, and any folders with that ARN listed as one of the folder’s owners or viewers are returned. Implicit permissions from folders or groups are considered.
    - QUICKSIGHT_OWNER: Provide an ARN of a user or group, and any folders with that ARN listed as one of the owners of the folders are returned. Implicit permissions from folders or groups are considered.
    - DIRECT_QUICKSIGHT_SOLE_OWNER: Provide an ARN of a user or group, and any folders with that ARN listed as the only owner of the folder are returned. Implicit permissions from folders or groups are not considered.
    - DIRECT_QUICKSIGHT_OWNER: Provide an ARN of a user or group, and any folders with that ARN listed as one of the owners of the folders are returned. Implicit permissions from folders or groups are not considered.
    - DIRECT_QUICKSIGHT_VIEWER_OR_OWNER: Provide an ARN of a user or group, and any folders with that ARN listed as one of the owners or viewers of the folders are returned. Implicit permissions from folders or groups are not considered.
    - FOLDER_NAME: Any folders whose names have a substring match to this value will be returned.
    - PARENT_FOLDER_ARN: Provide an ARN of a folder, and any folders that are directly under that parent folder are returned. If you choose to use this option and leave the value blank, all root-level folders in the account are returned.
  - Value (string) –
    
    The value of the named item (in this example, PARENT_FOLDER_ARN), that you want to use as a filter. For example, "Value": "arn:aws:quicksight:us-east-1:1:folder/folderId".
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,
    'FolderSummaryList': [
        {
            'Arn': 'string',
            'FolderId': 'string',
            'Name': 'string',
            'FolderType': 'SHARED',
            '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.