Returns a custom action.
Request Syntax
POST /get-custom-action HTTP/1.1
Content-type: application/json
{
"CustomActionArn": "string"
}URI Request Parameters
The request does not use any URI parameters.
Request Body
The request accepts the following data in JSON format.
- CustomActionArn
-
Returns 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::[0-9]{12}:custom-action/[a-zA-Z0-9_-]{1,64}Required: Yes
Response Syntax
HTTP/1.1 200
Content-type: application/json
{
"CustomAction": {
"ActionName": "string",
"AliasName": "string",
"Attachments": [
{
"ButtonText": "string",
"Criteria": [
{
"Operator": "string",
"Value": "string",
"VariableName": "string"
}
],
"NotificationType": "string",
"Variables": {
"string" : "string"
}
}
],
"CustomActionArn": "string",
"Definition": {
"CommandText": "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.
- CustomAction
-
Returns the custom action.
Type: CustomAction object
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 Amazon Q Developer.
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
See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
