VisualMessageConfiguration
The configuration for a customizable message displayed on a visual. Supports parameter substitution in text fields.
Contents
Note
In the following list, the required parameters are described first.
- Description
-
The description text of the message that is displayed on the visual.
Type: String
Length Constraints: Maximum length of 120.
Pattern:
\A[\p{L}\p{M}\p{N}\s.,/\\:_()\[\]<>$!?'"#@%+&|^\-]*\zRequired: No
- DescriptionVisibility
-
Specifies whether the description of the message is displayed.
Type: String
Valid Values:
HIDDEN | VISIBLERequired: No
- Enabled
-
Specifies whether the custom message is displayed on the visual. When set to
true, the custom message appears in place of the default message. When set tofalseor omitted, the default message is displayed.Type: Boolean
Required: No
- LinkText
-
The display text of the hyperlink that is shown in the message.
Type: String
Length Constraints: Maximum length of 120.
Pattern:
\A[\p{L}\p{M}\p{N}\s.,/\\:_()\[\]<>$!?'"#@%+&|^\-]*\zRequired: No
- LinkUrl
-
The destination URL of the hyperlink that is shown in the message. Only valid
http,https, andmailtoURLs are supported.Type: String
Length Constraints: Maximum length of 120.
Pattern:
(?i)\A(?:(?:https?://|mailto:)\S*<<\$.+?>>\S*|https?://[a-z\d.-]+\.[a-z]{2,63}(?::\d+)?(?:[/?#][^\s]*)?|mailto:[^\s@]+@[a-z\d.-]+\.[a-z]{2,63})\zRequired: No
- LinkVisibility
-
Specifies whether the hyperlink in the message is displayed.
Type: String
Valid Values:
HIDDEN | VISIBLERequired: No
- Title
-
The title text of the message that is displayed on the visual.
Type: String
Length Constraints: Maximum length of 120.
Pattern:
\A[\p{L}\p{M}\p{N}\s.,/\\:_()\[\]<>$!?'"#@%+&|^\-]*\zRequired: No
- TitleVisibility
-
Specifies whether the title of the message is displayed.
Type: String
Valid Values:
HIDDEN | VISIBLERequired: No
See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
