HttpRequestConfiguration
¶
Used by
-
AsyncMediaTailorClient Operationsput_function -
MediaTailorClient Operationsput_function
Source code in docs_src/capo_mediatailor/types/http_request_configuration.py
body
instance-attribute
¶
body: NotRequired[__string]
An expression that evaluates to the request body. Used with POST requests. The maximum size after evaluation is 64 KB.
cache
instance-attribute
¶
cache: NotRequired[HttpRequestCacheConfiguration]
The optional response-caching configuration for the function. When present, MediaTailor caches the responses that the function receives from the HTTP endpoint, within the time-to-live (TTL) bounds that you specify. Omit this configuration to disable response caching.
headers
instance-attribute
¶
headers: NotRequired[__mapOf__string]
A map of HTTP header names to expression values. MediaTailor evaluates each header value expression at runtime and includes the result in the outbound HTTP request. Maximum 50 headers.
method_type
instance-attribute
¶
method_type: MethodType
The HTTP method for the request. Valid values: GET and POST.
output
instance-attribute
¶
output: NotRequired[__mapOf__string]
A map of output bindings. Each key is a namespaced output path (such as player_params.device_type or temp.identity), and each value is an expression that MediaTailor evaluates at runtime. Output expressions in an HTTP_REQUEST function can reference the response object returned by the HTTP call. For more information about expression syntax, see JSONata expression reference in the MediaTailor User Guide.
request_timeout_milliseconds
instance-attribute
¶
request_timeout_milliseconds: __integer
The maximum time, in milliseconds, that MediaTailor waits for a response from the external service. If the call exceeds this timeout, MediaTailor sets the response status code to null and proceeds with output expression evaluation. Valid values: 100 to 2000.
runtime
instance-attribute
¶
runtime: RuntimeType
The expression language used to evaluate expressions in the function configuration. Set this to JSONata.