AWS CLI Command Reference

Note:

You are viewing the documentation for an older major version of the AWS CLI (version 1). To view this page for the AWS CLI version 2, click here.

We announced the upcoming end-of-support for the AWS CLI v1. For dates, additional details, and information on how to migrate, please refer to the linked announcement. For more information see the AWS CLI version 2 installation instructions and migration guide.

[ aws . mediatailor ]

get-function

Description

Retrieves the configuration and metadata for a function. For more information about functions, see Working with functions in the MediaTailor User Guide .

See also: AWS API Documentation

Synopsis

  get-function
--function-id <value>
[--cli-input-json <value>]
[--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>]
[--v2-debug]

Options

--function-id (string)

The identifier of the function.

--cli-input-json (string) Performs service operation based on the JSON string provided. The JSON string follows the format provided by --generate-cli-skeleton. If other arguments are provided on the command line, the CLI 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.

--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. If provided with the value output, it validates the command inputs and returns a sample output JSON for that command.

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

--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.

--v2-debug (boolean)

Enable AWS CLI v2 migration assistance. Prints warnings if the command would face a breaking change after swapping AWS CLI v1 for AWS CLI v2 in the current environment. Prints one warning for each breaking change detected.

Output

FunctionId -> (string)

The identifier of the function.

FunctionType -> (string)

The type of the function.

Description -> (string)

A description of the function.

HttpRequestConfiguration -> (structure)

The configuration for an HTTP_REQUEST function.

Runtime -> (string)

The expression language used to evaluate expressions in the function configuration. Set this to 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)

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

RequestTimeoutMilliseconds -> (integer)

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)

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)

The expression language used to evaluate expressions in the function configuration. Set this to 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)

The expression language used to evaluate expressions in the function configuration. Set this to 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)

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)

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.