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

Description

Documentation

data AnalysisSearchFilter Source #

A filter that you apply when searching for one or more analyses.

See: newAnalysisSearchFilter smart constructor.

Constructors

AnalysisSearchFilter'

Fields

name :: Maybe AnalysisFilterAttribute
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 analyses with that ARN listed as one of the analysis' 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 analyses with that ARN listed as one of the owners of the analyses are returned. Implicit permissions from folders or groups are considered.
- DIRECT_QUICKSIGHT_SOLE_OWNER: Provide an ARN of a user or group, and any analyses with that ARN listed as the only owner of the analysis are returned. Implicit permissions from folders or groups are not considered.
- DIRECT_QUICKSIGHT_OWNER: Provide an ARN of a user or group, and any analyses with that ARN listed as one of the owners of the analyses 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 analyses with that ARN listed as one of the owners or viewers of the analyses are returned. Implicit permissions from folders or groups are not considered.
- ANALYSIS_NAME: Any analyses whose names have a substring match to this value will be 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":"ANALYSIS_NAME", "Operator": "StringLike", "Value": "Test". The "StringLike" operator only supports the NAME value ANALYSIS_NAME.
value :: Maybe Text
The value of the named item, in this case QUICKSIGHT_USER, that you want to use as a filter, for example "Value". An example is "arn:aws:quicksight:us-east-1:1:user/default/UserName1".

Instances

Instances details

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

newAnalysisSearchFilter :: AnalysisSearchFilter Source #

Create a value of AnalysisSearchFilter 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:AnalysisSearchFilter', analysisSearchFilter_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 analyses with that ARN listed as one of the analysis' 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 analyses with that ARN listed as one of the owners of the analyses are returned. Implicit permissions from folders or groups are considered.
DIRECT_QUICKSIGHT_SOLE_OWNER: Provide an ARN of a user or group, and any analyses with that ARN listed as the only owner of the analysis are returned. Implicit permissions from folders or groups are not considered.
DIRECT_QUICKSIGHT_OWNER: Provide an ARN of a user or group, and any analyses with that ARN listed as one of the owners of the analyses 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 analyses with that ARN listed as one of the owners or viewers of the analyses are returned. Implicit permissions from folders or groups are not considered.
ANALYSIS_NAME: Any analyses whose names have a substring match to this value will be returned.

$sel:operator:AnalysisSearchFilter', analysisSearchFilter_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":"ANALYSIS_NAME", "Operator": "StringLike", "Value": "Test". The "StringLike" operator only supports the NAME value ANALYSIS_NAME.

$sel:value:AnalysisSearchFilter', analysisSearchFilter_value - The value of the named item, in this case QUICKSIGHT_USER, that you want to use as a filter, for example "Value". An example is "arn:aws:quicksight:us-east-1:1:user/default/UserName1".

analysisSearchFilter_name :: Lens' AnalysisSearchFilter (Maybe AnalysisFilterAttribute) 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 analyses with that ARN listed as one of the analysis' 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 analyses with that ARN listed as one of the owners of the analyses are returned. Implicit permissions from folders or groups are considered.
DIRECT_QUICKSIGHT_SOLE_OWNER: Provide an ARN of a user or group, and any analyses with that ARN listed as the only owner of the analysis are returned. Implicit permissions from folders or groups are not considered.
DIRECT_QUICKSIGHT_OWNER: Provide an ARN of a user or group, and any analyses with that ARN listed as one of the owners of the analyses 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 analyses with that ARN listed as one of the owners or viewers of the analyses are returned. Implicit permissions from folders or groups are not considered.
ANALYSIS_NAME: Any analyses whose names have a substring match to this value will be returned.

analysisSearchFilter_operator :: Lens' AnalysisSearchFilter (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":"ANALYSIS_NAME", "Operator": "StringLike", "Value": "Test". The "StringLike" operator only supports the NAME value ANALYSIS_NAME.

analysisSearchFilter_value :: Lens' AnalysisSearchFilter (Maybe Text) Source #

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