NAME

Paws::Lambda - Perl Interface to AWS AWS Lambda

SYNOPSIS

  use Paws;

  my $obj = Paws->service('Lambda');
  my $res = $obj->Method(
    Arg1 => $val1,
    Arg2 => [ 'V1', 'V2' ],
    # if Arg3 is an object, the HashRef will be used as arguments to the constructor
    # of the arguments type
    Arg3 => { Att1 => 'Val1' },
    # if Arg4 is an array of objects, the HashRefs will be passed as arguments to
    # the constructor of the arguments type
    Arg4 => [ { Att1 => 'Val1'  }, { Att1 => 'Val2' } ],
  );

DESCRIPTION

AWS Lambda

Overview

This is the AWS Lambda API Reference. The AWS Lambda Developer Guide provides additional information. For the service overview, see What is AWS Lambda (https://docs.aws.amazon.com/lambda/latest/dg/welcome.html), and for information about how the service works, see AWS Lambda: How it Works (https://docs.aws.amazon.com/lambda/latest/dg/lambda-introduction.html) in the AWS Lambda Developer Guide.

For the AWS API documentation, see https://docs.aws.amazon.com/goto/WebAPI/lambda-2015-03-31

METHODS

AddLayerVersionPermission

Action => Str
LayerName => Str
Principal => Str
StatementId => Str
VersionNumber => Int
[OrganizationId => Str]
[RevisionId => Str]

Each argument is described in detail in: Paws::Lambda::AddLayerVersionPermission

Returns: a Paws::Lambda::AddLayerVersionPermissionResponse instance

Adds permissions to the resource-based policy of a version of an AWS Lambda layer (https://docs.aws.amazon.com/lambda/latest/dg/configuration-layers.html). 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.

AddPermission

Action => Str
FunctionName => Str
Principal => Str
StatementId => Str
[EventSourceToken => Str]
[Qualifier => Str]
[RevisionId => Str]
[SourceAccount => Str]
[SourceArn => Str]

Each argument is described in detail in: Paws::Lambda::AddPermission

Returns: a Paws::Lambda::AddPermissionResponse instance

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 permission policy for the function. For more information about function policies, see Lambda Function Policies (https://docs.aws.amazon.com/lambda/latest/dg/access-control-resource-based.html).

CreateAlias

FunctionName => Str
FunctionVersion => Str
Name => Str
[Description => Str]
[RoutingConfig => Paws::Lambda::AliasRoutingConfiguration]

Each argument is described in detail in: Paws::Lambda::CreateAlias

Returns: a Paws::Lambda::AliasConfiguration instance

Creates an alias (https://docs.aws.amazon.com/lambda/latest/dg/versioning-aliases.html) 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.

CreateEventSourceMapping

EventSourceArn => Str
FunctionName => Str
[BatchSize => Int]
[Enabled => Bool]
[StartingPosition => Str]
[StartingPositionTimestamp => Str]

Each argument is described in detail in: Paws::Lambda::CreateEventSourceMapping

Returns: a Paws::Lambda::EventSourceMappingConfiguration instance

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.

Using AWS Lambda with Amazon Kinesis (https://docs.aws.amazon.com/lambda/latest/dg/with-kinesis.html)
Using AWS Lambda with Amazon SQS (https://docs.aws.amazon.com/lambda/latest/dg/with-sqs.html)
Using AWS Lambda with Amazon DynamoDB (https://docs.aws.amazon.com/lambda/latest/dg/with-ddb.html)

CreateFunction

Code => Paws::Lambda::FunctionCode
FunctionName => Str
Handler => Str
Role => Str
Runtime => Str
[DeadLetterConfig => Paws::Lambda::DeadLetterConfig]
[Description => Str]
[Environment => Paws::Lambda::Environment]
[KMSKeyArn => Str]
[Layers => ArrayRef[Str|Undef]]
[MemorySize => Int]
[Publish => Bool]
[Tags => Paws::Lambda::Tags]
[Timeout => Int]
[TracingConfig => Paws::Lambda::TracingConfig]
[VpcConfig => Paws::Lambda::VpcConfig]

Each argument is described in detail in: Paws::Lambda::CreateFunction

Returns: a Paws::Lambda::FunctionConfiguration instance

Creates a Lambda function. To create a function, you need a deployment package (https://docs.aws.amazon.com/lambda/latest/dg/deployment-package-v2.html) and an execution role (https://docs.aws.amazon.com/lambda/latest/dg/intro-permission-model.html#lambda-intro-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.

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 (https://docs.aws.amazon.com/lambda/latest/dg/invoking-lambda-functions.html).

DeleteAlias

FunctionName => Str
Name => Str

Each argument is described in detail in: Paws::Lambda::DeleteAlias

Returns: nothing

Deletes a Lambda function alias (https://docs.aws.amazon.com/lambda/latest/dg/versioning-aliases.html).

DeleteEventSourceMapping

UUID => Str

Each argument is described in detail in: Paws::Lambda::DeleteEventSourceMapping

Returns: a Paws::Lambda::EventSourceMappingConfiguration instance

Deletes an event source mapping (https://docs.aws.amazon.com/lambda/latest/dg/intro-invocation-modes.html). You can get the identifier of a mapping from the output of ListEventSourceMappings.

DeleteFunction

FunctionName => Str
[Qualifier => Str]

Each argument is described in detail in: Paws::Lambda::DeleteFunction

Returns: nothing

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.

DeleteFunctionConcurrency

FunctionName => Str

Each argument is described in detail in: Paws::Lambda::DeleteFunctionConcurrency

Returns: nothing

Removes a concurrent execution limit from a function.

DeleteLayerVersion

LayerName => Str
VersionNumber => Int

Each argument is described in detail in: Paws::Lambda::DeleteLayerVersion

Returns: nothing

Deletes a version of an AWS Lambda layer (https://docs.aws.amazon.com/lambda/latest/dg/configuration-layers.html). 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.

GetAccountSettings

Each argument is described in detail in: Paws::Lambda::GetAccountSettings

Returns: a Paws::Lambda::GetAccountSettingsResponse instance

Retrieves details about your account's limits (https://docs.aws.amazon.com/lambda/latest/dg/limits.html) and usage in an AWS Region.

GetAlias

FunctionName => Str
Name => Str

Each argument is described in detail in: Paws::Lambda::GetAlias

Returns: a Paws::Lambda::AliasConfiguration instance

Returns details about a Lambda function alias (https://docs.aws.amazon.com/lambda/latest/dg/versioning-aliases.html).

GetEventSourceMapping

UUID => Str

Each argument is described in detail in: Paws::Lambda::GetEventSourceMapping

Returns: a Paws::Lambda::EventSourceMappingConfiguration instance

Returns details about an event source mapping. You can get the identifier of a mapping from the output of ListEventSourceMappings.

GetFunction

FunctionName => Str
[Qualifier => Str]

Each argument is described in detail in: Paws::Lambda::GetFunction

Returns: a Paws::Lambda::GetFunctionResponse instance

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.

GetFunctionConfiguration

FunctionName => Str
[Qualifier => Str]

Each argument is described in detail in: Paws::Lambda::GetFunctionConfiguration

Returns: a Paws::Lambda::FunctionConfiguration instance

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.

GetLayerVersion

LayerName => Str
VersionNumber => Int

Each argument is described in detail in: Paws::Lambda::GetLayerVersion

Returns: a Paws::Lambda::GetLayerVersionResponse instance

Returns information about a version of an AWS Lambda layer (https://docs.aws.amazon.com/lambda/latest/dg/configuration-layers.html), with a link to download the layer archive that's valid for 10 minutes.

GetLayerVersionByArn

Arn => Str

Each argument is described in detail in: Paws::Lambda::GetLayerVersionByArn

Returns: a Paws::Lambda::GetLayerVersionResponse instance

GetLayerVersionPolicy

LayerName => Str
VersionNumber => Int

Each argument is described in detail in: Paws::Lambda::GetLayerVersionPolicy

Returns: a Paws::Lambda::GetLayerVersionPolicyResponse instance

Returns the permission policy for a version of an AWS Lambda layer (https://docs.aws.amazon.com/lambda/latest/dg/configuration-layers.html). For more information, see AddLayerVersionPermission.

GetPolicy

FunctionName => Str
[Qualifier => Str]

Each argument is described in detail in: Paws::Lambda::GetPolicy

Returns: a Paws::Lambda::GetPolicyResponse instance

Returns the resource-based IAM policy (https://docs.aws.amazon.com/lambda/latest/dg/access-control-resource-based.html) for a function, version, or alias.

Invoke

FunctionName => Str
[ClientContext => Str]
[InvocationType => Str]
[LogType => Str]
[Payload => Str]
[Qualifier => Str]

Each argument is described in detail in: Paws::Lambda::Invoke

Returns: a Paws::Lambda::InvocationResponse instance

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 (https://docs.aws.amazon.com/lambda/latest/dg/monitoring-functions.html) and trace (https://docs.aws.amazon.com/lambda/latest/dg/dlq.html). To record function errors for asynchronous invocations, configure your function with a dead letter queue (https://docs.aws.amazon.com/lambda/latest/dg/dlq.html).

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 (https://docs.aws.amazon.com/lambda/latest/dg/retries-on-errors.html).

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 (https://docs.aws.amazon.com/lambda/latest/dg/limits.html), 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.

InvokeAsync

FunctionName => Str
InvokeArgs => Str

Each argument is described in detail in: Paws::Lambda::InvokeAsync

Returns: a Paws::Lambda::InvokeAsyncResponse instance

For asynchronous function invocation, use Invoke.

Invokes a function asynchronously.

ListAliases

FunctionName => Str
[FunctionVersion => Str]
[Marker => Str]
[MaxItems => Int]

Each argument is described in detail in: Paws::Lambda::ListAliases

Returns: a Paws::Lambda::ListAliasesResponse instance

Returns a list of aliases (https://docs.aws.amazon.com/lambda/latest/dg/versioning-aliases.html) for a Lambda function.

ListEventSourceMappings

[EventSourceArn => Str]
[FunctionName => Str]
[Marker => Str]
[MaxItems => Int]

Each argument is described in detail in: Paws::Lambda::ListEventSourceMappings

Returns: a Paws::Lambda::ListEventSourceMappingsResponse instance

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

ListFunctions

[FunctionVersion => Str]
[Marker => Str]
[MasterRegion => Str]
[MaxItems => Int]

Each argument is described in detail in: Paws::Lambda::ListFunctions

Returns: a Paws::Lambda::ListFunctionsResponse instance

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.

ListLayers

[CompatibleRuntime => Str]
[Marker => Str]
[MaxItems => Int]

Each argument is described in detail in: Paws::Lambda::ListLayers

Returns: a Paws::Lambda::ListLayersResponse instance

Lists AWS Lambda layers (https://docs.aws.amazon.com/lambda/latest/dg/configuration-layers.html) and shows information about the latest version of each. Specify a runtime identifier (https://docs.aws.amazon.com/lambda/latest/dg/lambda-runtimes.html) to list only layers that indicate that they're compatible with that runtime.

ListLayerVersions

LayerName => Str
[CompatibleRuntime => Str]
[Marker => Str]
[MaxItems => Int]

Each argument is described in detail in: Paws::Lambda::ListLayerVersions

Returns: a Paws::Lambda::ListLayerVersionsResponse instance

Lists the versions of an AWS Lambda layer (https://docs.aws.amazon.com/lambda/latest/dg/configuration-layers.html). Versions that have been deleted aren't listed. Specify a runtime identifier (https://docs.aws.amazon.com/lambda/latest/dg/lambda-runtimes.html) to list only versions that indicate that they're compatible with that runtime.

Resource => Str

Each argument is described in detail in: Paws::Lambda::ListTags

Returns: a Paws::Lambda::ListTagsResponse instance

Returns a function's tags (https://docs.aws.amazon.com/lambda/latest/dg/tagging.html). You can also view tags with GetFunction.

ListVersionsByFunction

FunctionName => Str
[Marker => Str]
[MaxItems => Int]

Each argument is described in detail in: Paws::Lambda::ListVersionsByFunction

Returns: a Paws::Lambda::ListVersionsByFunctionResponse instance

Returns a list of versions (https://docs.aws.amazon.com/lambda/latest/dg/versioning-aliases.html), with the version-specific configuration of each.

PublishLayerVersion

Content => Paws::Lambda::LayerVersionContentInput
LayerName => Str
[CompatibleRuntimes => ArrayRef[Str|Undef]]
[Description => Str]
[LicenseInfo => Str]

Each argument is described in detail in: Paws::Lambda::PublishLayerVersion

Returns: a Paws::Lambda::PublishLayerVersionResponse instance

Creates an AWS Lambda layer (https://docs.aws.amazon.com/lambda/latest/dg/configuration-layers.html) from a ZIP archive. Each time you call PublishLayerVersion with the same version name, a new version is created.

Add layers to your function with CreateFunction or UpdateFunctionConfiguration.

PublishVersion

FunctionName => Str
[CodeSha256 => Str]
[Description => Str]
[RevisionId => Str]

Each argument is described in detail in: Paws::Lambda::PublishVersion

Returns: a Paws::Lambda::FunctionConfiguration instance

Creates a version (https://docs.aws.amazon.com/lambda/latest/dg/versioning-aliases.html) 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.

PutFunctionConcurrency

FunctionName => Str
ReservedConcurrentExecutions => Int

Each argument is described in detail in: Paws::Lambda::PutFunctionConcurrency

Returns: a Paws::Lambda::Concurrency instance

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 (https://docs.aws.amazon.com/lambda/latest/dg/concurrent-executions.html).

RemoveLayerVersionPermission

LayerName => Str
StatementId => Str
VersionNumber => Int
[RevisionId => Str]

Each argument is described in detail in: Paws::Lambda::RemoveLayerVersionPermission

Returns: nothing

Removes a statement from the permissions policy for a version of an AWS Lambda layer (https://docs.aws.amazon.com/lambda/latest/dg/configuration-layers.html). For more information, see AddLayerVersionPermission.

RemovePermission

FunctionName => Str
StatementId => Str
[Qualifier => Str]
[RevisionId => Str]

Each argument is described in detail in: Paws::Lambda::RemovePermission

Returns: nothing

Revokes function-use permission from an AWS service or another account. You can get the ID of the statement from the output of GetPolicy.

TagResource

Resource => Str
Tags => Paws::Lambda::Tags

Each argument is described in detail in: Paws::Lambda::TagResource

Returns: nothing

Adds tags (https://docs.aws.amazon.com/lambda/latest/dg/tagging.html) to a function.

UntagResource

Resource => Str
TagKeys => ArrayRef[Str|Undef]

Each argument is described in detail in: Paws::Lambda::UntagResource

Returns: nothing

Removes tags (https://docs.aws.amazon.com/lambda/latest/dg/tagging.html) from a function.

UpdateAlias

FunctionName => Str
Name => Str
[Description => Str]
[FunctionVersion => Str]
[RevisionId => Str]
[RoutingConfig => Paws::Lambda::AliasRoutingConfiguration]

Each argument is described in detail in: Paws::Lambda::UpdateAlias

Returns: a Paws::Lambda::AliasConfiguration instance

Updates the configuration of a Lambda function alias (https://docs.aws.amazon.com/lambda/latest/dg/versioning-aliases.html).

UpdateEventSourceMapping

UUID => Str
[BatchSize => Int]
[Enabled => Bool]
[FunctionName => Str]

Each argument is described in detail in: Paws::Lambda::UpdateEventSourceMapping

Returns: a Paws::Lambda::EventSourceMappingConfiguration instance

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

UpdateFunctionCode

FunctionName => Str
[DryRun => Bool]
[Publish => Bool]
[RevisionId => Str]
[S3Bucket => Str]
[S3Key => Str]
[S3ObjectVersion => Str]
[ZipFile => Str]

Each argument is described in detail in: Paws::Lambda::UpdateFunctionCode

Returns: a Paws::Lambda::FunctionConfiguration instance

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.

UpdateFunctionConfiguration

FunctionName => Str
[DeadLetterConfig => Paws::Lambda::DeadLetterConfig]
[Description => Str]
[Environment => Paws::Lambda::Environment]
[Handler => Str]
[KMSKeyArn => Str]
[Layers => ArrayRef[Str|Undef]]
[MemorySize => Int]
[RevisionId => Str]
[Role => Str]
[Runtime => Str]
[Timeout => Int]
[TracingConfig => Paws::Lambda::TracingConfig]
[VpcConfig => Paws::Lambda::VpcConfig]

Each argument is described in detail in: Paws::Lambda::UpdateFunctionConfiguration

Returns: a Paws::Lambda::FunctionConfiguration instance

Modify the version-specific settings of a Lambda function.

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.

PAGINATORS

Paginator methods are helpers that repetively call methods that return partial results