Table of Contents
A low-level client representing AWS Lambda:
import boto3
client = boto3.client('lambda')
These are the available methods:
Adds permissions to the resource-based policy of a version of an AWS Lambda layer . Use this action to grant layer usage permission to other accounts. You can grant permission to a single account, all AWS accounts, or all accounts in an organization.
To revoke permission, call RemoveLayerVersionPermission with the statement ID that you specified when you added it.
See also: AWS API Documentation
Request Syntax
response = client.add_layer_version_permission(
LayerName='string',
VersionNumber=123,
StatementId='string',
Action='string',
Principal='string',
OrganizationId='string',
RevisionId='string'
)
[REQUIRED]
The name or Amazon Resource Name (ARN) of the layer.
[REQUIRED]
The version number.
[REQUIRED]
An identifier that distinguishes the policy from others on the same layer version.
[REQUIRED]
The API action that grants access to the layer. For example, lambda:GetLayerVersion .
[REQUIRED]
An account ID, or * to grant permission to all AWS accounts.
dict
Response Syntax
{
'Statement': 'string',
'RevisionId': 'string'
}
Response Structure
(dict) --
Statement (string) --
The permission statement.
RevisionId (string) --
A unique identifier for the current revision of the policy.
Grants an AWS service or another account permission to use a function. You can apply the policy at the function level, or specify a qualifier to restrict access to a single version or alias. If you use a qualifier, the invoker must use the full Amazon Resource Name (ARN) of that version or alias to invoke the function.
To grant permission to another account, specify the account ID as the Principal . For AWS services, the principal is a domain-style identifier defined by the service, like s3.amazonaws.com or sns.amazonaws.com . For AWS services, you can also specify the ARN or owning account of the associated resource as the SourceArn or SourceAccount . If you grant permission to a service principal without specifying the source, other accounts could potentially configure resources in their account to invoke your Lambda function.
This action adds a statement to a resource-based permissions policy for the function. For more information about function policies, see Lambda Function Policies .
See also: AWS API Documentation
Request Syntax
response = client.add_permission(
FunctionName='string',
StatementId='string',
Action='string',
Principal='string',
SourceArn='string',
SourceAccount='string',
EventSourceToken='string',
Qualifier='string',
RevisionId='string'
)
[REQUIRED]
The name of the Lambda function, version, or alias.
Name formats
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.
[REQUIRED]
A statement identifier that differentiates the statement from others in the same policy.
[REQUIRED]
The action that the principal can use on the function. For example, lambda:InvokeFunction or lambda:GetFunction .
[REQUIRED]
The AWS service or account that invokes the function. If you specify a service, use SourceArn or SourceAccount to limit who can invoke the function through that service.
dict
Response Syntax
{
'Statement': 'string'
}
Response Structure
(dict) --
Statement (string) --
The permission statement that's added to the function policy.
Examples
This example adds a permission for an S3 bucket to invoke a Lambda function.
response = client.add_permission(
Action='lambda:InvokeFunction',
FunctionName='MyFunction',
Principal='s3.amazonaws.com',
SourceAccount='123456789012',
SourceArn='arn:aws:s3:::examplebucket/*',
StatementId='ID-1',
)
print(response)
Expected Output:
{
'Statement': 'ID-1',
'ResponseMetadata': {
'...': '...',
},
}
Check if an operation can be paginated.
Creates an alias for a Lambda function version. Use aliases to provide clients with a function identifier that you can update to invoke a different version.
You can also map an alias to split invocation requests between two versions. Use the RoutingConfig parameter to specify a second version and the percentage of invocation requests that it receives.
See also: AWS API Documentation
Request Syntax
response = client.create_alias(
FunctionName='string',
Name='string',
FunctionVersion='string',
Description='string',
RoutingConfig={
'AdditionalVersionWeights': {
'string': 123.0
}
}
)
[REQUIRED]
The name of the Lambda function.
Name 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.
[REQUIRED]
The name of the alias.
[REQUIRED]
The function version that the alias invokes.
The routing configuration of the alias.
The name of the second alias, and the percentage of traffic that's routed to it.
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 alias .
AliasArn (string) --
The Amazon Resource Name (ARN) of the alias.
Name (string) --
The name of the alias.
FunctionVersion (string) --
The function version that the alias invokes.
Description (string) --
A description of the alias.
RoutingConfig (dict) --
The routing configuration of the alias.
AdditionalVersionWeights (dict) --
The name of the second alias, and the percentage of traffic that's routed to it.
RevisionId (string) --
A unique identifier that changes when you update the alias.
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):
See also: AWS API Documentation
Request Syntax
response = 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
)
[REQUIRED]
The Amazon Resource Name (ARN) of the event source.
[REQUIRED]
The name of the Lambda function.
Name formats
The length constraint applies only to the full ARN. If you specify only the function name, it's limited to 64 characters in length.
The maximum number of items to retrieve in a single batch.
(Streams) An Amazon SQS queue or Amazon SNS topic destination for discarded records.
The destination configuration for successful invocations.
The Amazon Resource Name (ARN) of the destination resource.
The destination configuration for failed invocations.
The Amazon Resource Name (ARN) of the destination resource.
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.
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
response = 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'|'ruby2.7'|'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',
]
)
[REQUIRED]
The name of the Lambda function.
Name 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.
[REQUIRED]
The identifier of the function's runtime .
[REQUIRED]
The Amazon Resource Name (ARN) of the function's execution role.
[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 .
[REQUIRED]
The code for the function.
The base64-encoded contents of the deployment package. AWS SDK and AWS CLI clients handle the encoding for you.
An Amazon S3 bucket in the same AWS Region as your function. The bucket can be in a different AWS account.
The Amazon S3 key of the deployment package.
For versioned objects, the version of the deployment package object to use.
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 .
A list of VPC subnet IDs.
A list of VPC security groups IDs.
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 .
The Amazon Resource Name (ARN) of an Amazon SQS queue or Amazon SNS topic.
Environment variables that are accessible from function code during execution.
Environment variable key-value pairs.
Set Mode to Active to sample and trace a subset of incoming requests with AWS X-Ray.
The tracing mode.
A list of tags to apply to the function.
A list of function layers to add to the function's execution environment. Specify each layer by its ARN, including the version.
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'|'ruby2.7'|'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'|'InvalidSubnet'|'InvalidSecurityGroup',
'LastUpdateStatus': 'Successful'|'Failed'|'InProgress',
'LastUpdateStatusReason': 'string',
'LastUpdateStatusReasonCode': 'EniLimitExceeded'|'InsufficientRolePermissions'|'InvalidConfiguration'|'InternalError'|'SubnetOutOfIPAddresses'|'InvalidSubnet'|'InvalidSecurityGroup'
}
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.
SecurityGroupIds (list) --
A list of VPC security groups IDs.
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.
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. This is first set to Successful after function creation completes.
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.
Examples
This example creates a Lambda function.
response = client.create_function(
Code={
},
Description='',
FunctionName='MyFunction',
# is of the form of the name of your source file and then name of your function handler
Handler='souce_file.handler_name',
MemorySize=128,
Publish=True,
# replace with the actual arn of the execution role you created
Role='arn:aws:iam::123456789012:role/service-role/role-name',
Runtime='nodejs4.3',
Timeout=15,
VpcConfig={
},
)
print(response)
Expected Output:
{
'CodeSha256': '',
'CodeSize': 123,
'Description': '',
'FunctionArn': 'arn:aws:lambda:us-west-2:123456789012:function:MyFunction',
'FunctionName': 'MyFunction',
'Handler': 'source_file.handler_name',
'LastModified': '2016-11-21T19:49:20.006+0000',
'MemorySize': 128,
'Role': 'arn:aws:iam::123456789012:role/service-role/role-name',
'Runtime': 'nodejs4.3',
'Timeout': 123,
'Version': '1',
'VpcConfig': {
},
'ResponseMetadata': {
'...': '...',
},
}
Deletes a Lambda function alias .
See also: AWS API Documentation
Request Syntax
response = client.delete_alias(
FunctionName='string',
Name='string'
)
[REQUIRED]
The name of the Lambda function.
Name 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.
[REQUIRED]
The name of the alias.
None
Examples
This operation deletes a Lambda function alias
response = client.delete_alias(
FunctionName='myFunction',
Name='alias',
)
print(response)
Expected Output:
{
'ResponseMetadata': {
'...': '...',
},
}
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
response = client.delete_event_source_mapping(
UUID='string'
)
[REQUIRED]
The identifier of the event source mapping.
{
'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
A mapping between an AWS resource and an AWS Lambda function. See CreateEventSourceMapping for details.
The identifier of the event source mapping.
The maximum number of items to retrieve in a single batch.
The maximum amount of time to gather records before invoking the function, in seconds.
(Streams) The number of batches to process from each shard concurrently.
The Amazon Resource Name (ARN) of the event source.
The ARN of the Lambda function.
The date that the event source mapping was last updated, or its state changed.
The result of the last AWS Lambda invocation of your Lambda function.
The state of the event source mapping. It can be one of the following: Creating , Enabling , Enabled , Disabling , Disabled , Updating , or Deleting .
Indicates whether the last change to the event source mapping was made by a user, or by the Lambda service.
(Streams) An Amazon SQS queue or Amazon SNS topic destination for discarded records.
The destination configuration for successful invocations.
The Amazon Resource Name (ARN) of the destination resource.
The destination configuration for failed invocations.
The Amazon Resource Name (ARN) of the destination resource.
(Streams) The maximum age of a record that Lambda sends to a function for processing.
(Streams) If the function returns an error, split the batch in two and retry.
(Streams) The maximum number of times to retry when the function returns an error.
Examples
This operation deletes a Lambda function event source mapping
response = client.delete_event_source_mapping(
UUID='12345kxodurf3443',
)
print(response)
Expected Output:
{
'BatchSize': 123,
'EventSourceArn': 'arn:aws:s3:::examplebucket/*',
'FunctionArn': 'arn:aws:lambda:us-west-2:123456789012:function:myFunction',
'LastModified': datetime(2016, 11, 21, 19, 49, 20, 0, 326, 0),
'LastProcessingResult': '',
'State': '',
'StateTransitionReason': '',
'UUID': '12345kxodurf3443',
'ResponseMetadata': {
'...': '...',
},
}
Deletes a Lambda function. To delete a specific function version, use the Qualifier parameter. Otherwise, all versions and aliases are deleted.
To delete Lambda event source mappings that invoke a function, use DeleteEventSourceMapping . For AWS services and resources that invoke your function directly, delete the trigger in the service where you originally configured it.
See also: AWS API Documentation
Request Syntax
response = client.delete_function(
FunctionName='string',
Qualifier='string'
)
[REQUIRED]
The name of the Lambda function or version.
Name formats
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.
None
Examples
This operation deletes a Lambda function
response = client.delete_function(
FunctionName='myFunction',
Qualifier='1',
)
print(response)
Expected Output:
{
'ResponseMetadata': {
'...': '...',
},
}
Removes a concurrent execution limit from a function.
See also: AWS API Documentation
Request Syntax
response = client.delete_function_concurrency(
FunctionName='string'
)
[REQUIRED]
The name of the Lambda function.
Name 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.
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
response = client.delete_function_event_invoke_config(
FunctionName='string',
Qualifier='string'
)
[REQUIRED]
The name of the Lambda function, version, or alias.
Name formats
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.
None
Deletes a version of an AWS Lambda layer . Deleted versions can no longer be viewed or added to functions. To avoid breaking functions, a copy of the version remains in Lambda until no functions refer to it.
See also: AWS API Documentation
Request Syntax
response = client.delete_layer_version(
LayerName='string',
VersionNumber=123
)
[REQUIRED]
The name or Amazon Resource Name (ARN) of the layer.
[REQUIRED]
The version number.
None
Deletes the provisioned concurrency configuration for a function.
See also: AWS API Documentation
Request Syntax
response = client.delete_provisioned_concurrency_config(
FunctionName='string',
Qualifier='string'
)
[REQUIRED]
The name of the Lambda function.
Name 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.
[REQUIRED]
The version number or alias name.
None
Generate a presigned url given a client, its method, and arguments
The presigned url
Retrieves details about your account's limits and usage in an AWS Region.
See also: AWS API Documentation
Request Syntax
response = client.get_account_settings()
{
'AccountLimit': {
'TotalCodeSize': 123,
'CodeSizeUnzipped': 123,
'CodeSizeZipped': 123,
'ConcurrentExecutions': 123,
'UnreservedConcurrentExecutions': 123
},
'AccountUsage': {
'TotalCodeSize': 123,
'FunctionCount': 123
}
}
Response Structure
Limits that are related to concurrency and code storage.
The amount of storage space that you can use for all deployment packages and layer archives.
The maximum size of a function's deployment package and layers when they're extracted.
The maximum size of a deployment package when it's uploaded directly to AWS Lambda. Use Amazon S3 for larger files.
The maximum number of simultaneous function executions.
The maximum number of simultaneous function executions, minus the capacity that's reserved for individual functions with PutFunctionConcurrency .
The number of functions and amount of storage in use.
The amount of storage space, in bytes, that's being used by deployment packages and layer archives.
The number of Lambda functions.
Examples
This operation retrieves a Lambda customer's account settings
response = client.get_account_settings(
)
print(response)
Expected Output:
{
'AccountLimit': {
},
'AccountUsage': {
},
'ResponseMetadata': {
'...': '...',
},
}
Returns details about a Lambda function alias .
See also: AWS API Documentation
Request Syntax
response = client.get_alias(
FunctionName='string',
Name='string'
)
[REQUIRED]
The name of the Lambda function.
Name 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.
[REQUIRED]
The name of the alias.
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 alias .
AliasArn (string) --
The Amazon Resource Name (ARN) of the alias.
Name (string) --
The name of the alias.
FunctionVersion (string) --
The function version that the alias invokes.
Description (string) --
A description of the alias.
RoutingConfig (dict) --
The routing configuration of the alias.
AdditionalVersionWeights (dict) --
The name of the second alias, and the percentage of traffic that's routed to it.
RevisionId (string) --
A unique identifier that changes when you update the alias.
Examples
This operation retrieves a Lambda function alias
response = client.get_alias(
FunctionName='myFunction',
Name='myFunctionAlias',
)
print(response)
Expected Output:
{
'AliasArn': 'arn:aws:lambda:us-west-2:123456789012:function:myFunctionAlias',
'Description': '',
'FunctionVersion': '1',
'Name': 'myFunctionAlias',
'ResponseMetadata': {
'...': '...',
},
}
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
response = client.get_event_source_mapping(
UUID='string'
)
[REQUIRED]
The identifier of the event source mapping.
{
'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
A mapping between an AWS resource and an AWS Lambda function. See CreateEventSourceMapping for details.
The identifier of the event source mapping.
The maximum number of items to retrieve in a single batch.
The maximum amount of time to gather records before invoking the function, in seconds.
(Streams) The number of batches to process from each shard concurrently.
The Amazon Resource Name (ARN) of the event source.
The ARN of the Lambda function.
The date that the event source mapping was last updated, or its state changed.
The result of the last AWS Lambda invocation of your Lambda function.
The state of the event source mapping. It can be one of the following: Creating , Enabling , Enabled , Disabling , Disabled , Updating , or Deleting .
Indicates whether the last change to the event source mapping was made by a user, or by the Lambda service.
(Streams) An Amazon SQS queue or Amazon SNS topic destination for discarded records.
The destination configuration for successful invocations.
The Amazon Resource Name (ARN) of the destination resource.
The destination configuration for failed invocations.
The Amazon Resource Name (ARN) of the destination resource.
(Streams) The maximum age of a record that Lambda sends to a function for processing.
(Streams) If the function returns an error, split the batch in two and retry.
(Streams) The maximum number of times to retry when the function returns an error.
Examples
This operation retrieves a Lambda function's event source mapping
response = client.get_event_source_mapping(
UUID='123489-xxxxx-kdla8d89d7',
)
print(response)
Expected Output:
{
'BatchSize': 123,
'EventSourceArn': 'arn:aws:iam::123456789012:eventsource',
'FunctionArn': 'arn:aws:lambda:us-west-2:123456789012:function:myFunction',
'LastModified': datetime(2016, 11, 21, 19, 49, 20, 0, 326, 0),
'LastProcessingResult': '',
'State': '',
'StateTransitionReason': '',
'UUID': '123489-xxxxx-kdla8d89d7',
'ResponseMetadata': {
'...': '...',
},
}
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
response = client.get_function(
FunctionName='string',
Qualifier='string'
)
[REQUIRED]
The name of the Lambda function, version, or alias.
Name formats
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.
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'|'ruby2.7'|'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'|'InvalidSubnet'|'InvalidSecurityGroup',
'LastUpdateStatus': 'Successful'|'Failed'|'InProgress',
'LastUpdateStatusReason': 'string',
'LastUpdateStatusReasonCode': 'EniLimitExceeded'|'InsufficientRolePermissions'|'InvalidConfiguration'|'InternalError'|'SubnetOutOfIPAddresses'|'InvalidSubnet'|'InvalidSecurityGroup'
},
'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.
SecurityGroupIds (list) --
A list of VPC security groups IDs.
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.
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. This is first set to Successful after function creation completes.
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 .
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 .
Examples
This operation retrieves a Lambda function's event source mapping
response = client.get_function(
FunctionName='myFunction',
Qualifier='1',
)
print(response)
Expected Output:
{
'Code': {
'Location': 'somelocation',
'RepositoryType': 'S3',
},
'Configuration': {
'CodeSha256': 'LQT+0DHxxxxcfwLyQjzoEFKZtdqQjHXanlSdfXBlEW0VA=',
'CodeSize': 262,
'Description': 'A starter AWS Lambda function.',
'Environment': {
'Variables': {
'S3_BUCKET': 'test',
},
},
'FunctionArn': 'arn:aws:lambda:us-west-2:123456789012:function:myFunction',
'FunctionName': 'myFunction',
'Handler': 'index.handler',
'LastModified': '2016-11-21T19:49:20.006+0000',
'MemorySize': 128,
'Role': 'arn:aws:iam::123456789012:role/lambda_basic_execution',
'Runtime': 'nodejs4.3',
'Timeout': 3,
'Version': '$LATEST',
'VpcConfig': {
'SecurityGroupIds': [
],
'SubnetIds': [
],
},
},
'ResponseMetadata': {
'...': '...',
},
}
Returns details about the reserved concurrency configuration for a function. To set a concurrency limit for a function, use PutFunctionConcurrency .
See also: AWS API Documentation
Request Syntax
response = client.get_function_concurrency(
FunctionName='string'
)
[REQUIRED]
The name of the Lambda function.
Name 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.
{
'ReservedConcurrentExecutions': 123
}
Response Structure
The number of simultaneous executions that are reserved for the function.
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
response = client.get_function_configuration(
FunctionName='string',
Qualifier='string'
)
[REQUIRED]
The name of the Lambda function, version, or alias.
Name formats
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.
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'|'ruby2.7'|'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'|'InvalidSubnet'|'InvalidSecurityGroup',
'LastUpdateStatus': 'Successful'|'Failed'|'InProgress',
'LastUpdateStatusReason': 'string',
'LastUpdateStatusReasonCode': 'EniLimitExceeded'|'InsufficientRolePermissions'|'InvalidConfiguration'|'InternalError'|'SubnetOutOfIPAddresses'|'InvalidSubnet'|'InvalidSecurityGroup'
}
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.
SecurityGroupIds (list) --
A list of VPC security groups IDs.
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.
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. This is first set to Successful after function creation completes.
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.
Examples
This operation retrieves a Lambda function's event source mapping
response = client.get_function_configuration(
FunctionName='myFunction',
Qualifier='1',
)
print(response)
Expected Output:
{
'CodeSha256': 'LQT+0DHxxxxcfwLyQjzoEFKZtdqQjHXanlSdfXBlEW0VA=',
'CodeSize': 123,
'DeadLetterConfig': {
},
'Description': '',
'Environment': {
},
'FunctionArn': 'arn:aws:lambda:us-west-2:123456789012:function:myFunction',
'FunctionName': 'myFunction',
'Handler': 'index.handler',
'KMSKeyArn': '',
'LastModified': '2016-11-21T19:49:20.006+0000',
'MemorySize': 128,
'Role': 'arn:aws:iam::123456789012:role/lambda_basic_execution',
'Runtime': 'python2.7',
'Timeout': 123,
'Version': '1',
'VpcConfig': {
},
'ResponseMetadata': {
'...': '...',
},
}
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
response = client.get_function_event_invoke_config(
FunctionName='string',
Qualifier='string'
)
[REQUIRED]
The name of the Lambda function, version, or alias.
Name formats
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.
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
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.
Returns information about a version of an AWS Lambda layer , with a link to download the layer archive that's valid for 10 minutes.
See also: AWS API Documentation
Request Syntax
response = client.get_layer_version(
LayerName='string',
VersionNumber=123
)
[REQUIRED]
The name or Amazon Resource Name (ARN) of the layer.
[REQUIRED]
The version number.
dict
Response Syntax
{
'Content': {
'Location': 'string',
'CodeSha256': 'string',
'CodeSize': 123
},
'LayerArn': 'string',
'LayerVersionArn': 'string',
'Description': 'string',
'CreatedDate': 'string',
'Version': 123,
'CompatibleRuntimes': [
'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'|'ruby2.7'|'provided',
],
'LicenseInfo': 'string'
}
Response Structure
(dict) --
Content (dict) --
Details about the layer version.
Location (string) --
A link to the layer archive in Amazon S3 that is valid for 10 minutes.
CodeSha256 (string) --
The SHA-256 hash of the layer archive.
CodeSize (integer) --
The size of the layer archive in bytes.
LayerArn (string) --
The ARN of the layer.
LayerVersionArn (string) --
The ARN of the layer version.
Description (string) --
The description of the version.
CreatedDate (string) --
The date that the layer version was created, in ISO-8601 format (YYYY-MM-DDThh:mm:ss.sTZD).
Version (integer) --
The version number.
CompatibleRuntimes (list) --
The layer's compatible runtimes.
LicenseInfo (string) --
The layer's software license.
Returns information about a version of an AWS Lambda layer , with a link to download the layer archive that's valid for 10 minutes.
See also: AWS API Documentation
Request Syntax
response = client.get_layer_version_by_arn(
Arn='string'
)
[REQUIRED]
The ARN of the layer version.
{
'Content': {
'Location': 'string',
'CodeSha256': 'string',
'CodeSize': 123
},
'LayerArn': 'string',
'LayerVersionArn': 'string',
'Description': 'string',
'CreatedDate': 'string',
'Version': 123,
'CompatibleRuntimes': [
'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'|'ruby2.7'|'provided',
],
'LicenseInfo': 'string'
}
Response Structure
Details about the layer version.
A link to the layer archive in Amazon S3 that is valid for 10 minutes.
The SHA-256 hash of the layer archive.
The size of the layer archive in bytes.
The ARN of the layer.
The ARN of the layer version.
The description of the version.
The date that the layer version was created, in ISO-8601 format (YYYY-MM-DDThh:mm:ss.sTZD).
The version number.
The layer's compatible runtimes.
The layer's software license.
Returns the permission policy for a version of an AWS Lambda layer . For more information, see AddLayerVersionPermission .
See also: AWS API Documentation
Request Syntax
response = client.get_layer_version_policy(
LayerName='string',
VersionNumber=123
)
[REQUIRED]
The name or Amazon Resource Name (ARN) of the layer.
[REQUIRED]
The version number.
dict
Response Syntax
{
'Policy': 'string',
'RevisionId': 'string'
}
Response Structure
(dict) --
Policy (string) --
The policy document.
RevisionId (string) --
A unique identifier for the current revision of the policy.
Create a paginator for an operation.
Returns the resource-based IAM policy for a function, version, or alias.
See also: AWS API Documentation
Request Syntax
response = client.get_policy(
FunctionName='string',
Qualifier='string'
)
[REQUIRED]
The name of the Lambda function, version, or alias.
Name formats
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.
dict
Response Syntax
{
'Policy': 'string',
'RevisionId': 'string'
}
Response Structure
(dict) --
Policy (string) --
The resource-based policy.
RevisionId (string) --
A unique identifier for the current revision of the policy.
Examples
This operation retrieves a Lambda function policy
response = client.get_policy(
FunctionName='myFunction',
Qualifier='1',
)
print(response)
Expected Output:
{
'Policy': '',
'ResponseMetadata': {
'...': '...',
},
}
Retrieves the provisioned concurrency configuration for a function's alias or version.
See also: AWS API Documentation
Request Syntax
response = client.get_provisioned_concurrency_config(
FunctionName='string',
Qualifier='string'
)
[REQUIRED]
The name of the Lambda function.
Name 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.
[REQUIRED]
The version number or alias name.
dict
Response Syntax
{
'RequestedProvisionedConcurrentExecutions': 123,
'AvailableProvisionedConcurrentExecutions': 123,
'AllocatedProvisionedConcurrentExecutions': 123,
'Status': 'IN_PROGRESS'|'READY'|'FAILED',
'StatusReason': 'string',
'LastModified': 'string'
}
Response Structure
(dict) --
RequestedProvisionedConcurrentExecutions (integer) --
The amount of provisioned concurrency requested.
AvailableProvisionedConcurrentExecutions (integer) --
The amount of provisioned concurrency available.
AllocatedProvisionedConcurrentExecutions (integer) --
The amount of provisioned concurrency allocated.
Status (string) --
The status of the allocation process.
StatusReason (string) --
For failed allocations, the reason that provisioned concurrency could not be allocated.
LastModified (string) --
The date and time that a user last updated the configuration, in ISO 8601 format .
Returns an object that can wait for some condition.
Invokes a Lambda function. You can invoke a function synchronously (and wait for the response), or asynchronously. To invoke a function asynchronously, set InvocationType to Event .
For synchronous invocation , details about the function response, including errors, are included in the response body and headers. For either invocation type, you can find more information in the execution log and trace .
When an error occurs, your function may be invoked multiple times. Retry behavior varies by error type, client, event source, and invocation type. For example, if you invoke a function asynchronously and it returns an error, Lambda executes the function up to two more times. For more information, see Retry Behavior .
For asynchronous invocation , Lambda adds events to a queue before sending them to your function. If your function does not have enough capacity to keep up with the queue, events may be lost. Occasionally, your function may receive the same event multiple times, even if no error occurs. To retain events that were not processed, configure your function with a dead-letter queue .
The status code in the API response doesn't reflect function errors. Error codes are reserved for errors that prevent your function from executing, such as permissions errors, limit errors , or issues with your function's code and configuration. For example, Lambda returns TooManyRequestsException if executing the function would cause you to exceed a concurrency limit at either the account level (ConcurrentInvocationLimitExceeded ) or function level (ReservedFunctionConcurrentInvocationLimitExceeded ).
For functions with a long timeout, your client might be disconnected during synchronous invocation while it waits for a response. Configure your HTTP client, SDK, firewall, proxy, or operating system to allow for long connections with timeout or keep-alive settings.
This operation requires permission for the lambda:InvokeFunction action.
See also: AWS API Documentation
Request Syntax
response = client.invoke(
FunctionName='string',
InvocationType='Event'|'RequestResponse'|'DryRun',
LogType='None'|'Tail',
ClientContext='string',
Payload=b'bytes'|file,
Qualifier='string'
)
[REQUIRED]
The name of the Lambda function, version, or alias.
Name formats
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.
Choose from the following options.
dict
Response Syntax
{
'StatusCode': 123,
'FunctionError': 'string',
'LogResult': 'string',
'Payload': StreamingBody(),
'ExecutedVersion': 'string'
}
Response Structure
(dict) --
StatusCode (integer) --
The HTTP status code is in the 200 range for a successful request. For the RequestResponse invocation type, this status code is 200. For the Event invocation type, this status code is 202. For the DryRun invocation type, the status code is 204.
FunctionError (string) --
If present, indicates that an error occurred during function execution. Details about the error are included in the response payload.
LogResult (string) --
The last 4 KB of the execution log, which is base64 encoded.
Payload (StreamingBody) --
The response from the function, or an error object.
ExecutedVersion (string) --
The version of the function that executed. When you invoke a function with an alias, this indicates which version the alias resolved to.
Examples
This operation invokes a Lambda function
response = client.invoke(
ClientContext='MyApp',
FunctionName='MyFunction',
InvocationType='Event',
LogType='Tail',
Payload='fileb://file-path/input.json',
Qualifier='1',
)
print(response)
Expected Output:
{
'FunctionError': '',
'LogResult': '',
'Payload': '?',
'StatusCode': 123,
'ResponseMetadata': {
'...': '...',
},
}
Warning
For asynchronous function invocation, use Invoke .
Invokes a function asynchronously.
Danger
This operation is deprecated and may not function as expected. This operation should not be used going forward and is only kept for the purpose of backwards compatiblity.
See also: AWS API Documentation
Request Syntax
response = client.invoke_async(
FunctionName='string',
InvokeArgs=b'bytes'|file
)
[REQUIRED]
The name of the Lambda function.
Name 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.
[REQUIRED]
The JSON that you want to provide to your Lambda function as input.
dict
Response Syntax
{
'Status': 123
}
Response Structure
(dict) --
A success response (202 Accepted ) indicates that the request is queued for invocation.
Status (integer) --
The status code.
Examples
This operation invokes a Lambda function asynchronously
response = client.invoke_async(
FunctionName='myFunction',
InvokeArgs='fileb://file-path/input.json',
)
print(response)
Expected Output:
{
'Status': 123,
'ResponseMetadata': {
'...': '...',
},
}
Returns a list of aliases for a Lambda function.
See also: AWS API Documentation
Request Syntax
response = client.list_aliases(
FunctionName='string',
FunctionVersion='string',
Marker='string',
MaxItems=123
)
[REQUIRED]
The name of the Lambda function.
Name 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.
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) --
The pagination token that's included if more results are available.
Aliases (list) --
A list of aliases.
(dict) --
Provides configuration information about a Lambda function alias .
AliasArn (string) --
The Amazon Resource Name (ARN) of the alias.
Name (string) --
The name of the alias.
FunctionVersion (string) --
The function version that the alias invokes.
Description (string) --
A description of the alias.
RoutingConfig (dict) --
The routing configuration of the alias.
AdditionalVersionWeights (dict) --
The name of the second alias, and the percentage of traffic that's routed to it.
RevisionId (string) --
A unique identifier that changes when you update the alias.
Examples
This operation retrieves a Lambda function's aliases
response = client.list_aliases(
FunctionName='myFunction',
FunctionVersion='1',
Marker='',
MaxItems=123,
)
print(response)
Expected Output:
{
'Aliases': [
],
'NextMarker': '',
'ResponseMetadata': {
'...': '...',
},
}
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
response = client.list_event_source_mappings(
EventSourceArn='string',
FunctionName='string',
Marker='string',
MaxItems=123
)
The Amazon Resource Name (ARN) of the event source.
The name of the Lambda function.
Name formats
The length constraint applies only to the full ARN. If you specify only the function name, it's limited to 64 characters in length.
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.
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
response = client.list_function_event_invoke_configs(
FunctionName='string',
Marker='string',
MaxItems=123
)
[REQUIRED]
The name of the Lambda function.
Name 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.
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
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.
Returns a list of Lambda functions, with the version-specific configuration of each. Lambda returns up to 50 functions per call.
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
response = client.list_functions(
MasterRegion='string',
FunctionVersion='ALL',
Marker='string',
MaxItems=123
)
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'|'ruby2.7'|'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'|'InvalidSubnet'|'InvalidSecurityGroup',
'LastUpdateStatus': 'Successful'|'Failed'|'InProgress',
'LastUpdateStatusReason': 'string',
'LastUpdateStatusReasonCode': 'EniLimitExceeded'|'InsufficientRolePermissions'|'InvalidConfiguration'|'InternalError'|'SubnetOutOfIPAddresses'|'InvalidSubnet'|'InvalidSecurityGroup'
},
]
}
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.
SecurityGroupIds (list) --
A list of VPC security groups IDs.
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.
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. This is first set to Successful after function creation completes.
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.
Examples
This operation retrieves a Lambda functions
response = client.list_functions(
Marker='',
MaxItems=123,
)
print(response)
Expected Output:
{
'Functions': [
],
'NextMarker': '',
'ResponseMetadata': {
'...': '...',
},
}
Lists the versions of an AWS Lambda layer . Versions that have been deleted aren't listed. Specify a runtime identifier to list only versions that indicate that they're compatible with that runtime.
See also: AWS API Documentation
Request Syntax
response = client.list_layer_versions(
CompatibleRuntime='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'|'ruby2.7'|'provided',
LayerName='string',
Marker='string',
MaxItems=123
)
[REQUIRED]
The name or Amazon Resource Name (ARN) of the layer.
dict
Response Syntax
{
'NextMarker': 'string',
'LayerVersions': [
{
'LayerVersionArn': 'string',
'Version': 123,
'Description': 'string',
'CreatedDate': 'string',
'CompatibleRuntimes': [
'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'|'ruby2.7'|'provided',
],
'LicenseInfo': 'string'
},
]
}
Response Structure
(dict) --
NextMarker (string) --
A pagination token returned when the response doesn't contain all versions.
LayerVersions (list) --
A list of versions.
(dict) --
Details about a version of an AWS Lambda layer .
LayerVersionArn (string) --
The ARN of the layer version.
Version (integer) --
The version number.
Description (string) --
The description of the version.
CreatedDate (string) --
The date that the version was created, in ISO 8601 format. For example, 2018-11-27T15:10:45.123+0000 .
CompatibleRuntimes (list) --
The layer's compatible runtimes.
LicenseInfo (string) --
The layer's open-source license.
Lists AWS Lambda layers and shows information about the latest version of each. Specify a runtime identifier to list only layers that indicate that they're compatible with that runtime.
See also: AWS API Documentation
Request Syntax
response = client.list_layers(
CompatibleRuntime='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'|'ruby2.7'|'provided',
Marker='string',
MaxItems=123
)
dict
Response Syntax
{
'NextMarker': 'string',
'Layers': [
{
'LayerName': 'string',
'LayerArn': 'string',
'LatestMatchingVersion': {
'LayerVersionArn': 'string',
'Version': 123,
'Description': 'string',
'CreatedDate': 'string',
'CompatibleRuntimes': [
'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'|'ruby2.7'|'provided',
],
'LicenseInfo': 'string'
}
},
]
}
Response Structure
(dict) --
NextMarker (string) --
A pagination token returned when the response doesn't contain all layers.
Layers (list) --
A list of function layers.
(dict) --
Details about an AWS Lambda layer .
LayerName (string) --
The name of the layer.
LayerArn (string) --
The Amazon Resource Name (ARN) of the function layer.
LatestMatchingVersion (dict) --
The newest version of the layer.
LayerVersionArn (string) --
The ARN of the layer version.
Version (integer) --
The version number.
Description (string) --
The description of the version.
CreatedDate (string) --
The date that the version was created, in ISO 8601 format. For example, 2018-11-27T15:10:45.123+0000 .
CompatibleRuntimes (list) --
The layer's compatible runtimes.
LicenseInfo (string) --
The layer's open-source license.
Retrieves a list of provisioned concurrency configurations for a function.
See also: AWS API Documentation
Request Syntax
response = client.list_provisioned_concurrency_configs(
FunctionName='string',
Marker='string',
MaxItems=123
)
[REQUIRED]
The name of the Lambda function.
Name 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.
dict
Response Syntax
{
'ProvisionedConcurrencyConfigs': [
{
'FunctionArn': 'string',
'RequestedProvisionedConcurrentExecutions': 123,
'AvailableProvisionedConcurrentExecutions': 123,
'AllocatedProvisionedConcurrentExecutions': 123,
'Status': 'IN_PROGRESS'|'READY'|'FAILED',
'StatusReason': 'string',
'LastModified': 'string'
},
],
'NextMarker': 'string'
}
Response Structure
(dict) --
ProvisionedConcurrencyConfigs (list) --
A list of provisioned concurrency configurations.
(dict) --
Details about the provisioned concurrency configuration for a function alias or version.
FunctionArn (string) --
The Amazon Resource Name (ARN) of the alias or version.
RequestedProvisionedConcurrentExecutions (integer) --
The amount of provisioned concurrency requested.
AvailableProvisionedConcurrentExecutions (integer) --
The amount of provisioned concurrency available.
AllocatedProvisionedConcurrentExecutions (integer) --
The amount of provisioned concurrency allocated.
Status (string) --
The status of the allocation process.
StatusReason (string) --
For failed allocations, the reason that provisioned concurrency could not be allocated.
LastModified (string) --
The date and time that a user last updated the configuration, in ISO 8601 format .
NextMarker (string) --
The pagination token that's included if more results are available.
Returns a function's tags . You can also view tags with GetFunction .
See also: AWS API Documentation
Request Syntax
response = client.list_tags(
Resource='string'
)
[REQUIRED]
The function's Amazon Resource Name (ARN).
{
'Tags': {
'string': 'string'
}
}
Response Structure
The function's tags.
Returns a list of versions , with the version-specific configuration of each. Lambda returns up to 50 versions per call.
See also: AWS API Documentation
Request Syntax
response = client.list_versions_by_function(
FunctionName='string',
Marker='string',
MaxItems=123
)
[REQUIRED]
The name of the Lambda function.
Name 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.
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'|'ruby2.7'|'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'|'InvalidSubnet'|'InvalidSecurityGroup',
'LastUpdateStatus': 'Successful'|'Failed'|'InProgress',
'LastUpdateStatusReason': 'string',
'LastUpdateStatusReasonCode': 'EniLimitExceeded'|'InsufficientRolePermissions'|'InvalidConfiguration'|'InternalError'|'SubnetOutOfIPAddresses'|'InvalidSubnet'|'InvalidSecurityGroup'
},
]
}
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.
SecurityGroupIds (list) --
A list of VPC security groups IDs.
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.
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. This is first set to Successful after function creation completes.
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.
Examples
This operation retrieves a Lambda function versions
response = client.list_versions_by_function(
FunctionName='myFunction',
Marker='',
MaxItems=123,
)
print(response)
Expected Output:
{
'NextMarker': '',
'Versions': [
],
'ResponseMetadata': {
'...': '...',
},
}
Creates an AWS Lambda layer from a ZIP archive. Each time you call PublishLayerVersion with the same layer name, a new version is created.
Add layers to your function with CreateFunction or UpdateFunctionConfiguration .
See also: AWS API Documentation
Request Syntax
response = client.publish_layer_version(
LayerName='string',
Description='string',
Content={
'S3Bucket': 'string',
'S3Key': 'string',
'S3ObjectVersion': 'string',
'ZipFile': b'bytes'
},
CompatibleRuntimes=[
'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'|'ruby2.7'|'provided',
],
LicenseInfo='string'
)
[REQUIRED]
The name or Amazon Resource Name (ARN) of the layer.
[REQUIRED]
The function layer archive.
The Amazon S3 bucket of the layer archive.
The Amazon S3 key of the layer archive.
For versioned objects, the version of the layer archive object to use.
The base64-encoded contents of the layer archive. AWS SDK and AWS CLI clients handle the encoding for you.
A list of compatible function runtimes . Used for filtering with ListLayers and ListLayerVersions .
The layer's software license. It can be any of the following:
dict
Response Syntax
{
'Content': {
'Location': 'string',
'CodeSha256': 'string',
'CodeSize': 123
},
'LayerArn': 'string',
'LayerVersionArn': 'string',
'Description': 'string',
'CreatedDate': 'string',
'Version': 123,
'CompatibleRuntimes': [
'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'|'ruby2.7'|'provided',
],
'LicenseInfo': 'string'
}
Response Structure
(dict) --
Content (dict) --
Details about the layer version.
Location (string) --
A link to the layer archive in Amazon S3 that is valid for 10 minutes.
CodeSha256 (string) --
The SHA-256 hash of the layer archive.
CodeSize (integer) --
The size of the layer archive in bytes.
LayerArn (string) --
The ARN of the layer.
LayerVersionArn (string) --
The ARN of the layer version.
Description (string) --
The description of the version.
CreatedDate (string) --
The date that the layer version was created, in ISO-8601 format (YYYY-MM-DDThh:mm:ss.sTZD).
Version (integer) --
The version number.
CompatibleRuntimes (list) --
The layer's compatible runtimes.
LicenseInfo (string) --
The layer's software license.
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
response = client.publish_version(
FunctionName='string',
CodeSha256='string',
Description='string',
RevisionId='string'
)
[REQUIRED]
The name of the Lambda function.
Name 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.
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'|'ruby2.7'|'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'|'InvalidSubnet'|'InvalidSecurityGroup',
'LastUpdateStatus': 'Successful'|'Failed'|'InProgress',
'LastUpdateStatusReason': 'string',
'LastUpdateStatusReasonCode': 'EniLimitExceeded'|'InsufficientRolePermissions'|'InvalidConfiguration'|'InternalError'|'SubnetOutOfIPAddresses'|'InvalidSubnet'|'InvalidSecurityGroup'
}
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.
SecurityGroupIds (list) --
A list of VPC security groups IDs.
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.
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. This is first set to Successful after function creation completes.
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.
Examples
This operation publishes a version of a Lambda function
response = client.publish_version(
CodeSha256='',
Description='',
FunctionName='myFunction',
)
print(response)
Expected Output:
{
'CodeSha256': '',
'CodeSize': 123,
'Description': '',
'FunctionArn': 'arn:aws:lambda:us-west-2:123456789012:function:myFunction:1',
'FunctionName': 'myFunction',
'Handler': 'index.handler',
'LastModified': '2016-11-21T19:49:20.006+0000',
'MemorySize': 128,
'Role': 'arn:aws:iam::123456789012:role/lambda_basic_execution',
'Runtime': 'python2.7',
'Timeout': 123,
'Version': '1',
'VpcConfig': {
},
'ResponseMetadata': {
'...': '...',
},
}
Sets the maximum number of simultaneous executions for a function, and reserves capacity for that concurrency level.
Concurrency settings apply to the function as a whole, including all published versions and the unpublished version. Reserving concurrency both ensures that your function has capacity to process the specified number of events simultaneously, and prevents it from scaling beyond that level. Use GetFunction to see the current setting for a function.
Use GetAccountSettings to see your Regional concurrency limit. You can reserve concurrency for as many functions as you like, as long as you leave at least 100 simultaneous executions unreserved for functions that aren't configured with a per-function limit. For more information, see Managing Concurrency .
See also: AWS API Documentation
Request Syntax
response = client.put_function_concurrency(
FunctionName='string',
ReservedConcurrentExecutions=123
)
[REQUIRED]
The name of the Lambda function.
Name 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.
[REQUIRED]
The number of simultaneous executions to reserve for the function.
dict
Response Syntax
{
'ReservedConcurrentExecutions': 123
}
Response Structure
(dict) --
ReservedConcurrentExecutions (integer) --
The number of concurrent executions that are reserved for this function. For more information, see Managing Concurrency .
Configures options for asynchronous invocation on a function, version, or alias. If a configuration already exists for a function, version, or alias, this operation overwrites it. If you exclude any settings, they are removed. To set one option without affecting existing settings for other options, use PutFunctionEventInvokeConfig .
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 .
To send an invocation record to a queue, topic, function, or event bus, specify a destination . You can configure separate destinations for successful invocations (on-success) and events that fail all processing attempts (on-failure). You can configure destinations in addition to or instead of a dead-letter queue.
See also: AWS API Documentation
Request Syntax
response = client.put_function_event_invoke_config(
FunctionName='string',
Qualifier='string',
MaximumRetryAttempts=123,
MaximumEventAgeInSeconds=123,
DestinationConfig={
'OnSuccess': {
'Destination': 'string'
},
'OnFailure': {
'Destination': 'string'
}
}
)
[REQUIRED]
The name of the Lambda function, version, or alias.
Name formats
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.
A destination for events after they have been sent to a function for processing.
Destinations
The destination configuration for successful invocations.
The Amazon Resource Name (ARN) of the destination resource.
The destination configuration for failed invocations.
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
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.
Adds a provisioned concurrency configuration to a function's alias or version.
See also: AWS API Documentation
Request Syntax
response = client.put_provisioned_concurrency_config(
FunctionName='string',
Qualifier='string',
ProvisionedConcurrentExecutions=123
)
[REQUIRED]
The name of the Lambda function.
Name 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.
[REQUIRED]
The version number or alias name.
[REQUIRED]
The amount of provisioned concurrency to allocate for the version or alias.
dict
Response Syntax
{
'RequestedProvisionedConcurrentExecutions': 123,
'AvailableProvisionedConcurrentExecutions': 123,
'AllocatedProvisionedConcurrentExecutions': 123,
'Status': 'IN_PROGRESS'|'READY'|'FAILED',
'StatusReason': 'string',
'LastModified': 'string'
}
Response Structure
(dict) --
RequestedProvisionedConcurrentExecutions (integer) --
The amount of provisioned concurrency requested.
AvailableProvisionedConcurrentExecutions (integer) --
The amount of provisioned concurrency available.
AllocatedProvisionedConcurrentExecutions (integer) --
The amount of provisioned concurrency allocated.
Status (string) --
The status of the allocation process.
StatusReason (string) --
For failed allocations, the reason that provisioned concurrency could not be allocated.
LastModified (string) --
The date and time that a user last updated the configuration, in ISO 8601 format .
Removes a statement from the permissions policy for a version of an AWS Lambda layer . For more information, see AddLayerVersionPermission .
See also: AWS API Documentation
Request Syntax
response = client.remove_layer_version_permission(
LayerName='string',
VersionNumber=123,
StatementId='string',
RevisionId='string'
)
[REQUIRED]
The name or Amazon Resource Name (ARN) of the layer.
[REQUIRED]
The version number.
[REQUIRED]
The identifier that was specified when the statement was added.
None
Revokes function-use permission from an AWS service or another account. You can get the ID of the statement from the output of GetPolicy .
See also: AWS API Documentation
Request Syntax
response = client.remove_permission(
FunctionName='string',
StatementId='string',
Qualifier='string',
RevisionId='string'
)
[REQUIRED]
The name of the Lambda function, version, or alias.
Name formats
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.
[REQUIRED]
Statement ID of the permission to remove.
None
Examples
This operation removes a Lambda function's permissions
response = client.remove_permission(
FunctionName='myFunction',
Qualifier='1',
StatementId='role-statement-id',
)
print(response)
Expected Output:
{
'ResponseMetadata': {
'...': '...',
},
}
Adds tags to a function.
See also: AWS API Documentation
Request Syntax
response = client.tag_resource(
Resource='string',
Tags={
'string': 'string'
}
)
[REQUIRED]
The function's Amazon Resource Name (ARN).
[REQUIRED]
A list of tags to apply to the function.
None
Removes tags from a function.
See also: AWS API Documentation
Request Syntax
response = client.untag_resource(
Resource='string',
TagKeys=[
'string',
]
)
[REQUIRED]
The function's Amazon Resource Name (ARN).
[REQUIRED]
A list of tag keys to remove from the function.
None
Updates the configuration of a Lambda function alias .
See also: AWS API Documentation
Request Syntax
response = client.update_alias(
FunctionName='string',
Name='string',
FunctionVersion='string',
Description='string',
RoutingConfig={
'AdditionalVersionWeights': {
'string': 123.0
}
},
RevisionId='string'
)
[REQUIRED]
The name of the Lambda function.
Name 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.
[REQUIRED]
The name of the alias.
The routing configuration of the alias.
The name of the second alias, and the percentage of traffic that's routed to it.
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 alias .
AliasArn (string) --
The Amazon Resource Name (ARN) of the alias.
Name (string) --
The name of the alias.
FunctionVersion (string) --
The function version that the alias invokes.
Description (string) --
A description of the alias.
RoutingConfig (dict) --
The routing configuration of the alias.
AdditionalVersionWeights (dict) --
The name of the second alias, and the percentage of traffic that's routed to it.
RevisionId (string) --
A unique identifier that changes when you update the alias.
Examples
This operation updates a Lambda function alias
response = client.update_alias(
Description='',
FunctionName='myFunction',
FunctionVersion='1',
Name='functionAlias',
)
print(response)
Expected Output:
{
'AliasArn': 'arn:aws:lambda:us-west-2:123456789012:function:functionAlias',
'Description': '',
'FunctionVersion': '1',
'Name': 'functionAlias',
'ResponseMetadata': {
'...': '...',
},
}
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):
See also: AWS API Documentation
Request Syntax
response = 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
)
[REQUIRED]
The identifier of the event source mapping.
The name of the Lambda function.
Name formats
The length constraint applies only to the full ARN. If you specify only the function name, it's limited to 64 characters in length.
The maximum number of items to retrieve in a single batch.
(Streams) An Amazon SQS queue or Amazon SNS topic destination for discarded records.
The destination configuration for successful invocations.
The Amazon Resource Name (ARN) of the destination resource.
The destination configuration for failed invocations.
The Amazon Resource Name (ARN) of the destination resource.
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.
Examples
This operation updates a Lambda function event source mapping
response = client.update_event_source_mapping(
BatchSize=123,
Enabled=True,
FunctionName='myFunction',
UUID='1234xCy789012',
)
print(response)
Expected Output:
{
'BatchSize': 123,
'EventSourceArn': 'arn:aws:s3:::examplebucket/*',
'FunctionArn': 'arn:aws:lambda:us-west-2:123456789012:function:myFunction',
'LastModified': datetime(2016, 11, 21, 19, 49, 20, 0, 326, 0),
'LastProcessingResult': '',
'State': '',
'StateTransitionReason': '',
'UUID': '1234xCy789012',
'ResponseMetadata': {
'...': '...',
},
}
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
response = client.update_function_code(
FunctionName='string',
ZipFile=b'bytes',
S3Bucket='string',
S3Key='string',
S3ObjectVersion='string',
Publish=True|False,
DryRun=True|False,
RevisionId='string'
)
[REQUIRED]
The name of the Lambda function.
Name 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.
The base64-encoded contents of the deployment package. AWS SDK and AWS CLI clients handle the encoding for you.
This value will be base64 encoded automatically. Do not base64 encode this value prior to performing the operation.
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'|'ruby2.7'|'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'|'InvalidSubnet'|'InvalidSecurityGroup',
'LastUpdateStatus': 'Successful'|'Failed'|'InProgress',
'LastUpdateStatusReason': 'string',
'LastUpdateStatusReasonCode': 'EniLimitExceeded'|'InsufficientRolePermissions'|'InvalidConfiguration'|'InternalError'|'SubnetOutOfIPAddresses'|'InvalidSubnet'|'InvalidSecurityGroup'
}
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.
SecurityGroupIds (list) --
A list of VPC security groups IDs.
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.
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. This is first set to Successful after function creation completes.
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.
Examples
This operation updates a Lambda function's code
response = client.update_function_code(
FunctionName='myFunction',
Publish=True,
S3Bucket='myBucket',
S3Key='myKey',
S3ObjectVersion='1',
ZipFile='fileb://file-path/file.zip',
)
print(response)
Expected Output:
{
'CodeSha256': 'LQT+0DHxxxxcfwLyQjzoEFKZtdqQjHXanlSdfXBlEW0VA=',
'CodeSize': 123,
'Description': '',
'FunctionArn': 'arn:aws:lambda:us-west-2:123456789012:function:myFunction',
'FunctionName': 'myFunction',
'Handler': 'index.handler',
'LastModified': '2016-11-21T19:49:20.006+0000',
'MemorySize': 128,
'Role': 'arn:aws:iam::123456789012:role/lambda_basic_execution',
'Runtime': 'python2.7',
'Timeout': 123,
'Version': '1',
'VpcConfig': {
},
'ResponseMetadata': {
'...': '...',
},
}
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
response = 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'|'ruby2.7'|'provided',
DeadLetterConfig={
'TargetArn': 'string'
},
KMSKeyArn='string',
TracingConfig={
'Mode': 'Active'|'PassThrough'
},
RevisionId='string',
Layers=[
'string',
]
)
[REQUIRED]
The name of the Lambda function.
Name 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.
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 .
A list of VPC subnet IDs.
A list of VPC security groups IDs.
Environment variables that are accessible from function code during execution.
Environment variable key-value pairs.
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 .
The Amazon Resource Name (ARN) of an Amazon SQS queue or Amazon SNS topic.
Set Mode to Active to sample and trace a subset of incoming requests with AWS X-Ray.
The tracing mode.
A list of function layers to add to the function's execution environment. Specify each layer by its ARN, including the version.
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'|'ruby2.7'|'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'|'InvalidSubnet'|'InvalidSecurityGroup',
'LastUpdateStatus': 'Successful'|'Failed'|'InProgress',
'LastUpdateStatusReason': 'string',
'LastUpdateStatusReasonCode': 'EniLimitExceeded'|'InsufficientRolePermissions'|'InvalidConfiguration'|'InternalError'|'SubnetOutOfIPAddresses'|'InvalidSubnet'|'InvalidSecurityGroup'
}
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.
SecurityGroupIds (list) --
A list of VPC security groups IDs.
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.
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. This is first set to Successful after function creation completes.
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.
Examples
This operation updates a Lambda function's configuration
response = client.update_function_configuration(
Description='',
FunctionName='myFunction',
Handler='index.handler',
MemorySize=128,
Role='arn:aws:iam::123456789012:role/lambda_basic_execution',
Runtime='python2.7',
Timeout=123,
VpcConfig={
},
)
print(response)
Expected Output:
{
'CodeSha256': 'LQT+0DHxxxxcfwLyQjzoEFKZtdqQjHXanlSdfXBlEW0VA=',
'CodeSize': 123,
'Description': '',
'FunctionArn': 'arn:aws:lambda:us-west-2:123456789012:function:myFunction',
'FunctionName': 'myFunction',
'Handler': 'index.handler',
'LastModified': '2016-11-21T19:49:20.006+0000',
'MemorySize': 128,
'Role': 'arn:aws:iam::123456789012:role/lambda_basic_execution',
'Runtime': 'python2.7',
'Timeout': 123,
'Version': '1',
'VpcConfig': {
},
'ResponseMetadata': {
'...': '...',
},
}
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
response = client.update_function_event_invoke_config(
FunctionName='string',
Qualifier='string',
MaximumRetryAttempts=123,
MaximumEventAgeInSeconds=123,
DestinationConfig={
'OnSuccess': {
'Destination': 'string'
},
'OnFailure': {
'Destination': 'string'
}
}
)
[REQUIRED]
The name of the Lambda function, version, or alias.
Name formats
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.
A destination for events after they have been sent to a function for processing.
Destinations
The destination configuration for successful invocations.
The Amazon Resource Name (ARN) of the destination resource.
The destination configuration for failed invocations.
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
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.
The available paginators are:
paginator = client.get_paginator('list_aliases')
Creates an iterator that will paginate through responses from Lambda.Client.list_aliases().
See also: AWS API Documentation
Request Syntax
response_iterator = paginator.paginate(
FunctionName='string',
FunctionVersion='string',
PaginationConfig={
'MaxItems': 123,
'PageSize': 123,
'StartingToken': 'string'
}
)
[REQUIRED]
The name of the Lambda function.
Name 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.
A dictionary that provides parameters to control pagination.
The total number of items to return. If the total number of items available is more than the value specified in max-items then a NextToken will be provided in the output that you can use to resume pagination.
The size of each page.
A token to specify where to start paginating. This is the NextToken from a previous response.
dict
Response Syntax
{
'Aliases': [
{
'AliasArn': 'string',
'Name': 'string',
'FunctionVersion': 'string',
'Description': 'string',
'RoutingConfig': {
'AdditionalVersionWeights': {
'string': 123.0
}
},
'RevisionId': 'string'
},
],
'NextToken': 'string'
}
Response Structure
(dict) --
Aliases (list) --
A list of aliases.
(dict) --
Provides configuration information about a Lambda function alias .
AliasArn (string) --
The Amazon Resource Name (ARN) of the alias.
Name (string) --
The name of the alias.
FunctionVersion (string) --
The function version that the alias invokes.
Description (string) --
A description of the alias.
RoutingConfig (dict) --
The routing configuration of the alias.
AdditionalVersionWeights (dict) --
The name of the second alias, and the percentage of traffic that's routed to it.
RevisionId (string) --
A unique identifier that changes when you update the alias.
NextToken (string) --
A token to resume pagination.
paginator = client.get_paginator('list_event_source_mappings')
Creates an iterator that will paginate through responses from Lambda.Client.list_event_source_mappings().
See also: AWS API Documentation
Request Syntax
response_iterator = paginator.paginate(
EventSourceArn='string',
FunctionName='string',
PaginationConfig={
'MaxItems': 123,
'PageSize': 123,
'StartingToken': 'string'
}
)
The Amazon Resource Name (ARN) of the event source.
The name of the Lambda function.
Name formats
The length constraint applies only to the full ARN. If you specify only the function name, it's limited to 64 characters in length.
A dictionary that provides parameters to control pagination.
The total number of items to return. If the total number of items available is more than the value specified in max-items then a NextToken will be provided in the output that you can use to resume pagination.
The size of each page.
A token to specify where to start paginating. This is the NextToken from a previous response.
dict
Response Syntax
{
'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
},
],
'NextToken': 'string'
}
Response Structure
(dict) --
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.
NextToken (string) --
A token to resume pagination.
paginator = client.get_paginator('list_function_event_invoke_configs')
Creates an iterator that will paginate through responses from Lambda.Client.list_function_event_invoke_configs().
See also: AWS API Documentation
Request Syntax
response_iterator = paginator.paginate(
FunctionName='string',
PaginationConfig={
'MaxItems': 123,
'PageSize': 123,
'StartingToken': 'string'
}
)
[REQUIRED]
The name of the Lambda function.
Name 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.
A dictionary that provides parameters to control pagination.
The total number of items to return. If the total number of items available is more than the value specified in max-items then a NextToken will be provided in the output that you can use to resume pagination.
The size of each page.
A token to specify where to start paginating. This is the NextToken from a previous response.
dict
Response Syntax
{
'FunctionEventInvokeConfigs': [
{
'LastModified': datetime(2015, 1, 1),
'FunctionArn': 'string',
'MaximumRetryAttempts': 123,
'MaximumEventAgeInSeconds': 123,
'DestinationConfig': {
'OnSuccess': {
'Destination': 'string'
},
'OnFailure': {
'Destination': 'string'
}
}
},
],
'NextToken': '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
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.
NextToken (string) --
A token to resume pagination.
paginator = client.get_paginator('list_functions')
Creates an iterator that will paginate through responses from Lambda.Client.list_functions().
See also: AWS API Documentation
Request Syntax
response_iterator = paginator.paginate(
MasterRegion='string',
FunctionVersion='ALL',
PaginationConfig={
'MaxItems': 123,
'PageSize': 123,
'StartingToken': 'string'
}
)
A dictionary that provides parameters to control pagination.
The total number of items to return. If the total number of items available is more than the value specified in max-items then a NextToken will be provided in the output that you can use to resume pagination.
The size of each page.
A token to specify where to start paginating. This is the NextToken from a previous response.
dict
Response Syntax
{
'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'|'ruby2.7'|'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'|'InvalidSubnet'|'InvalidSecurityGroup',
'LastUpdateStatus': 'Successful'|'Failed'|'InProgress',
'LastUpdateStatusReason': 'string',
'LastUpdateStatusReasonCode': 'EniLimitExceeded'|'InsufficientRolePermissions'|'InvalidConfiguration'|'InternalError'|'SubnetOutOfIPAddresses'|'InvalidSubnet'|'InvalidSecurityGroup'
},
],
'NextToken': 'string'
}
Response Structure
(dict) --
A list of Lambda functions.
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.
SecurityGroupIds (list) --
A list of VPC security groups IDs.
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.
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. This is first set to Successful after function creation completes.
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.
NextToken (string) --
A token to resume pagination.
paginator = client.get_paginator('list_layer_versions')
Creates an iterator that will paginate through responses from Lambda.Client.list_layer_versions().
See also: AWS API Documentation
Request Syntax
response_iterator = paginator.paginate(
CompatibleRuntime='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'|'ruby2.7'|'provided',
LayerName='string',
PaginationConfig={
'MaxItems': 123,
'PageSize': 123,
'StartingToken': 'string'
}
)
[REQUIRED]
The name or Amazon Resource Name (ARN) of the layer.
A dictionary that provides parameters to control pagination.
The total number of items to return. If the total number of items available is more than the value specified in max-items then a NextToken will be provided in the output that you can use to resume pagination.
The size of each page.
A token to specify where to start paginating. This is the NextToken from a previous response.
dict
Response Syntax
{
'LayerVersions': [
{
'LayerVersionArn': 'string',
'Version': 123,
'Description': 'string',
'CreatedDate': 'string',
'CompatibleRuntimes': [
'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'|'ruby2.7'|'provided',
],
'LicenseInfo': 'string'
},
],
'NextToken': 'string'
}
Response Structure
(dict) --
LayerVersions (list) --
A list of versions.
(dict) --
Details about a version of an AWS Lambda layer .
LayerVersionArn (string) --
The ARN of the layer version.
Version (integer) --
The version number.
Description (string) --
The description of the version.
CreatedDate (string) --
The date that the version was created, in ISO 8601 format. For example, 2018-11-27T15:10:45.123+0000 .
CompatibleRuntimes (list) --
The layer's compatible runtimes.
LicenseInfo (string) --
The layer's open-source license.
NextToken (string) --
A token to resume pagination.
paginator = client.get_paginator('list_layers')
Creates an iterator that will paginate through responses from Lambda.Client.list_layers().
See also: AWS API Documentation
Request Syntax
response_iterator = paginator.paginate(
CompatibleRuntime='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'|'ruby2.7'|'provided',
PaginationConfig={
'MaxItems': 123,
'PageSize': 123,
'StartingToken': 'string'
}
)
A dictionary that provides parameters to control pagination.
The total number of items to return. If the total number of items available is more than the value specified in max-items then a NextToken will be provided in the output that you can use to resume pagination.
The size of each page.
A token to specify where to start paginating. This is the NextToken from a previous response.
dict
Response Syntax
{
'Layers': [
{
'LayerName': 'string',
'LayerArn': 'string',
'LatestMatchingVersion': {
'LayerVersionArn': 'string',
'Version': 123,
'Description': 'string',
'CreatedDate': 'string',
'CompatibleRuntimes': [
'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'|'ruby2.7'|'provided',
],
'LicenseInfo': 'string'
}
},
],
'NextToken': 'string'
}
Response Structure
(dict) --
Layers (list) --
A list of function layers.
(dict) --
Details about an AWS Lambda layer .
LayerName (string) --
The name of the layer.
LayerArn (string) --
The Amazon Resource Name (ARN) of the function layer.
LatestMatchingVersion (dict) --
The newest version of the layer.
LayerVersionArn (string) --
The ARN of the layer version.
Version (integer) --
The version number.
Description (string) --
The description of the version.
CreatedDate (string) --
The date that the version was created, in ISO 8601 format. For example, 2018-11-27T15:10:45.123+0000 .
CompatibleRuntimes (list) --
The layer's compatible runtimes.
LicenseInfo (string) --
The layer's open-source license.
NextToken (string) --
A token to resume pagination.
paginator = client.get_paginator('list_provisioned_concurrency_configs')
Creates an iterator that will paginate through responses from Lambda.Client.list_provisioned_concurrency_configs().
See also: AWS API Documentation
Request Syntax
response_iterator = paginator.paginate(
FunctionName='string',
PaginationConfig={
'MaxItems': 123,
'PageSize': 123,
'StartingToken': 'string'
}
)
[REQUIRED]
The name of the Lambda function.
Name 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.
A dictionary that provides parameters to control pagination.
The total number of items to return. If the total number of items available is more than the value specified in max-items then a NextToken will be provided in the output that you can use to resume pagination.
The size of each page.
A token to specify where to start paginating. This is the NextToken from a previous response.
dict
Response Syntax
{
'ProvisionedConcurrencyConfigs': [
{
'FunctionArn': 'string',
'RequestedProvisionedConcurrentExecutions': 123,
'AvailableProvisionedConcurrentExecutions': 123,
'AllocatedProvisionedConcurrentExecutions': 123,
'Status': 'IN_PROGRESS'|'READY'|'FAILED',
'StatusReason': 'string',
'LastModified': 'string'
},
],
'NextToken': 'string'
}
Response Structure
(dict) --
ProvisionedConcurrencyConfigs (list) --
A list of provisioned concurrency configurations.
(dict) --
Details about the provisioned concurrency configuration for a function alias or version.
FunctionArn (string) --
The Amazon Resource Name (ARN) of the alias or version.
RequestedProvisionedConcurrentExecutions (integer) --
The amount of provisioned concurrency requested.
AvailableProvisionedConcurrentExecutions (integer) --
The amount of provisioned concurrency available.
AllocatedProvisionedConcurrentExecutions (integer) --
The amount of provisioned concurrency allocated.
Status (string) --
The status of the allocation process.
StatusReason (string) --
For failed allocations, the reason that provisioned concurrency could not be allocated.
LastModified (string) --
The date and time that a user last updated the configuration, in ISO 8601 format .
NextToken (string) --
A token to resume pagination.
paginator = client.get_paginator('list_versions_by_function')
Creates an iterator that will paginate through responses from Lambda.Client.list_versions_by_function().
See also: AWS API Documentation
Request Syntax
response_iterator = paginator.paginate(
FunctionName='string',
PaginationConfig={
'MaxItems': 123,
'PageSize': 123,
'StartingToken': 'string'
}
)
[REQUIRED]
The name of the Lambda function.
Name 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.
A dictionary that provides parameters to control pagination.
The total number of items to return. If the total number of items available is more than the value specified in max-items then a NextToken will be provided in the output that you can use to resume pagination.
The size of each page.
A token to specify where to start paginating. This is the NextToken from a previous response.
dict
Response Syntax
{
'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'|'ruby2.7'|'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'|'InvalidSubnet'|'InvalidSecurityGroup',
'LastUpdateStatus': 'Successful'|'Failed'|'InProgress',
'LastUpdateStatusReason': 'string',
'LastUpdateStatusReasonCode': 'EniLimitExceeded'|'InsufficientRolePermissions'|'InvalidConfiguration'|'InternalError'|'SubnetOutOfIPAddresses'|'InvalidSubnet'|'InvalidSecurityGroup'
},
],
'NextToken': 'string'
}
Response Structure
(dict) --
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.
SecurityGroupIds (list) --
A list of VPC security groups IDs.
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.
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. This is first set to Successful after function creation completes.
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.
NextToken (string) --
A token to resume pagination.
The available waiters are:
waiter = client.get_waiter('function_active')
Polls Lambda.Client.get_function_configuration() every 5 seconds until a successful state is reached. An error is returned after 60 failed checks.
See also: AWS API Documentation
Request Syntax
waiter.wait(
FunctionName='string',
Qualifier='string',
WaiterConfig={
'Delay': 123,
'MaxAttempts': 123
}
)
[REQUIRED]
The name of the Lambda function, version, or alias.
Name formats
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.
A dictionary that provides parameters to control waiting behavior.
The amount of time in seconds to wait between attempts. Default: 5
The maximum number of attempts to be made. Default: 60
None
waiter = client.get_waiter('function_exists')
Polls Lambda.Client.get_function() every 1 seconds until a successful state is reached. An error is returned after 20 failed checks.
See also: AWS API Documentation
Request Syntax
waiter.wait(
FunctionName='string',
Qualifier='string',
WaiterConfig={
'Delay': 123,
'MaxAttempts': 123
}
)
[REQUIRED]
The name of the Lambda function, version, or alias.
Name formats
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.
A dictionary that provides parameters to control waiting behavior.
The amount of time in seconds to wait between attempts. Default: 1
The maximum number of attempts to be made. Default: 20
None
waiter = client.get_waiter('function_updated')
Polls Lambda.Client.get_function_configuration() every 5 seconds until a successful state is reached. An error is returned after 60 failed checks.
See also: AWS API Documentation
Request Syntax
waiter.wait(
FunctionName='string',
Qualifier='string',
WaiterConfig={
'Delay': 123,
'MaxAttempts': 123
}
)
[REQUIRED]
The name of the Lambda function, version, or alias.
Name formats
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.
A dictionary that provides parameters to control waiting behavior.
The amount of time in seconds to wait between attempts. Default: 5
The maximum number of attempts to be made. Default: 60
None