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

Description

Documentation

data VisualCustomAction Source #

A custom action defined on a visual.

See: newVisualCustomAction smart constructor.

Constructors

VisualCustomAction'

Fields

status :: Maybe WidgetStatus
The status of the VisualCustomAction.
customActionId :: Text
The ID of the VisualCustomAction.
name :: Text
The name of the VisualCustomAction.
trigger :: VisualCustomActionTrigger
The trigger of the VisualCustomAction.
Valid values are defined as follows:
- DATA_POINT_CLICK: Initiates a custom action by a left pointer click on a data point.
- DATA_POINT_MENU: Initiates a custom action by right pointer click from the menu.
actionOperations :: NonEmpty VisualCustomActionOperation
A list of VisualCustomActionOperations.
This is a union type structure. For this structure to be valid, only one of the attributes can be defined.

Instances

Instances details

FromJSON VisualCustomAction Source #
Instance details Defined in Amazonka.QuickSight.Types.VisualCustomAction Methods parseJSON :: Value -> Parser VisualCustomAction # parseJSONList :: Value -> Parser [VisualCustomAction] #
ToJSON VisualCustomAction Source #
Instance details Defined in Amazonka.QuickSight.Types.VisualCustomAction Methods toJSON :: VisualCustomAction -> Value # toEncoding :: VisualCustomAction -> Encoding # toJSONList :: [VisualCustomAction] -> Value # toEncodingList :: [VisualCustomAction] -> Encoding #
Generic VisualCustomAction Source #
Instance details Defined in Amazonka.QuickSight.Types.VisualCustomAction Associated Types type Rep VisualCustomAction :: Type -> Type # Methods from :: VisualCustomAction -> Rep VisualCustomAction x # to :: Rep VisualCustomAction x -> VisualCustomAction #
Show VisualCustomAction Source #
Instance details Defined in Amazonka.QuickSight.Types.VisualCustomAction Methods showsPrec :: Int -> VisualCustomAction -> ShowS # show :: VisualCustomAction -> String # showList :: [VisualCustomAction] -> ShowS #
NFData VisualCustomAction Source #
Instance details Defined in Amazonka.QuickSight.Types.VisualCustomAction Methods rnf :: VisualCustomAction -> () #
Eq VisualCustomAction Source #
Instance details Defined in Amazonka.QuickSight.Types.VisualCustomAction Methods (==) :: VisualCustomAction -> VisualCustomAction -> Bool # (/=) :: VisualCustomAction -> VisualCustomAction -> Bool #
Hashable VisualCustomAction Source #
Instance details Defined in Amazonka.QuickSight.Types.VisualCustomAction Methods hashWithSalt :: Int -> VisualCustomAction -> Int # hash :: VisualCustomAction -> Int #
type Rep VisualCustomAction Source #
Instance details Defined in Amazonka.QuickSight.Types.VisualCustomAction type Rep VisualCustomAction = D1 ('MetaData "VisualCustomAction" "Amazonka.QuickSight.Types.VisualCustomAction" "amazonka-quicksight-2.0-9P6nV9koXl6GTlt8ZjS7C9" 'False) (C1 ('MetaCons "VisualCustomAction'" 'PrefixI 'True) ((S1 ('MetaSel ('Just "status") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe WidgetStatus)) :: S1 ('MetaSel ('Just "customActionId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text)) :: (S1 ('MetaSel ('Just "name") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text) :: (S1 ('MetaSel ('Just "trigger") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 VisualCustomActionTrigger) :: S1 ('MetaSel ('Just "actionOperations") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (NonEmpty VisualCustomActionOperation))))))

newVisualCustomAction Source #

Arguments

:: Text	`$sel:customActionId:VisualCustomAction'`
-> Text	`$sel:name:VisualCustomAction'`
-> VisualCustomActionTrigger	`$sel:trigger:VisualCustomAction'`
-> NonEmpty VisualCustomActionOperation	`$sel:actionOperations:VisualCustomAction'`
-> VisualCustomAction

Create a value of VisualCustomAction 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:status:VisualCustomAction', visualCustomAction_status - The status of the VisualCustomAction.

$sel:customActionId:VisualCustomAction', visualCustomAction_customActionId - The ID of the VisualCustomAction.

$sel:name:VisualCustomAction', visualCustomAction_name - The name of the VisualCustomAction.

$sel:trigger:VisualCustomAction', visualCustomAction_trigger - The trigger of the VisualCustomAction.

Valid values are defined as follows:

DATA_POINT_CLICK: Initiates a custom action by a left pointer click on a data point.
DATA_POINT_MENU: Initiates a custom action by right pointer click from the menu.

$sel:actionOperations:VisualCustomAction', visualCustomAction_actionOperations - A list of VisualCustomActionOperations.

This is a union type structure. For this structure to be valid, only one of the attributes can be defined.

visualCustomAction_status :: Lens' VisualCustomAction (Maybe WidgetStatus) Source #

The status of the VisualCustomAction.

visualCustomAction_customActionId :: Lens' VisualCustomAction Text Source #

The ID of the VisualCustomAction.

visualCustomAction_name :: Lens' VisualCustomAction Text Source #

The name of the VisualCustomAction.

visualCustomAction_trigger :: Lens' VisualCustomAction VisualCustomActionTrigger Source #

The trigger of the VisualCustomAction.

Valid values are defined as follows:

DATA_POINT_CLICK: Initiates a custom action by a left pointer click on a data point.
DATA_POINT_MENU: Initiates a custom action by right pointer click from the menu.

visualCustomAction_actionOperations :: Lens' VisualCustomAction (NonEmpty VisualCustomActionOperation) Source #

A list of VisualCustomActionOperations.

This is a union type structure. For this structure to be valid, only one of the attributes can be defined.