AWS Lambda

Describe function

Get details about a function.

Inputs

Field

Type

Description

region [required]

enum

default: us-east-1

resourceId [required]

string

The name of the Lambda function, version, or alias. This can be the function name ("my-function"), name with alias ("my-function:v1"), ARN ("arn:aws:lambda:us-west-2:123456789012:function:my-function"), or partial ARN ("123456789012:function:my-function").

Outputs

Expand All

Field

Type

Description

function [required]

object

Arn

string

Unique identifier for function resources

DeadLetterConfig

object

A dead letter queue configuration that specifies the queue or topic where Lambda sends asynchronous events when they fail processing.

TargetArn

string

The Amazon Resource Name (ARN) of an Amazon SQS queue or Amazon SNS topic.

Description

string

A description of the function.

Environment

object

Environment variables that are accessible from function code during execution.

Variables

object

EphemeralStorage

object

A function's ephemeral storage settings.

Size [required]

number

The amount of ephemeral storage that your function has access to.

FileSystemConfigs

[object]

Connection settings for an Amazon EFS file system. To connect a function to a file system, a mount target must be available in every Availability Zone that your function connects to. If your template contains an AWS::EFS::MountTarget resource, you must also specify a DependsOn attribute to ensure that the mount target is created or updated before the function.

Arn [required]

string

Unique identifier for function resources

LocalMountPath [required]

string

The path where the function can access the file system, starting with /mnt/.

FunctionName

string

The name of the Lambda function, up to 64 characters in length. If you don't specify a name, AWS CloudFormation generates one.

Handler

string

The name of the method within your code that Lambda calls to execute your function. The format includes the file name. It can also include namespaces and other qualifiers, depending on the runtime

Architectures

[string]

KmsKeyArn

string

The ARN of the AWS Key Management Service (AWS KMS) key that's used to encrypt your function's environment variables. If it's not provided, AWS Lambda uses a default service key.

Layers

[string]

A list of function layers to add to the function's execution environment. Specify each layer by its ARN, including the version.

MemorySize

number

The amount of memory that your function has access to. Increasing the function's memory also increases its CPU allocation. The default value is 128 MB. The value must be a multiple of 64 MB.

ReservedConcurrentExecutions

number

The number of simultaneous executions to reserve for the function.

Role

string

The Amazon Resource Name (ARN) of the function's execution role.

Runtime

string

The identifier of the function's runtime.

Tags

[object]

A list of tags to apply to the function.

Key [required]

string

The key name of the tag. You can specify a value that is 1 to 128 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -.

Value

string

The value for the tag. You can specify a value that is 0 to 256 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -.

Timeout

number

The amount of time that Lambda allows a function to run before stopping it. The default is 3 seconds. The maximum allowed value is 900 seconds.

TracingConfig

object

Set Mode to Active to sample and trace a subset of incoming requests with AWS X-Ray.

Mode

enum

VpcConfig

object

For network connectivity to AWS resources in a VPC, specify a list of security groups and subnets in the VPC.

SecurityGroupIds

[string]

A list of VPC security groups IDs.

SubnetIds

[string]

A list of VPC subnet IDs.

CodeSigningConfigArn

string

A unique Arn for CodeSigningConfig resource

ImageConfig

object

EntryPoint

[string]

Command

[string]

WorkingDirectory

string

PackageType

enum