Interface AwsServiceRequestConfiguration.Builder
- All Superinterfaces:
Buildable,CopyableBuilder<AwsServiceRequestConfiguration.Builder,,AwsServiceRequestConfiguration> SdkBuilder<AwsServiceRequestConfiguration.Builder,,AwsServiceRequestConfiguration> SdkPojo
- Enclosing class:
AwsServiceRequestConfiguration
-
Method Summary
Modifier and TypeMethodDescriptionAn expression that evaluates to the request body for the AWS service API call.A map of HTTP header names to expression values.methodType(String methodType) Specifies how the function sends the request to the target service.methodType(MethodType methodType) Specifies how the function sends the request to the target service.A map of output bindings.requestTimeoutMilliseconds(Integer requestTimeoutMilliseconds) The maximum time, in milliseconds, that MediaTailor waits for a response from the AWS service.The expression language used to evaluate expressions in the function configuration.runtime(RuntimeType runtime) The expression language used to evaluate expressions in the function configuration.targetRegion(String targetRegion) The AWS Region for the target service.targetService(String targetService) The AWS service to call.An expression that evaluates to the endpoint URL for the target AWS service API operation.Methods inherited from interface software.amazon.awssdk.utils.builder.CopyableBuilder
copyMethods inherited from interface software.amazon.awssdk.utils.builder.SdkBuilder
applyMutation, buildMethods inherited from interface software.amazon.awssdk.core.SdkPojo
equalsBySdkFields, sdkFieldNameToField, sdkFields
-
Method Details
-
runtime
The expression language used to evaluate expressions in the function configuration. The only supported value is
JSONata.- Parameters:
runtime- The expression language used to evaluate expressions in the function configuration. The only supported value isJSONata.- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-
runtime
The expression language used to evaluate expressions in the function configuration. The only supported value is
JSONata.- Parameters:
runtime- The expression language used to evaluate expressions in the function configuration. The only supported value isJSONata.- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-
output
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 theresponseobject from the target service. For more information, see JSONata expression reference in the MediaTailor User Guide.- Parameters:
output- A map of output bindings. Each key is a namespaced output path, such asplayer_params.device_type. Each value is an expression that MediaTailor evaluates at runtime and can reference theresponseobject from the target service. For more information, see JSONata expression reference in the MediaTailor User Guide.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
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.
- Parameters:
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.
-
- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-
-
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.
- Parameters:
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.
-
- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-
-
requestTimeoutMilliseconds
AwsServiceRequestConfiguration.Builder requestTimeoutMilliseconds(Integer requestTimeoutMilliseconds) 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
nulland proceeds with output expression evaluation. Valid values:100to2000.- Parameters:
requestTimeoutMilliseconds- 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 tonulland proceeds with output expression evaluation. Valid values:100to2000.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
url
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 inTargetService. The maximum length after evaluation is 2,048 characters.- Parameters:
url- 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 inTargetService. The maximum length after evaluation is 2,048 characters.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
body
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.
- Parameters:
body- 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.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
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 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.
- Parameters:
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 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.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
targetService
The AWS service to call. Valid value:
elemental-inference(AWS Elemental Inference).- Parameters:
targetService- The AWS service to call. Valid value:elemental-inference(AWS Elemental Inference).- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
targetRegion
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%}).- Parameters:
targetRegion- 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%}).- Returns:
- Returns a reference to this object so that method calls can be chained together.
-