ImageCustomAction - Amazon QuickSight

ImageCustomAction

A custom action defined on an image.

Contents

Note

In the following list, the required parameters are described first.

ActionOperations

A list of ImageCustomActionOperations.

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

Type: Array of ImageCustomActionOperation objects

Array Members: Minimum number of 1 item. Maximum number of 2 items.

Required: Yes

CustomActionId

The ID of the custom action.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 512.

Pattern: [\w\-]+

Required: Yes

Name

The name of the custom action.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 256.

Required: Yes

Trigger

The trigger of the VisualCustomAction.

Valid values are defined as follows:

  • CLICK: Initiates a custom action by a left pointer click on a data point.

  • MENU: Initiates a custom action by right pointer click from the menu.

Type: String

Valid Values: CLICK | MENU

Required: Yes

Status

The status of the custom action.

Type: String

Valid Values: ENABLED | DISABLED

Required: No

See Also

For more information about using this API in one of the language-specific AWS SDKs, see the following: