2019/11/25 - AWS Lambda - 5 new13 updated api methods
Changes Update lambda client to latest version
Updates the configuration for asynchronous invocation for a function, version, or alias.
To configure options for asynchronous invocation, use PutFunctionEventInvokeConfig.
See also: AWS API Documentation
Request Syntax
client.update_function_event_invoke_config( FunctionName='string', Qualifier='string', MaximumRetryAttempts=123, MaximumEventAgeInSeconds=123, DestinationConfig={ 'OnSuccess': { 'Destination': 'string' }, 'OnFailure': { 'Destination': 'string' } } )
string
[REQUIRED]
The name of the Lambda function, version, or alias.
Name formats
Function name - my-function (name-only), my-function:v1 (with alias).
Function ARN - arn:aws:lambda:us-west-2:123456789012:function:my-function.
Partial ARN - 123456789012:function:my-function.
You can append a version number or alias to any of the formats. The length constraint applies only to the full ARN. If you specify only the function name, it is limited to 64 characters in length.
string
A version number or alias name.
integer
The maximum number of times to retry when the function returns an error.
integer
The maximum age of a request that Lambda sends to a function for processing.
dict
A destination for events after they have been sent to a function for processing.
Destinations
Function - The Amazon Resource Name (ARN) of a Lambda function.
Queue - The ARN of an SQS queue.
Topic - The ARN of an SNS topic.
Event Bus - The ARN of an Amazon EventBridge event bus.
OnSuccess (dict) --
The destination configuration for successful invocations.
Destination (string) --
The Amazon Resource Name (ARN) of the destination resource.
OnFailure (dict) --
The destination configuration for failed invocations.
Destination (string) --
The Amazon Resource Name (ARN) of the destination resource.
dict
Response Syntax
{ 'LastModified': datetime(2015, 1, 1), 'FunctionArn': 'string', 'MaximumRetryAttempts': 123, 'MaximumEventAgeInSeconds': 123, 'DestinationConfig': { 'OnSuccess': { 'Destination': 'string' }, 'OnFailure': { 'Destination': 'string' } } }
Response Structure
(dict) --
LastModified (datetime) --
The date and time that the configuration was last updated.
FunctionArn (string) --
The Amazon Resource Name (ARN) of the function.
MaximumRetryAttempts (integer) --
The maximum number of times to retry when the function returns an error.
MaximumEventAgeInSeconds (integer) --
The maximum age of a request that Lambda sends to a function for processing.
DestinationConfig (dict) --
A destination for events after they have been sent to a function for processing.
Destinations
Function - The Amazon Resource Name (ARN) of a Lambda function.
Queue - The ARN of an SQS queue.
Topic - The ARN of an SNS topic.
Event Bus - The ARN of an Amazon EventBridge event bus.
OnSuccess (dict) --
The destination configuration for successful invocations.
Destination (string) --
The Amazon Resource Name (ARN) of the destination resource.
OnFailure (dict) --
The destination configuration for failed invocations.
Destination (string) --
The Amazon Resource Name (ARN) of the destination resource.
Configures options for asynchronous invocation on a function, version, or alias.
By default, Lambda retries an asynchronous invocation twice if the function returns an error. It retains events in a queue for up to six hours. When an event fails all processing attempts or stays in the asynchronous invocation queue for too long, Lambda discards it. To retain discarded events, configure a dead-letter queue with UpdateFunctionConfiguration.
See also: AWS API Documentation
Request Syntax
client.put_function_event_invoke_config( FunctionName='string', Qualifier='string', MaximumRetryAttempts=123, MaximumEventAgeInSeconds=123, DestinationConfig={ 'OnSuccess': { 'Destination': 'string' }, 'OnFailure': { 'Destination': 'string' } } )
string
[REQUIRED]
The name of the Lambda function, version, or alias.
Name formats
Function name - my-function (name-only), my-function:v1 (with alias).
Function ARN - arn:aws:lambda:us-west-2:123456789012:function:my-function.
Partial ARN - 123456789012:function:my-function.
You can append a version number or alias to any of the formats. The length constraint applies only to the full ARN. If you specify only the function name, it is limited to 64 characters in length.
string
A version number or alias name.
integer
The maximum number of times to retry when the function returns an error.
integer
The maximum age of a request that Lambda sends to a function for processing.
dict
A destination for events after they have been sent to a function for processing.
Destinations
Function - The Amazon Resource Name (ARN) of a Lambda function.
Queue - The ARN of an SQS queue.
Topic - The ARN of an SNS topic.
Event Bus - The ARN of an Amazon EventBridge event bus.
OnSuccess (dict) --
The destination configuration for successful invocations.
Destination (string) --
The Amazon Resource Name (ARN) of the destination resource.
OnFailure (dict) --
The destination configuration for failed invocations.
Destination (string) --
The Amazon Resource Name (ARN) of the destination resource.
dict
Response Syntax
{ 'LastModified': datetime(2015, 1, 1), 'FunctionArn': 'string', 'MaximumRetryAttempts': 123, 'MaximumEventAgeInSeconds': 123, 'DestinationConfig': { 'OnSuccess': { 'Destination': 'string' }, 'OnFailure': { 'Destination': 'string' } } }
Response Structure
(dict) --
LastModified (datetime) --
The date and time that the configuration was last updated.
FunctionArn (string) --
The Amazon Resource Name (ARN) of the function.
MaximumRetryAttempts (integer) --
The maximum number of times to retry when the function returns an error.
MaximumEventAgeInSeconds (integer) --
The maximum age of a request that Lambda sends to a function for processing.
DestinationConfig (dict) --
A destination for events after they have been sent to a function for processing.
Destinations
Function - The Amazon Resource Name (ARN) of a Lambda function.
Queue - The ARN of an SQS queue.
Topic - The ARN of an SNS topic.
Event Bus - The ARN of an Amazon EventBridge event bus.
OnSuccess (dict) --
The destination configuration for successful invocations.
Destination (string) --
The Amazon Resource Name (ARN) of the destination resource.
OnFailure (dict) --
The destination configuration for failed invocations.
Destination (string) --
The Amazon Resource Name (ARN) of the destination resource.
Deletes the configuration for asynchronous invocation for a function, version, or alias.
To configure options for asynchronous invocation, use PutFunctionEventInvokeConfig.
See also: AWS API Documentation
Request Syntax
client.delete_function_event_invoke_config( FunctionName='string', Qualifier='string' )
string
[REQUIRED]
The name of the Lambda function, version, or alias.
Name formats
Function name - my-function (name-only), my-function:v1 (with alias).
Function ARN - arn:aws:lambda:us-west-2:123456789012:function:my-function.
Partial ARN - 123456789012:function:my-function.
You can append a version number or alias to any of the formats. The length constraint applies only to the full ARN. If you specify only the function name, it is limited to 64 characters in length.
string
A version number or alias name.
None
Retrieves the configuration for asynchronous invocation for a function, version, or alias.
To configure options for asynchronous invocation, use PutFunctionEventInvokeConfig.
See also: AWS API Documentation
Request Syntax
client.get_function_event_invoke_config( FunctionName='string', Qualifier='string' )
string
[REQUIRED]
The name of the Lambda function, version, or alias.
Name formats
Function name - my-function (name-only), my-function:v1 (with alias).
Function ARN - arn:aws:lambda:us-west-2:123456789012:function:my-function.
Partial ARN - 123456789012:function:my-function.
You can append a version number or alias to any of the formats. The length constraint applies only to the full ARN. If you specify only the function name, it is limited to 64 characters in length.
string
A version number or alias name.
dict
Response Syntax
{ 'LastModified': datetime(2015, 1, 1), 'FunctionArn': 'string', 'MaximumRetryAttempts': 123, 'MaximumEventAgeInSeconds': 123, 'DestinationConfig': { 'OnSuccess': { 'Destination': 'string' }, 'OnFailure': { 'Destination': 'string' } } }
Response Structure
(dict) --
LastModified (datetime) --
The date and time that the configuration was last updated.
FunctionArn (string) --
The Amazon Resource Name (ARN) of the function.
MaximumRetryAttempts (integer) --
The maximum number of times to retry when the function returns an error.
MaximumEventAgeInSeconds (integer) --
The maximum age of a request that Lambda sends to a function for processing.
DestinationConfig (dict) --
A destination for events after they have been sent to a function for processing.
Destinations
Function - The Amazon Resource Name (ARN) of a Lambda function.
Queue - The ARN of an SQS queue.
Topic - The ARN of an SNS topic.
Event Bus - The ARN of an Amazon EventBridge event bus.
OnSuccess (dict) --
The destination configuration for successful invocations.
Destination (string) --
The Amazon Resource Name (ARN) of the destination resource.
OnFailure (dict) --
The destination configuration for failed invocations.
Destination (string) --
The Amazon Resource Name (ARN) of the destination resource.
Retrieves a list of configurations for asynchronous invocation for a function.
To configure options for asynchronous invocation, use PutFunctionEventInvokeConfig.
See also: AWS API Documentation
Request Syntax
client.list_function_event_invoke_configs( FunctionName='string', Marker='string', MaxItems=123 )
string
[REQUIRED]
The name of the Lambda function.
Name formats
Function name - my-function.
Function ARN - arn:aws:lambda:us-west-2:123456789012:function:my-function.
Partial ARN - 123456789012:function:my-function.
The length constraint applies only to the full ARN. If you specify only the function name, it is limited to 64 characters in length.
string
Specify the pagination token that's returned by a previous request to retrieve the next page of results.
integer
The maximum number of configurations to return.
dict
Response Syntax
{ 'FunctionEventInvokeConfigs': [ { 'LastModified': datetime(2015, 1, 1), 'FunctionArn': 'string', 'MaximumRetryAttempts': 123, 'MaximumEventAgeInSeconds': 123, 'DestinationConfig': { 'OnSuccess': { 'Destination': 'string' }, 'OnFailure': { 'Destination': 'string' } } }, ], 'NextMarker': 'string' }
Response Structure
(dict) --
FunctionEventInvokeConfigs (list) --
A list of configurations.
(dict) --
LastModified (datetime) --
The date and time that the configuration was last updated.
FunctionArn (string) --
The Amazon Resource Name (ARN) of the function.
MaximumRetryAttempts (integer) --
The maximum number of times to retry when the function returns an error.
MaximumEventAgeInSeconds (integer) --
The maximum age of a request that Lambda sends to a function for processing.
DestinationConfig (dict) --
A destination for events after they have been sent to a function for processing.
Destinations
Function - The Amazon Resource Name (ARN) of a Lambda function.
Queue - The ARN of an SQS queue.
Topic - The ARN of an SNS topic.
Event Bus - The ARN of an Amazon EventBridge event bus.
OnSuccess (dict) --
The destination configuration for successful invocations.
Destination (string) --
The Amazon Resource Name (ARN) of the destination resource.
OnFailure (dict) --
The destination configuration for failed invocations.
Destination (string) --
The Amazon Resource Name (ARN) of the destination resource.
NextMarker (string) --
The pagination token that's included if more results are available.
{'BisectBatchOnFunctionError': 'boolean', 'DestinationConfig': {'OnFailure': {'Destination': 'string'}, 'OnSuccess': {'Destination': 'string'}}, 'MaximumRecordAgeInSeconds': 'integer', 'MaximumRetryAttempts': 'integer', 'ParallelizationFactor': 'integer'}
Creates a mapping between an event source and an AWS Lambda function. Lambda reads items from the event source and triggers the function.
For details about each event source type, see the following topics.
The following error handling options are only available for stream sources (DynamoDB and Kinesis):
BisectBatchOnFunctionError - If the function returns an error, split the batch in two and retry.
DestinationConfig - Send discarded records to an Amazon SQS queue or Amazon SNS topic.
MaximumRecordAgeInSeconds - Discard records older than the specified age.
MaximumRetryAttempts - Discard records after the specified number of retries.
See also: AWS API Documentation
Request Syntax
client.create_event_source_mapping( EventSourceArn='string', FunctionName='string', Enabled=True|False, BatchSize=123, MaximumBatchingWindowInSeconds=123, ParallelizationFactor=123, StartingPosition='TRIM_HORIZON'|'LATEST'|'AT_TIMESTAMP', StartingPositionTimestamp=datetime(2015, 1, 1), DestinationConfig={ 'OnSuccess': { 'Destination': 'string' }, 'OnFailure': { 'Destination': 'string' } }, MaximumRecordAgeInSeconds=123, BisectBatchOnFunctionError=True|False, MaximumRetryAttempts=123 )
string
[REQUIRED]
The Amazon Resource Name (ARN) of the event source.
Amazon Kinesis - The ARN of the data stream or a stream consumer.
Amazon DynamoDB Streams - The ARN of the stream.
Amazon Simple Queue Service - The ARN of the queue.
string
[REQUIRED]
The name of the Lambda function.
Name formats
Function name - MyFunction.
Function ARN - arn:aws:lambda:us-west-2:123456789012:function:MyFunction.
Version or Alias ARN - arn:aws:lambda:us-west-2:123456789012:function:MyFunction:PROD.
Partial ARN - 123456789012:function:MyFunction.
The length constraint applies only to the full ARN. If you specify only the function name, it's limited to 64 characters in length.
boolean
Disables the event source mapping to pause polling and invocation.
integer
The maximum number of items to retrieve in a single batch.
Amazon Kinesis - Default 100. Max 10,000.
Amazon DynamoDB Streams - Default 100. Max 1,000.
Amazon Simple Queue Service - Default 10. Max 10.
integer
The maximum amount of time to gather records before invoking the function, in seconds.
integer
(Streams) The number of batches to process from each shard concurrently.
string
The position in a stream from which to start reading. Required for Amazon Kinesis and Amazon DynamoDB Streams sources. AT_TIMESTAMP is only supported for Amazon Kinesis streams.
datetime
With StartingPosition set to AT_TIMESTAMP, the time from which to start reading.
dict
(Streams) An Amazon SQS queue or Amazon SNS topic destination for discarded records.
OnSuccess (dict) --
The destination configuration for successful invocations.
Destination (string) --
The Amazon Resource Name (ARN) of the destination resource.
OnFailure (dict) --
The destination configuration for failed invocations.
Destination (string) --
The Amazon Resource Name (ARN) of the destination resource.
integer
(Streams) The maximum age of a record that Lambda sends to a function for processing.
boolean
(Streams) If the function returns an error, split the batch in two and retry.
integer
(Streams) The maximum number of times to retry when the function returns an error.
dict
Response Syntax
{ 'UUID': 'string', 'BatchSize': 123, 'MaximumBatchingWindowInSeconds': 123, 'ParallelizationFactor': 123, 'EventSourceArn': 'string', 'FunctionArn': 'string', 'LastModified': datetime(2015, 1, 1), 'LastProcessingResult': 'string', 'State': 'string', 'StateTransitionReason': 'string', 'DestinationConfig': { 'OnSuccess': { 'Destination': 'string' }, 'OnFailure': { 'Destination': 'string' } }, 'MaximumRecordAgeInSeconds': 123, 'BisectBatchOnFunctionError': True|False, 'MaximumRetryAttempts': 123 }
Response Structure
(dict) --
A mapping between an AWS resource and an AWS Lambda function. See CreateEventSourceMapping for details.
UUID (string) --
The identifier of the event source mapping.
BatchSize (integer) --
The maximum number of items to retrieve in a single batch.
MaximumBatchingWindowInSeconds (integer) --
The maximum amount of time to gather records before invoking the function, in seconds.
ParallelizationFactor (integer) --
(Streams) The number of batches to process from each shard concurrently.
EventSourceArn (string) --
The Amazon Resource Name (ARN) of the event source.
FunctionArn (string) --
The ARN of the Lambda function.
LastModified (datetime) --
The date that the event source mapping was last updated, or its state changed.
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 one of the following: Creating, Enabling, Enabled, Disabling, Disabled, Updating, or Deleting.
StateTransitionReason (string) --
Indicates whether the last change to the event source mapping was made by a user, or by the Lambda service.
DestinationConfig (dict) --
(Streams) An Amazon SQS queue or Amazon SNS topic destination for discarded records.
OnSuccess (dict) --
The destination configuration for successful invocations.
Destination (string) --
The Amazon Resource Name (ARN) of the destination resource.
OnFailure (dict) --
The destination configuration for failed invocations.
Destination (string) --
The Amazon Resource Name (ARN) of the destination resource.
MaximumRecordAgeInSeconds (integer) --
(Streams) The maximum age of a record that Lambda sends to a function for processing.
BisectBatchOnFunctionError (boolean) --
(Streams) If the function returns an error, split the batch in two and retry.
MaximumRetryAttempts (integer) --
(Streams) The maximum number of times to retry when the function returns an error.
{'LastUpdateStatus': 'Successful | Failed | InProgress', 'LastUpdateStatusReason': 'string', 'LastUpdateStatusReasonCode': 'EniLimitExceeded | InsufficientRolePermissions ' '| InvalidConfiguration | InternalError', 'State': 'Pending | Active | Inactive | Failed', 'StateReason': 'string', 'StateReasonCode': 'Idle | Creating | Restoring | EniLimitExceeded | ' 'InsufficientRolePermissions | InvalidConfiguration | ' 'InternalError | SubnetOutOfIPAddresses'}
Creates a Lambda function. To create a function, you need a deployment package and an execution role. The deployment package contains your function code. The execution role grants the function permission to use AWS services, such as Amazon CloudWatch Logs for log streaming and AWS X-Ray for request tracing.
When you create a function, Lambda provisions an instance of the function and its supporting resources. If your function connects to a VPC, this process can take a minute or so. During this time, you can't invoke or modify the function. The State, StateReason, and StateReasonCode fields in the response from GetFunctionConfiguration indicate when the function is ready to invoke. For more information, see Function States.
A function has an unpublished version, and can have published versions and aliases. The unpublished version changes when you update your function's code and configuration. A published version is a snapshot of your function code and configuration that can't be changed. An alias is a named resource that maps to a version, and can be changed to map to a different version. Use the Publish parameter to create version 1 of your function from its initial configuration.
The other parameters let you configure version-specific and function-level settings. You can modify version-specific settings later with UpdateFunctionConfiguration. Function-level settings apply to both the unpublished and published versions of the function, and include tags ( TagResource) and per-function concurrency limits ( PutFunctionConcurrency).
If another account or an AWS service invokes your function, use AddPermission to grant permission by creating a resource-based IAM policy. You can grant permissions at the function level, on a version, or on an alias.
To invoke your function directly, use Invoke. To invoke your function in response to events in other AWS services, create an event source mapping ( CreateEventSourceMapping), or configure a function trigger in the other service. For more information, see Invoking Functions.
See also: AWS API Documentation
Request Syntax
client.create_function( FunctionName='string', Runtime='nodejs'|'nodejs4.3'|'nodejs6.10'|'nodejs8.10'|'nodejs10.x'|'nodejs12.x'|'java8'|'java11'|'python2.7'|'python3.6'|'python3.7'|'python3.8'|'dotnetcore1.0'|'dotnetcore2.0'|'dotnetcore2.1'|'nodejs4.3-edge'|'go1.x'|'ruby2.5'|'provided', 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' }, Layers=[ 'string', ] )
string
[REQUIRED]
The name of the Lambda function.
Name formats
Function name - my-function.
Function ARN - arn:aws:lambda:us-west-2:123456789012:function:my-function.
Partial ARN - 123456789012:function:my-function.
The length constraint applies only to the full ARN. If you specify only the function name, it is limited to 64 characters in length.
string
[REQUIRED]
The identifier of the function's runtime.
string
[REQUIRED]
The Amazon Resource Name (ARN) of the function's execution role.
string
[REQUIRED]
The name of the method within your code that Lambda calls to execute your function. The format includes the file name. It can also include namespaces and other qualifiers, depending on the runtime. For more information, see Programming Model.
dict
[REQUIRED]
The code for the function.
ZipFile (bytes) --
The base64-encoded contents of the deployment package. AWS SDK and AWS CLI clients handle the encoding for you.
S3Bucket (string) --
An Amazon S3 bucket in the same AWS Region as your function. The bucket can be in a different AWS account.
S3Key (string) --
The Amazon S3 key of the deployment package.
S3ObjectVersion (string) --
For versioned objects, the version of the deployment package object to use.
string
A description of the function.
integer
The amount of time that Lambda allows a function to run before stopping it. The default is 3 seconds. The maximum allowed value is 900 seconds.
integer
The amount of memory that your function has access to. Increasing the function's memory also increases its CPU allocation. The default value is 128 MB. The value must be a multiple of 64 MB.
boolean
Set to true to publish the first version of the function during creation.
dict
For network connectivity to AWS resources in a VPC, specify a list of security groups and subnets in the VPC. When you connect a function to a VPC, it can only access resources and the internet through that VPC. For more information, see VPC Settings.
SubnetIds (list) --
A list of VPC subnet IDs.
(string) --
SecurityGroupIds (list) --
A list of VPC security groups IDs.
(string) --
dict
A dead letter queue configuration that specifies the queue or topic where Lambda sends asynchronous events when they fail processing. For more information, see Dead Letter Queues.
TargetArn (string) --
The Amazon Resource Name (ARN) of an Amazon SQS queue or Amazon SNS topic.
dict
Environment variables that are accessible from function code during execution.
Variables (dict) --
Environment variable key-value pairs.
(string) --
(string) --
string
The ARN of the AWS Key Management Service (AWS KMS) key that's used to encrypt your function's environment variables. If it's not provided, AWS Lambda uses a default service key.
dict
Set Mode to Active to sample and trace a subset of incoming requests with AWS X-Ray.
Mode (string) --
The tracing mode.
dict
A list of tags to apply to the function.
(string) --
(string) --
list
A list of function layers to add to the function's execution environment. Specify each layer by its ARN, including the version.
(string) --
dict
Response Syntax
{ 'FunctionName': 'string', 'FunctionArn': 'string', 'Runtime': 'nodejs'|'nodejs4.3'|'nodejs6.10'|'nodejs8.10'|'nodejs10.x'|'nodejs12.x'|'java8'|'java11'|'python2.7'|'python3.6'|'python3.7'|'python3.8'|'dotnetcore1.0'|'dotnetcore2.0'|'dotnetcore2.1'|'nodejs4.3-edge'|'go1.x'|'ruby2.5'|'provided', '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', 'Layers': [ { 'Arn': 'string', 'CodeSize': 123 }, ], 'State': 'Pending'|'Active'|'Inactive'|'Failed', 'StateReason': 'string', 'StateReasonCode': 'Idle'|'Creating'|'Restoring'|'EniLimitExceeded'|'InsufficientRolePermissions'|'InvalidConfiguration'|'InternalError'|'SubnetOutOfIPAddresses', 'LastUpdateStatus': 'Successful'|'Failed'|'InProgress', 'LastUpdateStatusReason': 'string', 'LastUpdateStatusReasonCode': 'EniLimitExceeded'|'InsufficientRolePermissions'|'InvalidConfiguration'|'InternalError' }
Response Structure
(dict) --
Details about a function's configuration.
FunctionName (string) --
The name of the function.
FunctionArn (string) --
The function's Amazon Resource Name (ARN).
Runtime (string) --
The runtime environment for the Lambda function.
Role (string) --
The function's execution role.
Handler (string) --
The function that Lambda calls to begin executing your function.
CodeSize (integer) --
The size of the function's deployment package, in bytes.
Description (string) --
The function's description.
Timeout (integer) --
The amount of time that Lambda allows a function to run before stopping it.
MemorySize (integer) --
The memory that's allocated to the function.
LastModified (string) --
The date and time that the function was last updated, in ISO-8601 format (YYYY-MM-DDThh:mm:ss.sTZD).
CodeSha256 (string) --
The SHA256 hash of the function's deployment package.
Version (string) --
The version of the Lambda function.
VpcConfig (dict) --
The function's networking configuration.
SubnetIds (list) --
A list of VPC subnet IDs.
(string) --
SecurityGroupIds (list) --
A list of VPC security groups IDs.
(string) --
VpcId (string) --
The ID of the VPC.
DeadLetterConfig (dict) --
The function's dead letter queue.
TargetArn (string) --
The Amazon Resource Name (ARN) of an Amazon SQS queue or Amazon SNS topic.
Environment (dict) --
The function's environment variables.
Variables (dict) --
Environment variable key-value pairs.
(string) --
(string) --
Error (dict) --
Error messages for environment variables that couldn't be applied.
ErrorCode (string) --
The error code.
Message (string) --
The error message.
KMSKeyArn (string) --
The KMS key that's used to encrypt the function's environment variables. This key is only returned if you've configured a customer managed CMK.
TracingConfig (dict) --
The function's AWS X-Ray tracing configuration.
Mode (string) --
The tracing mode.
MasterArn (string) --
For Lambda@Edge functions, the ARN of the master function.
RevisionId (string) --
The latest updated revision of the function or alias.
Layers (list) --
The function's layers.
(dict) --
An AWS Lambda layer.
Arn (string) --
The Amazon Resource Name (ARN) of the function layer.
CodeSize (integer) --
The size of the layer archive in bytes.
State (string) --
The current state of the function. When the state is Inactive, you can reactivate the function by invoking it.
StateReason (string) --
The reason for the function's current state.
StateReasonCode (string) --
The reason code for the function's current state. When the code is Creating, you can't invoke or modify the function.
LastUpdateStatus (string) --
The status of the last update that was performed on the function.
LastUpdateStatusReason (string) --
The reason for the last update that was performed on the function.
LastUpdateStatusReasonCode (string) --
The reason code for the last update that was performed on the function.
{'BisectBatchOnFunctionError': 'boolean', 'DestinationConfig': {'OnFailure': {'Destination': 'string'}, 'OnSuccess': {'Destination': 'string'}}, 'MaximumRecordAgeInSeconds': 'integer', 'MaximumRetryAttempts': 'integer', 'ParallelizationFactor': 'integer'}
Deletes an event source mapping. You can get the identifier of a mapping from the output of ListEventSourceMappings.
When you delete an event source mapping, it enters a Deleting state and might not be completely deleted for several seconds.
See also: AWS API Documentation
Request Syntax
client.delete_event_source_mapping( UUID='string' )
string
[REQUIRED]
The identifier of the event source mapping.
dict
Response Syntax
{ 'UUID': 'string', 'BatchSize': 123, 'MaximumBatchingWindowInSeconds': 123, 'ParallelizationFactor': 123, 'EventSourceArn': 'string', 'FunctionArn': 'string', 'LastModified': datetime(2015, 1, 1), 'LastProcessingResult': 'string', 'State': 'string', 'StateTransitionReason': 'string', 'DestinationConfig': { 'OnSuccess': { 'Destination': 'string' }, 'OnFailure': { 'Destination': 'string' } }, 'MaximumRecordAgeInSeconds': 123, 'BisectBatchOnFunctionError': True|False, 'MaximumRetryAttempts': 123 }
Response Structure
(dict) --
A mapping between an AWS resource and an AWS Lambda function. See CreateEventSourceMapping for details.
UUID (string) --
The identifier of the event source mapping.
BatchSize (integer) --
The maximum number of items to retrieve in a single batch.
MaximumBatchingWindowInSeconds (integer) --
The maximum amount of time to gather records before invoking the function, in seconds.
ParallelizationFactor (integer) --
(Streams) The number of batches to process from each shard concurrently.
EventSourceArn (string) --
The Amazon Resource Name (ARN) of the event source.
FunctionArn (string) --
The ARN of the Lambda function.
LastModified (datetime) --
The date that the event source mapping was last updated, or its state changed.
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 one of the following: Creating, Enabling, Enabled, Disabling, Disabled, Updating, or Deleting.
StateTransitionReason (string) --
Indicates whether the last change to the event source mapping was made by a user, or by the Lambda service.
DestinationConfig (dict) --
(Streams) An Amazon SQS queue or Amazon SNS topic destination for discarded records.
OnSuccess (dict) --
The destination configuration for successful invocations.
Destination (string) --
The Amazon Resource Name (ARN) of the destination resource.
OnFailure (dict) --
The destination configuration for failed invocations.
Destination (string) --
The Amazon Resource Name (ARN) of the destination resource.
MaximumRecordAgeInSeconds (integer) --
(Streams) The maximum age of a record that Lambda sends to a function for processing.
BisectBatchOnFunctionError (boolean) --
(Streams) If the function returns an error, split the batch in two and retry.
MaximumRetryAttempts (integer) --
(Streams) The maximum number of times to retry when the function returns an error.
{'BisectBatchOnFunctionError': 'boolean', 'DestinationConfig': {'OnFailure': {'Destination': 'string'}, 'OnSuccess': {'Destination': 'string'}}, 'MaximumRecordAgeInSeconds': 'integer', 'MaximumRetryAttempts': 'integer', 'ParallelizationFactor': 'integer'}
Returns details about an event source mapping. You can get the identifier of a mapping from the output of ListEventSourceMappings.
See also: AWS API Documentation
Request Syntax
client.get_event_source_mapping( UUID='string' )
string
[REQUIRED]
The identifier of the event source mapping.
dict
Response Syntax
{ 'UUID': 'string', 'BatchSize': 123, 'MaximumBatchingWindowInSeconds': 123, 'ParallelizationFactor': 123, 'EventSourceArn': 'string', 'FunctionArn': 'string', 'LastModified': datetime(2015, 1, 1), 'LastProcessingResult': 'string', 'State': 'string', 'StateTransitionReason': 'string', 'DestinationConfig': { 'OnSuccess': { 'Destination': 'string' }, 'OnFailure': { 'Destination': 'string' } }, 'MaximumRecordAgeInSeconds': 123, 'BisectBatchOnFunctionError': True|False, 'MaximumRetryAttempts': 123 }
Response Structure
(dict) --
A mapping between an AWS resource and an AWS Lambda function. See CreateEventSourceMapping for details.
UUID (string) --
The identifier of the event source mapping.
BatchSize (integer) --
The maximum number of items to retrieve in a single batch.
MaximumBatchingWindowInSeconds (integer) --
The maximum amount of time to gather records before invoking the function, in seconds.
ParallelizationFactor (integer) --
(Streams) The number of batches to process from each shard concurrently.
EventSourceArn (string) --
The Amazon Resource Name (ARN) of the event source.
FunctionArn (string) --
The ARN of the Lambda function.
LastModified (datetime) --
The date that the event source mapping was last updated, or its state changed.
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 one of the following: Creating, Enabling, Enabled, Disabling, Disabled, Updating, or Deleting.
StateTransitionReason (string) --
Indicates whether the last change to the event source mapping was made by a user, or by the Lambda service.
DestinationConfig (dict) --
(Streams) An Amazon SQS queue or Amazon SNS topic destination for discarded records.
OnSuccess (dict) --
The destination configuration for successful invocations.
Destination (string) --
The Amazon Resource Name (ARN) of the destination resource.
OnFailure (dict) --
The destination configuration for failed invocations.
Destination (string) --
The Amazon Resource Name (ARN) of the destination resource.
MaximumRecordAgeInSeconds (integer) --
(Streams) The maximum age of a record that Lambda sends to a function for processing.
BisectBatchOnFunctionError (boolean) --
(Streams) If the function returns an error, split the batch in two and retry.
MaximumRetryAttempts (integer) --
(Streams) The maximum number of times to retry when the function returns an error.
{'Configuration': {'LastUpdateStatus': 'Successful | Failed | InProgress', 'LastUpdateStatusReason': 'string', 'LastUpdateStatusReasonCode': 'EniLimitExceeded | ' 'InsufficientRolePermissions ' '| InvalidConfiguration | ' 'InternalError', 'State': 'Pending | Active | Inactive | Failed', 'StateReason': 'string', 'StateReasonCode': 'Idle | Creating | Restoring | ' 'EniLimitExceeded | ' 'InsufficientRolePermissions | ' 'InvalidConfiguration | InternalError | ' 'SubnetOutOfIPAddresses'}}
Returns information about the function or function version, with a link to download the deployment package that's valid for 10 minutes. If you specify a function version, only details that are specific to that version are returned.
See also: AWS API Documentation
Request Syntax
client.get_function( FunctionName='string', Qualifier='string' )
string
[REQUIRED]
The name of the Lambda function, version, or alias.
Name formats
Function name - my-function (name-only), my-function:v1 (with alias).
Function ARN - arn:aws:lambda:us-west-2:123456789012:function:my-function.
Partial ARN - 123456789012:function:my-function.
You can append a version number or alias to any of the formats. The length constraint applies only to the full ARN. If you specify only the function name, it is limited to 64 characters in length.
string
Specify a version or alias to get details about a published version of the function.
dict
Response Syntax
{ 'Configuration': { 'FunctionName': 'string', 'FunctionArn': 'string', 'Runtime': 'nodejs'|'nodejs4.3'|'nodejs6.10'|'nodejs8.10'|'nodejs10.x'|'nodejs12.x'|'java8'|'java11'|'python2.7'|'python3.6'|'python3.7'|'python3.8'|'dotnetcore1.0'|'dotnetcore2.0'|'dotnetcore2.1'|'nodejs4.3-edge'|'go1.x'|'ruby2.5'|'provided', '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', 'Layers': [ { 'Arn': 'string', 'CodeSize': 123 }, ], 'State': 'Pending'|'Active'|'Inactive'|'Failed', 'StateReason': 'string', 'StateReasonCode': 'Idle'|'Creating'|'Restoring'|'EniLimitExceeded'|'InsufficientRolePermissions'|'InvalidConfiguration'|'InternalError'|'SubnetOutOfIPAddresses', 'LastUpdateStatus': 'Successful'|'Failed'|'InProgress', 'LastUpdateStatusReason': 'string', 'LastUpdateStatusReasonCode': 'EniLimitExceeded'|'InsufficientRolePermissions'|'InvalidConfiguration'|'InternalError' }, 'Code': { 'RepositoryType': 'string', 'Location': 'string' }, 'Tags': { 'string': 'string' }, 'Concurrency': { 'ReservedConcurrentExecutions': 123 } }
Response Structure
(dict) --
Configuration (dict) --
The configuration of the function or version.
FunctionName (string) --
The name of the function.
FunctionArn (string) --
The function's Amazon Resource Name (ARN).
Runtime (string) --
The runtime environment for the Lambda function.
Role (string) --
The function's execution role.
Handler (string) --
The function that Lambda calls to begin executing your function.
CodeSize (integer) --
The size of the function's deployment package, in bytes.
Description (string) --
The function's description.
Timeout (integer) --
The amount of time that Lambda allows a function to run before stopping it.
MemorySize (integer) --
The memory that's allocated to the function.
LastModified (string) --
The date and time that the function was last updated, in ISO-8601 format (YYYY-MM-DDThh:mm:ss.sTZD).
CodeSha256 (string) --
The SHA256 hash of the function's deployment package.
Version (string) --
The version of the Lambda function.
VpcConfig (dict) --
The function's networking configuration.
SubnetIds (list) --
A list of VPC subnet IDs.
(string) --
SecurityGroupIds (list) --
A list of VPC security groups IDs.
(string) --
VpcId (string) --
The ID of the VPC.
DeadLetterConfig (dict) --
The function's dead letter queue.
TargetArn (string) --
The Amazon Resource Name (ARN) of an Amazon SQS queue or Amazon SNS topic.
Environment (dict) --
The function's environment variables.
Variables (dict) --
Environment variable key-value pairs.
(string) --
(string) --
Error (dict) --
Error messages for environment variables that couldn't be applied.
ErrorCode (string) --
The error code.
Message (string) --
The error message.
KMSKeyArn (string) --
The KMS key that's used to encrypt the function's environment variables. This key is only returned if you've configured a customer managed CMK.
TracingConfig (dict) --
The function's AWS X-Ray tracing configuration.
Mode (string) --
The tracing mode.
MasterArn (string) --
For Lambda@Edge functions, the ARN of the master function.
RevisionId (string) --
The latest updated revision of the function or alias.
Layers (list) --
The function's layers.
(dict) --
An AWS Lambda layer.
Arn (string) --
The Amazon Resource Name (ARN) of the function layer.
CodeSize (integer) --
The size of the layer archive in bytes.
State (string) --
The current state of the function. When the state is Inactive, you can reactivate the function by invoking it.
StateReason (string) --
The reason for the function's current state.
StateReasonCode (string) --
The reason code for the function's current state. When the code is Creating, you can't invoke or modify the function.
LastUpdateStatus (string) --
The status of the last update that was performed on the function.
LastUpdateStatusReason (string) --
The reason for the last update that was performed on the function.
LastUpdateStatusReasonCode (string) --
The reason code for the last update that was performed on the function.
Code (dict) --
The deployment package of the function or version.
RepositoryType (string) --
The service that's hosting the file.
Location (string) --
A presigned URL that you can use to download the deployment package.
Tags (dict) --
The function's tags.
(string) --
(string) --
Concurrency (dict) --
The function's reserved concurrency.
ReservedConcurrentExecutions (integer) --
The number of concurrent executions that are reserved for this function. For more information, see Managing Concurrency.
{'LastUpdateStatus': 'Successful | Failed | InProgress', 'LastUpdateStatusReason': 'string', 'LastUpdateStatusReasonCode': 'EniLimitExceeded | InsufficientRolePermissions ' '| InvalidConfiguration | InternalError', 'State': 'Pending | Active | Inactive | Failed', 'StateReason': 'string', 'StateReasonCode': 'Idle | Creating | Restoring | EniLimitExceeded | ' 'InsufficientRolePermissions | InvalidConfiguration | ' 'InternalError | SubnetOutOfIPAddresses'}
Returns the version-specific settings of a Lambda function or version. The output includes only options that can vary between versions of a function. To modify these settings, use UpdateFunctionConfiguration.
To get all of a function's details, including function-level settings, use GetFunction.
See also: AWS API Documentation
Request Syntax
client.get_function_configuration( FunctionName='string', Qualifier='string' )
string
[REQUIRED]
The name of the Lambda function, version, or alias.
Name formats
Function name - my-function (name-only), my-function:v1 (with alias).
Function ARN - arn:aws:lambda:us-west-2:123456789012:function:my-function.
Partial ARN - 123456789012:function:my-function.
You can append a version number or alias to any of the formats. The length constraint applies only to the full ARN. If you specify only the function name, it is limited to 64 characters in length.
string
Specify a version or alias to get details about a published version of the function.
dict
Response Syntax
{ 'FunctionName': 'string', 'FunctionArn': 'string', 'Runtime': 'nodejs'|'nodejs4.3'|'nodejs6.10'|'nodejs8.10'|'nodejs10.x'|'nodejs12.x'|'java8'|'java11'|'python2.7'|'python3.6'|'python3.7'|'python3.8'|'dotnetcore1.0'|'dotnetcore2.0'|'dotnetcore2.1'|'nodejs4.3-edge'|'go1.x'|'ruby2.5'|'provided', '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', 'Layers': [ { 'Arn': 'string', 'CodeSize': 123 }, ], 'State': 'Pending'|'Active'|'Inactive'|'Failed', 'StateReason': 'string', 'StateReasonCode': 'Idle'|'Creating'|'Restoring'|'EniLimitExceeded'|'InsufficientRolePermissions'|'InvalidConfiguration'|'InternalError'|'SubnetOutOfIPAddresses', 'LastUpdateStatus': 'Successful'|'Failed'|'InProgress', 'LastUpdateStatusReason': 'string', 'LastUpdateStatusReasonCode': 'EniLimitExceeded'|'InsufficientRolePermissions'|'InvalidConfiguration'|'InternalError' }
Response Structure
(dict) --
Details about a function's configuration.
FunctionName (string) --
The name of the function.
FunctionArn (string) --
The function's Amazon Resource Name (ARN).
Runtime (string) --
The runtime environment for the Lambda function.
Role (string) --
The function's execution role.
Handler (string) --
The function that Lambda calls to begin executing your function.
CodeSize (integer) --
The size of the function's deployment package, in bytes.
Description (string) --
The function's description.
Timeout (integer) --
The amount of time that Lambda allows a function to run before stopping it.
MemorySize (integer) --
The memory that's allocated to the function.
LastModified (string) --
The date and time that the function was last updated, in ISO-8601 format (YYYY-MM-DDThh:mm:ss.sTZD).
CodeSha256 (string) --
The SHA256 hash of the function's deployment package.
Version (string) --
The version of the Lambda function.
VpcConfig (dict) --
The function's networking configuration.
SubnetIds (list) --
A list of VPC subnet IDs.
(string) --
SecurityGroupIds (list) --
A list of VPC security groups IDs.
(string) --
VpcId (string) --
The ID of the VPC.
DeadLetterConfig (dict) --
The function's dead letter queue.
TargetArn (string) --
The Amazon Resource Name (ARN) of an Amazon SQS queue or Amazon SNS topic.
Environment (dict) --
The function's environment variables.
Variables (dict) --
Environment variable key-value pairs.
(string) --
(string) --
Error (dict) --
Error messages for environment variables that couldn't be applied.
ErrorCode (string) --
The error code.
Message (string) --
The error message.
KMSKeyArn (string) --
The KMS key that's used to encrypt the function's environment variables. This key is only returned if you've configured a customer managed CMK.
TracingConfig (dict) --
The function's AWS X-Ray tracing configuration.
Mode (string) --
The tracing mode.
MasterArn (string) --
For Lambda@Edge functions, the ARN of the master function.
RevisionId (string) --
The latest updated revision of the function or alias.
Layers (list) --
The function's layers.
(dict) --
An AWS Lambda layer.
Arn (string) --
The Amazon Resource Name (ARN) of the function layer.
CodeSize (integer) --
The size of the layer archive in bytes.
State (string) --
The current state of the function. When the state is Inactive, you can reactivate the function by invoking it.
StateReason (string) --
The reason for the function's current state.
StateReasonCode (string) --
The reason code for the function's current state. When the code is Creating, you can't invoke or modify the function.
LastUpdateStatus (string) --
The status of the last update that was performed on the function.
LastUpdateStatusReason (string) --
The reason for the last update that was performed on the function.
LastUpdateStatusReasonCode (string) --
The reason code for the last update that was performed on the function.
{'EventSourceMappings': {'BisectBatchOnFunctionError': 'boolean', 'DestinationConfig': {'OnFailure': {'Destination': 'string'}, 'OnSuccess': {'Destination': 'string'}}, 'MaximumRecordAgeInSeconds': 'integer', 'MaximumRetryAttempts': 'integer', 'ParallelizationFactor': 'integer'}}
Lists event source mappings. Specify an EventSourceArn to only show event source mappings for a single event source.
See also: AWS API Documentation
Request Syntax
client.list_event_source_mappings( EventSourceArn='string', FunctionName='string', Marker='string', MaxItems=123 )
string
The Amazon Resource Name (ARN) of the event source.
Amazon Kinesis - The ARN of the data stream or a stream consumer.
Amazon DynamoDB Streams - The ARN of the stream.
Amazon Simple Queue Service - The ARN of the queue.
string
The name of the Lambda function.
Name formats
Function name - MyFunction.
Function ARN - arn:aws:lambda:us-west-2:123456789012:function:MyFunction.
Version or Alias ARN - arn:aws:lambda:us-west-2:123456789012:function:MyFunction:PROD.
Partial ARN - 123456789012:function:MyFunction.
The length constraint applies only to the full ARN. If you specify only the function name, it's limited to 64 characters in length.
string
A pagination token returned by a previous call.
integer
The maximum number of event source mappings to return.
dict
Response Syntax
{ 'NextMarker': 'string', 'EventSourceMappings': [ { 'UUID': 'string', 'BatchSize': 123, 'MaximumBatchingWindowInSeconds': 123, 'ParallelizationFactor': 123, 'EventSourceArn': 'string', 'FunctionArn': 'string', 'LastModified': datetime(2015, 1, 1), 'LastProcessingResult': 'string', 'State': 'string', 'StateTransitionReason': 'string', 'DestinationConfig': { 'OnSuccess': { 'Destination': 'string' }, 'OnFailure': { 'Destination': 'string' } }, 'MaximumRecordAgeInSeconds': 123, 'BisectBatchOnFunctionError': True|False, 'MaximumRetryAttempts': 123 }, ] }
Response Structure
(dict) --
NextMarker (string) --
A pagination token that's returned when the response doesn't contain all event source mappings.
EventSourceMappings (list) --
A list of event source mappings.
(dict) --
A mapping between an AWS resource and an AWS Lambda function. See CreateEventSourceMapping for details.
UUID (string) --
The identifier of the event source mapping.
BatchSize (integer) --
The maximum number of items to retrieve in a single batch.
MaximumBatchingWindowInSeconds (integer) --
The maximum amount of time to gather records before invoking the function, in seconds.
ParallelizationFactor (integer) --
(Streams) The number of batches to process from each shard concurrently.
EventSourceArn (string) --
The Amazon Resource Name (ARN) of the event source.
FunctionArn (string) --
The ARN of the Lambda function.
LastModified (datetime) --
The date that the event source mapping was last updated, or its state changed.
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 one of the following: Creating, Enabling, Enabled, Disabling, Disabled, Updating, or Deleting.
StateTransitionReason (string) --
Indicates whether the last change to the event source mapping was made by a user, or by the Lambda service.
DestinationConfig (dict) --
(Streams) An Amazon SQS queue or Amazon SNS topic destination for discarded records.
OnSuccess (dict) --
The destination configuration for successful invocations.
Destination (string) --
The Amazon Resource Name (ARN) of the destination resource.
OnFailure (dict) --
The destination configuration for failed invocations.
Destination (string) --
The Amazon Resource Name (ARN) of the destination resource.
MaximumRecordAgeInSeconds (integer) --
(Streams) The maximum age of a record that Lambda sends to a function for processing.
BisectBatchOnFunctionError (boolean) --
(Streams) If the function returns an error, split the batch in two and retry.
MaximumRetryAttempts (integer) --
(Streams) The maximum number of times to retry when the function returns an error.
{'Functions': {'LastUpdateStatus': 'Successful | Failed | InProgress', 'LastUpdateStatusReason': 'string', 'LastUpdateStatusReasonCode': 'EniLimitExceeded | ' 'InsufficientRolePermissions | ' 'InvalidConfiguration | ' 'InternalError', 'State': 'Pending | Active | Inactive | Failed', 'StateReason': 'string', 'StateReasonCode': 'Idle | Creating | Restoring | ' 'EniLimitExceeded | ' 'InsufficientRolePermissions | ' 'InvalidConfiguration | InternalError | ' 'SubnetOutOfIPAddresses'}}
Returns a list of Lambda functions, with the version-specific configuration of each.
Set FunctionVersion to ALL to include all published versions of each function in addition to the unpublished version. To get more information about a function or version, use GetFunction.
See also: AWS API Documentation
Request Syntax
client.list_functions( MasterRegion='string', FunctionVersion='ALL', Marker='string', MaxItems=123 )
string
For Lambda@Edge functions, the AWS Region of the master function. For example, us-east-2 or ALL. If specified, you must set FunctionVersion to ALL.
string
Set to ALL to include entries for all published versions of each function.
string
Specify the pagination token that's returned by a previous request to retrieve the next page of results.
integer
Specify a value between 1 and 50 to limit the number of functions in the response.
dict
Response Syntax
{ 'NextMarker': 'string', 'Functions': [ { 'FunctionName': 'string', 'FunctionArn': 'string', 'Runtime': 'nodejs'|'nodejs4.3'|'nodejs6.10'|'nodejs8.10'|'nodejs10.x'|'nodejs12.x'|'java8'|'java11'|'python2.7'|'python3.6'|'python3.7'|'python3.8'|'dotnetcore1.0'|'dotnetcore2.0'|'dotnetcore2.1'|'nodejs4.3-edge'|'go1.x'|'ruby2.5'|'provided', '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', 'Layers': [ { 'Arn': 'string', 'CodeSize': 123 }, ], 'State': 'Pending'|'Active'|'Inactive'|'Failed', 'StateReason': 'string', 'StateReasonCode': 'Idle'|'Creating'|'Restoring'|'EniLimitExceeded'|'InsufficientRolePermissions'|'InvalidConfiguration'|'InternalError'|'SubnetOutOfIPAddresses', 'LastUpdateStatus': 'Successful'|'Failed'|'InProgress', 'LastUpdateStatusReason': 'string', 'LastUpdateStatusReasonCode': 'EniLimitExceeded'|'InsufficientRolePermissions'|'InvalidConfiguration'|'InternalError' }, ] }
Response Structure
(dict) --
A list of Lambda functions.
NextMarker (string) --
The pagination token that's included if more results are available.
Functions (list) --
A list of Lambda functions.
(dict) --
Details about a function's configuration.
FunctionName (string) --
The name of the function.
FunctionArn (string) --
The function's Amazon Resource Name (ARN).
Runtime (string) --
The runtime environment for the Lambda function.
Role (string) --
The function's execution role.
Handler (string) --
The function that Lambda calls to begin executing your function.
CodeSize (integer) --
The size of the function's deployment package, in bytes.
Description (string) --
The function's description.
Timeout (integer) --
The amount of time that Lambda allows a function to run before stopping it.
MemorySize (integer) --
The memory that's allocated to the function.
LastModified (string) --
The date and time that the function was last updated, in ISO-8601 format (YYYY-MM-DDThh:mm:ss.sTZD).
CodeSha256 (string) --
The SHA256 hash of the function's deployment package.
Version (string) --
The version of the Lambda function.
VpcConfig (dict) --
The function's networking configuration.
SubnetIds (list) --
A list of VPC subnet IDs.
(string) --
SecurityGroupIds (list) --
A list of VPC security groups IDs.
(string) --
VpcId (string) --
The ID of the VPC.
DeadLetterConfig (dict) --
The function's dead letter queue.
TargetArn (string) --
The Amazon Resource Name (ARN) of an Amazon SQS queue or Amazon SNS topic.
Environment (dict) --
The function's environment variables.
Variables (dict) --
Environment variable key-value pairs.
(string) --
(string) --
Error (dict) --
Error messages for environment variables that couldn't be applied.
ErrorCode (string) --
The error code.
Message (string) --
The error message.
KMSKeyArn (string) --
The KMS key that's used to encrypt the function's environment variables. This key is only returned if you've configured a customer managed CMK.
TracingConfig (dict) --
The function's AWS X-Ray tracing configuration.
Mode (string) --
The tracing mode.
MasterArn (string) --
For Lambda@Edge functions, the ARN of the master function.
RevisionId (string) --
The latest updated revision of the function or alias.
Layers (list) --
The function's layers.
(dict) --
An AWS Lambda layer.
Arn (string) --
The Amazon Resource Name (ARN) of the function layer.
CodeSize (integer) --
The size of the layer archive in bytes.
State (string) --
The current state of the function. When the state is Inactive, you can reactivate the function by invoking it.
StateReason (string) --
The reason for the function's current state.
StateReasonCode (string) --
The reason code for the function's current state. When the code is Creating, you can't invoke or modify the function.
LastUpdateStatus (string) --
The status of the last update that was performed on the function.
LastUpdateStatusReason (string) --
The reason for the last update that was performed on the function.
LastUpdateStatusReasonCode (string) --
The reason code for the last update that was performed on the function.
{'Versions': {'LastUpdateStatus': 'Successful | Failed | InProgress', 'LastUpdateStatusReason': 'string', 'LastUpdateStatusReasonCode': 'EniLimitExceeded | ' 'InsufficientRolePermissions | ' 'InvalidConfiguration | ' 'InternalError', 'State': 'Pending | Active | Inactive | Failed', 'StateReason': 'string', 'StateReasonCode': 'Idle | Creating | Restoring | ' 'EniLimitExceeded | ' 'InsufficientRolePermissions | ' 'InvalidConfiguration | InternalError | ' 'SubnetOutOfIPAddresses'}}
Returns a list of versions, with the version-specific configuration of each.
See also: AWS API Documentation
Request Syntax
client.list_versions_by_function( FunctionName='string', Marker='string', MaxItems=123 )
string
[REQUIRED]
The name of the Lambda function.
Name formats
Function name - MyFunction.
Function ARN - arn:aws:lambda:us-west-2:123456789012:function:MyFunction.
Partial ARN - 123456789012:function:MyFunction.
The length constraint applies only to the full ARN. If you specify only the function name, it is limited to 64 characters in length.
string
Specify the pagination token that's returned by a previous request to retrieve the next page of results.
integer
Limit the number of versions that are returned.
dict
Response Syntax
{ 'NextMarker': 'string', 'Versions': [ { 'FunctionName': 'string', 'FunctionArn': 'string', 'Runtime': 'nodejs'|'nodejs4.3'|'nodejs6.10'|'nodejs8.10'|'nodejs10.x'|'nodejs12.x'|'java8'|'java11'|'python2.7'|'python3.6'|'python3.7'|'python3.8'|'dotnetcore1.0'|'dotnetcore2.0'|'dotnetcore2.1'|'nodejs4.3-edge'|'go1.x'|'ruby2.5'|'provided', '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', 'Layers': [ { 'Arn': 'string', 'CodeSize': 123 }, ], 'State': 'Pending'|'Active'|'Inactive'|'Failed', 'StateReason': 'string', 'StateReasonCode': 'Idle'|'Creating'|'Restoring'|'EniLimitExceeded'|'InsufficientRolePermissions'|'InvalidConfiguration'|'InternalError'|'SubnetOutOfIPAddresses', 'LastUpdateStatus': 'Successful'|'Failed'|'InProgress', 'LastUpdateStatusReason': 'string', 'LastUpdateStatusReasonCode': 'EniLimitExceeded'|'InsufficientRolePermissions'|'InvalidConfiguration'|'InternalError' }, ] }
Response Structure
(dict) --
NextMarker (string) --
The pagination token that's included if more results are available.
Versions (list) --
A list of Lambda function versions.
(dict) --
Details about a function's configuration.
FunctionName (string) --
The name of the function.
FunctionArn (string) --
The function's Amazon Resource Name (ARN).
Runtime (string) --
The runtime environment for the Lambda function.
Role (string) --
The function's execution role.
Handler (string) --
The function that Lambda calls to begin executing your function.
CodeSize (integer) --
The size of the function's deployment package, in bytes.
Description (string) --
The function's description.
Timeout (integer) --
The amount of time that Lambda allows a function to run before stopping it.
MemorySize (integer) --
The memory that's allocated to the function.
LastModified (string) --
The date and time that the function was last updated, in ISO-8601 format (YYYY-MM-DDThh:mm:ss.sTZD).
CodeSha256 (string) --
The SHA256 hash of the function's deployment package.
Version (string) --
The version of the Lambda function.
VpcConfig (dict) --
The function's networking configuration.
SubnetIds (list) --
A list of VPC subnet IDs.
(string) --
SecurityGroupIds (list) --
A list of VPC security groups IDs.
(string) --
VpcId (string) --
The ID of the VPC.
DeadLetterConfig (dict) --
The function's dead letter queue.
TargetArn (string) --
The Amazon Resource Name (ARN) of an Amazon SQS queue or Amazon SNS topic.
Environment (dict) --
The function's environment variables.
Variables (dict) --
Environment variable key-value pairs.
(string) --
(string) --
Error (dict) --
Error messages for environment variables that couldn't be applied.
ErrorCode (string) --
The error code.
Message (string) --
The error message.
KMSKeyArn (string) --
The KMS key that's used to encrypt the function's environment variables. This key is only returned if you've configured a customer managed CMK.
TracingConfig (dict) --
The function's AWS X-Ray tracing configuration.
Mode (string) --
The tracing mode.
MasterArn (string) --
For Lambda@Edge functions, the ARN of the master function.
RevisionId (string) --
The latest updated revision of the function or alias.
Layers (list) --
The function's layers.
(dict) --
An AWS Lambda layer.
Arn (string) --
The Amazon Resource Name (ARN) of the function layer.
CodeSize (integer) --
The size of the layer archive in bytes.
State (string) --
The current state of the function. When the state is Inactive, you can reactivate the function by invoking it.
StateReason (string) --
The reason for the function's current state.
StateReasonCode (string) --
The reason code for the function's current state. When the code is Creating, you can't invoke or modify the function.
LastUpdateStatus (string) --
The status of the last update that was performed on the function.
LastUpdateStatusReason (string) --
The reason for the last update that was performed on the function.
LastUpdateStatusReasonCode (string) --
The reason code for the last update that was performed on the function.
{'LastUpdateStatus': 'Successful | Failed | InProgress', 'LastUpdateStatusReason': 'string', 'LastUpdateStatusReasonCode': 'EniLimitExceeded | InsufficientRolePermissions ' '| InvalidConfiguration | InternalError', 'State': 'Pending | Active | Inactive | Failed', 'StateReason': 'string', 'StateReasonCode': 'Idle | Creating | Restoring | EniLimitExceeded | ' 'InsufficientRolePermissions | InvalidConfiguration | ' 'InternalError | SubnetOutOfIPAddresses'}
Creates a version from the current code and configuration of a function. Use versions to create a snapshot of your function code and configuration that doesn't change.
AWS Lambda doesn't publish a version if the function's configuration and code haven't changed since the last version. Use UpdateFunctionCode or UpdateFunctionConfiguration to update the function before publishing a version.
Clients can invoke versions directly or with an alias. To create an alias, use CreateAlias.
See also: AWS API Documentation
Request Syntax
client.publish_version( FunctionName='string', CodeSha256='string', Description='string', RevisionId='string' )
string
[REQUIRED]
The name of the Lambda function.
Name formats
Function name - MyFunction.
Function ARN - arn:aws:lambda:us-west-2:123456789012:function:MyFunction.
Partial ARN - 123456789012:function:MyFunction.
The length constraint applies only to the full ARN. If you specify only the function name, it is limited to 64 characters in length.
string
Only publish a version if the hash value matches the value that's specified. Use this option to avoid publishing a version if the function code has changed since you last updated it. You can get the hash for the version that you uploaded from the output of UpdateFunctionCode.
string
A description for the version to override the description in the function configuration.
string
Only update the function if the revision ID matches the ID that's specified. Use this option to avoid publishing a version if the function configuration has changed since you last updated it.
dict
Response Syntax
{ 'FunctionName': 'string', 'FunctionArn': 'string', 'Runtime': 'nodejs'|'nodejs4.3'|'nodejs6.10'|'nodejs8.10'|'nodejs10.x'|'nodejs12.x'|'java8'|'java11'|'python2.7'|'python3.6'|'python3.7'|'python3.8'|'dotnetcore1.0'|'dotnetcore2.0'|'dotnetcore2.1'|'nodejs4.3-edge'|'go1.x'|'ruby2.5'|'provided', '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', 'Layers': [ { 'Arn': 'string', 'CodeSize': 123 }, ], 'State': 'Pending'|'Active'|'Inactive'|'Failed', 'StateReason': 'string', 'StateReasonCode': 'Idle'|'Creating'|'Restoring'|'EniLimitExceeded'|'InsufficientRolePermissions'|'InvalidConfiguration'|'InternalError'|'SubnetOutOfIPAddresses', 'LastUpdateStatus': 'Successful'|'Failed'|'InProgress', 'LastUpdateStatusReason': 'string', 'LastUpdateStatusReasonCode': 'EniLimitExceeded'|'InsufficientRolePermissions'|'InvalidConfiguration'|'InternalError' }
Response Structure
(dict) --
Details about a function's configuration.
FunctionName (string) --
The name of the function.
FunctionArn (string) --
The function's Amazon Resource Name (ARN).
Runtime (string) --
The runtime environment for the Lambda function.
Role (string) --
The function's execution role.
Handler (string) --
The function that Lambda calls to begin executing your function.
CodeSize (integer) --
The size of the function's deployment package, in bytes.
Description (string) --
The function's description.
Timeout (integer) --
The amount of time that Lambda allows a function to run before stopping it.
MemorySize (integer) --
The memory that's allocated to the function.
LastModified (string) --
The date and time that the function was last updated, in ISO-8601 format (YYYY-MM-DDThh:mm:ss.sTZD).
CodeSha256 (string) --
The SHA256 hash of the function's deployment package.
Version (string) --
The version of the Lambda function.
VpcConfig (dict) --
The function's networking configuration.
SubnetIds (list) --
A list of VPC subnet IDs.
(string) --
SecurityGroupIds (list) --
A list of VPC security groups IDs.
(string) --
VpcId (string) --
The ID of the VPC.
DeadLetterConfig (dict) --
The function's dead letter queue.
TargetArn (string) --
The Amazon Resource Name (ARN) of an Amazon SQS queue or Amazon SNS topic.
Environment (dict) --
The function's environment variables.
Variables (dict) --
Environment variable key-value pairs.
(string) --
(string) --
Error (dict) --
Error messages for environment variables that couldn't be applied.
ErrorCode (string) --
The error code.
Message (string) --
The error message.
KMSKeyArn (string) --
The KMS key that's used to encrypt the function's environment variables. This key is only returned if you've configured a customer managed CMK.
TracingConfig (dict) --
The function's AWS X-Ray tracing configuration.
Mode (string) --
The tracing mode.
MasterArn (string) --
For Lambda@Edge functions, the ARN of the master function.
RevisionId (string) --
The latest updated revision of the function or alias.
Layers (list) --
The function's layers.
(dict) --
An AWS Lambda layer.
Arn (string) --
The Amazon Resource Name (ARN) of the function layer.
CodeSize (integer) --
The size of the layer archive in bytes.
State (string) --
The current state of the function. When the state is Inactive, you can reactivate the function by invoking it.
StateReason (string) --
The reason for the function's current state.
StateReasonCode (string) --
The reason code for the function's current state. When the code is Creating, you can't invoke or modify the function.
LastUpdateStatus (string) --
The status of the last update that was performed on the function.
LastUpdateStatusReason (string) --
The reason for the last update that was performed on the function.
LastUpdateStatusReasonCode (string) --
The reason code for the last update that was performed on the function.
{'BisectBatchOnFunctionError': 'boolean', 'DestinationConfig': {'OnFailure': {'Destination': 'string'}, 'OnSuccess': {'Destination': 'string'}}, 'MaximumRecordAgeInSeconds': 'integer', 'MaximumRetryAttempts': 'integer', 'ParallelizationFactor': 'integer'}
Updates an event source mapping. You can change the function that AWS Lambda invokes, or pause invocation and resume later from the same location.
The following error handling options are only available for stream sources (DynamoDB and Kinesis):
BisectBatchOnFunctionError - If the function returns an error, split the batch in two and retry.
DestinationConfig - Send discarded records to an Amazon SQS queue or Amazon SNS topic.
MaximumRecordAgeInSeconds - Discard records older than the specified age.
MaximumRetryAttempts - Discard records after the specified number of retries.
See also: AWS API Documentation
Request Syntax
client.update_event_source_mapping( UUID='string', FunctionName='string', Enabled=True|False, BatchSize=123, MaximumBatchingWindowInSeconds=123, DestinationConfig={ 'OnSuccess': { 'Destination': 'string' }, 'OnFailure': { 'Destination': 'string' } }, MaximumRecordAgeInSeconds=123, BisectBatchOnFunctionError=True|False, MaximumRetryAttempts=123, ParallelizationFactor=123 )
string
[REQUIRED]
The identifier of the event source mapping.
string
The name of the Lambda function.
Name formats
Function name - MyFunction.
Function ARN - arn:aws:lambda:us-west-2:123456789012:function:MyFunction.
Version or Alias ARN - arn:aws:lambda:us-west-2:123456789012:function:MyFunction:PROD.
Partial ARN - 123456789012:function:MyFunction.
The length constraint applies only to the full ARN. If you specify only the function name, it's limited to 64 characters in length.
boolean
Disables the event source mapping to pause polling and invocation.
integer
The maximum number of items to retrieve in a single batch.
Amazon Kinesis - Default 100. Max 10,000.
Amazon DynamoDB Streams - Default 100. Max 1,000.
Amazon Simple Queue Service - Default 10. Max 10.
integer
The maximum amount of time to gather records before invoking the function, in seconds.
dict
(Streams) An Amazon SQS queue or Amazon SNS topic destination for discarded records.
OnSuccess (dict) --
The destination configuration for successful invocations.
Destination (string) --
The Amazon Resource Name (ARN) of the destination resource.
OnFailure (dict) --
The destination configuration for failed invocations.
Destination (string) --
The Amazon Resource Name (ARN) of the destination resource.
integer
(Streams) The maximum age of a record that Lambda sends to a function for processing.
boolean
(Streams) If the function returns an error, split the batch in two and retry.
integer
(Streams) The maximum number of times to retry when the function returns an error.
integer
(Streams) The number of batches to process from each shard concurrently.
dict
Response Syntax
{ 'UUID': 'string', 'BatchSize': 123, 'MaximumBatchingWindowInSeconds': 123, 'ParallelizationFactor': 123, 'EventSourceArn': 'string', 'FunctionArn': 'string', 'LastModified': datetime(2015, 1, 1), 'LastProcessingResult': 'string', 'State': 'string', 'StateTransitionReason': 'string', 'DestinationConfig': { 'OnSuccess': { 'Destination': 'string' }, 'OnFailure': { 'Destination': 'string' } }, 'MaximumRecordAgeInSeconds': 123, 'BisectBatchOnFunctionError': True|False, 'MaximumRetryAttempts': 123 }
Response Structure
(dict) --
A mapping between an AWS resource and an AWS Lambda function. See CreateEventSourceMapping for details.
UUID (string) --
The identifier of the event source mapping.
BatchSize (integer) --
The maximum number of items to retrieve in a single batch.
MaximumBatchingWindowInSeconds (integer) --
The maximum amount of time to gather records before invoking the function, in seconds.
ParallelizationFactor (integer) --
(Streams) The number of batches to process from each shard concurrently.
EventSourceArn (string) --
The Amazon Resource Name (ARN) of the event source.
FunctionArn (string) --
The ARN of the Lambda function.
LastModified (datetime) --
The date that the event source mapping was last updated, or its state changed.
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 one of the following: Creating, Enabling, Enabled, Disabling, Disabled, Updating, or Deleting.
StateTransitionReason (string) --
Indicates whether the last change to the event source mapping was made by a user, or by the Lambda service.
DestinationConfig (dict) --
(Streams) An Amazon SQS queue or Amazon SNS topic destination for discarded records.
OnSuccess (dict) --
The destination configuration for successful invocations.
Destination (string) --
The Amazon Resource Name (ARN) of the destination resource.
OnFailure (dict) --
The destination configuration for failed invocations.
Destination (string) --
The Amazon Resource Name (ARN) of the destination resource.
MaximumRecordAgeInSeconds (integer) --
(Streams) The maximum age of a record that Lambda sends to a function for processing.
BisectBatchOnFunctionError (boolean) --
(Streams) If the function returns an error, split the batch in two and retry.
MaximumRetryAttempts (integer) --
(Streams) The maximum number of times to retry when the function returns an error.
{'LastUpdateStatus': 'Successful | Failed | InProgress', 'LastUpdateStatusReason': 'string', 'LastUpdateStatusReasonCode': 'EniLimitExceeded | InsufficientRolePermissions ' '| InvalidConfiguration | InternalError', 'State': 'Pending | Active | Inactive | Failed', 'StateReason': 'string', 'StateReasonCode': 'Idle | Creating | Restoring | EniLimitExceeded | ' 'InsufficientRolePermissions | InvalidConfiguration | ' 'InternalError | SubnetOutOfIPAddresses'}
Updates a Lambda function's code.
The function's code is locked when you publish a version. You can't modify the code of a published version, only the unpublished version.
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 name of the Lambda function.
Name formats
Function name - my-function.
Function ARN - arn:aws:lambda:us-west-2:123456789012:function:my-function.
Partial ARN - 123456789012:function:my-function.
The length constraint applies only to the full ARN. If you specify only the function name, it is limited to 64 characters in length.
bytes
The base64-encoded contents of the deployment package. AWS SDK and AWS CLI clients handle the encoding for you.
string
An Amazon S3 bucket in the same AWS Region as your function. The bucket can be in a different AWS account.
string
The Amazon S3 key of the deployment package.
string
For versioned objects, the version of the deployment package object to use.
boolean
Set to true to publish a new version of the function after updating the code. This has the same effect as calling PublishVersion separately.
boolean
Set to true to validate the request parameters and access permissions without modifying the function code.
string
Only update the function if the revision ID matches the ID that's specified. Use this option to avoid modifying a function that has changed since you last read it.
dict
Response Syntax
{ 'FunctionName': 'string', 'FunctionArn': 'string', 'Runtime': 'nodejs'|'nodejs4.3'|'nodejs6.10'|'nodejs8.10'|'nodejs10.x'|'nodejs12.x'|'java8'|'java11'|'python2.7'|'python3.6'|'python3.7'|'python3.8'|'dotnetcore1.0'|'dotnetcore2.0'|'dotnetcore2.1'|'nodejs4.3-edge'|'go1.x'|'ruby2.5'|'provided', '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', 'Layers': [ { 'Arn': 'string', 'CodeSize': 123 }, ], 'State': 'Pending'|'Active'|'Inactive'|'Failed', 'StateReason': 'string', 'StateReasonCode': 'Idle'|'Creating'|'Restoring'|'EniLimitExceeded'|'InsufficientRolePermissions'|'InvalidConfiguration'|'InternalError'|'SubnetOutOfIPAddresses', 'LastUpdateStatus': 'Successful'|'Failed'|'InProgress', 'LastUpdateStatusReason': 'string', 'LastUpdateStatusReasonCode': 'EniLimitExceeded'|'InsufficientRolePermissions'|'InvalidConfiguration'|'InternalError' }
Response Structure
(dict) --
Details about a function's configuration.
FunctionName (string) --
The name of the function.
FunctionArn (string) --
The function's Amazon Resource Name (ARN).
Runtime (string) --
The runtime environment for the Lambda function.
Role (string) --
The function's execution role.
Handler (string) --
The function that Lambda calls to begin executing your function.
CodeSize (integer) --
The size of the function's deployment package, in bytes.
Description (string) --
The function's description.
Timeout (integer) --
The amount of time that Lambda allows a function to run before stopping it.
MemorySize (integer) --
The memory that's allocated to the function.
LastModified (string) --
The date and time that the function was last updated, in ISO-8601 format (YYYY-MM-DDThh:mm:ss.sTZD).
CodeSha256 (string) --
The SHA256 hash of the function's deployment package.
Version (string) --
The version of the Lambda function.
VpcConfig (dict) --
The function's networking configuration.
SubnetIds (list) --
A list of VPC subnet IDs.
(string) --
SecurityGroupIds (list) --
A list of VPC security groups IDs.
(string) --
VpcId (string) --
The ID of the VPC.
DeadLetterConfig (dict) --
The function's dead letter queue.
TargetArn (string) --
The Amazon Resource Name (ARN) of an Amazon SQS queue or Amazon SNS topic.
Environment (dict) --
The function's environment variables.
Variables (dict) --
Environment variable key-value pairs.
(string) --
(string) --
Error (dict) --
Error messages for environment variables that couldn't be applied.
ErrorCode (string) --
The error code.
Message (string) --
The error message.
KMSKeyArn (string) --
The KMS key that's used to encrypt the function's environment variables. This key is only returned if you've configured a customer managed CMK.
TracingConfig (dict) --
The function's AWS X-Ray tracing configuration.
Mode (string) --
The tracing mode.
MasterArn (string) --
For Lambda@Edge functions, the ARN of the master function.
RevisionId (string) --
The latest updated revision of the function or alias.
Layers (list) --
The function's layers.
(dict) --
An AWS Lambda layer.
Arn (string) --
The Amazon Resource Name (ARN) of the function layer.
CodeSize (integer) --
The size of the layer archive in bytes.
State (string) --
The current state of the function. When the state is Inactive, you can reactivate the function by invoking it.
StateReason (string) --
The reason for the function's current state.
StateReasonCode (string) --
The reason code for the function's current state. When the code is Creating, you can't invoke or modify the function.
LastUpdateStatus (string) --
The status of the last update that was performed on the function.
LastUpdateStatusReason (string) --
The reason for the last update that was performed on the function.
LastUpdateStatusReasonCode (string) --
The reason code for the last update that was performed on the function.
{'LastUpdateStatus': 'Successful | Failed | InProgress', 'LastUpdateStatusReason': 'string', 'LastUpdateStatusReasonCode': 'EniLimitExceeded | InsufficientRolePermissions ' '| InvalidConfiguration | InternalError', 'State': 'Pending | Active | Inactive | Failed', 'StateReason': 'string', 'StateReasonCode': 'Idle | Creating | Restoring | EniLimitExceeded | ' 'InsufficientRolePermissions | InvalidConfiguration | ' 'InternalError | SubnetOutOfIPAddresses'}
Modify the version-specific settings of a Lambda function.
When you update a function, Lambda provisions an instance of the function and its supporting resources. If your function connects to a VPC, this process can take a minute. During this time, you can't modify the function, but you can still invoke it. The LastUpdateStatus, LastUpdateStatusReason, and LastUpdateStatusReasonCode fields in the response from GetFunctionConfiguration indicate when the update is complete and the function is processing events with the new configuration. For more information, see Function States.
These settings can vary between versions of a function and are locked when you publish a version. You can't modify the configuration of a published version, only the unpublished version.
To configure function concurrency, use PutFunctionConcurrency. To grant invoke permissions to an account or AWS service, use AddPermission.
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'|'nodejs8.10'|'nodejs10.x'|'nodejs12.x'|'java8'|'java11'|'python2.7'|'python3.6'|'python3.7'|'python3.8'|'dotnetcore1.0'|'dotnetcore2.0'|'dotnetcore2.1'|'nodejs4.3-edge'|'go1.x'|'ruby2.5'|'provided', DeadLetterConfig={ 'TargetArn': 'string' }, KMSKeyArn='string', TracingConfig={ 'Mode': 'Active'|'PassThrough' }, RevisionId='string', Layers=[ 'string', ] )
string
[REQUIRED]
The name of the Lambda function.
Name formats
Function name - my-function.
Function ARN - arn:aws:lambda:us-west-2:123456789012:function:my-function.
Partial ARN - 123456789012:function:my-function.
The length constraint applies only to the full ARN. If you specify only the function name, it is limited to 64 characters in length.
string
The Amazon Resource Name (ARN) of the function's execution role.
string
The name of the method within your code that Lambda calls to execute your function. The format includes the file name. It can also include namespaces and other qualifiers, depending on the runtime. For more information, see Programming Model.
string
A description of the function.
integer
The amount of time that Lambda allows a function to run before stopping it. The default is 3 seconds. The maximum allowed value is 900 seconds.
integer
The amount of memory that your function has access to. Increasing the function's memory also increases its CPU allocation. The default value is 128 MB. The value must be a multiple of 64 MB.
dict
For network connectivity to AWS resources in a VPC, specify a list of security groups and subnets in the VPC. When you connect a function to a VPC, it can only access resources and the internet through that VPC. For more information, see VPC Settings.
SubnetIds (list) --
A list of VPC subnet IDs.
(string) --
SecurityGroupIds (list) --
A list of VPC security groups IDs.
(string) --
dict
Environment variables that are accessible from function code during execution.
Variables (dict) --
Environment variable key-value pairs.
(string) --
(string) --
string
The identifier of the function's runtime.
dict
A dead letter queue configuration that specifies the queue or topic where Lambda sends asynchronous events when they fail processing. For more information, see Dead Letter Queues.
TargetArn (string) --
The Amazon Resource Name (ARN) of an Amazon SQS queue or Amazon SNS topic.
string
The ARN of the AWS Key Management Service (AWS KMS) key that's used to encrypt your function's environment variables. If it's not provided, AWS Lambda uses a default service key.
dict
Set Mode to Active to sample and trace a subset of incoming requests with AWS X-Ray.
Mode (string) --
The tracing mode.
string
Only update the function if the revision ID matches the ID that's specified. Use this option to avoid modifying a function that has changed since you last read it.
list
A list of function layers to add to the function's execution environment. Specify each layer by its ARN, including the version.
(string) --
dict
Response Syntax
{ 'FunctionName': 'string', 'FunctionArn': 'string', 'Runtime': 'nodejs'|'nodejs4.3'|'nodejs6.10'|'nodejs8.10'|'nodejs10.x'|'nodejs12.x'|'java8'|'java11'|'python2.7'|'python3.6'|'python3.7'|'python3.8'|'dotnetcore1.0'|'dotnetcore2.0'|'dotnetcore2.1'|'nodejs4.3-edge'|'go1.x'|'ruby2.5'|'provided', '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', 'Layers': [ { 'Arn': 'string', 'CodeSize': 123 }, ], 'State': 'Pending'|'Active'|'Inactive'|'Failed', 'StateReason': 'string', 'StateReasonCode': 'Idle'|'Creating'|'Restoring'|'EniLimitExceeded'|'InsufficientRolePermissions'|'InvalidConfiguration'|'InternalError'|'SubnetOutOfIPAddresses', 'LastUpdateStatus': 'Successful'|'Failed'|'InProgress', 'LastUpdateStatusReason': 'string', 'LastUpdateStatusReasonCode': 'EniLimitExceeded'|'InsufficientRolePermissions'|'InvalidConfiguration'|'InternalError' }
Response Structure
(dict) --
Details about a function's configuration.
FunctionName (string) --
The name of the function.
FunctionArn (string) --
The function's Amazon Resource Name (ARN).
Runtime (string) --
The runtime environment for the Lambda function.
Role (string) --
The function's execution role.
Handler (string) --
The function that Lambda calls to begin executing your function.
CodeSize (integer) --
The size of the function's deployment package, in bytes.
Description (string) --
The function's description.
Timeout (integer) --
The amount of time that Lambda allows a function to run before stopping it.
MemorySize (integer) --
The memory that's allocated to the function.
LastModified (string) --
The date and time that the function was last updated, in ISO-8601 format (YYYY-MM-DDThh:mm:ss.sTZD).
CodeSha256 (string) --
The SHA256 hash of the function's deployment package.
Version (string) --
The version of the Lambda function.
VpcConfig (dict) --
The function's networking configuration.
SubnetIds (list) --
A list of VPC subnet IDs.
(string) --
SecurityGroupIds (list) --
A list of VPC security groups IDs.
(string) --
VpcId (string) --
The ID of the VPC.
DeadLetterConfig (dict) --
The function's dead letter queue.
TargetArn (string) --
The Amazon Resource Name (ARN) of an Amazon SQS queue or Amazon SNS topic.
Environment (dict) --
The function's environment variables.
Variables (dict) --
Environment variable key-value pairs.
(string) --
(string) --
Error (dict) --
Error messages for environment variables that couldn't be applied.
ErrorCode (string) --
The error code.
Message (string) --
The error message.
KMSKeyArn (string) --
The KMS key that's used to encrypt the function's environment variables. This key is only returned if you've configured a customer managed CMK.
TracingConfig (dict) --
The function's AWS X-Ray tracing configuration.
Mode (string) --
The tracing mode.
MasterArn (string) --
For Lambda@Edge functions, the ARN of the master function.
RevisionId (string) --
The latest updated revision of the function or alias.
Layers (list) --
The function's layers.
(dict) --
An AWS Lambda layer.
Arn (string) --
The Amazon Resource Name (ARN) of the function layer.
CodeSize (integer) --
The size of the layer archive in bytes.
State (string) --
The current state of the function. When the state is Inactive, you can reactivate the function by invoking it.
StateReason (string) --
The reason for the function's current state.
StateReasonCode (string) --
The reason code for the function's current state. When the code is Creating, you can't invoke or modify the function.
LastUpdateStatus (string) --
The status of the last update that was performed on the function.
LastUpdateStatusReason (string) --
The reason for the last update that was performed on the function.
LastUpdateStatusReasonCode (string) --
The reason code for the last update that was performed on the function.