Search Folders

quicksight_search_folders

R Documentation

Searches the subfolders in a folder¶

Description¶

Searches the subfolders in a folder.

Usage¶

quicksight_search_folders(AwsAccountId, Filters, NextToken, MaxResults)

Arguments¶

AwsAccountId

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

Filters

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

NextToken

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

MaxResults

The maximum number of results to be returned per request.

Value¶

A list with the following syntax:

list(
  Status = 123,
  FolderSummaryList = list(
    list(
      Arn = "string",
      FolderId = "string",
      Name = "string",
      FolderType = "SHARED"|"RESTRICTED",
      CreatedTime = as.POSIXct(
        "2015-01-01"
      ),
      LastUpdatedTime = as.POSIXct(
        "2015-01-01"
      ),
      SharingModel = "ACCOUNT"|"NAMESPACE"
    )
  ),
  NextToken = "string",
  RequestId = "string"
)

Request syntax¶

svc$search_folders(
  AwsAccountId = "string",
  Filters = list(
    list(
      Operator = "StringEquals"|"StringLike",
      Name = "PARENT_FOLDER_ARN"|"DIRECT_QUICKSIGHT_OWNER"|"DIRECT_QUICKSIGHT_SOLE_OWNER"|"DIRECT_QUICKSIGHT_VIEWER_OR_OWNER"|"QUICKSIGHT_OWNER"|"QUICKSIGHT_VIEWER_OR_OWNER"|"FOLDER_NAME",
      Value = "string"
    )
  ),
  NextToken = "string",
  MaxResults = 123
)