Class: Aws::QuickSight::Types::SearchFoldersRequest

Inherits:
Struct
  • Object
show all
Defined in:
gems/aws-sdk-quicksight/lib/aws-sdk-quicksight/types.rb

Overview

Note:

When making an API call, you may pass SearchFoldersRequest data as a hash:

{
  aws_account_id: "AwsAccountId", # required
  filters: [ # required
    {
      operator: "StringEquals", # accepts StringEquals
      name: "PARENT_FOLDER_ARN", # accepts PARENT_FOLDER_ARN
      value: "String",
    },
  ],
  next_token: "String",
  max_results: 1,
}

Constant Summary collapse

SENSITIVE =
[]

Instance Attribute Summary collapse

Instance Attribute Details

#aws_account_idString

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

Returns:

  • (String)


11229
11230
11231
11232
11233
11234
11235
11236
# File 'gems/aws-sdk-quicksight/lib/aws-sdk-quicksight/types.rb', line 11229

class SearchFoldersRequest < Struct.new(
  :aws_account_id,
  :filters,
  :next_token,
  :max_results)
  SENSITIVE = []
  include Aws::Structure
end

#filtersArray<Types::FolderSearchFilter>

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

Returns:



11229
11230
11231
11232
11233
11234
11235
11236
# File 'gems/aws-sdk-quicksight/lib/aws-sdk-quicksight/types.rb', line 11229

class SearchFoldersRequest < Struct.new(
  :aws_account_id,
  :filters,
  :next_token,
  :max_results)
  SENSITIVE = []
  include Aws::Structure
end

#max_resultsInteger

The maximum number of results to be returned per request.

Returns:

  • (Integer)


11229
11230
11231
11232
11233
11234
11235
11236
# File 'gems/aws-sdk-quicksight/lib/aws-sdk-quicksight/types.rb', line 11229

class SearchFoldersRequest < Struct.new(
  :aws_account_id,
  :filters,
  :next_token,
  :max_results)
  SENSITIVE = []
  include Aws::Structure
end

#next_tokenString

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

Returns:

  • (String)


11229
11230
11231
11232
11233
11234
11235
11236
# File 'gems/aws-sdk-quicksight/lib/aws-sdk-quicksight/types.rb', line 11229

class SearchFoldersRequest < Struct.new(
  :aws_account_id,
  :filters,
  :next_token,
  :max_results)
  SENSITIVE = []
  include Aws::Structure
end