2016/12/01 - AWS Lambda - 1 new 9 updated api methods
Changes Adds new API `getAccountSettings`, dotnetcore 1.0 runtime support, DeadLetterConfig, and event source mappings with kinesis streams.
Returns a customer's account settings.
You can use this operation to retrieve Lambda limit information such as code size and concurrency limits. For more information on limits, see AWS Lambda Limits. You can also retrieve resource usage statistics such as code storage usage and function count.
See also: AWS API Documentation
Request Syntax
client.get_account_settings()
dict
Response Syntax
{
'AccountLimit': {
'TotalCodeSize': 123,
'CodeSizeUnzipped': 123,
'CodeSizeZipped': 123,
'ConcurrentExecutions': 123
},
'AccountUsage': {
'TotalCodeSize': 123,
'FunctionCount': 123
}
}
Response Structure
(dict) --
AccountLimit (dict) --
Provides limits of code size and concurrency associated with the current account and region.
TotalCodeSize (integer) --
Maximum size, in megabytes, of a code package you can upload per region. The default size is 75 GB.
CodeSizeUnzipped (integer) --
Size, in bytes, of code/dependencies that you can zip into a deployment package (uncompressed zip/jar size) for uploading. The default limit is 250 MB.
CodeSizeZipped (integer) --
Size, in bytes, of a single zipped code/dependencies package you can upload for your Lambda function(.zip/.jar file). Try using AWS S3 for uploading larger files. Default limit is 50 MB.
ConcurrentExecutions (integer) --
Number of simultaneous executions of your function per region. For more information or to request a limit increase for concurrent executions, see Lambda Function Concurrent Executions. The default limit is 100.
AccountUsage (dict) --
Provides code size usage and function count associated with the current account and region.
TotalCodeSize (integer) --
Total size, in megabytes, of the account's deployment packages per region.
FunctionCount (integer) --
The number of your account's existing functions per region.
{'StartingPosition': {'AT_TIMESTAMP'}, 'StartingPositionTimestamp': 'timestamp'}
Identifies a stream as an event source for a Lambda function. It can be either an Amazon Kinesis stream or an Amazon DynamoDB stream. AWS Lambda invokes the specified function when records are posted to the stream.
This association between a stream source and a Lambda function is called the event source mapping.
Warning
This event source mapping is relevant only in the AWS Lambda pull model, where AWS Lambda invokes the function. For more information, go to AWS Lambda: How it Works in the AWS Lambda Developer Guide .
You provide mapping information (for example, which stream to read from and which Lambda function to invoke) in the request body.
Each event source, such as an Amazon Kinesis or a DynamoDB stream, can be associated with multiple AWS Lambda function. A given Lambda function can be associated with multiple AWS event sources.
If you are using versioning, you can specify a specific function version or an alias via the function name parameter. For more information about versioning, see AWS Lambda Function Versioning and Aliases.
This operation requires permission for the lambda:CreateEventSourceMapping action.
See also: AWS API Documentation
Request Syntax
client.create_event_source_mapping(
EventSourceArn='string',
FunctionName='string',
Enabled=True|False,
BatchSize=123,
StartingPosition='TRIM_HORIZON'|'LATEST'|'AT_TIMESTAMP',
StartingPositionTimestamp=datetime(2015, 1, 1)
)
string
[REQUIRED]
The Amazon Resource Name (ARN) of the Amazon Kinesis or the Amazon DynamoDB stream that is the event source. Any record added to this stream could cause AWS Lambda to invoke your Lambda function, it depends on the BatchSize . AWS Lambda POSTs the Amazon Kinesis event, containing records, to your Lambda function as JSON.
string
[REQUIRED]
The Lambda function to invoke when AWS Lambda detects an event on the stream.
You can specify the 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 ).
If you are using versioning, you can also provide a qualified function ARN (ARN that is qualified with function version or alias name as suffix). For more information about versioning, see AWS Lambda Function Versioning and Aliases
AWS Lambda also allows you to specify only the function name with the account ID qualifier (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 character in length.
boolean
Indicates whether AWS Lambda should begin polling the event source. By default, Enabled is true.
integer
The largest number of records that AWS Lambda will retrieve from your event source at the time of invoking your function. Your function receives an event with all the retrieved records. The default is 100 records.
string
[REQUIRED]
The position in the stream where AWS Lambda should start reading. Valid only for Kinesis streams. For more information, go to ShardIteratorType in the Amazon Kinesis API Reference .
datetime
The timestamp of the data record from which to start reading. Used with shard iterator type AT_TIMESTAMP. If a record with this exact timestamp does not exist, the iterator returned is for the next (later) record. If the timestamp is older than the current trim horizon, the iterator returned is for the oldest untrimmed data record (TRIM_HORIZON). Valid only for Kinesis streams.
dict
Response Syntax
{
'UUID': 'string',
'BatchSize': 123,
'EventSourceArn': 'string',
'FunctionArn': 'string',
'LastModified': datetime(2015, 1, 1),
'LastProcessingResult': 'string',
'State': 'string',
'StateTransitionReason': 'string'
}
Response Structure
(dict) --
Describes mapping between an Amazon Kinesis stream and a Lambda function.
UUID (string) --
The AWS Lambda assigned opaque identifier for the mapping.
BatchSize (integer) --
The largest number of records that AWS Lambda will retrieve from your event source at the time of invoking your function. Your function receives an event with all the retrieved records.
EventSourceArn (string) --
The Amazon Resource Name (ARN) of the Amazon Kinesis stream that is the source of events.
FunctionArn (string) --
The Lambda function to invoke when AWS Lambda detects an event on the stream.
LastModified (datetime) --
The UTC time string indicating the last time the event mapping was updated.
LastProcessingResult (string) --
The result of the last AWS Lambda invocation of your Lambda function.
State (string) --
The state of the event source mapping. It can be Creating , Enabled , Disabled , Enabling , Disabling , Updating , or Deleting .
StateTransitionReason (string) --
The reason the event source mapping is in its current state. It is either user-requested or an AWS Lambda-initiated state transition.
{'DeadLetterConfig': {'TargetArn': 'string'},
'Runtime': {'nodejs4.3-edge', 'dotnetcore1.0'}}
Creates a new Lambda function. The function metadata is created from the request parameters, and the code for the function is provided by a .zip file in the request body. If the function name already exists, the operation will fail. Note that the function name is case-sensitive.
If you are using versioning, you can also publish a version of the Lambda function you are creating using the Publish parameter. For more information about versioning, see AWS Lambda Function Versioning and Aliases.
This operation requires permission for the lambda:CreateFunction action.
See also: AWS API Documentation
Request Syntax
client.create_function(
FunctionName='string',
Runtime='nodejs'|'nodejs4.3'|'java8'|'python2.7'|'dotnetcore1.0'|'nodejs4.3-edge',
Role='string',
Handler='string',
Code={
'ZipFile': b'bytes',
'S3Bucket': 'string',
'S3Key': 'string',
'S3ObjectVersion': 'string'
},
Description='string',
Timeout=123,
MemorySize=123,
Publish=True|False,
VpcConfig={
'SubnetIds': [
'string',
],
'SecurityGroupIds': [
'string',
]
},
DeadLetterConfig={
'TargetArn': 'string'
},
Environment={
'Variables': {
'string': 'string'
}
},
KMSKeyArn='string'
)
string
[REQUIRED]
The name you want to assign to the function you are uploading. The function names appear in the console and are returned in the ListFunctions API. Function names are used to specify functions to other AWS Lambda APIs, such as Invoke.
string
[REQUIRED]
The runtime environment for the Lambda function you are uploading.
To use the Node.js runtime v4.3, set the value to "nodejs4.3". To use earlier runtime (v0.10.42), set the value to "nodejs".
Note
You can no longer create functions using the v0.10.42 runtime version as of November, 2016. Existing functions will be supported until early 2017 but we recommend you migrate them to nodejs4.3 runtime version as soon as possible.
string
[REQUIRED]
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. For more information, see AWS Lambda: How it Works.
string
[REQUIRED]
The function within your code that Lambda calls to begin execution. For Node.js, it is the module-name .*export* value in your function. For Java, it can be package.class-name::handler or package.class-name . For more information, see Lambda Function Handler (Java).
dict
[REQUIRED]
The code for the Lambda function.
ZipFile (bytes) --
The contents of your zip file containing your deployment package. If you are using the web API directly, the contents of the zip file must be base64-encoded. If you are using the AWS SDKs or the AWS CLI, the SDKs or CLI will do the encoding for you. For more information about creating a .zip file, go to Execution Permissions in the AWS Lambda Developer Guide .
S3Bucket (string) --
Amazon S3 bucket name where the .zip file containing your deployment package is stored. This bucket must reside in the same AWS region where you are creating the Lambda function.
S3Key (string) --
The Amazon S3 object (the deployment package) key name you want to upload.
S3ObjectVersion (string) --
The Amazon S3 object (the deployment package) version you want to upload.
string
A short, user-defined function description. Lambda does not use this value. Assign a meaningful description as you see fit.
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.
integer
The amount of memory, in MB, your Lambda function is given. Lambda uses this memory size to infer the amount of CPU and memory allocated to your function. Your function use-case determines your CPU and memory requirements. For example, a database operation might need less memory compared to an image processing function. The default value is 128 MB. The value must be a multiple of 64 MB.
boolean
This boolean parameter can be used to request AWS Lambda to create the Lambda function and publish a version as an atomic operation.
dict
If your Lambda function accesses resources in a VPC, you provide this parameter identifying the list of security group IDs and subnet IDs. These must belong to the same VPC. You must provide at least one security group and one subnet ID.
SubnetIds (list) --
A list of one or more subnet IDs in your VPC.
(string) --
SecurityGroupIds (list) --
A list of one or more security groups IDs in your VPC.
(string) --
dict
The parent object that contains the target ARN (Amazon Resource Name) of an Amazon SQS queue or Amazon SNS topic.
TargetArn (string) --
The ARN (Amazon Resource Value) of an Amazon SQS queue or Amazon SNS topic you specify as your Dead Letter Queue (DLQ).
dict
The parent object that contains your environment's configuration settings.
Variables (dict) --
The key-value pairs that represent your environment's configuration settings. The value you specify cannot contain a ",".
(string) --
(string) --
string
The Amazon Resource Name (ARN) of the KMS key used to encrypt your function's environment variables. If not provided, AWS Lambda will use a default service key.
dict
Response Syntax
{
'FunctionName': 'string',
'FunctionArn': 'string',
'Runtime': 'nodejs'|'nodejs4.3'|'java8'|'python2.7'|'dotnetcore1.0'|'nodejs4.3-edge',
'Role': 'string',
'Handler': 'string',
'CodeSize': 123,
'Description': 'string',
'Timeout': 123,
'MemorySize': 123,
'LastModified': 'string',
'CodeSha256': 'string',
'Version': 'string',
'VpcConfig': {
'SubnetIds': [
'string',
],
'SecurityGroupIds': [
'string',
],
'VpcId': 'string'
},
'DeadLetterConfig': {
'TargetArn': 'string'
},
'Environment': {
'Variables': {
'string': 'string'
},
'Error': {
'ErrorCode': 'string',
'Message': 'string'
}
},
'KMSKeyArn': 'string'
}
Response Structure
(dict) --
A complex type that describes function metadata.
FunctionName (string) --
The name of the function.
FunctionArn (string) --
The Amazon Resource Name (ARN) assigned to the function.
Runtime (string) --
The runtime environment for the Lambda function.
To use the Node.js runtime v4.3, set the value to "nodejs4.3". To use earlier runtime (v0.10.42), set the value to "nodejs".
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 (integer) --
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.
CodeSha256 (string) --
It is the SHA256 hash of your function deployment package.
Version (string) --
The version of the Lambda function.
VpcConfig (dict) --
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 (dict) --
The parent object that contains the target ARN (Amazon Resource Name) of an Amazon SQS queue or Amazon SNS topic.
TargetArn (string) --
The ARN (Amazon Resource Value) of an Amazon SQS queue or Amazon SNS topic you specify as your Dead Letter Queue (DLQ).
Environment (dict) --
The parent object that contains your environment's configuration settings.
Variables (dict) --
The key-value pairs returned that represent your environment's configuration settings or error information.
(string) --
(string) --
Error (dict) --
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.
{'Configuration': {'DeadLetterConfig': {'TargetArn': 'string'},
'Runtime': {'nodejs4.3-edge', 'dotnetcore1.0'}}}
Returns the configuration information of the Lambda function and a presigned URL link to the .zip file you uploaded with CreateFunction so you can download the .zip file. Note that the URL is valid for up to 10 minutes. The configuration information is the same information you provided as parameters when uploading the function.
Using the optional Qualifier parameter, you can specify a specific function version for which you want this information. If you don't specify this parameter, the API uses unqualified function ARN which return information about the $LATEST version of the Lambda function. For more information, see AWS Lambda Function Versioning and Aliases.
This operation requires permission for the lambda:GetFunction action.
See also: AWS API Documentation
Request Syntax
client.get_function(
FunctionName='string',
Qualifier='string'
)
string
[REQUIRED]
The Lambda function name.
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 character in length.
string
Using this optional parameter to specify a function version or an alias name. If you specify function version, the API uses qualified function ARN for the request and returns information about the specific Lambda 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 provide this parameter, the API uses unqualified function ARN and returns information about the $LATEST version of the Lambda function.
dict
Response Syntax
{
'Configuration': {
'FunctionName': 'string',
'FunctionArn': 'string',
'Runtime': 'nodejs'|'nodejs4.3'|'java8'|'python2.7'|'dotnetcore1.0'|'nodejs4.3-edge',
'Role': 'string',
'Handler': 'string',
'CodeSize': 123,
'Description': 'string',
'Timeout': 123,
'MemorySize': 123,
'LastModified': 'string',
'CodeSha256': 'string',
'Version': 'string',
'VpcConfig': {
'SubnetIds': [
'string',
],
'SecurityGroupIds': [
'string',
],
'VpcId': 'string'
},
'DeadLetterConfig': {
'TargetArn': 'string'
},
'Environment': {
'Variables': {
'string': 'string'
},
'Error': {
'ErrorCode': 'string',
'Message': 'string'
}
},
'KMSKeyArn': 'string'
},
'Code': {
'RepositoryType': 'string',
'Location': 'string'
}
}
Response Structure
(dict) --
This response contains the object for the Lambda function location (see FunctionCodeLocation.
Configuration (dict) --
A complex type that describes function metadata.
FunctionName (string) --
The name of the function.
FunctionArn (string) --
The Amazon Resource Name (ARN) assigned to the function.
Runtime (string) --
The runtime environment for the Lambda function.
To use the Node.js runtime v4.3, set the value to "nodejs4.3". To use earlier runtime (v0.10.42), set the value to "nodejs".
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 (integer) --
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.
CodeSha256 (string) --
It is the SHA256 hash of your function deployment package.
Version (string) --
The version of the Lambda function.
VpcConfig (dict) --
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 (dict) --
The parent object that contains the target ARN (Amazon Resource Name) of an Amazon SQS queue or Amazon SNS topic.
TargetArn (string) --
The ARN (Amazon Resource Value) of an Amazon SQS queue or Amazon SNS topic you specify as your Dead Letter Queue (DLQ).
Environment (dict) --
The parent object that contains your environment's configuration settings.
Variables (dict) --
The key-value pairs returned that represent your environment's configuration settings or error information.
(string) --
(string) --
Error (dict) --
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.
Code (dict) --
The object for the Lambda function location.
RepositoryType (string) --
The repository from which you can download the function.
Location (string) --
The presigned URL you can use to download the function's .zip file that you previously uploaded. The URL is valid for up to 10 minutes.
{'DeadLetterConfig': {'TargetArn': 'string'},
'Runtime': {'nodejs4.3-edge', 'dotnetcore1.0'}}
Returns the configuration information of the Lambda function. This the same information you provided as parameters when uploading the function by using CreateFunction.
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
Request Syntax
client.get_function_configuration(
FunctionName='string',
Qualifier='string'
)
string
[REQUIRED]
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 character in length.
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.
dict
Response Syntax
{
'FunctionName': 'string',
'FunctionArn': 'string',
'Runtime': 'nodejs'|'nodejs4.3'|'java8'|'python2.7'|'dotnetcore1.0'|'nodejs4.3-edge',
'Role': 'string',
'Handler': 'string',
'CodeSize': 123,
'Description': 'string',
'Timeout': 123,
'MemorySize': 123,
'LastModified': 'string',
'CodeSha256': 'string',
'Version': 'string',
'VpcConfig': {
'SubnetIds': [
'string',
],
'SecurityGroupIds': [
'string',
],
'VpcId': 'string'
},
'DeadLetterConfig': {
'TargetArn': 'string'
},
'Environment': {
'Variables': {
'string': 'string'
},
'Error': {
'ErrorCode': 'string',
'Message': 'string'
}
},
'KMSKeyArn': 'string'
}
Response Structure
(dict) --
A complex type that describes function metadata.
FunctionName (string) --
The name of the function.
FunctionArn (string) --
The Amazon Resource Name (ARN) assigned to the function.
Runtime (string) --
The runtime environment for the Lambda function.
To use the Node.js runtime v4.3, set the value to "nodejs4.3". To use earlier runtime (v0.10.42), set the value to "nodejs".
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 (integer) --
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.
CodeSha256 (string) --
It is the SHA256 hash of your function deployment package.
Version (string) --
The version of the Lambda function.
VpcConfig (dict) --
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 (dict) --
The parent object that contains the target ARN (Amazon Resource Name) of an Amazon SQS queue or Amazon SNS topic.
TargetArn (string) --
The ARN (Amazon Resource Value) of an Amazon SQS queue or Amazon SNS topic you specify as your Dead Letter Queue (DLQ).
Environment (dict) --
The parent object that contains your environment's configuration settings.
Variables (dict) --
The key-value pairs returned that represent your environment's configuration settings or error information.
(string) --
(string) --
Error (dict) --
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.
{'Functions': {'DeadLetterConfig': {'TargetArn': 'string'},
'Runtime': {'nodejs4.3-edge', 'dotnetcore1.0'}}}
Returns a list of your Lambda functions. For each function, the response includes the function configuration information. You must use GetFunction to retrieve the code for your function.
This operation requires permission for the lambda:ListFunctions action.
If you are using versioning feature, the response returns list of $LATEST versions of your functions. For information about the versioning feature, see AWS Lambda Function Versioning and Aliases.
See also: AWS API Documentation
Request Syntax
client.list_functions(
Marker='string',
MaxItems=123
)
string
Optional string. An opaque pagination token returned from a previous ListFunctions operation. If present, indicates where to continue the listing.
integer
Optional integer. Specifies the maximum number of AWS Lambda functions to return in response. This parameter value must be greater than 0.
dict
Response Syntax
{
'NextMarker': 'string',
'Functions': [
{
'FunctionName': 'string',
'FunctionArn': 'string',
'Runtime': 'nodejs'|'nodejs4.3'|'java8'|'python2.7'|'dotnetcore1.0'|'nodejs4.3-edge',
'Role': 'string',
'Handler': 'string',
'CodeSize': 123,
'Description': 'string',
'Timeout': 123,
'MemorySize': 123,
'LastModified': 'string',
'CodeSha256': 'string',
'Version': 'string',
'VpcConfig': {
'SubnetIds': [
'string',
],
'SecurityGroupIds': [
'string',
],
'VpcId': 'string'
},
'DeadLetterConfig': {
'TargetArn': 'string'
},
'Environment': {
'Variables': {
'string': 'string'
},
'Error': {
'ErrorCode': 'string',
'Message': 'string'
}
},
'KMSKeyArn': 'string'
},
]
}
Response Structure
(dict) --
Contains a list of AWS Lambda function configurations (see FunctionConfiguration.
NextMarker (string) --
A string, present if there are more functions.
Functions (list) --
A list of Lambda functions.
(dict) --
A complex type that describes function metadata.
FunctionName (string) --
The name of the function.
FunctionArn (string) --
The Amazon Resource Name (ARN) assigned to the function.
Runtime (string) --
The runtime environment for the Lambda function.
To use the Node.js runtime v4.3, set the value to "nodejs4.3". To use earlier runtime (v0.10.42), set the value to "nodejs".
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 (integer) --
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.
CodeSha256 (string) --
It is the SHA256 hash of your function deployment package.
Version (string) --
The version of the Lambda function.
VpcConfig (dict) --
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 (dict) --
The parent object that contains the target ARN (Amazon Resource Name) of an Amazon SQS queue or Amazon SNS topic.
TargetArn (string) --
The ARN (Amazon Resource Value) of an Amazon SQS queue or Amazon SNS topic you specify as your Dead Letter Queue (DLQ).
Environment (dict) --
The parent object that contains your environment's configuration settings.
Variables (dict) --
The key-value pairs returned that represent your environment's configuration settings or error information.
(string) --
(string) --
Error (dict) --
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.
{'Versions': {'DeadLetterConfig': {'TargetArn': 'string'},
'Runtime': {'nodejs4.3-edge', 'dotnetcore1.0'}}}
List all versions of a function. For information about the versioning feature, see AWS Lambda Function Versioning and Aliases.
See also: AWS API Documentation
Request Syntax
client.list_versions_by_function(
FunctionName='string',
Marker='string',
MaxItems=123
)
string
[REQUIRED]
Function name whose versions to list. 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 character in length.
string
Optional string. An opaque pagination token returned from a previous ListVersionsByFunction operation. If present, indicates where to continue the listing.
integer
Optional integer. Specifies the maximum number of AWS Lambda function versions to return in response. This parameter value must be greater than 0.
dict
Response Syntax
{
'NextMarker': 'string',
'Versions': [
{
'FunctionName': 'string',
'FunctionArn': 'string',
'Runtime': 'nodejs'|'nodejs4.3'|'java8'|'python2.7'|'dotnetcore1.0'|'nodejs4.3-edge',
'Role': 'string',
'Handler': 'string',
'CodeSize': 123,
'Description': 'string',
'Timeout': 123,
'MemorySize': 123,
'LastModified': 'string',
'CodeSha256': 'string',
'Version': 'string',
'VpcConfig': {
'SubnetIds': [
'string',
],
'SecurityGroupIds': [
'string',
],
'VpcId': 'string'
},
'DeadLetterConfig': {
'TargetArn': 'string'
},
'Environment': {
'Variables': {
'string': 'string'
},
'Error': {
'ErrorCode': 'string',
'Message': 'string'
}
},
'KMSKeyArn': 'string'
},
]
}
Response Structure
(dict) --
NextMarker (string) --
A string, present if there are more function versions.
Versions (list) --
A list of Lambda function versions.
(dict) --
A complex type that describes function metadata.
FunctionName (string) --
The name of the function.
FunctionArn (string) --
The Amazon Resource Name (ARN) assigned to the function.
Runtime (string) --
The runtime environment for the Lambda function.
To use the Node.js runtime v4.3, set the value to "nodejs4.3". To use earlier runtime (v0.10.42), set the value to "nodejs".
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 (integer) --
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.
CodeSha256 (string) --
It is the SHA256 hash of your function deployment package.
Version (string) --
The version of the Lambda function.
VpcConfig (dict) --
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 (dict) --
The parent object that contains the target ARN (Amazon Resource Name) of an Amazon SQS queue or Amazon SNS topic.
TargetArn (string) --
The ARN (Amazon Resource Value) of an Amazon SQS queue or Amazon SNS topic you specify as your Dead Letter Queue (DLQ).
Environment (dict) --
The parent object that contains your environment's configuration settings.
Variables (dict) --
The key-value pairs returned that represent your environment's configuration settings or error information.
(string) --
(string) --
Error (dict) --
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.
{'DeadLetterConfig': {'TargetArn': 'string'},
'Runtime': {'nodejs4.3-edge', 'dotnetcore1.0'}}
Publishes a version of your function from the current snapshot of $LATEST. That is, AWS Lambda takes a snapshot of the function code and configuration information from $LATEST and publishes a new version. The code and configuration cannot be modified after publication. For information about the versioning feature, see AWS Lambda Function Versioning and Aliases.
See also: AWS API Documentation
Request Syntax
client.publish_version(
FunctionName='string',
CodeSha256='string',
Description='string'
)
string
[REQUIRED]
The Lambda function name. 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 character in length.
string
The SHA256 hash of the deployment package you want to publish. This provides validation on the code you are publishing. If you provide this parameter value must match the SHA256 of the $LATEST version for the publication to succeed.
string
The description for the version you are publishing. If not provided, AWS Lambda copies the description from the $LATEST version.
dict
Response Syntax
{
'FunctionName': 'string',
'FunctionArn': 'string',
'Runtime': 'nodejs'|'nodejs4.3'|'java8'|'python2.7'|'dotnetcore1.0'|'nodejs4.3-edge',
'Role': 'string',
'Handler': 'string',
'CodeSize': 123,
'Description': 'string',
'Timeout': 123,
'MemorySize': 123,
'LastModified': 'string',
'CodeSha256': 'string',
'Version': 'string',
'VpcConfig': {
'SubnetIds': [
'string',
],
'SecurityGroupIds': [
'string',
],
'VpcId': 'string'
},
'DeadLetterConfig': {
'TargetArn': 'string'
},
'Environment': {
'Variables': {
'string': 'string'
},
'Error': {
'ErrorCode': 'string',
'Message': 'string'
}
},
'KMSKeyArn': 'string'
}
Response Structure
(dict) --
A complex type that describes function metadata.
FunctionName (string) --
The name of the function.
FunctionArn (string) --
The Amazon Resource Name (ARN) assigned to the function.
Runtime (string) --
The runtime environment for the Lambda function.
To use the Node.js runtime v4.3, set the value to "nodejs4.3". To use earlier runtime (v0.10.42), set the value to "nodejs".
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 (integer) --
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.
CodeSha256 (string) --
It is the SHA256 hash of your function deployment package.
Version (string) --
The version of the Lambda function.
VpcConfig (dict) --
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 (dict) --
The parent object that contains the target ARN (Amazon Resource Name) of an Amazon SQS queue or Amazon SNS topic.
TargetArn (string) --
The ARN (Amazon Resource Value) of an Amazon SQS queue or Amazon SNS topic you specify as your Dead Letter Queue (DLQ).
Environment (dict) --
The parent object that contains your environment's configuration settings.
Variables (dict) --
The key-value pairs returned that represent your environment's configuration settings or error information.
(string) --
(string) --
Error (dict) --
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.
{'DeadLetterConfig': {'TargetArn': 'string'},
'Runtime': {'nodejs4.3-edge', 'dotnetcore1.0'}}
Updates the code for the specified Lambda function. This operation must only be used on an existing Lambda function and cannot be used to update the function configuration.
If you are using the versioning feature, note this API will always update the $LATEST version of your Lambda function. For information about the versioning feature, see AWS Lambda Function Versioning and Aliases.
This operation requires permission for the lambda:UpdateFunctionCode action.
See also: AWS API Documentation
Request Syntax
client.update_function_code(
FunctionName='string',
ZipFile=b'bytes',
S3Bucket='string',
S3Key='string',
S3ObjectVersion='string',
Publish=True|False
)
string
[REQUIRED]
The existing Lambda function name whose code you want to replace.
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 character in length.
bytes
The contents of your zip file containing your deployment package. If you are using the web API directly, the contents of the zip file must be base64-encoded. If you are using the AWS SDKs or the AWS CLI, the SDKs or CLI will do the encoding for you. For more information about creating a .zip file, go to Execution Permissions in the AWS Lambda Developer Guide .
string
Amazon S3 bucket name where the .zip file containing your deployment package is stored. This bucket must reside in the same AWS region where you are creating the Lambda function.
string
The Amazon S3 object (the deployment package) key name you want to upload.
string
The Amazon S3 object (the deployment package) version you want to upload.
boolean
This boolean parameter can be used to request AWS Lambda to update the Lambda function and publish a version as an atomic operation.
dict
Response Syntax
{
'FunctionName': 'string',
'FunctionArn': 'string',
'Runtime': 'nodejs'|'nodejs4.3'|'java8'|'python2.7'|'dotnetcore1.0'|'nodejs4.3-edge',
'Role': 'string',
'Handler': 'string',
'CodeSize': 123,
'Description': 'string',
'Timeout': 123,
'MemorySize': 123,
'LastModified': 'string',
'CodeSha256': 'string',
'Version': 'string',
'VpcConfig': {
'SubnetIds': [
'string',
],
'SecurityGroupIds': [
'string',
],
'VpcId': 'string'
},
'DeadLetterConfig': {
'TargetArn': 'string'
},
'Environment': {
'Variables': {
'string': 'string'
},
'Error': {
'ErrorCode': 'string',
'Message': 'string'
}
},
'KMSKeyArn': 'string'
}
Response Structure
(dict) --
A complex type that describes function metadata.
FunctionName (string) --
The name of the function.
FunctionArn (string) --
The Amazon Resource Name (ARN) assigned to the function.
Runtime (string) --
The runtime environment for the Lambda function.
To use the Node.js runtime v4.3, set the value to "nodejs4.3". To use earlier runtime (v0.10.42), set the value to "nodejs".
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 (integer) --
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.
CodeSha256 (string) --
It is the SHA256 hash of your function deployment package.
Version (string) --
The version of the Lambda function.
VpcConfig (dict) --
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 (dict) --
The parent object that contains the target ARN (Amazon Resource Name) of an Amazon SQS queue or Amazon SNS topic.
TargetArn (string) --
The ARN (Amazon Resource Value) of an Amazon SQS queue or Amazon SNS topic you specify as your Dead Letter Queue (DLQ).
Environment (dict) --
The parent object that contains your environment's configuration settings.
Variables (dict) --
The key-value pairs returned that represent your environment's configuration settings or error information.
(string) --
(string) --
Error (dict) --
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.
{'DeadLetterConfig': {'TargetArn': 'string'},
'Runtime': {'nodejs4.3-edge', 'dotnetcore1.0'}}
Updates the configuration parameters for the specified Lambda function by using the values provided in the request. You provide only the parameters you want to change. This operation must only be used on an existing Lambda function and cannot be used to update the function's code.
If you are using the versioning feature, note this API will always update the $LATEST version of your Lambda function. For information about the versioning feature, see AWS Lambda Function Versioning and Aliases.
This operation requires permission for the lambda:UpdateFunctionConfiguration action.
See also: AWS API Documentation
Request Syntax
client.update_function_configuration(
FunctionName='string',
Role='string',
Handler='string',
Description='string',
Timeout=123,
MemorySize=123,
VpcConfig={
'SubnetIds': [
'string',
],
'SecurityGroupIds': [
'string',
]
},
Environment={
'Variables': {
'string': 'string'
}
},
Runtime='nodejs'|'nodejs4.3'|'java8'|'python2.7'|'dotnetcore1.0'|'nodejs4.3-edge',
DeadLetterConfig={
'TargetArn': 'string'
},
KMSKeyArn='string'
)
string
[REQUIRED]
The name of the Lambda function.
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 character in length.
string
The Amazon Resource Name (ARN) of the IAM role that Lambda will assume when it executes your function.
string
The function that Lambda calls to begin executing your function. For Node.js, it is the module-name.export value in your function.
string
A short user-defined function description. AWS Lambda does not use this value. Assign a meaningful description as you see fit.
integer
The function execution time at which AWS 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.
integer
The amount of memory, in MB, your Lambda function is given. AWS Lambda uses this memory size to infer the amount of CPU allocated to your function. Your function use-case determines your CPU and memory requirements. For example, a database operation might need less memory compared to an image processing function. The default value is 128 MB. The value must be a multiple of 64 MB.
dict
If your Lambda function accesses resources in a VPC, you provide this parameter identifying the list of security group IDs and subnet IDs. These must belong to the same VPC. You must provide at least one security group and one subnet ID.
SubnetIds (list) --
A list of one or more subnet IDs in your VPC.
(string) --
SecurityGroupIds (list) --
A list of one or more security groups IDs in your VPC.
(string) --
dict
The parent object that contains your environment's configuration settings.
Variables (dict) --
The key-value pairs that represent your environment's configuration settings. The value you specify cannot contain a ",".
(string) --
(string) --
string
The runtime environment for the Lambda function.
To use the Node.js runtime v4.3, set the value to "nodejs4.3". To use earlier runtime (v0.10.42), set the value to "nodejs".
Note
You can no longer downgrade to the v0.10.42 runtime version. This version will no longer be supported as of early 2017.
dict
The parent object that contains the target ARN (Amazon Resource Name) of an Amazon SQS queue or Amazon SNS topic.
TargetArn (string) --
The ARN (Amazon Resource Value) of an Amazon SQS queue or Amazon SNS topic you specify as your Dead Letter Queue (DLQ).
string
The Amazon Resource Name (ARN) of the KMS key used to encrypt your function's environment variables. If you elect to use the AWS Lambda default service key, pass in an empty string ("") for this parameter.
dict
Response Syntax
{
'FunctionName': 'string',
'FunctionArn': 'string',
'Runtime': 'nodejs'|'nodejs4.3'|'java8'|'python2.7'|'dotnetcore1.0'|'nodejs4.3-edge',
'Role': 'string',
'Handler': 'string',
'CodeSize': 123,
'Description': 'string',
'Timeout': 123,
'MemorySize': 123,
'LastModified': 'string',
'CodeSha256': 'string',
'Version': 'string',
'VpcConfig': {
'SubnetIds': [
'string',
],
'SecurityGroupIds': [
'string',
],
'VpcId': 'string'
},
'DeadLetterConfig': {
'TargetArn': 'string'
},
'Environment': {
'Variables': {
'string': 'string'
},
'Error': {
'ErrorCode': 'string',
'Message': 'string'
}
},
'KMSKeyArn': 'string'
}
Response Structure
(dict) --
A complex type that describes function metadata.
FunctionName (string) --
The name of the function.
FunctionArn (string) --
The Amazon Resource Name (ARN) assigned to the function.
Runtime (string) --
The runtime environment for the Lambda function.
To use the Node.js runtime v4.3, set the value to "nodejs4.3". To use earlier runtime (v0.10.42), set the value to "nodejs".
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 (integer) --
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.
CodeSha256 (string) --
It is the SHA256 hash of your function deployment package.
Version (string) --
The version of the Lambda function.
VpcConfig (dict) --
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 (dict) --
The parent object that contains the target ARN (Amazon Resource Name) of an Amazon SQS queue or Amazon SNS topic.
TargetArn (string) --
The ARN (Amazon Resource Value) of an Amazon SQS queue or Amazon SNS topic you specify as your Dead Letter Queue (DLQ).
Environment (dict) --
The parent object that contains your environment's configuration settings.
Variables (dict) --
The key-value pairs returned that represent your environment's configuration settings or error information.
(string) --
(string) --
Error (dict) --
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.