ListFolderMembers -

ListFolderMembers

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

Request Syntax

GET /accounts/AwsAccountId/folders/FolderId/members?max-results=MaxResults&next-token=NextToken HTTP/1.1

URI Request Parameters

The request uses the following URI parameters.

AwsAccountId

The AWS account ID.

Length Constraints: Fixed length of 12.

Pattern: ^[0-9]{12}$

Required: Yes

FolderId

The folder ID.

Length Constraints: Minimum length of 1. Maximum length of 2048.

Pattern: [\w\-]+

Required: Yes

MaxResults

The maximum number of results to be returned per request.

Valid Range: Minimum value of 1. Maximum value of 100.

NextToken

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

Request Body

The request does not have a request body.

Response Syntax

HTTP/1.1 Status Content-type: application/json { "FolderMemberList": [ { "MemberArn": "string", "MemberId": "string" } ], "NextToken": "string", "RequestId": "string" }

Response Elements

If the action is successful, the service sends back the following HTTP response.

Status

The status. If succeeded, the status is SC_OK

The following data is returned in JSON format by the service.

FolderMemberList

A structure that contains all of the folder members (dashboards, analyses, and datasets) in the folder.

Type: Array of MemberIdArnPair objects

Array Members: Maximum number of 100 items.

NextToken

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

Type: String

RequestId

The request ID.

Type: String

Errors

For information about the errors that are common to all actions, see Common Errors.

AccessDeniedException

You don't have access to this item. The provided credentials couldn't be validated. You might not be authorized to carry out the request. Make sure that your account is authorized to use the Amazon QuickSight service, that your policies have the correct permissions, and that you are using the correct access keys.

HTTP Status Code: 401

InternalFailureException

An internal failure occurred.

HTTP Status Code: 500

InvalidNextTokenException

The NextToken value isn't valid.

HTTP Status Code: 400

InvalidParameterValueException

One or more parameters has a value that isn't valid.

HTTP Status Code: 400

ResourceNotFoundException

One or more resources can't be found.

HTTP Status Code: 404

ThrottlingException

Access is throttled.

HTTP Status Code: 429

UnsupportedUserEditionException

This error indicates that you are calling an operation on an Amazon QuickSight subscription where the edition doesn't include support for that operation. Amazon Amazon QuickSight currently has Standard Edition and Enterprise Edition. Not every operation and capability is available in every edition.

HTTP Status Code: 403

See Also

For more information about using this API in one of the language-specific AWS SDKs, see the following: