Retrieves information about a Lambda function definition version, including which Lambda functions are included in the version and their configurations.
URI: GET /greengrass/definition/functions/FunctionDefinitionId/
versions/FunctionDefinitionVersionId Produces: application/json
CLI:
aws greengrass get-function-definition-version \ --function-definition-id <value> \
--function-definition-version-id <value> \ [--next-token <value>] \
[--cli-input-json <value>] \ [--generate-cli-skeleton]
cli-input-json format:
{"FunctionDefinitionId": "string",
"FunctionDefinitionVersionId": "string",
"NextToken": "string"
}
Parameters:
FunctionDefinitionId (p. 587) The ID of the function definition.
where used: path; required: true type: string
FunctionDefinitionVersionId (p. 587)
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.
where used: path; required: true type: string
NextToken (p. 589)
The token for the next set of results, or null if there are no more results.
where used: query; required: false type: string
Responses:
200
Success.
GetFunctionDefinitionVersionResponse (p. 641) { "DefaultConfig": { "Execution": {
"IsolationMode": "GreengrassContainer|NoContainer", "RunAs": {
"FunctionArn": "string", "FunctionConfiguration": { "Pinned": true,
"Executable": "string", "ExecArgs": "string", "MemorySize": 0, "Timeout": 0,
"EncodingType": "binary|json", "Environment": {
"IsolationMode": "GreengrassContainer|NoContainer", "RunAs": {
"NextToken": "string"
}
GetFunctionDefinitionVersionResponse
Information about a function definition version.
type: object Arn
The ARN of the function definition version.
type: string Id
The ID of the function definition version.
type: string Version
The version of the function definition version.
type: string CreationTimestamp
The time, in milliseconds since the epoch, when the function definition version was created.
type: string Definition
Information about a function definition version.
type: object DefaultConfig
The default configuration that applies to all Lambda functions in the group. Individual Lambda functions can override these settings.
type: object Execution
Configuration information that specifies how a Lambda function runs.
Functions
A list of Lambda functions in this function definition version.
type: array
items: Function (p. 617)
Information about a Lambda function.
type: object required: ["Id"]
Id
A descriptive or arbitrary ID for the function. This value must be unique within the function definition version. Maximum length is 128 characters with the pattern [a‑zA‑Z0‑9:_‑]+.
type: string FunctionArn
The ARN of the alias (recommended) or version of the target Lambda function.
type: string FunctionConfiguration
The configuration of the Lambda function.
type: object Pinned
True if the function is pinned. Pinned means the function is long-lived and starts when the core starts.
type: boolean Executable
The name of the function executable.
type: string ExecArgs
The execution arguments.
type: string MemorySize
The memory size, in KB, required by the function. This setting does not apply and should be cleared when you run the Lambda function without containerization.
type: integer Timeout
The allowed function execution time, after which Lambda should terminate the function. This timeout still applies to pinned Lambda functions for each request.
type: integer EncodingType
The expected encoding type of the input payload for the function. The default is json.
type: string
enum: ["binary", "json"]
Environment
The environment configuration of the function.
type: object Variables
Environment variables for the Lambda function's configuration.
type: object
additionalProperties: An object with properties of type string that represent the environment variables.
ResourceAccessPolicies
A list of the resources, with their permissions, to which the Lambda function is granted access. A Lambda function can have at most 10 resources. ResourceAccessPolicies applies only when you run the Lambda function in a Greengrass container.
type: array
items: ResourceAccessPolicy (p. 677) ResourceAccessPolicy
A policy used by the function to access a resource.
type: object
required: ["ResourceId"]
ResourceId
The ID of the resource. (This ID is assigned to the resource when you create the resource definiton.)
type: string Permission
The type of permission a function has to access a resource.
type: string enum: ["ro", "rw"]
AccessSysfs
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.
type: boolean Execution
Configuration information that specifies how a Lambda function runs.
type: object IsolationMode
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.
type: string
enum: ["GreengrassContainer", "NoContainer"]
RunAs
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. To minimize the risk of unintended changes or malicious attacks, we recommend that you avoid running as root unless absolutely necessary. To run as root, you must update config.json in greengrass-root/
config to set allowFunctionsToRunAsRoot to yes.
type: object Uid
The user ID whose permissions are used to run a Lambda function.
type: integer Gid
The group ID whose permissions are used to run a Lambda function.
type: integer NextToken
The token for the next set of results, or null if there are no more results.
type: string 400
Invalid request.
GeneralError (p. 631)
{"Message": "string",
"ErrorDetails": [ {
"DetailedErrorCode": "string", "DetailedErrorMessage": "string"
} ]}
GeneralError
General error information.
type: object
required: ["Message"]
Message
A message that contains information about the error.
type: string ErrorDetails
A list of error details.
type: array
items: ErrorDetail (p. 616) ErrorDetail
Details about the error.
type: object DetailedErrorCode
A detailed error code.
type: string DetailedErrorMessage
A detailed error message.
type: string
GetGroup
Retrieves information about a group.
URI: GET /greengrass/groups/GroupId Produces: application/json
CLI:
aws greengrass get-group \ --group-id <value> \
[--cli-input-json <value>] \ [--generate-cli-skeleton]
cli-input-json format:
{
"GroupId": "string"
}
Parameters:
GroupId (p. 587)
The ID of the Greengrass group.
where used: path; required: true type: string
Responses:
200 (GetGroupResponse) Success.
DefinitionInformation (p. 611)
{"Name": "string",
"Id": "string",
"Arn": "string",
"tags": {
"additionalProperty0": "string", "additionalProperty1": "string", "additionalProperty2": "string"
},"LastUpdatedTimestamp": "string",
"CreationTimestamp": "string",
"LatestVersion": "string",
"LatestVersionArn": "string"
}
DefinitionInformation
Information about a definition.
type: object Name
The name of the definition.
type: string Id
The ID of the definition.
type: string Arn
The ARN of the definition.
type: string tags
The resource tags.
type: object
additionalProperties: The key-value pair for the resource tag. Type: string LastUpdatedTimestamp
The time, in milliseconds since the epoch, when the definition was last updated.
type: string CreationTimestamp
The time, in milliseconds since the epoch, when the definition was created.
type: string LatestVersion
The ID of the latest version associated with the definition.
type: string LatestVersionArn
The ARN of the latest version associated with the definition.
type: string 400
Invalid request.
GeneralError (p. 631) {
"Message": "string",
"ErrorDetails": [
{ "DetailedErrorCode": "string", "DetailedErrorMessage": "string"
} ]}
GeneralError
General error information.
type: object
required: ["Message"]
Message
A message that contains information about the error.
type: string ErrorDetails
A list of error details.
type: array
items: ErrorDetail (p. 616) ErrorDetail
Details about the error.
type: object DetailedErrorCode
A detailed error code.
type: string DetailedErrorMessage
A detailed error message.
type: string