Table Of Contents

Feedback

User Guide

First time using the AWS CLI? See the User Guide for help getting started.

[ aws . lambda ]

get-function-configuration

Description

Returns the configuration information of the Lambda function. This the same information you provided as parameters when uploading the function by using create-function .

If you are using the versioning feature, you can retrieve this information for a specific function version by using the optional qualifier parameter and specifying the function version or alias that points to it. If you don't provide it, the API returns information about the $LATEST version of the function. For more information about versioning, see AWS Lambda Function Versioning and Aliases .

This operation requires permission for the lambda:GetFunctionConfiguration operation.

See also: AWS API Documentation

See 'aws help' for descriptions of global parameters.

Synopsis

  get-function-configuration
--function-name <value>
[--qualifier <value>]
[--cli-input-json <value>]
[--generate-cli-skeleton <value>]

Options

--function-name (string)

The name of the Lambda function for which you want to retrieve the configuration information.

You can specify a function name (for example, Thumbnail ) or you can specify Amazon Resource Name (ARN) of the function (for example, arn:aws:lambda:us-west-2:account-id:function:ThumbNail ). AWS Lambda also allows you to specify a partial ARN (for example, account-id:Thumbnail ). Note that the length constraint applies only to the ARN. If you specify only the function name, it is limited to 64 characters in length.

--qualifier (string)

Using this optional parameter you can specify a function version or an alias name. If you specify function version, the API uses qualified function ARN and returns information about the specific function version. If you specify an alias name, the API uses the alias ARN and returns information about the function version to which the alias points.

If you don't specify this parameter, the API uses unqualified function ARN, and returns information about the $LATEST function version.

--cli-input-json (string) Performs service operation based on the JSON string provided. The JSON string follows the format provided by --generate-cli-skeleton. If other arguments are provided on the command line, the CLI values will override the JSON-provided values.

--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. If provided with the value output, it validates the command inputs and returns a sample output JSON for that command.

See 'aws help' for descriptions of global parameters.

Output

FunctionName -> (string)

The name of the function. Note that the length constraint applies only to the ARN. If you specify only the function name, it is limited to 64 characters in length.

FunctionArn -> (string)

The Amazon Resource Name (ARN) assigned to the function.

Runtime -> (string)

The runtime environment for the Lambda function.

Role -> (string)

The Amazon Resource Name (ARN) of the IAM role that Lambda assumes when it executes your function to access any other Amazon Web Services (AWS) resources.

Handler -> (string)

The function Lambda calls to begin executing your function.

CodeSize -> (long)

The size, in bytes, of the function .zip file you uploaded.

Description -> (string)

The user-provided description.

Timeout -> (integer)

The function execution time at which Lambda should terminate the function. Because the execution time has cost implications, we recommend you set this value based on your expected execution time. The default is 3 seconds.

MemorySize -> (integer)

The memory size, in MB, you configured for the function. Must be a multiple of 64 MB.

LastModified -> (string)

The time stamp of the last time you updated the function. The time stamp is conveyed as a string complying with ISO-8601 in this way YYYY-MM-DDThh:mm:ssTZD (e.g., 1997-07-16T19:20:30+01:00). For more information, see Date and Time Formats .

CodeSha256 -> (string)

It is the SHA256 hash of your function deployment package.

Version -> (string)

The version of the Lambda function.

VpcConfig -> (structure)

VPC configuration associated with your Lambda function.

SubnetIds -> (list)

A list of subnet IDs associated with the Lambda function.

(string)

SecurityGroupIds -> (list)

A list of security group IDs associated with the Lambda function.

(string)

VpcId -> (string)

The VPC ID associated with you Lambda function.

DeadLetterConfig -> (structure)

The parent object that contains the target ARN (Amazon Resource Name) of an Amazon SQS queue or Amazon SNS topic.

TargetArn -> (string)

The Amazon Resource Name (ARN) of an Amazon SQS queue or Amazon SNS topic you specify as your Dead Letter Queue (DLQ).

Environment -> (structure)

The parent object that contains your environment's configuration settings.

Variables -> (map)

The key-value pairs returned that represent your environment's configuration settings or error information.

key -> (string)

value -> (string)

Error -> (structure)

The parent object that contains error information associated with your configuration settings.

ErrorCode -> (string)

The error code returned by the environment error object.

Message -> (string)

The message returned by the environment error object.

KMSKeyArn -> (string)

The Amazon Resource Name (ARN) of the KMS key used to encrypt your function's environment variables. If empty, it means you are using the AWS Lambda default service key.

TracingConfig -> (structure)

The parent object that contains your function's tracing settings.

Mode -> (string)

The tracing mode associated with your Lambda function.

MasterArn -> (string)

Returns the ARN (Amazon Resource Name) of the master function.

RevisionId -> (string)

Represents the latest updated revision of the function or alias.