Copyright	(c) 2013-2023 Brendan Hay
License	Mozilla Public License, v. 2.0.
Maintainer	Brendan Hay
Stability	auto-generated
Portability	non-portable (GHC extensions)
Safe Haskell	Safe-Inferred
Language	Haskell2010

Amazonka.QuickSight.Types.DataSetSearchFilter

Description

Documentation

data DataSetSearchFilter Source #

A filter that you apply when searching for datasets.

See: newDataSetSearchFilter smart constructor.

Constructors

DataSetSearchFilter'

Fields

operator :: FilterOperator
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.
name :: DataSetFilterAttribute
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.
value :: Text
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".

Instances

Instances details

ToJSON DataSetSearchFilter Source #
Instance details Defined in Amazonka.QuickSight.Types.DataSetSearchFilter Methods toJSON :: DataSetSearchFilter -> Value # toEncoding :: DataSetSearchFilter -> Encoding # toJSONList :: [DataSetSearchFilter] -> Value # toEncodingList :: [DataSetSearchFilter] -> Encoding #
Generic DataSetSearchFilter Source #
Instance details Defined in Amazonka.QuickSight.Types.DataSetSearchFilter Associated Types type Rep DataSetSearchFilter :: Type -> Type # Methods from :: DataSetSearchFilter -> Rep DataSetSearchFilter x # to :: Rep DataSetSearchFilter x -> DataSetSearchFilter #
Read DataSetSearchFilter Source #
Instance details Defined in Amazonka.QuickSight.Types.DataSetSearchFilter Methods readsPrec :: Int -> ReadS DataSetSearchFilter # readList :: ReadS [DataSetSearchFilter] # readPrec :: ReadPrec DataSetSearchFilter # readListPrec :: ReadPrec [DataSetSearchFilter] #
Show DataSetSearchFilter Source #
Instance details Defined in Amazonka.QuickSight.Types.DataSetSearchFilter Methods showsPrec :: Int -> DataSetSearchFilter -> ShowS # show :: DataSetSearchFilter -> String # showList :: [DataSetSearchFilter] -> ShowS #
NFData DataSetSearchFilter Source #
Instance details Defined in Amazonka.QuickSight.Types.DataSetSearchFilter Methods rnf :: DataSetSearchFilter -> () #
Eq DataSetSearchFilter Source #
Instance details Defined in Amazonka.QuickSight.Types.DataSetSearchFilter Methods (==) :: DataSetSearchFilter -> DataSetSearchFilter -> Bool # (/=) :: DataSetSearchFilter -> DataSetSearchFilter -> Bool #
Hashable DataSetSearchFilter Source #
Instance details Defined in Amazonka.QuickSight.Types.DataSetSearchFilter Methods hashWithSalt :: Int -> DataSetSearchFilter -> Int # hash :: DataSetSearchFilter -> Int #
type Rep DataSetSearchFilter Source #
Instance details Defined in Amazonka.QuickSight.Types.DataSetSearchFilter type Rep DataSetSearchFilter = D1 ('MetaData "DataSetSearchFilter" "Amazonka.QuickSight.Types.DataSetSearchFilter" "amazonka-quicksight-2.0-9P6nV9koXl6GTlt8ZjS7C9" 'False) (C1 ('MetaCons "DataSetSearchFilter'" 'PrefixI 'True) (S1 ('MetaSel ('Just "operator") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 FilterOperator) :: (S1 ('MetaSel ('Just "name") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 DataSetFilterAttribute) :: S1 ('MetaSel ('Just "value") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text))))

newDataSetSearchFilter Source #

Arguments

:: FilterOperator	`$sel:operator:DataSetSearchFilter'`
-> DataSetFilterAttribute	`$sel:name:DataSetSearchFilter'`
-> Text	`$sel:value:DataSetSearchFilter'`
-> DataSetSearchFilter

Create a value of DataSetSearchFilter with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

$sel:operator:DataSetSearchFilter', dataSetSearchFilter_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.

$sel:name:DataSetSearchFilter', dataSetSearchFilter_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.

$sel:value:DataSetSearchFilter', dataSetSearchFilter_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".

dataSetSearchFilter_operator :: Lens' DataSetSearchFilter FilterOperator Source #

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.

dataSetSearchFilter_name :: Lens' DataSetSearchFilter DataSetFilterAttribute Source #

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.

dataSetSearchFilter_value :: Lens' DataSetSearchFilter Text Source #

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