AWS services or capabilities described in AWS Documentation may vary by region/location. Click Getting Started with Amazon AWS to see specific differences applicable to the China (Beijing) Region.

Class: Aws::QuickSight::Types::SearchDashboardsRequest

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 SearchDashboardsRequest data as a hash:

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

Constant Summary collapse

SENSITIVE =
[]

Instance Attribute Summary collapse

Instance Attribute Details

#aws_account_idString

The ID of the Amazon Web Services account that contains the user whose dashboards you're searching for.

Returns:

  • (String)


10857
10858
10859
10860
10861
10862
10863
10864
# File 'gems/aws-sdk-quicksight/lib/aws-sdk-quicksight/types.rb', line 10857

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

#filtersArray<Types::DashboardSearchFilter>

The filters to apply to the search. Currently, you can search only by user name, for example, "Filters": [ \{ "Name": "QUICKSIGHT_USER", "Operator": "StringEquals", "Value": "arn:aws:quicksight:us-east-1:1:user/default/UserName1" \} ]

Returns:



10857
10858
10859
10860
10861
10862
10863
10864
# File 'gems/aws-sdk-quicksight/lib/aws-sdk-quicksight/types.rb', line 10857

class SearchDashboardsRequest < 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)


10857
10858
10859
10860
10861
10862
10863
10864
# File 'gems/aws-sdk-quicksight/lib/aws-sdk-quicksight/types.rb', line 10857

class SearchDashboardsRequest < 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)


10857
10858
10859
10860
10861
10862
10863
10864
# File 'gems/aws-sdk-quicksight/lib/aws-sdk-quicksight/types.rb', line 10857

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