Skip to content

PipeEnrichmentParameters

Used by
Source code in docs_src/capo_pipes/types/pipe_enrichment_parameters.py 
12
13
14
15
16
17
18
class PipeEnrichmentParameters(TypedDict, closed=True):
    input_template: NotRequired["capo_pipes.types.input_template.InputTemplate"]
    """<p>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>.</p> <p>To remove an input template, specify an empty string.</p>"""
    http_parameters: NotRequired[
        "capo_pipes.types.pipe_enrichment_http_parameters.PipeEnrichmentHttpParameters"
    ]
    """<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>"""

http_parameters instance-attribute 

http_parameters: NotRequired[PipeEnrichmentHttpParameters]

Contains the HTTP parameters to use when the target is a API Gateway REST endpoint or EventBridge ApiDestination.

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.

input_template instance-attribute 

input_template: NotRequired[InputTemplate]

Valid JSON text passed to the enrichment. In this case, nothing from the event itself is passed to the enrichment. For more information, see The JavaScript Object Notation (JSON) Data Interchange Format.

To remove an input template, specify an empty string.