AwsServiceRequestConfiguration
¶
Used by
-
AsyncMediaTailorClient Operationsput_function -
MediaTailorClient Operationsput_function
Source code in docs_src/capo_mediatailor/types/aws_service_request_configuration.py
body
instance-attribute
¶
body: NotRequired[__string]
An expression that evaluates to the request body for the AWS service API call. The body must conform to the input format that the target service operation expects. Applies only when the target operation accepts a request body. 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 AWS service, 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 request to the AWS service. Use this to pass any headers required by the target service operation. You can include a maximum of 50 headers.
method_type
instance-attribute
¶
method_type: MethodType
Specifies how the function sends the request to the target service. The value must match what the target service operation requires. Valid values:
-
GET– Retrieves data from the target service. -
POST– Submits a request body to the target service.
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. Each value is an expression that MediaTailor evaluates at runtime and can reference the response object from the target service. For more information, 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 AWS 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. The only supported value is JSONata.
target_region
instance-attribute
¶
target_region: __string
The AWS Region for the target service. Specify a static Region code (for example, us-east-1) or a JSONata expression that resolves to a Region code at runtime (for example, {%inference.region%}).
target_service
instance-attribute
¶
target_service: AwsTargetService
The AWS service to call. Valid value: elemental-inference (AWS Elemental Inference).
url
instance-attribute
¶
url: __string
An expression that evaluates to the endpoint URL for the target AWS service API operation. Use {%...%} delimiters for dynamic expressions. The URL must correspond to a valid endpoint for the service specified in TargetService. The maximum length after evaluation is 2,048 characters.