Class: Aws::MediaTailor::Types::VastRequestConfiguration

Inherits:

Struct

• Object
• Struct
• Aws::MediaTailor::Types::VastRequestConfiguration

Includes:

Structure

Defined in:

lib/aws-sdk-mediatailor/types.rb

Overview

The configuration for a VAST_REQUEST function. Specifies the HTTP method, URL, headers, body, timeout, and output expressions for a request to a VAST endpoint. MediaTailor parses the response as VAST and resolves wrapper redirects, then makes the parsed ads available to the function's output expressions. For more information, see Function types and composition in the MediaTailor User Guide.

See Also:

• AWS API Documentation

Constant Summary

SENSITIVE =

[]

Instance Attribute Summary

• #body ⇒ String

  An expression that evaluates to the request body, for example to send an OpenRTB bid request.

• #headers ⇒ Hash<String,String>

  A map of HTTP header names to expression values.

• #method_type ⇒ String

  The HTTP method for the request to the VAST endpoint.

• #output ⇒ Hash<String,String>

  A map of output bindings.

• #request_timeout_milliseconds ⇒ Integer

  The maximum time, in milliseconds, that MediaTailor waits for a response from the VAST endpoint.

• #runtime ⇒ String

  The expression language used to evaluate expressions in the function configuration.

• #url ⇒ String

  An expression that evaluates to the VAST endpoint URL.

Instance Attribute Details

#body ⇒ String

An expression that evaluates to the request body, for example to send an OpenRTB bid request. The expression can be up to 100,000 characters, and the body after evaluation can be up to 64 KB.

Returns:

# File 'lib/aws-sdk-mediatailor/types.rb', line 6537

class VastRequestConfiguration < Struct.new(
  :runtime,
  :output,
  :method_type,
  :request_timeout_milliseconds,
  :url,
  :body,
  :headers)
  SENSITIVE = []
  include Aws::Structure
end

#headers ⇒ Hash<String,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. Headers beginning with X-Amz- are reserved by the service, and method override headers are not allowed.

Returns:

# File 'lib/aws-sdk-mediatailor/types.rb', line 6537

class VastRequestConfiguration < Struct.new(
  :runtime,
  :output,
  :method_type,
  :request_timeout_milliseconds,
  :url,
  :body,
  :headers)
  SENSITIVE = []
  include Aws::Structure
end

#method_type ⇒ String

The HTTP method for the request to the VAST endpoint. Valid values: GET and POST. Use POST to send a bid request body, such as an OpenRTB payload.

Returns:

# File 'lib/aws-sdk-mediatailor/types.rb', line 6537

class VastRequestConfiguration < Struct.new(
  :runtime,
  :output,
  :method_type,
  :request_timeout_milliseconds,
  :url,
  :body,
  :headers)
  SENSITIVE = []
  include Aws::Structure
end

#output ⇒ Hash<String,String>

A map of output bindings. Each key is a namespaced output path (such as temp.wrappedAds), and each value is an expression that MediaTailor evaluates at runtime. Output expressions in a VAST_REQUEST function can reference the response object, which exposes response.parsedAds — the ads parsed from the VAST response after schema validation and wrapper resolution — and response.statusCode. For more information about expression syntax, see JSONata expression reference in the MediaTailor User Guide.

Returns:

# File 'lib/aws-sdk-mediatailor/types.rb', line 6537

class VastRequestConfiguration < Struct.new(
  :runtime,
  :output,
  :method_type,
  :request_timeout_milliseconds,
  :url,
  :body,
  :headers)
  SENSITIVE = []
  include Aws::Structure
end

#request_timeout_milliseconds ⇒ Integer

The maximum time, in milliseconds, that MediaTailor waits for a response from the VAST endpoint. The timeout covers the entire response, including any wrapper redirects that MediaTailor follows. If the call exceeds this timeout, MediaTailor proceeds with an empty ad list and continues output expression evaluation. Valid values: 100 to 2000.

Returns:

# File 'lib/aws-sdk-mediatailor/types.rb', line 6537

class VastRequestConfiguration < Struct.new(
  :runtime,
  :output,
  :method_type,
  :request_timeout_milliseconds,
  :url,
  :body,
  :headers)
  SENSITIVE = []
  include Aws::Structure
end

#runtime ⇒ String

The expression language used to evaluate expressions in the function configuration. Set this to JSONata.

Returns:

# File 'lib/aws-sdk-mediatailor/types.rb', line 6537

class VastRequestConfiguration < Struct.new(
  :runtime,
  :output,
  :method_type,
  :request_timeout_milliseconds,
  :url,
  :body,
  :headers)
  SENSITIVE = []
  include Aws::Structure
end

#url ⇒ String

An expression that evaluates to the VAST endpoint URL. Use {%...%} delimiters for dynamic expressions. A literal value must be an https:// URL. The expression can be up to 25,000 characters, and the URL after evaluation can be up to 2,048 characters.

Returns:

# File 'lib/aws-sdk-mediatailor/types.rb', line 6537

class VastRequestConfiguration < Struct.new(
  :runtime,
  :output,
  :method_type,
  :request_timeout_milliseconds,
  :url,
  :body,
  :headers)
  SENSITIVE = []
  include Aws::Structure
end