Property | Description |
Payload | Provide the request payload to be sent to the custom extension in one of the following ways: ![]() For details on the data objects and variables available in the Request Processing section that you can use to configure, see
Data Objects and Variables Available in API Gateway. ![]() ![]() ![]() ![]() |
Headers | Provide the following information, if you want to configure the headers you need to send to the custom extension. By default, no headers are sent to the custom extension. ![]() ![]() |
Query Parameters | Provide the following information, if you want to configure query parameters you need to send to the custom extension. ![]() For details on the data objects and variables available in the Request Processing section that you can use to configure, see
Data Objects and Variables Available in API Gateway. |
Property | Description |
Copy the entire response | Select to copy the entire response received from the external call out. This response is used in the subsequent step by using ${request.payload} or ${response.payload}. Note: Do not select this if you are using AWS Lambda custom extension with invocation type as Event as there is no response returned. |
Abort API execution in case of failure | Select to abort the API execution when the external callout encounters any failures. If you do not select this option, API Gateway logs the failure and continues with the processing. |
Transformation | Specify the following custom variables with a syntax to be accessed from the response of the custom extension and click Add. ![]() ![]() For example if you provide a variable as ${var} and the corresponding value as ${response[customExtension].payload.jsonPath[$.id]}, this transformation evaluates the JSON path from the custom policy response payload to get the value of the attribute id. The evaluated value is assigned to the variable var given in the Variable field. You can use the ${var} syntax in the subsequent policies that support variable framework. For details about the data objects and variables available in the Response Processing section that you can use to configure, see
Data Objects and Variables Available in API Gateway. |
Custom extension metadata | This is used for XML transformation. ![]() ![]() |
Property | Description |
Namespace Prefix | Provide the namespace prefix of the payload expression to be validated. |
Namespace URI | Provide the namespace URI of the payload expression to be validated. |