Skip to content

CustomAction

Source code in docs_src/capo_chatbot/types/custom_action.py
class CustomAction(TypedDict, closed=True):
    custom_action_arn: "capo_chatbot.types.custom_action_arn.CustomActionArn"
    """<p>The fully defined Amazon Resource Name (ARN) of the custom action.</p>"""
    definition: "capo_chatbot.types.custom_action_definition.CustomActionDefinition"
    """<p>The definition of the command to run when invoked an alias or as an action button.</p>"""
    alias_name: NotRequired[
        "capo_chatbot.types.custom_action_alias_name.CustomActionAliasName"
    ]
    """<p>The name used to invoke this action in the chat channel. For example, <code>@aws run my-alias</code>.</p>"""
    attachments: NotRequired[
        "capo_chatbot.types.custom_action_attachment_list.CustomActionAttachmentList"
    ]
    """<p>Defines when this custom action button should be attached to a notification.</p>"""
    action_name: NotRequired["capo_chatbot.types.custom_action_name.CustomActionName"]
    """<p>The name of the custom action that is included in the ARN.</p>"""

action_name instance-attribute

action_name: NotRequired[CustomActionName]

The name of the custom action that is included in the ARN.

alias_name instance-attribute

alias_name: NotRequired[CustomActionAliasName]

The name used to invoke this action in the chat channel. For example, @aws run my-alias.

attachments instance-attribute

attachments: NotRequired[CustomActionAttachmentList]

Defines when this custom action button should be attached to a notification.

custom_action_arn instance-attribute

custom_action_arn: CustomActionArn

The fully defined Amazon Resource Name (ARN) of the custom action.

definition instance-attribute

The definition of the command to run when invoked an alias or as an action button.