AWS Lambda 2015-03-31
- Client: Aws\Lambda\LambdaClient
- 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 an AWS Lambda layer.
- AddPermission ( array $params = [] )
Grants an AWS service or another account permission to use a function.
- CreateAlias ( array $params = [] )
Creates an alias for a Lambda function version.
- CreateEventSourceMapping ( array $params = [] )
Creates a mapping between an event source and an AWS Lambda function.
- CreateFunction ( array $params = [] )
Creates a Lambda function.
- DeleteAlias ( array $params = [] )
Deletes a Lambda function alias.
- DeleteEventSourceMapping ( array $params = [] )
Deletes an event source mapping.
- DeleteFunction ( array $params = [] )
Deletes a Lambda function.
- DeleteFunctionConcurrency ( array $params = [] )
Removes a concurrent execution limit from a function.
- DeleteFunctionEventInvokeConfig ( array $params = [] )
Deletes the configuration for asynchronous invocation for a function, version, or alias.
- DeleteLayerVersion ( array $params = [] )
Deletes a version of an AWS Lambda layer.
- DeleteProvisionedConcurrencyConfig ( array $params = [] )
Deletes the provisioned concurrency configuration for a function.
- GetAccountSettings ( array $params = [] )
Retrieves details about your account's limits and usage in an AWS Region.
- GetAlias ( array $params = [] )
Returns details about a Lambda function alias.
- GetEventSourceMapping ( array $params = [] )
Returns details about an event source mapping.
- GetFunction ( array $params = [] )
Returns information about the function or function version, with a link to download the deployment package that's valid for 10 minutes.
- GetFunctionConcurrency ( array $params = [] )
Returns details about the concurrency configuration for a function.
- GetFunctionConfiguration ( array $params = [] )
Returns the version-specific settings of a Lambda function or version.
- GetFunctionEventInvokeConfig ( array $params = [] )
Retrieves the configuration for asynchronous invocation for a function, version, or alias.
- GetLayerVersion ( array $params = [] )
Returns information about a version of an AWS Lambda layer, with a link to download the layer archive that's valid for 10 minutes.
- GetLayerVersionByArn ( array $params = [] )
Returns information about a version of an AWS Lambda layer, with a link to download the layer archive that's valid for 10 minutes.
- GetLayerVersionPolicy ( array $params = [] )
Returns the permission policy for a version of an AWS Lambda layer.
- GetPolicy ( array $params = [] )
Returns the resource-based IAM policy for a function, version, or alias.
- GetProvisionedConcurrencyConfig ( array $params = [] )
Retrieves the provisioned concurrency configuration for a function's alias or version.
- Invoke ( array $params = [] )
Invokes a Lambda function.
- InvokeAsync ( array $params = [] )
For asynchronous function invocation, use Invoke.
- ListAliases ( array $params = [] )
Returns a list of aliases for a Lambda function.
- ListEventSourceMappings ( array $params = [] )
Lists event source mappings.
- ListFunctionEventInvokeConfigs ( array $params = [] )
Retrieves a list of configurations for asynchronous invocation for a function.
- ListFunctions ( array $params = [] )
Returns a list of Lambda functions, with the version-specific configuration of each.
- ListLayerVersions ( array $params = [] )
Lists the versions of an AWS Lambda layer.
- ListLayers ( array $params = [] )
Lists AWS Lambda layers and shows information about the latest version of each.
- ListProvisionedConcurrencyConfigs ( array $params = [] )
Retrieves a list of provisioned concurrency configurations for a function.
- ListTags ( array $params = [] )
Returns a function's tags.
- ListVersionsByFunction ( array $params = [] )
Returns a list of versions, with the version-specific configuration of each.
- PublishLayerVersion ( array $params = [] )
Creates an AWS Lambda layer from a ZIP archive.
- PublishVersion ( array $params = [] )
Creates a version from the current code and configuration of a function.
- PutFunctionConcurrency ( array $params = [] )
Sets the maximum number of simultaneous executions for a function, and reserves capacity for that concurrency level.
- PutFunctionEventInvokeConfig ( array $params = [] )
Configures options for asynchronous invocation on a function, version, or alias.
- PutProvisionedConcurrencyConfig ( array $params = [] )
Adds a provisioned concurrency configuration to a function's alias or version.
- RemoveLayerVersionPermission ( array $params = [] )
Removes a statement from the permissions policy for a version of an AWS Lambda layer.
- RemovePermission ( array $params = [] )
Revokes function-use permission from an AWS service or another account.
- TagResource ( array $params = [] )
Adds tags to a function.
- UntagResource ( array $params = [] )
Removes tags from a function.
- UpdateAlias ( array $params = [] )
Updates the configuration of a Lambda function alias.
- UpdateEventSourceMapping ( array $params = [] )
Updates an event source mapping.
- UpdateFunctionCode ( array $params = [] )
Updates a Lambda function's code.
- UpdateFunctionConfiguration ( array $params = [] )
Modify the version-specific settings of a Lambda function.
- UpdateFunctionEventInvokeConfig ( array $params = [] )
Updates the configuration for asynchronous invocation for a function, version, or alias.
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:
Waiters
Waiters allow you to poll a resource until it enters into a desired state. A waiter has a name used to describe what it does, and is associated with an API operation. When creating a waiter, you can provide the API operation parameters associated with the corresponding operation. Waiters can be accessed using the getWaiter($waiterName, $operationParameters) method of a client object. This client supports the following waiters:
Waiter name | API Operation | Delay | Max Attempts |
---|---|---|---|
FunctionExists | GetFunction | 1 | 20 |
FunctionActive | GetFunctionConfiguration | 5 | 60 |
FunctionUpdated | GetFunctionConfiguration | 5 | 60 |
Operations
AddLayerVersionPermission
$result = $client->addLayerVersionPermission
([/* ... */]); $promise = $client->addLayerVersionPermissionAsync
([/* ... */]);
Adds permissions to the resource-based policy of a version of an AWS Lambda layer. Use this action to grant layer usage permission to other accounts. You can grant permission to a single account, all AWS accounts, or all accounts in an organization.
To revoke permission, call RemoveLayerVersionPermission with the statement ID that you specified when you added it.
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 or Amazon Resource Name (ARN) 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
Errors
-
The AWS Lambda service encountered an internal error.
-
The resource specified in the request does not exist.
-
The resource already exists, or another operation is in progress.
-
The request throughput limit was exceeded.
-
InvalidParameterValueException:
One of the parameters in the request is invalid.
-
PolicyLengthExceededException:
The permissions policy for the resource is too large. Learn more
-
The RevisionId provided does not match the latest RevisionId for the Lambda function or alias. Call the
GetFunction
or theGetAlias
API to retrieve the latest RevisionId for your resource.
AddPermission
$result = $client->addPermission
([/* ... */]); $promise = $client->addPermissionAsync
([/* ... */]);
Grants an AWS service or another account permission to use a function. You can apply the policy at the function level, or specify a qualifier to restrict access to a single version or alias. If you use a qualifier, the invoker must use the full Amazon Resource Name (ARN) of that version or alias to invoke the function.
To grant permission to another account, specify the account ID as the Principal
. For AWS services, the principal is a domain-style identifier defined by the service, like s3.amazonaws.com
or sns.amazonaws.com
. For AWS services, you can also specify the ARN or owning account of the associated resource as the SourceArn
or SourceAccount
. If you grant permission to a service principal without specifying the source, other accounts could potentially configure resources in their account to invoke your Lambda function.
This action adds a statement to a resource-based permissions policy for the function. For more information about function policies, see Lambda Function Policies.
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 action that the principal can use on the function. For example,
lambda:InvokeFunction
orlambda:GetFunction
. - EventSourceToken
-
- Type: string
For Alexa Smart Home functions, a token that must be supplied by the invoker.
- FunctionName
-
- Required: Yes
- Type: string
The name of the Lambda function, version, or alias.
Name formats
-
Function name -
my-function
(name-only),my-function:v1
(with alias). -
Function ARN -
arn:aws:lambda:us-west-2:123456789012:function:my-function
. -
Partial ARN -
123456789012:function:my-function
.
You can append a version number or alias to any of the formats. The length constraint applies only to the full ARN. If you specify only the function name, it is limited to 64 characters in length.
- Principal
-
- Required: Yes
- Type: string
The AWS service or account that invokes the function. If you specify a service, use
SourceArn
orSourceAccount
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
Only update the policy if the revision ID matches the ID that's specified. Use this option to avoid modifying a policy that has changed since you last read it.
- SourceAccount
-
- Type: string
For AWS services, the ID of the account that owns the resource. Use this instead of
SourceArn
to grant permission to resources that are owned by another account (for example, all of an account's Amazon S3 buckets). Or use it together withSourceArn
to ensure that the resource is owned by the specified account. For example, an Amazon S3 bucket could be deleted by its owner and recreated by another account. - SourceArn
-
- Type: string
For AWS services, the ARN of the AWS resource that invokes the function. For example, an Amazon S3 bucket or Amazon SNS topic.
- StatementId
-
- Required: Yes
- Type: string
A statement identifier that differentiates the statement from others in the same policy.
Result Syntax
[ 'Statement' => '<string>', ]
Result Details
Errors
-
The AWS Lambda service encountered an internal error.
-
The resource specified in the request does not exist.
-
The resource already exists, or another operation is in progress.
-
InvalidParameterValueException:
One of the parameters in the request is invalid.
-
PolicyLengthExceededException:
The permissions policy for the resource is too large. Learn more
-
The request throughput limit was exceeded.
-
The RevisionId provided does not match the latest RevisionId for the Lambda function or alias. Call the
GetFunction
or theGetAlias
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 for a Lambda function version. Use aliases to provide clients with a function identifier that you can update to invoke a different version.
You can also map an alias to split invocation requests between two versions. Use the RoutingConfig
parameter to specify a second version and the percentage of invocation requests that it receives.
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
A 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
The function version that the alias invokes.
- Name
-
- Required: Yes
- Type: string
The name of the alias.
- RoutingConfig
-
- Type: AliasRoutingConfiguration structure
The routing configuration of the alias.
Result Syntax
[ 'AliasArn' => '<string>', 'Description' => '<string>', 'FunctionVersion' => '<string>', 'Name' => '<string>', 'RevisionId' => '<string>', 'RoutingConfig' => [ 'AdditionalVersionWeights' => [<float>, ...], ], ]
Result Details
Members
- AliasArn
-
- Type: string
The Amazon Resource Name (ARN) of the alias.
- Description
-
- Type: string
A description of the alias.
- FunctionVersion
-
- Type: string
The function version that the alias invokes.
- Name
-
- Type: string
The name of the alias.
- RevisionId
-
- Type: string
A unique identifier that changes when you update the alias.
- RoutingConfig
-
- Type: AliasRoutingConfiguration structure
The routing configuration of the alias.
Errors
-
The AWS Lambda service encountered an internal error.
-
The resource specified in the request does not exist.
-
The resource already exists, or another operation is in progress.
-
InvalidParameterValueException:
One of the parameters in the request is invalid.
-
The request throughput limit was 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.
The following error handling options are only available for stream sources (DynamoDB and Kinesis):
-
BisectBatchOnFunctionError
- If the function returns an error, split the batch in two and retry. -
DestinationConfig
- Send discarded records to an Amazon SQS queue or Amazon SNS topic. -
MaximumRecordAgeInSeconds
- Discard records older than the specified age. -
MaximumRetryAttempts
- Discard records after the specified number of retries.
Parameter Syntax
$result = $client->createEventSourceMapping([ 'BatchSize' => <integer>, 'BisectBatchOnFunctionError' => true || false, 'DestinationConfig' => [ 'OnFailure' => [ 'Destination' => '<string>', ], 'OnSuccess' => [ 'Destination' => '<string>', ], ], 'Enabled' => true || false, 'EventSourceArn' => '<string>', // REQUIRED 'FunctionName' => '<string>', // REQUIRED 'MaximumBatchingWindowInSeconds' => <integer>, 'MaximumRecordAgeInSeconds' => <integer>, 'MaximumRetryAttempts' => <integer>, 'ParallelizationFactor' => <integer>, '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.
- BisectBatchOnFunctionError
-
- Type: boolean
(Streams) If the function returns an error, split the batch in two and retry.
- DestinationConfig
-
- Type: DestinationConfig structure
(Streams) An Amazon SQS queue or Amazon SNS topic destination for discarded records.
- 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.
- MaximumBatchingWindowInSeconds
-
- Type: int
The maximum amount of time to gather records before invoking the function, in seconds.
- MaximumRecordAgeInSeconds
-
- Type: int
(Streams) The maximum age of a record that Lambda sends to a function for processing.
- MaximumRetryAttempts
-
- Type: int
(Streams) The maximum number of times to retry when the function returns an error.
- ParallelizationFactor
-
- Type: int
(Streams) The number of batches to process from each shard concurrently.
- 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 toAT_TIMESTAMP
, the time from which to start reading.
Result Syntax
[ 'BatchSize' => <integer>, 'BisectBatchOnFunctionError' => true || false, 'DestinationConfig' => [ 'OnFailure' => [ 'Destination' => '<string>', ], 'OnSuccess' => [ 'Destination' => '<string>', ], ], 'EventSourceArn' => '<string>', 'FunctionArn' => '<string>', 'LastModified' => <DateTime>, 'LastProcessingResult' => '<string>', 'MaximumBatchingWindowInSeconds' => <integer>, 'MaximumRecordAgeInSeconds' => <integer>, 'MaximumRetryAttempts' => <integer>, 'ParallelizationFactor' => <integer>, 'State' => '<string>', 'StateTransitionReason' => '<string>', 'UUID' => '<string>', ]
Result Details
Members
- BatchSize
-
- Type: int
The maximum number of items to retrieve in a single batch.
- BisectBatchOnFunctionError
-
- Type: boolean
(Streams) If the function returns an error, split the batch in two and retry.
- DestinationConfig
-
- Type: DestinationConfig structure
(Streams) An Amazon SQS queue or Amazon SNS topic destination for discarded records.
- 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, or its state changed.
- LastProcessingResult
-
- Type: string
The result of the last AWS Lambda invocation of your Lambda function.
- MaximumBatchingWindowInSeconds
-
- Type: int
The maximum amount of time to gather records before invoking the function, in seconds.
- MaximumRecordAgeInSeconds
-
- Type: int
(Streams) The maximum age of a record that Lambda sends to a function for processing.
- MaximumRetryAttempts
-
- Type: int
(Streams) The maximum number of times to retry when the function returns an error.
- ParallelizationFactor
-
- Type: int
(Streams) The number of batches to process from each shard concurrently.
- State
-
- Type: string
The state of the event source mapping. It can be one of the following:
Creating
,Enabling
,Enabled
,Disabling
,Disabled
,Updating
, orDeleting
. - StateTransitionReason
-
- Type: string
Indicates whether the last change to the event source mapping was made by a user, or by the Lambda service.
- UUID
-
- Type: string
The identifier of the event source mapping.
Errors
-
The AWS Lambda service encountered an internal error.
-
InvalidParameterValueException:
One of the parameters in the request is invalid.
-
The resource already exists, or another operation is in progress.
-
The request throughput limit was exceeded.
-
The resource specified in the request does not exist.
CreateFunction
$result = $client->createFunction
([/* ... */]); $promise = $client->createFunctionAsync
([/* ... */]);
Creates a Lambda function. To create a function, you need a deployment package and an execution role. The deployment package contains your function code. The execution role grants the function permission to use AWS services, such as Amazon CloudWatch Logs for log streaming and AWS X-Ray for request tracing.
When you create a function, Lambda provisions an instance of the function and its supporting resources. If your function connects to a VPC, this process can take a minute or so. During this time, you can't invoke or modify the function. The State
, StateReason
, and StateReasonCode
fields in the response from GetFunctionConfiguration indicate when the function is ready to invoke. For more information, see Function States.
A function has an unpublished version, and can have published versions and aliases. The unpublished version changes when you update your function's code and configuration. A published version is a snapshot of your function code and configuration that can't be changed. An alias is a named resource that maps to a version, and can be changed to map to a different version. Use the Publish
parameter to create version 1
of your function from its initial configuration.
The other parameters let you configure version-specific and function-level settings. You can modify version-specific settings later with UpdateFunctionConfiguration. Function-level settings apply to both the unpublished and published versions of the function, and include tags (TagResource) and per-function concurrency limits (PutFunctionConcurrency).
If another account or an AWS service invokes your function, use AddPermission to grant permission by creating a resource-based IAM policy. You can grant permissions at the function level, on a version, or on an alias.
To invoke your function directly, use Invoke. To invoke your function in response to events in other AWS services, create an event source mapping (CreateEventSourceMapping), or configure a function trigger in the other service. For more information, see Invoking Functions.
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|nodejs10.x|nodejs12.x|java8|java11|python2.7|python3.6|python3.7|python3.8|dotnetcore1.0|dotnetcore2.0|dotnetcore2.1|nodejs4.3-edge|go1.x|ruby2.5|provided', // 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 -
my-function
. -
Function ARN -
arn:aws:lambda:us-west-2:123456789012:function:my-function
. -
Partial ARN -
123456789012:function:my-function
.
The length constraint applies only to the full ARN. If you specify only the function name, it is limited to 64 characters in length.
- Handler
-
- Required: Yes
- Type: string
The name of the method within your code that Lambda calls to execute your function. The format includes the file name. It can also include namespaces and other qualifiers, depending on the runtime. For more information, see Programming Model.
- KMSKeyArn
-
- Type: string
The ARN of the AWS Key Management Service (AWS KMS) key that's used to encrypt your function's environment variables. If it's not provided, AWS Lambda uses a default service key.
- Layers
-
- Type: Array of strings
A list of function layers to add to the function's execution environment. Specify each layer by its ARN, including the version.
- MemorySize
-
- Type: int
The amount of memory that your function has access to. Increasing the function's memory also increases its CPU allocation. The default value is 128 MB. The value must be a multiple of 64 MB.
- 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 identifier of the function's runtime.
- Tags
-
- Type: Associative array of custom strings keys (TagKey) to strings
A list of tags to apply to the function.
- Timeout
-
- Type: int
The amount of time that Lambda allows a function to run before stopping it. The default is 3 seconds. The maximum allowed value is 900 seconds.
- TracingConfig
-
- Type: TracingConfig structure
Set
Mode
toActive
to sample and trace a subset of incoming requests with AWS X-Ray. - VpcConfig
-
- Type: VpcConfig structure
For network connectivity to AWS resources in a VPC, specify a list of security groups and subnets in the VPC. When you connect a function to a VPC, it can only access resources and the internet through that VPC. For more information, see VPC Settings.
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>', 'LastUpdateStatus' => 'Successful|Failed|InProgress', 'LastUpdateStatusReason' => '<string>', 'LastUpdateStatusReasonCode' => 'EniLimitExceeded|InsufficientRolePermissions|InvalidConfiguration|InternalError', 'Layers' => [ [ 'Arn' => '<string>', 'CodeSize' => <integer>, ], // ... ], 'MasterArn' => '<string>', 'MemorySize' => <integer>, 'RevisionId' => '<string>', 'Role' => '<string>', 'Runtime' => 'nodejs|nodejs4.3|nodejs6.10|nodejs8.10|nodejs10.x|nodejs12.x|java8|java11|python2.7|python3.6|python3.7|python3.8|dotnetcore1.0|dotnetcore2.0|dotnetcore2.1|nodejs4.3-edge|go1.x|ruby2.5|provided', 'State' => 'Pending|Active|Inactive|Failed', 'StateReason' => '<string>', 'StateReasonCode' => 'Idle|Creating|Restoring|EniLimitExceeded|InsufficientRolePermissions|InvalidConfiguration|InternalError|SubnetOutOfIPAddresses', '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 (ARN).
- FunctionName
-
- Type: string
The name of the function.
- Handler
-
- Type: string
The function that Lambda calls to begin executing your function.
- KMSKeyArn
-
- Type: string
The KMS key that's used to encrypt the function's environment variables. This key is only returned if you've configured a customer managed CMK.
- LastModified
-
- Type: string
The date and time that the function was last updated, in ISO-8601 format (YYYY-MM-DDThh:mm:ss.sTZD).
- LastUpdateStatus
-
- Type: string
The status of the last update that was performed on the function.
- LastUpdateStatusReason
-
- Type: string
The reason for the last update that was performed on the function.
- LastUpdateStatusReasonCode
-
- Type: string
The reason code for the last update that was performed on the function.
- Layers
-
- Type: Array of Layer structures
The function's layers.
- MasterArn
-
- Type: string
For Lambda@Edge functions, the ARN of the master function.
- MemorySize
-
- Type: int
The memory that's allocated to the function.
- RevisionId
-
- Type: string
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.
- State
-
- Type: string
The current state of the function. When the state is
Inactive
, you can reactivate the function by invoking it. - StateReason
-
- Type: string
The reason for the function's current state.
- StateReasonCode
-
- Type: string
The reason code for the function's current state. When the code is
Creating
, you can't invoke or modify the function. - Timeout
-
- Type: int
The amount of time that Lambda allows a function to run before stopping 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
-
The AWS Lambda service encountered an internal error.
-
InvalidParameterValueException:
One of the parameters in the request is invalid.
-
The resource specified in the request does not exist.
-
The resource already exists, or another operation is in progress.
-
The request throughput limit was exceeded.
-
You have exceeded your maximum total code size per account. Learn more
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' => 'nodejs8.10', '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' => 'nodejs8.10', 'Timeout' => 123, 'Version' => '1', 'VpcConfig' => [ ], ]
DeleteAlias
$result = $client->deleteAlias
([/* ... */]); $promise = $client->deleteAliasAsync
([/* ... */]);
Deletes a Lambda function alias.
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
The name of the alias.
Result Syntax
[]
Result Details
Errors
-
The AWS Lambda service encountered an internal error.
-
InvalidParameterValueException:
One of the parameters in the request is invalid.
-
The resource already exists, or another operation is in progress.
-
The request throughput limit was 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. You can get the identifier of a mapping from the output of ListEventSourceMappings.
When you delete an event source mapping, it enters a Deleting
state and might not be completely deleted for several seconds.
Parameter Syntax
$result = $client->deleteEventSourceMapping([ 'UUID' => '<string>', // REQUIRED ]);
Parameter Details
Result Syntax
[ 'BatchSize' => <integer>, 'BisectBatchOnFunctionError' => true || false, 'DestinationConfig' => [ 'OnFailure' => [ 'Destination' => '<string>', ], 'OnSuccess' => [ 'Destination' => '<string>', ], ], 'EventSourceArn' => '<string>', 'FunctionArn' => '<string>', 'LastModified' => <DateTime>, 'LastProcessingResult' => '<string>', 'MaximumBatchingWindowInSeconds' => <integer>, 'MaximumRecordAgeInSeconds' => <integer>, 'MaximumRetryAttempts' => <integer>, 'ParallelizationFactor' => <integer>, 'State' => '<string>', 'StateTransitionReason' => '<string>', 'UUID' => '<string>', ]
Result Details
Members
- BatchSize
-
- Type: int
The maximum number of items to retrieve in a single batch.
- BisectBatchOnFunctionError
-
- Type: boolean
(Streams) If the function returns an error, split the batch in two and retry.
- DestinationConfig
-
- Type: DestinationConfig structure
(Streams) An Amazon SQS queue or Amazon SNS topic destination for discarded records.
- 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, or its state changed.
- LastProcessingResult
-
- Type: string
The result of the last AWS Lambda invocation of your Lambda function.
- MaximumBatchingWindowInSeconds
-
- Type: int
The maximum amount of time to gather records before invoking the function, in seconds.
- MaximumRecordAgeInSeconds
-
- Type: int
(Streams) The maximum age of a record that Lambda sends to a function for processing.
- MaximumRetryAttempts
-
- Type: int
(Streams) The maximum number of times to retry when the function returns an error.
- ParallelizationFactor
-
- Type: int
(Streams) The number of batches to process from each shard concurrently.
- State
-
- Type: string
The state of the event source mapping. It can be one of the following:
Creating
,Enabling
,Enabled
,Disabling
,Disabled
,Updating
, orDeleting
. - StateTransitionReason
-
- Type: string
Indicates whether the last change to the event source mapping was made by a user, or by the Lambda service.
- UUID
-
- Type: string
The identifier of the event source mapping.
Errors
-
The AWS Lambda service encountered an internal error.
-
The resource specified in the request does not exist.
-
InvalidParameterValueException:
One of the parameters in the request is invalid.
-
The request throughput limit was exceeded.
-
The operation conflicts with the resource's availability. For example, you attempted to update an EventSource Mapping in CREATING, or tried to delete a EventSource 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.
To delete Lambda event source mappings that invoke a function, use DeleteEventSourceMapping. For AWS services and resources that invoke your function directly, delete the trigger in the service where you originally configured it.
Parameter Syntax
$result = $client->deleteFunction([ 'FunctionName' => '<string>', // REQUIRED 'Qualifier' => '<string>', ]);
Parameter Details
Members
- FunctionName
-
- Required: Yes
- Type: string
The name of the Lambda function or version.
Name formats
-
Function name -
my-function
(name-only),my-function:1
(with version). -
Function ARN -
arn:aws:lambda:us-west-2:123456789012:function:my-function
. -
Partial ARN -
123456789012:function:my-function
.
You can append a version number or alias to any of the formats. The length constraint applies only to the full ARN. If you specify only the function name, it is limited to 64 characters in length.
- Qualifier
-
- Type: string
Specify a version to delete. You can't delete a version that's referenced by an alias.
Result Syntax
[]
Result Details
Errors
-
The AWS Lambda service encountered an internal error.
-
The resource specified in the request does not exist.
-
The request throughput limit was exceeded.
-
InvalidParameterValueException:
One of the parameters in the request is invalid.
-
The resource already exists, or another operation is in progress.
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 a concurrent execution limit from a function.
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 -
my-function
. -
Function ARN -
arn:aws:lambda:us-west-2:123456789012:function:my-function
. -
Partial ARN -
123456789012:function:my-function
.
The length constraint applies only to the full ARN. If you specify only the function name, it is limited to 64 characters in length.
Result Syntax
[]
Result Details
Errors
-
The AWS Lambda service encountered an internal error.
-
The resource specified in the request does not exist.
-
The request throughput limit was exceeded.
-
InvalidParameterValueException:
One of the parameters in the request is invalid.
-
The resource already exists, or another operation is in progress.
DeleteFunctionEventInvokeConfig
$result = $client->deleteFunctionEventInvokeConfig
([/* ... */]); $promise = $client->deleteFunctionEventInvokeConfigAsync
([/* ... */]);
Deletes the configuration for asynchronous invocation for a function, version, or alias.
To configure options for asynchronous invocation, use PutFunctionEventInvokeConfig.
Parameter Syntax
$result = $client->deleteFunctionEventInvokeConfig([ 'FunctionName' => '<string>', // REQUIRED 'Qualifier' => '<string>', ]);
Parameter Details
Members
- FunctionName
-
- Required: Yes
- Type: string
The name of the Lambda function, version, or alias.
Name formats
-
Function name -
my-function
(name-only),my-function:v1
(with alias). -
Function ARN -
arn:aws:lambda:us-west-2:123456789012:function:my-function
. -
Partial ARN -
123456789012:function:my-function
.
You can append a version number or alias to any of the formats. The length constraint applies only to the full ARN. If you specify only the function name, it is limited to 64 characters in length.
- Qualifier
-
- Type: string
A version number or alias name.
Result Syntax
[]
Result Details
Errors
-
The AWS Lambda service encountered an internal error.
-
The resource specified in the request does not exist.
-
InvalidParameterValueException:
One of the parameters in the request is invalid.
-
The request throughput limit was exceeded.
DeleteLayerVersion
$result = $client->deleteLayerVersion
([/* ... */]); $promise = $client->deleteLayerVersionAsync
([/* ... */]);
Deletes a version of an AWS Lambda layer. Deleted versions can no longer be viewed or added to functions. To avoid breaking functions, a copy of the version remains in Lambda until no functions refer to it.
Parameter Syntax
$result = $client->deleteLayerVersion([ 'LayerName' => '<string>', // REQUIRED 'VersionNumber' => <integer>, // REQUIRED ]);
Parameter Details
Members
Result Syntax
[]
Result Details
Errors
-
The AWS Lambda service encountered an internal error.
-
The request throughput limit was exceeded.
DeleteProvisionedConcurrencyConfig
$result = $client->deleteProvisionedConcurrencyConfig
([/* ... */]); $promise = $client->deleteProvisionedConcurrencyConfigAsync
([/* ... */]);
Deletes the provisioned concurrency configuration for a function.
Parameter Syntax
$result = $client->deleteProvisionedConcurrencyConfig([ 'FunctionName' => '<string>', // REQUIRED 'Qualifier' => '<string>', // REQUIRED ]);
Parameter Details
Members
- FunctionName
-
- Required: Yes
- Type: string
The name of the Lambda function.
Name formats
-
Function name -
my-function
. -
Function ARN -
arn:aws:lambda:us-west-2:123456789012:function:my-function
. -
Partial ARN -
123456789012:function:my-function
.
The length constraint applies only to the full ARN. If you specify only the function name, it is limited to 64 characters in length.
- Qualifier
-
- Required: Yes
- Type: string
The version number or alias name.
Result Syntax
[]
Result Details
Errors
-
InvalidParameterValueException:
One of the parameters in the request is invalid.
-
The resource already exists, or another operation is in progress.
-
The resource specified in the request does not exist.
-
The request throughput limit was exceeded.
-
The AWS Lambda service encountered an internal error.
GetAccountSettings
$result = $client->getAccountSettings
([/* ... */]); $promise = $client->getAccountSettingsAsync
([/* ... */]);
Retrieves details about your account's limits and usage in an AWS 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 that are related to concurrency and code storage.
- AccountUsage
-
- Type: AccountUsage structure
The number of functions and amount of storage in use.
Errors
-
The request throughput limit was exceeded.
-
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 details about a Lambda function alias.
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
The name of the alias.
Result Syntax
[ 'AliasArn' => '<string>', 'Description' => '<string>', 'FunctionVersion' => '<string>', 'Name' => '<string>', 'RevisionId' => '<string>', 'RoutingConfig' => [ 'AdditionalVersionWeights' => [<float>, ...], ], ]
Result Details
Members
- AliasArn
-
- Type: string
The Amazon Resource Name (ARN) of the alias.
- Description
-
- Type: string
A description of the alias.
- FunctionVersion
-
- Type: string
The function version that the alias invokes.
- Name
-
- Type: string
The name of the alias.
- RevisionId
-
- Type: string
A unique identifier that changes when you update the alias.
- RoutingConfig
-
- Type: AliasRoutingConfiguration structure
The routing configuration of the alias.
Errors
-
The AWS Lambda service encountered an internal error.
-
The resource specified in the request does not exist.
-
InvalidParameterValueException:
One of the parameters in the request is invalid.
-
The request throughput limit was 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. You can get the identifier of a mapping from the output of ListEventSourceMappings.
Parameter Syntax
$result = $client->getEventSourceMapping([ 'UUID' => '<string>', // REQUIRED ]);
Parameter Details
Result Syntax
[ 'BatchSize' => <integer>, 'BisectBatchOnFunctionError' => true || false, 'DestinationConfig' => [ 'OnFailure' => [ 'Destination' => '<string>', ], 'OnSuccess' => [ 'Destination' => '<string>', ], ], 'EventSourceArn' => '<string>', 'FunctionArn' => '<string>', 'LastModified' => <DateTime>, 'LastProcessingResult' => '<string>', 'MaximumBatchingWindowInSeconds' => <integer>, 'MaximumRecordAgeInSeconds' => <integer>, 'MaximumRetryAttempts' => <integer>, 'ParallelizationFactor' => <integer>, 'State' => '<string>', 'StateTransitionReason' => '<string>', 'UUID' => '<string>', ]
Result Details
Members
- BatchSize
-
- Type: int
The maximum number of items to retrieve in a single batch.
- BisectBatchOnFunctionError
-
- Type: boolean
(Streams) If the function returns an error, split the batch in two and retry.
- DestinationConfig
-
- Type: DestinationConfig structure
(Streams) An Amazon SQS queue or Amazon SNS topic destination for discarded records.
- 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, or its state changed.
- LastProcessingResult
-
- Type: string
The result of the last AWS Lambda invocation of your Lambda function.
- MaximumBatchingWindowInSeconds
-
- Type: int
The maximum amount of time to gather records before invoking the function, in seconds.
- MaximumRecordAgeInSeconds
-
- Type: int
(Streams) The maximum age of a record that Lambda sends to a function for processing.
- MaximumRetryAttempts
-
- Type: int
(Streams) The maximum number of times to retry when the function returns an error.
- ParallelizationFactor
-
- Type: int
(Streams) The number of batches to process from each shard concurrently.
- State
-
- Type: string
The state of the event source mapping. It can be one of the following:
Creating
,Enabling
,Enabled
,Disabling
,Disabled
,Updating
, orDeleting
. - StateTransitionReason
-
- Type: string
Indicates whether the last change to the event source mapping was made by a user, or by the Lambda service.
- UUID
-
- Type: string
The identifier of the event source mapping.
Errors
-
The AWS Lambda service encountered an internal error.
-
The resource specified in the request does not exist.
-
InvalidParameterValueException:
One of the parameters in the request is invalid.
-
The request throughput limit was 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 information about the function or function version, with a link to download the deployment package that's valid for 10 minutes. If you specify a function version, only details that are specific to that version are returned.
Parameter Syntax
$result = $client->getFunction([ 'FunctionName' => '<string>', // REQUIRED 'Qualifier' => '<string>', ]);
Parameter Details
Members
- FunctionName
-
- Required: Yes
- Type: string
The name of the Lambda function, version, or alias.
Name formats
-
Function name -
my-function
(name-only),my-function:v1
(with alias). -
Function ARN -
arn:aws:lambda:us-west-2:123456789012:function:my-function
. -
Partial ARN -
123456789012:function:my-function
.
You can append a version number or alias to any of the formats. The length constraint applies only to the full ARN. If you specify only the function name, it is limited to 64 characters in length.
- 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>', 'LastUpdateStatus' => 'Successful|Failed|InProgress', 'LastUpdateStatusReason' => '<string>', 'LastUpdateStatusReasonCode' => 'EniLimitExceeded|InsufficientRolePermissions|InvalidConfiguration|InternalError', 'Layers' => [ [ 'Arn' => '<string>', 'CodeSize' => <integer>, ], // ... ], 'MasterArn' => '<string>', 'MemorySize' => <integer>, 'RevisionId' => '<string>', 'Role' => '<string>', 'Runtime' => 'nodejs|nodejs4.3|nodejs6.10|nodejs8.10|nodejs10.x|nodejs12.x|java8|java11|python2.7|python3.6|python3.7|python3.8|dotnetcore1.0|dotnetcore2.0|dotnetcore2.1|nodejs4.3-edge|go1.x|ruby2.5|provided', 'State' => 'Pending|Active|Inactive|Failed', 'StateReason' => '<string>', 'StateReasonCode' => 'Idle|Creating|Restoring|EniLimitExceeded|InsufficientRolePermissions|InvalidConfiguration|InternalError|SubnetOutOfIPAddresses', '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 deployment package of the function or version.
- Concurrency
-
- Type: Concurrency structure
The function's reserved concurrency.
- Configuration
-
- Type: FunctionConfiguration structure
The configuration of the function or version.
- Tags
-
- Type: Associative array of custom strings keys (TagKey) to strings
The function's tags.
Errors
-
The AWS Lambda service encountered an internal error.
-
The resource specified in the request does not exist.
-
The request throughput limit was exceeded.
-
InvalidParameterValueException:
One of the parameters in the request is invalid.
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' => 'nodejs8.10', 'Timeout' => 3, 'Version' => '$LATEST', 'VpcConfig' => [ 'SecurityGroupIds' => [ ], 'SubnetIds' => [ ], ], ], ]
GetFunctionConcurrency
$result = $client->getFunctionConcurrency
([/* ... */]); $promise = $client->getFunctionConcurrencyAsync
([/* ... */]);
Returns details about the concurrency configuration for a function. To set a concurrency limit for a function, use PutFunctionConcurrency.
Parameter Syntax
$result = $client->getFunctionConcurrency([ 'FunctionName' => '<string>', // REQUIRED ]);
Parameter Details
Members
- FunctionName
-
- Required: Yes
- Type: string
The name of the Lambda function.
Name formats
-
Function name -
my-function
. -
Function ARN -
arn:aws:lambda:us-west-2:123456789012:function:my-function
. -
Partial ARN -
123456789012:function:my-function
.
The length constraint applies only to the full ARN. If you specify only the function name, it is limited to 64 characters in length.
Result Syntax
[ 'ReservedConcurrentExecutions' => <integer>, ]
Result Details
Members
Errors
-
InvalidParameterValueException:
One of the parameters in the request is invalid.
-
The resource specified in the request does not exist.
-
The request throughput limit was exceeded.
-
The AWS Lambda service encountered an internal error.
GetFunctionConfiguration
$result = $client->getFunctionConfiguration
([/* ... */]); $promise = $client->getFunctionConfigurationAsync
([/* ... */]);
Returns the version-specific settings of a Lambda function or version. The output includes only options that can vary between versions of a function. To modify these settings, use UpdateFunctionConfiguration.
To get all of a function's details, including function-level settings, use GetFunction.
Parameter Syntax
$result = $client->getFunctionConfiguration([ 'FunctionName' => '<string>', // REQUIRED 'Qualifier' => '<string>', ]);
Parameter Details
Members
- FunctionName
-
- Required: Yes
- Type: string
The name of the Lambda function, version, or alias.
Name formats
-
Function name -
my-function
(name-only),my-function:v1
(with alias). -
Function ARN -
arn:aws:lambda:us-west-2:123456789012:function:my-function
. -
Partial ARN -
123456789012:function:my-function
.
You can append a version number or alias to any of the formats. The length constraint applies only to the full ARN. If you specify only the function name, it is limited to 64 characters in length.
- 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>', 'LastUpdateStatus' => 'Successful|Failed|InProgress', 'LastUpdateStatusReason' => '<string>', 'LastUpdateStatusReasonCode' => 'EniLimitExceeded|InsufficientRolePermissions|InvalidConfiguration|InternalError', 'Layers' => [ [ 'Arn' => '<string>', 'CodeSize' => <integer>, ], // ... ], 'MasterArn' => '<string>', 'MemorySize' => <integer>, 'RevisionId' => '<string>', 'Role' => '<string>', 'Runtime' => 'nodejs|nodejs4.3|nodejs6.10|nodejs8.10|nodejs10.x|nodejs12.x|java8|java11|python2.7|python3.6|python3.7|python3.8|dotnetcore1.0|dotnetcore2.0|dotnetcore2.1|nodejs4.3-edge|go1.x|ruby2.5|provided', 'State' => 'Pending|Active|Inactive|Failed', 'StateReason' => '<string>', 'StateReasonCode' => 'Idle|Creating|Restoring|EniLimitExceeded|InsufficientRolePermissions|InvalidConfiguration|InternalError|SubnetOutOfIPAddresses', '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 (ARN).
- FunctionName
-
- Type: string
The name of the function.
- Handler
-
- Type: string
The function that Lambda calls to begin executing your function.
- KMSKeyArn
-
- Type: string
The KMS key that's used to encrypt the function's environment variables. This key is only returned if you've configured a customer managed CMK.
- LastModified
-
- Type: string
The date and time that the function was last updated, in ISO-8601 format (YYYY-MM-DDThh:mm:ss.sTZD).
- LastUpdateStatus
-
- Type: string
The status of the last update that was performed on the function.
- LastUpdateStatusReason
-
- Type: string
The reason for the last update that was performed on the function.
- LastUpdateStatusReasonCode
-
- Type: string
The reason code for the last update that was performed on the function.
- Layers
-
- Type: Array of Layer structures
The function's layers.
- MasterArn
-
- Type: string
For Lambda@Edge functions, the ARN of the master function.
- MemorySize
-
- Type: int
The memory that's allocated to the function.
- RevisionId
-
- Type: string
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.
- State
-
- Type: string
The current state of the function. When the state is
Inactive
, you can reactivate the function by invoking it. - StateReason
-
- Type: string
The reason for the function's current state.
- StateReasonCode
-
- Type: string
The reason code for the function's current state. When the code is
Creating
, you can't invoke or modify the function. - Timeout
-
- Type: int
The amount of time that Lambda allows a function to run before stopping 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
-
The AWS Lambda service encountered an internal error.
-
The resource specified in the request does not exist.
-
The request throughput limit was exceeded.
-
InvalidParameterValueException:
One of the parameters in the request is invalid.
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' => [ ], ]
GetFunctionEventInvokeConfig
$result = $client->getFunctionEventInvokeConfig
([/* ... */]); $promise = $client->getFunctionEventInvokeConfigAsync
([/* ... */]);
Retrieves the configuration for asynchronous invocation for a function, version, or alias.
To configure options for asynchronous invocation, use PutFunctionEventInvokeConfig.
Parameter Syntax
$result = $client->getFunctionEventInvokeConfig([ 'FunctionName' => '<string>', // REQUIRED 'Qualifier' => '<string>', ]);
Parameter Details
Members
- FunctionName
-
- Required: Yes
- Type: string
The name of the Lambda function, version, or alias.
Name formats
-
Function name -
my-function
(name-only),my-function:v1
(with alias). -
Function ARN -
arn:aws:lambda:us-west-2:123456789012:function:my-function
. -
Partial ARN -
123456789012:function:my-function
.
You can append a version number or alias to any of the formats. The length constraint applies only to the full ARN. If you specify only the function name, it is limited to 64 characters in length.
- Qualifier
-
- Type: string
A version number or alias name.
Result Syntax
[ 'DestinationConfig' => [ 'OnFailure' => [ 'Destination' => '<string>', ], 'OnSuccess' => [ 'Destination' => '<string>', ], ], 'FunctionArn' => '<string>', 'LastModified' => <DateTime>, 'MaximumEventAgeInSeconds' => <integer>, 'MaximumRetryAttempts' => <integer>, ]
Result Details
Members
- DestinationConfig
-
- Type: DestinationConfig structure
A destination for events after they have been sent to a function for processing.
Destinations
-
Function - The Amazon Resource Name (ARN) of a Lambda function.
-
Queue - The ARN of an SQS queue.
-
Topic - The ARN of an SNS topic.
-
Event Bus - The ARN of an Amazon EventBridge event bus.
- FunctionArn
-
- Type: string
The Amazon Resource Name (ARN) of the function.
- LastModified
-
- Type: timestamp (string|DateTime or anything parsable by strtotime)
The date and time that the configuration was last updated.
- MaximumEventAgeInSeconds
-
- Type: int
The maximum age of a request that Lambda sends to a function for processing.
- MaximumRetryAttempts
-
- Type: int
The maximum number of times to retry when the function returns an error.
Errors
-
The AWS Lambda service encountered an internal error.
-
The resource specified in the request does not exist.
-
InvalidParameterValueException:
One of the parameters in the request is invalid.
-
The request throughput limit was exceeded.
GetLayerVersion
$result = $client->getLayerVersion
([/* ... */]); $promise = $client->getLayerVersionAsync
([/* ... */]);
Returns information about a version of an AWS Lambda 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
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 ARN of the 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
-
The AWS Lambda service encountered an internal error.
-
InvalidParameterValueException:
One of the parameters in the request is invalid.
-
The request throughput limit was exceeded.
-
The resource specified in the request does not exist.
GetLayerVersionByArn
$result = $client->getLayerVersionByArn
([/* ... */]); $promise = $client->getLayerVersionByArnAsync
([/* ... */]);
Returns information about a version of an AWS Lambda layer, with a link to download the layer archive that's valid for 10 minutes.
Parameter Syntax
$result = $client->getLayerVersionByArn([ 'Arn' => '<string>', // REQUIRED ]);
Parameter Details
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 ARN of the 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
-
The AWS Lambda service encountered an internal error.
-
InvalidParameterValueException:
One of the parameters in the request is invalid.
-
The request throughput limit was exceeded.
-
The resource specified in the request does not exist.
GetLayerVersionPolicy
$result = $client->getLayerVersionPolicy
([/* ... */]); $promise = $client->getLayerVersionPolicyAsync
([/* ... */]);
Returns the permission policy for a version of an AWS Lambda layer. For more information, see AddLayerVersionPermission.
Parameter Syntax
$result = $client->getLayerVersionPolicy([ 'LayerName' => '<string>', // REQUIRED 'VersionNumber' => <integer>, // REQUIRED ]);
Parameter Details
Members
Result Syntax
[ 'Policy' => '<string>', 'RevisionId' => '<string>', ]
Result Details
Members
Errors
-
The AWS Lambda service encountered an internal error.
-
The resource specified in the request does not exist.
-
The request throughput limit was exceeded.
-
InvalidParameterValueException:
One of the parameters in the request is invalid.
GetPolicy
$result = $client->getPolicy
([/* ... */]); $promise = $client->getPolicyAsync
([/* ... */]);
Returns the resource-based IAM policy for a function, version, or alias.
Parameter Syntax
$result = $client->getPolicy([ 'FunctionName' => '<string>', // REQUIRED 'Qualifier' => '<string>', ]);
Parameter Details
Members
- FunctionName
-
- Required: Yes
- Type: string
The name of the Lambda function, version, or alias.
Name formats
-
Function name -
my-function
(name-only),my-function:v1
(with alias). -
Function ARN -
arn:aws:lambda:us-west-2:123456789012:function:my-function
. -
Partial ARN -
123456789012:function:my-function
.
You can append a version number or alias to any of the formats. The length constraint applies only to the full ARN. If you specify only the function name, it is limited to 64 characters in length.
- Qualifier
-
- Type: string
Specify a version or alias to get the policy for that resource.
Result Syntax
[ 'Policy' => '<string>', 'RevisionId' => '<string>', ]
Result Details
Members
Errors
-
The AWS Lambda service encountered an internal error.
-
The resource specified in the request does not exist.
-
The request throughput limit was exceeded.
-
InvalidParameterValueException:
One of the parameters in the request is invalid.
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' => '', ]
GetProvisionedConcurrencyConfig
$result = $client->getProvisionedConcurrencyConfig
([/* ... */]); $promise = $client->getProvisionedConcurrencyConfigAsync
([/* ... */]);
Retrieves the provisioned concurrency configuration for a function's alias or version.
Parameter Syntax
$result = $client->getProvisionedConcurrencyConfig([ 'FunctionName' => '<string>', // REQUIRED 'Qualifier' => '<string>', // REQUIRED ]);
Parameter Details
Members
- FunctionName
-
- Required: Yes
- Type: string
The name of the Lambda function.
Name formats
-
Function name -
my-function
. -
Function ARN -
arn:aws:lambda:us-west-2:123456789012:function:my-function
. -
Partial ARN -
123456789012:function:my-function
.
The length constraint applies only to the full ARN. If you specify only the function name, it is limited to 64 characters in length.
- Qualifier
-
- Required: Yes
- Type: string
The version number or alias name.
Result Syntax
[ 'AllocatedProvisionedConcurrentExecutions' => <integer>, 'AvailableProvisionedConcurrentExecutions' => <integer>, 'LastModified' => '<string>', 'RequestedProvisionedConcurrentExecutions' => <integer>, 'Status' => 'IN_PROGRESS|READY|FAILED', 'StatusReason' => '<string>', ]
Result Details
Members
- AllocatedProvisionedConcurrentExecutions
-
- Type: int
The amount of provisioned concurrency allocated.
- AvailableProvisionedConcurrentExecutions
-
- Type: int
The amount of provisioned concurrency available.
- LastModified
-
- Type: string
The date and time that a user last updated the configuration, in ISO 8601 format.
- RequestedProvisionedConcurrentExecutions
-
- Type: int
The amount of provisioned concurrency requested.
- Status
-
- Type: string
The status of the allocation process.
- StatusReason
-
- Type: string
For failed allocations, the reason that provisioned concurrency could not be allocated.
Errors
-
InvalidParameterValueException:
One of the parameters in the request is invalid.
-
The resource specified in the request does not exist.
-
The request throughput limit was exceeded.
-
The AWS Lambda service encountered an internal error.
-
ProvisionedConcurrencyConfigNotFoundException:
The specified configuration does not exist.
Invoke
$result = $client->invoke
([/* ... */]); $promise = $client->invokeAsync
([/* ... */]);
Invokes a Lambda function. You can invoke a function synchronously (and wait for the response), or asynchronously. To invoke a function asynchronously, set InvocationType
to Event
.
For synchronous invocation, details about the function response, including errors, are included in the response body and headers. For either invocation type, you can find more information in the execution log and trace.
When an error occurs, your function may be invoked multiple times. Retry behavior varies by error type, client, event source, and invocation type. For example, if you invoke a function asynchronously and it returns an error, Lambda executes the function up to two more times. For more information, see Retry Behavior.
For asynchronous invocation, Lambda adds events to a queue before sending them to your function. If your function does not have enough capacity to keep up with the queue, events may be lost. Occasionally, your function may receive the same event multiple times, even if no error occurs. To retain events that were not processed, configure your function with a dead-letter queue.
The status code in the API response doesn't reflect function errors. Error codes are reserved for errors that prevent your function from executing, such as permissions errors, limit errors, or issues with your function's code and configuration. For example, Lambda returns TooManyRequestsException
if executing the function would cause you to exceed a concurrency limit at either the account level (ConcurrentInvocationLimitExceeded
) or function level (ReservedFunctionConcurrentInvocationLimitExceeded
).
For functions with a long timeout, your client might be disconnected during synchronous invocation while it waits for a response. Configure your HTTP client, SDK, firewall, proxy, or operating system to allow for long connections with timeout or keep-alive settings.
This operation requires permission for the lambda:InvokeFunction
action.
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
Up to 3583 bytes of base64-encoded data about the invoking client to pass to the function in the context object.
- FunctionName
-
- Required: Yes
- Type: string
The name of the Lambda function, version, or alias.
Name formats
-
Function name -
my-function
(name-only),my-function:v1
(with alias). -
Function ARN -
arn:aws:lambda:us-west-2:123456789012:function:my-function
. -
Partial ARN -
123456789012:function:my-function
.
You can append a version number or alias to any of the formats. The length constraint applies only to the full ARN. If you specify only the function name, it is limited to 64 characters in length.
- 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. The API response includes the function response and additional data. -
Event
- Invoke the function asynchronously. Send events that fail multiple times to the function's dead-letter queue (if it's configured). The API response only includes a status code. -
DryRun
- Validate parameter values and verify that the user or role has permission to invoke the function.
- LogType
-
- Type: string
Set to
Tail
to include the execution log in the response. - Payload
-
- Type: blob (string|resource|Psr\Http\Message\StreamInterface)
The 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 version of the function that executed. When you invoke a function with an alias, this indicates which version the alias resolved to.
- FunctionError
-
- Type: string
If present, indicates that an error occurred during function execution. Details about the error are included in the response payload.
-
Handled
- The runtime caught an error thrown by the function and formatted it into a JSON document. -
Unhandled
- The runtime didn't handle the error. For example, the function ran out of memory or timed out.
- LogResult
-
- Type: string
The last 4 KB of the execution log, which is base64 encoded.
- Payload
-
- Type: blob (string|resource|Psr\Http\Message\StreamInterface)
The response from the function, or an error object.
- StatusCode
-
- Type: int
The HTTP status code is in the 200 range for a successful request. For the
RequestResponse
invocation type, this status code is 200. For theEvent
invocation type, this status code is 202. For theDryRun
invocation type, the status code is 204.
Errors
-
The AWS Lambda service encountered an internal error.
-
The resource specified in the request does not exist.
-
InvalidRequestContentException:
The request body could not be parsed as JSON.
-
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. -
The request throughput limit was exceeded.
-
InvalidParameterValueException:
One of the parameters in the request is invalid.
-
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.
-
AWS Lambda was not able to create an elastic network interface in the VPC, specified as part of Lambda function configuration, because the limit for network interfaces has been reached.
-
AWS Lambda was throttled by Amazon EC2 during Lambda function initialization using the execution role provided for the Lambda function.
-
Need additional permissions to configure VPC settings.
-
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.
-
AWS Lambda could not unzip the deployment package.
-
Lambda was unable to decrypt the environment variables because the KMS key used is disabled. Check the Lambda function's KMS key settings.
-
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.
-
Lambda was unable to decrypt the environment variables because KMS access was denied. Check the Lambda function's KMS permissions.
-
Lambda was unable to decrypt the environment variables because the KMS key was not found. Check the function's KMS key settings.
-
The runtime or runtime version specified is not supported.
-
The resource already exists, or another operation is in progress.
-
The function is inactive and its VPC connection is no longer available. Wait for the VPC connection to reestablish and try again.
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.
Invokes a function asynchronously.
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 -
my-function
. -
Function ARN -
arn:aws:lambda:us-west-2:123456789012:function:my-function
. -
Partial ARN -
123456789012:function:my-function
.
The length constraint applies only to the full ARN. If you specify only the function name, it is limited to 64 characters in length.
- InvokeArgs
-
- Required: Yes
- Type: blob (string|resource|Psr\Http\Message\StreamInterface)
The JSON that you want to provide to your Lambda function as input.
Result Syntax
[ 'Status' => <integer>, ]
Result Details
Errors
-
The AWS Lambda service encountered an internal error.
-
The resource specified in the request does not exist.
-
InvalidRequestContentException:
The request body could not be parsed as JSON.
-
The runtime or runtime version specified is not supported.
-
The resource already exists, or another operation is in progress.
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 a list of aliases for a Lambda function.
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
Specify a function version to only list aliases that invoke that version.
- Marker
-
- Type: string
Specify the pagination token that's returned by a previous request to retrieve the next page of results.
- MaxItems
-
- Type: int
Limit the number of aliases returned.
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
The pagination token that's included if more results are available.
Errors
-
The AWS Lambda service encountered an internal error.
-
The resource specified in the request does not exist.
-
InvalidParameterValueException:
One of the parameters in the request is invalid.
-
The request throughput limit was 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>, 'BisectBatchOnFunctionError' => true || false, 'DestinationConfig' => [ 'OnFailure' => [ 'Destination' => '<string>', ], 'OnSuccess' => [ 'Destination' => '<string>', ], ], 'EventSourceArn' => '<string>', 'FunctionArn' => '<string>', 'LastModified' => <DateTime>, 'LastProcessingResult' => '<string>', 'MaximumBatchingWindowInSeconds' => <integer>, 'MaximumRecordAgeInSeconds' => <integer>, 'MaximumRetryAttempts' => <integer>, 'ParallelizationFactor' => <integer>, '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
-
The AWS Lambda service encountered an internal error.
-
The resource specified in the request does not exist.
-
InvalidParameterValueException:
One of the parameters in the request is invalid.
-
The request throughput limit was exceeded.
ListFunctionEventInvokeConfigs
$result = $client->listFunctionEventInvokeConfigs
([/* ... */]); $promise = $client->listFunctionEventInvokeConfigsAsync
([/* ... */]);
Retrieves a list of configurations for asynchronous invocation for a function.
To configure options for asynchronous invocation, use PutFunctionEventInvokeConfig.
Parameter Syntax
$result = $client->listFunctionEventInvokeConfigs([ '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 -
my-function
. -
Function ARN -
arn:aws:lambda:us-west-2:123456789012:function:my-function
. -
Partial ARN -
123456789012:function:my-function
.
The length constraint applies only to the full ARN. If you specify only the function name, it is limited to 64 characters in length.
- Marker
-
- Type: string
Specify the pagination token that's returned by a previous request to retrieve the next page of results.
- MaxItems
-
- Type: int
The maximum number of configurations to return.
Result Syntax
[ 'FunctionEventInvokeConfigs' => [ [ 'DestinationConfig' => [ 'OnFailure' => [ 'Destination' => '<string>', ], 'OnSuccess' => [ 'Destination' => '<string>', ], ], 'FunctionArn' => '<string>', 'LastModified' => <DateTime>, 'MaximumEventAgeInSeconds' => <integer>, 'MaximumRetryAttempts' => <integer>, ], // ... ], 'NextMarker' => '<string>', ]
Result Details
Members
- FunctionEventInvokeConfigs
-
- Type: Array of FunctionEventInvokeConfig structures
A list of configurations.
- NextMarker
-
- Type: string
The pagination token that's included if more results are available.
Errors
-
InvalidParameterValueException:
One of the parameters in the request is invalid.
-
The resource specified in the request does not exist.
-
The request throughput limit was exceeded.
-
The AWS Lambda service encountered an internal error.
ListFunctions
$result = $client->listFunctions
([/* ... */]); $promise = $client->listFunctionsAsync
([/* ... */]);
Returns a list of Lambda functions, with the version-specific configuration of each.
Set FunctionVersion
to ALL
to include all published versions of each function in addition to the unpublished version. To get more information about a function or version, use GetFunction.
Parameter Syntax
$result = $client->listFunctions([ 'FunctionVersion' => 'ALL', 'Marker' => '<string>', 'MasterRegion' => '<string>', 'MaxItems' => <integer>, ]);
Parameter Details
Members
- FunctionVersion
-
- Type: string
Set to
ALL
to include entries for all published versions of each function. - Marker
-
- Type: string
Specify the pagination token that's returned by a previous request to retrieve the next page of results.
- MasterRegion
-
- Type: string
For Lambda@Edge functions, the AWS Region of the master function. For example,
us-east-2
orALL
. If specified, you must setFunctionVersion
toALL
. - MaxItems
-
- Type: int
Specify a value between 1 and 50 to limit the number of functions in the response.
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>', 'LastUpdateStatus' => 'Successful|Failed|InProgress', 'LastUpdateStatusReason' => '<string>', 'LastUpdateStatusReasonCode' => 'EniLimitExceeded|InsufficientRolePermissions|InvalidConfiguration|InternalError', 'Layers' => [ [ 'Arn' => '<string>', 'CodeSize' => <integer>, ], // ... ], 'MasterArn' => '<string>', 'MemorySize' => <integer>, 'RevisionId' => '<string>', 'Role' => '<string>', 'Runtime' => 'nodejs|nodejs4.3|nodejs6.10|nodejs8.10|nodejs10.x|nodejs12.x|java8|java11|python2.7|python3.6|python3.7|python3.8|dotnetcore1.0|dotnetcore2.0|dotnetcore2.1|nodejs4.3-edge|go1.x|ruby2.5|provided', 'State' => 'Pending|Active|Inactive|Failed', 'StateReason' => '<string>', 'StateReasonCode' => 'Idle|Creating|Restoring|EniLimitExceeded|InsufficientRolePermissions|InvalidConfiguration|InternalError|SubnetOutOfIPAddresses', '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
The pagination token that's included if more results are available.
Errors
-
The AWS Lambda service encountered an internal error.
-
The request throughput limit was exceeded.
-
InvalidParameterValueException:
One of the parameters in the request is invalid.
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 an AWS Lambda layer. Versions that have been deleted aren't listed. Specify a runtime identifier to list only versions that indicate that they're compatible with that runtime.
Parameter Syntax
$result = $client->listLayerVersions([ 'CompatibleRuntime' => 'nodejs|nodejs4.3|nodejs6.10|nodejs8.10|nodejs10.x|nodejs12.x|java8|java11|python2.7|python3.6|python3.7|python3.8|dotnetcore1.0|dotnetcore2.0|dotnetcore2.1|nodejs4.3-edge|go1.x|ruby2.5|provided', 'LayerName' => '<string>', // REQUIRED 'Marker' => '<string>', 'MaxItems' => <integer>, ]);
Parameter Details
Members
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
-
The AWS Lambda service encountered an internal error.
-
InvalidParameterValueException:
One of the parameters in the request is invalid.
-
The resource specified in the request does not exist.
-
The request throughput limit was exceeded.
ListLayers
$result = $client->listLayers
([/* ... */]); $promise = $client->listLayersAsync
([/* ... */]);
Lists AWS Lambda layers and shows information about the latest version of each. Specify a runtime identifier to list only layers that indicate that they're compatible with that runtime.
Parameter Syntax
$result = $client->listLayers([ 'CompatibleRuntime' => 'nodejs|nodejs4.3|nodejs6.10|nodejs8.10|nodejs10.x|nodejs12.x|java8|java11|python2.7|python3.6|python3.7|python3.8|dotnetcore1.0|dotnetcore2.0|dotnetcore2.1|nodejs4.3-edge|go1.x|ruby2.5|provided', 'Marker' => '<string>', 'MaxItems' => <integer>, ]);
Parameter Details
Members
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
-
The AWS Lambda service encountered an internal error.
-
InvalidParameterValueException:
One of the parameters in the request is invalid.
-
The request throughput limit was exceeded.
ListProvisionedConcurrencyConfigs
$result = $client->listProvisionedConcurrencyConfigs
([/* ... */]); $promise = $client->listProvisionedConcurrencyConfigsAsync
([/* ... */]);
Retrieves a list of provisioned concurrency configurations for a function.
Parameter Syntax
$result = $client->listProvisionedConcurrencyConfigs([ '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 -
my-function
. -
Function ARN -
arn:aws:lambda:us-west-2:123456789012:function:my-function
. -
Partial ARN -
123456789012:function:my-function
.
The length constraint applies only to the full ARN. If you specify only the function name, it is limited to 64 characters in length.
- Marker
-
- Type: string
Specify the pagination token that's returned by a previous request to retrieve the next page of results.
- MaxItems
-
- Type: int
Specify a number to limit the number of configurations returned.
Result Syntax
[ 'NextMarker' => '<string>', 'ProvisionedConcurrencyConfigs' => [ [ 'AllocatedProvisionedConcurrentExecutions' => <integer>, 'AvailableProvisionedConcurrentExecutions' => <integer>, 'FunctionArn' => '<string>', 'LastModified' => '<string>', 'RequestedProvisionedConcurrentExecutions' => <integer>, 'Status' => 'IN_PROGRESS|READY|FAILED', 'StatusReason' => '<string>', ], // ... ], ]
Result Details
Members
- NextMarker
-
- Type: string
The pagination token that's included if more results are available.
- ProvisionedConcurrencyConfigs
-
- Type: Array of ProvisionedConcurrencyConfigListItem structures
A list of provisioned concurrency configurations.
Errors
-
InvalidParameterValueException:
One of the parameters in the request is invalid.
-
The resource specified in the request does not exist.
-
The request throughput limit was exceeded.
-
The AWS Lambda service encountered an internal error.
ListTags
$result = $client->listTags
([/* ... */]); $promise = $client->listTagsAsync
([/* ... */]);
Returns a function's tags. You can also view tags with GetFunction.
Parameter Syntax
$result = $client->listTags([ 'Resource' => '<string>', // REQUIRED ]);
Parameter Details
Result Syntax
[ 'Tags' => ['<string>', ...], ]
Result Details
Members
Errors
-
The AWS Lambda service encountered an internal error.
-
The resource specified in the request does not exist.
-
InvalidParameterValueException:
One of the parameters in the request is invalid.
-
The request throughput limit was exceeded.
ListVersionsByFunction
$result = $client->listVersionsByFunction
([/* ... */]); $promise = $client->listVersionsByFunctionAsync
([/* ... */]);
Returns a list of versions, with the version-specific configuration of each.
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
Specify the pagination token that's returned by a previous request to retrieve the next page of results.
- MaxItems
-
- Type: int
Limit the number of versions that are returned.
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>', 'LastUpdateStatus' => 'Successful|Failed|InProgress', 'LastUpdateStatusReason' => '<string>', 'LastUpdateStatusReasonCode' => 'EniLimitExceeded|InsufficientRolePermissions|InvalidConfiguration|InternalError', 'Layers' => [ [ 'Arn' => '<string>', 'CodeSize' => <integer>, ], // ... ], 'MasterArn' => '<string>', 'MemorySize' => <integer>, 'RevisionId' => '<string>', 'Role' => '<string>', 'Runtime' => 'nodejs|nodejs4.3|nodejs6.10|nodejs8.10|nodejs10.x|nodejs12.x|java8|java11|python2.7|python3.6|python3.7|python3.8|dotnetcore1.0|dotnetcore2.0|dotnetcore2.1|nodejs4.3-edge|go1.x|ruby2.5|provided', 'State' => 'Pending|Active|Inactive|Failed', 'StateReason' => '<string>', 'StateReasonCode' => 'Idle|Creating|Restoring|EniLimitExceeded|InsufficientRolePermissions|InvalidConfiguration|InternalError|SubnetOutOfIPAddresses', 'Timeout' => <integer>, 'TracingConfig' => [ 'Mode' => 'Active|PassThrough', ], 'Version' => '<string>', 'VpcConfig' => [ 'SecurityGroupIds' => ['<string>', ...], 'SubnetIds' => ['<string>', ...], 'VpcId' => '<string>', ], ], // ... ], ]
Result Details
Members
- NextMarker
-
- Type: string
The pagination token that's included if more results are available.
- Versions
-
- Type: Array of FunctionConfiguration structures
A list of Lambda function versions.
Errors
-
The AWS Lambda service encountered an internal error.
-
The resource specified in the request does not exist.
-
InvalidParameterValueException:
One of the parameters in the request is invalid.
-
The request throughput limit was 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 an AWS Lambda layer from a ZIP archive. Each time you call PublishLayerVersion
with the same layer name, a new version is created.
Add layers to your function with CreateFunction or UpdateFunctionConfiguration.
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 or Amazon Resource Name (ARN) 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 ARN of the 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
-
The AWS Lambda service encountered an internal error.
-
The resource specified in the request does not exist.
-
The request throughput limit was exceeded.
-
InvalidParameterValueException:
One of the parameters in the request is invalid.
-
You have exceeded your maximum total code size per account. Learn more
PublishVersion
$result = $client->publishVersion
([/* ... */]); $promise = $client->publishVersionAsync
([/* ... */]);
Creates a version from the current code and configuration of a function. Use versions to create a snapshot of your function code and configuration that doesn't change.
AWS Lambda doesn't publish a version if the function's configuration and code haven't changed since the last version. Use UpdateFunctionCode or UpdateFunctionConfiguration to update the function before publishing a version.
Clients can invoke versions directly or with an alias. To create an alias, use CreateAlias.
Parameter Syntax
$result = $client->publishVersion([ 'CodeSha256' => '<string>', 'Description' => '<string>', 'FunctionName' => '<string>', // REQUIRED 'RevisionId' => '<string>', ]);
Parameter Details
Members
- CodeSha256
-
- Type: string
Only publish a version if the hash value matches the value that's specified. Use this option to avoid publishing a version if the function code has changed since you last updated it. You can get the hash for the version that you uploaded from the output of UpdateFunctionCode.
- Description
-
- Type: string
A description for the version to override the description in the function configuration.
- 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
Only update the function if the revision ID matches the ID that's specified. Use this option to avoid publishing a version if the function configuration has changed since you last updated it.
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>', 'LastUpdateStatus' => 'Successful|Failed|InProgress', 'LastUpdateStatusReason' => '<string>', 'LastUpdateStatusReasonCode' => 'EniLimitExceeded|InsufficientRolePermissions|InvalidConfiguration|InternalError', 'Layers' => [ [ 'Arn' => '<string>', 'CodeSize' => <integer>, ], // ... ], 'MasterArn' => '<string>', 'MemorySize' => <integer>, 'RevisionId' => '<string>', 'Role' => '<string>', 'Runtime' => 'nodejs|nodejs4.3|nodejs6.10|nodejs8.10|nodejs10.x|nodejs12.x|java8|java11|python2.7|python3.6|python3.7|python3.8|dotnetcore1.0|dotnetcore2.0|dotnetcore2.1|nodejs4.3-edge|go1.x|ruby2.5|provided', 'State' => 'Pending|Active|Inactive|Failed', 'StateReason' => '<string>', 'StateReasonCode' => 'Idle|Creating|Restoring|EniLimitExceeded|InsufficientRolePermissions|InvalidConfiguration|InternalError|SubnetOutOfIPAddresses', '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 (ARN).
- FunctionName
-
- Type: string
The name of the function.
- Handler
-
- Type: string
The function that Lambda calls to begin executing your function.
- KMSKeyArn
-
- Type: string
The KMS key that's used to encrypt the function's environment variables. This key is only returned if you've configured a customer managed CMK.
- LastModified
-
- Type: string
The date and time that the function was last updated, in ISO-8601 format (YYYY-MM-DDThh:mm:ss.sTZD).
- LastUpdateStatus
-
- Type: string
The status of the last update that was performed on the function.
- LastUpdateStatusReason
-
- Type: string
The reason for the last update that was performed on the function.
- LastUpdateStatusReasonCode
-
- Type: string
The reason code for the last update that was performed on the function.
- Layers
-
- Type: Array of Layer structures
The function's layers.
- MasterArn
-
- Type: string
For Lambda@Edge functions, the ARN of the master function.
- MemorySize
-
- Type: int
The memory that's allocated to the function.
- RevisionId
-
- Type: string
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.
- State
-
- Type: string
The current state of the function. When the state is
Inactive
, you can reactivate the function by invoking it. - StateReason
-
- Type: string
The reason for the function's current state.
- StateReasonCode
-
- Type: string
The reason code for the function's current state. When the code is
Creating
, you can't invoke or modify the function. - Timeout
-
- Type: int
The amount of time that Lambda allows a function to run before stopping 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
-
The AWS Lambda service encountered an internal error.
-
The resource specified in the request does not exist.
-
InvalidParameterValueException:
One of the parameters in the request is invalid.
-
The request throughput limit was exceeded.
-
You have exceeded your maximum total code size per account. Learn more
-
The RevisionId provided does not match the latest RevisionId for the Lambda function or alias. Call the
GetFunction
or theGetAlias
API to retrieve the latest RevisionId for your resource. -
The resource already exists, or another operation is in progress.
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 the maximum number of simultaneous executions for a function, and reserves capacity for that concurrency level.
Concurrency settings apply to the function as a whole, including all published versions and the unpublished version. Reserving concurrency both ensures that your function has capacity to process the specified number of events simultaneously, and prevents it from scaling beyond that level. Use GetFunction to see the current setting for a function.
Use GetAccountSettings to see your Regional concurrency limit. You can reserve concurrency for as many functions as you like, as long as you leave at least 100 simultaneous executions unreserved for functions that aren't configured with a per-function limit. For more information, see Managing Concurrency.
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 -
my-function
. -
Function ARN -
arn:aws:lambda:us-west-2:123456789012:function:my-function
. -
Partial ARN -
123456789012:function:my-function
.
The length constraint applies only to the full ARN. If you specify only the function name, it is limited to 64 characters in length.
- ReservedConcurrentExecutions
-
- Required: Yes
- Type: int
The number of simultaneous executions to reserve for the function.
Result Syntax
[ 'ReservedConcurrentExecutions' => <integer>, ]
Result Details
Members
- ReservedConcurrentExecutions
-
- Type: int
The number of concurrent executions that are reserved for this function. For more information, see Managing Concurrency.
Errors
-
The AWS Lambda service encountered an internal error.
-
InvalidParameterValueException:
One of the parameters in the request is invalid.
-
The resource specified in the request does not exist.
-
The request throughput limit was exceeded.
-
The resource already exists, or another operation is in progress.
PutFunctionEventInvokeConfig
$result = $client->putFunctionEventInvokeConfig
([/* ... */]); $promise = $client->putFunctionEventInvokeConfigAsync
([/* ... */]);
Configures options for asynchronous invocation on a function, version, or alias.
By default, Lambda retries an asynchronous invocation twice if the function returns an error. It retains events in a queue for up to six hours. When an event fails all processing attempts or stays in the asynchronous invocation queue for too long, Lambda discards it. To retain discarded events, configure a dead-letter queue with UpdateFunctionConfiguration.
Parameter Syntax
$result = $client->putFunctionEventInvokeConfig([ 'DestinationConfig' => [ 'OnFailure' => [ 'Destination' => '<string>', ], 'OnSuccess' => [ 'Destination' => '<string>', ], ], 'FunctionName' => '<string>', // REQUIRED 'MaximumEventAgeInSeconds' => <integer>, 'MaximumRetryAttempts' => <integer>, 'Qualifier' => '<string>', ]);
Parameter Details
Members
- DestinationConfig
-
- Type: DestinationConfig structure
A destination for events after they have been sent to a function for processing.
Destinations
-
Function - The Amazon Resource Name (ARN) of a Lambda function.
-
Queue - The ARN of an SQS queue.
-
Topic - The ARN of an SNS topic.
-
Event Bus - The ARN of an Amazon EventBridge event bus.
- FunctionName
-
- Required: Yes
- Type: string
The name of the Lambda function, version, or alias.
Name formats
-
Function name -
my-function
(name-only),my-function:v1
(with alias). -
Function ARN -
arn:aws:lambda:us-west-2:123456789012:function:my-function
. -
Partial ARN -
123456789012:function:my-function
.
You can append a version number or alias to any of the formats. The length constraint applies only to the full ARN. If you specify only the function name, it is limited to 64 characters in length.
- MaximumEventAgeInSeconds
-
- Type: int
The maximum age of a request that Lambda sends to a function for processing.
- MaximumRetryAttempts
-
- Type: int
The maximum number of times to retry when the function returns an error.
- Qualifier
-
- Type: string
A version number or alias name.
Result Syntax
[ 'DestinationConfig' => [ 'OnFailure' => [ 'Destination' => '<string>', ], 'OnSuccess' => [ 'Destination' => '<string>', ], ], 'FunctionArn' => '<string>', 'LastModified' => <DateTime>, 'MaximumEventAgeInSeconds' => <integer>, 'MaximumRetryAttempts' => <integer>, ]
Result Details
Members
- DestinationConfig
-
- Type: DestinationConfig structure
A destination for events after they have been sent to a function for processing.
Destinations
-
Function - The Amazon Resource Name (ARN) of a Lambda function.
-
Queue - The ARN of an SQS queue.
-
Topic - The ARN of an SNS topic.
-
Event Bus - The ARN of an Amazon EventBridge event bus.
- FunctionArn
-
- Type: string
The Amazon Resource Name (ARN) of the function.
- LastModified
-
- Type: timestamp (string|DateTime or anything parsable by strtotime)
The date and time that the configuration was last updated.
- MaximumEventAgeInSeconds
-
- Type: int
The maximum age of a request that Lambda sends to a function for processing.
- MaximumRetryAttempts
-
- Type: int
The maximum number of times to retry when the function returns an error.
Errors
-
The AWS Lambda service encountered an internal error.
-
The resource specified in the request does not exist.
-
InvalidParameterValueException:
One of the parameters in the request is invalid.
-
The request throughput limit was exceeded.
PutProvisionedConcurrencyConfig
$result = $client->putProvisionedConcurrencyConfig
([/* ... */]); $promise = $client->putProvisionedConcurrencyConfigAsync
([/* ... */]);
Adds a provisioned concurrency configuration to a function's alias or version.
Parameter Syntax
$result = $client->putProvisionedConcurrencyConfig([ 'FunctionName' => '<string>', // REQUIRED 'ProvisionedConcurrentExecutions' => <integer>, // REQUIRED 'Qualifier' => '<string>', // REQUIRED ]);
Parameter Details
Members
- FunctionName
-
- Required: Yes
- Type: string
The name of the Lambda function.
Name formats
-
Function name -
my-function
. -
Function ARN -
arn:aws:lambda:us-west-2:123456789012:function:my-function
. -
Partial ARN -
123456789012:function:my-function
.
The length constraint applies only to the full ARN. If you specify only the function name, it is limited to 64 characters in length.
- ProvisionedConcurrentExecutions
-
- Required: Yes
- Type: int
The amount of provisioned concurrency to allocate for the version or alias.
- Qualifier
-
- Required: Yes
- Type: string
The version number or alias name.
Result Syntax
[ 'AllocatedProvisionedConcurrentExecutions' => <integer>, 'AvailableProvisionedConcurrentExecutions' => <integer>, 'LastModified' => '<string>', 'RequestedProvisionedConcurrentExecutions' => <integer>, 'Status' => 'IN_PROGRESS|READY|FAILED', 'StatusReason' => '<string>', ]
Result Details
Members
- AllocatedProvisionedConcurrentExecutions
-
- Type: int
The amount of provisioned concurrency allocated.
- AvailableProvisionedConcurrentExecutions
-
- Type: int
The amount of provisioned concurrency available.
- LastModified
-
- Type: string
The date and time that a user last updated the configuration, in ISO 8601 format.
- RequestedProvisionedConcurrentExecutions
-
- Type: int
The amount of provisioned concurrency requested.
- Status
-
- Type: string
The status of the allocation process.
- StatusReason
-
- Type: string
For failed allocations, the reason that provisioned concurrency could not be allocated.
Errors
-
InvalidParameterValueException:
One of the parameters in the request is invalid.
-
The resource specified in the request does not exist.
-
The resource already exists, or another operation is in progress.
-
The request throughput limit was exceeded.
-
The AWS Lambda service encountered an internal error.
RemoveLayerVersionPermission
$result = $client->removeLayerVersionPermission
([/* ... */]); $promise = $client->removeLayerVersionPermissionAsync
([/* ... */]);
Removes a statement from the permissions policy for a version of an AWS Lambda layer. 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 or Amazon Resource Name (ARN) 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
Errors
-
The AWS Lambda service encountered an internal error.
-
The resource specified in the request does not exist.
-
InvalidParameterValueException:
One of the parameters in the request is invalid.
-
The request throughput limit was exceeded.
-
The RevisionId provided does not match the latest RevisionId for the Lambda function or alias. Call the
GetFunction
or theGetAlias
API to retrieve the latest RevisionId for your resource.
RemovePermission
$result = $client->removePermission
([/* ... */]); $promise = $client->removePermissionAsync
([/* ... */]);
Revokes function-use permission from an AWS service or another account. You can get the ID of the statement from the output of GetPolicy.
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, version, or alias.
Name formats
-
Function name -
my-function
(name-only),my-function:v1
(with alias). -
Function ARN -
arn:aws:lambda:us-west-2:123456789012:function:my-function
. -
Partial ARN -
123456789012:function:my-function
.
You can append a version number or alias to any of the formats. The length constraint applies only to the full ARN. If you specify only the function name, it is limited to 64 characters in length.
- Qualifier
-
- Type: string
Specify a version or alias to remove permissions from a published version of the function.
- RevisionId
-
- Type: string
Only update the policy if the revision ID matches the ID that's specified. Use this option to avoid modifying a policy that has changed since you last read it.
- StatementId
-
- Required: Yes
- Type: string
Statement ID of the permission to remove.
Result Syntax
[]
Result Details
Errors
-
The AWS Lambda service encountered an internal error.
-
The resource specified in the request does not exist.
-
InvalidParameterValueException:
One of the parameters in the request is invalid.
-
The request throughput limit was exceeded.
-
The RevisionId provided does not match the latest RevisionId for the Lambda function or alias. Call the
GetFunction
or theGetAlias
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
([/* ... */]);
Adds tags to a function.
Parameter Syntax
$result = $client->tagResource([ 'Resource' => '<string>', // REQUIRED 'Tags' => ['<string>', ...], // REQUIRED ]);
Parameter Details
Members
Result Syntax
[]
Result Details
Errors
-
The AWS Lambda service encountered an internal error.
-
The resource specified in the request does not exist.
-
InvalidParameterValueException:
One of the parameters in the request is invalid.
-
The request throughput limit was exceeded.
UntagResource
$result = $client->untagResource
([/* ... */]); $promise = $client->untagResourceAsync
([/* ... */]);
Removes tags from a function.
Parameter Syntax
$result = $client->untagResource([ 'Resource' => '<string>', // REQUIRED 'TagKeys' => ['<string>', ...], // REQUIRED ]);
Parameter Details
Members
Result Syntax
[]
Result Details
Errors
-
The AWS Lambda service encountered an internal error.
-
The resource specified in the request does not exist.
-
InvalidParameterValueException:
One of the parameters in the request is invalid.
-
The request throughput limit was exceeded.
UpdateAlias
$result = $client->updateAlias
([/* ... */]); $promise = $client->updateAliasAsync
([/* ... */]);
Updates the configuration of a Lambda function alias.
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
A 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
-
- Type: string
The function version that the alias invokes.
- Name
-
- Required: Yes
- Type: string
The name of the alias.
- RevisionId
-
- Type: string
Only update the alias if the revision ID matches the ID that's specified. Use this option to avoid modifying an alias that has changed since you last read it.
- RoutingConfig
-
- Type: AliasRoutingConfiguration structure
The routing configuration of the alias.
Result Syntax
[ 'AliasArn' => '<string>', 'Description' => '<string>', 'FunctionVersion' => '<string>', 'Name' => '<string>', 'RevisionId' => '<string>', 'RoutingConfig' => [ 'AdditionalVersionWeights' => [<float>, ...], ], ]
Result Details
Members
- AliasArn
-
- Type: string
The Amazon Resource Name (ARN) of the alias.
- Description
-
- Type: string
A description of the alias.
- FunctionVersion
-
- Type: string
The function version that the alias invokes.
- Name
-
- Type: string
The name of the alias.
- RevisionId
-
- Type: string
A unique identifier that changes when you update the alias.
- RoutingConfig
-
- Type: AliasRoutingConfiguration structure
The routing configuration of the alias.
Errors
-
The AWS Lambda service encountered an internal error.
-
The resource specified in the request does not exist.
-
InvalidParameterValueException:
One of the parameters in the request is invalid.
-
The request throughput limit was exceeded.
-
The RevisionId provided does not match the latest RevisionId for the Lambda function or alias. Call the
GetFunction
or theGetAlias
API to retrieve the latest RevisionId for your resource. -
The resource already exists, or another operation is in progress.
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.
The following error handling options are only available for stream sources (DynamoDB and Kinesis):
-
BisectBatchOnFunctionError
- If the function returns an error, split the batch in two and retry. -
DestinationConfig
- Send discarded records to an Amazon SQS queue or Amazon SNS topic. -
MaximumRecordAgeInSeconds
- Discard records older than the specified age. -
MaximumRetryAttempts
- Discard records after the specified number of retries.
Parameter Syntax
$result = $client->updateEventSourceMapping([ 'BatchSize' => <integer>, 'BisectBatchOnFunctionError' => true || false, 'DestinationConfig' => [ 'OnFailure' => [ 'Destination' => '<string>', ], 'OnSuccess' => [ 'Destination' => '<string>', ], ], 'Enabled' => true || false, 'FunctionName' => '<string>', 'MaximumBatchingWindowInSeconds' => <integer>, 'MaximumRecordAgeInSeconds' => <integer>, 'MaximumRetryAttempts' => <integer>, 'ParallelizationFactor' => <integer>, '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.
- BisectBatchOnFunctionError
-
- Type: boolean
(Streams) If the function returns an error, split the batch in two and retry.
- DestinationConfig
-
- Type: DestinationConfig structure
(Streams) An Amazon SQS queue or Amazon SNS topic destination for discarded records.
- 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.
- MaximumBatchingWindowInSeconds
-
- Type: int
The maximum amount of time to gather records before invoking the function, in seconds.
- MaximumRecordAgeInSeconds
-
- Type: int
(Streams) The maximum age of a record that Lambda sends to a function for processing.
- MaximumRetryAttempts
-
- Type: int
(Streams) The maximum number of times to retry when the function returns an error.
- ParallelizationFactor
-
- Type: int
(Streams) The number of batches to process from each shard concurrently.
- UUID
-
- Required: Yes
- Type: string
The identifier of the event source mapping.
Result Syntax
[ 'BatchSize' => <integer>, 'BisectBatchOnFunctionError' => true || false, 'DestinationConfig' => [ 'OnFailure' => [ 'Destination' => '<string>', ], 'OnSuccess' => [ 'Destination' => '<string>', ], ], 'EventSourceArn' => '<string>', 'FunctionArn' => '<string>', 'LastModified' => <DateTime>, 'LastProcessingResult' => '<string>', 'MaximumBatchingWindowInSeconds' => <integer>, 'MaximumRecordAgeInSeconds' => <integer>, 'MaximumRetryAttempts' => <integer>, 'ParallelizationFactor' => <integer>, 'State' => '<string>', 'StateTransitionReason' => '<string>', 'UUID' => '<string>', ]
Result Details
Members
- BatchSize
-
- Type: int
The maximum number of items to retrieve in a single batch.
- BisectBatchOnFunctionError
-
- Type: boolean
(Streams) If the function returns an error, split the batch in two and retry.
- DestinationConfig
-
- Type: DestinationConfig structure
(Streams) An Amazon SQS queue or Amazon SNS topic destination for discarded records.
- 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, or its state changed.
- LastProcessingResult
-
- Type: string
The result of the last AWS Lambda invocation of your Lambda function.
- MaximumBatchingWindowInSeconds
-
- Type: int
The maximum amount of time to gather records before invoking the function, in seconds.
- MaximumRecordAgeInSeconds
-
- Type: int
(Streams) The maximum age of a record that Lambda sends to a function for processing.
- MaximumRetryAttempts
-
- Type: int
(Streams) The maximum number of times to retry when the function returns an error.
- ParallelizationFactor
-
- Type: int
(Streams) The number of batches to process from each shard concurrently.
- State
-
- Type: string
The state of the event source mapping. It can be one of the following:
Creating
,Enabling
,Enabled
,Disabling
,Disabled
,Updating
, orDeleting
. - StateTransitionReason
-
- Type: string
Indicates whether the last change to the event source mapping was made by a user, or by the Lambda service.
- UUID
-
- Type: string
The identifier of the event source mapping.
Errors
-
The AWS Lambda service encountered an internal error.
-
The resource specified in the request does not exist.
-
InvalidParameterValueException:
One of the parameters in the request is invalid.
-
The request throughput limit was exceeded.
-
The resource already exists, or another operation is in progress.
-
The operation conflicts with the resource's availability. For example, you attempted to update an EventSource Mapping in CREATING, or tried to delete a EventSource 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 a Lambda function's code.
The function's code is locked when you publish a version. You can't modify the code of a published version, only the unpublished version.
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
Set to true to validate the request parameters and access permissions without modifying the function code.
- FunctionName
-
- Required: Yes
- Type: string
The name of the Lambda function.
Name formats
-
Function name -
my-function
. -
Function ARN -
arn:aws:lambda:us-west-2:123456789012:function:my-function
. -
Partial ARN -
123456789012:function:my-function
.
The length constraint applies only to the full ARN. If you specify only the function name, it is limited to 64 characters in length.
- Publish
-
- Type: boolean
Set to true to publish a new version of the function after updating the code. This has the same effect as calling PublishVersion separately.
- RevisionId
-
- Type: string
Only update the function if the revision ID matches the ID that's specified. Use this option to avoid modifying a function that has changed since you last read it.
- S3Bucket
-
- Type: string
An Amazon S3 bucket in the same AWS Region as your function. The bucket can be in a different AWS account.
- 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 the deployment package. AWS SDK and AWS CLI clients handle the encoding for you.
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>', 'LastUpdateStatus' => 'Successful|Failed|InProgress', 'LastUpdateStatusReason' => '<string>', 'LastUpdateStatusReasonCode' => 'EniLimitExceeded|InsufficientRolePermissions|InvalidConfiguration|InternalError', 'Layers' => [ [ 'Arn' => '<string>', 'CodeSize' => <integer>, ], // ... ], 'MasterArn' => '<string>', 'MemorySize' => <integer>, 'RevisionId' => '<string>', 'Role' => '<string>', 'Runtime' => 'nodejs|nodejs4.3|nodejs6.10|nodejs8.10|nodejs10.x|nodejs12.x|java8|java11|python2.7|python3.6|python3.7|python3.8|dotnetcore1.0|dotnetcore2.0|dotnetcore2.1|nodejs4.3-edge|go1.x|ruby2.5|provided', 'State' => 'Pending|Active|Inactive|Failed', 'StateReason' => '<string>', 'StateReasonCode' => 'Idle|Creating|Restoring|EniLimitExceeded|InsufficientRolePermissions|InvalidConfiguration|InternalError|SubnetOutOfIPAddresses', '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 (ARN).
- FunctionName
-
- Type: string
The name of the function.
- Handler
-
- Type: string
The function that Lambda calls to begin executing your function.
- KMSKeyArn
-
- Type: string
The KMS key that's used to encrypt the function's environment variables. This key is only returned if you've configured a customer managed CMK.
- LastModified
-
- Type: string
The date and time that the function was last updated, in ISO-8601 format (YYYY-MM-DDThh:mm:ss.sTZD).
- LastUpdateStatus
-
- Type: string
The status of the last update that was performed on the function.
- LastUpdateStatusReason
-
- Type: string
The reason for the last update that was performed on the function.
- LastUpdateStatusReasonCode
-
- Type: string
The reason code for the last update that was performed on the function.
- Layers
-
- Type: Array of Layer structures
The function's layers.
- MasterArn
-
- Type: string
For Lambda@Edge functions, the ARN of the master function.
- MemorySize
-
- Type: int
The memory that's allocated to the function.
- RevisionId
-
- Type: string
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.
- State
-
- Type: string
The current state of the function. When the state is
Inactive
, you can reactivate the function by invoking it. - StateReason
-
- Type: string
The reason for the function's current state.
- StateReasonCode
-
- Type: string
The reason code for the function's current state. When the code is
Creating
, you can't invoke or modify the function. - Timeout
-
- Type: int
The amount of time that Lambda allows a function to run before stopping 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
-
The AWS Lambda service encountered an internal error.
-
The resource specified in the request does not exist.
-
InvalidParameterValueException:
One of the parameters in the request is invalid.
-
The request throughput limit was exceeded.
-
You have exceeded your maximum total code size per account. Learn more
-
The RevisionId provided does not match the latest RevisionId for the Lambda function or alias. Call the
GetFunction
or theGetAlias
API to retrieve the latest RevisionId for your resource. -
The resource already exists, or another operation is in progress.
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
([/* ... */]);
Modify the version-specific settings of a Lambda function.
When you update a function, Lambda provisions an instance of the function and its supporting resources. If your function connects to a VPC, this process can take a minute. During this time, you can't modify the function, but you can still invoke it. The LastUpdateStatus
, LastUpdateStatusReason
, and LastUpdateStatusReasonCode
fields in the response from GetFunctionConfiguration indicate when the update is complete and the function is processing events with the new configuration. For more information, see Function States.
These settings can vary between versions of a function and are locked when you publish a version. You can't modify the configuration of a published version, only the unpublished version.
To configure function concurrency, use PutFunctionConcurrency. To grant invoke permissions to an account or AWS service, use AddPermission.
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|nodejs10.x|nodejs12.x|java8|java11|python2.7|python3.6|python3.7|python3.8|dotnetcore1.0|dotnetcore2.0|dotnetcore2.1|nodejs4.3-edge|go1.x|ruby2.5|provided', '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 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 -
my-function
. -
Function ARN -
arn:aws:lambda:us-west-2:123456789012:function:my-function
. -
Partial ARN -
123456789012:function:my-function
.
The length constraint applies only to the full ARN. If you specify only the function name, it is limited to 64 characters in length.
- Handler
-
- Type: string
The name of the method within your code that Lambda calls to execute your function. The format includes the file name. It can also include namespaces and other qualifiers, depending on the runtime. For more information, see Programming Model.
- KMSKeyArn
-
- Type: string
The ARN of the AWS Key Management Service (AWS KMS) key that's used to encrypt your function's environment variables. If it's not provided, AWS Lambda uses a default service key.
- Layers
-
- Type: Array of strings
A list of function layers to add to the function's execution environment. Specify each layer by its ARN, including the version.
- MemorySize
-
- Type: int
The amount of memory that your function has access to. Increasing the function's memory also increases its CPU allocation. The default value is 128 MB. The value must be a multiple of 64 MB.
- RevisionId
-
- Type: string
Only update the function if the revision ID matches the ID that's specified. Use this option to avoid modifying a function that has changed since you last read it.
- Role
-
- Type: string
The Amazon Resource Name (ARN) of the function's execution role.
- Runtime
-
- Type: string
The identifier of the function's runtime.
- Timeout
-
- Type: int
The amount of time that Lambda allows a function to run before stopping it. The default is 3 seconds. The maximum allowed value is 900 seconds.
- TracingConfig
-
- Type: TracingConfig structure
Set
Mode
toActive
to sample and trace a subset of incoming requests with AWS X-Ray. - VpcConfig
-
- Type: VpcConfig structure
For network connectivity to AWS resources in a VPC, specify a list of security groups and subnets in the VPC. When you connect a function to a VPC, it can only access resources and the internet through that VPC. For more information, see VPC Settings.
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>', 'LastUpdateStatus' => 'Successful|Failed|InProgress', 'LastUpdateStatusReason' => '<string>', 'LastUpdateStatusReasonCode' => 'EniLimitExceeded|InsufficientRolePermissions|InvalidConfiguration|InternalError', 'Layers' => [ [ 'Arn' => '<string>', 'CodeSize' => <integer>, ], // ... ], 'MasterArn' => '<string>', 'MemorySize' => <integer>, 'RevisionId' => '<string>', 'Role' => '<string>', 'Runtime' => 'nodejs|nodejs4.3|nodejs6.10|nodejs8.10|nodejs10.x|nodejs12.x|java8|java11|python2.7|python3.6|python3.7|python3.8|dotnetcore1.0|dotnetcore2.0|dotnetcore2.1|nodejs4.3-edge|go1.x|ruby2.5|provided', 'State' => 'Pending|Active|Inactive|Failed', 'StateReason' => '<string>', 'StateReasonCode' => 'Idle|Creating|Restoring|EniLimitExceeded|InsufficientRolePermissions|InvalidConfiguration|InternalError|SubnetOutOfIPAddresses', '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 (ARN).
- FunctionName
-
- Type: string
The name of the function.
- Handler
-
- Type: string
The function that Lambda calls to begin executing your function.
- KMSKeyArn
-
- Type: string
The KMS key that's used to encrypt the function's environment variables. This key is only returned if you've configured a customer managed CMK.
- LastModified
-
- Type: string
The date and time that the function was last updated, in ISO-8601 format (YYYY-MM-DDThh:mm:ss.sTZD).
- LastUpdateStatus
-
- Type: string
The status of the last update that was performed on the function.
- LastUpdateStatusReason
-
- Type: string
The reason for the last update that was performed on the function.
- LastUpdateStatusReasonCode
-
- Type: string
The reason code for the last update that was performed on the function.
- Layers
-
- Type: Array of Layer structures
The function's layers.
- MasterArn
-
- Type: string
For Lambda@Edge functions, the ARN of the master function.
- MemorySize
-
- Type: int
The memory that's allocated to the function.
- RevisionId
-
- Type: string
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.
- State
-
- Type: string
The current state of the function. When the state is
Inactive
, you can reactivate the function by invoking it. - StateReason
-
- Type: string
The reason for the function's current state.
- StateReasonCode
-
- Type: string
The reason code for the function's current state. When the code is
Creating
, you can't invoke or modify the function. - Timeout
-
- Type: int
The amount of time that Lambda allows a function to run before stopping 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
-
The AWS Lambda service encountered an internal error.
-
The resource specified in the request does not exist.
-
InvalidParameterValueException:
One of the parameters in the request is invalid.
-
The request throughput limit was exceeded.
-
The resource already exists, or another operation is in progress.
-
The RevisionId provided does not match the latest RevisionId for the Lambda function or alias. Call the
GetFunction
or theGetAlias
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' => [ ], ]
UpdateFunctionEventInvokeConfig
$result = $client->updateFunctionEventInvokeConfig
([/* ... */]); $promise = $client->updateFunctionEventInvokeConfigAsync
([/* ... */]);
Updates the configuration for asynchronous invocation for a function, version, or alias.
To configure options for asynchronous invocation, use PutFunctionEventInvokeConfig.
Parameter Syntax
$result = $client->updateFunctionEventInvokeConfig([ 'DestinationConfig' => [ 'OnFailure' => [ 'Destination' => '<string>', ], 'OnSuccess' => [ 'Destination' => '<string>', ], ], 'FunctionName' => '<string>', // REQUIRED 'MaximumEventAgeInSeconds' => <integer>, 'MaximumRetryAttempts' => <integer>, 'Qualifier' => '<string>', ]);
Parameter Details
Members
- DestinationConfig
-
- Type: DestinationConfig structure
A destination for events after they have been sent to a function for processing.
Destinations
-
Function - The Amazon Resource Name (ARN) of a Lambda function.
-
Queue - The ARN of an SQS queue.
-
Topic - The ARN of an SNS topic.
-
Event Bus - The ARN of an Amazon EventBridge event bus.
- FunctionName
-
- Required: Yes
- Type: string
The name of the Lambda function, version, or alias.
Name formats
-
Function name -
my-function
(name-only),my-function:v1
(with alias). -
Function ARN -
arn:aws:lambda:us-west-2:123456789012:function:my-function
. -
Partial ARN -
123456789012:function:my-function
.
You can append a version number or alias to any of the formats. The length constraint applies only to the full ARN. If you specify only the function name, it is limited to 64 characters in length.
- MaximumEventAgeInSeconds
-
- Type: int
The maximum age of a request that Lambda sends to a function for processing.
- MaximumRetryAttempts
-
- Type: int
The maximum number of times to retry when the function returns an error.
- Qualifier
-
- Type: string
A version number or alias name.
Result Syntax
[ 'DestinationConfig' => [ 'OnFailure' => [ 'Destination' => '<string>', ], 'OnSuccess' => [ 'Destination' => '<string>', ], ], 'FunctionArn' => '<string>', 'LastModified' => <DateTime>, 'MaximumEventAgeInSeconds' => <integer>, 'MaximumRetryAttempts' => <integer>, ]
Result Details
Members
- DestinationConfig
-
- Type: DestinationConfig structure
A destination for events after they have been sent to a function for processing.
Destinations
-
Function - The Amazon Resource Name (ARN) of a Lambda function.
-
Queue - The ARN of an SQS queue.
-
Topic - The ARN of an SNS topic.
-
Event Bus - The ARN of an Amazon EventBridge event bus.
- FunctionArn
-
- Type: string
The Amazon Resource Name (ARN) of the function.
- LastModified
-
- Type: timestamp (string|DateTime or anything parsable by strtotime)
The date and time that the configuration was last updated.
- MaximumEventAgeInSeconds
-
- Type: int
The maximum age of a request that Lambda sends to a function for processing.
- MaximumRetryAttempts
-
- Type: int
The maximum number of times to retry when the function returns an error.
Errors
-
The AWS Lambda service encountered an internal error.
-
The resource specified in the request does not exist.
-
InvalidParameterValueException:
One of the parameters in the request is invalid.
-
The request throughput limit was exceeded.
Shapes
AccountLimit
Description
Limits that are related to concurrency and storage. All file and storage sizes are in bytes.
Members
- CodeSizeUnzipped
-
- Type: long (int|float)
The maximum size of a function's deployment package and layers when they're extracted.
- CodeSizeZipped
-
- Type: long (int|float)
The maximum size of a deployment package when it's uploaded directly to AWS Lambda. Use Amazon S3 for larger files.
- ConcurrentExecutions
-
- Type: int
The maximum number of simultaneous function executions.
- TotalCodeSize
-
- Type: long (int|float)
The amount of storage space that you can use for all deployment packages and layer archives.
- UnreservedConcurrentExecutions
-
- Type: int
The maximum number of simultaneous function executions, minus the capacity that's reserved for individual functions with PutFunctionConcurrency.
AccountUsage
Description
The number of functions and amount of storage in use.
Members
AliasRoutingConfiguration
CodeStorageExceededException
DeadLetterConfig
DestinationConfig
Description
A configuration object that specifies the destination of an event after Lambda processes it.
Members
EC2AccessDeniedException
Description
Need additional permissions to configure VPC settings.
Members
EC2ThrottledException
Description
AWS Lambda was throttled by Amazon EC2 during Lambda function initialization using the execution role provided for the Lambda function.
Members
EC2UnexpectedException
Description
AWS Lambda received an unexpected EC2 client exception while setting up for the Lambda function.
Members
ENILimitReachedException
Description
AWS Lambda was not able to create an elastic network interface in the VPC, specified as part of Lambda function configuration, because the limit for network interfaces has been reached.
Members
Environment
Description
A function's environment variable settings.
Members
EnvironmentError
Description
Error messages for environment variables that couldn't be applied.
Members
EnvironmentResponse
Description
The results of an operation to update or read environment variables. If the operation is successful, the response contains the environment variables. If it failed, the response contains details about the error.
Members
- Error
-
- Type: EnvironmentError structure
Error messages for environment variables that couldn't 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 object in Amazon S3, or upload a deployment package directly.
Members
- S3Bucket
-
- Type: string
An Amazon S3 bucket in the same AWS Region as your function. The bucket can be in a different AWS account.
- 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 the deployment package. AWS SDK and AWS CLI clients handle the encoding for you.
FunctionCodeLocation
Description
Details about a function's deployment package.
Members
InvalidParameterValueException
Description
One of the parameters in the request is invalid.
Members
InvalidRequestContentException
Description
The request body could not be parsed as JSON.
Members
InvalidRuntimeException
Description
The runtime or runtime version specified is not supported.
Members
InvalidSecurityGroupIDException
Description
The Security Group ID provided in the Lambda function VPC configuration is invalid.
Members
InvalidSubnetIDException
Description
The Subnet ID provided in the Lambda function VPC configuration is invalid.
Members
InvalidZipFileException
Description
AWS Lambda could not unzip the deployment package.
Members
KMSAccessDeniedException
Description
Lambda was unable to decrypt the environment variables because KMS access was denied. Check the Lambda function's KMS permissions.
Members
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
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
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
Layer
LayerVersionContentInput
Description
A ZIP archive that contains the contents of an AWS Lambda 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
LayerVersionsListItem
Description
Details about a version of an AWS Lambda layer.
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 an AWS Lambda 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.
OnFailure
Description
A destination for events that failed processing.
Members
OnSuccess
Description
A destination for events that were processed successfully.
Members
PolicyLengthExceededException
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
ProvisionedConcurrencyConfigListItem
Description
Details about the provisioned concurrency configuration for a function alias or version.
Members
- AllocatedProvisionedConcurrentExecutions
-
- Type: int
The amount of provisioned concurrency allocated.
- AvailableProvisionedConcurrentExecutions
-
- Type: int
The amount of provisioned concurrency available.
- FunctionArn
-
- Type: string
The Amazon Resource Name (ARN) of the alias or version.
- LastModified
-
- Type: string
The date and time that a user last updated the configuration, in ISO 8601 format.
- RequestedProvisionedConcurrentExecutions
-
- Type: int
The amount of provisioned concurrency requested.
- Status
-
- Type: string
The status of the allocation process.
- StatusReason
-
- Type: string
For failed allocations, the reason that provisioned concurrency could not be allocated.
ProvisionedConcurrencyConfigNotFoundException
Description
The specified configuration does not exist.
Members
RequestTooLargeException
Description
The request payload exceeded the Invoke
request body JSON input limit. For more information, see Limits.
Members
ResourceConflictException
Description
The resource already exists, or another operation is in progress.
Members
ResourceInUseException
Description
The operation conflicts with the resource's availability. For example, you attempted to update an EventSource Mapping in CREATING, or tried to delete a EventSource mapping currently in the UPDATING state.
Members
ResourceNotFoundException
Description
The resource specified in the request does not exist.
Members
ResourceNotReadyException
Description
The function is inactive and its VPC connection is no longer available. Wait for the VPC connection to reestablish and try again.
Members
ServiceException
Description
The AWS Lambda service encountered an internal error.
Members
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
TooManyRequestsException
Description
The request throughput limit was exceeded.
Members
TracingConfig
Description
The function's AWS X-Ray tracing configuration.
Members
TracingConfigResponse
Description
The function's AWS X-Ray tracing configuration.
Members
UnsupportedMediaTypeException
Description
The content type of the Invoke
request body is not JSON.
Members
VpcConfig
Description
The VPC security groups and subnets that are attached to a Lambda function. For more information, see VPC Settings.