Class: Aws::QuickSight::Types::DataSourceSearchFilter

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

Overview

A filter that you apply when searching for data sources.

See Also:

Constant Summary collapse

SENSITIVE = 
[]

Instance Attribute Summary collapse

Instance Attribute Details

#name ⇒ String

The name of the value that you want to use as a filter, for example, "Name": "DIRECT_QUICKSIGHT_OWNER".

Valid values are defined as follows:

  • DIRECT_QUICKSIGHT_VIEWER_OR_OWNER: Provide an ARN of a user or group, and any data sources with that ARN listed as one of the owners or viewers of the data sources are returned. Implicit permissions from folders or groups are not considered.

  • DIRECT_QUICKSIGHT_OWNER: Provide an ARN of a user or group, and any data sources with that ARN listed as one of the owners if the data source are returned. Implicit permissions from folders or groups are not considered.

  • DIRECT_QUICKSIGHT_SOLE_OWNER: Provide an ARN of a user or group, and any data sources with that ARN listed as the only owner of the data source are returned. Implicit permissions from folders or groups are not considered.

  • DATASOURCE_NAME: Any data sources whose names have a substring match to the provided value are returned.

Returns:

  • (String) 


9770
9771
9772
9773
9774
9775
9776
 
# File 'gems/aws-sdk-quicksight/lib/aws-sdk-quicksight/types.rb', line 9770

class DataSourceSearchFilter < Struct.new(
  :operator,
  :name,
  :value)
  SENSITIVE = []
  include Aws::Structure
end

#operator ⇒ String

The comparison operator that you want to use as a filter, for example "Operator": "StringEquals". Valid values are "StringEquals" and "StringLike".

If you set the operator value to "StringEquals", you need to provide an ownership related filter in the "NAME" field and the arn of the user or group whose data sources you want to search in the "Value" field. For example, "Name":"DIRECT_QUICKSIGHT_OWNER", "Operator": "StringEquals", "Value": "arn:aws:quicksight:us-east-1:1:user/default/UserName1".

If you set the value to "StringLike", you need to provide the name of the data sources you are searching for. For example, "Name":"DATASOURCE_NAME", "Operator": "StringLike", "Value": "Test". The "StringLike" operator only supports the NAME value DATASOURCE_NAME.

Returns:

  • (String) 


9770
9771
9772
9773
9774
9775
9776
 
# File 'gems/aws-sdk-quicksight/lib/aws-sdk-quicksight/types.rb', line 9770

class DataSourceSearchFilter < Struct.new(
  :operator,
  :name,
  :value)
  SENSITIVE = []
  include Aws::Structure
end

#value ⇒ String

The value of the named item, for example DIRECT_QUICKSIGHT_OWNER, that you want to use as a filter, for example, "Value": "arn:aws:quicksight:us-east-1:1:user/default/UserName1".

Returns:

  • (String) 


9770
9771
9772
9773
9774
9775
9776
 
# File 'gems/aws-sdk-quicksight/lib/aws-sdk-quicksight/types.rb', line 9770

class DataSourceSearchFilter < Struct.new(
  :operator,
  :name,
  :value)
  SENSITIVE = []
  include Aws::Structure
end