PipeTargetHttpParameters

These are custom parameter to be used when the target is an API Gateway REST APIs or EventBridge ApiDestinations.

Amazon Web ServicesEvent-DrivenIntegrationMessagingServerless

Properties

Name Type Description
HeaderParameters object
PathParameterValues object
QueryStringParameters object
View JSON Schema on GitHub

JSON Schema

amazon-eventbridge-pipes-pipe-target-http-parameters-schema.json Raw ↑
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "https://raw.githubusercontent.com/api-evangelist/amazon-eventbridge-pipes/refs/heads/main/json-schema/amazon-eventbridge-pipes-pipe-target-http-parameters-schema.json",
  "title": "PipeTargetHttpParameters",
  "description": "These are custom parameter to be used when the target is an API Gateway REST APIs or EventBridge ApiDestinations.",
  "type": "object",
  "properties": {
    "HeaderParameters": {
      "allOf": [
        {
          "$ref": "#/components/schemas/HeaderParametersMap"
        },
        {
          "description": "The headers that need to be sent as part of request invoking the API Gateway REST API or EventBridge ApiDestination."
        }
      ]
    },
    "PathParameterValues": {
      "allOf": [
        {
          "$ref": "#/components/schemas/PathParameterList"
        },
        {
          "description": "The path parameter values to be used to populate API Gateway REST API or EventBridge ApiDestination path wildcards (\"*\")."
        }
      ]
    },
    "QueryStringParameters": {
      "allOf": [
        {
          "$ref": "#/components/schemas/QueryStringParametersMap"
        },
        {
          "description": "The query string keys/values that need to be sent as part of request invoking the API Gateway REST API or EventBridge ApiDestination."
        }
      ]
    }
  }
}