MessageComponents ¶

class MessageComponents(TypedDict, closed=True):
    headline: NotRequired[
        "capo_notifications.types.text_part_reference.TextPartReference"
    ]
    """<p>A sentence long summary. For example, titles or an email subject line.</p>"""
    paragraph_summary: NotRequired[
        "capo_notifications.types.text_part_reference.TextPartReference"
    ]
    """<p>A paragraph long or multiple sentence summary. For example, Amazon Q Developer in chat applications notifications.</p>"""
    complete_description: NotRequired[
        "capo_notifications.types.text_part_reference.TextPartReference"
    ]
    """<p>A complete summary with all possible relevant information.</p>"""
    markup_description: NotRequired[
        "capo_notifications.types.text_part_reference.TextPartReference"
    ]
    """<p>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.</p>"""
    dimensions: NotRequired["capo_notifications.types.dimensions.Dimensions"]
    """<p>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.</p> <note> <p>Included dimensions, keys, and values are subject to change.</p> </note>"""