AWS Lambda Command Line Interface (CLI) Examples (with examples)
Run a function
aws lambda invoke --function-name name path/to/response.json
Motivation: The command is used to run a specific Lambda function and capture the output in a JSON file. This allows users to quickly test the Lambda function and verify its behavior.
Explanation:
--function-name: Specifies the name of the Lambda function to be invoked.name: Replace it with the actual name of the Lambda function.path/to/response.json: Specifies the path and filename to store the invocation response in a JSON file.
Example Output:
{
"StatusCode": 200,
"ExecutedVersion": "$LATEST"
...
}
Run a function with an input payload in JSON format
aws lambda invoke --function-name name --payload json path/to/response.json
Motivation: This command allows passing an input payload in JSON format while running a Lambda function. This is useful when testing the function with different inputs and checking if the function handles them correctly.
Explanation:
--function-name: Specifies the name of the Lambda function to be invoked.name: Replace it with the actual name of the Lambda function.--payload: Specifies the input payload in JSON format.json: Replace it with the actual JSON payload.path/to/response.json: Specifies the path and filename to store the invocation response in a JSON file.
Example Output:
{
"StatusCode": 200,
"ExecutedVersion": "$LATEST"
...
}
List functions
aws lambda list-functions
Motivation: This command provides a quick way to retrieve a list of Lambda functions associated with the AWS account. It helps users to check the existing functions, their names, and their configuration.
Explanation: This command does not require any additional arguments.
Example Output:
{
"Functions": [
{
"FunctionName": "FunctionA",
"Runtime": "python3.8",
...
},
{
"FunctionName": "FunctionB",
"Runtime": "nodejs12.x",
...
},
...
]
}
Display the configuration of a function
aws lambda get-function-configuration --function-name name
Motivation: This command provides detailed information about the configuration of a specific Lambda function. It includes details such as function name, runtime, memory size, and environment variables.
Explanation:
--function-name: Specifies the name of the Lambda function.name: Replace it with the actual name of the Lambda function.
Example Output:
{
"FunctionName": "MyFunction",
"Runtime": "python3.8",
"MemorySize": 128,
...
}
List function aliases
aws lambda list-aliases --function-name name
Motivation: This command retrieves a list of all the aliases associated with a particular Lambda function. Aliases are helpful when managing different versions of the function in different environments (e.g., production, staging, development).
Explanation:
--function-name: Specifies the name of the Lambda function.name: Replace it with the actual name of the Lambda function.
Example Output:
{
"Aliases": [
{
"AliasArn": "arn:aws:lambda:us-west-2:123456789012:function:MyFunction:PROD",
"Name": "PROD",
...
},
{
"AliasArn": "arn:aws:lambda:us-west-2:123456789012:function:MyFunction:DEV",
"Name": "DEV",
...
}
]
}
Display the reserved concurrency configuration for a function
aws lambda get-function-concurrency --function-name name
Motivation: The command helps retrieve the reserved concurrency configuration for a specific Lambda function. Reserved concurrency ensures that a specific number of function invocations are allowed to happen concurrently.
Explanation:
--function-name: Specifies the name of the Lambda function.name: Replace it with the actual name of the Lambda function.
Example Output:
{
"ReservedConcurrentExecutions": 5
}
List which AWS services can invoke the function
aws lambda get-policy --function-name name
Motivation: This command allows users to view the AWS service principal permissions associated with a specific Lambda function. It provides information about which services are authorized to invoke the function.
Explanation:
--function-name: Specifies the name of the Lambda function.name: Replace it with the actual name of the Lambda function.
Example Output:
{
"Policy": "{\"Version\":\"2012-10-17\",\"Statement\":[{\"Sid\":\"AllowAPIGatewayInvoke\",\"Effect\":\"Allow\",\"Principal\":{\"Service\":\"apigateway.amazonaws.com\"},\"Action\":\"lambda:InvokeFunction\",\"Resource\":\"arn:aws:lambda:us-west-2:123456789012:function:MyFunction\",\"Condition\":{\"ArnLike\":{\"AWS:SourceArn\":\"arn:aws:execute-api:us-west-2:123456789012:abcdefghi/*/POST/*\"}}}]}"
}
Conclusion
These 8 examples demonstrate the usage of various AWS Lambda CLI commands. Understanding and utilizing these commands will enable users to effectively manage and interact with their Lambda functions in different scenarios and use cases.
