[ aws . mediatailor ]

put-function

Description

Creates or updates a function. A function defines reusable logic that MediaTailor executes at lifecycle hooks during ad insertion. For more information about functions, see Working with functions in the MediaTailor User Guide .

See also: AWS API Documentation

Synopsis

  put-function
--function-id <value>
--function-type <value>
[--description <value>]
[--http-request-configuration <value>]
[--custom-output-configuration <value>]
[--sequential-executor-configuration <value>]
[--tags <value>]
[--cli-input-json | --cli-input-yaml]
[--generate-cli-skeleton <value>]
[--debug]
[--endpoint-url <value>]
[--no-verify-ssl]
[--no-paginate]
[--output <value>]
[--query <value>]
[--profile <value>]
[--region <value>]
[--version <value>]
[--color <value>]
[--no-sign-request]
[--ca-bundle <value>]
[--cli-read-timeout <value>]
[--cli-connect-timeout <value>]
[--cli-binary-format <value>]
[--no-cli-pager]
[--cli-auto-prompt]
[--no-cli-auto-prompt]
[--cli-error-format <value>]

Options

--function-id (string) [required]

The identifier of the function. The identifier must be unique within your account.

--function-type (string) [required]

The type of the function. The function type determines what the function can do at runtime. Valid values: CUSTOM_OUTPUT evaluates expressions and produces output bindings with no external calls. HTTP_REQUEST makes an HTTP call to an external service and evaluates output expressions that can reference the response. SEQUENTIAL_EXECUTOR runs a sequence of child functions in order, passing data between steps through temporary data. For more information, see Function types and composition in the MediaTailor User Guide .

Possible values:

• HTTP_REQUEST
• CUSTOM_OUTPUT
• SEQUENTIAL_EXECUTOR

--description (string)

A description of the function.

--http-request-configuration (structure)

The configuration for an HTTP_REQUEST function. Specifies the HTTP method, URL, headers, body, timeout, and output expressions. Required when FunctionType is HTTP_REQUEST .

Runtime -> (string) [required]

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

Possible values:

• JSONATA

Output -> (map)

A map of output bindings. Each key is a namespaced output path (such as player_params.device_type or temp.identity ), and each value is an expression that MediaTailor evaluates at runtime. Output expressions in an HTTP_REQUEST function can reference the response object returned by the HTTP call. For more information about expression syntax, see JSONata expression reference in the MediaTailor User Guide .

key -> (string)

value -> (string)

MethodType -> (string) [required]

The HTTP method for the request. Valid values: GET and POST .

Possible values:

• GET
• POST

RequestTimeoutMilliseconds -> (integer) [required]

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

Url -> (string) [required]

An expression that evaluates to the request URL. Use {%...%} delimiters for dynamic expressions. The maximum length after evaluation is 2,048 characters.

Body -> (string)

An expression that evaluates to the request body. Used with POST requests. The maximum size after evaluation is 64 KB.

Headers -> (map)

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.

key -> (string)

value -> (string)

Shorthand Syntax:

Runtime=string,Output={KeyName1=string,KeyName2=string},MethodType=string,RequestTimeoutMilliseconds=integer,Url=string,Body=string,Headers={KeyName1=string,KeyName2=string}

JSON Syntax:

{
  "Runtime": "JSONATA",
  "Output": {"string": "string"
    ...},
  "MethodType": "GET"|"POST",
  "RequestTimeoutMilliseconds": integer,
  "Url": "string",
  "Body": "string",
  "Headers": {"string": "string"
    ...}
}

--custom-output-configuration (structure)

The configuration for a CUSTOM_OUTPUT function. Specifies the runtime and output expressions. Required when FunctionType is CUSTOM_OUTPUT .

Runtime -> (string) [required]

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

Possible values:

• JSONATA

Output -> (map)

A map of output bindings. Each key is a namespaced output path (such as player_params.device_type or temp.variant ), and each value is an expression that MediaTailor evaluates at runtime against the current session state. For more information about expression syntax, see JSONata expression reference in the MediaTailor User Guide .

key -> (string)

value -> (string)

Shorthand Syntax:

Runtime=string,Output={KeyName1=string,KeyName2=string}

JSON Syntax:

{
  "Runtime": "JSONATA",
  "Output": {"string": "string"
    ...}
}

--sequential-executor-configuration (structure)

The configuration for a SEQUENTIAL_EXECUTOR function. Specifies the ordered list of child functions to execute, an optional output block, and a timeout. Required when FunctionType is SEQUENTIAL_EXECUTOR .

Runtime -> (string) [required]

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

Possible values:

• JSONATA

Output -> (map)

An optional map of output bindings that controls which bindings the sequence commits to the session state after all steps complete. If omitted, MediaTailor commits all accumulated output bindings from all child steps.

key -> (string)

value -> (string)

FunctionList -> (list) [required]

An ordered list of 1 to 10 steps. Each step specifies a child function to execute and an optional run condition expression that controls whether the step runs. MediaTailor executes steps in order, passing data between steps through temporary data.

(structure)

A reference to a child function within a SEQUENTIAL_EXECUTOR function.

RunCondition -> (string)

An optional expression that evaluates to a boolean. MediaTailor evaluates this expression immediately before running the step, using the accumulated state at that point in the sequence. If the expression evaluates to false , MediaTailor skips the step and moves to the next one. If omitted, the step always runs.

FunctionId -> (string)

The identifier of the child function to execute in this step.

TimeoutMilliseconds -> (integer) [required]

The maximum time, in milliseconds, for the entire sequence to complete. This timeout covers all steps, including any HTTP calls made by child functions. If the sequence exceeds this timeout, MediaTailor discards all output from the sequence and proceeds with default behavior.

Shorthand Syntax:

Runtime=string,Output={KeyName1=string,KeyName2=string},FunctionList=[{RunCondition=string,FunctionId=string},{RunCondition=string,FunctionId=string}],TimeoutMilliseconds=integer

JSON Syntax:

{
  "Runtime": "JSONATA",
  "Output": {"string": "string"
    ...},
  "FunctionList": [
    {
      "RunCondition": "string",
      "FunctionId": "string"
    }
    ...
  ],
  "TimeoutMilliseconds": integer
}

--tags (map)

The tags to assign to the function. Tags are key-value pairs that you can associate with Amazon resources to help with organization, access control, and cost tracking. For more information, see Tagging AWS Elemental MediaTailor Resources .

key -> (string)

value -> (string)

Shorthand Syntax:

KeyName1=string,KeyName2=string

JSON Syntax:

{"string": "string"
  ...}

--cli-input-json | --cli-input-yaml (string) Reads arguments from the JSON string provided. The JSON string follows the format provided by --generate-cli-skeleton. If other arguments are provided on the command line, those values will override the JSON-provided values. It is not possible to pass arbitrary binary values using a JSON-provided value as the string will be taken literally. This may not be specified along with --cli-input-yaml.

--generate-cli-skeleton (string) Prints a JSON skeleton to standard output without sending an API request. If provided with no value or the value input, prints a sample input JSON that can be used as an argument for --cli-input-json. Similarly, if provided yaml-input it will print a sample input YAML that can be used with --cli-input-yaml. If provided with the value output, it validates the command inputs and returns a sample output JSON for that command. The generated JSON skeleton is not stable between versions of the AWS CLI and there are no backwards compatibility guarantees in the JSON skeleton generated.

Global Options

--debug (boolean)

Turn on debug logging.

--endpoint-url (string)

Override command’s default URL with the given URL.

--no-verify-ssl (boolean)

By default, the AWS CLI uses SSL when communicating with AWS services. For each SSL connection, the AWS CLI will verify SSL certificates. This option overrides the default behavior of verifying SSL certificates.

--no-paginate (boolean)

Disable automatic pagination. If automatic pagination is disabled, the AWS CLI will only make one call, for the first page of results.

--output (string)

The formatting style for command output.

• json
• text
• table
• yaml
• yaml-stream
• off

--query (string)

A JMESPath query to use in filtering the response data.

--profile (string)

Use a specific profile from your credential file.

--region (string)

The region to use. Overrides config/env settings.

--version (string)

Display the version of this tool.

--color (string)

Turn on/off color output.

• on
• off
• auto

--no-sign-request (boolean)

Do not sign requests. Credentials will not be loaded if this argument is provided.

--ca-bundle (string)

The CA certificate bundle to use when verifying SSL certificates. Overrides config/env settings.

--cli-read-timeout (int)

The maximum socket read time in seconds. If the value is set to 0, the socket read will be blocking and not timeout. The default value is 60 seconds.

--cli-connect-timeout (int)

The maximum socket connect time in seconds. If the value is set to 0, the socket connect will be blocking and not timeout. The default value is 60 seconds.

--cli-binary-format (string)

The formatting style to be used for binary blobs. The default format is base64. The base64 format expects binary blobs to be provided as a base64 encoded string. The raw-in-base64-out format preserves compatibility with AWS CLI V1 behavior and binary values must be passed literally. When providing contents from a file that map to a binary blob fileb:// will always be treated as binary and use the file contents directly regardless of the cli-binary-format setting. When using file:// the file contents will need to properly formatted for the configured cli-binary-format.

• base64
• raw-in-base64-out

--no-cli-pager (boolean)

Disable cli pager for output.

--cli-auto-prompt (boolean)

Automatically prompt for CLI input parameters.

--no-cli-auto-prompt (boolean)

Disable automatically prompt for CLI input parameters.

--cli-error-format (string)

The formatting style for error output. By default, errors are displayed in enhanced format.

• legacy
• json
• yaml
• text
• table
• enhanced

Output

FunctionId -> (string)

The identifier of the function.

FunctionType -> (string)

The type of the function.

Possible values:

• HTTP_REQUEST
• CUSTOM_OUTPUT
• SEQUENTIAL_EXECUTOR

Description -> (string)

A description of the function.

HttpRequestConfiguration -> (structure)

The configuration for an HTTP_REQUEST function.

Runtime -> (string) [required]

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

Possible values:

• JSONATA

Output -> (map)

A map of output bindings. Each key is a namespaced output path (such as player_params.device_type or temp.identity ), and each value is an expression that MediaTailor evaluates at runtime. Output expressions in an HTTP_REQUEST function can reference the response object returned by the HTTP call. For more information about expression syntax, see JSONata expression reference in the MediaTailor User Guide .

key -> (string)

value -> (string)

MethodType -> (string) [required]

The HTTP method for the request. Valid values: GET and POST .

Possible values:

• GET
• POST

RequestTimeoutMilliseconds -> (integer) [required]

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

Url -> (string) [required]

An expression that evaluates to the request URL. Use {%...%} delimiters for dynamic expressions. The maximum length after evaluation is 2,048 characters.

Body -> (string)

An expression that evaluates to the request body. Used with POST requests. The maximum size after evaluation is 64 KB.

Headers -> (map)

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.

key -> (string)

value -> (string)

CustomOutputConfiguration -> (structure)

The configuration for a CUSTOM_OUTPUT function.

Runtime -> (string) [required]

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

Possible values:

• JSONATA

Output -> (map)

A map of output bindings. Each key is a namespaced output path (such as player_params.device_type or temp.variant ), and each value is an expression that MediaTailor evaluates at runtime against the current session state. For more information about expression syntax, see JSONata expression reference in the MediaTailor User Guide .

key -> (string)

value -> (string)

SequentialExecutorConfiguration -> (structure)

The configuration for a SEQUENTIAL_EXECUTOR function.

Runtime -> (string) [required]

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

Possible values:

• JSONATA

Output -> (map)

An optional map of output bindings that controls which bindings the sequence commits to the session state after all steps complete. If omitted, MediaTailor commits all accumulated output bindings from all child steps.

key -> (string)

value -> (string)

FunctionList -> (list) [required]

An ordered list of 1 to 10 steps. Each step specifies a child function to execute and an optional run condition expression that controls whether the step runs. MediaTailor executes steps in order, passing data between steps through temporary data.

(structure)

A reference to a child function within a SEQUENTIAL_EXECUTOR function.

RunCondition -> (string)

An optional expression that evaluates to a boolean. MediaTailor evaluates this expression immediately before running the step, using the accumulated state at that point in the sequence. If the expression evaluates to false , MediaTailor skips the step and moves to the next one. If omitted, the step always runs.

FunctionId -> (string)

The identifier of the child function to execute in this step.

TimeoutMilliseconds -> (integer) [required]

The maximum time, in milliseconds, for the entire sequence to complete. This timeout covers all steps, including any HTTP calls made by child functions. If the sequence exceeds this timeout, MediaTailor discards all output from the sequence and proceeds with default behavior.

Tags -> (map)

The tags assigned to the function. Tags are key-value pairs that you can associate with Amazon resources to help with organization, access control, and cost tracking. For more information, see Tagging AWS Elemental MediaTailor Resources .

key -> (string)

value -> (string)

Arn -> (string)

The Amazon Resource Name (ARN) of the function.