Request Syntax URI Request Parameters Request Body Response Syntax Response Elements Errors See Also

CreateCustomAction

Creates a custom action that can be invoked as an alias or as a button on a notification.

Request Syntax


POST /create-custom-action HTTP/1.1
Content-type: application/json

{
   "ActionName": "string",
   "AliasName": "string",
   "Attachments": [ 
      { 
         "ButtonText": "string",
         "Criteria": [ 
            { 
               "Operator": "string",
               "Value": "string",
               "VariableName": "string"
            }
         ],
         "NotificationType": "string",
         "Variables": { 
            "string" : "string" 
         }
      }
   ],
   "ClientToken": "string",
   "Definition": { 
      "CommandText": "string"
   },
   "Tags": [ 
      { 
         "TagKey": "string",
         "TagValue": "string"
      }
   ]
}

URI Request Parameters

The request does not use any URI parameters.

Request Body

The request accepts the following data in JSON format.

ActionName

The name of the custom action. This name is included in the Amazon Resource Name (ARN).

Type: String

Length Constraints: Minimum length of 1. Maximum length of 64.

Pattern: [a-zA-Z0-9_-]{1,64}

Required: Yes

AliasName

The name used to invoke this action in a 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

ClientToken

A unique, case-sensitive identifier that you provide to ensure the idempotency of the request. Idempotency ensures that an API request completes only once. With an idempotent request, if the original request completes successfully, subsequent retries with the same client token returns the result from the original successful request.

If you do not specify a client token, one is automatically generated by the SDK.

Type: String

Length Constraints: Minimum length of 33. Maximum length of 126.

Pattern: [\x21-\x7F]+

Required: No

Definition

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

Type: CustomActionDefinition object

Required: Yes

Tags

A map of tags assigned to a resource. A tag is a string-to-string map of key-value pairs.

Type: Array of Tag objects

Array Members: Minimum number of 0 items. Maximum number of 200 items.

Required: No

Response Syntax


HTTP/1.1 201
Content-type: application/json

{
   "CustomActionArn": "string"
}

Response Elements

If the action is successful, the service sends back an HTTP 201 response.

The following data is returned in JSON format by the service.

CustomActionArn

The fully defined 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}

Errors

For information about the errors that are common to all actions, see Common Errors.

ConflictException

There was an issue processing your request.

HTTP Status Code: 409

InternalServiceError

Unexpected error during processing of request.

HTTP Status Code: 500

InvalidRequestException

Your request input doesn't meet the constraints required by AWS Chatbot.

HTTP Status Code: 400

LimitExceededException

You have exceeded a service limit for AWS Chatbot.

HTTP Status Code: 403

UnauthorizedException

The request was rejected because it doesn't have valid credentials for the target resource.

HTTP Status Code: 403