# GetCustomAction
<a name="API_GetCustomAction"></a>

Returns a custom action.

## Request Syntax
<a name="API_GetCustomAction_RequestSyntax"></a>

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

{
   "CustomActionArn": "string"
}
```

## URI Request Parameters
<a name="API_GetCustomAction_RequestParameters"></a>

The request does not use any URI parameters.

## Request Body
<a name="API_GetCustomAction_RequestBody"></a>

The request accepts the following data in JSON format.

 ** [CustomActionArn](#API_GetCustomAction_RequestSyntax) **   <a name="qdevinchatapps-GetCustomAction-request-CustomActionArn"></a>
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
<a name="API_GetCustomAction_ResponseSyntax"></a>

```
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
<a name="API_GetCustomAction_ResponseElements"></a>

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](#API_GetCustomAction_ResponseSyntax) **   <a name="qdevinchatapps-GetCustomAction-response-CustomAction"></a>
Returns the custom action.  
Type: [CustomAction](API_CustomAction.md) object

## Errors
<a name="API_GetCustomAction_Errors"></a>

For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

 ** 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
<a name="API_GetCustomAction_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/chatbot-2017-10-11/GetCustomAction) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/chatbot-2017-10-11/GetCustomAction) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/chatbot-2017-10-11/GetCustomAction) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/chatbot-2017-10-11/GetCustomAction) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/chatbot-2017-10-11/GetCustomAction) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/chatbot-2017-10-11/GetCustomAction) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/chatbot-2017-10-11/GetCustomAction) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/chatbot-2017-10-11/GetCustomAction) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/chatbot-2017-10-11/GetCustomAction) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/chatbot-2017-10-11/GetCustomAction)