QuickSight / Paginator / ListFoldersForResource

ListFoldersForResource

class QuickSight.Paginator.ListFoldersForResource

paginator = client.get_paginator('list_folders_for_resource')

paginate(**kwargs)

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

See also: AWS API Documentation

Request Syntax

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

Parameters:

• AwsAccountId (string) –

  [REQUIRED]

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

• ResourceArn (string) –

  [REQUIRED]

  The Amazon Resource Name (ARN) the resource whose folders you need to list.

• 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,
    'Folders': [
        'string',
    ],
    'RequestId': 'string'
}

Response Structure

• (dict) –

  • Status (integer) –

    The HTTP status of the request.

  • Folders (list) –

    A list that contains the Amazon Resource Names (ARNs) of all folders that the resource is a member of.

    • (string) –

  • RequestId (string) –

    The Amazon Web Services request ID for this operation.