[ aws . quicksight ]

search-folders

Description

Searches the subfolders in a folder.

See also: AWS API Documentation

See ‘aws help’ for descriptions of global parameters.

Synopsis

  search-folders
--aws-account-id <value>
--filters <value>
[--next-token <value>]
[--max-results <value>]
[--cli-input-json | --cli-input-yaml]
[--generate-cli-skeleton <value>]

Options

--aws-account-id (string)

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

--filters (list)

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

(structure)

A filter to use to search a Amazon QuickSight folder.

Operator -> (string)

The comparison operator that you want to use in the filter. For example, "Operator": "StringEquals" .

Name -> (string)

The name of a value that you want to use in the filter. For example, "Name": "PARENT_FOLDER_ARN" .

Value -> (string)

The value of the named item (in this example, PARENT_FOLDER_ARN ), that you want to use as a filter. For example, "Value": "arn:aws:quicksight:us-east-1:1:folder/folderId" .

Shorthand Syntax:

Operator=string,Name=string,Value=string ...

JSON Syntax:

[
  {
    "Operator": "StringEquals",
    "Name": "PARENT_FOLDER_ARN",
    "Value": "string"
  }
  ...
]

--next-token (string)

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

--max-results (integer)

The maximum number of results to be returned per request.

--cli-input-json | --cli-input-yaml (string) Reads arguments from the JSON string provided. The JSON string follows the format provided by --generate-cli-skeleton. If other arguments are provided on the command line, those values will override the JSON-provided values. It is not possible to pass arbitrary binary values using a JSON-provided value as the string will be taken literally. This may not be specified along with --cli-input-yaml.

--generate-cli-skeleton (string) Prints a JSON skeleton to standard output without sending an API request. If provided with no value or the value input, prints a sample input JSON that can be used as an argument for --cli-input-json. Similarly, if provided yaml-input it will print a sample input YAML that can be used with --cli-input-yaml. If provided with the value output, it validates the command inputs and returns a sample output JSON for that command.

See ‘aws help’ for descriptions of global parameters.

Output

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.

(structure)

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 -> (timestamp)

The time that the folder was created.

LastUpdatedTime -> (timestamp)

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.