Interface AwsServiceRequestConfiguration.Builder

  • 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 is JSONata.
      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 is JSONata.
      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 the response object 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 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.
      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 null and proceeds with output expression evaluation. Valid values: 100 to 2000.

      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 to null and proceeds with output expression evaluation. Valid values: 100 to 2000.
      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 in TargetService. 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 in TargetService. 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

      AwsServiceRequestConfiguration.Builder targetService(String 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

      AwsServiceRequestConfiguration.Builder targetRegion(String 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.