List functions

async AsyncCogniteClient.functions.list(
name: str | None = None,
owner: str | None = None,
file_id: int | None = None,
status: Literal['Queued', 'Deploying', 'Ready', 'Failed'] | None = None,
external_id_prefix: str | None = None,
created_time: dict[Literal['min', 'max'], int] | TimestampRange | None = None,
metadata: dict[str, str] | None = None,
limit: int | None = 25,
) → FunctionList

List all functions.

Parameters:

  • name (str | None) – The name of the function.

  • owner (str | None) – Owner of the function.

  • file_id (int | None) – The file ID of the zip-file used to create the function.

  • status (FunctionStatus | None) – Status of the function. Possible values: [“Queued”, “Deploying”, “Ready”, “Failed”].

  • external_id_prefix (str | None) – External ID prefix to filter on.

  • created_time (dict[Literal['min', 'max'], int] | TimestampRange | None) – Range between two timestamps. Possible keys are min and max, with values given as time stamps in ms.

  • metadata (dict[str, str] | None) – Custom, application-specific metadata. String key -> String value. Limits: Maximum length of key is 32, value 512 characters, up to 16 key-value pairs. Maximum size of entire metadata is 4096 bytes.

  • limit (int | None) – Maximum number of functions to return. Pass in -1, float(‘inf’) or None to list all.

Returns:

List of functions

Return type:

FunctionList

Example

List functions:

>>> from cognite.client import CogniteClient, AsyncCogniteClient
>>> client = CogniteClient()
>>> # async_client = AsyncCogniteClient()  # another option
>>> functions_list = client.functions.list()