Menu
AWS Greengrass
API Reference

Function

type: object

Information about a function.

required: Id

properties:

  • Id:

    The id of the Lambda function.

    type: string

  • FunctionArn:

    The arn of the Lambda function.

    type: string

  • FunctionConfiguration:

    The configuration of the function

    FunctionConfiguration:

    type: object

    The configuration of a function

    properties:

    • Pinned:

      Whether the function is pinned or not. Pinned means the function is long-lived and starts when the core starts.

      type: boolean

    • Executable:

      The executable.

      type: string

    • ExecArgs:

      The execution arguments.

      type: string

    • MemorySize:

      The memory size, in KB, which are configured for the function.

      type: integer

    • Timeout:

      The function execution time after which Lambda should terminate the function. This timeout still applies to pinned lambdas for each request.

      type: integer

    • Environment:

      The environment of the function configuration.

      FunctionConfigurationEnvironment:

      type: object

      The Environment of a function configuration.

      properties:

      • Variables:

        The environment variables for the lambda function.

        type: object

        additionalProperties:

        type: string

Example:

Copy
{ "Id": "string", "FunctionArn": "string", "FunctionConfiguration": { "Pinned": true, "Executable": "string", "ExecArgs": "string", "MemorySize": 0, "Timeout": 0, "Environment": { "Variables": { "additionalProperty0": "string", "additionalProperty1": "string", "additionalProperty2": "string" } } } }