ListCustomActions - AWS Chatbot

ListCustomActions

Lists custom actions defined in this account.

Request Syntax

POST /list-custom-actions HTTP/1.1 Content-type: application/json { "MaxResults": number, "NextToken": "string" }

URI Request Parameters

The request does not use any URI parameters.

Request Body

The request accepts the following data in JSON format.

MaxResults

The maximum number of results to include in the response. If more results exist than the specified MaxResults value, a token is included in the response so that the remaining results can be retrieved.

Type: Integer

Valid Range: Minimum value of 1. Maximum value of 100.

Required: No

NextToken

An optional token returned from a prior request. Use this token for pagination of results from this action. If this parameter is specified, the response includes only results beyond the token, up to the value specified by MaxResults.

Type: String

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

Pattern: [\x20-\x7F]+

Required: No

Response Syntax

HTTP/1.1 200 Content-type: application/json { "CustomActions": [ "string" ], "NextToken": "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.

CustomActions

A list of custom actions.

Type: Array of strings

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}

NextToken

An optional token returned from a prior request. Use this token for pagination of results from this action. If this parameter is specified, the response includes only results beyond the token, up to the value specified by MaxResults.

Type: String

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

Pattern: [\x20-\x7F]+

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

UnauthorizedException

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

HTTP Status Code: 403

See Also

For more information about using this API in one of the language-specific AWS SDKs, see the following: