HttpRequestConfiguration
The configuration for an HTTP_REQUEST function. Specifies the HTTP method, URL, headers, body, timeout, and output expressions for the request. For more information, see HTTP_REQUEST in the MediaTailor User Guide.
Contents
- MethodType
-
The HTTP method for the request. Valid values:
GETandPOST.Type: String
Valid Values:
GET | POSTRequired: Yes
- RequestTimeoutMilliseconds
-
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
nulland proceeds with output expression evaluation. Valid values:100to2000.Type: Integer
Required: Yes
- Runtime
-
The expression language used to evaluate expressions in the function configuration. Set this to
JSONata.Type: String
Valid Values:
JSONATARequired: Yes
- Url
-
An expression that evaluates to the request URL. Use
{%...%}delimiters for dynamic expressions. The maximum length after evaluation is 2,048 characters.Type: String
Required: Yes
- Body
-
An expression that evaluates to the request body. Used with
POSTrequests. The maximum size after evaluation is 64 KB.Type: String
Required: No
- Headers
-
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.
Type: String to string map
Required: No
- Output
-
A map of output bindings. Each key is a namespaced output path (such as
player_params.device_typeortemp.identity), and each value is an expression that MediaTailor evaluates at runtime. Output expressions in anHTTP_REQUESTfunction can reference theresponseobject returned by the HTTP call. For more information about expression syntax, see JSONata expression reference in the MediaTailor User Guide.Type: String to string map
Required: No
See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following: