<a id="cli-aws-elementalinference-list-functions"></a>

# list-functions

## Description

Lists the functions in this account, in this Region. Each entry is a summary. To get the expressions of a function, use GetFunction.

See also: [AWS API Documentation](https://docs.aws.amazon.com/goto/WebAPI/elementalinference-2018-11-14/ListFunctions)

`list-functions` is a paginated operation. Multiple API calls may be issued in order to retrieve the entire data set of results. You can disable pagination by providing the `--no-paginate` argument.
When using `--output text` and the `--query` argument on a paginated response, the `--query` argument must extract data from the results of the following query expressions: `functions`

## Synopsis

```
  list-functions
[--starting-token <value>]
[--page-size <value>]
[--max-items <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>]
[--help]
```

## Options

`--starting-token` (string)

> A token to specify where to start paginating. This is the `NextToken` from a previously truncated response.

> For usage examples, see [Pagination](https://docs.aws.amazon.com/cli/latest/userguide/pagination.html) in the *AWS Command Line Interface User Guide* .

`--page-size` (integer)

> The size of each page to get in the AWS service call. This does not affect the number of items returned in the command’s output. Setting a smaller page size results in more calls to the AWS service, retrieving fewer items in each call. This can help prevent the AWS service calls from timing out.

> For usage examples, see [Pagination](https://docs.aws.amazon.com/cli/latest/userguide/pagination.html) in the *AWS Command Line Interface User Guide* .

> Constraints:

> * min: `1`
> * max: `100`

`--max-items` (integer)

> The total number of items to return in the command’s output. If the total number of items available is more than the value specified, a `NextToken` is provided in the command’s output. To resume pagination, provide the `NextToken` value in the `starting-token` argument of a subsequent command. **Do not** use the `NextToken` response element directly outside of the AWS CLI.

> For usage examples, see [Pagination](https://docs.aws.amazon.com/cli/latest/userguide/pagination.html) in the *AWS Command Line Interface User Guide* .

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

`--help` (boolean)

Display help for the command/subcommand.

## Output

functions -> (list)

> An array of function summaries.

> (structure)

> > Contains identifying and configuration details for a function, including its name, target, status, and derived media context.

> > arn -> (string) [required]

> > > The ARN of the function.

> > id -> (string) [required]

> > > The ID of the function.

> > > Constraints:

> > > * pattern: `[a-z0-9]{19}`

> > name -> (string) [required]

> > > The name of the function.

> > > Constraints:

> > > * pattern: `[a-zA-Z0-9]([a-zA-Z0-9-_]{0,126}[a-zA-Z0-9])?`

> > description -> (string)

> > > The description of the function.

> > > Constraints:

> > > * min: `0`
> > > * max: `1024`
> > > * pattern: `[\w \-\.',@:;]*`

> > status -> (string) [required]

> > > The status of the function.

> > > Possible values:

> > > * `CREATING`
> > > * `AVAILABLE`
> > > * `REFERENCED`
> > > * `DELETING`
> > > * `DELETED`

> > target -> (tagged union structure)

> > > The destination for the request that the function builds.

> > > #### NOTE
> > > This is a Tagged Union structure. Only one of the following top level keys can be set: `bedrock`, `passthrough`.

> > > bedrock -> (structure)

> > > > Send the request to an Amazon Bedrock model.

> > > > api -> (string) [required]

> > > > > The Amazon Bedrock API to call. The only valid value is INVOKE_MODEL.

> > > > > Possible values:

> > > > > * `INVOKE_MODEL`

> > > > model -> (string) [required]

> > > > > The model to invoke. Specify one of the following:

> > > > > * A model ID.
> > > > > * An inference profile ID.
> > > > > * The ARN of a custom model.
> > > > > * The ARN of a provisioned model.

> > > > > Elemental Inference invokes the model in the Region of the feed. To use a model in other Regions, specify a cross-Region inference profile ID. A custom or provisioned model must be in the Region of the feed.

> > > > > The request expression must produce a request body that this model accepts, and the model must accept the kind of media that the request expression references. For example, a text-only model can’t accept a request that references media.frames.

> > > > > Constraints:

> > > > > * min: `1`
> > > > > * max: `2048`
> > > > > * pattern: `([a-z0-9-]{1,63}[.][a-z0-9-.:]{1,76}|arn:aws:bedrock:[a-z0-9-]{1,20}:[0-9]{12}:(custom-model|provisioned-model)/.+)`

> > > passthrough -> (structure)

> > > > Send the request nowhere. Use this target to reshape the metadata that Elemental Inference already produces, with no model invocation and no model charges.

> > contextTypes -> (list)

> > > The kinds of media context that this function uses. Elemental Inference derives this field from the media paths that the request expression references; you can’t set it. An empty list means that the expression references no media, so Elemental Inference supplies none at run time.

> > > Constraints:

> > > * min: `0`
> > > * max: `10`

> > > (string)

> > > > One kind of media context that a function reads. Elemental Inference derives this value from the media paths that the request expression references:

> > > > * FRAMES – Derived from media.frames.
> > > > * SUBTITLES – Derived from media.transcript.
> > > > * CONTEXTUAL_METADATA – Derived from media.contextual.
> > > > * CLIP_METADATA – Derived from media.clip.

> > > > A request expression can reference at most one of SUBTITLES, CONTEXTUAL_METADATA, and CLIP_METADATA, in addition to FRAMES.

> > > > Possible values:

> > > > * `FRAMES`
> > > > * `SUBTITLES`
> > > > * `CONTEXTUAL_METADATA`
> > > > * `CLIP_METADATA`

nextToken -> (string)

> The token to use in a subsequent request to get the next page of results. This field is absent when there are no more results.
