class Amazonite::Lambda::Client

Defined in:

lambda/client.cr

Constant Summary

EXCEPTION_FACTORY = ExceptionFactory.new
Log = ::Log.for("amazonite.lambda.client")

Constructors

Instance Method Summary

Instance methods inherited from class Amazonite::Core::Client

post(command, url, body : String) post, query_request(command : String, body : String) query_request, rest_request(command : String, method : String, path : String, headers : HTTP::Headers, body : String | Nil) rest_request

Constructor methods inherited from class Amazonite::Core::Client

new(target_prefix : String, endpoint_prefix : String, json_version : String, exception_factory : ResponseExceptionFactory, config : Amazonite::Core::Config = Config.new) new

Constructor Detail

def self.new(config = Core::Config.new) #

[View source]

Instance Method Detail

def add_layer_version_permission(input : AL::AddLayerVersionPermissionRequest) : Core::ParsedResponse(AL::AddLayerVersionPermissionResponse) #

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

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


[View source]
def add_permission(input : AL::AddPermissionRequest) : Core::ParsedResponse(AL::AddPermissionResponse) #

Grants a principal 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. Note: Lambda does not support adding policies to version $LATEST.

To grant permission to another account, specify the account ID as the Principal. To grant permission to an organization defined in Organizations, specify the organization ID as the PrincipalOrgID. For Amazon Web Services services, the principal is a domain-style identifier that the service defines, such as s3.amazonaws.com or sns.amazonaws.com. For Amazon Web Services services, you can also specify the ARN of the associated resource as the SourceArn. 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 operation adds a statement to a resource-based permissions policy for the function. For more information about function policies, see Using resource-based policies for Lambda.


[View source]
def checkpoint_durable_execution(input : AL::CheckpointDurableExecutionRequest) : Core::ParsedResponse(AL::CheckpointDurableExecutionResponse) #

Saves the progress of a durable function execution during runtime. This API is used by the Lambda durable functions SDK to checkpoint completed steps and schedule asynchronous operations. You typically don't need to call this API directly as the SDK handles checkpointing automatically.

Each checkpoint operation consumes the current checkpoint token and returns a new one for the next checkpoint. This ensures that checkpoints are applied in the correct order and prevents duplicate or out-of-order state updates.


[View source]
def create_alias(input : AL::CreateAliasRequest) : Core::ParsedResponse(AL::AliasConfiguration) #

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.


[View source]
def create_capacity_provider(input : AL::CreateCapacityProviderRequest) : Core::ParsedResponse(AL::CreateCapacityProviderResponse) #

Creates a capacity provider that manages compute resources for Lambda functions


[View source]
def create_code_signing_config(input : AL::CreateCodeSigningConfigRequest) : Core::ParsedResponse(AL::CreateCodeSigningConfigResponse) #

Creates a code signing configuration. A code signing configuration defines a list of allowed signing profiles and defines the code-signing validation policy (action to be taken if deployment validation checks fail).


[View source]
def create_event_source_mapping(input : AL::CreateEventSourceMappingRequest) : Core::ParsedResponse(AL::EventSourceMappingConfiguration) #

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

For details about how to configure different event sources, see the following topics.

The following error handling options are available for stream sources (DynamoDB, Kinesis, Amazon MSK, and self-managed Apache Kafka):

  • BisectBatchOnFunctionError – If the function returns an error, split the batch in two and retry.

  • MaximumRecordAgeInSeconds – Discard records older than the specified age. The default value is infinite (-1). When set to infinite (-1), failed records are retried until the record expires

  • MaximumRetryAttempts – Discard records after the specified number of retries. The default value is infinite (-1). When set to infinite (-1), failed records are retried until the record expires.

  • OnFailure – Send discarded records to an Amazon SQS queue, Amazon SNS topic, Kafka topic, or Amazon S3 bucket. For more information, see Adding a destination.

The following option is available only for DynamoDB and Kinesis event sources:

  • ParallelizationFactor – Process multiple batches from each shard concurrently.

For information about which configuration parameters apply to each event source, see the following topics.


[View source]
def create_function(input : AL::CreateFunctionRequest) : Core::ParsedResponse(AL::FunctionConfiguration) #

Creates a Lambda function. To create a function, you need a deployment package and an execution role. The deployment package is a .zip file archive or container image that contains your function code. The execution role grants the function permission to use Amazon Web Services services, such as Amazon CloudWatch Logs for log streaming and X-Ray for request tracing.

If the deployment package is a container image, then you set the package type to Image. For a container image, the code property must include the URI of a container image in the Amazon ECR registry. You do not need to specify the handler and runtime properties.

If the deployment package is a .zip file archive, then you set the package type to Zip. For a .zip file archive, the code property specifies the location of the .zip file. You must also specify the handler and runtime properties. The code in the deployment package must be compatible with the target instruction set architecture of the function (x86-64 or arm64). If you do not specify the architecture, then the default value is x86-64.

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 Lambda 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).

You can use code signing if your deployment package is a .zip file archive. To enable code signing for this function, specify the ARN of a code-signing configuration. When a user attempts to deploy a code package with UpdateFunctionCode, Lambda checks that the code package has a valid signature from a trusted publisher. The code-signing configuration includes set of signing profiles, which define the trusted publishers for this function.

If another Amazon Web Services account or an Amazon Web Services service invokes your function, use AddPermission to grant permission by creating a resource-based Identity and Access Management (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 Amazon Web Services services, create an event source mapping (CreateEventSourceMapping), or configure a function trigger in the other service. For more information, see Invoking Lambda functions.


[View source]
def create_function_url_config(input : AL::CreateFunctionUrlConfigRequest) : Core::ParsedResponse(AL::CreateFunctionUrlConfigResponse) #

Creates a Lambda function URL with the specified configuration parameters. A function URL is a dedicated HTTP(S) endpoint that you can use to invoke your function.


[View source]
def delete_alias(input : AL::DeleteAliasRequest) : Core::Response #

Deletes a Lambda function alias.


[View source]
def delete_capacity_provider(input : AL::DeleteCapacityProviderRequest) : Core::ParsedResponse(AL::DeleteCapacityProviderResponse) #

Deletes a capacity provider. You cannot delete a capacity provider that is currently being used by Lambda functions.


[View source]
def delete_code_signing_config(input : AL::DeleteCodeSigningConfigRequest) : Core::Response #

Deletes the code signing configuration. You can delete the code signing configuration only if no function is using it.


[View source]
def delete_event_source_mapping(input : AL::DeleteEventSourceMappingRequest) : Core::ParsedResponse(AL::EventSourceMappingConfiguration) #

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.


[View source]
def delete_function(input : AL::DeleteFunctionRequest) : Core::ParsedResponse(AL::DeleteFunctionResponse) #

Deletes a Lambda function. To delete a specific function version, use the Qualifier parameter. Otherwise, all versions and aliases are deleted. This doesn't require the user to have explicit permissions for DeleteAlias.

A deleted Lambda function cannot be recovered. Ensure that you specify the correct function name and version before deleting.

To delete Lambda event source mappings that invoke a function, use DeleteEventSourceMapping. For Amazon Web Services services and resources that invoke your function directly, delete the trigger in the service where you originally configured it.


[View source]
def delete_function_code_signing_config(input : AL::DeleteFunctionCodeSigningConfigRequest) : Core::Response #

Removes the code signing configuration from the function.


[View source]
def delete_function_concurrency(input : AL::DeleteFunctionConcurrencyRequest) : Core::Response #

Removes a concurrent execution limit from a function.


[View source]
def delete_function_event_invoke_config(input : AL::DeleteFunctionEventInvokeConfigRequest) : Core::Response #

Deletes the configuration for asynchronous invocation for a function, version, or alias.

To configure options for asynchronous invocation, use PutFunctionEventInvokeConfig.


[View source]
def delete_function_url_config(input : AL::DeleteFunctionUrlConfigRequest) : Core::Response #

Deletes a Lambda function URL. When you delete a function URL, you can't recover it. Creating a new function URL results in a different URL address.


[View source]
def delete_layer_version(input : AL::DeleteLayerVersionRequest) : Core::Response #

Deletes a version of an 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.


[View source]
def delete_provisioned_concurrency_config(input : AL::DeleteProvisionedConcurrencyConfigRequest) : Core::Response #

Deletes the provisioned concurrency configuration for a function.


[View source]
def delete_resource_policy(input : AL::DeleteResourcePolicyRequest) : Core::Response #

Deletes a resource-based policy from a Lambda resource.


[View source]
def get_account_settings(input : AL::GetAccountSettingsRequest) : Core::ParsedResponse(AL::GetAccountSettingsResponse) #

Retrieves details about your account's limits and usage in an Amazon Web Services Region.


[View source]
def get_alias(input : AL::GetAliasRequest) : Core::ParsedResponse(AL::AliasConfiguration) #

Returns details about a Lambda function alias.


[View source]
def get_capacity_provider(input : AL::GetCapacityProviderRequest) : Core::ParsedResponse(AL::GetCapacityProviderResponse) #

Retrieves information about a specific capacity provider, including its configuration, state, and associated resources.


[View source]
def get_code_signing_config(input : AL::GetCodeSigningConfigRequest) : Core::ParsedResponse(AL::GetCodeSigningConfigResponse) #

Returns information about the specified code signing configuration.


[View source]
def get_durable_execution(input : AL::GetDurableExecutionRequest) : Core::ParsedResponse(AL::GetDurableExecutionResponse) #

Retrieves detailed information about a specific durable execution, including its current status, input payload, result or error information, and execution metadata such as start time and usage statistics.


[View source]
def get_durable_execution_history(input : AL::GetDurableExecutionHistoryRequest) : Core::ParsedResponse(AL::GetDurableExecutionHistoryResponse) #

Retrieves the execution history for a durable execution, showing all the steps, callbacks, and events that occurred during the execution. This provides a detailed audit trail of the execution's progress over time.

The history is available while the execution is running and for a retention period after it completes (1-90 days, default 30 days). You can control whether to include execution data such as step results and callback payloads.


[View source]
def get_durable_execution_state(input : AL::GetDurableExecutionStateRequest) : Core::ParsedResponse(AL::GetDurableExecutionStateResponse) #

Retrieves the current execution state required for the replay process during durable function execution. This API is used by the Lambda durable functions SDK to get state information needed for replay. You typically don't need to call this API directly as the SDK handles state management automatically.

The response contains operations ordered by start sequence number in ascending order. Completed operations with children don't include child operation details since they don't need to be replayed.


[View source]
def get_event_source_mapping(input : AL::GetEventSourceMappingRequest) : Core::ParsedResponse(AL::EventSourceMappingConfiguration) #

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


[View source]
def get_function(input : AL::GetFunctionRequest) : Core::ParsedResponse(AL::GetFunctionResponse) #

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.


[View source]
def get_function_code_signing_config(input : AL::GetFunctionCodeSigningConfigRequest) : Core::ParsedResponse(AL::GetFunctionCodeSigningConfigResponse) #

Returns the code signing configuration for the specified function.


[View source]
def get_function_concurrency(input : AL::GetFunctionConcurrencyRequest) : Core::ParsedResponse(AL::GetFunctionConcurrencyResponse) #

Returns details about the reserved concurrency configuration for a function. To set a concurrency limit for a function, use PutFunctionConcurrency.


[View source]
def get_function_configuration(input : AL::GetFunctionConfigurationRequest) : Core::ParsedResponse(AL::FunctionConfiguration) #

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.


[View source]
def get_function_event_invoke_config(input : AL::GetFunctionEventInvokeConfigRequest) : Core::ParsedResponse(AL::FunctionEventInvokeConfig) #

Retrieves the configuration for asynchronous invocation for a function, version, or alias.

To configure options for asynchronous invocation, use PutFunctionEventInvokeConfig.


[View source]
def get_function_recursion_config(input : AL::GetFunctionRecursionConfigRequest) : Core::ParsedResponse(AL::GetFunctionRecursionConfigResponse) #

Returns your function's recursive loop detection configuration.


[View source]
def get_function_scaling_config(input : AL::GetFunctionScalingConfigRequest) : Core::ParsedResponse(AL::GetFunctionScalingConfigResponse) #

Retrieves the scaling configuration for a Lambda Managed Instances function.


[View source]
def get_function_url_config(input : AL::GetFunctionUrlConfigRequest) : Core::ParsedResponse(AL::GetFunctionUrlConfigResponse) #

Returns details about a Lambda function URL.


[View source]
def get_layer_version(input : AL::GetLayerVersionRequest) : Core::ParsedResponse(AL::GetLayerVersionResponse) #

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


[View source]
def get_layer_version_by_arn(input : AL::GetLayerVersionByArnRequest) : Core::ParsedResponse(AL::GetLayerVersionResponse) #

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


[View source]
def get_layer_version_policy(input : AL::GetLayerVersionPolicyRequest) : Core::ParsedResponse(AL::GetLayerVersionPolicyResponse) #

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


[View source]
def get_policy(input : AL::GetPolicyRequest) : Core::ParsedResponse(AL::GetPolicyResponse) #

Returns the resource-based IAM policy for a function, version, or alias.


[View source]
def get_provisioned_concurrency_config(input : AL::GetProvisionedConcurrencyConfigRequest) : Core::ParsedResponse(AL::GetProvisionedConcurrencyConfigResponse) #

Retrieves the provisioned concurrency configuration for a function's alias or version.


[View source]
def get_resource_policy(input : AL::GetResourcePolicyRequest) : Core::ParsedResponse(AL::GetResourcePolicyResponse) #

Retrieves the resource-based policy attached to a Lambda resource.


[View source]
def get_runtime_management_config(input : AL::GetRuntimeManagementConfigRequest) : Core::ParsedResponse(AL::GetRuntimeManagementConfigResponse) #

Retrieves the runtime management configuration for a function's version. If the runtime update mode is Manual, this includes the ARN of the runtime version and the runtime update mode. If the runtime update mode is Auto or Function update, this includes the runtime update mode and null is returned for the ARN. For more information, see Runtime updates.


[View source]
def invoke(input : AL::InvocationRequest) : Core::ParsedResponse(AL::InvocationResponse) #

Invokes a Lambda function. You can invoke a function synchronously (and wait for the response), or asynchronously. By default, Lambda invokes your function synchronously (i.e. theInvocationType is RequestResponse). To invoke a function asynchronously, set InvocationType to Event. Lambda passes the ClientContext object to your function for synchronous invocations only.

For synchronous invocations, the maximum payload size is 6 MB. For asynchronous invocations, the maximum payload size is 1 MB.

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 Error handling and automatic retries in Lambda.

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, quota errors, or issues with your function's code and configuration. For example, Lambda returns TooManyRequestsException if running 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 disconnect 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. For details on how to set up permissions for cross-account invocations, see Granting function access to other accounts.


[View source]
def invoke_async(input : AL::InvokeAsyncRequest) : Core::ParsedResponse(AL::InvokeAsyncResponse) #

For asynchronous function invocation, use Invoke.

Invokes a function asynchronously.

The payload limit is 256KB. For larger payloads, for up to 1MB, use Invoke.

If you do use the InvokeAsync action, note that it doesn't support the use of X-Ray active tracing. Trace ID is not propagated to the function, even if X-Ray active tracing is turned on.


[View source]
def list_aliases(input : AL::ListAliasesRequest) : Core::ParsedResponse(AL::ListAliasesResponse) #

Returns a list of aliases for a Lambda function.


[View source]
def list_capacity_providers(input : AL::ListCapacityProvidersRequest) : Core::ParsedResponse(AL::ListCapacityProvidersResponse) #

Returns a list of capacity providers in your account.


[View source]
def list_code_signing_configs(input : AL::ListCodeSigningConfigsRequest) : Core::ParsedResponse(AL::ListCodeSigningConfigsResponse) #

Returns a list of code signing configurations. A request returns up to 10,000 configurations per call. You can use the MaxItems parameter to return fewer configurations per call.


[View source]
def list_durable_executions_by_function(input : AL::ListDurableExecutionsByFunctionRequest) : Core::ParsedResponse(AL::ListDurableExecutionsByFunctionResponse) #

Returns a list of durable executions for a specified Lambda function. You can filter the results by execution name, status, and start time range. This API supports pagination for large result sets.


[View source]
def list_event_source_mappings(input : AL::ListEventSourceMappingsRequest) : Core::ParsedResponse(AL::ListEventSourceMappingsResponse) #

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


[View source]
def list_function_event_invoke_configs(input : AL::ListFunctionEventInvokeConfigsRequest) : Core::ParsedResponse(AL::ListFunctionEventInvokeConfigsResponse) #

Retrieves a list of configurations for asynchronous invocation for a function.

To configure options for asynchronous invocation, use PutFunctionEventInvokeConfig.


[View source]
def list_function_url_configs(input : AL::ListFunctionUrlConfigsRequest) : Core::ParsedResponse(AL::ListFunctionUrlConfigsResponse) #

Returns a list of Lambda function URLs for the specified function.


[View source]
def list_function_versions_by_capacity_provider(input : AL::ListFunctionVersionsByCapacityProviderRequest) : Core::ParsedResponse(AL::ListFunctionVersionsByCapacityProviderResponse) #

Returns a list of function versions that are configured to use a specific capacity provider.


[View source]
def list_functions(input : AL::ListFunctionsRequest) : Core::ParsedResponse(AL::ListFunctionsResponse) #

Returns a list of Lambda functions, with the version-specific configuration of each. Lambda returns up to 50 functions per call.

Set FunctionVersion to ALL to include all published versions of each function in addition to the unpublished version.

The ListFunctions operation returns a subset of the FunctionConfiguration fields. To get the additional fields (State, StateReasonCode, StateReason, LastUpdateStatus, LastUpdateStatusReason, LastUpdateStatusReasonCode, RuntimeVersionConfig) for a function or version, use GetFunction.


[View source]
def list_functions_by_code_signing_config(input : AL::ListFunctionsByCodeSigningConfigRequest) : Core::ParsedResponse(AL::ListFunctionsByCodeSigningConfigResponse) #

List the functions that use the specified code signing configuration. You can use this method prior to deleting a code signing configuration, to verify that no functions are using it.


[View source]
def list_layer_versions(input : AL::ListLayerVersionsRequest) : Core::ParsedResponse(AL::ListLayerVersionsResponse) #

Lists the versions of an 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. Specify a compatible architecture to include only layer versions that are compatible with that architecture.


[View source]
def list_layers(input : AL::ListLayersRequest) : Core::ParsedResponse(AL::ListLayersResponse) #

Lists 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. Specify a compatible architecture to include only layers that are compatible with that instruction set architecture.


[View source]
def list_provisioned_concurrency_configs(input : AL::ListProvisionedConcurrencyConfigsRequest) : Core::ParsedResponse(AL::ListProvisionedConcurrencyConfigsResponse) #

Retrieves a list of provisioned concurrency configurations for a function.


[View source]
def list_tags(input : AL::ListTagsRequest) : Core::ParsedResponse(AL::ListTagsResponse) #

Returns a function, event source mapping, or code signing configuration's tags. You can also view function tags with GetFunction.


[View source]
def list_versions_by_function(input : AL::ListVersionsByFunctionRequest) : Core::ParsedResponse(AL::ListVersionsByFunctionResponse) #

Returns a list of versions, with the version-specific configuration of each. Lambda returns up to 50 versions per call.


[View source]
def publish_layer_version(input : AL::PublishLayerVersionRequest) : Core::ParsedResponse(AL::PublishLayerVersionResponse) #

Creates an 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.


[View source]
def publish_version(input : AL::PublishVersionRequest) : Core::ParsedResponse(AL::FunctionConfiguration) #

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.

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.


[View source]
def put_function_code_signing_config(input : AL::PutFunctionCodeSigningConfigRequest) : Core::ParsedResponse(AL::PutFunctionCodeSigningConfigResponse) #

Update the code signing configuration for the function. Changes to the code signing configuration take effect the next time a user tries to deploy a code package to the function.


[View source]
def put_function_concurrency(input : AL::PutFunctionConcurrencyRequest) : Core::ParsedResponse(AL::Concurrency) #

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 Lambda function scaling.


[View source]
def put_function_event_invoke_config(input : AL::PutFunctionEventInvokeConfigRequest) : Core::ParsedResponse(AL::FunctionEventInvokeConfig) #

Configures options for asynchronous invocation on a function, version, or alias. If a configuration already exists for a function, version, or alias, this operation overwrites it. If you exclude any settings, they are removed. To set one option without affecting existing settings for other options, use UpdateFunctionEventInvokeConfig.

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.

To send an invocation record to a queue, topic, S3 bucket, function, or event bus, specify a destination. You can configure separate destinations for successful invocations (on-success) and events that fail all processing attempts (on-failure). You can configure destinations in addition to or instead of a dead-letter queue.

S3 buckets are supported only for on-failure destinations. To retain records of successful invocations, use another destination type.


[View source]
def put_function_recursion_config(input : AL::PutFunctionRecursionConfigRequest) : Core::ParsedResponse(AL::PutFunctionRecursionConfigResponse) #

Sets your function's recursive loop detection configuration.

When you configure a Lambda function to output to the same service or resource that invokes the function, it's possible to create an infinite recursive loop. For example, a Lambda function might write a message to an Amazon Simple Queue Service (Amazon SQS) queue, which then invokes the same function. This invocation causes the function to write another message to the queue, which in turn invokes the function again.

Lambda can detect certain types of recursive loops shortly after they occur. When Lambda detects a recursive loop and your function's recursive loop detection configuration is set to Terminate, it stops your function being invoked and notifies you.


[View source]
def put_function_scaling_config(input : AL::PutFunctionScalingConfigRequest) : Core::ParsedResponse(AL::PutFunctionScalingConfigResponse) #

Sets the scaling configuration for a Lambda Managed Instances function. The scaling configuration defines the minimum and maximum number of execution environments that can be provisioned for the function, allowing you to control scaling behavior and resource allocation.


[View source]
def put_provisioned_concurrency_config(input : AL::PutProvisionedConcurrencyConfigRequest) : Core::ParsedResponse(AL::PutProvisionedConcurrencyConfigResponse) #

Adds a provisioned concurrency configuration to a function's alias or version.


[View source]
def put_resource_policy(input : AL::PutResourcePolicyRequest) : Core::ParsedResponse(AL::PutResourcePolicyResponse) #

Adds a resource-based policy to a Lambda resource. Resource-based policies grant access to other Amazon Web Services accounts, organizations, or services. Resource-based policies apply to a single Lambda resource (for example, a function, function version, or function alias).

This operation replaces any existing policy on the Lambda resource. If you previously added permissions using the AddPermission operation, the new policy overwrites those permissions.


[View source]
def put_runtime_management_config(input : AL::PutRuntimeManagementConfigRequest) : Core::ParsedResponse(AL::PutRuntimeManagementConfigResponse) #

Sets the runtime management configuration for a function's version. For more information, see Runtime updates.


[View source]
def remove_layer_version_permission(input : AL::RemoveLayerVersionPermissionRequest) : Core::Response #

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


[View source]
def remove_permission(input : AL::RemovePermissionRequest) : Core::Response #

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


[View source]
def send_durable_execution_callback_failure(input : AL::SendDurableExecutionCallbackFailureRequest) : Core::ParsedResponse(AL::SendDurableExecutionCallbackFailureResponse) #

Sends a failure response for a callback operation in a durable execution. Use this API when an external system cannot complete a callback operation successfully.


[View source]
def send_durable_execution_callback_heartbeat(input : AL::SendDurableExecutionCallbackHeartbeatRequest) : Core::ParsedResponse(AL::SendDurableExecutionCallbackHeartbeatResponse) #

Sends a heartbeat signal for a long-running callback operation to prevent timeout. Use this API to extend the callback timeout period while the external operation is still in progress.


[View source]
def send_durable_execution_callback_success(input : AL::SendDurableExecutionCallbackSuccessRequest) : Core::ParsedResponse(AL::SendDurableExecutionCallbackSuccessResponse) #

Sends a successful completion response for a callback operation in a durable execution. Use this API when an external system has successfully completed a callback operation.


[View source]
def stop_durable_execution(input : AL::StopDurableExecutionRequest) : Core::ParsedResponse(AL::StopDurableExecutionResponse) #

Stops a running durable execution. The execution transitions to STOPPED status and cannot be resumed. Any in-progress operations are terminated.


[View source]
def tag_resource(input : AL::TagResourceRequest) : Core::Response #

Adds tags to a function, event source mapping, or code signing configuration.


[View source]
def untag_resource(input : AL::UntagResourceRequest) : Core::Response #

Removes tags from a function, event source mapping, or code signing configuration.


[View source]
def update_alias(input : AL::UpdateAliasRequest) : Core::ParsedResponse(AL::AliasConfiguration) #

Updates the configuration of a Lambda function alias.


[View source]
def update_capacity_provider(input : AL::UpdateCapacityProviderRequest) : Core::ParsedResponse(AL::UpdateCapacityProviderResponse) #

Updates the configuration of an existing capacity provider.


[View source]
def update_code_signing_config(input : AL::UpdateCodeSigningConfigRequest) : Core::ParsedResponse(AL::UpdateCodeSigningConfigResponse) #

Update the code signing configuration. Changes to the code signing configuration take effect the next time a user tries to deploy a code package to the function.


[View source]
def update_event_source_mapping(input : AL::UpdateEventSourceMappingRequest) : Core::ParsedResponse(AL::EventSourceMappingConfiguration) #

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

For details about how to configure different event sources, see the following topics.

The following error handling options are available for stream sources (DynamoDB, Kinesis, Amazon MSK, and self-managed Apache Kafka):

  • BisectBatchOnFunctionError – If the function returns an error, split the batch in two and retry.

  • MaximumRecordAgeInSeconds – Discard records older than the specified age. The default value is infinite (-1). When set to infinite (-1), failed records are retried until the record expires

  • MaximumRetryAttempts – Discard records after the specified number of retries. The default value is infinite (-1). When set to infinite (-1), failed records are retried until the record expires.

  • OnFailure – Send discarded records to an Amazon SQS queue, Amazon SNS topic, Kafka topic, or Amazon S3 bucket. For more information, see Adding a destination.

The following option is available only for DynamoDB and Kinesis event sources:

  • ParallelizationFactor – Process multiple batches from each shard concurrently.

For information about which configuration parameters apply to each event source, see the following topics.


[View source]
def update_function_code(input : AL::UpdateFunctionCodeRequest) : Core::ParsedResponse(AL::FunctionConfiguration) #

Updates a Lambda function's code. If code signing is enabled for the function, the code package must be signed by a trusted publisher. For more information, see Configuring code signing for Lambda.

If the function's package type is Image, then you must specify the code package in ImageUri as the URI of a container image in the Amazon ECR registry.

If the function's package type is Zip, then you must specify the deployment package as a .zip file archive. Enter the Amazon S3 bucket and key of the code .zip file location. You can also provide the function code inline using the ZipFile field.

The code in the deployment package must be compatible with the target instruction set architecture of the function (x86-64 or arm64).

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.

For a function defined as a container image, Lambda resolves the image tag to an image digest. In Amazon ECR, if you update the image tag to a new image, Lambda does not automatically update the function.


[View source]
def update_function_configuration(input : AL::UpdateFunctionConfigurationRequest) : Core::ParsedResponse(AL::FunctionConfiguration) #

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 Lambda 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 Amazon Web Services account or Amazon Web Services service, use AddPermission.


[View source]
def update_function_event_invoke_config(input : AL::UpdateFunctionEventInvokeConfigRequest) : Core::ParsedResponse(AL::FunctionEventInvokeConfig) #

Updates the configuration for asynchronous invocation for a function, version, or alias.

To configure options for asynchronous invocation, use PutFunctionEventInvokeConfig.


[View source]
def update_function_url_config(input : AL::UpdateFunctionUrlConfigRequest) : Core::ParsedResponse(AL::UpdateFunctionUrlConfigResponse) #

Updates the configuration for a Lambda function URL.


[View source]