AWS Lambda

2018/11/19 - AWS Lambda - 8 updated api methods

Changes  Update lambda client to latest version

CreateFunction (updated) Link ¶
Changes (both)
{'Runtime': {'python3.7'}}

Creates a new Lambda function. The function configuration is created from the request parameters, and the code for the function is provided by a .zip file. The function name is case-sensitive.

This operation requires permission for the lambda:CreateFunction action.

See also: AWS API Documentation

Request Syntax

client.create_function(
    FunctionName='string',
    Runtime='nodejs'|'nodejs4.3'|'nodejs6.10'|'nodejs8.10'|'java8'|'python2.7'|'python3.6'|'python3.7'|'dotnetcore1.0'|'dotnetcore2.0'|'dotnetcore2.1'|'nodejs4.3-edge'|'go1.x',
    Role='string',
    Handler='string',
    Code={
        'ZipFile': b'bytes',
        'S3Bucket': 'string',
        'S3Key': 'string',
        'S3ObjectVersion': 'string'
    },
    Description='string',
    Timeout=123,
    MemorySize=123,
    Publish=True|False,
    VpcConfig={
        'SubnetIds': [
            'string',
        ],
        'SecurityGroupIds': [
            'string',
        ]
    },
    DeadLetterConfig={
        'TargetArn': 'string'
    },
    Environment={
        'Variables': {
            'string': 'string'
        }
    },
    KMSKeyArn='string',
    TracingConfig={
        'Mode': 'Active'|'PassThrough'
    },
    Tags={
        'string': 'string'
    }
)
type FunctionName:

string

param FunctionName:

[REQUIRED]

The name of the lambda function.

Name formats

  • Function name - MyFunction.

  • Function ARN - arn:aws:lambda:us-west-2:123456789012:function:MyFunction.

  • Partial ARN - 123456789012:function:MyFunction.

The length constraint applies only to the full ARN. If you specify only the function name, it is limited to 64 characters in length.

type Runtime:

string

param Runtime:

[REQUIRED]

The runtime version for the function.

type Role:

string

param Role:

[REQUIRED]

The Amazon Resource Name (ARN) of the function's execution role.

type Handler:

string

param Handler:

[REQUIRED]

The name of the method within your code that Lambda calls to execute your function. For more information, see Programming Model.

type Code:

dict

param Code:

[REQUIRED]

The code for the function.

  • ZipFile (bytes) --

    The base64-encoded contents of your zip file containing your deployment package. AWS SDK and AWS CLI clients handle the encoding for you.

  • S3Bucket (string) --

    An Amazon S3 bucket in the same region as your function.

  • S3Key (string) --

    The Amazon S3 key of the deployment package.

  • S3ObjectVersion (string) --

    For versioned objects, the version of the deployment package object to use.

type Description:

string

param Description:

A description of the function.

type Timeout:

integer

param Timeout:

The amount of time that Lambda allows a function to run before terminating it. The default is 3 seconds. The maximum allowed value is 900 seconds.

type MemorySize:

integer

param MemorySize:

The amount of memory that your function has access to. Increasing the function's memory also increases it's CPU allocation. The default value is 128 MB. The value must be a multiple of 64 MB.

type Publish:

boolean

param Publish:

Set to true to publish the first version of the function during creation.

type VpcConfig:

dict

param VpcConfig:

If your Lambda function accesses resources in a VPC, you provide this parameter identifying the list of security group IDs and subnet IDs. These must belong to the same VPC. You must provide at least one security group and one subnet ID.

  • SubnetIds (list) --

    A list of VPC subnet IDs.

    • (string) --

  • SecurityGroupIds (list) --

    A list of VPC security groups IDs.

    • (string) --

type DeadLetterConfig:

dict

param DeadLetterConfig:

A dead letter queue configuration that specifies the queue or topic where Lambda sends asynchronous events when they fail processing. For more information, see Dead Letter Queues.

  • TargetArn (string) --

    The Amazon Resource Name (ARN) of an Amazon SQS queue or Amazon SNS topic.

type Environment:

dict

param Environment:

Environment variables that are accessible from function code during execution.

  • Variables (dict) --

    Environment variable key-value pairs.

    • (string) --

      • (string) --

type KMSKeyArn:

string

param KMSKeyArn:

The ARN of the KMS key used to encrypt your function's environment variables. If not provided, AWS Lambda will use a default service key.

type TracingConfig:

dict

param TracingConfig:

Set Mode to Active to sample and trace a subset of incoming requests with AWS X-Ray.

  • Mode (string) --

    The tracing mode.

type Tags:

dict

param Tags:

The list of tags (key-value pairs) assigned to the new function. For more information, see Tagging Lambda Functions in the AWS Lambda Developer Guide.

  • (string) --

    • (string) --

rtype:

dict

returns:

Response Syntax

{
    'FunctionName': 'string',
    'FunctionArn': 'string',
    'Runtime': 'nodejs'|'nodejs4.3'|'nodejs6.10'|'nodejs8.10'|'java8'|'python2.7'|'python3.6'|'python3.7'|'dotnetcore1.0'|'dotnetcore2.0'|'dotnetcore2.1'|'nodejs4.3-edge'|'go1.x',
    'Role': 'string',
    'Handler': 'string',
    'CodeSize': 123,
    'Description': 'string',
    'Timeout': 123,
    'MemorySize': 123,
    'LastModified': 'string',
    'CodeSha256': 'string',
    'Version': 'string',
    'VpcConfig': {
        'SubnetIds': [
            'string',
        ],
        'SecurityGroupIds': [
            'string',
        ],
        'VpcId': 'string'
    },
    'DeadLetterConfig': {
        'TargetArn': 'string'
    },
    'Environment': {
        'Variables': {
            'string': 'string'
        },
        'Error': {
            'ErrorCode': 'string',
            'Message': 'string'
        }
    },
    'KMSKeyArn': 'string',
    'TracingConfig': {
        'Mode': 'Active'|'PassThrough'
    },
    'MasterArn': 'string',
    'RevisionId': 'string'
}

Response Structure

  • (dict) --

    A Lambda function's configuration settings.

    • FunctionName (string) --

      The name of the function.

    • FunctionArn (string) --

      The function's Amazon Resource Name.

    • Runtime (string) --

      The runtime environment for the Lambda function.

    • Role (string) --

      The function's execution role.

    • Handler (string) --

      The function 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 terminating it.

    • MemorySize (integer) --

      The memory allocated to the function

    • LastModified (string) --

      The date and time that the function was last updated, in ISO-8601 format (YYYY-MM-DDThh:mm:ssTZD).

    • CodeSha256 (string) --

      The SHA256 hash of the function's deployment package.

    • Version (string) --

      The version of the Lambda function.

    • VpcConfig (dict) --

      The function's networking configuration.

      • SubnetIds (list) --

        A list of VPC subnet IDs.

        • (string) --

      • SecurityGroupIds (list) --

        A list of VPC security groups IDs.

        • (string) --

      • VpcId (string) --

        The ID of the VPC.

    • DeadLetterConfig (dict) --

      The function's dead letter queue.

      • TargetArn (string) --

        The Amazon Resource Name (ARN) of an Amazon SQS queue or Amazon SNS topic.

    • Environment (dict) --

      The function's environment variables.

      • Variables (dict) --

        Environment variable key-value pairs.

        • (string) --

          • (string) --

      • Error (dict) --

        Error messages for environment variables that could not be applied.

        • ErrorCode (string) --

          The error code.

        • Message (string) --

          The error message.

    • KMSKeyArn (string) --

      The KMS key used to encrypt the function's environment variables. 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) --

      The ARN of the master function.

    • RevisionId (string) --

      Represents the latest updated revision of the function or alias.

GetFunction (updated) Link ¶
Changes (response)
{'Configuration': {'Runtime': {'python3.7'}}}

Returns the configuration information of the Lambda function and a presigned URL link to the .zip file you uploaded with CreateFunction so you can download the .zip file. Note that the URL is valid for up to 10 minutes. The configuration information is the same information you provided as parameters when uploading the function.

Use the Qualifier parameter to retrieve a published version of the function. Otherwise, returns the unpublished version ( $LATEST). For more information, see AWS Lambda Function Versioning and Aliases.

This operation requires permission for the lambda:GetFunction action.

See also: AWS API Documentation

Request Syntax

client.get_function(
    FunctionName='string',
    Qualifier='string'
)
type FunctionName:

string

param FunctionName:

[REQUIRED]

The name of the lambda function.

Name formats

  • Function name - MyFunction.

  • Function ARN - arn:aws:lambda:us-west-2:123456789012:function:MyFunction.

  • Partial ARN - 123456789012:function:MyFunction.

The length constraint applies only to the full ARN. If you specify only the function name, it is limited to 64 characters in length.

type Qualifier:

string

param Qualifier:

Specify a version or alias to get details about a published version of the function.

rtype:

dict

returns:

Response Syntax

{
    'Configuration': {
        'FunctionName': 'string',
        'FunctionArn': 'string',
        'Runtime': 'nodejs'|'nodejs4.3'|'nodejs6.10'|'nodejs8.10'|'java8'|'python2.7'|'python3.6'|'python3.7'|'dotnetcore1.0'|'dotnetcore2.0'|'dotnetcore2.1'|'nodejs4.3-edge'|'go1.x',
        'Role': 'string',
        'Handler': 'string',
        'CodeSize': 123,
        'Description': 'string',
        'Timeout': 123,
        'MemorySize': 123,
        'LastModified': 'string',
        'CodeSha256': 'string',
        'Version': 'string',
        'VpcConfig': {
            'SubnetIds': [
                'string',
            ],
            'SecurityGroupIds': [
                'string',
            ],
            'VpcId': 'string'
        },
        'DeadLetterConfig': {
            'TargetArn': 'string'
        },
        'Environment': {
            'Variables': {
                'string': 'string'
            },
            'Error': {
                'ErrorCode': 'string',
                'Message': 'string'
            }
        },
        'KMSKeyArn': 'string',
        'TracingConfig': {
            'Mode': 'Active'|'PassThrough'
        },
        'MasterArn': 'string',
        'RevisionId': 'string'
    },
    'Code': {
        'RepositoryType': 'string',
        'Location': 'string'
    },
    'Tags': {
        'string': 'string'
    },
    'Concurrency': {
        'ReservedConcurrentExecutions': 123
    }
}

Response Structure

  • (dict) --

    This response contains the object for the Lambda function location (see FunctionCodeLocation.

    • Configuration (dict) --

      The function's configuration.

      • FunctionName (string) --

        The name of the function.

      • FunctionArn (string) --

        The function's Amazon Resource Name.

      • Runtime (string) --

        The runtime environment for the Lambda function.

      • Role (string) --

        The function's execution role.

      • Handler (string) --

        The function 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 terminating it.

      • MemorySize (integer) --

        The memory allocated to the function

      • LastModified (string) --

        The date and time that the function was last updated, in ISO-8601 format (YYYY-MM-DDThh:mm:ssTZD).

      • CodeSha256 (string) --

        The SHA256 hash of the function's deployment package.

      • Version (string) --

        The version of the Lambda function.

      • VpcConfig (dict) --

        The function's networking configuration.

        • SubnetIds (list) --

          A list of VPC subnet IDs.

          • (string) --

        • SecurityGroupIds (list) --

          A list of VPC security groups IDs.

          • (string) --

        • VpcId (string) --

          The ID of the VPC.

      • DeadLetterConfig (dict) --

        The function's dead letter queue.

        • TargetArn (string) --

          The Amazon Resource Name (ARN) of an Amazon SQS queue or Amazon SNS topic.

      • Environment (dict) --

        The function's environment variables.

        • Variables (dict) --

          Environment variable key-value pairs.

          • (string) --

            • (string) --

        • Error (dict) --

          Error messages for environment variables that could not be applied.

          • ErrorCode (string) --

            The error code.

          • Message (string) --

            The error message.

      • KMSKeyArn (string) --

        The KMS key used to encrypt the function's environment variables. 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) --

        The ARN of the master function.

      • RevisionId (string) --

        Represents the latest updated revision of the function or alias.

    • Code (dict) --

      The function's code.

      • RepositoryType (string) --

        The repository from which you can download the function.

      • Location (string) --

        The presigned URL you can use to download the function's .zip file that you previously uploaded. The URL is valid for up to 10 minutes.

    • Tags (dict) --

      Returns the list of tags associated with the function. For more information, see Tagging Lambda Functions in the AWS Lambda Developer Guide.

      • (string) --

        • (string) --

    • Concurrency (dict) --

      The concurrent execution limit set for this function. For more information, see Managing Concurrency.

      • ReservedConcurrentExecutions (integer) --

        The number of concurrent executions reserved for this function. For more information, see Managing Concurrency.

GetFunctionConfiguration (updated) Link ¶
Changes (response)
{'Runtime': {'python3.7'}}

Returns the configuration information of the Lambda function. This the same information you provided as parameters when uploading the function by using CreateFunction.

If you are using the versioning feature, you can retrieve this information for a specific function version by using the optional Qualifier parameter and specifying the function version or alias that points to it. If you don't provide it, the API returns information about the $LATEST version of the function. For more information about versioning, see AWS Lambda Function Versioning and Aliases.

This operation requires permission for the lambda:GetFunctionConfiguration operation.

See also: AWS API Documentation

Request Syntax

client.get_function_configuration(
    FunctionName='string',
    Qualifier='string'
)
type FunctionName:

string

param FunctionName:

[REQUIRED]

The name of the lambda function.

Name formats

  • Function name - MyFunction.

  • Function ARN - arn:aws:lambda:us-west-2:123456789012:function:MyFunction.

  • Partial ARN - 123456789012:function:MyFunction.

The length constraint applies only to the full ARN. If you specify only the function name, it is limited to 64 characters in length.

type Qualifier:

string

param Qualifier:

Specify a version or alias to get details about a published version of the function.

rtype:

dict

returns:

Response Syntax

{
    'FunctionName': 'string',
    'FunctionArn': 'string',
    'Runtime': 'nodejs'|'nodejs4.3'|'nodejs6.10'|'nodejs8.10'|'java8'|'python2.7'|'python3.6'|'python3.7'|'dotnetcore1.0'|'dotnetcore2.0'|'dotnetcore2.1'|'nodejs4.3-edge'|'go1.x',
    'Role': 'string',
    'Handler': 'string',
    'CodeSize': 123,
    'Description': 'string',
    'Timeout': 123,
    'MemorySize': 123,
    'LastModified': 'string',
    'CodeSha256': 'string',
    'Version': 'string',
    'VpcConfig': {
        'SubnetIds': [
            'string',
        ],
        'SecurityGroupIds': [
            'string',
        ],
        'VpcId': 'string'
    },
    'DeadLetterConfig': {
        'TargetArn': 'string'
    },
    'Environment': {
        'Variables': {
            'string': 'string'
        },
        'Error': {
            'ErrorCode': 'string',
            'Message': 'string'
        }
    },
    'KMSKeyArn': 'string',
    'TracingConfig': {
        'Mode': 'Active'|'PassThrough'
    },
    'MasterArn': 'string',
    'RevisionId': 'string'
}

Response Structure

  • (dict) --

    A Lambda function's configuration settings.

    • FunctionName (string) --

      The name of the function.

    • FunctionArn (string) --

      The function's Amazon Resource Name.

    • Runtime (string) --

      The runtime environment for the Lambda function.

    • Role (string) --

      The function's execution role.

    • Handler (string) --

      The function 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 terminating it.

    • MemorySize (integer) --

      The memory allocated to the function

    • LastModified (string) --

      The date and time that the function was last updated, in ISO-8601 format (YYYY-MM-DDThh:mm:ssTZD).

    • CodeSha256 (string) --

      The SHA256 hash of the function's deployment package.

    • Version (string) --

      The version of the Lambda function.

    • VpcConfig (dict) --

      The function's networking configuration.

      • SubnetIds (list) --

        A list of VPC subnet IDs.

        • (string) --

      • SecurityGroupIds (list) --

        A list of VPC security groups IDs.

        • (string) --

      • VpcId (string) --

        The ID of the VPC.

    • DeadLetterConfig (dict) --

      The function's dead letter queue.

      • TargetArn (string) --

        The Amazon Resource Name (ARN) of an Amazon SQS queue or Amazon SNS topic.

    • Environment (dict) --

      The function's environment variables.

      • Variables (dict) --

        Environment variable key-value pairs.

        • (string) --

          • (string) --

      • Error (dict) --

        Error messages for environment variables that could not be applied.

        • ErrorCode (string) --

          The error code.

        • Message (string) --

          The error message.

    • KMSKeyArn (string) --

      The KMS key used to encrypt the function's environment variables. 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) --

      The ARN of the master function.

    • RevisionId (string) --

      Represents the latest updated revision of the function or alias.

ListFunctions (updated) Link ¶
Changes (response)
{'Functions': {'Runtime': {'python3.7'}}}

Returns a list of your Lambda functions. For each function, the response includes the function configuration information. You must use GetFunction to retrieve the code for your function.

This operation requires permission for the lambda:ListFunctions action.

If you are using the versioning feature, you can list all of your functions or only $LATEST versions. For information about the versioning feature, see AWS Lambda Function Versioning and Aliases.

See also: AWS API Documentation

Request Syntax

client.list_functions(
    MasterRegion='string',
    FunctionVersion='ALL',
    Marker='string',
    MaxItems=123
)
type MasterRegion:

string

param MasterRegion:

Specify a region (e.g. us-east-2) to only list functions that were created in that region, or ALL to include functions replicated from any region. If specified, you also must specify the FunctionVersion.

type FunctionVersion:

string

param FunctionVersion:

Set to ALL to list all published versions. If not specified, only the latest unpublished version ARN is returned.

type Marker:

string

param Marker:

Optional string. An opaque pagination token returned from a previous ListFunctions operation. If present, indicates where to continue the listing.

type MaxItems:

integer

param MaxItems:

Optional integer. Specifies the maximum number of AWS Lambda functions to return in response. This parameter value must be greater than 0. The absolute maximum of AWS Lambda functions that can be returned is 50.

rtype:

dict

returns:

Response Syntax

{
    'NextMarker': 'string',
    'Functions': [
        {
            'FunctionName': 'string',
            'FunctionArn': 'string',
            'Runtime': 'nodejs'|'nodejs4.3'|'nodejs6.10'|'nodejs8.10'|'java8'|'python2.7'|'python3.6'|'python3.7'|'dotnetcore1.0'|'dotnetcore2.0'|'dotnetcore2.1'|'nodejs4.3-edge'|'go1.x',
            'Role': 'string',
            'Handler': 'string',
            'CodeSize': 123,
            'Description': 'string',
            'Timeout': 123,
            'MemorySize': 123,
            'LastModified': 'string',
            'CodeSha256': 'string',
            'Version': 'string',
            'VpcConfig': {
                'SubnetIds': [
                    'string',
                ],
                'SecurityGroupIds': [
                    'string',
                ],
                'VpcId': 'string'
            },
            'DeadLetterConfig': {
                'TargetArn': 'string'
            },
            'Environment': {
                'Variables': {
                    'string': 'string'
                },
                'Error': {
                    'ErrorCode': 'string',
                    'Message': 'string'
                }
            },
            'KMSKeyArn': 'string',
            'TracingConfig': {
                'Mode': 'Active'|'PassThrough'
            },
            'MasterArn': 'string',
            'RevisionId': 'string'
        },
    ]
}

Response Structure

  • (dict) --

    A list of Lambda functions.

    • NextMarker (string) --

      A string, present if there are more functions.

    • Functions (list) --

      A list of Lambda functions.

      • (dict) --

        A Lambda function's configuration settings.

        • FunctionName (string) --

          The name of the function.

        • FunctionArn (string) --

          The function's Amazon Resource Name.

        • Runtime (string) --

          The runtime environment for the Lambda function.

        • Role (string) --

          The function's execution role.

        • Handler (string) --

          The function 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 terminating it.

        • MemorySize (integer) --

          The memory allocated to the function

        • LastModified (string) --

          The date and time that the function was last updated, in ISO-8601 format (YYYY-MM-DDThh:mm:ssTZD).

        • CodeSha256 (string) --

          The SHA256 hash of the function's deployment package.

        • Version (string) --

          The version of the Lambda function.

        • VpcConfig (dict) --

          The function's networking configuration.

          • SubnetIds (list) --

            A list of VPC subnet IDs.

            • (string) --

          • SecurityGroupIds (list) --

            A list of VPC security groups IDs.

            • (string) --

          • VpcId (string) --

            The ID of the VPC.

        • DeadLetterConfig (dict) --

          The function's dead letter queue.

          • TargetArn (string) --

            The Amazon Resource Name (ARN) of an Amazon SQS queue or Amazon SNS topic.

        • Environment (dict) --

          The function's environment variables.

          • Variables (dict) --

            Environment variable key-value pairs.

            • (string) --

              • (string) --

          • Error (dict) --

            Error messages for environment variables that could not be applied.

            • ErrorCode (string) --

              The error code.

            • Message (string) --

              The error message.

        • KMSKeyArn (string) --

          The KMS key used to encrypt the function's environment variables. 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) --

          The ARN of the master function.

        • RevisionId (string) --

          Represents the latest updated revision of the function or alias.

ListVersionsByFunction (updated) Link ¶
Changes (response)
{'Versions': {'Runtime': {'python3.7'}}}

Lists all versions of a function. For information about versioning, see AWS Lambda Function Versioning and Aliases.

See also: AWS API Documentation

Request Syntax

client.list_versions_by_function(
    FunctionName='string',
    Marker='string',
    MaxItems=123
)
type FunctionName:

string

param FunctionName:

[REQUIRED]

The name of the lambda function.

Name formats

  • Function name - MyFunction.

  • Function ARN - arn:aws:lambda:us-west-2:123456789012:function:MyFunction.

  • Partial ARN - 123456789012:function:MyFunction.

The length constraint applies only to the full ARN. If you specify only the function name, it is limited to 64 characters in length.

type Marker:

string

param Marker:

Optional string. An opaque pagination token returned from a previous ListVersionsByFunction operation. If present, indicates where to continue the listing.

type MaxItems:

integer

param MaxItems:

Optional integer. Specifies the maximum number of AWS Lambda function versions to return in response. This parameter value must be greater than 0.

rtype:

dict

returns:

Response Syntax

{
    'NextMarker': 'string',
    'Versions': [
        {
            'FunctionName': 'string',
            'FunctionArn': 'string',
            'Runtime': 'nodejs'|'nodejs4.3'|'nodejs6.10'|'nodejs8.10'|'java8'|'python2.7'|'python3.6'|'python3.7'|'dotnetcore1.0'|'dotnetcore2.0'|'dotnetcore2.1'|'nodejs4.3-edge'|'go1.x',
            'Role': 'string',
            'Handler': 'string',
            'CodeSize': 123,
            'Description': 'string',
            'Timeout': 123,
            'MemorySize': 123,
            'LastModified': 'string',
            'CodeSha256': 'string',
            'Version': 'string',
            'VpcConfig': {
                'SubnetIds': [
                    'string',
                ],
                'SecurityGroupIds': [
                    'string',
                ],
                'VpcId': 'string'
            },
            'DeadLetterConfig': {
                'TargetArn': 'string'
            },
            'Environment': {
                'Variables': {
                    'string': 'string'
                },
                'Error': {
                    'ErrorCode': 'string',
                    'Message': 'string'
                }
            },
            'KMSKeyArn': 'string',
            'TracingConfig': {
                'Mode': 'Active'|'PassThrough'
            },
            'MasterArn': 'string',
            'RevisionId': 'string'
        },
    ]
}

Response Structure

  • (dict) --

    • NextMarker (string) --

      A string, present if there are more function versions.

    • Versions (list) --

      A list of Lambda function versions.

      • (dict) --

        A Lambda function's configuration settings.

        • FunctionName (string) --

          The name of the function.

        • FunctionArn (string) --

          The function's Amazon Resource Name.

        • Runtime (string) --

          The runtime environment for the Lambda function.

        • Role (string) --

          The function's execution role.

        • Handler (string) --

          The function 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 terminating it.

        • MemorySize (integer) --

          The memory allocated to the function

        • LastModified (string) --

          The date and time that the function was last updated, in ISO-8601 format (YYYY-MM-DDThh:mm:ssTZD).

        • CodeSha256 (string) --

          The SHA256 hash of the function's deployment package.

        • Version (string) --

          The version of the Lambda function.

        • VpcConfig (dict) --

          The function's networking configuration.

          • SubnetIds (list) --

            A list of VPC subnet IDs.

            • (string) --

          • SecurityGroupIds (list) --

            A list of VPC security groups IDs.

            • (string) --

          • VpcId (string) --

            The ID of the VPC.

        • DeadLetterConfig (dict) --

          The function's dead letter queue.

          • TargetArn (string) --

            The Amazon Resource Name (ARN) of an Amazon SQS queue or Amazon SNS topic.

        • Environment (dict) --

          The function's environment variables.

          • Variables (dict) --

            Environment variable key-value pairs.

            • (string) --

              • (string) --

          • Error (dict) --

            Error messages for environment variables that could not be applied.

            • ErrorCode (string) --

              The error code.

            • Message (string) --

              The error message.

        • KMSKeyArn (string) --

          The KMS key used to encrypt the function's environment variables. 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) --

          The ARN of the master function.

        • RevisionId (string) --

          Represents the latest updated revision of the function or alias.

PublishVersion (updated) Link ¶
Changes (response)
{'Runtime': {'python3.7'}}

Publishes a version of your function from the current snapshot of $LATEST. That is, AWS Lambda takes a snapshot of the function code and configuration information from $LATEST and publishes a new version. The code and configuration cannot be modified after publication. For information about the versioning feature, see AWS Lambda Function Versioning and Aliases.

See also: AWS API Documentation

Request Syntax

client.publish_version(
    FunctionName='string',
    CodeSha256='string',
    Description='string',
    RevisionId='string'
)
type FunctionName:

string

param FunctionName:

[REQUIRED]

The name of the lambda function.

Name formats

  • Function name - MyFunction.

  • Function ARN - arn:aws:lambda:us-west-2:123456789012:function:MyFunction.

  • Partial ARN - 123456789012:function:MyFunction.

The length constraint applies only to the full ARN. If you specify only the function name, it is limited to 64 characters in length.

type CodeSha256:

string

param CodeSha256:

The SHA256 hash of the deployment package you want to publish. This provides validation on the code you are publishing. If you provide this parameter, the value must match the SHA256 of the $LATEST version for the publication to succeed. You can use the DryRun parameter of UpdateFunctionCode to verify the hash value that will be returned before publishing your new version.

type Description:

string

param Description:

The description for the version you are publishing. If not provided, AWS Lambda copies the description from the $LATEST version.

type RevisionId:

string

param RevisionId:

An optional value you can use to ensure you are updating the latest update of the function version or alias. If the RevisionID you pass doesn't match the latest RevisionId of the function or alias, it will fail with an error message, advising you retrieve the latest function version or alias RevisionID using either GetFunction or GetAlias.

rtype:

dict

returns:

Response Syntax

{
    'FunctionName': 'string',
    'FunctionArn': 'string',
    'Runtime': 'nodejs'|'nodejs4.3'|'nodejs6.10'|'nodejs8.10'|'java8'|'python2.7'|'python3.6'|'python3.7'|'dotnetcore1.0'|'dotnetcore2.0'|'dotnetcore2.1'|'nodejs4.3-edge'|'go1.x',
    'Role': 'string',
    'Handler': 'string',
    'CodeSize': 123,
    'Description': 'string',
    'Timeout': 123,
    'MemorySize': 123,
    'LastModified': 'string',
    'CodeSha256': 'string',
    'Version': 'string',
    'VpcConfig': {
        'SubnetIds': [
            'string',
        ],
        'SecurityGroupIds': [
            'string',
        ],
        'VpcId': 'string'
    },
    'DeadLetterConfig': {
        'TargetArn': 'string'
    },
    'Environment': {
        'Variables': {
            'string': 'string'
        },
        'Error': {
            'ErrorCode': 'string',
            'Message': 'string'
        }
    },
    'KMSKeyArn': 'string',
    'TracingConfig': {
        'Mode': 'Active'|'PassThrough'
    },
    'MasterArn': 'string',
    'RevisionId': 'string'
}

Response Structure

  • (dict) --

    A Lambda function's configuration settings.

    • FunctionName (string) --

      The name of the function.

    • FunctionArn (string) --

      The function's Amazon Resource Name.

    • Runtime (string) --

      The runtime environment for the Lambda function.

    • Role (string) --

      The function's execution role.

    • Handler (string) --

      The function 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 terminating it.

    • MemorySize (integer) --

      The memory allocated to the function

    • LastModified (string) --

      The date and time that the function was last updated, in ISO-8601 format (YYYY-MM-DDThh:mm:ssTZD).

    • CodeSha256 (string) --

      The SHA256 hash of the function's deployment package.

    • Version (string) --

      The version of the Lambda function.

    • VpcConfig (dict) --

      The function's networking configuration.

      • SubnetIds (list) --

        A list of VPC subnet IDs.

        • (string) --

      • SecurityGroupIds (list) --

        A list of VPC security groups IDs.

        • (string) --

      • VpcId (string) --

        The ID of the VPC.

    • DeadLetterConfig (dict) --

      The function's dead letter queue.

      • TargetArn (string) --

        The Amazon Resource Name (ARN) of an Amazon SQS queue or Amazon SNS topic.

    • Environment (dict) --

      The function's environment variables.

      • Variables (dict) --

        Environment variable key-value pairs.

        • (string) --

          • (string) --

      • Error (dict) --

        Error messages for environment variables that could not be applied.

        • ErrorCode (string) --

          The error code.

        • Message (string) --

          The error message.

    • KMSKeyArn (string) --

      The KMS key used to encrypt the function's environment variables. 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) --

      The ARN of the master function.

    • RevisionId (string) --

      Represents the latest updated revision of the function or alias.

UpdateFunctionCode (updated) Link ¶
Changes (response)
{'Runtime': {'python3.7'}}

Updates the code for the specified Lambda function. This operation must only be used on an existing Lambda function and cannot be used to update the function configuration.

If you are using the versioning feature, note this API will always update the $LATEST version of your Lambda function. For information about the versioning feature, see AWS Lambda Function Versioning and Aliases.

This operation requires permission for the lambda:UpdateFunctionCode action.

See also: AWS API Documentation

Request Syntax

client.update_function_code(
    FunctionName='string',
    ZipFile=b'bytes',
    S3Bucket='string',
    S3Key='string',
    S3ObjectVersion='string',
    Publish=True|False,
    DryRun=True|False,
    RevisionId='string'
)
type FunctionName:

string

param FunctionName:

[REQUIRED]

The name of the lambda function.

Name formats

  • Function name - MyFunction.

  • Function ARN - arn:aws:lambda:us-west-2:123456789012:function:MyFunction.

  • Partial ARN - 123456789012:function:MyFunction.

The length constraint applies only to the full ARN. If you specify only the function name, it is limited to 64 characters in length.

type ZipFile:

bytes

param ZipFile:

The contents of your zip file containing your deployment package. If you are using the web API directly, the contents of the zip file must be base64-encoded. If you are using the AWS SDKs or the AWS CLI, the SDKs or CLI will do the encoding for you. For more information about creating a .zip file, see Execution Permissions.

type S3Bucket:

string

param S3Bucket:

Amazon S3 bucket name where the .zip file containing your deployment package is stored. This bucket must reside in the same AWS Region where you are creating the Lambda function.

type S3Key:

string

param S3Key:

The Amazon S3 object (the deployment package) key name you want to upload.

type S3ObjectVersion:

string

param S3ObjectVersion:

The Amazon S3 object (the deployment package) version you want to upload.

type Publish:

boolean

param Publish:

This boolean parameter can be used to request AWS Lambda to update the Lambda function and publish a version as an atomic operation.

type DryRun:

boolean

param DryRun:

This boolean parameter can be used to test your request to AWS Lambda to update the Lambda function and publish a version as an atomic operation. It will do all necessary computation and validation of your code but will not upload it or a publish a version. Each time this operation is invoked, the CodeSha256 hash value of the provided code will also be computed and returned in the response.

type RevisionId:

string

param RevisionId:

An optional value you can use to ensure you are updating the latest update of the function version or alias. If the RevisionID you pass doesn't match the latest RevisionId of the function or alias, it will fail with an error message, advising you to retrieve the latest function version or alias RevisionID using either using using either GetFunction or GetAlias.

rtype:

dict

returns:

Response Syntax

{
    'FunctionName': 'string',
    'FunctionArn': 'string',
    'Runtime': 'nodejs'|'nodejs4.3'|'nodejs6.10'|'nodejs8.10'|'java8'|'python2.7'|'python3.6'|'python3.7'|'dotnetcore1.0'|'dotnetcore2.0'|'dotnetcore2.1'|'nodejs4.3-edge'|'go1.x',
    'Role': 'string',
    'Handler': 'string',
    'CodeSize': 123,
    'Description': 'string',
    'Timeout': 123,
    'MemorySize': 123,
    'LastModified': 'string',
    'CodeSha256': 'string',
    'Version': 'string',
    'VpcConfig': {
        'SubnetIds': [
            'string',
        ],
        'SecurityGroupIds': [
            'string',
        ],
        'VpcId': 'string'
    },
    'DeadLetterConfig': {
        'TargetArn': 'string'
    },
    'Environment': {
        'Variables': {
            'string': 'string'
        },
        'Error': {
            'ErrorCode': 'string',
            'Message': 'string'
        }
    },
    'KMSKeyArn': 'string',
    'TracingConfig': {
        'Mode': 'Active'|'PassThrough'
    },
    'MasterArn': 'string',
    'RevisionId': 'string'
}

Response Structure

  • (dict) --

    A Lambda function's configuration settings.

    • FunctionName (string) --

      The name of the function.

    • FunctionArn (string) --

      The function's Amazon Resource Name.

    • Runtime (string) --

      The runtime environment for the Lambda function.

    • Role (string) --

      The function's execution role.

    • Handler (string) --

      The function 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 terminating it.

    • MemorySize (integer) --

      The memory allocated to the function

    • LastModified (string) --

      The date and time that the function was last updated, in ISO-8601 format (YYYY-MM-DDThh:mm:ssTZD).

    • CodeSha256 (string) --

      The SHA256 hash of the function's deployment package.

    • Version (string) --

      The version of the Lambda function.

    • VpcConfig (dict) --

      The function's networking configuration.

      • SubnetIds (list) --

        A list of VPC subnet IDs.

        • (string) --

      • SecurityGroupIds (list) --

        A list of VPC security groups IDs.

        • (string) --

      • VpcId (string) --

        The ID of the VPC.

    • DeadLetterConfig (dict) --

      The function's dead letter queue.

      • TargetArn (string) --

        The Amazon Resource Name (ARN) of an Amazon SQS queue or Amazon SNS topic.

    • Environment (dict) --

      The function's environment variables.

      • Variables (dict) --

        Environment variable key-value pairs.

        • (string) --

          • (string) --

      • Error (dict) --

        Error messages for environment variables that could not be applied.

        • ErrorCode (string) --

          The error code.

        • Message (string) --

          The error message.

    • KMSKeyArn (string) --

      The KMS key used to encrypt the function's environment variables. 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) --

      The ARN of the master function.

    • RevisionId (string) --

      Represents the latest updated revision of the function or alias.

UpdateFunctionConfiguration (updated) Link ¶
Changes (both)
{'Runtime': {'python3.7'}}

Updates the configuration parameters for the specified Lambda function by using the values provided in the request. You provide only the parameters you want to change. This operation must only be used on an existing Lambda function and cannot be used to update the function's code.

If you are using the versioning feature, note this API will always update the $LATEST version of your Lambda function. For information about the versioning feature, see AWS Lambda Function Versioning and Aliases.

This operation requires permission for the lambda:UpdateFunctionConfiguration action.

See also: AWS API Documentation

Request Syntax

client.update_function_configuration(
    FunctionName='string',
    Role='string',
    Handler='string',
    Description='string',
    Timeout=123,
    MemorySize=123,
    VpcConfig={
        'SubnetIds': [
            'string',
        ],
        'SecurityGroupIds': [
            'string',
        ]
    },
    Environment={
        'Variables': {
            'string': 'string'
        }
    },
    Runtime='nodejs'|'nodejs4.3'|'nodejs6.10'|'nodejs8.10'|'java8'|'python2.7'|'python3.6'|'python3.7'|'dotnetcore1.0'|'dotnetcore2.0'|'dotnetcore2.1'|'nodejs4.3-edge'|'go1.x',
    DeadLetterConfig={
        'TargetArn': 'string'
    },
    KMSKeyArn='string',
    TracingConfig={
        'Mode': 'Active'|'PassThrough'
    },
    RevisionId='string'
)
type FunctionName:

string

param FunctionName:

[REQUIRED]

The name of the lambda function.

Name formats

  • Function name - MyFunction.

  • Function ARN - arn:aws:lambda:us-west-2:123456789012:function:MyFunction.

  • Partial ARN - 123456789012:function:MyFunction.

The length constraint applies only to the full ARN. If you specify only the function name, it is limited to 64 characters in length.

type Role:

string

param Role:

The Amazon Resource Name (ARN) of the IAM role that Lambda will assume when it executes your function.

type Handler:

string

param Handler:

The function that Lambda calls to begin executing your function. For Node.js, it is the module-name.export value in your function.

type Description:

string

param Description:

A short user-defined function description. AWS Lambda does not use this value. Assign a meaningful description as you see fit.

type Timeout:

integer

param Timeout:

The amount of time that Lambda allows a function to run before terminating it. The default is 3 seconds. The maximum allowed value is 900 seconds.

type MemorySize:

integer

param MemorySize:

The amount of memory, in MB, your Lambda function is given. AWS Lambda uses this memory size to infer the amount of CPU allocated to your function. Your function use-case determines your CPU and memory requirements. For example, a database operation might need less memory compared to an image processing function. The default value is 128 MB. The value must be a multiple of 64 MB.

type VpcConfig:

dict

param VpcConfig:

Specify security groups and subnets in a VPC to which your Lambda function needs access.

  • SubnetIds (list) --

    A list of VPC subnet IDs.

    • (string) --

  • SecurityGroupIds (list) --

    A list of VPC security groups IDs.

    • (string) --

type Environment:

dict

param Environment:

The parent object that contains your environment's configuration settings.

  • Variables (dict) --

    Environment variable key-value pairs.

    • (string) --

      • (string) --

type Runtime:

string

param Runtime:

The runtime version for the function.

type DeadLetterConfig:

dict

param DeadLetterConfig:

A dead letter queue configuration that specifies the queue or topic where Lambda sends asynchronous events when they fail processing. For more information, see Dead Letter Queues.

  • TargetArn (string) --

    The Amazon Resource Name (ARN) of an Amazon SQS queue or Amazon SNS topic.

type KMSKeyArn:

string

param KMSKeyArn:

The Amazon Resource Name (ARN) of the KMS key used to encrypt your function's environment variables. If you elect to use the AWS Lambda default service key, pass in an empty string ("") for this parameter.

type TracingConfig:

dict

param TracingConfig:

Set Mode to Active to sample and trace a subset of incoming requests with AWS X-Ray.

  • Mode (string) --

    The tracing mode.

type RevisionId:

string

param RevisionId:

An optional value you can use to ensure you are updating the latest update of the function version or alias. If the RevisionID you pass doesn't match the latest RevisionId of the function or alias, it will fail with an error message, advising you to retrieve the latest function version or alias RevisionID using either GetFunction or GetAlias.

rtype:

dict

returns:

Response Syntax

{
    'FunctionName': 'string',
    'FunctionArn': 'string',
    'Runtime': 'nodejs'|'nodejs4.3'|'nodejs6.10'|'nodejs8.10'|'java8'|'python2.7'|'python3.6'|'python3.7'|'dotnetcore1.0'|'dotnetcore2.0'|'dotnetcore2.1'|'nodejs4.3-edge'|'go1.x',
    'Role': 'string',
    'Handler': 'string',
    'CodeSize': 123,
    'Description': 'string',
    'Timeout': 123,
    'MemorySize': 123,
    'LastModified': 'string',
    'CodeSha256': 'string',
    'Version': 'string',
    'VpcConfig': {
        'SubnetIds': [
            'string',
        ],
        'SecurityGroupIds': [
            'string',
        ],
        'VpcId': 'string'
    },
    'DeadLetterConfig': {
        'TargetArn': 'string'
    },
    'Environment': {
        'Variables': {
            'string': 'string'
        },
        'Error': {
            'ErrorCode': 'string',
            'Message': 'string'
        }
    },
    'KMSKeyArn': 'string',
    'TracingConfig': {
        'Mode': 'Active'|'PassThrough'
    },
    'MasterArn': 'string',
    'RevisionId': 'string'
}

Response Structure

  • (dict) --

    A Lambda function's configuration settings.

    • FunctionName (string) --

      The name of the function.

    • FunctionArn (string) --

      The function's Amazon Resource Name.

    • Runtime (string) --

      The runtime environment for the Lambda function.

    • Role (string) --

      The function's execution role.

    • Handler (string) --

      The function 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 terminating it.

    • MemorySize (integer) --

      The memory allocated to the function

    • LastModified (string) --

      The date and time that the function was last updated, in ISO-8601 format (YYYY-MM-DDThh:mm:ssTZD).

    • CodeSha256 (string) --

      The SHA256 hash of the function's deployment package.

    • Version (string) --

      The version of the Lambda function.

    • VpcConfig (dict) --

      The function's networking configuration.

      • SubnetIds (list) --

        A list of VPC subnet IDs.

        • (string) --

      • SecurityGroupIds (list) --

        A list of VPC security groups IDs.

        • (string) --

      • VpcId (string) --

        The ID of the VPC.

    • DeadLetterConfig (dict) --

      The function's dead letter queue.

      • TargetArn (string) --

        The Amazon Resource Name (ARN) of an Amazon SQS queue or Amazon SNS topic.

    • Environment (dict) --

      The function's environment variables.

      • Variables (dict) --

        Environment variable key-value pairs.

        • (string) --

          • (string) --

      • Error (dict) --

        Error messages for environment variables that could not be applied.

        • ErrorCode (string) --

          The error code.

        • Message (string) --

          The error message.

    • KMSKeyArn (string) --

      The KMS key used to encrypt the function's environment variables. 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) --

      The ARN of the master function.

    • RevisionId (string) --

      Represents the latest updated revision of the function or alias.