Request Syntax URI Request Parameters Request Body Response Syntax Response Elements Errors See Also

SearchFolders

Searches the subfolders in a folder.

Request Syntax


POST /accounts/AwsAccountId/search/folders HTTP/1.1
Content-type: application/json

{
   "Filters": [ 
      { 
         "Name": "string",
         "Operator": "string",
         "Value": "string"
      }
   ],
   "MaxResults": number,
   "NextToken": "string"
}

URI Request Parameters

The request uses the following URI parameters.

AwsAccountId

The ID for the AWS account that contains the folder.

Length Constraints: Fixed length of 12.

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

Required: Yes

Request Body

The request accepts the following data in JSON format.

Filters

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" } ].

Type: Array of FolderSearchFilter objects

Array Members: Maximum number of 100 items.

Required: Yes

MaxResults

The maximum number of results to be returned per request.

Type: Integer

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

Required: No

NextToken

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

Type: String

Required: No

Response Syntax


HTTP/1.1 Status
Content-type: application/json

{
   "FolderSummaryList": [ 
      { 
         "Arn": "string",
         "CreatedTime": number,
         "FolderId": "string",
         "FolderType": "string",
         "LastUpdatedTime": number,
         "Name": "string",
         "SharingModel": "string"
      }
   ],
   "NextToken": "string",
   "RequestId": "string"
}

Response Elements

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

Status: The HTTP status of the request.

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

FolderSummaryList

A structure that contains all of the folders in the AWS account. This structure provides basic information about the folders.

Type: Array of FolderSummary 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 AWS request ID for this operation.

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 credentials.

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

InvalidRequestException

You don't have this feature activated for your account. To fix this issue, contact AWS support.

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