Class: Aws::Lambda::Client
- Inherits:
-
Seahorse::Client::Base
- Object
- Seahorse::Client::Base
- Aws::Lambda::Client
- Includes:
- ClientStubs
- Defined in:
- gems/aws-sdk-lambda/lib/aws-sdk-lambda/client.rb
Overview
An API client for Lambda. To construct a client, you need to configure a :region
and :credentials
.
client = Aws::Lambda::Client.new(
region: region_name,
credentials: credentials,
# ...
)
For details on configuring region and credentials see the developer guide.
See #initialize for a full list of supported configuration options.
Instance Attribute Summary
Attributes inherited from Seahorse::Client::Base
API Operations collapse
-
#add_layer_version_permission(params = {}) ⇒ Types::AddLayerVersionPermissionResponse
Adds permissions to the resource-based policy of a version of an [Lambda layer][1].
-
#add_permission(params = {}) ⇒ Types::AddPermissionResponse
Grants a [principal][1] permission to use a function.
-
#create_alias(params = {}) ⇒ Types::AliasConfiguration
Creates an [alias][1] for a Lambda function version.
-
#create_code_signing_config(params = {}) ⇒ Types::CreateCodeSigningConfigResponse
Creates a code signing configuration.
-
#create_event_source_mapping(params = {}) ⇒ Types::EventSourceMappingConfiguration
Creates a mapping between an event source and an Lambda function.
-
#create_function(params = {}) ⇒ Types::FunctionConfiguration
Creates a Lambda function.
-
#create_function_url_config(params = {}) ⇒ Types::CreateFunctionUrlConfigResponse
Creates a Lambda function URL with the specified configuration parameters.
-
#delete_alias(params = {}) ⇒ Struct
Deletes a Lambda function [alias][1].
-
#delete_code_signing_config(params = {}) ⇒ Struct
Deletes the code signing configuration.
-
#delete_event_source_mapping(params = {}) ⇒ Types::EventSourceMappingConfiguration
Deletes an [event source mapping][1].
-
#delete_function(params = {}) ⇒ Struct
Deletes a Lambda function.
-
#delete_function_code_signing_config(params = {}) ⇒ Struct
Removes the code signing configuration from the function.
-
#delete_function_concurrency(params = {}) ⇒ Struct
Removes a concurrent execution limit from a function.
-
#delete_function_event_invoke_config(params = {}) ⇒ Struct
Deletes the configuration for asynchronous invocation for a function, version, or alias.
-
#delete_function_url_config(params = {}) ⇒ Struct
Deletes a Lambda function URL.
-
#delete_layer_version(params = {}) ⇒ Struct
Deletes a version of an [Lambda layer][1].
-
#delete_provisioned_concurrency_config(params = {}) ⇒ Struct
Deletes the provisioned concurrency configuration for a function.
-
#get_account_settings(params = {}) ⇒ Types::GetAccountSettingsResponse
Retrieves details about your account's [limits][1] and usage in an Amazon Web Services Region.
-
#get_alias(params = {}) ⇒ Types::AliasConfiguration
Returns details about a Lambda function [alias][1].
-
#get_code_signing_config(params = {}) ⇒ Types::GetCodeSigningConfigResponse
Returns information about the specified code signing configuration.
-
#get_event_source_mapping(params = {}) ⇒ Types::EventSourceMappingConfiguration
Returns details about an event source mapping.
-
#get_function(params = {}) ⇒ Types::GetFunctionResponse
Returns information about the function or function version, with a link to download the deployment package that's valid for 10 minutes.
-
#get_function_code_signing_config(params = {}) ⇒ Types::GetFunctionCodeSigningConfigResponse
Returns the code signing configuration for the specified function.
-
#get_function_concurrency(params = {}) ⇒ Types::GetFunctionConcurrencyResponse
Returns details about the reserved concurrency configuration for a function.
-
#get_function_configuration(params = {}) ⇒ Types::FunctionConfiguration
Returns the version-specific settings of a Lambda function or version.
-
#get_function_event_invoke_config(params = {}) ⇒ Types::FunctionEventInvokeConfig
Retrieves the configuration for asynchronous invocation for a function, version, or alias.
-
#get_function_recursion_config(params = {}) ⇒ Types::GetFunctionRecursionConfigResponse
Returns your function's [recursive loop detection][1] configuration.
-
#get_function_url_config(params = {}) ⇒ Types::GetFunctionUrlConfigResponse
Returns details about a Lambda function URL.
-
#get_layer_version(params = {}) ⇒ Types::GetLayerVersionResponse
Returns information about a version of an [Lambda layer][1], with a link to download the layer archive that's valid for 10 minutes.
-
#get_layer_version_by_arn(params = {}) ⇒ Types::GetLayerVersionResponse
Returns information about a version of an [Lambda layer][1], with a link to download the layer archive that's valid for 10 minutes.
-
#get_layer_version_policy(params = {}) ⇒ Types::GetLayerVersionPolicyResponse
Returns the permission policy for a version of an [Lambda layer][1].
-
#get_policy(params = {}) ⇒ Types::GetPolicyResponse
Returns the [resource-based IAM policy][1] for a function, version, or alias.
-
#get_provisioned_concurrency_config(params = {}) ⇒ Types::GetProvisionedConcurrencyConfigResponse
Retrieves the provisioned concurrency configuration for a function's alias or version.
-
#get_runtime_management_config(params = {}) ⇒ Types::GetRuntimeManagementConfigResponse
Retrieves the runtime management configuration for a function's version.
-
#invoke(params = {}) ⇒ Types::InvocationResponse
Invokes a Lambda function.
-
#invoke_async(params = {}) ⇒ Types::InvokeAsyncResponse
For asynchronous function invocation, use Invoke.
-
#invoke_with_response_stream(params = {}) ⇒ Types::InvokeWithResponseStreamResponse
Configure your Lambda functions to stream response payloads back to clients.
-
#list_aliases(params = {}) ⇒ Types::ListAliasesResponse
Returns a list of [aliases][1] for a Lambda function.
-
#list_code_signing_configs(params = {}) ⇒ Types::ListCodeSigningConfigsResponse
Returns a list of [code signing configurations][1].
-
#list_event_source_mappings(params = {}) ⇒ Types::ListEventSourceMappingsResponse
Lists event source mappings.
-
#list_function_event_invoke_configs(params = {}) ⇒ Types::ListFunctionEventInvokeConfigsResponse
Retrieves a list of configurations for asynchronous invocation for a function.
-
#list_function_url_configs(params = {}) ⇒ Types::ListFunctionUrlConfigsResponse
Returns a list of Lambda function URLs for the specified function.
-
#list_functions(params = {}) ⇒ Types::ListFunctionsResponse
Returns a list of Lambda functions, with the version-specific configuration of each.
-
#list_functions_by_code_signing_config(params = {}) ⇒ Types::ListFunctionsByCodeSigningConfigResponse
List the functions that use the specified code signing configuration.
-
#list_layer_versions(params = {}) ⇒ Types::ListLayerVersionsResponse
Lists the versions of an [Lambda layer][1].
-
#list_layers(params = {}) ⇒ Types::ListLayersResponse
Lists [Lambda layers][1] and shows information about the latest version of each.
-
#list_provisioned_concurrency_configs(params = {}) ⇒ Types::ListProvisionedConcurrencyConfigsResponse
Retrieves a list of provisioned concurrency configurations for a function.
-
#list_tags(params = {}) ⇒ Types::ListTagsResponse
Returns a function, event source mapping, or code signing configuration's [tags][1].
-
#list_versions_by_function(params = {}) ⇒ Types::ListVersionsByFunctionResponse
Returns a list of [versions][1], with the version-specific configuration of each.
-
#publish_layer_version(params = {}) ⇒ Types::PublishLayerVersionResponse
Creates an [Lambda layer][1] from a ZIP archive.
-
#publish_version(params = {}) ⇒ Types::FunctionConfiguration
Creates a [version][1] from the current code and configuration of a function.
-
#put_function_code_signing_config(params = {}) ⇒ Types::PutFunctionCodeSigningConfigResponse
Update the code signing configuration for the function.
-
#put_function_concurrency(params = {}) ⇒ Types::Concurrency
Sets the maximum number of simultaneous executions for a function, and reserves capacity for that concurrency level.
-
#put_function_event_invoke_config(params = {}) ⇒ Types::FunctionEventInvokeConfig
Configures options for [asynchronous invocation][1] on a function, version, or alias.
-
#put_function_recursion_config(params = {}) ⇒ Types::PutFunctionRecursionConfigResponse
Sets your function's [recursive loop detection][1] configuration.
-
#put_provisioned_concurrency_config(params = {}) ⇒ Types::PutProvisionedConcurrencyConfigResponse
Adds a provisioned concurrency configuration to a function's alias or version.
-
#put_runtime_management_config(params = {}) ⇒ Types::PutRuntimeManagementConfigResponse
Sets the runtime management configuration for a function's version.
-
#remove_layer_version_permission(params = {}) ⇒ Struct
Removes a statement from the permissions policy for a version of an [Lambda layer][1].
-
#remove_permission(params = {}) ⇒ Struct
Revokes function-use permission from an Amazon Web Services service or another Amazon Web Services account.
-
#tag_resource(params = {}) ⇒ Struct
Adds [tags][1] to a function, event source mapping, or code signing configuration.
-
#untag_resource(params = {}) ⇒ Struct
Removes [tags][1] from a function, event source mapping, or code signing configuration.
-
#update_alias(params = {}) ⇒ Types::AliasConfiguration
Updates the configuration of a Lambda function [alias][1].
-
#update_code_signing_config(params = {}) ⇒ Types::UpdateCodeSigningConfigResponse
Update the code signing configuration.
-
#update_event_source_mapping(params = {}) ⇒ Types::EventSourceMappingConfiguration
Updates an event source mapping.
-
#update_function_code(params = {}) ⇒ Types::FunctionConfiguration
Updates a Lambda function's code.
-
#update_function_configuration(params = {}) ⇒ Types::FunctionConfiguration
Modify the version-specific settings of a Lambda function.
-
#update_function_event_invoke_config(params = {}) ⇒ Types::FunctionEventInvokeConfig
Updates the configuration for asynchronous invocation for a function, version, or alias.
-
#update_function_url_config(params = {}) ⇒ Types::UpdateFunctionUrlConfigResponse
Updates the configuration for a Lambda function URL.
Instance Method Summary collapse
-
#initialize(options) ⇒ Client
constructor
A new instance of Client.
-
#wait_until(waiter_name, params = {}, options = {}) {|w.waiter| ... } ⇒ Boolean
Polls an API operation until a resource enters a desired state.
Methods included from ClientStubs
#api_requests, #stub_data, #stub_responses
Methods inherited from Seahorse::Client::Base
add_plugin, api, clear_plugins, define, new, #operation_names, plugins, remove_plugin, set_api, set_plugins
Methods included from Seahorse::Client::HandlerBuilder
#handle, #handle_request, #handle_response
Constructor Details
#initialize(options) ⇒ Client
Returns a new instance of Client.
455 456 457 |
# File 'gems/aws-sdk-lambda/lib/aws-sdk-lambda/client.rb', line 455 def initialize(*args) super end |
Instance Method Details
#add_layer_version_permission(params = {}) ⇒ Types::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.
548 549 550 551 |
# File 'gems/aws-sdk-lambda/lib/aws-sdk-lambda/client.rb', line 548 def (params = {}, = {}) req = build_request(:add_layer_version_permission, params) req.send_request() end |
#add_permission(params = {}) ⇒ Types::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.
718 719 720 721 |
# File 'gems/aws-sdk-lambda/lib/aws-sdk-lambda/client.rb', line 718 def (params = {}, = {}) req = build_request(:add_permission, params) req.send_request() end |
#create_alias(params = {}) ⇒ Types::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.
824 825 826 827 |
# File 'gems/aws-sdk-lambda/lib/aws-sdk-lambda/client.rb', line 824 def create_alias(params = {}, = {}) req = build_request(:create_alias, params) req.send_request() end |
#create_code_signing_config(params = {}) ⇒ Types::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).
884 885 886 887 |
# File 'gems/aws-sdk-lambda/lib/aws-sdk-lambda/client.rb', line 884 def create_code_signing_config(params = {}, = {}) req = build_request(:create_code_signing_config, params) req.send_request() end |
#create_event_source_mapping(params = {}) ⇒ Types::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 only for DynamoDB and Kinesis event sources:
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 expiresMaximumRetryAttempts
– 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.ParallelizationFactor
– Process multiple batches from each shard concurrently.
For stream sources (DynamoDB, Kinesis, Amazon MSK, and self-managed Apache Kafka), the following option is also available:
DestinationConfig
– Send discarded records to an Amazon SQS queue, Amazon SNS topic, or Amazon S3 bucket.
^
For information about which configuration parameters apply to each event source, see the following topics.
1350 1351 1352 1353 |
# File 'gems/aws-sdk-lambda/lib/aws-sdk-lambda/client.rb', line 1350 def create_event_source_mapping(params = {}, = {}) req = build_request(:create_event_source_mapping, params) req.send_request() end |
#create_function(params = {}) ⇒ Types::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.
1867 1868 1869 1870 |
# File 'gems/aws-sdk-lambda/lib/aws-sdk-lambda/client.rb', line 1867 def create_function(params = {}, = {}) req = build_request(:create_function, params) req.send_request() end |
#create_function_url_config(params = {}) ⇒ Types::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.
1979 1980 1981 1982 |
# File 'gems/aws-sdk-lambda/lib/aws-sdk-lambda/client.rb', line 1979 def create_function_url_config(params = {}, = {}) req = build_request(:create_function_url_config, params) req.send_request() end |
#delete_alias(params = {}) ⇒ Struct
Deletes a Lambda function alias.
2031 2032 2033 2034 |
# File 'gems/aws-sdk-lambda/lib/aws-sdk-lambda/client.rb', line 2031 def delete_alias(params = {}, = {}) req = build_request(:delete_alias, params) req.send_request() end |
#delete_code_signing_config(params = {}) ⇒ Struct
Deletes the code signing configuration. You can delete the code signing configuration only if no function is using it.
2054 2055 2056 2057 |
# File 'gems/aws-sdk-lambda/lib/aws-sdk-lambda/client.rb', line 2054 def delete_code_signing_config(params = {}, = {}) req = build_request(:delete_code_signing_config, params) req.send_request() end |
#delete_event_source_mapping(params = {}) ⇒ Types::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.
2186 2187 2188 2189 |
# File 'gems/aws-sdk-lambda/lib/aws-sdk-lambda/client.rb', line 2186 def delete_event_source_mapping(params = {}, = {}) req = build_request(:delete_event_source_mapping, params) req.send_request() end |
#delete_function(params = {}) ⇒ Struct
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.
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.
2245 2246 2247 2248 |
# File 'gems/aws-sdk-lambda/lib/aws-sdk-lambda/client.rb', line 2245 def delete_function(params = {}, = {}) req = build_request(:delete_function, params) req.send_request() end |
#delete_function_code_signing_config(params = {}) ⇒ Struct
Removes the code signing configuration from the function.
2279 2280 2281 2282 |
# File 'gems/aws-sdk-lambda/lib/aws-sdk-lambda/client.rb', line 2279 def delete_function_code_signing_config(params = {}, = {}) req = build_request(:delete_function_code_signing_config, params) req.send_request() end |
#delete_function_concurrency(params = {}) ⇒ Struct
Removes a concurrent execution limit from a function.
2322 2323 2324 2325 |
# File 'gems/aws-sdk-lambda/lib/aws-sdk-lambda/client.rb', line 2322 def delete_function_concurrency(params = {}, = {}) req = build_request(:delete_function_concurrency, params) req.send_request() end |
#delete_function_event_invoke_config(params = {}) ⇒ Struct
Deletes the configuration for asynchronous invocation for a function, version, or alias.
To configure options for asynchronous invocation, use PutFunctionEventInvokeConfig.
2377 2378 2379 2380 |
# File 'gems/aws-sdk-lambda/lib/aws-sdk-lambda/client.rb', line 2377 def delete_function_event_invoke_config(params = {}, = {}) req = build_request(:delete_function_event_invoke_config, params) req.send_request() end |
#delete_function_url_config(params = {}) ⇒ Struct
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.
2417 2418 2419 2420 |
# File 'gems/aws-sdk-lambda/lib/aws-sdk-lambda/client.rb', line 2417 def delete_function_url_config(params = {}, = {}) req = build_request(:delete_function_url_config, params) req.send_request() end |
#delete_layer_version(params = {}) ⇒ Struct
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.
2459 2460 2461 2462 |
# File 'gems/aws-sdk-lambda/lib/aws-sdk-lambda/client.rb', line 2459 def delete_layer_version(params = {}, = {}) req = build_request(:delete_layer_version, params) req.send_request() end |
#delete_provisioned_concurrency_config(params = {}) ⇒ Struct
Deletes the provisioned concurrency configuration for a function.
2508 2509 2510 2511 |
# File 'gems/aws-sdk-lambda/lib/aws-sdk-lambda/client.rb', line 2508 def delete_provisioned_concurrency_config(params = {}, = {}) req = build_request(:delete_provisioned_concurrency_config, params) req.send_request() end |
#get_account_settings(params = {}) ⇒ Types::GetAccountSettingsResponse
Retrieves details about your account's limits and usage in an Amazon Web Services Region.
2562 2563 2564 2565 |
# File 'gems/aws-sdk-lambda/lib/aws-sdk-lambda/client.rb', line 2562 def get_account_settings(params = {}, = {}) req = build_request(:get_account_settings, params) req.send_request() end |
#get_alias(params = {}) ⇒ Types::AliasConfiguration
Returns details about a Lambda function alias.
2640 2641 2642 2643 |
# File 'gems/aws-sdk-lambda/lib/aws-sdk-lambda/client.rb', line 2640 def get_alias(params = {}, = {}) req = build_request(:get_alias, params) req.send_request() end |
#get_code_signing_config(params = {}) ⇒ Types::GetCodeSigningConfigResponse
Returns information about the specified code signing configuration.
2674 2675 2676 2677 |
# File 'gems/aws-sdk-lambda/lib/aws-sdk-lambda/client.rb', line 2674 def get_code_signing_config(params = {}, = {}) req = build_request(:get_code_signing_config, params) req.send_request() end |
#get_event_source_mapping(params = {}) ⇒ Types::EventSourceMappingConfiguration
Returns details about an event source mapping. You can get the identifier of a mapping from the output of ListEventSourceMappings.
2806 2807 2808 2809 |
# File 'gems/aws-sdk-lambda/lib/aws-sdk-lambda/client.rb', line 2806 def get_event_source_mapping(params = {}, = {}) req = build_request(:get_event_source_mapping, params) req.send_request() end |
#get_function(params = {}) ⇒ Types::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.
The following waiters are defined for this operation (see #wait_until for detailed usage):
- function_active_v2
- function_exists
- function_updated_v2
2987 2988 2989 2990 |
# File 'gems/aws-sdk-lambda/lib/aws-sdk-lambda/client.rb', line 2987 def get_function(params = {}, = {}) req = build_request(:get_function, params) req.send_request() end |
#get_function_code_signing_config(params = {}) ⇒ Types::GetFunctionCodeSigningConfigResponse
Returns the code signing configuration for the specified function.
3029 3030 3031 3032 |
# File 'gems/aws-sdk-lambda/lib/aws-sdk-lambda/client.rb', line 3029 def get_function_code_signing_config(params = {}, = {}) req = build_request(:get_function_code_signing_config, params) req.send_request() end |
#get_function_concurrency(params = {}) ⇒ Types::GetFunctionConcurrencyResponse
Returns details about the reserved concurrency configuration for a function. To set a concurrency limit for a function, use PutFunctionConcurrency.
3085 3086 3087 3088 |
# File 'gems/aws-sdk-lambda/lib/aws-sdk-lambda/client.rb', line 3085 def get_function_concurrency(params = {}, = {}) req = build_request(:get_function_concurrency, params) req.send_request() end |
#get_function_configuration(params = {}) ⇒ Types::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.
The following waiters are defined for this operation (see #wait_until for detailed usage):
- function_active
- function_updated
- published_version_active
3280 3281 3282 3283 |
# File 'gems/aws-sdk-lambda/lib/aws-sdk-lambda/client.rb', line 3280 def get_function_configuration(params = {}, = {}) req = build_request(:get_function_configuration, params) req.send_request() end |
#get_function_event_invoke_config(params = {}) ⇒ Types::FunctionEventInvokeConfig
Retrieves the configuration for asynchronous invocation for a function, version, or alias.
To configure options for asynchronous invocation, use PutFunctionEventInvokeConfig.
3365 3366 3367 3368 |
# File 'gems/aws-sdk-lambda/lib/aws-sdk-lambda/client.rb', line 3365 def get_function_event_invoke_config(params = {}, = {}) req = build_request(:get_function_event_invoke_config, params) req.send_request() end |
#get_function_recursion_config(params = {}) ⇒ Types::GetFunctionRecursionConfigResponse
Returns your function's recursive loop detection configuration.
3396 3397 3398 3399 |
# File 'gems/aws-sdk-lambda/lib/aws-sdk-lambda/client.rb', line 3396 def get_function_recursion_config(params = {}, = {}) req = build_request(:get_function_recursion_config, params) req.send_request() end |
#get_function_url_config(params = {}) ⇒ Types::GetFunctionUrlConfigResponse
Returns details about a Lambda function URL.
3461 3462 3463 3464 |
# File 'gems/aws-sdk-lambda/lib/aws-sdk-lambda/client.rb', line 3461 def get_function_url_config(params = {}, = {}) req = build_request(:get_function_url_config, params) req.send_request() end |
#get_layer_version(params = {}) ⇒ Types::GetLayerVersionResponse
Returns information about a version of an Lambda layer, with a link to download the layer archive that's valid for 10 minutes.
3549 3550 3551 3552 |
# File 'gems/aws-sdk-lambda/lib/aws-sdk-lambda/client.rb', line 3549 def get_layer_version(params = {}, = {}) req = build_request(:get_layer_version, params) req.send_request() end |
#get_layer_version_by_arn(params = {}) ⇒ Types::GetLayerVersionResponse
Returns information about a version of an Lambda layer, with a link to download the layer archive that's valid for 10 minutes.
3630 3631 3632 3633 |
# File 'gems/aws-sdk-lambda/lib/aws-sdk-lambda/client.rb', line 3630 def get_layer_version_by_arn(params = {}, = {}) req = build_request(:get_layer_version_by_arn, params) req.send_request() end |
#get_layer_version_policy(params = {}) ⇒ Types::GetLayerVersionPolicyResponse
Returns the permission policy for a version of an Lambda layer. For more information, see AddLayerVersionPermission.
3669 3670 3671 3672 |
# File 'gems/aws-sdk-lambda/lib/aws-sdk-lambda/client.rb', line 3669 def get_layer_version_policy(params = {}, = {}) req = build_request(:get_layer_version_policy, params) req.send_request() end |
#get_policy(params = {}) ⇒ Types::GetPolicyResponse
Returns the resource-based IAM policy for a function, version, or alias.
3738 3739 3740 3741 |
# File 'gems/aws-sdk-lambda/lib/aws-sdk-lambda/client.rb', line 3738 def get_policy(params = {}, = {}) req = build_request(:get_policy, params) req.send_request() end |
#get_provisioned_concurrency_config(params = {}) ⇒ Types::GetProvisionedConcurrencyConfigResponse
Retrieves the provisioned concurrency configuration for a function's alias or version.
3832 3833 3834 3835 |
# File 'gems/aws-sdk-lambda/lib/aws-sdk-lambda/client.rb', line 3832 def get_provisioned_concurrency_config(params = {}, = {}) req = build_request(:get_provisioned_concurrency_config, params) req.send_request() end |
#get_runtime_management_config(params = {}) ⇒ Types::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.
3891 3892 3893 3894 |
# File 'gems/aws-sdk-lambda/lib/aws-sdk-lambda/client.rb', line 3891 def get_runtime_management_config(params = {}, = {}) req = build_request(:get_runtime_management_config, params) req.send_request() end |
#invoke(params = {}) ⇒ Types::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 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.
4070 4071 4072 4073 |
# File 'gems/aws-sdk-lambda/lib/aws-sdk-lambda/client.rb', line 4070 def invoke(params = {}, = {}) req = build_request(:invoke, params) req.send_request() end |
#invoke_async(params = {}) ⇒ Types::InvokeAsyncResponse
For asynchronous function invocation, use Invoke.
Invokes a function asynchronously.
4137 4138 4139 4140 |
# File 'gems/aws-sdk-lambda/lib/aws-sdk-lambda/client.rb', line 4137 def invoke_async(params = {}, = {}) req = build_request(:invoke_async, params) req.send_request() end |
#invoke_with_response_stream(params = {}) ⇒ Types::InvokeWithResponseStreamResponse
Configure your Lambda functions to stream response payloads back to clients. For more information, see Configuring a Lambda function to stream responses.
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.
4332 4333 4334 4335 4336 4337 4338 4339 4340 4341 4342 4343 4344 4345 4346 4347 4348 4349 4350 4351 4352 4353 |
# File 'gems/aws-sdk-lambda/lib/aws-sdk-lambda/client.rb', line 4332 def invoke_with_response_stream(params = {}, = {}, &block) params = params.dup event_stream_handler = case handler = params.delete(:event_stream_handler) when EventStreams::InvokeWithResponseStreamResponseEvent then handler when Proc then EventStreams::InvokeWithResponseStreamResponseEvent.new.tap(&handler) when nil then EventStreams::InvokeWithResponseStreamResponseEvent.new else msg = "expected :event_stream_handler to be a block or "\ "instance of Aws::Lambda::EventStreams::InvokeWithResponseStreamResponseEvent"\ ", got `#{handler.inspect}` instead" raise ArgumentError, msg end yield(event_stream_handler) if block_given? req = build_request(:invoke_with_response_stream, params) req.context[:event_stream_handler] = event_stream_handler req.handlers.add(Aws::Binary::DecodeHandler, priority: 95) req.send_request(, &block) end |
#list_aliases(params = {}) ⇒ Types::ListAliasesResponse
Returns a list of aliases for a Lambda function.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
4453 4454 4455 4456 |
# File 'gems/aws-sdk-lambda/lib/aws-sdk-lambda/client.rb', line 4453 def list_aliases(params = {}, = {}) req = build_request(:list_aliases, params) req.send_request() end |
#list_code_signing_configs(params = {}) ⇒ Types::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.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
4503 4504 4505 4506 |
# File 'gems/aws-sdk-lambda/lib/aws-sdk-lambda/client.rb', line 4503 def list_code_signing_configs(params = {}, = {}) req = build_request(:list_code_signing_configs, params) req.send_request() end |
#list_event_source_mappings(params = {}) ⇒ Types::ListEventSourceMappingsResponse
Lists event source mappings. Specify an EventSourceArn
to show only
event source mappings for a single event source.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
4654 4655 4656 4657 |
# File 'gems/aws-sdk-lambda/lib/aws-sdk-lambda/client.rb', line 4654 def list_event_source_mappings(params = {}, = {}) req = build_request(:list_event_source_mappings, params) req.send_request() end |
#list_function_event_invoke_configs(params = {}) ⇒ Types::ListFunctionEventInvokeConfigsResponse
Retrieves a list of configurations for asynchronous invocation for a function.
To configure options for asynchronous invocation, use PutFunctionEventInvokeConfig.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
4744 4745 4746 4747 |
# File 'gems/aws-sdk-lambda/lib/aws-sdk-lambda/client.rb', line 4744 def list_function_event_invoke_configs(params = {}, = {}) req = build_request(:list_function_event_invoke_configs, params) req.send_request() end |
#list_function_url_configs(params = {}) ⇒ Types::ListFunctionUrlConfigsResponse
Returns a list of Lambda function URLs for the specified function.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
4815 4816 4817 4818 |
# File 'gems/aws-sdk-lambda/lib/aws-sdk-lambda/client.rb', line 4815 def list_function_url_configs(params = {}, = {}) req = build_request(:list_function_url_configs, params) req.send_request() end |
#list_functions(params = {}) ⇒ Types::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.
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.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
5000 5001 5002 5003 |
# File 'gems/aws-sdk-lambda/lib/aws-sdk-lambda/client.rb', line 5000 def list_functions(params = {}, = {}) req = build_request(:list_functions, params) req.send_request() end |
#list_functions_by_code_signing_config(params = {}) ⇒ Types::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.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
5044 5045 5046 5047 |
# File 'gems/aws-sdk-lambda/lib/aws-sdk-lambda/client.rb', line 5044 def list_functions_by_code_signing_config(params = {}, = {}) req = build_request(:list_functions_by_code_signing_config, params) req.send_request() end |
#list_layer_versions(params = {}) ⇒ Types::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.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
5158 5159 5160 5161 |
# File 'gems/aws-sdk-lambda/lib/aws-sdk-lambda/client.rb', line 5158 def list_layer_versions(params = {}, = {}) req = build_request(:list_layer_versions, params) req.send_request() end |
#list_layers(params = {}) ⇒ Types::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.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
5267 5268 5269 5270 |
# File 'gems/aws-sdk-lambda/lib/aws-sdk-lambda/client.rb', line 5267 def list_layers(params = {}, = {}) req = build_request(:list_layers, params) req.send_request() end |
#list_provisioned_concurrency_configs(params = {}) ⇒ Types::ListProvisionedConcurrencyConfigsResponse
Retrieves a list of provisioned concurrency configurations for a function.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
5359 5360 5361 5362 |
# File 'gems/aws-sdk-lambda/lib/aws-sdk-lambda/client.rb', line 5359 def list_provisioned_concurrency_configs(params = {}, = {}) req = build_request(:list_provisioned_concurrency_configs, params) req.send_request() end |
#list_tags(params = {}) ⇒ Types::ListTagsResponse
Returns a function, event source mapping, or code signing configuration's tags. You can also view function tags with GetFunction.
5412 5413 5414 5415 |
# File 'gems/aws-sdk-lambda/lib/aws-sdk-lambda/client.rb', line 5412 def (params = {}, = {}) req = build_request(:list_tags, params) req.send_request() end |
#list_versions_by_function(params = {}) ⇒ Types::ListVersionsByFunctionResponse
Returns a list of versions, with the version-specific configuration of each. Lambda returns up to 50 versions per call.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
5600 5601 5602 5603 |
# File 'gems/aws-sdk-lambda/lib/aws-sdk-lambda/client.rb', line 5600 def list_versions_by_function(params = {}, = {}) req = build_request(:list_versions_by_function, params) req.send_request() end |
#publish_layer_version(params = {}) ⇒ Types::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.
5747 5748 5749 5750 |
# File 'gems/aws-sdk-lambda/lib/aws-sdk-lambda/client.rb', line 5747 def publish_layer_version(params = {}, = {}) req = build_request(:publish_layer_version, params) req.send_request() end |
#publish_version(params = {}) ⇒ Types::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.
5957 5958 5959 5960 |
# File 'gems/aws-sdk-lambda/lib/aws-sdk-lambda/client.rb', line 5957 def publish_version(params = {}, = {}) req = build_request(:publish_version, params) req.send_request() end |
#put_function_code_signing_config(params = {}) ⇒ Types::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.
6005 6006 6007 6008 |
# File 'gems/aws-sdk-lambda/lib/aws-sdk-lambda/client.rb', line 6005 def put_function_code_signing_config(params = {}, = {}) req = build_request(:put_function_code_signing_config, params) req.send_request() end |
#put_function_concurrency(params = {}) ⇒ Types::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.
6081 6082 6083 6084 |
# File 'gems/aws-sdk-lambda/lib/aws-sdk-lambda/client.rb', line 6081 def put_function_concurrency(params = {}, = {}) req = build_request(:put_function_concurrency, params) req.send_request() end |
#put_function_event_invoke_config(params = {}) ⇒ Types::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.
6228 6229 6230 6231 |
# File 'gems/aws-sdk-lambda/lib/aws-sdk-lambda/client.rb', line 6228 def put_function_event_invoke_config(params = {}, = {}) req = build_request(:put_function_event_invoke_config, params) req.send_request() end |
#put_function_recursion_config(params = {}) ⇒ Types::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.
6313 6314 6315 6316 |
# File 'gems/aws-sdk-lambda/lib/aws-sdk-lambda/client.rb', line 6313 def put_function_recursion_config(params = {}, = {}) req = build_request(:put_function_recursion_config, params) req.send_request() end |
#put_provisioned_concurrency_config(params = {}) ⇒ Types::PutProvisionedConcurrencyConfigResponse
Adds a provisioned concurrency configuration to a function's alias or version.
6392 6393 6394 6395 |
# File 'gems/aws-sdk-lambda/lib/aws-sdk-lambda/client.rb', line 6392 def put_provisioned_concurrency_config(params = {}, = {}) req = build_request(:put_provisioned_concurrency_config, params) req.send_request() end |
#put_runtime_management_config(params = {}) ⇒ Types::PutRuntimeManagementConfigResponse
Sets the runtime management configuration for a function's version. For more information, see Runtime updates.