CustomAction
Represents a parameterized command that can be invoked as an alias or as a notification button in the chat client.
Contents
- CustomActionArn
-
The fully defined Amazon Resource Name (ARN) of the custom action.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 1011.
Pattern:
arn:aws:chatbot:[A-Za-z0-9_/.-]{0,63}:[A-Za-z0-9_/.-]{0,63}:custom-action/[a-zA-Z0-9_-]{1,64}
Required: Yes
- Definition
-
The definition of the command to run when invoked an alias or as an action button.
Type: CustomActionDefinition object
Required: Yes
- ActionName
-
The name of the custom action that is included in the ARN.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 64.
Pattern:
[a-zA-Z0-9_-]{1,64}
Required: No
- AliasName
-
The name used to invoke this action in the chat channel. For example,
@aws run my-alias
.Type: String
Length Constraints: Minimum length of 1. Maximum length of 30.
Pattern:
[A-Za-z0-9-_]+
Required: No
- Attachments
-
Defines when this custom action button should be attached to a notification.
Type: Array of CustomActionAttachment objects
Required: No
See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following: