2018/01/25 - AWS Lambda - 15 updated api methods
Changes AWS Lambda now supports Revision ID on your function versions and aliases, to track and apply conditional updates when you are updating your function version or alias resources.
{'RevisionId': 'string'}
Adds a permission to the resource policy associated with the specified AWS Lambda function. You use resource policies to grant permissions to event sources that use push model. In a push model, event sources (such as Amazon S3 and custom applications) invoke your Lambda function. Each permission you add to the resource policy allows an event source, permission to invoke the Lambda function.
For information about the push model, see AWS Lambda: How it Works.
If you are using versioning, the permissions you add are specific to the Lambda function version or alias you specify in the AddPermission request via the Qualifier parameter. For more information about versioning, see AWS Lambda Function Versioning and Aliases.
This operation requires permission for the lambda:AddPermission action.
See also: AWS API Documentation
Request Syntax
client.add_permission(
FunctionName='string',
StatementId='string',
Action='string',
Principal='string',
SourceArn='string',
SourceAccount='string',
EventSourceToken='string',
Qualifier='string',
RevisionId='string'
)
string
[REQUIRED]
Name of the Lambda function whose resource policy you are updating by adding a new permission.
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 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.
string
[REQUIRED]
A unique statement identifier.
string
[REQUIRED]
The AWS Lambda action you want to allow in this statement. Each Lambda action is a string starting with lambda: followed by the API name . For example, lambda:CreateFunction . You can use wildcard ( lambda:* ) to grant permission for all AWS Lambda actions.
string
[REQUIRED]
The principal who is getting this permission. It can be Amazon S3 service Principal ( s3.amazonaws.com ) if you want Amazon S3 to invoke the function, an AWS account ID if you are granting cross-account permission, or any valid AWS service principal such as sns.amazonaws.com . For example, you might want to allow a custom application in another AWS account to push events to AWS Lambda by invoking your function.
string
This is optional; however, when granting permission to invoke your function, you should specify this field with the Amazon Resource Name (ARN) as its value. This ensures that only events generated from the specified source can invoke the function.
Warning
If you add a permission without providing the source ARN, any AWS account that creates a mapping to your function ARN can send events to invoke your Lambda function.
string
This parameter is used for S3 and SES. The AWS account ID (without a hyphen) of the source owner. For example, if the SourceArn identifies a bucket, then this is the bucket owner's account ID. You can use this additional condition to ensure the bucket you specify is owned by a specific account (it is possible the bucket owner deleted the bucket and some other AWS account created the bucket). You can also use this condition to specify all sources (that is, you don't specify the SourceArn ) owned by a specific account.
string
A unique token that must be supplied by the principal invoking the function. This is currently only used for Alexa Smart Home functions.
string
You can use this optional query parameter to describe a qualified ARN using a function version or an alias name. The permission will then apply to the specific qualified ARN. For example, if you specify function version 2 as the qualifier, then permission applies only when request is made using qualified function ARN:
arn:aws:lambda:aws-region:acct-id:function:function-name:2
If you specify an alias name, for example PROD , then the permission is valid only for requests made using the alias ARN:
arn:aws:lambda:aws-region:acct-id:function:function-name:PROD
If the qualifier is not specified, the permission is valid only when requests is made using unqualified function ARN.
arn:aws:lambda:aws-region:acct-id:function:function-name
string
An optional value you can use to ensure you are updating the latest update of the function version or alias. If the RevisionID you pass doesn't match the latest RevisionId of the function or alias, it will fail with an error message, advising you to retrieve the latest function version or alias RevisionID using either or .
dict
Response Syntax
{
'Statement': 'string'
}
Response Structure
(dict) --
Statement (string) --
The permission statement you specified in the request. The response returns the same as a string using a backslash ("") as an escape character in the JSON.
{'RevisionId': 'string'}
Creates an alias that points to the specified Lambda function version. For more information, see Introduction to AWS Lambda Aliases.
Alias names are unique for a given function. This requires permission for the lambda:CreateAlias action.
See also: AWS API Documentation
Request Syntax
client.create_alias(
FunctionName='string',
Name='string',
FunctionVersion='string',
Description='string',
RoutingConfig={
'AdditionalVersionWeights': {
'string': 123.0
}
}
)
string
[REQUIRED]
Name of the Lambda function for which you want to create an alias. 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.
string
[REQUIRED]
Name for the alias you are creating.
string
[REQUIRED]
Lambda function version for which you are creating the alias.
string
Description of the alias.
dict
Specifies an additional version your alias can point to, allowing you to dictate what percentage of traffic will invoke each version. For more information, see lambda-traffic-shifting-using-aliases.
AdditionalVersionWeights (dict) --
Set this value to dictate what percentage of traffic will invoke the updated function version. If set to an empty string, 100 percent of traffic will invoke function-version . For more information, see lambda-traffic-shifting-using-aliases.
(string) --
(float) --
dict
Response Syntax
{
'AliasArn': 'string',
'Name': 'string',
'FunctionVersion': 'string',
'Description': 'string',
'RoutingConfig': {
'AdditionalVersionWeights': {
'string': 123.0
}
},
'RevisionId': 'string'
}
Response Structure
(dict) --
Provides configuration information about a Lambda function version alias.
AliasArn (string) --
Lambda function ARN that is qualified using the alias name as the suffix. For example, if you create an alias called BETA that points to a helloworld function version, the ARN is arn:aws:lambda:aws-regions:acct-id:function:helloworld:BETA .
Name (string) --
Alias name.
FunctionVersion (string) --
Function version to which the alias points.
Description (string) --
Alias description.
RoutingConfig (dict) --
Specifies an additional function versions the alias points to, allowing you to dictate what percentage of traffic will invoke each version. For more information, see lambda-traffic-shifting-using-aliases.
AdditionalVersionWeights (dict) --
Set this value to dictate what percentage of traffic will invoke the updated function version. If set to an empty string, 100 percent of traffic will invoke function-version . For more information, see lambda-traffic-shifting-using-aliases.
(string) --
(float) --
RevisionId (string) --
Represents the latest updated revision of the function or alias.
{'RevisionId': 'string'}
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'|'nodejs6.10'|'java8'|'python2.7'|'python3.6'|'dotnetcore1.0'|'dotnetcore2.0'|'nodejs4.3-edge'|'go1.x',
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',
TracingConfig={
'Mode': 'Active'|'PassThrough'
},
Tags={
'string': '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 API operations, such as Invoke. 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.
string
[REQUIRED]
The runtime environment for the Lambda function you are uploading.
To use the Python runtime v3.6, set the value to "python3.6". To use the Python runtime v2.7, set the value to "python2.7". To use the Node.js runtime v6.10, set the value to "nodejs6.10". To use the Node.js runtime v4.3, set the value to "nodejs4.3".
Note
Node v0.10.42 is currently marked as deprecated. You must migrate existing functions to the newer Node.js runtime versions available on AWS Lambda (nodejs4.3 or nodejs6.10) as soon as possible. Failure to do so will result in an invalid parameter error being returned. Note that you will have to follow this procedure for each region that contains functions written in the Node v0.10.42 runtime.
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, see 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 Amazon Resource Name (ARN) 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.
(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
The parent object that contains your function's tracing settings.
Mode (string) --
Can be either PassThrough or Active. If PassThrough, Lambda will only trace the request from an upstream service if it contains a tracing header with "sampled=1". If Active, Lambda will respect any tracing header it receives from an upstream service. If no tracing header is received, Lambda will call X-Ray for a tracing decision.
dict
The list of tags (key-value pairs) assigned to the new function.
(string) --
(string) --
dict
Response Syntax
{
'FunctionName': 'string',
'FunctionArn': 'string',
'Runtime': 'nodejs'|'nodejs4.3'|'nodejs6.10'|'java8'|'python2.7'|'python3.6'|'dotnetcore1.0'|'dotnetcore2.0'|'nodejs4.3-edge'|'go1.x',
'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',
'TracingConfig': {
'Mode': 'Active'|'PassThrough'
},
'MasterArn': 'string',
'RevisionId': 'string'
}
Response Structure
(dict) --
A complex type that describes function metadata.
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 (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. 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 (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 Amazon Resource Name (ARN) 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.
TracingConfig (dict) --
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.
{'RevisionId': 'string'}
Returns the specified alias information such as the alias ARN, description, and function version it is pointing to. For more information, see Introduction to AWS Lambda Aliases.
This requires permission for the lambda:GetAlias action.
See also: AWS API Documentation
Request Syntax
client.get_alias(
FunctionName='string',
Name='string'
)
string
[REQUIRED]
Function name for which the alias is created. An alias is a subresource that exists only in the context of an existing Lambda function so you must specify the function name. 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.
string
[REQUIRED]
Name of the alias for which you want to retrieve information.
dict
Response Syntax
{
'AliasArn': 'string',
'Name': 'string',
'FunctionVersion': 'string',
'Description': 'string',
'RoutingConfig': {
'AdditionalVersionWeights': {
'string': 123.0
}
},
'RevisionId': 'string'
}
Response Structure
(dict) --
Provides configuration information about a Lambda function version alias.
AliasArn (string) --
Lambda function ARN that is qualified using the alias name as the suffix. For example, if you create an alias called BETA that points to a helloworld function version, the ARN is arn:aws:lambda:aws-regions:acct-id:function:helloworld:BETA .
Name (string) --
Alias name.
FunctionVersion (string) --
Function version to which the alias points.
Description (string) --
Alias description.
RoutingConfig (dict) --
Specifies an additional function versions the alias points to, allowing you to dictate what percentage of traffic will invoke each version. For more information, see lambda-traffic-shifting-using-aliases.
AdditionalVersionWeights (dict) --
Set this value to dictate what percentage of traffic will invoke the updated function version. If set to an empty string, 100 percent of traffic will invoke function-version . For more information, see lambda-traffic-shifting-using-aliases.
(string) --
(float) --
RevisionId (string) --
Represents the latest updated revision of the function or alias.
{'Configuration': {'RevisionId': 'string'}}
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 characters in length.
string
Use 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'|'nodejs6.10'|'java8'|'python2.7'|'python3.6'|'dotnetcore1.0'|'dotnetcore2.0'|'nodejs4.3-edge'|'go1.x',
'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',
'TracingConfig': {
'Mode': 'Active'|'PassThrough'
},
'MasterArn': 'string',
'RevisionId': 'string'
},
'Code': {
'RepositoryType': 'string',
'Location': 'string'
},
'Tags': {
'string': 'string'
},
'Concurrency': {
'ReservedConcurrentExecutions': 123
}
}
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. 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 (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. 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 (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 Amazon Resource Name (ARN) 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.
TracingConfig (dict) --
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.
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.
Tags (dict) --
Returns the list of tags associated with the function.
(string) --
(string) --
Concurrency (dict) --
The concurrent execution limit set for this function. For more information, see concurrent-executions.
ReservedConcurrentExecutions (integer) --
The number of concurrent executions reserved for this function. For more information, see concurrent-executions.
{'RevisionId': 'string'}
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 characters 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'|'nodejs6.10'|'java8'|'python2.7'|'python3.6'|'dotnetcore1.0'|'dotnetcore2.0'|'nodejs4.3-edge'|'go1.x',
'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',
'TracingConfig': {
'Mode': 'Active'|'PassThrough'
},
'MasterArn': 'string',
'RevisionId': 'string'
}
Response Structure
(dict) --
A complex type that describes function metadata.
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 (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. 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 (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 Amazon Resource Name (ARN) 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.
TracingConfig (dict) --
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.
{'RevisionId': 'string'}
Returns the resource policy associated with the specified Lambda function.
If you are using the versioning feature, you can get the resource policy associated with the specific Lambda function version or alias by specifying the version or alias name using the Qualifier parameter. For more information about versioning, see AWS Lambda Function Versioning and Aliases.
You need permission for the lambda:GetPolicy action.
See also: AWS API Documentation
Request Syntax
client.get_policy(
FunctionName='string',
Qualifier='string'
)
string
[REQUIRED]
Function name whose resource policy you want to retrieve.
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). 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 characters in length.
string
You can specify this optional query parameter to specify a function version or an alias name in which case this API will return all permissions associated with the specific qualified ARN. If you don't provide this parameter, the API will return permissions that apply to the unqualified function ARN.
dict
Response Syntax
{
'Policy': 'string',
'RevisionId': 'string'
}
Response Structure
(dict) --
Policy (string) --
The resource policy associated with the specified function. The response returns the same as a string using a backslash ("") as an escape character in the JSON.
RevisionId (string) --
Represents the latest updated revision of the function or alias.
{'Aliases': {'RevisionId': 'string'}}
Returns list of aliases created for a Lambda function. For each alias, the response includes information such as the alias ARN, description, alias name, and the function version to which it points. For more information, see Introduction to AWS Lambda Aliases.
This requires permission for the lambda:ListAliases action.
See also: AWS API Documentation
Request Syntax
client.list_aliases(
FunctionName='string',
FunctionVersion='string',
Marker='string',
MaxItems=123
)
string
[REQUIRED]
Lambda function name for which the alias is created. 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.
string
If you specify this optional parameter, the API returns only the aliases that are pointing to the specific Lambda function version, otherwise the API returns all of the aliases created for the Lambda function.
string
Optional string. An opaque pagination token returned from a previous ListAliases operation. If present, indicates where to continue the listing.
integer
Optional integer. Specifies the maximum number of aliases to return in response. This parameter value must be greater than 0.
dict
Response Syntax
{
'NextMarker': 'string',
'Aliases': [
{
'AliasArn': 'string',
'Name': 'string',
'FunctionVersion': 'string',
'Description': 'string',
'RoutingConfig': {
'AdditionalVersionWeights': {
'string': 123.0
}
},
'RevisionId': 'string'
},
]
}
Response Structure
(dict) --
NextMarker (string) --
A string, present if there are more aliases.
Aliases (list) --
A list of aliases.
(dict) --
Provides configuration information about a Lambda function version alias.
AliasArn (string) --
Lambda function ARN that is qualified using the alias name as the suffix. For example, if you create an alias called BETA that points to a helloworld function version, the ARN is arn:aws:lambda:aws-regions:acct-id:function:helloworld:BETA .
Name (string) --
Alias name.
FunctionVersion (string) --
Function version to which the alias points.
Description (string) --
Alias description.
RoutingConfig (dict) --
Specifies an additional function versions the alias points to, allowing you to dictate what percentage of traffic will invoke each version. For more information, see lambda-traffic-shifting-using-aliases.
AdditionalVersionWeights (dict) --
Set this value to dictate what percentage of traffic will invoke the updated function version. If set to an empty string, 100 percent of traffic will invoke function-version . For more information, see lambda-traffic-shifting-using-aliases.
(string) --
(float) --
RevisionId (string) --
Represents the latest updated revision of the function or alias.
{'Functions': {'RevisionId': 'string'}}
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 the versioning feature, you can list all of your functions or only $LATEST versions. For information about the versioning feature, see AWS Lambda Function Versioning and Aliases.
See also: AWS API Documentation
Request Syntax
client.list_functions(
MasterRegion='string',
FunctionVersion='ALL',
Marker='string',
MaxItems=123
)
string
Optional string. If not specified, will return only regular function versions (i.e., non-replicated versions).
Valid values are:
The region from which the functions are replicated. For example, if you specify us-east-1 , only functions replicated from that region will be returned.
ALL : Will return all functions from any region. If specified, you also must specify a valid FunctionVersion parameter.
string
Optional string. If not specified, only the unqualified functions ARNs (Amazon Resource Names) will be returned.
Valid value:
ALL : Will return all versions, including $LATEST which will have fully qualified ARNs (Amazon Resource Names).
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'|'nodejs6.10'|'java8'|'python2.7'|'python3.6'|'dotnetcore1.0'|'dotnetcore2.0'|'nodejs4.3-edge'|'go1.x',
'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',
'TracingConfig': {
'Mode': 'Active'|'PassThrough'
},
'MasterArn': 'string',
'RevisionId': '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. 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 (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. 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 (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 Amazon Resource Name (ARN) 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.
TracingConfig (dict) --
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.
{'Versions': {'RevisionId': 'string'}}
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 characters 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'|'nodejs6.10'|'java8'|'python2.7'|'python3.6'|'dotnetcore1.0'|'dotnetcore2.0'|'nodejs4.3-edge'|'go1.x',
'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',
'TracingConfig': {
'Mode': 'Active'|'PassThrough'
},
'MasterArn': 'string',
'RevisionId': '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. 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 (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. 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 (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 Amazon Resource Name (ARN) 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.
TracingConfig (dict) --
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.
{'RevisionId': 'string'}
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',
RevisionId='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 characters 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, the value must match the SHA256 of the $LATEST version for the publication to succeed. You can use the DryRun parameter of UpdateFunctionCode to verify the hash value that will be returned before publishing your new version.
string
The description for the version you are publishing. If not provided, AWS Lambda copies the description from the $LATEST version.
string
An optional value you can use to ensure you are updating the latest update of the function version or alias. If the RevisionID you pass doesn't match the latest RevisionId of the function or alias, it will fail with an error message, advising you to retrieve the latest function version or alias RevisionID using either or .
dict
Response Syntax
{
'FunctionName': 'string',
'FunctionArn': 'string',
'Runtime': 'nodejs'|'nodejs4.3'|'nodejs6.10'|'java8'|'python2.7'|'python3.6'|'dotnetcore1.0'|'dotnetcore2.0'|'nodejs4.3-edge'|'go1.x',
'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',
'TracingConfig': {
'Mode': 'Active'|'PassThrough'
},
'MasterArn': 'string',
'RevisionId': 'string'
}
Response Structure
(dict) --
A complex type that describes function metadata.
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 (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. 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 (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 Amazon Resource Name (ARN) 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.
TracingConfig (dict) --
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.
{'RevisionId': 'string'}
You can remove individual permissions from an resource policy associated with a Lambda function by providing a statement ID that you provided when you added the permission.
If you are using versioning, the permissions you remove are specific to the Lambda function version or alias you specify in the AddPermission request via the Qualifier parameter. For more information about versioning, see AWS Lambda Function Versioning and Aliases.
Note that removal of a permission will cause an active event source to lose permission to the function.
You need permission for the lambda:RemovePermission action.
See also: AWS API Documentation
Request Syntax
client.remove_permission(
FunctionName='string',
StatementId='string',
Qualifier='string',
RevisionId='string'
)
string
[REQUIRED]
Lambda function whose resource policy you want to remove a permission from.
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.
string
[REQUIRED]
Statement ID of the permission to remove.
string
You can specify this optional parameter to remove permission associated with a specific function version or function alias. If you don't specify this parameter, the API removes permission associated with the unqualified function ARN.
string
An optional value you can use to ensure you are updating the latest update of the function version or alias. If the RevisionID you pass doesn't match the latest RevisionId of the function or alias, it will fail with an error message, advising you to retrieve the latest function version or alias RevisionID using either or .
None
{'RevisionId': 'string'}
Using this API you can update the function version to which the alias points and the alias description. For more information, see Introduction to AWS Lambda Aliases.
This requires permission for the lambda:UpdateAlias action.
See also: AWS API Documentation
Request Syntax
client.update_alias(
FunctionName='string',
Name='string',
FunctionVersion='string',
Description='string',
RoutingConfig={
'AdditionalVersionWeights': {
'string': 123.0
}
},
RevisionId='string'
)
string
[REQUIRED]
The function name for which the alias is created. 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.
string
[REQUIRED]
The alias name.
string
Using this parameter you can change the Lambda function version to which the alias points.
string
You can change the description of the alias using this parameter.
dict
Specifies an additional version your alias can point to, allowing you to dictate what percentage of traffic will invoke each version. For more information, see lambda-traffic-shifting-using-aliases.
AdditionalVersionWeights (dict) --
Set this value to dictate what percentage of traffic will invoke the updated function version. If set to an empty string, 100 percent of traffic will invoke function-version . For more information, see lambda-traffic-shifting-using-aliases.
(string) --
(float) --
string
An optional value you can use to ensure you are updating the latest update of the function version or alias. If the RevisionID you pass doesn't match the latest RevisionId of the function or alias, it will fail with an error message, advising you to retrieve the latest function version or alias RevisionID using either or .
dict
Response Syntax
{
'AliasArn': 'string',
'Name': 'string',
'FunctionVersion': 'string',
'Description': 'string',
'RoutingConfig': {
'AdditionalVersionWeights': {
'string': 123.0
}
},
'RevisionId': 'string'
}
Response Structure
(dict) --
Provides configuration information about a Lambda function version alias.
AliasArn (string) --
Lambda function ARN that is qualified using the alias name as the suffix. For example, if you create an alias called BETA that points to a helloworld function version, the ARN is arn:aws:lambda:aws-regions:acct-id:function:helloworld:BETA .
Name (string) --
Alias name.
FunctionVersion (string) --
Function version to which the alias points.
Description (string) --
Alias description.
RoutingConfig (dict) --
Specifies an additional function versions the alias points to, allowing you to dictate what percentage of traffic will invoke each version. For more information, see lambda-traffic-shifting-using-aliases.
AdditionalVersionWeights (dict) --
Set this value to dictate what percentage of traffic will invoke the updated function version. If set to an empty string, 100 percent of traffic will invoke function-version . For more information, see lambda-traffic-shifting-using-aliases.
(string) --
(float) --
RevisionId (string) --
Represents the latest updated revision of the function or alias.
{'RevisionId': 'string'}
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,
DryRun=True|False,
RevisionId='string'
)
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 characters 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, see 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.
boolean
This boolean parameter can be used to test your request to AWS Lambda to update the Lambda function and publish a version as an atomic operation. It will do all necessary computation and validation of your code but will not upload it or a publish a version. Each time this operation is invoked, the CodeSha256 hash value of the provided code will also be computed and returned in the response.
string
An optional value you can use to ensure you are updating the latest update of the function version or alias. If the RevisionID you pass doesn't match the latest RevisionId of the function or alias, it will fail with an error message, advising you to retrieve the latest function version or alias RevisionID using either or .
dict
Response Syntax
{
'FunctionName': 'string',
'FunctionArn': 'string',
'Runtime': 'nodejs'|'nodejs4.3'|'nodejs6.10'|'java8'|'python2.7'|'python3.6'|'dotnetcore1.0'|'dotnetcore2.0'|'nodejs4.3-edge'|'go1.x',
'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',
'TracingConfig': {
'Mode': 'Active'|'PassThrough'
},
'MasterArn': 'string',
'RevisionId': 'string'
}
Response Structure
(dict) --
A complex type that describes function metadata.
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 (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. 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 (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 Amazon Resource Name (ARN) 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.
TracingConfig (dict) --
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.
{'RevisionId': 'string'}
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'|'nodejs6.10'|'java8'|'python2.7'|'python3.6'|'dotnetcore1.0'|'dotnetcore2.0'|'nodejs4.3-edge'|'go1.x',
DeadLetterConfig={
'TargetArn': 'string'
},
KMSKeyArn='string',
TracingConfig={
'Mode': 'Active'|'PassThrough'
},
RevisionId='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.
(string) --
(string) --
string
The runtime environment for the Lambda function.
To use the Python runtime v3.6, set the value to "python3.6". To use the Python runtime v2.7, set the value to "python2.7". To use the Node.js runtime v6.10, set the value to "nodejs6.10". To use the Node.js runtime v4.3, set the value to "nodejs4.3". To use the Python runtime v3.6, set the value to "python3.6".
Note
Node v0.10.42 is currently marked as deprecated. You must migrate existing functions to the newer Node.js runtime versions available on AWS Lambda (nodejs4.3 or nodejs6.10) as soon as possible. Failure to do so will result in an invalid parameter error being returned. Note that you will have to follow this procedure for each region that contains functions written in the Node v0.10.42 runtime.
dict
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).
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
The parent object that contains your function's tracing settings.
Mode (string) --
Can be either PassThrough or Active. If PassThrough, Lambda will only trace the request from an upstream service if it contains a tracing header with "sampled=1". If Active, Lambda will respect any tracing header it receives from an upstream service. If no tracing header is received, Lambda will call X-Ray for a tracing decision.
string
An optional value you can use to ensure you are updating the latest update of the function version or alias. If the RevisionID you pass doesn't match the latest RevisionId of the function or alias, it will fail with an error message, advising you to retrieve the latest function version or alias RevisionID using either or .
dict
Response Syntax
{
'FunctionName': 'string',
'FunctionArn': 'string',
'Runtime': 'nodejs'|'nodejs4.3'|'nodejs6.10'|'java8'|'python2.7'|'python3.6'|'dotnetcore1.0'|'dotnetcore2.0'|'nodejs4.3-edge'|'go1.x',
'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',
'TracingConfig': {
'Mode': 'Active'|'PassThrough'
},
'MasterArn': 'string',
'RevisionId': 'string'
}
Response Structure
(dict) --
A complex type that describes function metadata.
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 (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. 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 (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 Amazon Resource Name (ARN) 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.
TracingConfig (dict) --
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.