Skip to content

Client

lambda R Documentation

AWS Lambda

Description

Lambda

Overview

Lambda is a compute service that lets you run code without provisioning or managing servers. Lambda runs your code on a high-availability compute infrastructure and performs all of the administration of the compute resources, including server and operating system maintenance, capacity provisioning and automatic scaling, code monitoring and logging. With Lambda, you can run code for virtually any type of application or backend service. For more information about the Lambda service, see What is Lambda in the Lambda Developer Guide.

The Lambda API Reference provides information about each of the API methods, including details about the parameters in each API request and response.

You can use Software Development Kits (SDKs), Integrated Development Environment (IDE) Toolkits, and command line tools to access the API. For installation instructions, see Tools for Amazon Web Services.

For a list of Region-specific endpoints that Lambda supports, see Lambda endpoints and quotas in the Amazon Web Services General Reference..

When making the API calls, you will need to authenticate your request by providing a signature. Lambda supports signature version 4. For more information, see Signature Version 4 signing process in the Amazon Web Services General Reference..

CA certificates

Because Amazon Web Services SDKs use the CA certificates from your computer, changes to the certificates on the Amazon Web Services servers can cause connection failures when you attempt to use an SDK. You can prevent these failures by keeping your computer's CA certificates and operating system up-to-date. If you encounter this issue in a corporate environment and do not manage your own computer, you might need to ask an administrator to assist with the update process. The following list shows minimum operating system and Java versions:

  • Microsoft Windows versions that have updates from January 2005 or later installed contain at least one of the required CAs in their trust list.

  • Mac OS X 10.4 with Java for Mac OS X 10.4 Release 5 (February 2007), Mac OS X 10.5 (October 2007), and later versions contain at least one of the required CAs in their trust list.

  • Red Hat Enterprise Linux 5 (March 2007), 6, and 7 and CentOS 5, 6, and 7 all contain at least one of the required CAs in their default trusted CA list.

  • Java 1.4.2_12 (May 2006), 5 Update 2 (March 2005), and all later versions, including Java 6 (December 2006), 7, and 8, contain at least one of the required CAs in their default trusted CA list.

When accessing the Lambda management console or Lambda API endpoints, whether through browsers or programmatically, you will need to ensure your client machines support any of the following CAs:

  • Amazon Root CA 1

  • Starfield Services Root Certificate Authority - G2

  • Starfield Class 2 Certification Authority

Root certificates from the first two authorities are available from Amazon trust services, but keeping your computer up-to-date is the more straightforward solution. To learn more about ACM-provided certificates, see Amazon Web Services Certificate Manager FAQs.

Usage

lambda(config = list(), credentials = list(), endpoint = NULL, region = NULL)

Arguments

config

Optional configuration of credentials, endpoint, and/or region.

  • credentials:

    • creds:

      • access_key_id: AWS access key ID

      • secret_access_key: AWS secret access key

      • session_token: AWS temporary session token

    • profile: The name of a profile to use. If not given, then the default profile is used.

    • anonymous: Set anonymous credentials.

  • endpoint: The complete URL to use for the constructed client.

  • region: The AWS Region used in instantiating the client.

  • close_connection: Immediately close all HTTP connections.

  • timeout: The time in seconds till a timeout exception is thrown when attempting to make a connection. The default is 60 seconds.

  • s3_force_path_style: Set this to true to force the request to use path-style addressing, i.e. ⁠http://s3.amazonaws.com/BUCKET/KEY⁠.

  • sts_regional_endpoint: Set sts regional endpoint resolver to regional or legacy https://docs.aws.amazon.com/sdkref/latest/guide/feature-sts-regionalized-endpoints.html

credentials

Optional credentials shorthand for the config parameter

  • creds:

    • access_key_id: AWS access key ID

    • secret_access_key: AWS secret access key

    • session_token: AWS temporary session token

  • profile: The name of a profile to use. If not given, then the default profile is used.

  • anonymous: Set anonymous credentials.

endpoint

Optional shorthand for complete URL to use for the constructed client.

region

Optional shorthand for AWS Region used in instantiating the client.

Value

A client for the service. You can call the service's operations using syntax like svc$operation(...), where svc is the name you've assigned to the client. The available operations are listed in the Operations section.

Service syntax

svc <- lambda(
  config = list(
    credentials = list(
      creds = list(
        access_key_id = "string",
        secret_access_key = "string",
        session_token = "string"
      ),
      profile = "string",
      anonymous = "logical"
    ),
    endpoint = "string",
    region = "string",
    close_connection = "logical",
    timeout = "numeric",
    s3_force_path_style = "logical",
    sts_regional_endpoint = "string"
  ),
  credentials = list(
    creds = list(
      access_key_id = "string",
      secret_access_key = "string",
      session_token = "string"
    ),
    profile = "string",
    anonymous = "logical"
  ),
  endpoint = "string",
  region = "string"
)

Operations

add_layer_version_permission
Adds permissions to the resource-based policy of a version of an Lambda layer
add_permission
Grants an Amazon Web Service, Amazon Web Services account, or Amazon Web Services organization permission to use a function
create_alias
Creates an alias for a Lambda function version
create_code_signing_config
Creates a code signing configuration
create_event_source_mapping
Creates a mapping between an event source and an Lambda function
create_function
Creates a Lambda function
create_function_url_config
Creates a Lambda function URL with the specified configuration parameters
delete_alias
Deletes a Lambda function alias
delete_code_signing_config
Deletes the code signing configuration
delete_event_source_mapping
Deletes an event source mapping
delete_function
Deletes a Lambda function
delete_function_code_signing_config
Removes the code signing configuration from the function
delete_function_concurrency
Removes a concurrent execution limit from a function
delete_function_event_invoke_config
Deletes the configuration for asynchronous invocation for a function, version, or alias
delete_function_url_config
Deletes a Lambda function URL
delete_layer_version
Deletes a version of an Lambda layer
delete_provisioned_concurrency_config
Deletes the provisioned concurrency configuration for a function
get_account_settings
Retrieves details about your account's limits and usage in an Amazon Web Services Region
get_alias
Returns details about a Lambda function alias
get_code_signing_config
Returns information about the specified code signing configuration
get_event_source_mapping
Returns details about an event source mapping
get_function
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
Returns the code signing configuration for the specified function
get_function_concurrency
Returns details about the reserved concurrency configuration for a function
get_function_configuration
Returns the version-specific settings of a Lambda function or version
get_function_event_invoke_config
Retrieves the configuration for asynchronous invocation for a function, version, or alias
get_function_url_config
Returns details about a Lambda function URL
get_layer_version
Returns information about a version of an Lambda layer, with a link to download the layer archive that's valid for 10 minutes
get_layer_version_by_arn
Returns information about a version of an Lambda layer, with a link to download the layer archive that's valid for 10 minutes
get_layer_version_policy
Returns the permission policy for a version of an Lambda layer
get_policy
Returns the resource-based IAM policy for a function, version, or alias
get_provisioned_concurrency_config
Retrieves the provisioned concurrency configuration for a function's alias or version
get_runtime_management_config
Retrieves the runtime management configuration for a function's version
invoke
Invokes a Lambda function
invoke_async
For asynchronous function invocation, use Invoke
invoke_with_response_stream
Configure your Lambda functions to stream response payloads back to clients
list_aliases
Returns a list of aliases for a Lambda function
list_code_signing_configs
Returns a list of code signing configurations
list_event_source_mappings
Lists event source mappings
list_function_event_invoke_configs
Retrieves a list of configurations for asynchronous invocation for a function
list_functions
Returns a list of Lambda functions, with the version-specific configuration of each
list_functions_by_code_signing_config
List the functions that use the specified code signing configuration
list_function_url_configs
Returns a list of Lambda function URLs for the specified function
list_layers
Lists Lambda layers and shows information about the latest version of each
list_layer_versions
Lists the versions of an Lambda layer
list_provisioned_concurrency_configs
Retrieves a list of provisioned concurrency configurations for a function
list_tags
Returns a function's tags
list_versions_by_function
Returns a list of versions, with the version-specific configuration of each
publish_layer_version
Creates an Lambda layer from a ZIP archive
publish_version
Creates a version from the current code and configuration of a function
put_function_code_signing_config
Update the code signing configuration for the function
put_function_concurrency
Sets the maximum number of simultaneous executions for a function, and reserves capacity for that concurrency level
put_function_event_invoke_config
Configures options for asynchronous invocation on a function, version, or alias
put_provisioned_concurrency_config
Adds a provisioned concurrency configuration to a function's alias or version
put_runtime_management_config
Sets the runtime management configuration for a function's version
remove_layer_version_permission
Removes a statement from the permissions policy for a version of an Lambda layer
remove_permission
Revokes function-use permission from an Amazon Web Service or another Amazon Web Services account
tag_resource
Adds tags to a function
untag_resource
Removes tags from a function
update_alias
Updates the configuration of a Lambda function alias
update_code_signing_config
Update the code signing configuration
update_event_source_mapping
Updates an event source mapping
update_function_code
Updates a Lambda function's code
update_function_configuration
Modify the version-specific settings of a Lambda function
update_function_event_invoke_config
Updates the configuration for asynchronous invocation for a function, version, or alias
update_function_url_config
Updates the configuration for a Lambda function URL

Examples

## Not run: 
svc <- lambda()
svc$add_layer_version_permission(
  Foo = 123
)

## End(Not run)