MessageComponents
Describes the components of a notification message.
Contents
- completeDescription
-
A complete summary with all possible relevant information.
Type: String
Required: No
- dimensions
-
A list of properties in key-value pairs. Pairs are shown in order of importance from most important to least important. Channels may limit the number of dimensions shown to the notification viewer.
Note
Included dimensions, keys, and values are subject to change.
Type: Array of Dimension objects
Array Members: Minimum number of 0 items. Maximum number of 10 items.
Required: No
- headline
-
A sentence long summary. For example, titles or an email subject line.
Type: String
Required: No
- markupDescription
-
A rich description in Portable Text format, which you can convert to markup formats such as HTML, Markdown, or plain text. Channels that don't support rich rendering ignore this field and use the plain text components instead.
Type: String
Required: No
- paragraphSummary
-
A paragraph long or multiple sentence summary. For example, Amazon Q Developer in chat applications notifications.
Type: String
Required: No
See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
