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

UpdateCustomAction

Updates a custom action.

Request Syntax


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

{
   "AliasName": "string",
   "Attachments": [ 
      { 
         "ButtonText": "string",
         "Criteria": [ 
            { 
               "Operator": "string",
               "Value": "string",
               "VariableName": "string"
            }
         ],
         "NotificationType": "string",
         "Variables": { 
            "string" : "string" 
         }
      }
   ],
   "CustomActionArn": "string",
   "Definition": { 
      "CommandText": "string"
   }
}

URI Request Parameters

The request does not use any URI parameters.

Request Body

The request accepts the following data in JSON format.

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

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 as an alias or as an action button.

Type: CustomActionDefinition object

Required: Yes

Response Syntax


HTTP/1.1 200
Content-type: application/json

{
   "CustomActionArn": "string"
}

Response Elements

If the action is successful, the service sends back an HTTP 200 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.

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

ResourceNotFoundException

We were unable to find the resource for your request

HTTP Status Code: 404

UnauthorizedException

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

HTTP Status Code: 403