AWS SDK for PHP 3.x

Service ID: lambda

Version: 2015-03-31

This page describes the parameters and results for the operations of the AWS Lambda (2015-03-31), and shows how to use the Aws\Lambda\LambdaClient object to call the described operations. This documentation is specific to the 2015-03-31 API version of the service.

Operation Summary

Each of the following operations can be created from a client using $client->getCommand('CommandName'), where "CommandName" is the name of one of the following operations. Note: a command is a value that encapsulates an operation and the parameters used to create an HTTP request.

You can also create and send a command immediately using the magic methods available on a client object: $client->commandName(/* parameters */). You can send the command asynchronously (returning a promise) by appending the word "Async" to the operation name: $client->commandNameAsync(/* parameters */).

AddPermission ( array $params = [] )
Adds a permission to the resource policy associated with the specified AWS Lambda function.
CreateAlias ( array $params = [] )
Creates an alias that points to the specified Lambda function version.
CreateEventSourceMapping ( array $params = [] )
Identifies a poll-based event source for a Lambda function.
CreateFunction ( array $params = [] )
Creates a new Lambda function.
DeleteAlias ( array $params = [] )
Deletes the specified Lambda function alias.
DeleteEventSourceMapping ( array $params = [] )
Removes an event source mapping.
DeleteFunction ( array $params = [] )
Deletes the specified Lambda function code and configuration.
DeleteFunctionConcurrency ( array $params = [] )
Removes concurrent execution limits from this function.
GetAccountSettings ( array $params = [] )
Returns a customer's account settings.
GetAlias ( array $params = [] )
Returns the specified alias information such as the alias ARN, description, and function version it is pointing to.
GetEventSourceMapping ( array $params = [] )
Returns configuration information for the specified event source mapping (see CreateEventSourceMapping).
GetFunction ( array $params = [] )
Returns the configuration information of the Lambda function and a presigned URL link to the .
GetFunctionConfiguration ( array $params = [] )
Returns the configuration information of the Lambda function.
GetPolicy ( array $params = [] )
Returns the resource policy associated with the specified Lambda function.
Invoke ( array $params = [] )
Invokes a specific Lambda function.
InvokeAsync ( array $params = [] )
This API is deprecated.
ListAliases ( array $params = [] )
Returns list of aliases created for a Lambda function.
ListEventSourceMappings ( array $params = [] )
Returns a list of event source mappings you created using the CreateEventSourceMapping (see CreateEventSourceMapping).
ListFunctions ( array $params = [] )
Returns a list of your Lambda functions.
ListTags ( array $params = [] )
Returns a list of tags assigned to a function when supplied the function ARN (Amazon Resource Name).
ListVersionsByFunction ( array $params = [] )
List all versions of a function.
PublishVersion ( array $params = [] )
Publishes a version of your function from the current snapshot of $LATEST.
PutFunctionConcurrency ( array $params = [] )
Sets a limit on the number of concurrent executions available to this function.
RemovePermission ( array $params = [] )
You can remove individual permissions from an resource policy associated with a Lambda function by providing a statement ID that you provided when you added the permission.
TagResource ( array $params = [] )
Creates a list of tags (key-value pairs) on the Lambda function.
UntagResource ( array $params = [] )
Removes tags from a Lambda function.
UpdateAlias ( array $params = [] )
Using this API you can update the function version to which the alias points and the alias description.
UpdateEventSourceMapping ( array $params = [] )
You can update an event source mapping.
UpdateFunctionCode ( array $params = [] )
Updates the code for the specified Lambda function.
UpdateFunctionConfiguration ( array $params = [] )
Updates the configuration parameters for the specified Lambda function by using the values provided in the request.

Paginators

Paginators handle automatically iterating over paginated API results. Paginators are associated with specific API operations, and they accept the parameters that the corresponding API operation accepts. You can get a paginator from a client class using getPaginator($paginatorName, $operationParameters). This client supports the following paginators:

ListEventSourceMappings
ListFunctions

Operations

AddPermission

$result = $client->addPermission([/* ... */]);
$promise = $client->addPermissionAsync([/* ... */]);

Adds a permission to the resource policy associated with the specified AWS Lambda function. You use resource policies to grant permissions to event sources that use push model. In a push model, event sources (such as Amazon S3 and custom applications) invoke your Lambda function. Each permission you add to the resource policy allows an event source, permission to invoke the Lambda function.

For information about the push model, see Lambda Functions.

If you are using versioning, the permissions you add are specific to the Lambda function version or alias you specify in the AddPermission request via the Qualifier parameter. For more information about versioning, see AWS Lambda Function Versioning and Aliases.

This operation requires permission for the lambda:AddPermission action.

Parameter Syntax

$result = $client->addPermission([
    'Action' => '<string>', // REQUIRED
    'EventSourceToken' => '<string>',
    'FunctionName' => '<string>', // REQUIRED
    'Principal' => '<string>', // REQUIRED
    'Qualifier' => '<string>',
    'RevisionId' => '<string>',
    'SourceAccount' => '<string>',
    'SourceArn' => '<string>',
    'StatementId' => '<string>', // REQUIRED
]);

Parameter Details

Members

Action

Type: string

The AWS Lambda action you want to allow in this statement. Each Lambda action is a string starting with lambda: followed by the API name . For example, lambda:CreateFunction. You can use wildcard (lambda:*) to grant permission for all AWS Lambda actions.

EventSourceToken

Type: string

A unique token that must be supplied by the principal invoking the function. This is currently only used for Alexa Smart Home functions.

FunctionName

Type: string

Name of the Lambda function whose resource policy you are updating by adding a new permission.

You can specify a function name (for example, Thumbnail) or you can specify Amazon Resource Name (ARN) of the function (for example, arn:aws:lambda:us-west-2:account-id:function:ThumbNail). AWS Lambda also allows you to specify partial ARN (for example, account-id:Thumbnail). Note that the length constraint applies only to the ARN. If you specify only the function name, it is limited to 64 characters in length.

Principal

Type: string

The principal who is getting this permission. It can be Amazon S3 service Principal (s3.amazonaws.com) if you want Amazon S3 to invoke the function, an AWS account ID if you are granting cross-account permission, or any valid AWS service principal such as sns.amazonaws.com. For example, you might want to allow a custom application in another AWS account to push events to AWS Lambda by invoking your function.

Qualifier

Type: string

You can use this optional query parameter to describe a qualified ARN using a function version or an alias name. The permission will then apply to the specific qualified ARN. For example, if you specify function version 2 as the qualifier, then permission applies only when request is made using qualified function ARN:

arn:aws:lambda:aws-region:acct-id:function:function-name:2

If you specify an alias name, for example PROD, then the permission is valid only for requests made using the alias ARN:

arn:aws:lambda:aws-region:acct-id:function:function-name:PROD

If the qualifier is not specified, the permission is valid only when requests is made using unqualified function ARN.

arn:aws:lambda:aws-region:acct-id:function:function-name

RevisionId

Type: string

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

SourceAccount

Type: string

This parameter is used for S3 and SES. The AWS account ID (without a hyphen) of the source owner. For example, if the SourceArn identifies a bucket, then this is the bucket owner's account ID. You can use this additional condition to ensure the bucket you specify is owned by a specific account (it is possible the bucket owner deleted the bucket and some other AWS account created the bucket). You can also use this condition to specify all sources (that is, you don't specify the SourceArn) owned by a specific account.

SourceArn

Type: string

This is optional; however, when granting permission to invoke your function, you should specify this field with the Amazon Resource Name (ARN) as its value. This ensures that only events generated from the specified source can invoke the function.

If you add a permission without providing the source ARN, any AWS account that creates a mapping to your function ARN can send events to invoke your Lambda function.

StatementId

Type: string

A unique statement identifier.

Result Syntax

[
    'Statement' => '<string>',
]

Result Details

Members

Statement

Type: string

The permission statement you specified in the request. The response returns the same as a string using a backslash ("\") as an escape character in the JSON.

Errors

ServiceException:
The AWS Lambda service encountered an internal error.
ResourceNotFoundException:
The resource (for example, a Lambda function or access policy statement) specified in the request does not exist.
ResourceConflictException:
The resource already exists.
InvalidParameterValueException:
One of the parameters in the request is invalid. For example, if you provided an IAM role for AWS Lambda to assume in the CreateFunction or the UpdateFunctionConfiguration API, that AWS Lambda is unable to assume you will get this exception.
PolicyLengthExceededException:
Lambda function access policy is limited to 20 KB.
TooManyRequestsException:
PreconditionFailedException:
The RevisionId provided does not match the latest RevisionId for the Lambda function or alias. Call the GetFunction or the GetAlias API to retrieve the latest RevisionId for your resource.

Examples

Example 1: add-permission

This example adds a permission for an S3 bucket to invoke a Lambda function.

$result = $client->addPermission([
    'Action' => 'lambda:InvokeFunction',
    'FunctionName' => 'MyFunction',
    'Principal' => 's3.amazonaws.com',
    'SourceAccount' => '123456789012',
    'SourceArn' => 'arn:aws:s3:::examplebucket/*',
    'StatementId' => 'ID-1',
]);

Result syntax:

[
    'Statement' => 'ID-1',
]

CreateAlias

$result = $client->createAlias([/* ... */]);
$promise = $client->createAliasAsync([/* ... */]);

Creates an alias that points to the specified Lambda function version. For more information, see Introduction to AWS Lambda Aliases.

Alias names are unique for a given function. This requires permission for the lambda:CreateAlias action.

Parameter Syntax

$result = $client->createAlias([
    'Description' => '<string>',
    'FunctionName' => '<string>', // REQUIRED
    'FunctionVersion' => '<string>', // REQUIRED
    'Name' => '<string>', // REQUIRED
    'RoutingConfig' => [
        'AdditionalVersionWeights' => [<float>, ...],
    ],
]);

Parameter Details

Members

Description

Type: string

Description of the alias.

FunctionName

Type: string

Name of the Lambda function for which you want to create an alias. Note that the length constraint applies only to the ARN. If you specify only the function name, it is limited to 64 characters in length.

FunctionVersion

Type: string

Lambda function version for which you are creating the alias.

Name

Type: string

Name for the alias you are creating.

RoutingConfig

Type: AliasRoutingConfiguration structure

Specifies an additional version your alias can point to, allowing you to dictate what percentage of traffic will invoke each version. For more information, see lambda-traffic-shifting-using-aliases.

Result Syntax

[
    'AliasArn' => '<string>',
    'Description' => '<string>',
    'FunctionVersion' => '<string>',
    'Name' => '<string>',
    'RevisionId' => '<string>',
    'RoutingConfig' => [
        'AdditionalVersionWeights' => [<float>, ...],
    ],
]

Result Details

Members

AliasArn

Type: string

Lambda function ARN that is qualified using the alias name as the suffix. For example, if you create an alias called BETA that points to a helloworld function version, the ARN is arn:aws:lambda:aws-regions:acct-id:function:helloworld:BETA.

Description

Type: string

Alias description.

FunctionVersion

Type: string

Function version to which the alias points.

Name

Type: string

Alias name.

RevisionId

Type: string

Represents the latest updated revision of the function or alias.

RoutingConfig

Type: AliasRoutingConfiguration structure

Specifies an additional function versions the alias points to, allowing you to dictate what percentage of traffic will invoke each version. For more information, see lambda-traffic-shifting-using-aliases.

Errors

ServiceException:
The AWS Lambda service encountered an internal error.
ResourceNotFoundException:
The resource (for example, a Lambda function or access policy statement) specified in the request does not exist.
ResourceConflictException:
The resource already exists.
InvalidParameterValueException:
One of the parameters in the request is invalid. For example, if you provided an IAM role for AWS Lambda to assume in the CreateFunction or the UpdateFunctionConfiguration API, that AWS Lambda is unable to assume you will get this exception.
TooManyRequestsException:

CreateEventSourceMapping

$result = $client->createEventSourceMapping([/* ... */]);
$promise = $client->createEventSourceMappingAsync([/* ... */]);

Identifies a poll-based event source for a Lambda function. It can be either an Amazon Kinesis or DynamoDB stream, or an Amazon SQS queue. AWS Lambda invokes the specified function when records are posted to the event source.

This association between a poll-based source and a Lambda function is called the event source mapping.

You provide mapping information (for example, which stream or SQS queue to read from and which Lambda function to invoke) in the request body.

Amazon Kinesis or DynamoDB stream event sources can be associated with multiple AWS Lambda functions and a given Lambda function can be associated with multiple AWS event sources. For Amazon SQS, you can configure multiple queues as event sources for a single Lambda function, but an SQS queue can be mapped only to a single Lambda function.

If you are using versioning, you can specify a specific function version or an alias via the function name parameter. For more information about versioning, see AWS Lambda Function Versioning and Aliases.

This operation requires permission for the lambda:CreateEventSourceMapping action.

Parameter Syntax

$result = $client->createEventSourceMapping([
    'BatchSize' => <integer>,
    'Enabled' => true || false,
    'EventSourceArn' => '<string>', // REQUIRED
    'FunctionName' => '<string>', // REQUIRED
    'StartingPosition' => 'TRIM_HORIZON|LATEST|AT_TIMESTAMP',
    'StartingPositionTimestamp' => <integer || string || DateTime>,
]);

Parameter Details

Members

BatchSize

Type: int

The largest number of records that AWS Lambda will retrieve from your event source at the time of invoking your function. Your function receives an event with all the retrieved records. The default for Amazon Kinesis and Amazon DynamoDB is 100 records. For SQS, the default is 1.

Enabled

Type: boolean

Indicates whether AWS Lambda should begin polling the event source. By default, Enabled is true.

EventSourceArn

Type: string

The Amazon Resource Name (ARN) of the event source. Any record added to this source could cause AWS Lambda to invoke your Lambda function, it depends on the BatchSize. AWS Lambda POSTs the event's records to your Lambda function as JSON.

FunctionName

Type: string

The Lambda function to invoke when AWS Lambda detects an event on the stream.

You can specify the function name (for example, Thumbnail) or you can specify Amazon Resource Name (ARN) of the function (for example, arn:aws:lambda:us-west-2:account-id:function:ThumbNail).

If you are using versioning, you can also provide a qualified function ARN (ARN that is qualified with function version or alias name as suffix). For more information about versioning, see AWS Lambda Function Versioning and Aliases

AWS Lambda also allows you to specify only the function name with the account ID qualifier (for example, account-id:Thumbnail).

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

StartingPosition

Type: string

The position in the DynamoDB or Kinesis stream where AWS Lambda should start reading. For more information, see GetShardIterator in the Amazon Kinesis API Reference Guide or GetShardIterator in the Amazon DynamoDB API Reference Guide. The AT_TIMESTAMP value is supported only for Kinesis streams.

StartingPositionTimestamp

Type: timestamp (string|DateTime or anything parsable by strtotime)

The timestamp of the data record from which to start reading. Used with shard iterator type AT_TIMESTAMP. If a record with this exact timestamp does not exist, the iterator returned is for the next (later) record. If the timestamp is older than the current trim horizon, the iterator returned is for the oldest untrimmed data record (TRIM_HORIZON). Valid only for Kinesis streams.

Result Syntax

[
    'BatchSize' => <integer>,
    'EventSourceArn' => '<string>',
    'FunctionArn' => '<string>',
    'LastModified' => <DateTime>,
    'LastProcessingResult' => '<string>',
    'State' => '<string>',
    'StateTransitionReason' => '<string>',
    'UUID' => '<string>',
]

Result Details

Members

BatchSize

Type: int

The largest number of records that AWS Lambda will retrieve from your event source at the time of invoking your function. Your function receives an event with all the retrieved records.

EventSourceArn

Type: string

The Amazon Resource Name (ARN) of the Amazon Kinesis or DynamoDB stream or the SQS queue that is the source of events.

FunctionArn

Type: string

The Lambda function to invoke when AWS Lambda detects an event on the poll-based source.

LastModified

Type: timestamp (string|DateTime or anything parsable by strtotime)

The UTC time string indicating the last time the event mapping was updated.

LastProcessingResult

Type: string

The result of the last AWS Lambda invocation of your Lambda function.

State

Type: string

The state of the event source mapping. It can be Creating, Enabled, Disabled, Enabling, Disabling, Updating, or Deleting.

StateTransitionReason

Type: string

The reason the event source mapping is in its current state. It is either user-requested or an AWS Lambda-initiated state transition.

UUID

Type: string

The AWS Lambda assigned opaque identifier for the mapping.

Errors

ServiceException:
The AWS Lambda service encountered an internal error.
InvalidParameterValueException:
One of the parameters in the request is invalid. For example, if you provided an IAM role for AWS Lambda to assume in the CreateFunction or the UpdateFunctionConfiguration API, that AWS Lambda is unable to assume you will get this exception.
ResourceConflictException:
The resource already exists.
TooManyRequestsException:
ResourceNotFoundException:
The resource (for example, a Lambda function or access policy statement) specified in the request does not exist.

CreateFunction

$result = $client->createFunction([/* ... */]);
$promise = $client->createFunctionAsync([/* ... */]);

Creates a new Lambda function. The function metadata is created from the request parameters, and the code for the function is provided by a .zip file in the request body. If the function name already exists, the operation will fail. Note that the function name is case-sensitive.

If you are using versioning, you can also publish a version of the Lambda function you are creating using the Publish parameter. For more information about versioning, see AWS Lambda Function Versioning and Aliases.

This operation requires permission for the lambda:CreateFunction action.

Parameter Syntax

$result = $client->createFunction([
    'Code' => [ // REQUIRED
        'S3Bucket' => '<string>',
        'S3Key' => '<string>',
        'S3ObjectVersion' => '<string>',
        'ZipFile' => <string || resource || Psr\Http\Message\StreamInterface>,
    ],
    'DeadLetterConfig' => [
        'TargetArn' => '<string>',
    ],
    'Description' => '<string>',
    'Environment' => [
        'Variables' => ['<string>', ...],
    ],
    'FunctionName' => '<string>', // REQUIRED
    'Handler' => '<string>', // REQUIRED
    'KMSKeyArn' => '<string>',
    'MemorySize' => <integer>,
    'Publish' => true || false,
    'Role' => '<string>', // REQUIRED
    'Runtime' => 'nodejs|nodejs4.3|nodejs6.10|nodejs8.10|java8|python2.7|python3.6|dotnetcore1.0|dotnetcore2.0|dotnetcore2.1|nodejs4.3-edge|go1.x', // REQUIRED
    'Tags' => ['<string>', ...],
    'Timeout' => <integer>,
    'TracingConfig' => [
        'Mode' => 'Active|PassThrough',
    ],
    'VpcConfig' => [
        'SecurityGroupIds' => ['<string>', ...],
        'SubnetIds' => ['<string>', ...],
    ],
]);

Parameter Details

Members

Code

Type: FunctionCode structure

The code for the Lambda function.

DeadLetterConfig

Type: DeadLetterConfig structure

The parent object that contains the target ARN (Amazon Resource Name) of an Amazon SQS queue or Amazon SNS topic. For more information, see dlq.

Description

Type: string

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

Environment

Type: Environment structure

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

FunctionName

Type: string

The name you want to assign to the function you are uploading. The function names appear in the console and are returned in the ListFunctions API. Function names are used to specify functions to other AWS Lambda API operations, such as Invoke. Note that the length constraint applies only to the ARN. If you specify only the function name, it is limited to 64 characters in length.

Handler

Type: string

The function within your code that Lambda calls to begin execution. For Node.js, it is the module-name.export value in your function. For Java, it can be package.class-name::handler or package.class-name. For more information, see Lambda Function Handler (Java).

KMSKeyArn

Type: string

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

MemorySize

Type: int

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

Publish

Type: boolean

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

Role

Type: string

The Amazon Resource Name (ARN) of the IAM role that Lambda assumes when it executes your function to access any other Amazon Web Services (AWS) resources. For more information, see AWS Lambda: How it Works.

Runtime

Type: string

The runtime environment for the Lambda function you are uploading.

To use the Python runtime v3.6, set the value to "python3.6". To use the Python runtime v2.7, set the value to "python2.7". To use the Node.js runtime v6.10, set the value to "nodejs6.10". To use the Node.js runtime v4.3, set the value to "nodejs4.3". To use the .NET Core runtime v1.0, set the value to "dotnetcore1.0". To use the .NET Core runtime v2.0, set the value to "dotnetcore2.0".

Node v0.10.42 is currently marked as deprecated. You must migrate existing functions to the newer Node.js runtime versions available on AWS Lambda (nodejs4.3 or nodejs6.10) as soon as possible. Failure to do so will result in an invalid parameter error being returned. Note that you will have to follow this procedure for each region that contains functions written in the Node v0.10.42 runtime.

Tags

Type: Associative array of custom strings keys (TagKey) to strings

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.

Timeout

Type: int

The function execution time at which Lambda should terminate the function. Because the execution time has cost implications, we recommend you set this value based on your expected execution time. The default is 3 seconds.

TracingConfig

Type: TracingConfig structure

The parent object that contains your function's tracing settings.

VpcConfig

Type: VpcConfig structure

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.

Result Syntax

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

Result Details

Members

CodeSha256

Type: string

It is the SHA256 hash of your function deployment package.

CodeSize

Type: long (int|float)

The size, in bytes, of the function .zip file you uploaded.

DeadLetterConfig

Type: DeadLetterConfig structure

The parent object that contains the target ARN (Amazon Resource Name) of an Amazon SQS queue or Amazon SNS topic. For more information, see dlq.

Description

Type: string

The user-provided description.

Environment

Type: EnvironmentResponse structure

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

FunctionArn

Type: string

The Amazon Resource Name (ARN) assigned to the function.

FunctionName

Type: string

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

Handler

Type: string

The function Lambda calls to begin executing your function.

KMSKeyArn

Type: string

The Amazon Resource Name (ARN) of the KMS key used to encrypt your function's environment variables. If empty, it means you are using the AWS Lambda default service key.

LastModified

Type: string

The time stamp of the last time you updated the function. The time stamp is conveyed as a string complying with ISO-8601 in this way YYYY-MM-DDThh:mm:ssTZD (e.g., 1997-07-16T19:20:30+01:00). For more information, see Date and Time Formats.

MasterArn

Type: string

Returns the ARN (Amazon Resource Name) of the master function.

MemorySize

Type: int

The memory size, in MB, you configured for the function. Must be a multiple of 64 MB.

RevisionId

Type: string

Represents the latest updated revision of the function or alias.

Role

Type: string

The Amazon Resource Name (ARN) of the IAM role that Lambda assumes when it executes your function to access any other Amazon Web Services (AWS) resources.

Runtime

Type: string

The runtime environment for the Lambda function.

Timeout

Type: int

TracingConfig

Type: TracingConfigResponse structure

The parent object that contains your function's tracing settings.

Version

Type: string

The version of the Lambda function.

VpcConfig

Type: VpcConfigResponse structure

VPC configuration associated with your Lambda function.

Errors

ServiceException:
The AWS Lambda service encountered an internal error.
InvalidParameterValueException:
One of the parameters in the request is invalid. For example, if you provided an IAM role for AWS Lambda to assume in the CreateFunction or the UpdateFunctionConfiguration API, that AWS Lambda is unable to assume you will get this exception.
ResourceNotFoundException:
The resource (for example, a Lambda function or access policy statement) specified in the request does not exist.
ResourceConflictException:
The resource already exists.
TooManyRequestsException:
CodeStorageExceededException:
You have exceeded your maximum total code size per account. Limits

Examples

Example 1: create-function

This example creates a Lambda function.

$result = $client->createFunction([
    'Code' => [
    ],
    'Description' => '',
    'FunctionName' => 'MyFunction',
    'Handler' => 'souce_file.handler_name', // is of the form of the name of your source file and then name of your function handler
    'MemorySize' => 128,
    'Publish' => 1,
    'Role' => 'arn:aws:iam::123456789012:role/service-role/role-name', // replace with the actual arn of the execution role you created
    'Runtime' => 'nodejs4.3',
    'Timeout' => 15,
    'VpcConfig' => [
    ],
]);

Result syntax:

[
    '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' => [
    ],
]

DeleteAlias

$result = $client->deleteAlias([/* ... */]);
$promise = $client->deleteAliasAsync([/* ... */]);

Deletes the specified Lambda function alias. For more information, see Introduction to AWS Lambda Aliases.

This requires permission for the lambda:DeleteAlias action.

Parameter Syntax

$result = $client->deleteAlias([
    'FunctionName' => '<string>', // REQUIRED
    'Name' => '<string>', // REQUIRED
]);

Parameter Details

Members

FunctionName

Type: string

The Lambda function name for which the alias is created. Deleting an alias does not delete the function version to which it is pointing. Note that the length constraint applies only to the ARN. If you specify only the function name, it is limited to 64 characters in length.

Name

Type: string

Name of the alias to delete.

Result Syntax

[]

Result Details

The results for this operation are always empty.

Errors

ServiceException:
The AWS Lambda service encountered an internal error.
InvalidParameterValueException:
One of the parameters in the request is invalid. For example, if you provided an IAM role for AWS Lambda to assume in the CreateFunction or the UpdateFunctionConfiguration API, that AWS Lambda is unable to assume you will get this exception.
TooManyRequestsException:

Examples

Example 1: To delete a Lambda function alias

This operation deletes a Lambda function alias

$result = $client->deleteAlias([
    'FunctionName' => 'myFunction',
    'Name' => 'alias',
]);

DeleteEventSourceMapping

$result = $client->deleteEventSourceMapping([/* ... */]);
$promise = $client->deleteEventSourceMappingAsync([/* ... */]);

Removes an event source mapping. This means AWS Lambda will no longer invoke the function for events in the associated source.

This operation requires permission for the lambda:DeleteEventSourceMapping action.

Parameter Syntax

$result = $client->deleteEventSourceMapping([
    'UUID' => '<string>', // REQUIRED
]);

Parameter Details

Members

UUID

Type: string

The event source mapping ID.

Result Syntax

[
    'BatchSize' => <integer>,
    'EventSourceArn' => '<string>',
    'FunctionArn' => '<string>',
    'LastModified' => <DateTime>,
    'LastProcessingResult' => '<string>',
    'State' => '<string>',
    'StateTransitionReason' => '<string>',
    'UUID' => '<string>',
]

Result Details

Members

BatchSize

Type: int

The largest number of records that AWS Lambda will retrieve from your event source at the time of invoking your function. Your function receives an event with all the retrieved records.

EventSourceArn

Type: string

The Amazon Resource Name (ARN) of the Amazon Kinesis or DynamoDB stream or the SQS queue that is the source of events.

FunctionArn

Type: string

The Lambda function to invoke when AWS Lambda detects an event on the poll-based source.

LastModified

Type: timestamp (string|DateTime or anything parsable by strtotime)

The UTC time string indicating the last time the event mapping was updated.

LastProcessingResult

Type: string

The result of the last AWS Lambda invocation of your Lambda function.

State

Type: string

The state of the event source mapping. It can be Creating, Enabled, Disabled, Enabling, Disabling, Updating, or Deleting.

StateTransitionReason

Type: string

The reason the event source mapping is in its current state. It is either user-requested or an AWS Lambda-initiated state transition.

UUID

Type: string

The AWS Lambda assigned opaque identifier for the mapping.

Errors

ServiceException:
The AWS Lambda service encountered an internal error.
ResourceNotFoundException:
The resource (for example, a Lambda function or access policy statement) specified in the request does not exist.
InvalidParameterValueException:
One of the parameters in the request is invalid. For example, if you provided an IAM role for AWS Lambda to assume in the CreateFunction or the UpdateFunctionConfiguration API, that AWS Lambda is unable to assume you will get this exception.
TooManyRequestsException:
ResourceInUseException:
The operation conflicts with the resource's availability. For example, you attempted to update an EventSoure Mapping in CREATING, or tried to delete a EventSoure mapping currently in the UPDATING state.

Examples

Example 1: To delete a Lambda function event source mapping

This operation deletes a Lambda function event source mapping

$result = $client->deleteEventSourceMapping([
    'UUID' => '12345kxodurf3443',
]);

Result syntax:

[
    'BatchSize' => 123,
    'EventSourceArn' => 'arn:aws:s3:::examplebucket/*',
    'FunctionArn' => 'arn:aws:lambda:us-west-2:123456789012:function:myFunction',
    'LastModified' => ,
    'LastProcessingResult' => '',
    'State' => '',
    'StateTransitionReason' => '',
    'UUID' => '12345kxodurf3443',
]

DeleteFunction

$result = $client->deleteFunction([/* ... */]);
$promise = $client->deleteFunctionAsync([/* ... */]);

Deletes the specified Lambda function code and configuration.

If you are using the versioning feature and you don't specify a function version in your DeleteFunction request, AWS Lambda will delete the function, including all its versions, and any aliases pointing to the function versions. To delete a specific function version, you must provide the function version via the Qualifier parameter. For information about function versioning, see AWS Lambda Function Versioning and Aliases.

When you delete a function the associated resource policy is also deleted. You will need to delete the event source mappings explicitly.

This operation requires permission for the lambda:DeleteFunction action.

Parameter Syntax

$result = $client->deleteFunction([
    'FunctionName' => '<string>', // REQUIRED
    'Qualifier' => '<string>',
]);

Parameter Details

Members

FunctionName

Type: string

The Lambda function to delete.

You can specify the function name (for example, Thumbnail) or you can specify Amazon Resource Name (ARN) of the function (for example, arn:aws:lambda:us-west-2:account-id:function:ThumbNail). If you are using versioning, you can also provide a qualified function ARN (ARN that is qualified with function version or alias name as suffix). AWS Lambda also allows you to specify only the function name with the account ID qualifier (for example, account-id:Thumbnail). Note that the length constraint applies only to the ARN. If you specify only the function name, it is limited to 64 characters in length.

Qualifier

Type: string

Using this optional parameter you can specify a function version (but not the $LATEST version) to direct AWS Lambda to delete a specific function version. If the function version has one or more aliases pointing to it, you will get an error because you cannot have aliases pointing to it. You can delete any function version but not the $LATEST, that is, you cannot specify $LATEST as the value of this parameter. The $LATEST version can be deleted only when you want to delete all the function versions and aliases.

You can only specify a function version, not an alias name, using this parameter. You cannot delete a function version using its alias.

If you don't specify this parameter, AWS Lambda will delete the function, including all of its versions and aliases.

Result Syntax

[]

Result Details

The results for this operation are always empty.

Errors

ServiceException:
The AWS Lambda service encountered an internal error.
ResourceNotFoundException:
The resource (for example, a Lambda function or access policy statement) specified in the request does not exist.
TooManyRequestsException:
InvalidParameterValueException:
One of the parameters in the request is invalid. For example, if you provided an IAM role for AWS Lambda to assume in the CreateFunction or the UpdateFunctionConfiguration API, that AWS Lambda is unable to assume you will get this exception.
ResourceConflictException:
The resource already exists.

Examples

Example 1: To delete a Lambda function

This operation deletes a Lambda function

$result = $client->deleteFunction([
    'FunctionName' => 'myFunction',
    'Qualifier' => '1',
]);

DeleteFunctionConcurrency

$result = $client->deleteFunctionConcurrency([/* ... */]);
$promise = $client->deleteFunctionConcurrencyAsync([/* ... */]);

Removes concurrent execution limits from this function. For more information, see concurrent-executions.

Parameter Syntax

$result = $client->deleteFunctionConcurrency([
    'FunctionName' => '<string>', // REQUIRED
]);

Parameter Details

Members

FunctionName

Type: string

The name of the function you are removing concurrent execution limits from. For more information, see concurrent-executions.

Result Syntax

[]

Result Details

The results for this operation are always empty.

Errors

ServiceException:
The AWS Lambda service encountered an internal error.
ResourceNotFoundException:
The resource (for example, a Lambda function or access policy statement) specified in the request does not exist.
TooManyRequestsException:
InvalidParameterValueException:
One of the parameters in the request is invalid. For example, if you provided an IAM role for AWS Lambda to assume in the CreateFunction or the UpdateFunctionConfiguration API, that AWS Lambda is unable to assume you will get this exception.

GetAccountSettings

$result = $client->getAccountSettings([/* ... */]);
$promise = $client->getAccountSettingsAsync([/* ... */]);

Returns a customer's account settings.

You can use this operation to retrieve Lambda limits information, such as code size and concurrency limits. For more information about limits, see AWS Lambda Limits. You can also retrieve resource usage statistics, such as code storage usage and function count.

Parameter Syntax

$result = $client->getAccountSettings([
]);

Parameter Details

Members

Result Syntax

[
    'AccountLimit' => [
        'CodeSizeUnzipped' => <integer>,
        'CodeSizeZipped' => <integer>,
        'ConcurrentExecutions' => <integer>,
        'TotalCodeSize' => <integer>,
        'UnreservedConcurrentExecutions' => <integer>,
    ],
    'AccountUsage' => [
        'FunctionCount' => <integer>,
        'TotalCodeSize' => <integer>,
    ],
]

Result Details

Members

AccountLimit

Type: AccountLimit structure

Provides limits of code size and concurrency associated with the current account and region.

AccountUsage

Type: AccountUsage structure

Provides code size usage and function count associated with the current account and region.

Errors

TooManyRequestsException:
ServiceException:
The AWS Lambda service encountered an internal error.

Examples

Example 1: To retrieves a Lambda customer's account settings

This operation retrieves a Lambda customer's account settings

$result = $client->getAccountSettings([
]);

Result syntax:

[
    'AccountLimit' => [
    ],
    'AccountUsage' => [
    ],
]

GetAlias

$result = $client->getAlias([/* ... */]);
$promise = $client->getAliasAsync([/* ... */]);

Returns the specified alias information such as the alias ARN, description, and function version it is pointing to. For more information, see Introduction to AWS Lambda Aliases.

This requires permission for the lambda:GetAlias action.

Parameter Syntax

$result = $client->getAlias([
    'FunctionName' => '<string>', // REQUIRED
    'Name' => '<string>', // REQUIRED
]);

Parameter Details

Members

FunctionName

Type: string

Function name for which the alias is created. An alias is a subresource that exists only in the context of an existing Lambda function so you must specify the function name. Note that the length constraint applies only to the ARN. If you specify only the function name, it is limited to 64 characters in length.

Name

Type: string

Name of the alias for which you want to retrieve information.

Result Syntax

[
    'AliasArn' => '<string>',
    'Description' => '<string>',
    'FunctionVersion' => '<string>',
    'Name' => '<string>',
    'RevisionId' => '<string>',
    'RoutingConfig' => [
        'AdditionalVersionWeights' => [<float>, ...],
    ],
]

Result Details

Members

AliasArn

Type: string

Description

Type: string

Alias description.

FunctionVersion

Type: string

Function version to which the alias points.

Name

Type: string

Alias name.

RevisionId

Type: string

Represents the latest updated revision of the function or alias.

RoutingConfig

Type: AliasRoutingConfiguration structure

Errors

ServiceException:
The AWS Lambda service encountered an internal error.
ResourceNotFoundException:
The resource (for example, a Lambda function or access policy statement) specified in the request does not exist.
InvalidParameterValueException:
One of the parameters in the request is invalid. For example, if you provided an IAM role for AWS Lambda to assume in the CreateFunction or the UpdateFunctionConfiguration API, that AWS Lambda is unable to assume you will get this exception.
TooManyRequestsException:

Examples

Example 1: To retrieve a Lambda function alias

This operation retrieves a Lambda function alias

$result = $client->getAlias([
    'FunctionName' => 'myFunction',
    'Name' => 'myFunctionAlias',
]);

Result syntax:

[
    'AliasArn' => 'arn:aws:lambda:us-west-2:123456789012:function:myFunctionAlias',
    'Description' => '',
    'FunctionVersion' => '1',
    'Name' => 'myFunctionAlias',
]

GetEventSourceMapping

$result = $client->getEventSourceMapping([/* ... */]);
$promise = $client->getEventSourceMappingAsync([/* ... */]);

Returns configuration information for the specified event source mapping (see CreateEventSourceMapping).

This operation requires permission for the lambda:GetEventSourceMapping action.

Parameter Syntax

$result = $client->getEventSourceMapping([
    'UUID' => '<string>', // REQUIRED
]);

Parameter Details

Members

UUID

Type: string

The AWS Lambda assigned ID of the event source mapping.

Result Syntax

[
    'BatchSize' => <integer>,
    'EventSourceArn' => '<string>',
    'FunctionArn' => '<string>',
    'LastModified' => <DateTime>,
    'LastProcessingResult' => '<string>',
    'State' => '<string>',
    'StateTransitionReason' => '<string>',
    'UUID' => '<string>',
]

Result Details

Members

BatchSize

Type: int

The largest number of records that AWS Lambda will retrieve from your event source at the time of invoking your function. Your function receives an event with all the retrieved records.

EventSourceArn

Type: string

The Amazon Resource Name (ARN) of the Amazon Kinesis or DynamoDB stream or the SQS queue that is the source of events.

FunctionArn

Type: string

The Lambda function to invoke when AWS Lambda detects an event on the poll-based source.

LastModified

Type: timestamp (string|DateTime or anything parsable by strtotime)

The UTC time string indicating the last time the event mapping was updated.

LastProcessingResult

Type: string

The result of the last AWS Lambda invocation of your Lambda function.

State

Type: string

The state of the event source mapping. It can be Creating, Enabled, Disabled, Enabling, Disabling, Updating, or Deleting.

StateTransitionReason

Type: string

The reason the event source mapping is in its current state. It is either user-requested or an AWS Lambda-initiated state transition.

UUID

Type: string

The AWS Lambda assigned opaque identifier for the mapping.

Errors

ServiceException:
The AWS Lambda service encountered an internal error.
ResourceNotFoundException:
The resource (for example, a Lambda function or access policy statement) specified in the request does not exist.
InvalidParameterValueException:
One of the parameters in the request is invalid. For example, if you provided an IAM role for AWS Lambda to assume in the CreateFunction or the UpdateFunctionConfiguration API, that AWS Lambda is unable to assume you will get this exception.
TooManyRequestsException:

Examples

Example 1: To retrieve a Lambda function's event source mapping

This operation retrieves a Lambda function's event source mapping

$result = $client->getEventSourceMapping([
    'UUID' => '123489-xxxxx-kdla8d89d7',
]);

Result syntax:

[
    'BatchSize' => 123,
    'EventSourceArn' => 'arn:aws:iam::123456789012:eventsource',
    'FunctionArn' => 'arn:aws:lambda:us-west-2:123456789012:function:myFunction',
    'LastModified' => ,
    'LastProcessingResult' => '',
    'State' => '',
    'StateTransitionReason' => '',
    'UUID' => '123489-xxxxx-kdla8d89d7',
]

GetFunction

$result = $client->getFunction([/* ... */]);
$promise = $client->getFunctionAsync([/* ... */]);

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

Using the optional Qualifier parameter, you can specify a specific function version for which you want this information. If you don't specify this parameter, the API uses unqualified function ARN which return information about the $LATEST version of the Lambda function. For more information, see AWS Lambda Function Versioning and Aliases.

This operation requires permission for the lambda:GetFunction action.

Parameter Syntax

$result = $client->getFunction([
    'FunctionName' => '<string>', // REQUIRED
    'Qualifier' => '<string>',
]);

Parameter Details

Members

FunctionName

Type: string

The Lambda function name.

You can specify a function name (for example, Thumbnail) or you can specify Amazon Resource Name (ARN) of the function (for example, arn:aws:lambda:us-west-2:account-id:function:ThumbNail). AWS Lambda also allows you to specify a partial ARN (for example, account-id:Thumbnail). Note that the length constraint applies only to the ARN. If you specify only the function name, it is limited to 64 characters in length.

Qualifier

Type: string

Use this optional parameter to specify a function version or an alias name. If you specify function version, the API uses qualified function ARN for the request and returns information about the specific Lambda function version. If you specify an alias name, the API uses the alias ARN and returns information about the function version to which the alias points. If you don't provide this parameter, the API uses unqualified function ARN and returns information about the $LATEST version of the Lambda function.

Result Syntax

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

Result Details

Members

Code

Type: FunctionCodeLocation structure

The object for the Lambda function location.

Concurrency

Type: Concurrency structure

The concurrent execution limit set for this function. For more information, see concurrent-executions.

Configuration

Type: FunctionConfiguration structure

A complex type that describes function metadata.

Tags

Type: Associative array of custom strings keys (TagKey) to strings

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

Errors

ServiceException:
The AWS Lambda service encountered an internal error.
ResourceNotFoundException:
The resource (for example, a Lambda function or access policy statement) specified in the request does not exist.
TooManyRequestsException:
InvalidParameterValueException:
One of the parameters in the request is invalid. For example, if you provided an IAM role for AWS Lambda to assume in the CreateFunction or the UpdateFunctionConfiguration API, that AWS Lambda is unable to assume you will get this exception.

Examples

Example 1: To retrieve a Lambda function's event source mapping

This operation retrieves a Lambda function's event source mapping

$result = $client->getFunction([
    'FunctionName' => 'myFunction',
    'Qualifier' => '1',
]);

Result syntax:

[
    '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' => [
            ],
        ],
    ],
]

GetFunctionConfiguration

$result = $client->getFunctionConfiguration([/* ... */]);
$promise = $client->getFunctionConfigurationAsync([/* ... */]);

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.

Parameter Syntax

$result = $client->getFunctionConfiguration([
    'FunctionName' => '<string>', // REQUIRED
    'Qualifier' => '<string>',
]);

Parameter Details

Members

FunctionName

Type: string

The name of the Lambda function for which you want to retrieve the configuration information.

You can specify a function name (for example, Thumbnail) or you can specify Amazon Resource Name (ARN) of the function (for example, arn:aws:lambda:us-west-2:account-id:function:ThumbNail). AWS Lambda also allows you to specify a partial ARN (for example, account-id:Thumbnail). Note that the length constraint applies only to the ARN. If you specify only the function name, it is limited to 64 characters in length.

Qualifier

Type: string

Using this optional parameter you can specify a function version or an alias name. If you specify function version, the API uses qualified function ARN and returns information about the specific function version. If you specify an alias name, the API uses the alias ARN and returns information about the function version to which the alias points.

If you don't specify this parameter, the API uses unqualified function ARN, and returns information about the $LATEST function version.

Result Syntax

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

Result Details

Members

CodeSha256

Type: string

It is the SHA256 hash of your function deployment package.

CodeSize

Type: long (int|float)

The size, in bytes, of the function .zip file you uploaded.

DeadLetterConfig

Type: DeadLetterConfig structure

The parent object that contains the target ARN (Amazon Resource Name) of an Amazon SQS queue or Amazon SNS topic. For more information, see dlq.

Description

Type: string

The user-provided description.

Environment

Type: EnvironmentResponse structure

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

FunctionArn

Type: string

The Amazon Resource Name (ARN) assigned to the function.

FunctionName

Type: string

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

Handler

Type: string

The function Lambda calls to begin executing your function.

KMSKeyArn

Type: string

The Amazon Resource Name (ARN) of the KMS key used to encrypt your function's environment variables. If empty, it means you are using the AWS Lambda default service key.

LastModified

Type: string

MasterArn

Type: string

Returns the ARN (Amazon Resource Name) of the master function.

MemorySize

Type: int

The memory size, in MB, you configured for the function. Must be a multiple of 64 MB.

RevisionId

Type: string

Represents the latest updated revision of the function or alias.

Role

Type: string

The Amazon Resource Name (ARN) of the IAM role that Lambda assumes when it executes your function to access any other Amazon Web Services (AWS) resources.

Runtime

Type: string

The runtime environment for the Lambda function.

Timeout

Type: int

TracingConfig

Type: TracingConfigResponse structure

The parent object that contains your function's tracing settings.

Version

Type: string

The version of the Lambda function.

VpcConfig

Type: VpcConfigResponse structure

VPC configuration associated with your Lambda function.

Errors

ServiceException:
The AWS Lambda service encountered an internal error.
ResourceNotFoundException:
The resource (for example, a Lambda function or access policy statement) specified in the request does not exist.
TooManyRequestsException:
InvalidParameterValueException:
One of the parameters in the request is invalid. For example, if you provided an IAM role for AWS Lambda to assume in the CreateFunction or the UpdateFunctionConfiguration API, that AWS Lambda is unable to assume you will get this exception.

Examples

Example 1: To retrieve a Lambda function's event source mapping

This operation retrieves a Lambda function's event source mapping

$result = $client->getFunctionConfiguration([
    'FunctionName' => 'myFunction',
    'Qualifier' => '1',
]);

Result syntax:

[
    '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' => [
    ],
]

GetPolicy

$result = $client->getPolicy([/* ... */]);
$promise = $client->getPolicyAsync([/* ... */]);

Returns the resource policy associated with the specified Lambda function.

If you are using the versioning feature, you can get the resource policy associated with the specific Lambda function version or alias by specifying the version or alias name using the Qualifier parameter. For more information about versioning, see AWS Lambda Function Versioning and Aliases.

You need permission for the lambda:GetPolicy action.

Parameter Syntax

$result = $client->getPolicy([
    'FunctionName' => '<string>', // REQUIRED
    'Qualifier' => '<string>',
]);

Parameter Details

Members

FunctionName

Type: string

Function name whose resource policy you want to retrieve.

Qualifier

Type: string

You can specify this optional query parameter to specify a function version or an alias name in which case this API will return all permissions associated with the specific qualified ARN. If you don't provide this parameter, the API will return permissions that apply to the unqualified function ARN.

Result Syntax

[
    'Policy' => '<string>',
    'RevisionId' => '<string>',
]

Result Details

Members

Policy

Type: string

The resource policy associated with the specified function. The response returns the same as a string using a backslash ("\") as an escape character in the JSON.

RevisionId

Type: string

Represents the latest updated revision of the function or alias.

Errors

ServiceException:
The AWS Lambda service encountered an internal error.
ResourceNotFoundException:
The resource (for example, a Lambda function or access policy statement) specified in the request does not exist.
TooManyRequestsException:
InvalidParameterValueException:
One of the parameters in the request is invalid. For example, if you provided an IAM role for AWS Lambda to assume in the CreateFunction or the UpdateFunctionConfiguration API, that AWS Lambda is unable to assume you will get this exception.

Examples

Example 1: To retrieve a Lambda function policy

This operation retrieves a Lambda function policy

$result = $client->getPolicy([
    'FunctionName' => 'myFunction',
    'Qualifier' => '1',
]);

Result syntax:

[
    'Policy' => '',
]

Invoke

$result = $client->invoke([/* ... */]);
$promise = $client->invokeAsync([/* ... */]);

Invokes a specific Lambda function. For an example, see Create the Lambda Function and Test It Manually.

If you are using the versioning feature, you can invoke the specific function version by providing function version or alias name that is pointing to the function version using the Qualifier parameter in the request. If you don't provide the Qualifier parameter, the $LATEST version of the Lambda function is invoked. Invocations occur at least once in response to an event and functions must be idempotent to handle this. For information about the versioning feature, see AWS Lambda Function Versioning and Aliases.

This operation requires permission for the lambda:InvokeFunction action.

The TooManyRequestsException noted below will return the following: ConcurrentInvocationLimitExceeded will be returned if you have no functions with reserved concurrency and have exceeded your account concurrent limit or if a function without reserved concurrency exceeds the account's unreserved concurrency limit. ReservedFunctionConcurrentInvocationLimitExceeded will be returned when a function with reserved concurrency exceeds its configured concurrency limit.

Parameter Syntax

$result = $client->invoke([
    'ClientContext' => '<string>',
    'FunctionName' => '<string>', // REQUIRED
    'InvocationType' => 'Event|RequestResponse|DryRun',
    'LogType' => 'None|Tail',
    'Payload' => <string || resource || Psr\Http\Message\StreamInterface>,
    'Qualifier' => '<string>',
]);

Parameter Details

Members

ClientContext

Type: string

Using the ClientContext you can pass client-specific information to the Lambda function you are invoking. You can then process the client information in your Lambda function as you choose through the context variable. For an example of a ClientContext JSON, see PutEvents in the Amazon Mobile Analytics API Reference and User Guide.

The ClientContext JSON must be base64-encoded and has a maximum size of 3583 bytes.

FunctionName

Type: string

The Lambda function name.

You can specify a function name (for example, Thumbnail) or you can specify Amazon Resource Name (ARN) of the function (for example, arn:aws:lambda:us-west-2:account-id:function:ThumbNail). AWS Lambda also allows you to specify a partial ARN (for example, account-id:Thumbnail). Note that the length constraint applies only to the ARN. If you specify only the function name, it is limited to 64 characters in length.

InvocationType

Type: string

By default, the Invoke API assumes RequestResponse invocation type. You can optionally request asynchronous execution by specifying Event as the InvocationType. You can also use this parameter to request AWS Lambda to not execute the function but do some verification, such as if the caller is authorized to invoke the function and if the inputs are valid. You request this by specifying DryRun as the InvocationType. This is useful in a cross-account scenario when you want to verify access to a function without running it.

LogType

Type: string

You can set this optional parameter to Tail in the request only if you specify the InvocationType parameter with value RequestResponse. In this case, AWS Lambda returns the base64-encoded last 4 KB of log data produced by your Lambda function in the x-amz-log-result header.

Payload

Type: blob (string|resource|Psr\Http\Message\StreamInterface)

JSON that you want to provide to your Lambda function as input.

Qualifier

Type: string

You can use this optional parameter to specify a Lambda function version or alias name. If you specify a function version, the API uses the qualified function ARN to invoke a specific Lambda function. If you specify an alias name, the API uses the alias ARN to invoke the Lambda function version to which the alias points.

If you don't provide this parameter, then the API uses unqualified function ARN which results in invocation of the $LATEST version.

Result Syntax

[
    'ExecutedVersion' => '<string>',
    'FunctionError' => '<string>',
    'LogResult' => '<string>',
    'Payload' => <string || resource || Psr\Http\Message\StreamInterface>,
    'StatusCode' => <integer>,
]

Result Details

Members

ExecutedVersion

Type: string

The function version that has been executed. This value is returned only if the invocation type is RequestResponse. For more information, see lambda-traffic-shifting-using-aliases.

FunctionError

Type: string

Indicates whether an error occurred while executing the Lambda function. If an error occurred this field will have one of two values; Handled or Unhandled. Handled errors are errors that are reported by the function while the Unhandled errors are those detected and reported by AWS Lambda. Unhandled errors include out of memory errors and function timeouts. For information about how to report an Handled error, see Programming Model.

LogResult

Type: string

It is the base64-encoded logs for the Lambda function invocation. This is present only if the invocation type is RequestResponse and the logs were requested.

Payload

Type: blob (string|resource|Psr\Http\Message\StreamInterface)

It is the JSON representation of the object returned by the Lambda function. This is present only if the invocation type is RequestResponse.

In the event of a function error this field contains a message describing the error. For the Handled errors the Lambda function will report this message. For Unhandled errors AWS Lambda reports the message.

StatusCode

Type: int

The HTTP status code will be in the 200 range for successful request. For the RequestResponse invocation type this status code will be 200. For the Event invocation type this status code will be 202. For the DryRun invocation type the status code will be 204.

Errors

ServiceException:
The AWS Lambda service encountered an internal error.
ResourceNotFoundException:
The resource (for example, a Lambda function or access policy statement) specified in the request does not exist.
InvalidRequestContentException:
The request body could not be parsed as JSON.
RequestTooLargeException:
The request payload exceeded the Invoke request body JSON input limit. For more information, see Limits.
UnsupportedMediaTypeException:
The content type of the Invoke request body is not JSON.
TooManyRequestsException:
InvalidParameterValueException:
One of the parameters in the request is invalid. For example, if you provided an IAM role for AWS Lambda to assume in the CreateFunction or the UpdateFunctionConfiguration API, that AWS Lambda is unable to assume you will get this exception.
EC2UnexpectedException:
AWS Lambda received an unexpected EC2 client exception while setting up for the Lambda function.
SubnetIPAddressLimitReachedException:
AWS Lambda was not able to set up VPC access for the Lambda function because one or more configured subnets has no available IP addresses.
ENILimitReachedException:
AWS Lambda was not able to create an Elastic Network Interface (ENI) in the VPC, specified as part of Lambda function configuration, because the limit for network interfaces has been reached.
EC2ThrottledException:
AWS Lambda was throttled by Amazon EC2 during Lambda function initialization using the execution role provided for the Lambda function.
EC2AccessDeniedException:
InvalidSubnetIDException:
The Subnet ID provided in the Lambda function VPC configuration is invalid.
InvalidSecurityGroupIDException:
The Security Group ID provided in the Lambda function VPC configuration is invalid.
InvalidZipFileException:
AWS Lambda could not unzip the function zip file.
KMSDisabledException:
Lambda was unable to decrypt the environment variables because the KMS key used is disabled. Check the Lambda function's KMS key settings.
KMSInvalidStateException:
Lambda was unable to decrypt the environment variables because the KMS key used is in an invalid state for Decrypt. Check the function's KMS key settings.
KMSAccessDeniedException:
Lambda was unable to decrypt the environment variables because KMS access was denied. Check the Lambda function's KMS permissions.
KMSNotFoundException:
Lambda was unable to decrypt the environment variables because the KMS key was not found. Check the function's KMS key settings.
InvalidRuntimeException:
The runtime or runtime version specified is not supported.

Examples

Example 1: To invoke a Lambda function

This operation invokes a Lambda function

$result = $client->invoke([
    'ClientContext' => 'MyApp',
    'FunctionName' => 'MyFunction',
    'InvocationType' => 'Event',
    'LogType' => 'Tail',
    'Payload' => ,
    'Qualifier' => '1',
]);

Result syntax:

[
    'FunctionError' => '',
    'LogResult' => '',
    'Payload' => ,
    'StatusCode' => 123,
]

InvokeAsync

$result = $client->invokeAsync([/* ... */]);
$promise = $client->invokeAsyncAsync([/* ... */]);

This API is deprecated. We recommend you use Invoke API (see Invoke).

Submits an invocation request to AWS Lambda. Upon receiving the request, Lambda executes the specified function asynchronously. To see the logs generated by the Lambda function execution, see the CloudWatch Logs console.

This operation requires permission for the lambda:InvokeFunction action.

Parameter Syntax

$result = $client->invokeAsync([
    'FunctionName' => '<string>', // REQUIRED
    'InvokeArgs' => <string || resource || Psr\Http\Message\StreamInterface>, // REQUIRED
]);

Parameter Details

Members

FunctionName

Type: string

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

InvokeArgs

Type: blob (string|resource|Psr\Http\Message\StreamInterface)

JSON that you want to provide to your Lambda function as input.

Result Syntax

[
    'Status' => <integer>,
]

Result Details

Members

Status

Type: int

It will be 202 upon success.

Errors

ServiceException:
The AWS Lambda service encountered an internal error.
ResourceNotFoundException:
The resource (for example, a Lambda function or access policy statement) specified in the request does not exist.
InvalidRequestContentException:
The request body could not be parsed as JSON.
InvalidRuntimeException:
The runtime or runtime version specified is not supported.

Examples

Example 1: To invoke a Lambda function asynchronously

This operation invokes a Lambda function asynchronously

$result = $client->invokeAsync([
    'FunctionName' => 'myFunction',
    'InvokeArgs' => ,
]);

Result syntax:

[
    'Status' => 123,
]

ListAliases

$result = $client->listAliases([/* ... */]);
$promise = $client->listAliasesAsync([/* ... */]);

Returns list of aliases created for a Lambda function. For each alias, the response includes information such as the alias ARN, description, alias name, and the function version to which it points. For more information, see Introduction to AWS Lambda Aliases.

This requires permission for the lambda:ListAliases action.

Parameter Syntax

$result = $client->listAliases([
    'FunctionName' => '<string>', // REQUIRED
    'FunctionVersion' => '<string>',
    'Marker' => '<string>',
    'MaxItems' => <integer>,
]);

Parameter Details

Members

FunctionName

Type: string

Lambda function name for which the alias is created. Note that the length constraint applies only to the ARN. If you specify only the function name, it is limited to 64 characters in length.

FunctionVersion

Type: string

If you specify this optional parameter, the API returns only the aliases that are pointing to the specific Lambda function version, otherwise the API returns all of the aliases created for the Lambda function.

Marker

Type: string

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

MaxItems

Type: int

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

Result Syntax

[
    'Aliases' => [
        [
            'AliasArn' => '<string>',
            'Description' => '<string>',
            'FunctionVersion' => '<string>',
            'Name' => '<string>',
            'RevisionId' => '<string>',
            'RoutingConfig' => [
                'AdditionalVersionWeights' => [<float>, ...],
            ],
        ],
        // ...
    ],
    'NextMarker' => '<string>',
]

Result Details

Members

Aliases

Type: Array of AliasConfiguration structures

A list of aliases.

NextMarker

Type: string

A string, present if there are more aliases.

Errors

ServiceException:
The AWS Lambda service encountered an internal error.
ResourceNotFoundException:
The resource (for example, a Lambda function or access policy statement) specified in the request does not exist.
InvalidParameterValueException:
One of the parameters in the request is invalid. For example, if you provided an IAM role for AWS Lambda to assume in the CreateFunction or the UpdateFunctionConfiguration API, that AWS Lambda is unable to assume you will get this exception.
TooManyRequestsException:

Examples

Example 1: To retrieve a Lambda function aliases

This operation retrieves a Lambda function's aliases

$result = $client->listAliases([
    'FunctionName' => 'myFunction',
    'FunctionVersion' => '1',
    'Marker' => '',
    'MaxItems' => 123,
]);

Result syntax:

[
    'Aliases' => [
    ],
    'NextMarker' => '',
]

ListEventSourceMappings

$result = $client->listEventSourceMappings([/* ... */]);
$promise = $client->listEventSourceMappingsAsync([/* ... */]);

Returns a list of event source mappings you created using the CreateEventSourceMapping (see CreateEventSourceMapping).

For each mapping, the API returns configuration information. You can optionally specify filters to retrieve specific event source mappings.

If you are using the versioning feature, you can get list of event source mappings for a specific Lambda function version or an alias as described in the FunctionName parameter. For information about the versioning feature, see AWS Lambda Function Versioning and Aliases.

This operation requires permission for the lambda:ListEventSourceMappings action.

Parameter Syntax

$result = $client->listEventSourceMappings([
    'EventSourceArn' => '<string>',
    'FunctionName' => '<string>',
    'Marker' => '<string>',
    'MaxItems' => <integer>,
]);

Parameter Details

Members

EventSourceArn

Type: string

The Amazon Resource Name (ARN) of the Amazon Kinesis or DynamoDB stream, or an SQS queue. (This parameter is optional.)

FunctionName

Type: string

The name of the Lambda function.

Marker

Type: string

Optional string. An opaque pagination token returned from a previous ListEventSourceMappings operation. If present, specifies to continue the list from where the returning call left off.

MaxItems

Type: int

Optional integer. Specifies the maximum number of event sources to return in response. This value must be greater than 0.

Result Syntax

[
    'EventSourceMappings' => [
        [
            'BatchSize' => <integer>,
            'EventSourceArn' => '<string>',
            'FunctionArn' => '<string>',
            'LastModified' => <DateTime>,
            'LastProcessingResult' => '<string>',
            'State' => '<string>',
            'StateTransitionReason' => '<string>',
            'UUID' => '<string>',
        ],
        // ...
    ],
    'NextMarker' => '<string>',
]

Result Details

Members

EventSourceMappings

Type: Array of EventSourceMappingConfiguration structures

An array of EventSourceMappingConfiguration objects.

NextMarker

Type: string

A string, present if there are more event source mappings.

Errors

ServiceException:
The AWS Lambda service encountered an internal error.
ResourceNotFoundException:
The resource (for example, a Lambda function or access policy statement) specified in the request does not exist.
InvalidParameterValueException:
One of the parameters in the request is invalid. For example, if you provided an IAM role for AWS Lambda to assume in the CreateFunction or the UpdateFunctionConfiguration API, that AWS Lambda is unable to assume you will get this exception.
TooManyRequestsException:

ListFunctions

$result = $client->listFunctions([/* ... */]);
$promise = $client->listFunctionsAsync([/* ... */]);

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.

Parameter Syntax

$result = $client->listFunctions([
    'FunctionVersion' => 'ALL',
    'Marker' => '<string>',
    'MasterRegion' => '<string>',
    'MaxItems' => <integer>,
]);

Parameter Details

Members

FunctionVersion

Type: string

Optional string. If not specified, only the unqualified functions ARNs (Amazon Resource Names) will be returned.

Valid value:

ALL: Will return all versions, including $LATEST which will have fully qualified ARNs (Amazon Resource Names).

Marker

Type: string

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

MasterRegion

Type: string

Optional string. If not specified, will return only regular function versions (i.e., non-replicated versions).

Valid values are:

The region from which the functions are replicated. For example, if you specify us-east-1, only functions replicated from that region will be returned.

ALL: Will return all functions from any region. If specified, you also must specify a valid FunctionVersion parameter.

MaxItems

Type: int

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

Result Syntax

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

Result Details

Members

Functions

Type: Array of FunctionConfiguration structures

A list of Lambda functions.

NextMarker

Type: string

A string, present if there are more functions.

Errors

ServiceException:
The AWS Lambda service encountered an internal error.
TooManyRequestsException:
InvalidParameterValueException:
One of the parameters in the request is invalid. For example, if you provided an IAM role for AWS Lambda to assume in the CreateFunction or the UpdateFunctionConfiguration API, that AWS Lambda is unable to assume you will get this exception.

Examples

Example 1: To retrieve a list of Lambda functions

This operation retrieves a Lambda functions

$result = $client->listFunctions([
    'Marker' => '',
    'MaxItems' => 123,
]);

Result syntax:

[
    'Functions' => [
    ],
    'NextMarker' => '',
]

$result = $client->listTags([/* ... */]);
$promise = $client->listTagsAsync([/* ... */]);

Returns a list of tags assigned to a function when supplied the function ARN (Amazon Resource Name). For more information on Tagging, see Tagging Lambda Functions in the AWS Lambda Developer Guide.

Parameter Syntax

$result = $client->listTags([
    'Resource' => '<string>', // REQUIRED
]);

Parameter Details

Members

Resource

Type: string

The ARN (Amazon Resource Name) of the function. For more information, see Tagging Lambda Functions in the AWS Lambda Developer Guide.

Result Syntax

[
    'Tags' => ['<string>', ...],
]

Result Details

Members

Tags

Type: Associative array of custom strings keys (TagKey) to strings

The list of tags assigned to the function. For more information, see Tagging Lambda Functions in the AWS Lambda Developer Guide.

Errors

ServiceException:
The AWS Lambda service encountered an internal error.
ResourceNotFoundException:
The resource (for example, a Lambda function or access policy statement) specified in the request does not exist.
InvalidParameterValueException:
One of the parameters in the request is invalid. For example, if you provided an IAM role for AWS Lambda to assume in the CreateFunction or the UpdateFunctionConfiguration API, that AWS Lambda is unable to assume you will get this exception.
TooManyRequestsException:

ListVersionsByFunction

$result = $client->listVersionsByFunction([/* ... */]);
$promise = $client->listVersionsByFunctionAsync([/* ... */]);

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

Parameter Syntax

$result = $client->listVersionsByFunction([
    'FunctionName' => '<string>', // REQUIRED
    'Marker' => '<string>',
    'MaxItems' => <integer>,
]);

Parameter Details

Members

FunctionName

Type: string

Function name whose versions to list. You can specify a function name (for example, Thumbnail) or you can specify Amazon Resource Name (ARN) of the function (for example, arn:aws:lambda:us-west-2:account-id:function:ThumbNail). AWS Lambda also allows you to specify a partial ARN (for example, account-id:Thumbnail). Note that the length constraint applies only to the ARN. If you specify only the function name, it is limited to 64 characters in length.

Marker

Type: string

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

MaxItems

Type: int

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

Result Syntax

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

Result Details

Members

NextMarker

Type: string

A string, present if there are more function versions.

Versions

Type: Array of FunctionConfiguration structures

A list of Lambda function versions.

Errors

ServiceException:
The AWS Lambda service encountered an internal error.
ResourceNotFoundException:
The resource (for example, a Lambda function or access policy statement) specified in the request does not exist.
InvalidParameterValueException:
One of the parameters in the request is invalid. For example, if you provided an IAM role for AWS Lambda to assume in the CreateFunction or the UpdateFunctionConfiguration API, that AWS Lambda is unable to assume you will get this exception.
TooManyRequestsException:

Examples

Example 1: To retrieve a list of Lambda function versions

This operation retrieves a Lambda function versions

$result = $client->listVersionsByFunction([
    'FunctionName' => 'myFunction',
    'Marker' => '',
    'MaxItems' => 123,
]);

Result syntax:

[
    'NextMarker' => '',
    'Versions' => [
    ],
]

PublishVersion

$result = $client->publishVersion([/* ... */]);
$promise = $client->publishVersionAsync([/* ... */]);

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.

Parameter Syntax

$result = $client->publishVersion([
    'CodeSha256' => '<string>',
    'Description' => '<string>',
    'FunctionName' => '<string>', // REQUIRED
    'RevisionId' => '<string>',
]);

Parameter Details

Members

CodeSha256

Type: string

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

Description

Type: string

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

FunctionName

Type: string

The Lambda function name. You can specify a function name (for example, Thumbnail) or you can specify Amazon Resource Name (ARN) of the function (for example, arn:aws:lambda:us-west-2:account-id:function:ThumbNail). AWS Lambda also allows you to specify a partial ARN (for example, account-id:Thumbnail). Note that the length constraint applies only to the ARN. If you specify only the function name, it is limited to 64 characters in length.

RevisionId

Type: string

Result Syntax

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

Result Details

Members

CodeSha256

Type: string

It is the SHA256 hash of your function deployment package.

CodeSize

Type: long (int|float)

The size, in bytes, of the function .zip file you uploaded.

DeadLetterConfig

Type: DeadLetterConfig structure

The parent object that contains the target ARN (Amazon Resource Name) of an Amazon SQS queue or Amazon SNS topic. For more information, see dlq.

Description

Type: string

The user-provided description.

Environment

Type: EnvironmentResponse structure

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

FunctionArn

Type: string

The Amazon Resource Name (ARN) assigned to the function.

FunctionName

Type: string

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

Handler

Type: string

The function Lambda calls to begin executing your function.

KMSKeyArn

Type: string

The Amazon Resource Name (ARN) of the KMS key used to encrypt your function's environment variables. If empty, it means you are using the AWS Lambda default service key.

LastModified

Type: string

MasterArn

Type: string

Returns the ARN (Amazon Resource Name) of the master function.

MemorySize

Type: int

The memory size, in MB, you configured for the function. Must be a multiple of 64 MB.

RevisionId

Type: string

Represents the latest updated revision of the function or alias.

Role

Type: string

The Amazon Resource Name (ARN) of the IAM role that Lambda assumes when it executes your function to access any other Amazon Web Services (AWS) resources.

Runtime

Type: string

The runtime environment for the Lambda function.

Timeout

Type: int

TracingConfig

Type: TracingConfigResponse structure

The parent object that contains your function's tracing settings.

Version

Type: string

The version of the Lambda function.

VpcConfig

Type: VpcConfigResponse structure

VPC configuration associated with your Lambda function.

Errors

ServiceException:
The AWS Lambda service encountered an internal error.
ResourceNotFoundException:
The resource (for example, a Lambda function or access policy statement) specified in the request does not exist.
InvalidParameterValueException:
One of the parameters in the request is invalid. For example, if you provided an IAM role for AWS Lambda to assume in the CreateFunction or the UpdateFunctionConfiguration API, that AWS Lambda is unable to assume you will get this exception.
TooManyRequestsException:
CodeStorageExceededException:
You have exceeded your maximum total code size per account. Limits
PreconditionFailedException:
The RevisionId provided does not match the latest RevisionId for the Lambda function or alias. Call the GetFunction or the GetAlias API to retrieve the latest RevisionId for your resource.

Examples

Example 1: To publish a version of a Lambda function

This operation publishes a version of a Lambda function

$result = $client->publishVersion([
    'CodeSha256' => '',
    'Description' => '',
    'FunctionName' => 'myFunction',
]);

Result syntax:

[
    'CodeSha256' => '',
    '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' => [
    ],
]

PutFunctionConcurrency

$result = $client->putFunctionConcurrency([/* ... */]);
$promise = $client->putFunctionConcurrencyAsync([/* ... */]);

Sets a limit on the number of concurrent executions available to this function. It is a subset of your account's total concurrent execution limit per region. Note that Lambda automatically reserves a buffer of 100 concurrent executions for functions without any reserved concurrency limit. This means if your account limit is 1000, you have a total of 900 available to allocate to individual functions. For more information, see concurrent-executions.

Parameter Syntax

$result = $client->putFunctionConcurrency([
    'FunctionName' => '<string>', // REQUIRED
    'ReservedConcurrentExecutions' => <integer>, // REQUIRED
]);

Parameter Details

Members

FunctionName

Type: string

The name of the function you are setting concurrent execution limits on. For more information, see concurrent-executions.

ReservedConcurrentExecutions

Type: int

The concurrent execution limit reserved for this function. For more information, see concurrent-executions.

Result Syntax

[
    'ReservedConcurrentExecutions' => <integer>,
]

Result Details

Members

ReservedConcurrentExecutions

Type: int

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

Errors

ServiceException:
The AWS Lambda service encountered an internal error.
InvalidParameterValueException:
One of the parameters in the request is invalid. For example, if you provided an IAM role for AWS Lambda to assume in the CreateFunction or the UpdateFunctionConfiguration API, that AWS Lambda is unable to assume you will get this exception.
ResourceNotFoundException:
The resource (for example, a Lambda function or access policy statement) specified in the request does not exist.
TooManyRequestsException:

RemovePermission

$result = $client->removePermission([/* ... */]);
$promise = $client->removePermissionAsync([/* ... */]);

You can remove individual permissions from an resource policy associated with a Lambda function by providing a statement ID that you provided when you added the permission.

If you are using versioning, the permissions you remove are specific to the Lambda function version or alias you specify in the AddPermission request via the Qualifier parameter. For more information about versioning, see AWS Lambda Function Versioning and Aliases.

Note that removal of a permission will cause an active event source to lose permission to the function.

You need permission for the lambda:RemovePermission action.

Parameter Syntax

$result = $client->removePermission([
    'FunctionName' => '<string>', // REQUIRED
    'Qualifier' => '<string>',
    'RevisionId' => '<string>',
    'StatementId' => '<string>', // REQUIRED
]);

Parameter Details

Members

FunctionName

Type: string

Lambda function whose resource policy you want to remove a permission from.

You can specify a function name (for example, Thumbnail) or you can specify Amazon Resource Name (ARN) of the function (for example, arn:aws:lambda:us-west-2:account-id:function:ThumbNail). AWS Lambda also allows you to specify a partial ARN (for example, account-id:Thumbnail). Note that the length constraint applies only to the ARN. If you specify only the function name, it is limited to 64 characters in length.

Qualifier

Type: string

You can specify this optional parameter to remove permission associated with a specific function version or function alias. If you don't specify this parameter, the API removes permission associated with the unqualified function ARN.

RevisionId

Type: string

StatementId

Type: string

Statement ID of the permission to remove.

Result Syntax

[]

Result Details

The results for this operation are always empty.

Errors

ServiceException:
The AWS Lambda service encountered an internal error.
ResourceNotFoundException:
The resource (for example, a Lambda function or access policy statement) specified in the request does not exist.
InvalidParameterValueException:
One of the parameters in the request is invalid. For example, if you provided an IAM role for AWS Lambda to assume in the CreateFunction or the UpdateFunctionConfiguration API, that AWS Lambda is unable to assume you will get this exception.
TooManyRequestsException:
PreconditionFailedException:
The RevisionId provided does not match the latest RevisionId for the Lambda function or alias. Call the GetFunction or the GetAlias API to retrieve the latest RevisionId for your resource.

Examples

Example 1: To remove a Lambda function's permissions

This operation removes a Lambda function's permissions

$result = $client->removePermission([
    'FunctionName' => 'myFunction',
    'Qualifier' => '1',
    'StatementId' => 'role-statement-id',
]);

TagResource

$result = $client->tagResource([/* ... */]);
$promise = $client->tagResourceAsync([/* ... */]);

Creates a list of tags (key-value pairs) on the Lambda function. Requires the Lambda function ARN (Amazon Resource Name). If a key is specified without a value, Lambda creates a tag with the specified key and a value of null. For more information, see Tagging Lambda Functions in the AWS Lambda Developer Guide.

Parameter Syntax

$result = $client->tagResource([
    'Resource' => '<string>', // REQUIRED
    'Tags' => ['<string>', ...], // REQUIRED
]);

Parameter Details

Members

Resource

Type: string

The ARN (Amazon Resource Name) of the Lambda function. For more information, see Tagging Lambda Functions in the AWS Lambda Developer Guide.

Tags

Type: Associative array of custom strings keys (TagKey) to strings

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

Result Syntax

[]

Result Details

The results for this operation are always empty.

Errors

ServiceException:
The AWS Lambda service encountered an internal error.
ResourceNotFoundException:
The resource (for example, a Lambda function or access policy statement) specified in the request does not exist.
InvalidParameterValueException:
One of the parameters in the request is invalid. For example, if you provided an IAM role for AWS Lambda to assume in the CreateFunction or the UpdateFunctionConfiguration API, that AWS Lambda is unable to assume you will get this exception.
TooManyRequestsException:

UntagResource

$result = $client->untagResource([/* ... */]);
$promise = $client->untagResourceAsync([/* ... */]);

Removes tags from a Lambda function. Requires the function ARN (Amazon Resource Name). For more information, see Tagging Lambda Functions in the AWS Lambda Developer Guide.

Parameter Syntax

$result = $client->untagResource([
    'Resource' => '<string>', // REQUIRED
    'TagKeys' => ['<string>', ...], // REQUIRED
]);

Parameter Details

Members

Resource

Type: string

The ARN (Amazon Resource Name) of the function. For more information, see Tagging Lambda Functions in the AWS Lambda Developer Guide.

TagKeys

Type: Array of strings

The list of tag keys to be deleted from the function. For more information, see Tagging Lambda Functions in the AWS Lambda Developer Guide.

Result Syntax

[]

Result Details

The results for this operation are always empty.

Errors

ServiceException:
The AWS Lambda service encountered an internal error.
ResourceNotFoundException:
The resource (for example, a Lambda function or access policy statement) specified in the request does not exist.
InvalidParameterValueException:
One of the parameters in the request is invalid. For example, if you provided an IAM role for AWS Lambda to assume in the CreateFunction or the UpdateFunctionConfiguration API, that AWS Lambda is unable to assume you will get this exception.
TooManyRequestsException:

UpdateAlias

$result = $client->updateAlias([/* ... */]);
$promise = $client->updateAliasAsync([/* ... */]);

Using this API you can update the function version to which the alias points and the alias description. For more information, see Introduction to AWS Lambda Aliases.

This requires permission for the lambda:UpdateAlias action.

Parameter Syntax

$result = $client->updateAlias([
    'Description' => '<string>',
    'FunctionName' => '<string>', // REQUIRED
    'FunctionVersion' => '<string>',
    'Name' => '<string>', // REQUIRED
    'RevisionId' => '<string>',
    'RoutingConfig' => [
        'AdditionalVersionWeights' => [<float>, ...],
    ],
]);

Parameter Details

Members

Description

Type: string

You can change the description of the alias using this parameter.

FunctionName

Type: string

The function name for which the alias is created. Note that the length constraint applies only to the ARN. If you specify only the function name, it is limited to 64 characters in length.

FunctionVersion

Type: string

Using this parameter you can change the Lambda function version to which the alias points.

Name

Type: string

The alias name.

RevisionId

Type: string

RoutingConfig

Type: AliasRoutingConfiguration structure

Specifies an additional version your alias can point to, allowing you to dictate what percentage of traffic will invoke each version. For more information, see lambda-traffic-shifting-using-aliases.

Result Syntax

[
    'AliasArn' => '<string>',
    'Description' => '<string>',
    'FunctionVersion' => '<string>',
    'Name' => '<string>',
    'RevisionId' => '<string>',
    'RoutingConfig' => [
        'AdditionalVersionWeights' => [<float>, ...],
    ],
]

Result Details

Members

AliasArn

Type: string

Description

Type: string

Alias description.

FunctionVersion

Type: string

Function version to which the alias points.

Name

Type: string

Alias name.

RevisionId

Type: string

Represents the latest updated revision of the function or alias.

RoutingConfig

Type: AliasRoutingConfiguration structure

Errors

ServiceException:
The AWS Lambda service encountered an internal error.
ResourceNotFoundException:
The resource (for example, a Lambda function or access policy statement) specified in the request does not exist.
InvalidParameterValueException:
One of the parameters in the request is invalid. For example, if you provided an IAM role for AWS Lambda to assume in the CreateFunction or the UpdateFunctionConfiguration API, that AWS Lambda is unable to assume you will get this exception.
TooManyRequestsException:
PreconditionFailedException:
The RevisionId provided does not match the latest RevisionId for the Lambda function or alias. Call the GetFunction or the GetAlias API to retrieve the latest RevisionId for your resource.

Examples

Example 1: To update a Lambda function alias

This operation updates a Lambda function alias

$result = $client->updateAlias([
    'Description' => '',
    'FunctionName' => 'myFunction',
    'FunctionVersion' => '1',
    'Name' => 'functionAlias',
]);

Result syntax:

[
    'AliasArn' => 'arn:aws:lambda:us-west-2:123456789012:function:functionAlias',
    'Description' => '',
    'FunctionVersion' => '1',
    'Name' => 'functionAlias',
]

UpdateEventSourceMapping

$result = $client->updateEventSourceMapping([/* ... */]);
$promise = $client->updateEventSourceMappingAsync([/* ... */]);

You can update an event source mapping. This is useful if you want to change the parameters of the existing mapping without losing your position in the stream. You can change which function will receive the stream records, but to change the stream itself, you must create a new mapping.

If you are using the versioning feature, you can update the event source mapping to map to a specific Lambda function version or alias as described in the FunctionName parameter. For information about the versioning feature, see AWS Lambda Function Versioning and Aliases.

If you disable the event source mapping, AWS Lambda stops polling. If you enable again, it will resume polling from the time it had stopped polling, so you don't lose processing of any records. However, if you delete event source mapping and create it again, it will reset.

This operation requires permission for the lambda:UpdateEventSourceMapping action.

Parameter Syntax

$result = $client->updateEventSourceMapping([
    'BatchSize' => <integer>,
    'Enabled' => true || false,
    'FunctionName' => '<string>',
    'UUID' => '<string>', // REQUIRED
]);

Parameter Details

Members

BatchSize

Type: int

The maximum number of stream records that can be sent to your Lambda function for a single invocation.

Enabled

Type: boolean

Specifies whether AWS Lambda should actively poll the stream or not. If disabled, AWS Lambda will not poll the stream.

FunctionName

Type: string

The Lambda function to which you want the stream records sent.

You can specify a function name (for example, Thumbnail) or you can specify Amazon Resource Name (ARN) of the function (for example, arn:aws:lambda:us-west-2:account-id:function:ThumbNail). AWS Lambda also allows you to specify a partial ARN (for example, account-id:Thumbnail). Note that the length constraint applies only to the ARN. If you specify only the function name, it is limited to 64 characters in length.

Note that the length constraint applies only to the ARN. If you specify only the function name, it is limited to 64 character in length.

UUID

Type: string

The event source mapping identifier.

Result Syntax

[
    'BatchSize' => <integer>,
    'EventSourceArn' => '<string>',
    'FunctionArn' => '<string>',
    'LastModified' => <DateTime>,
    'LastProcessingResult' => '<string>',
    'State' => '<string>',
    'StateTransitionReason' => '<string>',
    'UUID' => '<string>',
]

Result Details

Members

BatchSize

Type: int

The largest number of records that AWS Lambda will retrieve from your event source at the time of invoking your function. Your function receives an event with all the retrieved records.

EventSourceArn

Type: string

The Amazon Resource Name (ARN) of the Amazon Kinesis or DynamoDB stream or the SQS queue that is the source of events.

FunctionArn

Type: string

The Lambda function to invoke when AWS Lambda detects an event on the poll-based source.

LastModified

Type: timestamp (string|DateTime or anything parsable by strtotime)

The UTC time string indicating the last time the event mapping was updated.

LastProcessingResult

Type: string

The result of the last AWS Lambda invocation of your Lambda function.

State

Type: string

The state of the event source mapping. It can be Creating, Enabled, Disabled, Enabling, Disabling, Updating, or Deleting.

StateTransitionReason

Type: string

The reason the event source mapping is in its current state. It is either user-requested or an AWS Lambda-initiated state transition.

UUID

Type: string

The AWS Lambda assigned opaque identifier for the mapping.

Errors

ServiceException:
The AWS Lambda service encountered an internal error.
ResourceNotFoundException:
The resource (for example, a Lambda function or access policy statement) specified in the request does not exist.
InvalidParameterValueException:
One of the parameters in the request is invalid. For example, if you provided an IAM role for AWS Lambda to assume in the CreateFunction or the UpdateFunctionConfiguration API, that AWS Lambda is unable to assume you will get this exception.
TooManyRequestsException:
ResourceConflictException:
The resource already exists.
ResourceInUseException:
The operation conflicts with the resource's availability. For example, you attempted to update an EventSoure Mapping in CREATING, or tried to delete a EventSoure mapping currently in the UPDATING state.

Examples

Example 1: To update a Lambda function event source mapping

This operation updates a Lambda function event source mapping

$result = $client->updateEventSourceMapping([
    'BatchSize' => 123,
    'Enabled' => 1,
    'FunctionName' => 'myFunction',
    'UUID' => '1234xCy789012',
]);

Result syntax:

[
    'BatchSize' => 123,
    'EventSourceArn' => 'arn:aws:s3:::examplebucket/*',
    'FunctionArn' => 'arn:aws:lambda:us-west-2:123456789012:function:myFunction',
    'LastModified' => ,
    'LastProcessingResult' => '',
    'State' => '',
    'StateTransitionReason' => '',
    'UUID' => '1234xCy789012',
]

UpdateFunctionCode

$result = $client->updateFunctionCode([/* ... */]);
$promise = $client->updateFunctionCodeAsync([/* ... */]);

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.

Parameter Syntax

$result = $client->updateFunctionCode([
    'DryRun' => true || false,
    'FunctionName' => '<string>', // REQUIRED
    'Publish' => true || false,
    'RevisionId' => '<string>',
    'S3Bucket' => '<string>',
    'S3Key' => '<string>',
    'S3ObjectVersion' => '<string>',
    'ZipFile' => <string || resource || Psr\Http\Message\StreamInterface>,
]);

Parameter Details

Members

DryRun

Type: boolean

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

FunctionName

Type: string

The existing Lambda function name whose code you want to replace.

You can specify a function name (for example, Thumbnail) or you can specify Amazon Resource Name (ARN) of the function (for example, arn:aws:lambda:us-west-2:account-id:function:ThumbNail). AWS Lambda also allows you to specify a partial ARN (for example, account-id:Thumbnail). Note that the length constraint applies only to the ARN. If you specify only the function name, it is limited to 64 characters in length.

Publish

Type: boolean

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

RevisionId

Type: string

S3Bucket

Type: string

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

S3Key

Type: string

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

S3ObjectVersion

Type: string

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

ZipFile

Type: blob (string|resource|Psr\Http\Message\StreamInterface)

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.

Result Syntax

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

Result Details

Members

CodeSha256

Type: string

It is the SHA256 hash of your function deployment package.

CodeSize

Type: long (int|float)

The size, in bytes, of the function .zip file you uploaded.

DeadLetterConfig

Type: DeadLetterConfig structure

The parent object that contains the target ARN (Amazon Resource Name) of an Amazon SQS queue or Amazon SNS topic. For more information, see dlq.

Description

Type: string

The user-provided description.

Environment

Type: EnvironmentResponse structure

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

FunctionArn

Type: string

The Amazon Resource Name (ARN) assigned to the function.

FunctionName

Type: string

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

Handler

Type: string

The function Lambda calls to begin executing your function.

KMSKeyArn

Type: string

The Amazon Resource Name (ARN) of the KMS key used to encrypt your function's environment variables. If empty, it means you are using the AWS Lambda default service key.

LastModified

Type: string

MasterArn

Type: string

Returns the ARN (Amazon Resource Name) of the master function.

MemorySize

Type: int

The memory size, in MB, you configured for the function. Must be a multiple of 64 MB.

RevisionId

Type: string

Represents the latest updated revision of the function or alias.

Role

Type: string

The Amazon Resource Name (ARN) of the IAM role that Lambda assumes when it executes your function to access any other Amazon Web Services (AWS) resources.

Runtime

Type: string

The runtime environment for the Lambda function.

Timeout

Type: int

TracingConfig

Type: TracingConfigResponse structure

The parent object that contains your function's tracing settings.

Version

Type: string

The version of the Lambda function.

VpcConfig

Type: VpcConfigResponse structure

VPC configuration associated with your Lambda function.

Errors

ServiceException:
The AWS Lambda service encountered an internal error.
ResourceNotFoundException:
The resource (for example, a Lambda function or access policy statement) specified in the request does not exist.
InvalidParameterValueException:
One of the parameters in the request is invalid. For example, if you provided an IAM role for AWS Lambda to assume in the CreateFunction or the UpdateFunctionConfiguration API, that AWS Lambda is unable to assume you will get this exception.
TooManyRequestsException:
CodeStorageExceededException:
You have exceeded your maximum total code size per account. Limits
PreconditionFailedException:
The RevisionId provided does not match the latest RevisionId for the Lambda function or alias. Call the GetFunction or the GetAlias API to retrieve the latest RevisionId for your resource.

Examples

Example 1: To update a Lambda function's code

This operation updates a Lambda function's code

$result = $client->updateFunctionCode([
    'FunctionName' => 'myFunction',
    'Publish' => 1,
    'S3Bucket' => 'myBucket',
    'S3Key' => 'myKey',
    'S3ObjectVersion' => '1',
    'ZipFile' => ,
]);

Result syntax:

[
    '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' => [
    ],
]

UpdateFunctionConfiguration

$result = $client->updateFunctionConfiguration([/* ... */]);
$promise = $client->updateFunctionConfigurationAsync([/* ... */]);

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.

This operation requires permission for the lambda:UpdateFunctionConfiguration action.

Parameter Syntax

$result = $client->updateFunctionConfiguration([
    'DeadLetterConfig' => [
        'TargetArn' => '<string>',
    ],
    'Description' => '<string>',
    'Environment' => [
        'Variables' => ['<string>', ...],
    ],
    'FunctionName' => '<string>', // REQUIRED
    'Handler' => '<string>',
    'KMSKeyArn' => '<string>',
    'MemorySize' => <integer>,
    'RevisionId' => '<string>',
    'Role' => '<string>',
    'Runtime' => 'nodejs|nodejs4.3|nodejs6.10|nodejs8.10|java8|python2.7|python3.6|dotnetcore1.0|dotnetcore2.0|dotnetcore2.1|nodejs4.3-edge|go1.x',
    'Timeout' => <integer>,
    'TracingConfig' => [
        'Mode' => 'Active|PassThrough',
    ],
    'VpcConfig' => [
        'SecurityGroupIds' => ['<string>', ...],
        'SubnetIds' => ['<string>', ...],
    ],
]);

Parameter Details

Members

DeadLetterConfig

Type: DeadLetterConfig structure

The parent object that contains the target ARN (Amazon Resource Name) of an Amazon SQS queue or Amazon SNS topic. For more information, see dlq.

Description

Type: string

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

Environment

Type: Environment structure

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

FunctionName

Type: string

The name of the Lambda function.

You can specify a function name (for example, Thumbnail) or you can specify Amazon Resource Name (ARN) of the function (for example, arn:aws:lambda:us-west-2:account-id:function:ThumbNail). AWS Lambda also allows you to specify a partial ARN (for example, account-id:Thumbnail). Note that the length constraint applies only to the ARN. If you specify only the function name, it is limited to 64 character in length.

Handler

Type: string

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

KMSKeyArn

Type: string

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

MemorySize

Type: int

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.

RevisionId

Type: string

Role

Type: string

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

Runtime

Type: string

The runtime environment for the Lambda function.

Timeout

Type: int

The function execution time at which AWS Lambda should terminate the function. Because the execution time has cost implications, we recommend you set this value based on your expected execution time. The default is 3 seconds.

TracingConfig

Type: TracingConfig structure

The parent object that contains your function's tracing settings.

VpcConfig

Type: VpcConfig structure

Result Syntax

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

Result Details

Members

CodeSha256

Type: string

It is the SHA256 hash of your function deployment package.

CodeSize

Type: long (int|float)

The size, in bytes, of the function .zip file you uploaded.

DeadLetterConfig

Type: DeadLetterConfig structure

The parent object that contains the target ARN (Amazon Resource Name) of an Amazon SQS queue or Amazon SNS topic. For more information, see dlq.

Description

Type: string

The user-provided description.

Environment

Type: EnvironmentResponse structure

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

FunctionArn

Type: string

The Amazon Resource Name (ARN) assigned to the function.

FunctionName

Type: string

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

Handler

Type: string

The function Lambda calls to begin executing your function.

KMSKeyArn

Type: string

The Amazon Resource Name (ARN) of the KMS key used to encrypt your function's environment variables. If empty, it means you are using the AWS Lambda default service key.

LastModified

Type: string

MasterArn

Type: string

Returns the ARN (Amazon Resource Name) of the master function.

MemorySize

Type: int

The memory size, in MB, you configured for the function. Must be a multiple of 64 MB.

RevisionId

Type: string

Represents the latest updated revision of the function or alias.

Role

Type: string

The Amazon Resource Name (ARN) of the IAM role that Lambda assumes when it executes your function to access any other Amazon Web Services (AWS) resources.

Runtime

Type: string

The runtime environment for the Lambda function.

Timeout

Type: int

TracingConfig

Type: TracingConfigResponse structure

The parent object that contains your function's tracing settings.

Version

Type: string

The version of the Lambda function.

VpcConfig

Type: VpcConfigResponse structure

VPC configuration associated with your Lambda function.

Errors

ServiceException:
The AWS Lambda service encountered an internal error.
ResourceNotFoundException:
The resource (for example, a Lambda function or access policy statement) specified in the request does not exist.
InvalidParameterValueException:
One of the parameters in the request is invalid. For example, if you provided an IAM role for AWS Lambda to assume in the CreateFunction or the UpdateFunctionConfiguration API, that AWS Lambda is unable to assume you will get this exception.
TooManyRequestsException:
ResourceConflictException:
The resource already exists.
PreconditionFailedException:
The RevisionId provided does not match the latest RevisionId for the Lambda function or alias. Call the GetFunction or the GetAlias API to retrieve the latest RevisionId for your resource.

Examples

Example 1: To update a Lambda function's configuration

This operation updates a Lambda function's configuration

$result = $client->updateFunctionConfiguration([
    'Description' => '',
    'FunctionName' => 'myFunction',
    'Handler' => 'index.handler',
    'MemorySize' => 128,
    'Role' => 'arn:aws:iam::123456789012:role/lambda_basic_execution',
    'Runtime' => 'python2.7',
    'Timeout' => 123,
    'VpcConfig' => [
    ],
]);

Result syntax:

[
    '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' => [
    ],
]

Shapes

AccountLimit

Description

Provides limits of code size and concurrency associated with the current account and region.

Members

CodeSizeUnzipped

Type: long (int|float)

Size, in bytes, of code/dependencies that you can zip into a deployment package (uncompressed zip/jar size) for uploading. The default limit is 250 MB.

CodeSizeZipped

Type: long (int|float)

Size, in bytes, of a single zipped code/dependencies package you can upload for your Lambda function(.zip/.jar file). Try using Amazon S3 for uploading larger files. Default limit is 50 MB.

ConcurrentExecutions

Type: int

Number of simultaneous executions of your function per region. For more information or to request a limit increase for concurrent executions, see Lambda Function Concurrent Executions. The default limit is 1000.

TotalCodeSize

Type: long (int|float)

Maximum size, in bytes, of a code package you can upload per region. The default size is 75 GB.

UnreservedConcurrentExecutions

Type: int

The number of concurrent executions available to functions that do not have concurrency limits set. For more information, see concurrent-executions.

AccountUsage

Description

Provides code size usage and function count associated with the current account and region.

Members

FunctionCount

Type: long (int|float)

The number of your account's existing functions per region.

TotalCodeSize

Type: long (int|float)

Total size, in bytes, of the account's deployment packages per region.

AliasRoutingConfiguration

Description

The parent object that implements what percentage of traffic will invoke each function version. For more information, see lambda-traffic-shifting-using-aliases.

Members

AdditionalVersionWeights

Type: Associative array of custom strings keys (AdditionalVersion) to doubles

Set this value to dictate what percentage of traffic will invoke the updated function version. If set to an empty string, 100 percent of traffic will invoke function-version. For more information, see lambda-traffic-shifting-using-aliases.

CodeStorageExceededException

Description

You have exceeded your maximum total code size per account. Limits

Members

Type

Type: string

message

Type: string

DeadLetterConfig

Description

The Amazon Resource Name (ARN) of an Amazon SQS queue or Amazon SNS topic you specify as your Dead Letter Queue (DLQ). For more information, see dlq.

Members

TargetArn

Type: string

The Amazon Resource Name (ARN) of an Amazon SQS queue or Amazon SNS topic you specify as your Dead Letter Queue (DLQ). dlq. For more information, see dlq.

EC2AccessDeniedException

Description

Members

Message

Type: string

Type

Type: string

EC2ThrottledException

Description

AWS Lambda was throttled by Amazon EC2 during Lambda function initialization using the execution role provided for the Lambda function.

Members

Message

Type: string

Type

Type: string

EC2UnexpectedException

Description

AWS Lambda received an unexpected EC2 client exception while setting up for the Lambda function.

Members

EC2ErrorCode

Type: string

Message

Type: string

Type

Type: string

ENILimitReachedException

Description

AWS Lambda was not able to create an Elastic Network Interface (ENI) in the VPC, specified as part of Lambda function configuration, because the limit for network interfaces has been reached.

Members

Message

Type: string

Type

Type: string

Environment

Description

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

Members

Variables

Type: Associative array of custom strings keys (EnvironmentVariableName) to strings

The key-value pairs that represent your environment's configuration settings.

EnvironmentError

Description

The parent object that contains error information associated with your configuration settings.

Members

ErrorCode

Type: string

The error code returned by the environment error object.

Message

Type: string

The message returned by the environment error object.

EnvironmentResponse

Description

The parent object returned that contains your environment's configuration settings or any error information associated with your configuration settings.

Members

Error

Type: EnvironmentError structure

The parent object that contains error information associated with your configuration settings.

Variables

Type: Associative array of custom strings keys (EnvironmentVariableName) to strings

The key-value pairs returned that represent your environment's configuration settings or error information.

FunctionCode

Description

The code for the Lambda function.

Members

S3Bucket

Type: string

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

S3Key

Type: string

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

S3ObjectVersion

Type: string

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

ZipFile

Type: blob (string|resource|Psr\Http\Message\StreamInterface)

FunctionCodeLocation

Description

The object for the Lambda function location.

Members

Location

Type: 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.

RepositoryType

Type: string

The repository from which you can download the function.

InvalidParameterValueException

Description

One of the parameters in the request is invalid. For example, if you provided an IAM role for AWS Lambda to assume in the CreateFunction or the UpdateFunctionConfiguration API, that AWS Lambda is unable to assume you will get this exception.

Members

Type

Type: string

message

Type: string

InvalidRequestContentException

Description

The request body could not be parsed as JSON.

Members

Type

Type: string

message

Type: string

InvalidRuntimeException

Description

The runtime or runtime version specified is not supported.

Members

Message

Type: string

Type

Type: string

InvalidSecurityGroupIDException

Description

The Security Group ID provided in the Lambda function VPC configuration is invalid.

Members

Message

Type: string

Type

Type: string

InvalidSubnetIDException

Description

The Subnet ID provided in the Lambda function VPC configuration is invalid.

Members

Message

Type: string

Type

Type: string

InvalidZipFileException

Description

AWS Lambda could not unzip the function zip file.

Members

Message

Type: string

Type

Type: string

KMSAccessDeniedException

Description

Lambda was unable to decrypt the environment variables because KMS access was denied. Check the Lambda function's KMS permissions.

Members

Message

Type: string

Type

Type: string

KMSDisabledException

Description

Lambda was unable to decrypt the environment variables because the KMS key used is disabled. Check the Lambda function's KMS key settings.

Members

Message

Type: string

Type

Type: string

KMSInvalidStateException

Description

Lambda was unable to decrypt the environment variables because the KMS key used is in an invalid state for Decrypt. Check the function's KMS key settings.

Members

Message

Type: string

Type

Type: string

KMSNotFoundException

Description

Lambda was unable to decrypt the environment variables because the KMS key was not found. Check the function's KMS key settings.

Members

Message

Type: string

Type

Type: string

PolicyLengthExceededException

Description

Lambda function access policy is limited to 20 KB.

Members

Type

Type: string

message

Type: string

PreconditionFailedException

Description

The RevisionId provided does not match the latest RevisionId for the Lambda function or alias. Call the GetFunction or the GetAlias API to retrieve the latest RevisionId for your resource.

Members

Type

Type: string

message

Type: string

RequestTooLargeException

Description

The request payload exceeded the Invoke request body JSON input limit. For more information, see Limits.

Members

Type

Type: string

message

Type: string

ResourceConflictException

Description

The resource already exists.

Members

Type

Type: string

message

Type: string

ResourceInUseException

Description

The operation conflicts with the resource's availability. For example, you attempted to update an EventSoure Mapping in CREATING, or tried to delete a EventSoure mapping currently in the UPDATING state.

Members

Message

Type: string

Type

Type: string

ResourceNotFoundException

Description

The resource (for example, a Lambda function or access policy statement) specified in the request does not exist.

Members

Message

Type: string

Type

Type: string

ServiceException

Description

The AWS Lambda service encountered an internal error.

Members

Message

Type: string

Type

Type: string

SubnetIPAddressLimitReachedException

Description

AWS Lambda was not able to set up VPC access for the Lambda function because one or more configured subnets has no available IP addresses.

Members

Message

Type: string

Type

Type: string

TooManyRequestsException

Description

Members

Reason

Type: string

Type

Type: string

message

Type: string

retryAfterSeconds

Type: string

The number of seconds the caller should wait before retrying.

TracingConfig

Description

The parent object that contains your function's tracing settings.

Members

Mode

Type: string

Can be either PassThrough or Active. If PassThrough, Lambda will only trace the request from an upstream service if it contains a tracing header with "sampled=1". If Active, Lambda will respect any tracing header it receives from an upstream service. If no tracing header is received, Lambda will call X-Ray for a tracing decision.

TracingConfigResponse

Description

Parent object of the tracing information associated with your Lambda function.

Members

Mode

Type: string

The tracing mode associated with your Lambda function.

UnsupportedMediaTypeException

Description

The content type of the Invoke request body is not JSON.

Members

Type

Type: string

message

Type: string

VpcConfig

Description

Members

SecurityGroupIds

Type: Array of strings

A list of one or more security groups IDs in your VPC.

SubnetIds

Type: Array of strings

A list of one or more subnet IDs in your VPC.

VpcConfigResponse

Description

VPC configuration associated with your Lambda function.

Members

SecurityGroupIds

Type: Array of strings

A list of security group IDs associated with the Lambda function.

SubnetIds

Type: Array of strings

A list of subnet IDs associated with the Lambda function.

VpcId

Type: string

The VPC ID associated with you Lambda function.

Namespaces

Classes

Interfaces

Traits

Exceptions

Functions

AWS Lambda 2015-03-31

Operation Summary

Paginators

Operations

AddPermission

Parameter Syntax

Parameter Details

Members

Result Syntax

Result Details

Members

Errors

Examples

Example 1: add-permission

CreateAlias

Parameter Syntax

Parameter Details

Members

Result Syntax

Result Details

Members

Errors

CreateEventSourceMapping

Parameter Syntax

Parameter Details

Members

Result Syntax

Result Details

Members

Errors

CreateFunction

Parameter Syntax

Parameter Details

Members

Result Syntax

Result Details

Members

Errors

Examples

Example 1: create-function

DeleteAlias

Parameter Syntax

Parameter Details

Members

Result Syntax

Result Details

Errors

Examples

Example 1: To delete a Lambda function alias

DeleteEventSourceMapping

Parameter Syntax

Parameter Details

Members

Result Syntax

Result Details

Members

Errors

Examples

Example 1: To delete a Lambda function event source mapping

DeleteFunction

Parameter Syntax

Parameter Details

Members

Result Syntax

Result Details

Errors

Examples

Example 1: To delete a Lambda function

DeleteFunctionConcurrency

Parameter Syntax

Parameter Details

Members

Result Syntax

Result Details