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

Description

Documentation

data FolderSearchFilter Source #

A filter to use to search an Amazon QuickSight folder.

See: newFolderSearchFilter smart constructor.

Constructors

FolderSearchFilter'

Fields

name :: Maybe FolderFilterAttribute
The name of a value that you want to use in the 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 folders with that ARN listed as one of the folder's 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 folders with that ARN listed as one of the owners of the folders are returned. Implicit permissions from folders or groups are considered.
- DIRECT_QUICKSIGHT_SOLE_OWNER: Provide an ARN of a user or group, and any folders with that ARN listed as the only owner of the folder are returned. Implicit permissions from folders or groups are not considered.
- DIRECT_QUICKSIGHT_OWNER: Provide an ARN of a user or group, and any folders with that ARN listed as one of the owners of the folders 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 folders with that ARN listed as one of the owners or viewers of the folders are returned. Implicit permissions from folders or groups are not considered.
- FOLDER_NAME: Any folders whose names have a substring match to this value will be returned.
- PARENT_FOLDER_ARN: Provide an ARN of a folder, and any folders that are directly under that parent folder are returned. If you choose to use this option and leave the value blank, all root-level folders in the account are returned.
operator :: Maybe 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 folders 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 folders you are searching for. For example, "Name":"FOLDER_NAME", "Operator": "StringLike", "Value": "Test". The "StringLike" operator only supports the NAME value FOLDER_NAME.
value :: Maybe Text
The value of the named item (in this example, PARENT_FOLDER_ARN), that you want to use as a filter. For example, "Value": "arn:aws:quicksight:us-east-1:1:folder/folderId".

Instances

Instances details

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

newFolderSearchFilter :: FolderSearchFilter Source #

Create a value of FolderSearchFilter 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:name:FolderSearchFilter', folderSearchFilter_name - The name of a value that you want to use in the 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 folders with that ARN listed as one of the folder's 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 folders with that ARN listed as one of the owners of the folders are returned. Implicit permissions from folders or groups are considered.
DIRECT_QUICKSIGHT_SOLE_OWNER: Provide an ARN of a user or group, and any folders with that ARN listed as the only owner of the folder are returned. Implicit permissions from folders or groups are not considered.
DIRECT_QUICKSIGHT_OWNER: Provide an ARN of a user or group, and any folders with that ARN listed as one of the owners of the folders 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 folders with that ARN listed as one of the owners or viewers of the folders are returned. Implicit permissions from folders or groups are not considered.
FOLDER_NAME: Any folders whose names have a substring match to this value will be returned.
PARENT_FOLDER_ARN: Provide an ARN of a folder, and any folders that are directly under that parent folder are returned. If you choose to use this option and leave the value blank, all root-level folders in the account are returned.

$sel:operator:FolderSearchFilter', folderSearchFilter_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 folders 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 folders you are searching for. For example, "Name":"FOLDER_NAME", "Operator": "StringLike", "Value": "Test". The "StringLike" operator only supports the NAME value FOLDER_NAME.

$sel:value:FolderSearchFilter', folderSearchFilter_value - The value of the named item (in this example, PARENT_FOLDER_ARN), that you want to use as a filter. For example, "Value": "arn:aws:quicksight:us-east-1:1:folder/folderId".

folderSearchFilter_name :: Lens' FolderSearchFilter (Maybe FolderFilterAttribute) Source #

The name of a value that you want to use in the 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 folders with that ARN listed as one of the folder's 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 folders with that ARN listed as one of the owners of the folders are returned. Implicit permissions from folders or groups are considered.
DIRECT_QUICKSIGHT_SOLE_OWNER: Provide an ARN of a user or group, and any folders with that ARN listed as the only owner of the folder are returned. Implicit permissions from folders or groups are not considered.
DIRECT_QUICKSIGHT_OWNER: Provide an ARN of a user or group, and any folders with that ARN listed as one of the owners of the folders 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 folders with that ARN listed as one of the owners or viewers of the folders are returned. Implicit permissions from folders or groups are not considered.
FOLDER_NAME: Any folders whose names have a substring match to this value will be returned.
PARENT_FOLDER_ARN: Provide an ARN of a folder, and any folders that are directly under that parent folder are returned. If you choose to use this option and leave the value blank, all root-level folders in the account are returned.

folderSearchFilter_operator :: Lens' FolderSearchFilter (Maybe 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 folders 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 folders you are searching for. For example, "Name":"FOLDER_NAME", "Operator": "StringLike", "Value": "Test". The "StringLike" operator only supports the NAME value FOLDER_NAME.

folderSearchFilter_value :: Lens' FolderSearchFilter (Maybe Text) Source #

The value of the named item (in this example, PARENT_FOLDER_ARN), that you want to use as a filter. For example, "Value": "arn:aws:quicksight:us-east-1:1:folder/folderId".