@ThreadSafe @Generated(value="com.amazonaws:aws-java-sdk-code-generator") public class AWSLambdaClient extends AmazonWebServiceClient implements AWSLambda
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.
LOGGING_AWS_REQUEST_METRIC
ENDPOINT_PREFIX
Constructor and Description |
---|
AWSLambdaClient()
Deprecated.
|
AWSLambdaClient(AWSCredentials awsCredentials)
Deprecated.
use
AwsClientBuilder.withCredentials(AWSCredentialsProvider) for example:
AWSLambdaClientBuilder.standard().withCredentials(new AWSStaticCredentialsProvider(awsCredentials)).build(); |
AWSLambdaClient(AWSCredentials awsCredentials,
ClientConfiguration clientConfiguration)
|
AWSLambdaClient(AWSCredentialsProvider awsCredentialsProvider)
Deprecated.
|
AWSLambdaClient(AWSCredentialsProvider awsCredentialsProvider,
ClientConfiguration clientConfiguration)
|
AWSLambdaClient(AWSCredentialsProvider awsCredentialsProvider,
ClientConfiguration clientConfiguration,
RequestMetricCollector requestMetricCollector)
|
AWSLambdaClient(ClientConfiguration clientConfiguration)
Deprecated.
|
addRequestHandler, addRequestHandler, configureRegion, getClientConfiguration, getEndpointPrefix, getMonitoringListeners, getRequestMetricsCollector, getServiceName, getSignerByURI, getSignerOverride, getSignerRegionOverride, getTimeOffset, makeImmutable, removeRequestHandler, removeRequestHandler, setEndpoint, setEndpoint, setRegion, setServiceNameIntern, setSignerRegionOverride, setTimeOffset, withEndpoint, withRegion, withRegion, withTimeOffset
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
setEndpoint, setRegion
@Deprecated public AWSLambdaClient()
AWSLambdaClientBuilder.defaultClient()
All service calls made using this new client object are blocking, and will not return until the service call completes.
DefaultAWSCredentialsProviderChain
@Deprecated public AWSLambdaClient(ClientConfiguration clientConfiguration)
AwsClientBuilder.withClientConfiguration(ClientConfiguration)
All service calls made using this new client object are blocking, and will not return until the service call completes.
clientConfiguration
- The client configuration options controlling how this client connects to AWS Lambda (ex: proxy settings,
retry counts, etc.).DefaultAWSCredentialsProviderChain
@Deprecated public AWSLambdaClient(AWSCredentials awsCredentials)
AwsClientBuilder.withCredentials(AWSCredentialsProvider)
for example:
AWSLambdaClientBuilder.standard().withCredentials(new AWSStaticCredentialsProvider(awsCredentials)).build();
All service calls made using this new client object are blocking, and will not return until the service call completes.
awsCredentials
- The AWS credentials (access key ID and secret key) to use when authenticating with AWS services.@Deprecated public AWSLambdaClient(AWSCredentials awsCredentials, ClientConfiguration clientConfiguration)
AwsClientBuilder.withCredentials(AWSCredentialsProvider)
and
AwsClientBuilder.withClientConfiguration(ClientConfiguration)
All service calls made using this new client object are blocking, and will not return until the service call completes.
awsCredentials
- The AWS credentials (access key ID and secret key) to use when authenticating with AWS services.clientConfiguration
- The client configuration options controlling how this client connects to AWS Lambda (ex: proxy settings,
retry counts, etc.).@Deprecated public AWSLambdaClient(AWSCredentialsProvider awsCredentialsProvider)
AwsClientBuilder.withCredentials(AWSCredentialsProvider)
All service calls made using this new client object are blocking, and will not return until the service call completes.
awsCredentialsProvider
- The AWS credentials provider which will provide credentials to authenticate requests with AWS services.@Deprecated public AWSLambdaClient(AWSCredentialsProvider awsCredentialsProvider, ClientConfiguration clientConfiguration)
AwsClientBuilder.withCredentials(AWSCredentialsProvider)
and
AwsClientBuilder.withClientConfiguration(ClientConfiguration)
All service calls made using this new client object are blocking, and will not return until the service call completes.
awsCredentialsProvider
- The AWS credentials provider which will provide credentials to authenticate requests with AWS services.clientConfiguration
- The client configuration options controlling how this client connects to AWS Lambda (ex: proxy settings,
retry counts, etc.).@Deprecated public AWSLambdaClient(AWSCredentialsProvider awsCredentialsProvider, ClientConfiguration clientConfiguration, RequestMetricCollector requestMetricCollector)
AwsClientBuilder.withCredentials(AWSCredentialsProvider)
and
AwsClientBuilder.withClientConfiguration(ClientConfiguration)
and
AwsClientBuilder.withMetricsCollector(RequestMetricCollector)
All service calls made using this new client object are blocking, and will not return until the service call completes.
awsCredentialsProvider
- The AWS credentials provider which will provide credentials to authenticate requests with AWS services.clientConfiguration
- The client configuration options controlling how this client connects to AWS Lambda (ex: proxy settings,
retry counts, etc.).requestMetricCollector
- optional request metric collectorpublic static AWSLambdaClientBuilder builder()
public AddLayerVersionPermissionResult addLayerVersionPermission(AddLayerVersionPermissionRequest request)
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.
addLayerVersionPermission
in interface AWSLambda
addLayerVersionPermissionRequest
- ServiceException
- The Lambda service encountered an internal error.ResourceNotFoundException
- The resource specified in the request does not exist.ResourceConflictException
- The resource already exists, or another operation is in progress.TooManyRequestsException
- The request throughput limit was exceeded. For more information, see Lambda
quotas.InvalidParameterValueException
- One of the parameters in the request is not valid.PolicyLengthExceededException
- The permissions policy for the resource is too large. For more information, see Lambda quotas.PreconditionFailedException
- The RevisionId provided does not match the latest RevisionId for the Lambda function or alias. Call the
GetFunction
or the GetAlias
API operation to retrieve the latest RevisionId for
your resource.public AddPermissionResult addPermission(AddPermissionRequest request)
Grants an Amazon Web Service, Amazon Web Services account, or Amazon Web Services organization 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, the principal is a domain-style identifier that the service defines, such as
s3.amazonaws.com
or sns.amazonaws.com
. For Amazon Web 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.
addPermission
in interface AWSLambda
addPermissionRequest
- ServiceException
- The Lambda service encountered an internal error.ResourceNotFoundException
- The resource specified in the request does not exist.ResourceConflictException
- The resource already exists, or another operation is in progress.InvalidParameterValueException
- One of the parameters in the request is not valid.PolicyLengthExceededException
- The permissions policy for the resource is too large. For more information, see Lambda quotas.TooManyRequestsException
- The request throughput limit was exceeded. For more information, see Lambda
quotas.PreconditionFailedException
- The RevisionId provided does not match the latest RevisionId for the Lambda function or alias. Call the
GetFunction
or the GetAlias
API operation to retrieve the latest RevisionId for
your resource.AWSLambda client = AWSLambdaClientBuilder.standard().build(); AddPermissionRequest request = new AddPermissionRequest().withFunctionName("MyFunction").withStatementId("ID-1").withAction("lambda:InvokeFunction") .withPrincipal("s3.amazonaws.com").withSourceArn("arn:aws:s3:::examplebucket/*").withSourceAccount("123456789012"); AddPermissionResult response = client.addPermission(request);
public CreateAliasResult createAlias(CreateAliasRequest request)
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.
createAlias
in interface AWSLambda
createAliasRequest
- ServiceException
- The Lambda service encountered an internal error.ResourceNotFoundException
- The resource specified in the request does not exist.ResourceConflictException
- The resource already exists, or another operation is in progress.InvalidParameterValueException
- One of the parameters in the request is not valid.TooManyRequestsException
- The request throughput limit was exceeded. For more information, see Lambda
quotas.public CreateCodeSigningConfigResult createCodeSigningConfig(CreateCodeSigningConfigRequest request)
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).
createCodeSigningConfig
in interface AWSLambda
createCodeSigningConfigRequest
- ServiceException
- The Lambda service encountered an internal error.InvalidParameterValueException
- One of the parameters in the request is not valid.public CreateEventSourceMappingResult createEventSourceMapping(CreateEventSourceMappingRequest request)
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 stream sources (DynamoDB and Kinesis):
BisectBatchOnFunctionError
– If the function returns an error, split the batch in two and retry.
DestinationConfig
– Send discarded records to an Amazon SQS queue or Amazon SNS topic.
MaximumRecordAgeInSeconds
– Discard records older than the specified age. 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.
ParallelizationFactor
– Process multiple batches from each shard concurrently.
For information about which configuration parameters apply to each event source, see the following topics.
createEventSourceMapping
in interface AWSLambda
createEventSourceMappingRequest
- ServiceException
- The Lambda service encountered an internal error.InvalidParameterValueException
- One of the parameters in the request is not valid.ResourceConflictException
- The resource already exists, or another operation is in progress.TooManyRequestsException
- The request throughput limit was exceeded. For more information, see Lambda
quotas.ResourceNotFoundException
- The resource specified in the request does not exist.public CreateFunctionResult createFunction(CreateFunctionRequest request)
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, 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 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, create an event source mapping (CreateEventSourceMapping), or configure a function trigger in the other service. For more information, see Invoking Lambda functions.
createFunction
in interface AWSLambda
createFunctionRequest
- ServiceException
- The Lambda service encountered an internal error.InvalidParameterValueException
- One of the parameters in the request is not valid.ResourceNotFoundException
- The resource specified in the request does not exist.ResourceConflictException
- The resource already exists, or another operation is in progress.TooManyRequestsException
- The request throughput limit was exceeded. For more information, see Lambda
quotas.CodeStorageExceededException
- Your Amazon Web Services account has exceeded its maximum total code size. For more information, see Lambda quotas.CodeVerificationFailedException
- The code signature failed one or more of the validation checks for signature mismatch or expiry, and the
code signing policy is set to ENFORCE. Lambda blocks the deployment.InvalidCodeSignatureException
- The code signature failed the integrity check. If the integrity check fails, then Lambda blocks
deployment, even if the code signing policy is set to WARN.CodeSigningConfigNotFoundException
- The specified code signing configuration does not exist.AWSLambda client = AWSLambdaClientBuilder.standard().build(); CreateFunctionRequest request = new CreateFunctionRequest().withFunctionName("MyFunction").withRuntime("nodejs4.3") //replace with the actual arn of the execution role you created .withRole("arn:aws:iam::123456789012:role/service-role/role-name") //is of the form of the name of your source file and then name of your function handler .withHandler("souce_file.handler_name").withCode(new FunctionCode()).withDescription("").withTimeout(15).withMemorySize(128).withPublish(true) .withVpcConfig(new VpcConfig()); CreateFunctionResult response = client.createFunction(request);
public CreateFunctionUrlConfigResult createFunctionUrlConfig(CreateFunctionUrlConfigRequest request)
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.
createFunctionUrlConfig
in interface AWSLambda
createFunctionUrlConfigRequest
- ResourceConflictException
- The resource already exists, or another operation is in progress.ResourceNotFoundException
- The resource specified in the request does not exist.InvalidParameterValueException
- One of the parameters in the request is not valid.ServiceException
- The Lambda service encountered an internal error.TooManyRequestsException
- The request throughput limit was exceeded. For more information, see Lambda
quotas.public DeleteAliasResult deleteAlias(DeleteAliasRequest request)
Deletes a Lambda function alias.
deleteAlias
in interface AWSLambda
deleteAliasRequest
- ServiceException
- The Lambda service encountered an internal error.InvalidParameterValueException
- One of the parameters in the request is not valid.ResourceConflictException
- The resource already exists, or another operation is in progress.TooManyRequestsException
- The request throughput limit was exceeded. For more information, see Lambda
quotas.AWSLambda client = AWSLambdaClientBuilder.standard().build(); DeleteAliasRequest request = new DeleteAliasRequest().withFunctionName("myFunction").withName("alias"); DeleteAliasResult response = client.deleteAlias(request);
public DeleteCodeSigningConfigResult deleteCodeSigningConfig(DeleteCodeSigningConfigRequest request)
Deletes the code signing configuration. You can delete the code signing configuration only if no function is using it.
deleteCodeSigningConfig
in interface AWSLambda
deleteCodeSigningConfigRequest
- ServiceException
- The Lambda service encountered an internal error.InvalidParameterValueException
- One of the parameters in the request is not valid.ResourceNotFoundException
- The resource specified in the request does not exist.ResourceConflictException
- The resource already exists, or another operation is in progress.public DeleteEventSourceMappingResult deleteEventSourceMapping(DeleteEventSourceMappingRequest request)
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.
deleteEventSourceMapping
in interface AWSLambda
deleteEventSourceMappingRequest
- ServiceException
- The Lambda service encountered an internal error.ResourceNotFoundException
- The resource specified in the request does not exist.InvalidParameterValueException
- One of the parameters in the request is not valid.TooManyRequestsException
- The request throughput limit was exceeded. For more information, see Lambda
quotas.ResourceConflictException
- The resource already exists, or another operation is in progress.ResourceInUseException
- The operation conflicts with the resource's availability. For example, you tried to update an event
source mapping in the CREATING state, or you tried to delete an event source mapping currently UPDATING.AWSLambda client = AWSLambdaClientBuilder.standard().build(); DeleteEventSourceMappingRequest request = new DeleteEventSourceMappingRequest().withUUID("12345kxodurf3443"); DeleteEventSourceMappingResult response = client.deleteEventSourceMapping(request);
public DeleteFunctionResult deleteFunction(DeleteFunctionRequest request)
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 and resources that invoke your function directly, delete the trigger in the service where you originally configured it.
deleteFunction
in interface AWSLambda
deleteFunctionRequest
- ServiceException
- The Lambda service encountered an internal error.ResourceNotFoundException
- The resource specified in the request does not exist.TooManyRequestsException
- The request throughput limit was exceeded. For more information, see Lambda
quotas.InvalidParameterValueException
- One of the parameters in the request is not valid.ResourceConflictException
- The resource already exists, or another operation is in progress.AWSLambda client = AWSLambdaClientBuilder.standard().build(); DeleteFunctionRequest request = new DeleteFunctionRequest().withFunctionName("myFunction").withQualifier("1"); DeleteFunctionResult response = client.deleteFunction(request);
public DeleteFunctionCodeSigningConfigResult deleteFunctionCodeSigningConfig(DeleteFunctionCodeSigningConfigRequest request)
Removes the code signing configuration from the function.
deleteFunctionCodeSigningConfig
in interface AWSLambda
deleteFunctionCodeSigningConfigRequest
- InvalidParameterValueException
- One of the parameters in the request is not valid.CodeSigningConfigNotFoundException
- The specified code signing configuration does not exist.ResourceNotFoundException
- The resource specified in the request does not exist.ServiceException
- The Lambda service encountered an internal error.TooManyRequestsException
- The request throughput limit was exceeded. For more information, see Lambda
quotas.ResourceConflictException
- The resource already exists, or another operation is in progress.public DeleteFunctionConcurrencyResult deleteFunctionConcurrency(DeleteFunctionConcurrencyRequest request)
Removes a concurrent execution limit from a function.
deleteFunctionConcurrency
in interface AWSLambda
deleteFunctionConcurrencyRequest
- ServiceException
- The Lambda service encountered an internal error.ResourceNotFoundException
- The resource specified in the request does not exist.TooManyRequestsException
- The request throughput limit was exceeded. For more information, see Lambda
quotas.InvalidParameterValueException
- One of the parameters in the request is not valid.ResourceConflictException
- The resource already exists, or another operation is in progress.public DeleteFunctionEventInvokeConfigResult deleteFunctionEventInvokeConfig(DeleteFunctionEventInvokeConfigRequest request)
Deletes the configuration for asynchronous invocation for a function, version, or alias.
To configure options for asynchronous invocation, use PutFunctionEventInvokeConfig.
deleteFunctionEventInvokeConfig
in interface AWSLambda
deleteFunctionEventInvokeConfigRequest
- ServiceException
- The Lambda service encountered an internal error.ResourceNotFoundException
- The resource specified in the request does not exist.InvalidParameterValueException
- One of the parameters in the request is not valid.TooManyRequestsException
- The request throughput limit was exceeded. For more information, see Lambda
quotas.ResourceConflictException
- The resource already exists, or another operation is in progress.public DeleteFunctionUrlConfigResult deleteFunctionUrlConfig(DeleteFunctionUrlConfigRequest request)
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.
deleteFunctionUrlConfig
in interface AWSLambda
deleteFunctionUrlConfigRequest
- ResourceConflictException
- The resource already exists, or another operation is in progress.ResourceNotFoundException
- The resource specified in the request does not exist.ServiceException
- The Lambda service encountered an internal error.TooManyRequestsException
- The request throughput limit was exceeded. For more information, see Lambda
quotas.public DeleteLayerVersionResult deleteLayerVersion(DeleteLayerVersionRequest request)
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.
deleteLayerVersion
in interface AWSLambda
deleteLayerVersionRequest
- ServiceException
- The Lambda service encountered an internal error.TooManyRequestsException
- The request throughput limit was exceeded. For more information, see Lambda
quotas.public DeleteProvisionedConcurrencyConfigResult deleteProvisionedConcurrencyConfig(DeleteProvisionedConcurrencyConfigRequest request)
Deletes the provisioned concurrency configuration for a function.
deleteProvisionedConcurrencyConfig
in interface AWSLambda
deleteProvisionedConcurrencyConfigRequest
- InvalidParameterValueException
- One of the parameters in the request is not valid.ResourceConflictException
- The resource already exists, or another operation is in progress.ResourceNotFoundException
- The resource specified in the request does not exist.TooManyRequestsException
- The request throughput limit was exceeded. For more information, see Lambda
quotas.ServiceException
- The Lambda service encountered an internal error.public GetAccountSettingsResult getAccountSettings(GetAccountSettingsRequest request)
Retrieves details about your account's limits and usage in an Amazon Web Services Region.
getAccountSettings
in interface AWSLambda
getAccountSettingsRequest
- TooManyRequestsException
- The request throughput limit was exceeded. For more information, see Lambda
quotas.ServiceException
- The Lambda service encountered an internal error.AWSLambda client = AWSLambdaClientBuilder.standard().build(); GetAccountSettingsRequest request = new GetAccountSettingsRequest(); GetAccountSettingsResult response = client.getAccountSettings(request);
public GetAliasResult getAlias(GetAliasRequest request)
Returns details about a Lambda function alias.
getAlias
in interface AWSLambda
getAliasRequest
- ServiceException
- The Lambda service encountered an internal error.ResourceNotFoundException
- The resource specified in the request does not exist.InvalidParameterValueException
- One of the parameters in the request is not valid.TooManyRequestsException
- The request throughput limit was exceeded. For more information, see Lambda
quotas.AWSLambda client = AWSLambdaClientBuilder.standard().build(); GetAliasRequest request = new GetAliasRequest().withFunctionName("myFunction").withName("myFunctionAlias"); GetAliasResult response = client.getAlias(request);
public GetCodeSigningConfigResult getCodeSigningConfig(GetCodeSigningConfigRequest request)
Returns information about the specified code signing configuration.
getCodeSigningConfig
in interface AWSLambda
getCodeSigningConfigRequest
- ServiceException
- The Lambda service encountered an internal error.InvalidParameterValueException
- One of the parameters in the request is not valid.ResourceNotFoundException
- The resource specified in the request does not exist.public GetEventSourceMappingResult getEventSourceMapping(GetEventSourceMappingRequest request)
Returns details about an event source mapping. You can get the identifier of a mapping from the output of ListEventSourceMappings.
getEventSourceMapping
in interface AWSLambda
getEventSourceMappingRequest
- ServiceException
- The Lambda service encountered an internal error.ResourceNotFoundException
- The resource specified in the request does not exist.InvalidParameterValueException
- One of the parameters in the request is not valid.TooManyRequestsException
- The request throughput limit was exceeded. For more information, see Lambda
quotas.AWSLambda client = AWSLambdaClientBuilder.standard().build(); GetEventSourceMappingRequest request = new GetEventSourceMappingRequest().withUUID("123489-xxxxx-kdla8d89d7"); GetEventSourceMappingResult response = client.getEventSourceMapping(request);
public GetFunctionResult getFunction(GetFunctionRequest request)
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.
getFunction
in interface AWSLambda
getFunctionRequest
- ServiceException
- The Lambda service encountered an internal error.ResourceNotFoundException
- The resource specified in the request does not exist.TooManyRequestsException
- The request throughput limit was exceeded. For more information, see Lambda
quotas.InvalidParameterValueException
- One of the parameters in the request is not valid.AWSLambda client = AWSLambdaClientBuilder.standard().build(); GetFunctionRequest request = new GetFunctionRequest().withFunctionName("myFunction").withQualifier("1"); GetFunctionResult response = client.getFunction(request);
public GetFunctionCodeSigningConfigResult getFunctionCodeSigningConfig(GetFunctionCodeSigningConfigRequest request)
Returns the code signing configuration for the specified function.
getFunctionCodeSigningConfig
in interface AWSLambda
getFunctionCodeSigningConfigRequest
- InvalidParameterValueException
- One of the parameters in the request is not valid.ResourceNotFoundException
- The resource specified in the request does not exist.ServiceException
- The Lambda service encountered an internal error.TooManyRequestsException
- The request throughput limit was exceeded. For more information, see Lambda
quotas.public GetFunctionConcurrencyResult getFunctionConcurrency(GetFunctionConcurrencyRequest request)
Returns details about the reserved concurrency configuration for a function. To set a concurrency limit for a function, use PutFunctionConcurrency.
getFunctionConcurrency
in interface AWSLambda
getFunctionConcurrencyRequest
- InvalidParameterValueException
- One of the parameters in the request is not valid.ResourceNotFoundException
- The resource specified in the request does not exist.TooManyRequestsException
- The request throughput limit was exceeded. For more information, see Lambda
quotas.ServiceException
- The Lambda service encountered an internal error.public GetFunctionConfigurationResult getFunctionConfiguration(GetFunctionConfigurationRequest request)
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.
getFunctionConfiguration
in interface AWSLambda
getFunctionConfigurationRequest
- ServiceException
- The Lambda service encountered an internal error.ResourceNotFoundException
- The resource specified in the request does not exist.TooManyRequestsException
- The request throughput limit was exceeded. For more information, see Lambda
quotas.InvalidParameterValueException
- One of the parameters in the request is not valid.AWSLambda client = AWSLambdaClientBuilder.standard().build(); GetFunctionConfigurationRequest request = new GetFunctionConfigurationRequest().withFunctionName("myFunction").withQualifier("1"); GetFunctionConfigurationResult response = client.getFunctionConfiguration(request);
public GetFunctionEventInvokeConfigResult getFunctionEventInvokeConfig(GetFunctionEventInvokeConfigRequest request)
Retrieves the configuration for asynchronous invocation for a function, version, or alias.
To configure options for asynchronous invocation, use PutFunctionEventInvokeConfig.
getFunctionEventInvokeConfig
in interface AWSLambda
getFunctionEventInvokeConfigRequest
- ServiceException
- The Lambda service encountered an internal error.ResourceNotFoundException
- The resource specified in the request does not exist.InvalidParameterValueException
- One of the parameters in the request is not valid.TooManyRequestsException
- The request throughput limit was exceeded. For more information, see Lambda
quotas.public GetFunctionUrlConfigResult getFunctionUrlConfig(GetFunctionUrlConfigRequest request)
Returns details about a Lambda function URL.
getFunctionUrlConfig
in interface AWSLambda
getFunctionUrlConfigRequest
- InvalidParameterValueException
- One of the parameters in the request is not valid.ServiceException
- The Lambda service encountered an internal error.ResourceNotFoundException
- The resource specified in the request does not exist.TooManyRequestsException
- The request throughput limit was exceeded. For more information, see Lambda
quotas.public GetLayerVersionResult getLayerVersion(GetLayerVersionRequest request)
Returns information about a version of an Lambda layer, with a link to download the layer archive that's valid for 10 minutes.
getLayerVersion
in interface AWSLambda
getLayerVersionRequest
- ServiceException
- The Lambda service encountered an internal error.InvalidParameterValueException
- One of the parameters in the request is not valid.TooManyRequestsException
- The request throughput limit was exceeded. For more information, see Lambda
quotas.ResourceNotFoundException
- The resource specified in the request does not exist.public GetLayerVersionByArnResult getLayerVersionByArn(GetLayerVersionByArnRequest request)
Returns information about a version of an Lambda layer, with a link to download the layer archive that's valid for 10 minutes.
getLayerVersionByArn
in interface AWSLambda
getLayerVersionByArnRequest
- ServiceException
- The Lambda service encountered an internal error.InvalidParameterValueException
- One of the parameters in the request is not valid.TooManyRequestsException
- The request throughput limit was exceeded. For more information, see Lambda
quotas.ResourceNotFoundException
- The resource specified in the request does not exist.public GetLayerVersionPolicyResult getLayerVersionPolicy(GetLayerVersionPolicyRequest request)
Returns the permission policy for a version of an Lambda layer. For more information, see AddLayerVersionPermission.
getLayerVersionPolicy
in interface AWSLambda
getLayerVersionPolicyRequest
- ServiceException
- The Lambda service encountered an internal error.ResourceNotFoundException
- The resource specified in the request does not exist.TooManyRequestsException
- The request throughput limit was exceeded. For more information, see Lambda
quotas.InvalidParameterValueException
- One of the parameters in the request is not valid.public GetPolicyResult getPolicy(GetPolicyRequest request)
Returns the resource-based IAM policy for a function, version, or alias.
getPolicy
in interface AWSLambda
getPolicyRequest
- ServiceException
- The Lambda service encountered an internal error.ResourceNotFoundException
- The resource specified in the request does not exist.TooManyRequestsException
- The request throughput limit was exceeded. For more information, see Lambda
quotas.InvalidParameterValueException
- One of the parameters in the request is not valid.AWSLambda client = AWSLambdaClientBuilder.standard().build(); GetPolicyRequest request = new GetPolicyRequest().withFunctionName("myFunction").withQualifier("1"); GetPolicyResult response = client.getPolicy(request);
public GetProvisionedConcurrencyConfigResult getProvisionedConcurrencyConfig(GetProvisionedConcurrencyConfigRequest request)
Retrieves the provisioned concurrency configuration for a function's alias or version.
getProvisionedConcurrencyConfig
in interface AWSLambda
getProvisionedConcurrencyConfigRequest
- InvalidParameterValueException
- One of the parameters in the request is not valid.ResourceNotFoundException
- The resource specified in the request does not exist.TooManyRequestsException
- The request throughput limit was exceeded. For more information, see Lambda
quotas.ServiceException
- The Lambda service encountered an internal error.ProvisionedConcurrencyConfigNotFoundException
- The specified configuration does not exist.public GetRuntimeManagementConfigResult getRuntimeManagementConfig(GetRuntimeManagementConfigRequest request)
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.
getRuntimeManagementConfig
in interface AWSLambda
getRuntimeManagementConfigRequest
- ServiceException
- The Lambda service encountered an internal error.ResourceNotFoundException
- The resource specified in the request does not exist.InvalidParameterValueException
- One of the parameters in the request is not valid.TooManyRequestsException
- The request throughput limit was exceeded. For more information, see Lambda
quotas.public InvokeResult invoke(InvokeRequest request)
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.
invoke
in interface AWSLambda
invokeRequest
- ServiceException
- The Lambda service encountered an internal error.ResourceNotFoundException
- The resource specified in the request does not exist.InvalidRequestContentException
- The request body could not be parsed as JSON.RequestTooLargeException
- The request payload exceeded the Invoke
request body JSON input quota. For more information,
see Lambda quotas.UnsupportedMediaTypeException
- The content type of the Invoke
request body is not JSON.TooManyRequestsException
- The request throughput limit was exceeded. For more information, see Lambda
quotas.InvalidParameterValueException
- One of the parameters in the request is not valid.EC2UnexpectedException
- Lambda received an unexpected Amazon EC2 client exception while setting up for the Lambda function.SubnetIPAddressLimitReachedException
- Lambda couldn't set up VPC access for the Lambda function because one or more configured subnets has no
available IP addresses.ENILimitReachedException
- Lambda couldn't create an elastic network interface in the VPC, specified as part of Lambda function
configuration, because the limit for network interfaces has been reached. For more information, see Lambda quotas.EFSMountConnectivityException
- The Lambda function couldn't make a network connection to the configured file system.EFSMountFailureException
- The Lambda function couldn't mount the configured file system due to a permission or configuration issue.EFSMountTimeoutException
- The Lambda function made a network connection to the configured file system, but the mount operation
timed out.EFSIOException
- An error occurred when reading from or writing to a connected file system.SnapStartException
- The afterRestore()
runtime hook
encountered an error. For more information, check the Amazon CloudWatch logs.SnapStartTimeoutException
- Lambda couldn't restore the snapshot within the timeout limit.SnapStartNotReadyException
- Lambda is initializing your function. You can invoke the function when the function state becomes
Active
.EC2ThrottledException
- Amazon EC2 throttled Lambda during Lambda function initialization using the execution role provided for
the function.EC2AccessDeniedException
- Need additional permissions to configure VPC settings.InvalidSubnetIDException
- The subnet ID provided in the Lambda function VPC configuration is not valid.InvalidSecurityGroupIDException
- The security group ID provided in the Lambda function VPC configuration is not valid.InvalidZipFileException
- Lambda could not unzip the deployment package.KMSDisabledException
- Lambda couldn't decrypt the environment variables because the KMS key used is disabled. Check the Lambda
function's KMS key settings.KMSInvalidStateException
- Lambda couldn't decrypt the environment variables because the state of the KMS key used is not valid for
Decrypt. Check the function's KMS key settings.KMSAccessDeniedException
- Lambda couldn't decrypt the environment variables because KMS access was denied. Check the Lambda
function's KMS permissions.KMSNotFoundException
- Lambda couldn't decrypt the environment variables because the KMS key was not found. Check the function's
KMS key settings.InvalidRuntimeException
- The runtime or runtime version specified is not supported.ResourceConflictException
- The resource already exists, or another operation is in progress.ResourceNotReadyException
- The function is inactive and its VPC connection is no longer available. Wait for the VPC connection to
reestablish and try again.RecursiveInvocationException
- Lambda has detected your function being invoked in a recursive loop with other Amazon Web Services
resources and stopped your function's invocation.AWSLambda client = AWSLambdaClientBuilder.standard().build(); InvokeRequest request = new InvokeRequest().withFunctionName("MyFunction").withInvocationType("Event").withLogType("Tail").withClientContext("MyApp") .withPayload(ByteBuffer.wrap("fileb://file-path/input.json".getBytes())).withQualifier("1"); InvokeResult response = client.invoke(request);
@Deprecated public InvokeAsyncResult invokeAsync(InvokeAsyncRequest request)
For asynchronous function invocation, use Invoke.
Invokes a function asynchronously.
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.
invokeAsync
in interface AWSLambda
invokeAsyncRequest
- ServiceException
- The Lambda service encountered an internal error.ResourceNotFoundException
- The resource specified in the request does not exist.InvalidRequestContentException
- The request body could not be parsed as JSON.InvalidRuntimeException
- The runtime or runtime version specified is not supported.ResourceConflictException
- The resource already exists, or another operation is in progress.public ListAliasesResult listAliases(ListAliasesRequest request)
Returns a list of aliases for a Lambda function.
listAliases
in interface AWSLambda
listAliasesRequest
- ServiceException
- The Lambda service encountered an internal error.ResourceNotFoundException
- The resource specified in the request does not exist.InvalidParameterValueException
- One of the parameters in the request is not valid.TooManyRequestsException
- The request throughput limit was exceeded. For more information, see Lambda
quotas.AWSLambda client = AWSLambdaClientBuilder.standard().build(); ListAliasesRequest request = new ListAliasesRequest().withFunctionName("myFunction").withFunctionVersion("1").withMarker("").withMaxItems(123); ListAliasesResult response = client.listAliases(request);
public ListCodeSigningConfigsResult listCodeSigningConfigs(ListCodeSigningConfigsRequest request)
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.
listCodeSigningConfigs
in interface AWSLambda
listCodeSigningConfigsRequest
- ServiceException
- The Lambda service encountered an internal error.InvalidParameterValueException
- One of the parameters in the request is not valid.public ListEventSourceMappingsResult listEventSourceMappings(ListEventSourceMappingsRequest request)
Lists event source mappings. Specify an EventSourceArn
to show only event source mappings for a
single event source.
listEventSourceMappings
in interface AWSLambda
listEventSourceMappingsRequest
- ServiceException
- The Lambda service encountered an internal error.ResourceNotFoundException
- The resource specified in the request does not exist.InvalidParameterValueException
- One of the parameters in the request is not valid.TooManyRequestsException
- The request throughput limit was exceeded. For more information, see Lambda
quotas.public ListEventSourceMappingsResult listEventSourceMappings()
AWSLambda
listEventSourceMappings
in interface AWSLambda
AWSLambda.listEventSourceMappings(ListEventSourceMappingsRequest)
public ListFunctionEventInvokeConfigsResult listFunctionEventInvokeConfigs(ListFunctionEventInvokeConfigsRequest request)
Retrieves a list of configurations for asynchronous invocation for a function.
To configure options for asynchronous invocation, use PutFunctionEventInvokeConfig.
listFunctionEventInvokeConfigs
in interface AWSLambda
listFunctionEventInvokeConfigsRequest
- InvalidParameterValueException
- One of the parameters in the request is not valid.ResourceNotFoundException
- The resource specified in the request does not exist.TooManyRequestsException
- The request throughput limit was exceeded. For more information, see Lambda
quotas.ServiceException
- The Lambda service encountered an internal error.public ListFunctionUrlConfigsResult listFunctionUrlConfigs(ListFunctionUrlConfigsRequest request)
Returns a list of Lambda function URLs for the specified function.
listFunctionUrlConfigs
in interface AWSLambda
listFunctionUrlConfigsRequest
- InvalidParameterValueException
- One of the parameters in the request is not valid.ServiceException
- The Lambda service encountered an internal error.ResourceNotFoundException
- The resource specified in the request does not exist.TooManyRequestsException
- The request throughput limit was exceeded. For more information, see Lambda
quotas.public ListFunctionsResult listFunctions(ListFunctionsRequest request)
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.
listFunctions
in interface AWSLambda
listFunctionsRequest
- ServiceException
- The Lambda service encountered an internal error.TooManyRequestsException
- The request throughput limit was exceeded. For more information, see Lambda
quotas.InvalidParameterValueException
- One of the parameters in the request is not valid.AWSLambda client = AWSLambdaClientBuilder.standard().build(); ListFunctionsRequest request = new ListFunctionsRequest().withMarker("").withMaxItems(123); ListFunctionsResult response = client.listFunctions(request);
public ListFunctionsResult listFunctions()
AWSLambda
listFunctions
in interface AWSLambda
AWSLambda.listFunctions(ListFunctionsRequest)
public ListFunctionsByCodeSigningConfigResult listFunctionsByCodeSigningConfig(ListFunctionsByCodeSigningConfigRequest request)
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.
listFunctionsByCodeSigningConfig
in interface AWSLambda
listFunctionsByCodeSigningConfigRequest
- ServiceException
- The Lambda service encountered an internal error.InvalidParameterValueException
- One of the parameters in the request is not valid.ResourceNotFoundException
- The resource specified in the request does not exist.public ListLayerVersionsResult listLayerVersions(ListLayerVersionsRequest request)
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.
listLayerVersions
in interface AWSLambda
listLayerVersionsRequest
- ServiceException
- The Lambda service encountered an internal error.InvalidParameterValueException
- One of the parameters in the request is not valid.ResourceNotFoundException
- The resource specified in the request does not exist.TooManyRequestsException
- The request throughput limit was exceeded. For more information, see Lambda
quotas.public ListLayersResult listLayers(ListLayersRequest request)
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.
listLayers
in interface AWSLambda
listLayersRequest
- ServiceException
- The Lambda service encountered an internal error.InvalidParameterValueException
- One of the parameters in the request is not valid.TooManyRequestsException
- The request throughput limit was exceeded. For more information, see Lambda
quotas.public ListProvisionedConcurrencyConfigsResult listProvisionedConcurrencyConfigs(ListProvisionedConcurrencyConfigsRequest request)
Retrieves a list of provisioned concurrency configurations for a function.
listProvisionedConcurrencyConfigs
in interface AWSLambda
listProvisionedConcurrencyConfigsRequest
- InvalidParameterValueException
- One of the parameters in the request is not valid.ResourceNotFoundException
- The resource specified in the request does not exist.TooManyRequestsException
- The request throughput limit was exceeded. For more information, see Lambda
quotas.ServiceException
- The Lambda service encountered an internal error.public ListTagsResult listTags(ListTagsRequest request)
Returns a function's tags. You can also view tags with GetFunction.
listTags
in interface AWSLambda
listTagsRequest
- ServiceException
- The Lambda service encountered an internal error.ResourceNotFoundException
- The resource specified in the request does not exist.InvalidParameterValueException
- One of the parameters in the request is not valid.TooManyRequestsException
- The request throughput limit was exceeded. For more information, see Lambda
quotas.public ListVersionsByFunctionResult listVersionsByFunction(ListVersionsByFunctionRequest request)
Returns a list of versions, with the version-specific configuration of each. Lambda returns up to 50 versions per call.
listVersionsByFunction
in interface AWSLambda
listVersionsByFunctionRequest
- ServiceException
- The Lambda service encountered an internal error.ResourceNotFoundException
- The resource specified in the request does not exist.InvalidParameterValueException
- One of the parameters in the request is not valid.TooManyRequestsException
- The request throughput limit was exceeded. For more information, see Lambda
quotas.AWSLambda client = AWSLambdaClientBuilder.standard().build(); ListVersionsByFunctionRequest request = new ListVersionsByFunctionRequest().withFunctionName("myFunction").withMarker("").withMaxItems(123); ListVersionsByFunctionResult response = client.listVersionsByFunction(request);
public PublishLayerVersionResult publishLayerVersion(PublishLayerVersionRequest request)
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.
publishLayerVersion
in interface AWSLambda
publishLayerVersionRequest
- ServiceException
- The Lambda service encountered an internal error.ResourceNotFoundException
- The resource specified in the request does not exist.TooManyRequestsException
- The request throughput limit was exceeded. For more information, see Lambda
quotas.InvalidParameterValueException
- One of the parameters in the request is not valid.CodeStorageExceededException
- Your Amazon Web Services account has exceeded its maximum total code size. For more information, see Lambda quotas.public PublishVersionResult publishVersion(PublishVersionRequest request)
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.
publishVersion
in interface AWSLambda
publishVersionRequest
- ServiceException
- The Lambda service encountered an internal error.ResourceNotFoundException
- The resource specified in the request does not exist.InvalidParameterValueException
- One of the parameters in the request is not valid.TooManyRequestsException
- The request throughput limit was exceeded. For more information, see Lambda
quotas.CodeStorageExceededException
- Your Amazon Web Services account has exceeded its maximum total code size. For more information, see Lambda quotas.PreconditionFailedException
- The RevisionId provided does not match the latest RevisionId for the Lambda function or alias. Call the
GetFunction
or the GetAlias
API operation to retrieve the latest RevisionId for
your resource.ResourceConflictException
- The resource already exists, or another operation is in progress.AWSLambda client = AWSLambdaClientBuilder.standard().build(); PublishVersionRequest request = new PublishVersionRequest().withFunctionName("myFunction").withCodeSha256("").withDescription(""); PublishVersionResult response = client.publishVersion(request);
public PutFunctionCodeSigningConfigResult putFunctionCodeSigningConfig(PutFunctionCodeSigningConfigRequest request)
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.
putFunctionCodeSigningConfig
in interface AWSLambda
putFunctionCodeSigningConfigRequest
- ServiceException
- The Lambda service encountered an internal error.InvalidParameterValueException
- One of the parameters in the request is not valid.ResourceNotFoundException
- The resource specified in the request does not exist.TooManyRequestsException
- The request throughput limit was exceeded. For more information, see Lambda
quotas.ResourceConflictException
- The resource already exists, or another operation is in progress.CodeSigningConfigNotFoundException
- The specified code signing configuration does not exist.public PutFunctionConcurrencyResult putFunctionConcurrency(PutFunctionConcurrencyRequest request)
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.
putFunctionConcurrency
in interface AWSLambda
putFunctionConcurrencyRequest
- ServiceException
- The Lambda service encountered an internal error.InvalidParameterValueException
- One of the parameters in the request is not valid.ResourceNotFoundException
- The resource specified in the request does not exist.TooManyRequestsException
- The request throughput limit was exceeded. For more information, see Lambda
quotas.ResourceConflictException
- The resource already exists, or another operation is in progress.public PutFunctionEventInvokeConfigResult putFunctionEventInvokeConfig(PutFunctionEventInvokeConfigRequest request)
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, 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.
putFunctionEventInvokeConfig
in interface AWSLambda
putFunctionEventInvokeConfigRequest
- ServiceException
- The Lambda service encountered an internal error.ResourceNotFoundException
- The resource specified in the request does not exist.InvalidParameterValueException
- One of the parameters in the request is not valid.TooManyRequestsException
- The request throughput limit was exceeded. For more information, see Lambda
quotas.ResourceConflictException
- The resource already exists, or another operation is in progress.public PutProvisionedConcurrencyConfigResult putProvisionedConcurrencyConfig(PutProvisionedConcurrencyConfigRequest request)
Adds a provisioned concurrency configuration to a function's alias or version.
putProvisionedConcurrencyConfig
in interface AWSLambda
putProvisionedConcurrencyConfigRequest
- InvalidParameterValueException
- One of the parameters in the request is not valid.ResourceNotFoundException
- The resource specified in the request does not exist.ResourceConflictException
- The resource already exists, or another operation is in progress.TooManyRequestsException
- The request throughput limit was exceeded. For more information, see Lambda
quotas.ServiceException
- The Lambda service encountered an internal error.public PutRuntimeManagementConfigResult putRuntimeManagementConfig(PutRuntimeManagementConfigRequest request)
Sets the runtime management configuration for a function's version. For more information, see Runtime updates.
putRuntimeManagementConfig
in interface AWSLambda
putRuntimeManagementConfigRequest
- ServiceException
- The Lambda service encountered an internal error.ResourceNotFoundException
- The resource specified in the request does not exist.ResourceConflictException
- The resource already exists, or another operation is in progress.InvalidParameterValueException
- One of the parameters in the request is not valid.TooManyRequestsException
- The request throughput limit was exceeded. For more information, see Lambda
quotas.public RemoveLayerVersionPermissionResult removeLayerVersionPermission(RemoveLayerVersionPermissionRequest request)
Removes a statement from the permissions policy for a version of an Lambda layer. For more information, see AddLayerVersionPermission.
removeLayerVersionPermission
in interface AWSLambda
removeLayerVersionPermissionRequest
- ServiceException
- The Lambda service encountered an internal error.ResourceNotFoundException
- The resource specified in the request does not exist.InvalidParameterValueException
- One of the parameters in the request is not valid.TooManyRequestsException
- The request throughput limit was exceeded. For more information, see Lambda
quotas.PreconditionFailedException
- The RevisionId provided does not match the latest RevisionId for the Lambda function or alias. Call the
GetFunction
or the GetAlias
API operation to retrieve the latest RevisionId for
your resource.public RemovePermissionResult removePermission(RemovePermissionRequest request)
Revokes function-use permission from an Amazon Web Service or another Amazon Web Services account. You can get the ID of the statement from the output of GetPolicy.
removePermission
in interface AWSLambda
removePermissionRequest
- ServiceException
- The Lambda service encountered an internal error.ResourceNotFoundException
- The resource specified in the request does not exist.InvalidParameterValueException
- One of the parameters in the request is not valid.TooManyRequestsException
- The request throughput limit was exceeded. For more information, see Lambda
quotas.PreconditionFailedException
- The RevisionId provided does not match the latest RevisionId for the Lambda function or alias. Call the
GetFunction
or the GetAlias
API operation to retrieve the latest RevisionId for
your resource.AWSLambda client = AWSLambdaClientBuilder.standard().build(); RemovePermissionRequest request = new RemovePermissionRequest().withFunctionName("myFunction").withStatementId("role-statement-id").withQualifier("1"); RemovePermissionResult response = client.removePermission(request);
public TagResourceResult tagResource(TagResourceRequest request)
Adds tags to a function.
tagResource
in interface AWSLambda
tagResourceRequest
- ServiceException
- The Lambda service encountered an internal error.ResourceNotFoundException
- The resource specified in the request does not exist.InvalidParameterValueException
- One of the parameters in the request is not valid.TooManyRequestsException
- The request throughput limit was exceeded. For more information, see Lambda
quotas.ResourceConflictException
- The resource already exists, or another operation is in progress.public UntagResourceResult untagResource(UntagResourceRequest request)
Removes tags from a function.
untagResource
in interface AWSLambda
untagResourceRequest
- ServiceException
- The Lambda service encountered an internal error.ResourceNotFoundException
- The resource specified in the request does not exist.InvalidParameterValueException
- One of the parameters in the request is not valid.TooManyRequestsException
- The request throughput limit was exceeded. For more information, see Lambda
quotas.ResourceConflictException
- The resource already exists, or another operation is in progress.public UpdateAliasResult updateAlias(UpdateAliasRequest request)
Updates the configuration of a Lambda function alias.
updateAlias
in interface AWSLambda
updateAliasRequest
- ServiceException
- The Lambda service encountered an internal error.ResourceNotFoundException
- The resource specified in the request does not exist.InvalidParameterValueException
- One of the parameters in the request is not valid.TooManyRequestsException
- The request throughput limit was exceeded. For more information, see Lambda
quotas.PreconditionFailedException
- The RevisionId provided does not match the latest RevisionId for the Lambda function or alias. Call the
GetFunction
or the GetAlias
API operation to retrieve the latest RevisionId for
your resource.ResourceConflictException
- The resource already exists, or another operation is in progress.AWSLambda client = AWSLambdaClientBuilder.standard().build(); UpdateAliasRequest request = new UpdateAliasRequest().withFunctionName("myFunction").withName("functionAlias").withFunctionVersion("1") .withDescription(""); UpdateAliasResult response = client.updateAlias(request);
public UpdateCodeSigningConfigResult updateCodeSigningConfig(UpdateCodeSigningConfigRequest request)
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.
updateCodeSigningConfig
in interface AWSLambda
updateCodeSigningConfigRequest
- ServiceException
- The Lambda service encountered an internal error.InvalidParameterValueException
- One of the parameters in the request is not valid.ResourceNotFoundException
- The resource specified in the request does not exist.public UpdateEventSourceMappingResult updateEventSourceMapping(UpdateEventSourceMappingRequest request)
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 only for stream sources (DynamoDB and Kinesis):
BisectBatchOnFunctionError
– If the function returns an error, split the batch in two and retry.
DestinationConfig
– Send discarded records to an Amazon SQS queue or Amazon SNS topic.
MaximumRecordAgeInSeconds
– Discard records older than the specified age. 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.
ParallelizationFactor
– Process multiple batches from each shard concurrently.
For information about which configuration parameters apply to each event source, see the following topics.
updateEventSourceMapping
in interface AWSLambda
updateEventSourceMappingRequest
- ServiceException
- The Lambda service encountered an internal error.ResourceNotFoundException
- The resource specified in the request does not exist.InvalidParameterValueException
- One of the parameters in the request is not valid.TooManyRequestsException
- The request throughput limit was exceeded. For more information, see Lambda
quotas.ResourceConflictException
- The resource already exists, or another operation is in progress.ResourceInUseException
- The operation conflicts with the resource's availability. For example, you tried to update an event
source mapping in the CREATING state, or you tried to delete an event source mapping currently UPDATING.AWSLambda client = AWSLambdaClientBuilder.standard().build(); UpdateEventSourceMappingRequest request = new UpdateEventSourceMappingRequest().withUUID("1234xCy789012").withFunctionName("myFunction") .withEnabled(true).withBatchSize(123); UpdateEventSourceMappingResult response = client.updateEventSourceMapping(request);
public UpdateFunctionCodeResult updateFunctionCode(UpdateFunctionCodeRequest request)
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.
updateFunctionCode
in interface AWSLambda
updateFunctionCodeRequest
- ServiceException
- The Lambda service encountered an internal error.ResourceNotFoundException
- The resource specified in the request does not exist.InvalidParameterValueException
- One of the parameters in the request is not valid.TooManyRequestsException
- The request throughput limit was exceeded. For more information, see Lambda
quotas.CodeStorageExceededException
- Your Amazon Web Services account has exceeded its maximum total code size. For more information, see Lambda quotas.PreconditionFailedException
- The RevisionId provided does not match the latest RevisionId for the Lambda function or alias. Call the
GetFunction
or the GetAlias
API operation to retrieve the latest RevisionId for
your resource.ResourceConflictException
- The resource already exists, or another operation is in progress.CodeVerificationFailedException
- The code signature failed one or more of the validation checks for signature mismatch or expiry, and the
code signing policy is set to ENFORCE. Lambda blocks the deployment.InvalidCodeSignatureException
- The code signature failed the integrity check. If the integrity check fails, then Lambda blocks
deployment, even if the code signing policy is set to WARN.CodeSigningConfigNotFoundException
- The specified code signing configuration does not exist.AWSLambda client = AWSLambdaClientBuilder.standard().build(); UpdateFunctionCodeRequest request = new UpdateFunctionCodeRequest().withFunctionName("myFunction") .withZipFile(ByteBuffer.wrap("fileb://file-path/file.zip".getBytes())).withS3Bucket("myBucket").withS3Key("myKey").withS3ObjectVersion("1") .withPublish(true); UpdateFunctionCodeResult response = client.updateFunctionCode(request);
public UpdateFunctionConfigurationResult updateFunctionConfiguration(UpdateFunctionConfigurationRequest request)
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 Service, use AddPermission.
updateFunctionConfiguration
in interface AWSLambda
updateFunctionConfigurationRequest
- ServiceException
- The Lambda service encountered an internal error.ResourceNotFoundException
- The resource specified in the request does not exist.InvalidParameterValueException
- One of the parameters in the request is not valid.TooManyRequestsException
- The request throughput limit was exceeded. For more information, see Lambda
quotas.ResourceConflictException
- The resource already exists, or another operation is in progress.PreconditionFailedException
- The RevisionId provided does not match the latest RevisionId for the Lambda function or alias. Call the
GetFunction
or the GetAlias
API operation to retrieve the latest RevisionId for
your resource.CodeVerificationFailedException
- The code signature failed one or more of the validation checks for signature mismatch or expiry, and the
code signing policy is set to ENFORCE. Lambda blocks the deployment.InvalidCodeSignatureException
- The code signature failed the integrity check. If the integrity check fails, then Lambda blocks
deployment, even if the code signing policy is set to WARN.CodeSigningConfigNotFoundException
- The specified code signing configuration does not exist.AWSLambda client = AWSLambdaClientBuilder.standard().build(); UpdateFunctionConfigurationRequest request = new UpdateFunctionConfigurationRequest().withFunctionName("myFunction") .withRole("arn:aws:iam::123456789012:role/lambda_basic_execution").withHandler("index.handler").withDescription("").withTimeout(123) .withMemorySize(128).withVpcConfig(new VpcConfig()).withRuntime("python2.7"); UpdateFunctionConfigurationResult response = client.updateFunctionConfiguration(request);
public UpdateFunctionEventInvokeConfigResult updateFunctionEventInvokeConfig(UpdateFunctionEventInvokeConfigRequest request)
Updates the configuration for asynchronous invocation for a function, version, or alias.
To configure options for asynchronous invocation, use PutFunctionEventInvokeConfig.
updateFunctionEventInvokeConfig
in interface AWSLambda
updateFunctionEventInvokeConfigRequest
- ServiceException
- The Lambda service encountered an internal error.ResourceNotFoundException
- The resource specified in the request does not exist.InvalidParameterValueException
- One of the parameters in the request is not valid.TooManyRequestsException
- The request throughput limit was exceeded. For more information, see Lambda
quotas.ResourceConflictException
- The resource already exists, or another operation is in progress.public UpdateFunctionUrlConfigResult updateFunctionUrlConfig(UpdateFunctionUrlConfigRequest request)
Updates the configuration for a Lambda function URL.
updateFunctionUrlConfig
in interface AWSLambda
updateFunctionUrlConfigRequest
- ResourceConflictException
- The resource already exists, or another operation is in progress.ResourceNotFoundException
- The resource specified in the request does not exist.InvalidParameterValueException
- One of the parameters in the request is not valid.ServiceException
- The Lambda service encountered an internal error.TooManyRequestsException
- The request throughput limit was exceeded. For more information, see Lambda
quotas.public ResponseMetadata getCachedResponseMetadata(AmazonWebServiceRequest request)
Response metadata is only cached for a limited period of time, so if you need to access this extra diagnostic information for an executed request, you should use this method to retrieve it as soon as possible after executing the request.
getCachedResponseMetadata
in interface AWSLambda
request
- The originally executed requestpublic AWSLambdaWaiters waiters()
public void shutdown()
AmazonWebServiceClient
shutdown
in interface AWSLambda
shutdown
in class AmazonWebServiceClient