QuickSight / Client / list_folder_members

list_folder_members#

QuickSight.Client.list_folder_members(**kwargs)#

List all assets ( DASHBOARD , ANALYSIS , and DATASET ) in a folder.

Request Syntax

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

Parameters:

AwsAccountId (string) –
[REQUIRED]

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

The ID of 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,
    'FolderMemberList': [
        {
            'MemberId': 'string',
            'MemberArn': 'string'
        },
    ],
    'NextToken': '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.
- 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