Amazon EventBridge
API Reference (API Version 2015-10-07)

The AWS Documentation website is getting a new look!
Try it now and let us know what you think. Switch to the new look >>

You can return to the original look by selecting English in the language selector above.

InputTransformer

Contains the parameters needed for you to provide custom input to a target based on one or more pieces of data extracted from the event.

Contents

InputPathsMap

Map of JSON paths to be extracted from the event. You can then insert these in the template in InputTemplate to produce the output to be sent to the target.

InputPathsMap is an array key-value pairs, where each value is a valid JSON path. You can have as many as 10 key-value pairs. You must use JSON dot notation, not bracket notation.

The keys can't start with "AWS".

Type: String to string map

Key Length Constraints: Minimum length of 1. Maximum length of 256.

Key Pattern: [A-Za-z0-9\_\-]+

Value Length Constraints: Maximum length of 256.

Required: No

InputTemplate

Input template where you specify placeholders that will be filled with the values of the keys from InputPathsMap to customize the data sent to the target. Enclose each InputPathsMaps value in brackets: <value>. The InputTemplate must be valid JSON.

If InputTemplate is a JSON object (surrounded by curly braces), the following restrictions apply:

  • The placeholder can't be used as an object key

  • Object values can't include quote marks

The following example shows the syntax for using InputPathsMap and InputTemplate.

"InputTransformer":

{

"InputPathsMap": {"instance": "$.detail.instance","status": "$.detail.status"},

"InputTemplate": "<instance> is in state <status>"

}

To have the InputTemplate include quote marks within a JSON string, escape each quote marks with a slash, as in the following example:

"InputTransformer":

{

"InputPathsMap": {"instance": "$.detail.instance","status": "$.detail.status"},

"InputTemplate": "<instance> is in state \"<status>\""

}

Type: String

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

Required: Yes

See Also

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

On this page: