AWS SDK Version 3 for .NET
API Reference

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.

A filter that you apply when searching for datasets.

Inheritance Hierarchy

System.Object
  Amazon.QuickSight.Model.DataSetSearchFilter

Namespace: Amazon.QuickSight.Model
Assembly: AWSSDK.QuickSight.dll
Version: 3.x.y.z

Syntax

C#
public class DataSetSearchFilter

The DataSetSearchFilter type exposes the following members

Constructors

NameDescription
Public Method DataSetSearchFilter()

Properties

NameTypeDescription
Public Property Name Amazon.QuickSight.DataSetFilterAttribute

Gets and sets the property Name.

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

Valid values are defined as follows:

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

  • QUICKSIGHT_OWNER: Provide an ARN of a user or group, and any datasets with that ARN listed as one of the owners of the dataset are returned. Implicit permissions from folders or groups are considered.

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

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

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

  • DATASET_NAME: Any datasets whose names have a substring match to this value will be returned.

Public Property Operator Amazon.QuickSight.FilterOperator

Gets and sets the property Operator.

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 datasets you want to search in the "Value" field. For example, "Name":"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 datasets you are searching for. For example, "Name":"DATASET_NAME", "Operator": "StringLike", "Value": "Test". The "StringLike" operator only supports the NAME value DATASET_NAME.

Public Property Value System.String

Gets and sets the property Value.

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

Version Information

.NET:
Supported in: 8.0 and newer, Core 3.1

.NET Standard:
Supported in: 2.0

.NET Framework:
Supported in: 4.5 and newer, 3.5