get-function-definition-version¶

Description¶

Retrieves information about a Lambda function definition version, including which Lambda functions are included in the version and their configurations.

Synopsis¶

  get-function-definition-version
--function-definition-id <value>
--function-definition-version-id <value>
[--next-token <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]

Options¶

--function-definition-id (string) The ID of the Lambda function definition.

--function-definition-version-id (string) The ID of the function definition version. This value maps to the ‘’Version’’ property of the corresponding ‘’VersionInformation’’ object, which is returned by ‘’ListFunctionDefinitionVersions’’ requests. If the version is the last one that was associated with a function definition, the value also maps to the ‘’LatestVersion’’ property of the corresponding ‘’DefinitionInformation’’ object.

--next-token (string) The token for the next set of results, or ‘’null’’ if there are no additional results.

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

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

Examples¶

Note

To use the following examples, you must have the AWS CLI installed and configured. See the Getting started guide in the AWS CLI User Guide for more information.

Unless otherwise stated, all examples have unix-like quotation rules. These examples will need to be adapted to your terminal’s quoting rules. See Using quotation marks with strings in the AWS CLI User Guide .

To retrieve details about a specific version of a Lambda function

The following get-function-definition-version retrieves information about the specified version of the specified function definition. To retrieve the IDs of all versions of the function definition, use the list-function-definition-versions command. To retrieve the ID of the last version added to the function definition, use the get-function-definition command and check the LatestVersion property.

aws greengrass get-function-definition-version \
    --function-definition-id "063f5d1a-1dd1-40b4-9b51-56f8993d0f85" \
    --function-definition-version-id "9748fda7-1589-4fcc-ac94-f5559e88678b"

Output:

{
    "Arn": "arn:aws:greengrass:us-west-2:123456789012:/greengrass/definition/functions/063f5d1a-1dd1-40b4-9b51-56f8993d0f85/versions/9748fda7-1589-4fcc-ac94-f5559e88678b",
    "CreationTimestamp": "2019-06-18T17:04:30.776Z",
    "Definition": {
        "Functions": [
            {
                "FunctionArn": "arn:aws:lambda:::function:GGIPDetector:1",
                "FunctionConfiguration": {
                    "Environment": {},
                    "MemorySize": 32768,
                    "Pinned": true,
                    "Timeout": 3
                },
                "Id": "26b69bdb-e547-46bc-9812-84ec04b6cc8c"
            },
            {
                "FunctionArn": "arn:aws:lambda:us-west-2:123456789012:function:Greengrass_HelloWorld:GG_HelloWorld",
                "FunctionConfiguration": {
                    "EncodingType": "json",
                    "Environment": {
                        "Variables": {}
                    },
                    "MemorySize": 16384,
                    "Pinned": true,
                    "Timeout": 25
                },
                "Id": "384465a8-eedf-48c6-b793-4c35f7bfae9b"
            }
        ]
    },
    "Id": "063f5d1a-1dd1-40b4-9b51-56f8993d0f85",
    "Version": "9748fda7-1589-4fcc-ac94-f5559e88678b"
}

Output¶

Arn -> (string)

The ARN of the function definition version.

CreationTimestamp -> (string)

The time, in milliseconds since the epoch, when the function definition version was created.

Definition -> (structure)

Information on the definition.

DefaultConfig -> (structure)

The default configuration that applies to all Lambda functions in this function definition version. Individual Lambda functions can override these settings.

Execution -> (structure)

Configuration information that specifies how a Lambda function runs.

IsolationMode -> (string)

Specifies whether the Lambda function runs in a Greengrass container (default) or without containerization. Unless your scenario requires that you run without containerization, we recommend that you run in a Greengrass container. Omit this value to run the Lambda function with the default containerization for the group.

RunAs -> (structure)

Specifies the user and group whose permissions are used when running the Lambda function. You can specify one or both values to override the default values. We recommend that you avoid running as root unless absolutely necessary to minimize the risk of unintended changes or malicious attacks. To run as root, you must set ‘’IsolationMode’’ to ‘’NoContainer’’ and update config.json in ‘’greengrass-root/config’’ to set ‘’allowFunctionsToRunAsRoot’’ to ‘’yes’’.

Gid -> (integer)

The group ID whose permissions are used to run a Lambda function.

Uid -> (integer)

The user ID whose permissions are used to run a Lambda function.

Functions -> (list)

A list of Lambda functions in this function definition version.

(structure)

Information about a Lambda function.

FunctionArn -> (string)

The ARN of the Lambda function.

FunctionConfiguration -> (structure)

The configuration of the Lambda function.

EncodingType -> (string)

The expected encoding type of the input payload for the function. The default is ‘’json’’.

Environment -> (structure)

The environment configuration of the function.

AccessSysfs -> (boolean)

If true, the Lambda function is allowed to access the host’s /sys folder. Use this when the Lambda function needs to read device information from /sys. This setting applies only when you run the Lambda function in a Greengrass container.

Execution -> (structure)

Configuration related to executing the Lambda function

IsolationMode -> (string)

Specifies whether the Lambda function runs in a Greengrass container (default) or without containerization. Unless your scenario requires that you run without containerization, we recommend that you run in a Greengrass container. Omit this value to run the Lambda function with the default containerization for the group.

RunAs -> (structure)

Specifies the user and group whose permissions are used when running the Lambda function. You can specify one or both values to override the default values. We recommend that you avoid running as root unless absolutely necessary to minimize the risk of unintended changes or malicious attacks. To run as root, you must set ‘’IsolationMode’’ to ‘’NoContainer’’ and update config.json in ‘’greengrass-root/config’’ to set ‘’allowFunctionsToRunAsRoot’’ to ‘’yes’’.

Gid -> (integer)

The group ID whose permissions are used to run a Lambda function.

Uid -> (integer)

The user ID whose permissions are used to run a Lambda function.

ResourceAccessPolicies -> (list)

A list of the resources, with their permissions, to which the Lambda function will be granted access. A Lambda function can have at most 10 resources. ResourceAccessPolicies apply only when you run the Lambda function in a Greengrass container.

(structure)

A policy used by the function to access a resource.

Permission -> (string)

The permissions that the Lambda function has to the resource. Can be one of ‘’rw’’ (read/write) or ‘’ro’’ (read-only).

ResourceId -> (string)

The ID of the resource. (This ID is assigned to the resource when you create the resource definiton.)

Variables -> (map)

Environment variables for the Lambda function’s configuration.

key -> (string)

value -> (string)

ExecArgs -> (string)

The execution arguments.

Executable -> (string)

The name of the function executable.

MemorySize -> (integer)

The memory size, in KB, which the function requires. This setting is not applicable and should be cleared when you run the Lambda function without containerization.

Pinned -> (boolean)

True if the function is pinned. Pinned means the function is long-lived and starts when the core starts.

Timeout -> (integer)

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

FunctionRuntimeOverride -> (string)

The Lambda runtime supported by Greengrass which is to be used instead of the one specified in the Lambda function.

Id -> (string)

A descriptive or arbitrary ID for the function. This value must be unique within the function definition version. Max length is 128 characters with pattern ‘’[a-zA-Z0-9:_-]+’’.

Id -> (string)

The ID of the function definition version.

NextToken -> (string)

The token for the next set of results, or ‘’null’’ if there are no additional results.

Version -> (string)

The version of the function definition version.

Table of Contents

Feedback

User Guide