Amazon EventBridge Pipes · JSON Structure

Amazon Eventbridge Pipes Pipe Enrichment Parameters Structure

The parameters required to set up enrichment on your pipe.

Type: object Properties: 2
Amazon Web ServicesEvent-DrivenIntegrationMessagingServerless

PipeEnrichmentParameters is a JSON Structure definition published by Amazon EventBridge Pipes, describing 2 properties. It conforms to the https://json-structure.org/meta/core/v0/# meta-schema.

Properties

HttpParameters InputTemplate

Meta-schema: https://json-structure.org/meta/core/v0/#

JSON Structure

Raw ↑
{
  "$schema": "https://json-structure.org/meta/core/v0/#",
  "$id": "https://raw.githubusercontent.com/api-evangelist/amazon-eventbridge-pipes/refs/heads/main/json-structure/amazon-eventbridge-pipes-pipe-enrichment-parameters-structure.json",
  "name": "PipeEnrichmentParameters",
  "description": "The parameters required to set up enrichment on your pipe.",
  "type": "object",
  "properties": {
    "HttpParameters": {
      "allOf": [
        {
          "$ref": "#/components/schemas/PipeEnrichmentHttpParameters"
        },
        {
          "description": "<p>Contains the HTTP parameters to use when the target is a API Gateway REST endpoint or EventBridge ApiDestination.</p> <p>If you specify an API Gateway REST API or EventBridge ApiDestination as a target, you can use this parameter to specify headers, path parameters, and query string keys/values as part of your target invoking request. If you're using ApiDestinations, the corresponding Connection can also have these values configured. In case of any conflicting keys, values from the Connection take precedence.</p>"
        }
      ]
    },
    "InputTemplate": {
      "allOf": [
        {
          "$ref": "#/components/schemas/InputTemplate"
        },
        {
          "description": "Valid JSON text passed to the enrichment. In this case, nothing from the event itself is passed to the enrichment. For more information, see <a href=\"http://www.rfc-editor.org/rfc/rfc7159.txt\">The JavaScript Object Notation (JSON) Data Interchange Format</a>."
        }
      ]
    }
  }
}