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

Description

Documentation

data DashboardSearchFilter Source #

A filter that you apply when searching for dashboards.

See: newDashboardSearchFilter smart constructor.

Constructors

DashboardSearchFilter'

Fields

name :: Maybe DashboardFilterAttribute
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 dashboards with that ARN listed as one of the dashboards'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 dashboards with that ARN listed as one of the owners of the dashboards are returned. Implicit permissions from folders or groups are considered.
- DIRECT_QUICKSIGHT_SOLE_OWNER: Provide an ARN of a user or group, and any dashboards with that ARN listed as the only owner of the dashboard are returned. Implicit permissions from folders or groups are not considered.
- DIRECT_QUICKSIGHT_OWNER: Provide an ARN of a user or group, and any dashboards with that ARN listed as one of the owners of the dashboards 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 dashboards with that ARN listed as one of the owners or viewers of the dashboards are returned. Implicit permissions from folders or groups are not considered.
- DASHBOARD_NAME: Any dashboards whose names have a substring match to this value will be returned.
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": "arn:aws:quicksight:us-east-1:1:user/default/UserName1".
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 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":"DASHBOARD_NAME", "Operator": "StringLike", "Value": "Test". The "StringLike" operator only supports the NAME value DASHBOARD_NAME.

Instances

Instances details

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

newDashboardSearchFilter Source #

Arguments

:: FilterOperator	`$sel:operator:DashboardSearchFilter'`
-> DashboardSearchFilter

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

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

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

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

dashboardSearchFilter_value :: Lens' DashboardSearchFilter (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": "arn:aws:quicksight:us-east-1:1:user/default/UserName1".

dashboardSearchFilter_operator :: Lens' DashboardSearchFilter 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":"DASHBOARD_NAME", "Operator": "StringLike", "Value": "Test". The "StringLike" operator only supports the NAME value DASHBOARD_NAME.