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 */).

AddLayerVersionPermission ( array $params = [] )
Adds permissions to the resource-based policy of a version of a function layer.
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 = [] )
Creates a mapping between an event source and an AWS Lambda function.
CreateFunction ( array $params = [] )
Creates a new Lambda function.
DeleteAlias ( array $params = [] )
Deletes the specified Lambda function alias.
DeleteEventSourceMapping ( array $params = [] )
Deletes an event source mapping.
DeleteFunction ( array $params = [] )
Deletes a Lambda function.
DeleteFunctionConcurrency ( array $params = [] )
Removes concurrent execution limits from this function.
DeleteLayerVersion ( array $params = [] )
Deletes a version of a function layer.
GetAccountSettings ( array $params = [] )
Retrieves details about your account's limits and usage in a region.
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 details about an event source mapping.
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.
GetLayerVersion ( array $params = [] )
Returns information about a version of a function layer, with a link to download the layer archive that's valid for 10 minutes.
GetLayerVersionPolicy ( array $params = [] )
Returns the permission policy for a layer version.
GetPolicy ( array $params = [] )
Returns the resource policy associated with the specified Lambda function.
Invoke ( array $params = [] )
Invokes a Lambda function.
InvokeAsync ( array $params = [] )
For asynchronous function invocation, use Invoke.
ListAliases ( array $params = [] )
Returns list of aliases created for a Lambda function.
ListEventSourceMappings ( array $params = [] )
Lists event source mappings.
ListFunctions ( array $params = [] )
Returns a list of your Lambda functions.
ListLayerVersions ( array $params = [] )
Lists the versions of a function layer.
ListLayers ( array $params = [] )
Lists function layers and shows information about the latest version of each.
ListTags ( array $params = [] )
Returns a list of tags assigned to a function when supplied the function ARN (Amazon Resource Name).
ListVersionsByFunction ( array $params = [] )
Lists all versions of a function.
PublishLayerVersion ( array $params = [] )
Creates a function layer from a ZIP archive.
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.
RemoveLayerVersionPermission ( array $params = [] )
Removes a statement from the permissions policy for a layer version.
RemovePermission ( array $params = [] )
Removes permissions from a function.
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 = [] )
Updates 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

AddLayerVersionPermission

$result = $client->addLayerVersionPermission([/* ... */]);
$promise = $client->addLayerVersionPermissionAsync([/* ... */]);

Adds permissions to the resource-based policy of a version of a function layer. Use this action to grant layer usage permission to other accounts. You can grant permission to a single account, all AWS accounts, or all accounts in an organization.

To revoke permission, call RemoveLayerVersionPermission with the statement ID that you specified when you added it.

Parameter Syntax

$result = $client->addLayerVersionPermission([
    'Action' => '<string>', // REQUIRED
    'LayerName' => '<string>', // REQUIRED
    'OrganizationId' => '<string>',
    'Principal' => '<string>', // REQUIRED
    'RevisionId' => '<string>',
    'StatementId' => '<string>', // REQUIRED
    'VersionNumber' => <integer>, // REQUIRED
]);

Parameter Details

Members

Action

Required: Yes
Type: string

The API action that grants access to the layer. For example, lambda:GetLayerVersion.

LayerName

Required: Yes
Type: string

The name of the layer.

OrganizationId

Type: string

With the principal set to *, grant permission to all accounts in the specified organization.

Principal

Required: Yes
Type: string

An account ID, or * to grant permission to all AWS accounts.

RevisionId

Type: string

Only update the policy if the revision ID matches the ID specified. Use this option to avoid modifying a policy that has changed since you last read it.

StatementId

Required: Yes
Type: string

An identifier that distinguishes the policy from others on the same layer version.

VersionNumber

Required: Yes
Type: long (int|float)

The version number.

Result Syntax

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

Result Details

Members

RevisionId

Type: string

A unique identifier for the current revision of the policy.

Statement

Type: string

The permission statement.

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.
TooManyRequestsException:
Request throughput limit exceeded
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.
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.

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 the 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.

Permissions apply to the Amazon Resource Name (ARN) used to invoke the function, which can be unqualified (the unpublished version of the function), or include a version or alias. If a client uses a version or alias to invoke a function, use the Qualifier parameter to apply permissions to that ARN. 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

Required: Yes
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

Required: Yes
Type: string

The name of the Lambda function.

Name formats

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

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

Principal

Required: Yes
Type: string

The principal who is getting this permission. The principal can be an AWS service (e.g. s3.amazonaws.com or sns.amazonaws.com) for service triggers, or an account ID for cross-account access. If you specify a service as a principal, use the SourceArn parameter to limit who can invoke the function through that service.

Qualifier

Type: string

Specify a version or alias to add permissions to a published version of the function.

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 GetFunction or GetAlias

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

The Amazon Resource Name of the invoker.

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

StatementId

Required: Yes
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:
Request throughput limit exceeded
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

Required: Yes
Type: string

The name of the lambda function.

Name formats

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

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

FunctionVersion

Required: Yes
Type: string

Lambda function version for which you are creating the alias.

Name

Required: Yes
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 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.

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:
Request throughput limit exceeded

CreateEventSourceMapping

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

Creates a mapping between an event source and an AWS Lambda function. Lambda reads items from the event source and triggers the function.

For details about each event source type, see the following topics.

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 maximum number of items to retrieve in a single batch.

Amazon Kinesis - Default 100. Max 10,000.
Amazon DynamoDB Streams - Default 100. Max 1,000.
Amazon Simple Queue Service - Default 10. Max 10.

Enabled

Type: boolean

Disables the event source mapping to pause polling and invocation.

EventSourceArn

Required: Yes
Type: string

The Amazon Resource Name (ARN) of the event source.

Amazon Kinesis - The ARN of the data stream or a stream consumer.
Amazon DynamoDB Streams - The ARN of the stream.
Amazon Simple Queue Service - The ARN of the queue.

FunctionName

Required: Yes
Type: string

The name of the Lambda function.

Name formats

Function name - MyFunction.
Function ARN - arn:aws:lambda:us-west-2:123456789012:function:MyFunction.
Version or Alias ARN - arn:aws:lambda:us-west-2:123456789012:function:MyFunction:PROD.
Partial ARN - 123456789012:function:MyFunction.

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

StartingPosition

Type: string

The position in a stream from which to start reading. Required for Amazon Kinesis and Amazon DynamoDB Streams sources. AT_TIMESTAMP is only supported for Amazon Kinesis streams.

StartingPositionTimestamp

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

With StartingPosition set to AT_TIMESTAMP, the Unix time in seconds from which to start reading.

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 maximum number of items to retrieve in a single batch.

EventSourceArn

Type: string

The Amazon Resource Name (ARN) of the event source.

FunctionArn

Type: string

The ARN of the Lambda function.

LastModified

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

The date that the event source mapping was last updated, in Unix time seconds.

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 one of the following: Creating, Enabling, Enabled, Disabling, Disabled, Updating, or Deleting.

StateTransitionReason

Type: string

The cause of the last state change, either User initiated or Lambda initiated.

UUID

Type: string

The identifier of the event source 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:
Request throughput limit exceeded
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 configuration is created from the request parameters, and the code for the function is provided by a .zip file. The function name is case-sensitive.

This operation requires permission for the lambda:CreateFunction action.

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>',
    'Layers' => ['<string>', ...],
    'MemorySize' => <integer>,
    'Publish' => true || false,
    'Role' => '<string>', // REQUIRED
    'Runtime' => 'nodejs|nodejs4.3|nodejs6.10|nodejs8.10|java8|python2.7|python3.6|python3.7|dotnetcore1.0|dotnetcore2.0|dotnetcore2.1|nodejs4.3-edge|go1.x|ruby2.5|provided', // REQUIRED
    'Tags' => ['<string>', ...],
    'Timeout' => <integer>,
    'TracingConfig' => [
        'Mode' => 'Active|PassThrough',
    ],
    'VpcConfig' => [
        'SecurityGroupIds' => ['<string>', ...],
        'SubnetIds' => ['<string>', ...],
    ],
]);

Parameter Details

Members

Code

Required: Yes
Type: FunctionCode structure

The code for the function.

DeadLetterConfig

Type: DeadLetterConfig structure

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

Description

Type: string

A description of the function.

Environment

Type: Environment structure

Environment variables that are accessible from function code during execution.

FunctionName

Required: Yes
Type: string

The name of the Lambda function.

Name formats

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

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

Handler

Required: Yes
Type: string

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

KMSKeyArn

Type: string

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

Layers

Type: Array of strings

A list of function layers to add to the function's execution environment.

MemorySize

Type: int

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

Publish

Type: boolean

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

Role

Required: Yes
Type: string

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

Runtime

Required: Yes
Type: string

The runtime version for the function.

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 amount of time that Lambda allows a function to run before terminating it. The default is 3 seconds. The maximum allowed value is 900 seconds.

TracingConfig

Type: TracingConfig structure

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

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>',
    'Layers' => [
        [
            'Arn' => '<string>',
            'CodeSize' => <integer>,
        ],
        // ...
    ],
    'MasterArn' => '<string>',
    'MemorySize' => <integer>,
    'RevisionId' => '<string>',
    'Role' => '<string>',
    'Runtime' => 'nodejs|nodejs4.3|nodejs6.10|nodejs8.10|java8|python2.7|python3.6|python3.7|dotnetcore1.0|dotnetcore2.0|dotnetcore2.1|nodejs4.3-edge|go1.x|ruby2.5|provided',
    'Timeout' => <integer>,
    'TracingConfig' => [
        'Mode' => 'Active|PassThrough',
    ],
    'Version' => '<string>',
    'VpcConfig' => [
        'SecurityGroupIds' => ['<string>', ...],
        'SubnetIds' => ['<string>', ...],
        'VpcId' => '<string>',
    ],
]

Result Details

Members

CodeSha256

Type: string

The SHA256 hash of the function's deployment package.

CodeSize

Type: long (int|float)

The size of the function's deployment package in bytes.

DeadLetterConfig

Type: DeadLetterConfig structure

The function's dead letter queue.

Description

Type: string

The function's description.

Environment

Type: EnvironmentResponse structure

The function's environment variables.

FunctionArn

Type: string

The function's Amazon Resource Name.

FunctionName

Type: string

The name of the function.

Handler

Type: string

The function Lambda calls to begin executing your function.

KMSKeyArn

Type: string

The KMS key used to encrypt the function's environment variables. Only returned if you've configured a customer managed CMK.

LastModified

Type: string

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

Layers

Type: Array of Layer structures

A list of function layers.

MasterArn

Type: string

The ARN of the master function.

MemorySize

Type: int

The memory allocated to the function

RevisionId

Type: string

Represents the latest updated revision of the function or alias.

Role

Type: string

The function's execution role.

Runtime

Type: string

The runtime environment for the Lambda function.

Timeout

Type: int

The amount of time that Lambda allows a function to run before terminating it.

TracingConfig

Type: TracingConfigResponse structure

The function's AWS X-Ray tracing configuration.

Version

Type: string

The version of the Lambda function.

VpcConfig

Type: VpcConfigResponse structure

The function's networking configuration.

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:
Request throughput limit exceeded
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

Required: Yes
Type: string

The name of the lambda function.

Name formats

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

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

Name

Required: Yes
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:
Request throughput limit exceeded

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([/* ... */]);

Deletes an event source mapping.

Parameter Syntax

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

Parameter Details

Members

UUID

Required: Yes
Type: string

The identifier 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 maximum number of items to retrieve in a single batch.

EventSourceArn

Type: string

The Amazon Resource Name (ARN) of the event source.

FunctionArn

Type: string

The ARN of the Lambda function.

LastModified

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

The date that the event source mapping was last updated, in Unix time seconds.

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 one of the following: Creating, Enabling, Enabled, Disabling, Disabled, Updating, or Deleting.

StateTransitionReason

Type: string

The cause of the last state change, either User initiated or Lambda initiated.

UUID

Type: string

The identifier of the event source 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:
Request throughput limit exceeded
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 a Lambda function. To delete a specific function version, use the Qualifier parameter. Otherwise, all versions and aliases are deleted. Event source mappings are not deleted.

This operation requires permission for the lambda:DeleteFunction action.

Parameter Syntax

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

Parameter Details

Members

FunctionName

Required: Yes
Type: string

The name of the Lambda function.

Name formats

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

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

Qualifier

Type: string

Specify a version to delete. You cannot delete a version that is referenced by an alias.

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:
Request throughput limit exceeded
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 Managing Concurrency.

Parameter Syntax

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

Parameter Details

Members

FunctionName

Required: Yes
Type: string

The name of the Lambda function.

Name formats

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

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

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:
Request throughput limit exceeded
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.

DeleteLayerVersion

$result = $client->deleteLayerVersion([/* ... */]);
$promise = $client->deleteLayerVersionAsync([/* ... */]);

Deletes a version of a function layer. Deleted versions can no longer be viewed or added to functions. However, a copy of the version remains in Lambda until no functions refer to it.

Parameter Syntax

$result = $client->deleteLayerVersion([
    'LayerName' => '<string>', // REQUIRED
    'VersionNumber' => <integer>, // REQUIRED
]);

Parameter Details

Members

LayerName

Required: Yes
Type: string

The name of the layer.

VersionNumber

Required: Yes
Type: long (int|float)

The version number.

Result Syntax

[]

Result Details

The results for this operation are always empty.

Errors

ServiceException:
The AWS Lambda service encountered an internal error.
TooManyRequestsException:
Request throughput limit exceeded

GetAccountSettings

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

Retrieves details about your account's limits and usage in a region.

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

Limits related to concurrency and code storage.

AccountUsage

Type: AccountUsage structure

The number of functions and amount of storage in use.

Errors

TooManyRequestsException:
Request throughput limit exceeded
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

Required: Yes
Type: string

The name of the lambda function.

Name formats

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

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

Name

Required: Yes
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

Specifies an additional function versions the alias points to, allowing you to dictate what percentage of traffic will invoke each version.

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:
Request throughput limit exceeded

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 details about an event source mapping.

Parameter Syntax

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

Parameter Details

Members

UUID

Required: Yes
Type: string

The identifier 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 maximum number of items to retrieve in a single batch.

EventSourceArn

Type: string

The Amazon Resource Name (ARN) of the event source.

FunctionArn

Type: string

The ARN of the Lambda function.

LastModified

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

The date that the event source mapping was last updated, in Unix time seconds.

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 one of the following: Creating, Enabling, Enabled, Disabling, Disabled, Updating, or Deleting.

StateTransitionReason

Type: string

The cause of the last state change, either User initiated or Lambda initiated.

UUID

Type: string

The identifier of the event source 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:
Request throughput limit exceeded

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.

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

This operation requires permission for the lambda:GetFunction action.

Parameter Syntax

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

Parameter Details

Members

FunctionName

Required: Yes
Type: string

The name of the Lambda function.

Name formats

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

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

Qualifier

Type: string

Specify a version or alias to get details about a published version of the 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>',
        'Layers' => [
            [
                'Arn' => '<string>',
                'CodeSize' => <integer>,
            ],
            // ...
        ],
        'MasterArn' => '<string>',
        'MemorySize' => <integer>,
        'RevisionId' => '<string>',
        'Role' => '<string>',
        'Runtime' => 'nodejs|nodejs4.3|nodejs6.10|nodejs8.10|java8|python2.7|python3.6|python3.7|dotnetcore1.0|dotnetcore2.0|dotnetcore2.1|nodejs4.3-edge|go1.x|ruby2.5|provided',
        '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 function's code.

Concurrency

Type: Concurrency structure

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

Configuration

Type: FunctionConfiguration structure

The function's configuration.

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:
Request throughput limit exceeded
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

Required: Yes
Type: string

The name of the Lambda function.

Name formats

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

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

Qualifier

Type: string

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

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>',
    'Layers' => [
        [
            'Arn' => '<string>',
            'CodeSize' => <integer>,
        ],
        // ...
    ],
    'MasterArn' => '<string>',
    'MemorySize' => <integer>,
    'RevisionId' => '<string>',
    'Role' => '<string>',
    'Runtime' => 'nodejs|nodejs4.3|nodejs6.10|nodejs8.10|java8|python2.7|python3.6|python3.7|dotnetcore1.0|dotnetcore2.0|dotnetcore2.1|nodejs4.3-edge|go1.x|ruby2.5|provided',
    'Timeout' => <integer>,
    'TracingConfig' => [
        'Mode' => 'Active|PassThrough',
    ],
    'Version' => '<string>',
    'VpcConfig' => [
        'SecurityGroupIds' => ['<string>', ...],
        'SubnetIds' => ['<string>', ...],
        'VpcId' => '<string>',
    ],
]

Result Details

Members

CodeSha256

Type: string

The SHA256 hash of the function's deployment package.

CodeSize

Type: long (int|float)

The size of the function's deployment package in bytes.

DeadLetterConfig

Type: DeadLetterConfig structure

The function's dead letter queue.

Description

Type: string

The function's description.

Environment

Type: EnvironmentResponse structure

The function's environment variables.

FunctionArn

Type: string

The function's Amazon Resource Name.

FunctionName

Type: string

The name of the function.

Handler

Type: string

The function Lambda calls to begin executing your function.

KMSKeyArn

Type: string

The KMS key used to encrypt the function's environment variables. Only returned if you've configured a customer managed CMK.

LastModified

Type: string

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

Layers

Type: Array of Layer structures

A list of function layers.

MasterArn

Type: string

The ARN of the master function.

MemorySize

Type: int

The memory allocated to the function

RevisionId

Type: string

Represents the latest updated revision of the function or alias.

Role

Type: string

The function's execution role.

Runtime

Type: string

The runtime environment for the Lambda function.

Timeout

Type: int

The amount of time that Lambda allows a function to run before terminating it.

TracingConfig

Type: TracingConfigResponse structure

The function's AWS X-Ray tracing configuration.

Version

Type: string

The version of the Lambda function.

VpcConfig

Type: VpcConfigResponse structure

The function's networking configuration.

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:
Request throughput limit exceeded
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' => [
    ],
]

GetLayerVersion

$result = $client->getLayerVersion([/* ... */]);
$promise = $client->getLayerVersionAsync([/* ... */]);

Returns information about a version of a function layer, with a link to download the layer archive that's valid for 10 minutes.

Parameter Syntax

$result = $client->getLayerVersion([
    'LayerName' => '<string>', // REQUIRED
    'VersionNumber' => <integer>, // REQUIRED
]);

Parameter Details

Members

LayerName

Required: Yes
Type: string

The name of the layer.

VersionNumber

Required: Yes
Type: long (int|float)

The version number.

Result Syntax

[
    'CompatibleRuntimes' => ['<string>', ...],
    'Content' => [
        'CodeSha256' => '<string>',
        'CodeSize' => <integer>,
        'Location' => '<string>',
    ],
    'CreatedDate' => '<string>',
    'Description' => '<string>',
    'LayerArn' => '<string>',
    'LayerVersionArn' => '<string>',
    'LicenseInfo' => '<string>',
    'Version' => <integer>,
]

Result Details

Members

CompatibleRuntimes

Type: Array of strings

The layer's compatible runtimes.

Content

Type: LayerVersionContentOutput structure

Details about the layer version.

CreatedDate

Type: string

The date that the layer version was created, in ISO-8601 format (YYYY-MM-DDThh:mm:ss.sTZD).

Description

Type: string

The description of the version.

LayerArn

Type: string

The Amazon Resource Name (ARN) of the function layer.

LayerVersionArn

Type: string

The ARN of the layer version.

LicenseInfo

Type: string

The layer's software license.

Version

Type: long (int|float)

The version number.

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:
Request throughput limit exceeded
ResourceNotFoundException:
The resource (for example, a Lambda function or access policy statement) specified in the request does not exist.

GetLayerVersionPolicy

$result = $client->getLayerVersionPolicy([/* ... */]);
$promise = $client->getLayerVersionPolicyAsync([/* ... */]);

Returns the permission policy for a layer version. For more information, see AddLayerVersionPermission.

Parameter Syntax

$result = $client->getLayerVersionPolicy([
    'LayerName' => '<string>', // REQUIRED
    'VersionNumber' => <integer>, // REQUIRED
]);

Parameter Details

Members

LayerName

Required: Yes
Type: string

The name of the layer.

VersionNumber

Required: Yes
Type: long (int|float)

The version number.

Result Syntax

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

Result Details

Members

Policy

Type: string

The policy document.

RevisionId

Type: string

A unique identifier for the current revision of the policy.

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:
Request throughput limit exceeded
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.

GetPolicy

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

Returns the resource policy associated with the specified Lambda function.

This action requires permission for the lambda:GetPolicy action.

Parameter Syntax

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

Parameter Details

Members

FunctionName

Required: Yes
Type: string

The name of the lambda function.

Name formats

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

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

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:
Request throughput limit exceeded
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 Lambda function. For an example, see Create the Lambda Function and Test It Manually.

Specify just a function name to invoke the latest version of the function. To invoke a published version, use the Qualifier parameter to specify a version or alias.

If you use the RequestResponse (synchronous) invocation option, the function will be invoked only once. If you use the Event (asynchronous) invocation option, the function will be invoked at least once in response to an event and the function must be idempotent to handle this.

For functions with a long timeout, your client may be disconnected during synchronous invocation while it waits for a response. Configure your HTTP client, SDK, firewall, proxy, or operating system to allow for long connections with timeout or keep-alive settings.

This operation requires permission for the lambda:InvokeFunction action.

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.

ClientContext information is returned only if you use the synchronous (RequestResponse) invocation type.

FunctionName

Required: Yes
Type: string

The name of the Lambda function.

Name formats

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

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

InvocationType

Type: string

Choose from the following options.

RequestResponse (default) - Invoke the function synchronously. Keep the connection open until the function returns a response or times out.
Event - Invoke the function asynchronously. Send events that fail multiple times to the function's dead-letter queue (if configured).
DryRun - Validate parameter values and verify that the user or role has permission to invoke the function.

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

Specify a version or alias to invoke a published version of the function.

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 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:
Request throughput limit exceeded
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:
Need additional permissions to configure VPC settings.
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 deployment package.
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([/* ... */]);

For asynchronous function invocation, use 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

Required: Yes
Type: string

The name of the Lambda function.

Name formats

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

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

InvokeArgs

Required: Yes
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

Required: Yes
Type: string

The name of the lambda function.

Name formats

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

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

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:
Request throughput limit exceeded

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([/* ... */]);

Lists event source mappings. Specify an EventSourceArn to only show event source mappings for a single event source.

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 event source.

Amazon Kinesis - The ARN of the data stream or a stream consumer.
Amazon DynamoDB Streams - The ARN of the stream.
Amazon Simple Queue Service - The ARN of the queue.

FunctionName

Type: string

The name of the Lambda function.

Name formats

Function name - MyFunction.
Function ARN - arn:aws:lambda:us-west-2:123456789012:function:MyFunction.
Version or Alias ARN - arn:aws:lambda:us-west-2:123456789012:function:MyFunction:PROD.
Partial ARN - 123456789012:function:MyFunction.

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

Marker

Type: string

A pagination token returned by a previous call.

MaxItems

Type: int

The maximum number of event source mappings to return.

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

A list of event source mappings.

NextMarker

Type: string

A pagination token that's returned when the response doesn't contain all 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:
Request throughput limit exceeded

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

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

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

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

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. The absolute maximum of AWS Lambda functions that can be returned is 50.

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>',
            'Layers' => [
                [
                    'Arn' => '<string>',
                    'CodeSize' => <integer>,
                ],
                // ...
            ],
            'MasterArn' => '<string>',
            'MemorySize' => <integer>,
            'RevisionId' => '<string>',
            'Role' => '<string>',
            'Runtime' => 'nodejs|nodejs4.3|nodejs6.10|nodejs8.10|java8|python2.7|python3.6|python3.7|dotnetcore1.0|dotnetcore2.0|dotnetcore2.1|nodejs4.3-edge|go1.x|ruby2.5|provided',
            '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:
Request throughput limit exceeded
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' => '',
]

ListLayerVersions

$result = $client->listLayerVersions([/* ... */]);
$promise = $client->listLayerVersionsAsync([/* ... */]);

Lists the versions of a function layer. Versions that have been deleted aren't listed. Specify a runtime identifier to list only versions that indicate that they're compatible with that runtime.

Parameter Syntax

$result = $client->listLayerVersions([
    'CompatibleRuntime' => 'nodejs|nodejs4.3|nodejs6.10|nodejs8.10|java8|python2.7|python3.6|python3.7|dotnetcore1.0|dotnetcore2.0|dotnetcore2.1|nodejs4.3-edge|go1.x|ruby2.5|provided',
    'LayerName' => '<string>', // REQUIRED
    'Marker' => '<string>',
    'MaxItems' => <integer>,
]);

Parameter Details

Members

CompatibleRuntime

Type: string

A runtime identifier. For example, go1.x.

LayerName

Required: Yes
Type: string

The name of the layer.

Marker

Type: string

A pagination token returned by a previous call.

MaxItems

Type: int

The maximum number of versions to return.

Result Syntax

[
    'LayerVersions' => [
        [
            'CompatibleRuntimes' => ['<string>', ...],
            'CreatedDate' => '<string>',
            'Description' => '<string>',
            'LayerVersionArn' => '<string>',
            'LicenseInfo' => '<string>',
            'Version' => <integer>,
        ],
        // ...
    ],
    'NextMarker' => '<string>',
]

Result Details

Members

LayerVersions

Type: Array of LayerVersionsListItem structures

A list of versions.

NextMarker

Type: string

A pagination token returned when the response doesn't contain all versions.

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:
Request throughput limit exceeded

ListLayers

$result = $client->listLayers([/* ... */]);
$promise = $client->listLayersAsync([/* ... */]);

Lists function layers and shows information about the latest version of each. Specify a runtime identifier to list only layers that indicate that they're compatible with that runtime.

Parameter Syntax

$result = $client->listLayers([
    'CompatibleRuntime' => 'nodejs|nodejs4.3|nodejs6.10|nodejs8.10|java8|python2.7|python3.6|python3.7|dotnetcore1.0|dotnetcore2.0|dotnetcore2.1|nodejs4.3-edge|go1.x|ruby2.5|provided',
    'Marker' => '<string>',
    'MaxItems' => <integer>,
]);

Parameter Details

Members

CompatibleRuntime

Type: string

A runtime identifier. For example, go1.x.

Marker

Type: string

A pagination token returned by a previous call.

MaxItems

Type: int

The maximum number of layers to return.

Result Syntax

[
    'Layers' => [
        [
            'LatestMatchingVersion' => [
                'CompatibleRuntimes' => ['<string>', ...],
                'CreatedDate' => '<string>',
                'Description' => '<string>',
                'LayerVersionArn' => '<string>',
                'LicenseInfo' => '<string>',
                'Version' => <integer>,
            ],
            'LayerArn' => '<string>',
            'LayerName' => '<string>',
        ],
        // ...
    ],
    'NextMarker' => '<string>',
]

Result Details

Members

Layers

Type: Array of LayersListItem structures

A list of function layers.

NextMarker

Type: string

A pagination token returned when the response doesn't contain all layers.

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:
Request throughput limit exceeded

$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

Required: Yes
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:
Request throughput limit exceeded

ListVersionsByFunction

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

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

Parameter Syntax

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

Parameter Details

Members

FunctionName

Required: Yes
Type: string

The name of the lambda function.

Name formats

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

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

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>',
            'Layers' => [
                [
                    'Arn' => '<string>',
                    'CodeSize' => <integer>,
                ],
                // ...
            ],
            'MasterArn' => '<string>',
            'MemorySize' => <integer>,
            'RevisionId' => '<string>',
            'Role' => '<string>',
            'Runtime' => 'nodejs|nodejs4.3|nodejs6.10|nodejs8.10|java8|python2.7|python3.6|python3.7|dotnetcore1.0|dotnetcore2.0|dotnetcore2.1|nodejs4.3-edge|go1.x|ruby2.5|provided',
            '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:
Request throughput limit exceeded

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

PublishLayerVersion

$result = $client->publishLayerVersion([/* ... */]);
$promise = $client->publishLayerVersionAsync([/* ... */]);

Creates a function layer from a ZIP archive. Each time you call PublishLayerVersion with the same version name, a new version is created.

Add layers to your function with CreateFunction or UpdateFunctionConfiguration.

Parameter Syntax

$result = $client->publishLayerVersion([
    'CompatibleRuntimes' => ['<string>', ...],
    'Content' => [ // REQUIRED
        'S3Bucket' => '<string>',
        'S3Key' => '<string>',
        'S3ObjectVersion' => '<string>',
        'ZipFile' => <string || resource || Psr\Http\Message\StreamInterface>,
    ],
    'Description' => '<string>',
    'LayerName' => '<string>', // REQUIRED
    'LicenseInfo' => '<string>',
]);

Parameter Details

Members

CompatibleRuntimes

Type: Array of strings

A list of compatible function runtimes. Used for filtering with ListLayers and ListLayerVersions.

Content

Required: Yes
Type: LayerVersionContentInput structure

The function layer archive.

Description

Type: string

The description of the version.

LayerName

Required: Yes
Type: string

The name of the layer.

LicenseInfo

Type: string

The layer's software license. It can be any of the following:

An SPDX license identifier. For example, MIT.
The URL of a license hosted on the internet. For example, https://opensource.org/licenses/MIT.
The full text of the license.

Result Syntax

[
    'CompatibleRuntimes' => ['<string>', ...],
    'Content' => [
        'CodeSha256' => '<string>',
        'CodeSize' => <integer>,
        'Location' => '<string>',
    ],
    'CreatedDate' => '<string>',
    'Description' => '<string>',
    'LayerArn' => '<string>',
    'LayerVersionArn' => '<string>',
    'LicenseInfo' => '<string>',
    'Version' => <integer>,
]

Result Details

Members

CompatibleRuntimes

Type: Array of strings

The layer's compatible runtimes.

Content

Type: LayerVersionContentOutput structure

Details about the layer version.

CreatedDate

Type: string

The date that the layer version was created, in ISO-8601 format (YYYY-MM-DDThh:mm:ss.sTZD).

Description

Type: string

The description of the version.

LayerArn

Type: string

The Amazon Resource Name (ARN) of the function layer.

LayerVersionArn

Type: string

The ARN of the layer version.

LicenseInfo

Type: string

The layer's software license.

Version

Type: long (int|float)

The version number.

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:
Request throughput limit exceeded
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.
CodeStorageExceededException:
You have exceeded your maximum total code size per account. Limits

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

Required: Yes
Type: string

The name of the lambda function.

Name formats

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

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

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 retrieve the latest function version or alias RevisionID using either GetFunction or GetAlias.

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>',
    'Layers' => [
        [
            'Arn' => '<string>',
            'CodeSize' => <integer>,
        ],
        // ...
    ],
    'MasterArn' => '<string>',
    'MemorySize' => <integer>,
    'RevisionId' => '<string>',
    'Role' => '<string>',
    'Runtime' => 'nodejs|nodejs4.3|nodejs6.10|nodejs8.10|java8|python2.7|python3.6|python3.7|dotnetcore1.0|dotnetcore2.0|dotnetcore2.1|nodejs4.3-edge|go1.x|ruby2.5|provided',
    'Timeout' => <integer>,
    'TracingConfig' => [
        'Mode' => 'Active|PassThrough',
    ],
    'Version' => '<string>',
    'VpcConfig' => [
        'SecurityGroupIds' => ['<string>', ...],
        'SubnetIds' => ['<string>', ...],
        'VpcId' => '<string>',
    ],
]

Result Details

Members

CodeSha256

Type: string

The SHA256 hash of the function's deployment package.

CodeSize

Type: long (int|float)

The size of the function's deployment package in bytes.

DeadLetterConfig

Type: DeadLetterConfig structure

The function's dead letter queue.

Description

Type: string

The function's description.

Environment

Type: EnvironmentResponse structure

The function's environment variables.

FunctionArn

Type: string

The function's Amazon Resource Name.

FunctionName

Type: string

The name of the function.

Handler

Type: string

The function Lambda calls to begin executing your function.

KMSKeyArn

Type: string

The KMS key used to encrypt the function's environment variables. Only returned if you've configured a customer managed CMK.

LastModified

Type: string

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

Layers

Type: Array of Layer structures

A list of function layers.

MasterArn

Type: string

The ARN of the master function.

MemorySize

Type: int

The memory allocated to the function

RevisionId

Type: string

Represents the latest updated revision of the function or alias.

Role

Type: string

The function's execution role.

Runtime

Type: string

The runtime environment for the Lambda function.

Timeout

Type: int

The amount of time that Lambda allows a function to run before terminating it.

TracingConfig

Type: TracingConfigResponse structure

The function's AWS X-Ray tracing configuration.

Version

Type: string

The version of the Lambda function.

VpcConfig

Type: VpcConfigResponse structure

The function's networking configuration.

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:
Request throughput limit exceeded
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 Managing Concurrency.

Parameter Syntax

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

Parameter Details

Members

FunctionName

Required: Yes
Type: string

The name of the Lambda function.

Name formats

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

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

ReservedConcurrentExecutions

Required: Yes
Type: int

The concurrent execution limit reserved for this function.

Result Syntax

[
    'ReservedConcurrentExecutions' => <integer>,
]

Result Details

Members

ReservedConcurrentExecutions

Type: int

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

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:
Request throughput limit exceeded

RemoveLayerVersionPermission

$result = $client->removeLayerVersionPermission([/* ... */]);
$promise = $client->removeLayerVersionPermissionAsync([/* ... */]);

Removes a statement from the permissions policy for a layer version. For more information, see AddLayerVersionPermission.

Parameter Syntax

$result = $client->removeLayerVersionPermission([
    'LayerName' => '<string>', // REQUIRED
    'RevisionId' => '<string>',
    'StatementId' => '<string>', // REQUIRED
    'VersionNumber' => <integer>, // REQUIRED
]);

Parameter Details

Members

LayerName

Required: Yes
Type: string

The name of the layer.

RevisionId

Type: string

Only update the policy if the revision ID matches the ID specified. Use this option to avoid modifying a policy that has changed since you last read it.

StatementId

Required: Yes
Type: string

The identifier that was specified when the statement was added.

VersionNumber

Required: Yes
Type: long (int|float)

The version number.

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:
Request throughput limit exceeded
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.

RemovePermission

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

Removes permissions from a function. 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. When you remove permissions, disable the event source mapping or trigger configuration first to avoid errors.

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

Required: Yes
Type: string

The name of the Lambda function.

Name formats

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

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

Qualifier

Type: string

Specify a version or alias to remove permissions from a published version of the function.

RevisionId

Type: string

StatementId

Required: Yes
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:
Request throughput limit exceeded
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

Required: Yes
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

Required: Yes
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:
Request throughput limit exceeded

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

Required: Yes
Type: string

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

TagKeys

Required: Yes
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:
Request throughput limit exceeded

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

Required: Yes
Type: string

The name of the lambda function.

Name formats

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

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

FunctionVersion

Type: string

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

Name

Required: Yes
Type: string

The alias 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 retrieve the latest function version or alias RevisionID using either GetFunction or GetAlias.

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 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

Specifies an additional function versions the alias points to, allowing you to dictate what percentage of traffic will invoke each version.

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:
Request throughput limit exceeded
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([/* ... */]);

Updates an event source mapping. You can change the function that AWS Lambda invokes, or pause invocation and resume later from the same location.

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 items to retrieve in a single batch.

Amazon Kinesis - Default 100. Max 10,000.
Amazon DynamoDB Streams - Default 100. Max 1,000.
Amazon Simple Queue Service - Default 10. Max 10.

Enabled

Type: boolean

Disables the event source mapping to pause polling and invocation.

FunctionName

Type: string

The name of the Lambda function.

Name formats

Function name - MyFunction.
Function ARN - arn:aws:lambda:us-west-2:123456789012:function:MyFunction.
Version or Alias ARN - arn:aws:lambda:us-west-2:123456789012:function:MyFunction:PROD.
Partial ARN - 123456789012:function:MyFunction.

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

UUID

Required: Yes
Type: string

The identifier 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 maximum number of items to retrieve in a single batch.

EventSourceArn

Type: string

The Amazon Resource Name (ARN) of the event source.

FunctionArn

Type: string

The ARN of the Lambda function.

LastModified

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

The date that the event source mapping was last updated, in Unix time seconds.

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 one of the following: Creating, Enabling, Enabled, Disabling, Disabled, Updating, or Deleting.

StateTransitionReason

Type: string

The cause of the last state change, either User initiated or Lambda initiated.

UUID

Type: string

The identifier of the event source 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:
Request throughput limit exceeded
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

Required: Yes
Type: string

The name of the Lambda function.

Name formats

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

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

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>',
    'Layers' => [
        [
            'Arn' => '<string>',
            'CodeSize' => <integer>,
        ],
        // ...
    ],
    'MasterArn' => '<string>',
    'MemorySize' => <integer>,
    'RevisionId' => '<string>',
    'Role' => '<string>',
    'Runtime' => 'nodejs|nodejs4.3|nodejs6.10|nodejs8.10|java8|python2.7|python3.6|python3.7|dotnetcore1.0|dotnetcore2.0|dotnetcore2.1|nodejs4.3-edge|go1.x|ruby2.5|provided',
    'Timeout' => <integer>,
    'TracingConfig' => [
        'Mode' => 'Active|PassThrough',
    ],
    'Version' => '<string>',
    'VpcConfig' => [
        'SecurityGroupIds' => ['<string>', ...],
        'SubnetIds' => ['<string>', ...],
        'VpcId' => '<string>',
    ],
]

Result Details

Members

CodeSha256

Type: string

The SHA256 hash of the function's deployment package.

CodeSize

Type: long (int|float)

The size of the function's deployment package in bytes.

DeadLetterConfig

Type: DeadLetterConfig structure

The function's dead letter queue.

Description

Type: string

The function's description.

Environment

Type: EnvironmentResponse structure

The function's environment variables.

FunctionArn

Type: string

The function's Amazon Resource Name.

FunctionName

Type: string

The name of the function.

Handler

Type: string

The function Lambda calls to begin executing your function.

KMSKeyArn

Type: string

The KMS key used to encrypt the function's environment variables. Only returned if you've configured a customer managed CMK.

LastModified

Type: string

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

Layers

Type: Array of Layer structures

A list of function layers.

MasterArn

Type: string

The ARN of the master function.

MemorySize

Type: int

The memory allocated to the function

RevisionId

Type: string

Represents the latest updated revision of the function or alias.

Role

Type: string

The function's execution role.

Runtime

Type: string

The runtime environment for the Lambda function.

Timeout

Type: int

The amount of time that Lambda allows a function to run before terminating it.

TracingConfig

Type: TracingConfigResponse structure

The function's AWS X-Ray tracing configuration.

Version

Type: string

The version of the Lambda function.

VpcConfig

Type: VpcConfigResponse structure

The function's networking configuration.

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:
Request throughput limit exceeded
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>',
    'Layers' => ['<string>', ...],
    'MemorySize' => <integer>,
    'RevisionId' => '<string>',
    'Role' => '<string>',
    'Runtime' => 'nodejs|nodejs4.3|nodejs6.10|nodejs8.10|java8|python2.7|python3.6|python3.7|dotnetcore1.0|dotnetcore2.0|dotnetcore2.1|nodejs4.3-edge|go1.x|ruby2.5|provided',
    'Timeout' => <integer>,
    'TracingConfig' => [
        'Mode' => 'Active|PassThrough',
    ],
    'VpcConfig' => [
        'SecurityGroupIds' => ['<string>', ...],
        'SubnetIds' => ['<string>', ...],
    ],
]);

Parameter Details

Members

DeadLetterConfig

Type: DeadLetterConfig structure

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

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

Required: Yes
Type: string

The name of the Lambda function.

Name formats

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

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

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.

Layers

Type: Array of strings

A list of function layers to add to the function's execution environment.

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 version for the function.

Timeout

Type: int

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

TracingConfig

Type: TracingConfig structure

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

VpcConfig

Type: VpcConfig structure

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

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>',
    'Layers' => [
        [
            'Arn' => '<string>',
            'CodeSize' => <integer>,
        ],
        // ...
    ],
    'MasterArn' => '<string>',
    'MemorySize' => <integer>,
    'RevisionId' => '<string>',
    'Role' => '<string>',
    'Runtime' => 'nodejs|nodejs4.3|nodejs6.10|nodejs8.10|java8|python2.7|python3.6|python3.7|dotnetcore1.0|dotnetcore2.0|dotnetcore2.1|nodejs4.3-edge|go1.x|ruby2.5|provided',
    'Timeout' => <integer>,
    'TracingConfig' => [
        'Mode' => 'Active|PassThrough',
    ],
    'Version' => '<string>',
    'VpcConfig' => [
        'SecurityGroupIds' => ['<string>', ...],
        'SubnetIds' => ['<string>', ...],
        'VpcId' => '<string>',
    ],
]

Result Details

Members

CodeSha256

Type: string

The SHA256 hash of the function's deployment package.

CodeSize

Type: long (int|float)

The size of the function's deployment package in bytes.

DeadLetterConfig

Type: DeadLetterConfig structure

The function's dead letter queue.

Description

Type: string

The function's description.

Environment

Type: EnvironmentResponse structure

The function's environment variables.

FunctionArn

Type: string

The function's Amazon Resource Name.

FunctionName

Type: string

The name of the function.

Handler

Type: string

The function Lambda calls to begin executing your function.

KMSKeyArn

Type: string

The KMS key used to encrypt the function's environment variables. Only returned if you've configured a customer managed CMK.

LastModified

Type: string

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

Layers

Type: Array of Layer structures

A list of function layers.

MasterArn

Type: string

The ARN of the master function.

MemorySize

Type: int

The memory allocated to the function

RevisionId

Type: string

Represents the latest updated revision of the function or alias.

Role

Type: string

The function's execution role.

Runtime

Type: string

The runtime environment for the Lambda function.

Timeout

Type: int

The amount of time that Lambda allows a function to run before terminating it.

TracingConfig

Type: TracingConfigResponse structure

The function's AWS X-Ray tracing configuration.

Version

Type: string

The version of the Lambda function.

VpcConfig

Type: VpcConfigResponse structure

The function's networking configuration.

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:
Request throughput limit exceeded
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. For more information or to request a limit increase for concurrent executions, see Lambda Limits.

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. 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 Managing Concurrency.

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 alias's traffic shifting configuration.

Members

AdditionalVersionWeights

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

The name of the second alias, and the percentage of traffic that is routed to it.

CodeStorageExceededException

Description

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

Members

Type

Type: string

The exception type.

message

Type: string

DeadLetterConfig

Description

The dead letter queue for failed asynchronous invocations.

Members

TargetArn

Type: string

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

EC2AccessDeniedException

Description

Need additional permissions to configure VPC settings.

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

A function's environment variable settings.

Members

Variables

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

Environment variable key-value pairs.

EnvironmentError

Description

Error messages for environment variables that could not be applied.

Members

ErrorCode

Type: string

The error code.

Message

Type: string

The error message.

EnvironmentResponse

Description

The results of a configuration update that applied environment variables.

Members

Error

Type: EnvironmentError structure

Error messages for environment variables that could not be applied.

Variables

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

Environment variable key-value pairs.

FunctionCode

Description

The code for the Lambda function. You can specify either an S3 location, or upload a deployment package directly.

Members

S3Bucket

Type: string

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

S3Key

Type: string

The Amazon S3 key of the deployment package.

S3ObjectVersion

Type: string

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

ZipFile

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

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

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

The exception type.

message

Type: string

The exception message.

InvalidRequestContentException

Description

The request body could not be parsed as JSON.

Members

Type

Type: string

The exception type.

message

Type: string

The exception message.

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 deployment package.

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

Layer

Description

A function layer.

Members

Arn

Type: string

The Amazon Resource Name (ARN) of the function layer.

CodeSize

Type: long (int|float)

The size of the layer archive in bytes.

LayerVersionContentInput

Description

A ZIP archive that contains the contents of the function layer. You can specify either an Amazon S3 location, or upload a layer archive directly.

Members

S3Bucket

Type: string

The Amazon S3 bucket of the layer archive.

S3Key

Type: string

The Amazon S3 key of the layer archive.

S3ObjectVersion

Type: string

For versioned objects, the version of the layer archive object to use.

ZipFile

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

The base64-encoded contents of the layer archive. AWS SDK and AWS CLI clients handle the encoding for you.

LayerVersionContentOutput

Description

Details about a layer version.

Members

CodeSha256

Type: string

The SHA-256 hash of the layer archive.

CodeSize

Type: long (int|float)

The size of the layer archive in bytes.

Location

Type: string

A link to the layer archive in Amazon S3 that is valid for 10 minutes.

LayerVersionsListItem

Description

Details about a layer version.

Members

CompatibleRuntimes

Type: Array of strings

The layer's compatible runtimes.

CreatedDate

Type: string

The date that the version was created, in ISO 8601 format. For example, 2018-11-27T15:10:45.123+0000.

Description

Type: string

The description of the version.

LayerVersionArn

Type: string

The ARN of the layer version.

LicenseInfo

Type: string

The layer's open-source license.

Version

Type: long (int|float)

The version number.

LayersListItem

Description

Details about a function layer.

Members

LatestMatchingVersion

Type: LayerVersionsListItem structure

The newest version of the layer.

LayerArn

Type: string

The Amazon Resource Name (ARN) of the function layer.

LayerName

Type: string

The name of the layer.

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

The exception type.

message

Type: string

The exception message.

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

The exception type.

message

Type: string

The exception message.

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

Request throughput limit exceeded

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 function's AWS X-Ray tracing configuration.

Members

Mode

Type: string

The tracing mode.

TracingConfigResponse

Description

The function's AWS X-Ray tracing configuration.

Members

Mode

Type: string

The tracing mode.

UnsupportedMediaTypeException

Description

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

Members

Type

Type: string

message

Type: string

VpcConfig

Description

The VPC security groups and subnets attached to a Lambda function.

Members

SecurityGroupIds

Type: Array of strings

A list of VPC security groups IDs.

SubnetIds

Type: Array of strings

A list of VPC subnet IDs.

VpcConfigResponse

Description

The VPC security groups and subnets attached to a Lambda function.

Members

SecurityGroupIds

Type: Array of strings

A list of VPC security groups IDs.

SubnetIds

Type: Array of strings

A list of VPC subnet IDs.

VpcId

Type: string

The ID of the VPC.

Namespaces

Classes

Interfaces

Traits

Exceptions

Functions

AWS Lambda 2015-03-31

Operation Summary

Paginators

Operations

AddLayerVersionPermission

Parameter Syntax

Parameter Details

Members

Result Syntax

Result Details

Members

Errors

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