list_folders

QuickSight.Client.list_folders(**kwargs)

Lists all folders in an account.

See also: AWS API Documentation

Request Syntax

response = client.list_folders(
    AwsAccountId='string',
    NextToken='string',
    MaxResults=123
)

Parameters

• AwsAccountId (string) --

  [REQUIRED]

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

• NextToken (string) -- The token for the next set of results, or null if there are no more results.
• MaxResults (integer) -- The maximum number of results to be returned per request.

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)
        },
    ],
    'NextToken': 'string',
    '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.

  • NextToken (string) --

    The token for the next set of results, or null if there are no more results.

  • RequestId (string) --

    The Amazon Web Services request ID for this operation.

Exceptions

• QuickSight.Client.exceptions.InvalidParameterValueException
• QuickSight.Client.exceptions.AccessDeniedException
• QuickSight.Client.exceptions.ResourceNotFoundException
• QuickSight.Client.exceptions.ThrottlingException
• QuickSight.Client.exceptions.InvalidNextTokenException
• QuickSight.Client.exceptions.UnsupportedUserEditionException
• QuickSight.Client.exceptions.InternalFailureException