@Generated(value="com.amazonaws:aws-java-sdk-code-generator") public interface AWSLambda
Note: Do not directly implement this interface, new methods are added to it regularly. Extend from
AbstractAWSLambda
instead.
Overview
This is the AWS Lambda API Reference. The AWS Lambda Developer Guide provides additional information. For the service overview, see What is AWS Lambda, and for information about how the service works, see AWS Lambda: How it Works in the AWS Lambda Developer Guide.
Modifier and Type | Field and Description |
---|---|
static String |
ENDPOINT_PREFIX
The region metadata service name for computing region endpoints.
|
Modifier and Type | Method and Description |
---|---|
AddPermissionResult |
addPermission(AddPermissionRequest addPermissionRequest)
Adds a permission to the resource policy associated with the specified AWS Lambda function.
|
CreateAliasResult |
createAlias(CreateAliasRequest createAliasRequest)
Creates an alias that points to the specified Lambda function version.
|
CreateEventSourceMappingResult |
createEventSourceMapping(CreateEventSourceMappingRequest createEventSourceMappingRequest)
Identifies a poll-based event source for a Lambda function.
|
CreateFunctionResult |
createFunction(CreateFunctionRequest createFunctionRequest)
Creates a new Lambda function.
|
DeleteAliasResult |
deleteAlias(DeleteAliasRequest deleteAliasRequest)
Deletes the specified Lambda function alias.
|
DeleteEventSourceMappingResult |
deleteEventSourceMapping(DeleteEventSourceMappingRequest deleteEventSourceMappingRequest)
Removes an event source mapping.
|
DeleteFunctionResult |
deleteFunction(DeleteFunctionRequest deleteFunctionRequest)
Deletes a Lambda function.
|
DeleteFunctionConcurrencyResult |
deleteFunctionConcurrency(DeleteFunctionConcurrencyRequest deleteFunctionConcurrencyRequest)
Removes concurrent execution limits from this function.
|
GetAccountSettingsResult |
getAccountSettings(GetAccountSettingsRequest getAccountSettingsRequest)
Retrieves details about your account's limits and usage in a region.
|
GetAliasResult |
getAlias(GetAliasRequest getAliasRequest)
Returns the specified alias information such as the alias ARN, description, and function version it is pointing
to.
|
ResponseMetadata |
getCachedResponseMetadata(AmazonWebServiceRequest request)
Returns additional metadata for a previously executed successful request, typically used for debugging issues
where a service isn't acting as expected.
|
GetEventSourceMappingResult |
getEventSourceMapping(GetEventSourceMappingRequest getEventSourceMappingRequest)
Returns configuration information for the specified event source mapping (see CreateEventSourceMapping).
|
GetFunctionResult |
getFunction(GetFunctionRequest getFunctionRequest)
Returns the configuration information of the Lambda function and a presigned URL link to the .zip file you
uploaded with CreateFunction so you can download the .zip file.
|
GetFunctionConfigurationResult |
getFunctionConfiguration(GetFunctionConfigurationRequest getFunctionConfigurationRequest)
Returns the configuration information of the Lambda function.
|
GetPolicyResult |
getPolicy(GetPolicyRequest getPolicyRequest)
Returns the resource policy associated with the specified Lambda function.
|
InvokeResult |
invoke(InvokeRequest invokeRequest)
Invokes a Lambda function.
|
InvokeAsyncResult |
invokeAsync(InvokeAsyncRequest invokeAsyncRequest)
Deprecated.
|
ListAliasesResult |
listAliases(ListAliasesRequest listAliasesRequest)
Returns list of aliases created for a Lambda function.
|
ListEventSourceMappingsResult |
listEventSourceMappings()
Simplified method form for invoking the ListEventSourceMappings operation.
|
ListEventSourceMappingsResult |
listEventSourceMappings(ListEventSourceMappingsRequest listEventSourceMappingsRequest)
Returns a list of event source mappings you created using the
CreateEventSourceMapping (see
CreateEventSourceMapping). |
ListFunctionsResult |
listFunctions()
Simplified method form for invoking the ListFunctions operation.
|
ListFunctionsResult |
listFunctions(ListFunctionsRequest listFunctionsRequest)
Returns a list of your Lambda functions.
|
ListTagsResult |
listTags(ListTagsRequest listTagsRequest)
Returns a list of tags assigned to a function when supplied the function ARN (Amazon Resource Name).
|
ListVersionsByFunctionResult |
listVersionsByFunction(ListVersionsByFunctionRequest listVersionsByFunctionRequest)
Lists all versions of a function.
|
PublishVersionResult |
publishVersion(PublishVersionRequest publishVersionRequest)
Publishes a version of your function from the current snapshot of $LATEST.
|
PutFunctionConcurrencyResult |
putFunctionConcurrency(PutFunctionConcurrencyRequest putFunctionConcurrencyRequest)
Sets a limit on the number of concurrent executions available to this function.
|
RemovePermissionResult |
removePermission(RemovePermissionRequest removePermissionRequest)
Removes permissions from a function.
|
void |
setEndpoint(String endpoint)
Deprecated.
use
AwsClientBuilder#setEndpointConfiguration(AwsClientBuilder.EndpointConfiguration) for
example:
builder.setEndpointConfiguration(new EndpointConfiguration(endpoint, signingRegion)); |
void |
setRegion(Region region)
Deprecated.
use
AwsClientBuilder#setRegion(String) |
void |
shutdown()
Shuts down this client object, releasing any resources that might be held open.
|
TagResourceResult |
tagResource(TagResourceRequest tagResourceRequest)
Creates a list of tags (key-value pairs) on the Lambda function.
|
UntagResourceResult |
untagResource(UntagResourceRequest untagResourceRequest)
Removes tags from a Lambda function.
|
UpdateAliasResult |
updateAlias(UpdateAliasRequest updateAliasRequest)
Using this API you can update the function version to which the alias points and the alias description.
|
UpdateEventSourceMappingResult |
updateEventSourceMapping(UpdateEventSourceMappingRequest updateEventSourceMappingRequest)
You can update an event source mapping.
|
UpdateFunctionCodeResult |
updateFunctionCode(UpdateFunctionCodeRequest updateFunctionCodeRequest)
Updates the code for the specified Lambda function.
|
UpdateFunctionConfigurationResult |
updateFunctionConfiguration(UpdateFunctionConfigurationRequest updateFunctionConfigurationRequest)
Updates the configuration parameters for the specified Lambda function by using the values provided in the
request.
|
static final String ENDPOINT_PREFIX
@Deprecated void setEndpoint(String endpoint)
AwsClientBuilder#setEndpointConfiguration(AwsClientBuilder.EndpointConfiguration)
for
example:
builder.setEndpointConfiguration(new EndpointConfiguration(endpoint, signingRegion));
Callers can pass in just the endpoint (ex: "lambda.us-east-1.amazonaws.com") or a full URL, including the
protocol (ex: "lambda.us-east-1.amazonaws.com"). If the protocol is not specified here, the default protocol from
this client's ClientConfiguration
will be used, which by default is HTTPS.
For more information on using AWS regions with the AWS SDK for Java, and a complete list of all available endpoints for all AWS services, see: https://docs.aws.amazon.com/sdk-for-java/v1/developer-guide/java-dg-region-selection.html#region-selection- choose-endpoint
This method is not threadsafe. An endpoint should be configured when the client is created and before any service requests are made. Changing it afterwards creates inevitable race conditions for any service requests in transit or retrying.
endpoint
- The endpoint (ex: "lambda.us-east-1.amazonaws.com") or a full URL, including the protocol (ex:
"lambda.us-east-1.amazonaws.com") of the region specific AWS endpoint this client will communicate with.@Deprecated void setRegion(Region region)
AwsClientBuilder#setRegion(String)
setEndpoint(String)
, sets the regional endpoint for this client's service
calls. Callers can use this method to control which AWS region they want to work with.
By default, all service endpoints in all regions use the https protocol. To use http instead, specify it in the
ClientConfiguration
supplied at construction.
This method is not threadsafe. A region should be configured when the client is created and before any service requests are made. Changing it afterwards creates inevitable race conditions for any service requests in transit or retrying.
region
- The region this client will communicate with. See Region.getRegion(com.amazonaws.regions.Regions)
for accessing a given region. Must not be null and must be a region where the service is available.Region.getRegion(com.amazonaws.regions.Regions)
,
Region.createClient(Class, com.amazonaws.auth.AWSCredentialsProvider, ClientConfiguration)
,
Region.isServiceSupported(String)
AddPermissionResult addPermission(AddPermissionRequest addPermissionRequest)
Adds a permission to the resource policy associated with the specified AWS Lambda function. You use resource policies to grant permissions to event sources that use the push model. In a push model, event sources (such as Amazon S3 and custom applications) invoke your Lambda function. Each permission you add to the resource policy allows an event source permission to invoke the Lambda function.
Permissions apply to the Amazon Resource Name (ARN) used to invoke the function, which can be unqualified (the
unpublished version of the function), or include a version or alias. If a client uses a version or alias to
invoke a function, use the Qualifier
parameter to apply permissions to that ARN. For more
information about versioning, see AWS Lambda Function Versioning and
Aliases.
This operation requires permission for the lambda:AddPermission
action.
addPermissionRequest
- ServiceException
- The AWS Lambda service encountered an internal error.ResourceNotFoundException
- The resource (for example, a Lambda function or access policy statement) specified in the request does
not exist.ResourceConflictException
- The resource already exists.InvalidParameterValueException
- One of the parameters in the request is invalid. For example, if you provided an IAM role for AWS Lambda
to assume in the CreateFunction
or the UpdateFunctionConfiguration
API, that
AWS Lambda is unable to assume you will get this exception.PolicyLengthExceededException
- Lambda function access policy is limited to 20 KB.TooManyRequestsException
- Request throughput limit exceededPreconditionFailedException
- The RevisionId provided does not match the latest RevisionId for the Lambda function or alias. Call the
GetFunction
or the GetAlias
API to retrieve the latest RevisionId for your
resource.CreateAliasResult createAlias(CreateAliasRequest createAliasRequest)
Creates an alias that points to the specified Lambda function version. For more information, see Introduction to AWS Lambda Aliases.
Alias names are unique for a given function. This requires permission for the lambda:CreateAlias action.
createAliasRequest
- ServiceException
- The AWS Lambda service encountered an internal error.ResourceNotFoundException
- The resource (for example, a Lambda function or access policy statement) specified in the request does
not exist.ResourceConflictException
- The resource already exists.InvalidParameterValueException
- One of the parameters in the request is invalid. For example, if you provided an IAM role for AWS Lambda
to assume in the CreateFunction
or the UpdateFunctionConfiguration
API, that
AWS Lambda is unable to assume you will get this exception.TooManyRequestsException
- Request throughput limit exceededCreateEventSourceMappingResult createEventSourceMapping(CreateEventSourceMappingRequest createEventSourceMappingRequest)
Identifies a poll-based event source for a Lambda function. It can be either an Amazon Kinesis or DynamoDB stream. AWS Lambda invokes the specified function when records are posted to the event source.
This association between a poll-based source and a Lambda function is called the event source mapping.
You provide mapping information (for example, which stream or SQS queue to read from and which Lambda function to invoke) in the request body.
Amazon Kinesis or DynamoDB stream event sources can be associated with multiple AWS Lambda functions and a given Lambda function can be associated with multiple AWS event sources. For Amazon SQS, you can configure multiple queues as event sources for a single Lambda function, but an SQS queue can be mapped only to a single Lambda function.
You can configure an SQS queue in an account separate from your Lambda function's account. Also the queue needs to reside in the same AWS region as your function.
If you are using versioning, you can specify a specific function version or an alias via the function name parameter. For more information about versioning, see AWS Lambda Function Versioning and Aliases.
This operation requires permission for the lambda:CreateEventSourceMapping
action.
createEventSourceMappingRequest
- ServiceException
- The AWS Lambda service encountered an internal error.InvalidParameterValueException
- One of the parameters in the request is invalid. For example, if you provided an IAM role for AWS Lambda
to assume in the CreateFunction
or the UpdateFunctionConfiguration
API, that
AWS Lambda is unable to assume you will get this exception.ResourceConflictException
- The resource already exists.TooManyRequestsException
- Request throughput limit exceededResourceNotFoundException
- The resource (for example, a Lambda function or access policy statement) specified in the request does
not exist.CreateFunctionResult createFunction(CreateFunctionRequest createFunctionRequest)
Creates a new Lambda function. The function configuration is created from the request parameters, and the code for the function is provided by a .zip file. The function name is case-sensitive.
This operation requires permission for the lambda:CreateFunction
action.
createFunctionRequest
- ServiceException
- The AWS Lambda service encountered an internal error.InvalidParameterValueException
- One of the parameters in the request is invalid. For example, if you provided an IAM role for AWS Lambda
to assume in the CreateFunction
or the UpdateFunctionConfiguration
API, that
AWS Lambda is unable to assume you will get this exception.ResourceNotFoundException
- The resource (for example, a Lambda function or access policy statement) specified in the request does
not exist.ResourceConflictException
- The resource already exists.TooManyRequestsException
- Request throughput limit exceededCodeStorageExceededException
- You have exceeded your maximum total code size per account. LimitsDeleteAliasResult deleteAlias(DeleteAliasRequest deleteAliasRequest)
Deletes the specified Lambda function alias. For more information, see Introduction to AWS Lambda Aliases.
This requires permission for the lambda:DeleteAlias action.
deleteAliasRequest
- ServiceException
- The AWS Lambda service encountered an internal error.InvalidParameterValueException
- One of the parameters in the request is invalid. For example, if you provided an IAM role for AWS Lambda
to assume in the CreateFunction
or the UpdateFunctionConfiguration
API, that
AWS Lambda is unable to assume you will get this exception.TooManyRequestsException
- Request throughput limit exceededDeleteEventSourceMappingResult deleteEventSourceMapping(DeleteEventSourceMappingRequest deleteEventSourceMappingRequest)
Removes an event source mapping. This means AWS Lambda will no longer invoke the function for events in the associated source.
This operation requires permission for the lambda:DeleteEventSourceMapping
action.
deleteEventSourceMappingRequest
- ServiceException
- The AWS Lambda service encountered an internal error.ResourceNotFoundException
- The resource (for example, a Lambda function or access policy statement) specified in the request does
not exist.InvalidParameterValueException
- One of the parameters in the request is invalid. For example, if you provided an IAM role for AWS Lambda
to assume in the CreateFunction
or the UpdateFunctionConfiguration
API, that
AWS Lambda is unable to assume you will get this exception.TooManyRequestsException
- Request throughput limit exceededResourceInUseException
- The operation conflicts with the resource's availability. For example, you attempted to update an
EventSoure Mapping in CREATING, or tried to delete a EventSoure mapping currently in the UPDATING state.DeleteFunctionResult deleteFunction(DeleteFunctionRequest deleteFunctionRequest)
Deletes a Lambda function. To delete a specific function version, use the Qualifier
parameter.
Otherwise, all versions and aliases are deleted. Event source mappings are not deleted.
This operation requires permission for the lambda:DeleteFunction
action.
deleteFunctionRequest
- ServiceException
- The AWS Lambda service encountered an internal error.ResourceNotFoundException
- The resource (for example, a Lambda function or access policy statement) specified in the request does
not exist.TooManyRequestsException
- Request throughput limit exceededInvalidParameterValueException
- One of the parameters in the request is invalid. For example, if you provided an IAM role for AWS Lambda
to assume in the CreateFunction
or the UpdateFunctionConfiguration
API, that
AWS Lambda is unable to assume you will get this exception.ResourceConflictException
- The resource already exists.DeleteFunctionConcurrencyResult deleteFunctionConcurrency(DeleteFunctionConcurrencyRequest deleteFunctionConcurrencyRequest)
Removes concurrent execution limits from this function. For more information, see Managing Concurrency.
deleteFunctionConcurrencyRequest
- ServiceException
- The AWS Lambda service encountered an internal error.ResourceNotFoundException
- The resource (for example, a Lambda function or access policy statement) specified in the request does
not exist.TooManyRequestsException
- Request throughput limit exceededInvalidParameterValueException
- One of the parameters in the request is invalid. For example, if you provided an IAM role for AWS Lambda
to assume in the CreateFunction
or the UpdateFunctionConfiguration
API, that
AWS Lambda is unable to assume you will get this exception.GetAccountSettingsResult getAccountSettings(GetAccountSettingsRequest getAccountSettingsRequest)
Retrieves details about your account's limits and usage in a region.
getAccountSettingsRequest
- TooManyRequestsException
- Request throughput limit exceededServiceException
- The AWS Lambda service encountered an internal error.GetAliasResult getAlias(GetAliasRequest getAliasRequest)
Returns the specified alias information such as the alias ARN, description, and function version it is pointing to. For more information, see Introduction to AWS Lambda Aliases.
This requires permission for the lambda:GetAlias
action.
getAliasRequest
- ServiceException
- The AWS Lambda service encountered an internal error.ResourceNotFoundException
- The resource (for example, a Lambda function or access policy statement) specified in the request does
not exist.InvalidParameterValueException
- One of the parameters in the request is invalid. For example, if you provided an IAM role for AWS Lambda
to assume in the CreateFunction
or the UpdateFunctionConfiguration
API, that
AWS Lambda is unable to assume you will get this exception.TooManyRequestsException
- Request throughput limit exceededGetEventSourceMappingResult getEventSourceMapping(GetEventSourceMappingRequest getEventSourceMappingRequest)
Returns configuration information for the specified event source mapping (see CreateEventSourceMapping).
This operation requires permission for the lambda:GetEventSourceMapping
action.
getEventSourceMappingRequest
- ServiceException
- The AWS Lambda service encountered an internal error.ResourceNotFoundException
- The resource (for example, a Lambda function or access policy statement) specified in the request does
not exist.InvalidParameterValueException
- One of the parameters in the request is invalid. For example, if you provided an IAM role for AWS Lambda
to assume in the CreateFunction
or the UpdateFunctionConfiguration
API, that
AWS Lambda is unable to assume you will get this exception.TooManyRequestsException
- Request throughput limit exceededGetFunctionResult getFunction(GetFunctionRequest getFunctionRequest)
Returns the configuration information of the Lambda function and a presigned URL link to the .zip file you uploaded with CreateFunction so you can download the .zip file. Note that the URL is valid for up to 10 minutes. The configuration information is the same information you provided as parameters when uploading the function.
Use the Qualifier
parameter to retrieve a published version of the function. Otherwise, returns the
unpublished version ($LATEST
). For more information, see AWS Lambda Function Versioning and
Aliases.
This operation requires permission for the lambda:GetFunction
action.
getFunctionRequest
- ServiceException
- The AWS Lambda service encountered an internal error.ResourceNotFoundException
- The resource (for example, a Lambda function or access policy statement) specified in the request does
not exist.TooManyRequestsException
- Request throughput limit exceededInvalidParameterValueException
- One of the parameters in the request is invalid. For example, if you provided an IAM role for AWS Lambda
to assume in the CreateFunction
or the UpdateFunctionConfiguration
API, that
AWS Lambda is unable to assume you will get this exception.GetFunctionConfigurationResult getFunctionConfiguration(GetFunctionConfigurationRequest getFunctionConfigurationRequest)
Returns the configuration information of the Lambda function. This the same information you provided as parameters when uploading the function by using CreateFunction.
If you are using the versioning feature, you can retrieve this information for a specific function version by
using the optional Qualifier
parameter and specifying the function version or alias that points to
it. If you don't provide it, the API returns information about the $LATEST version of the function. For more
information about versioning, see AWS Lambda Function Versioning and
Aliases.
This operation requires permission for the lambda:GetFunctionConfiguration
operation.
getFunctionConfigurationRequest
- ServiceException
- The AWS Lambda service encountered an internal error.ResourceNotFoundException
- The resource (for example, a Lambda function or access policy statement) specified in the request does
not exist.TooManyRequestsException
- Request throughput limit exceededInvalidParameterValueException
- One of the parameters in the request is invalid. For example, if you provided an IAM role for AWS Lambda
to assume in the CreateFunction
or the UpdateFunctionConfiguration
API, that
AWS Lambda is unable to assume you will get this exception.GetPolicyResult getPolicy(GetPolicyRequest getPolicyRequest)
Returns the resource policy associated with the specified Lambda function.
This action requires permission for the lambda:GetPolicy action.
getPolicyRequest
- ServiceException
- The AWS Lambda service encountered an internal error.ResourceNotFoundException
- The resource (for example, a Lambda function or access policy statement) specified in the request does
not exist.TooManyRequestsException
- Request throughput limit exceededInvalidParameterValueException
- One of the parameters in the request is invalid. For example, if you provided an IAM role for AWS Lambda
to assume in the CreateFunction
or the UpdateFunctionConfiguration
API, that
AWS Lambda is unable to assume you will get this exception.InvokeResult invoke(InvokeRequest invokeRequest)
Invokes a Lambda function. For an example, see Create the Lambda Function and Test It Manually.
Specify just a function name to invoke the latest version of the function. To invoke a published version, use the
Qualifier
parameter to specify a version or alias.
If you use the RequestResponse
(synchronous) invocation option, the function will be invoked only
once. If you use the Event
(asynchronous) invocation option, the function will be invoked at least
once in response to an event and the function must be idempotent to handle this.
For functions with a long timeout, your client may be disconnected during synchronous invocation while it waits for a response. Configure your HTTP client, SDK, firewall, proxy, or operating system to allow for long connections with timeout or keep-alive settings.
This operation requires permission for the lambda:InvokeFunction
action.
The TooManyRequestsException
noted below will return the following:
ConcurrentInvocationLimitExceeded
will be returned if you have no functions with reserved
concurrency and have exceeded your account concurrent limit or if a function without reserved concurrency exceeds
the account's unreserved concurrency limit. ReservedFunctionConcurrentInvocationLimitExceeded
will
be returned when a function with reserved concurrency exceeds its configured concurrency limit.
invokeRequest
- ServiceException
- The AWS Lambda service encountered an internal error.ResourceNotFoundException
- The resource (for example, a Lambda function or access policy statement) 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 limit. For more information,
see Limits.UnsupportedMediaTypeException
- The content type of the Invoke
request body is not JSON.TooManyRequestsException
- Request throughput limit exceededInvalidParameterValueException
- One of the parameters in the request is invalid. For example, if you provided an IAM role for AWS Lambda
to assume in the CreateFunction
or the UpdateFunctionConfiguration
API, that
AWS Lambda is unable to assume you will get this exception.EC2UnexpectedException
- AWS Lambda received an unexpected EC2 client exception while setting up for the Lambda function.SubnetIPAddressLimitReachedException
- AWS Lambda was not able to set up VPC access for the Lambda function because one or more configured
subnets has no available IP addresses.ENILimitReachedException
- AWS Lambda was not able to create an Elastic Network Interface (ENI) in the VPC, specified as part of
Lambda function configuration, because the limit for network interfaces has been reached.EC2ThrottledException
- AWS Lambda was throttled by Amazon EC2 during Lambda function initialization using the execution role
provided for the Lambda function.EC2AccessDeniedException
- Need additional permissions to configure VPC settings.InvalidSubnetIDException
- The Subnet ID provided in the Lambda function VPC configuration is invalid.InvalidSecurityGroupIDException
- The Security Group ID provided in the Lambda function VPC configuration is invalid.InvalidZipFileException
- AWS Lambda could not unzip the deployment package.KMSDisabledException
- Lambda was unable to decrypt the environment variables because the KMS key used is disabled. Check the
Lambda function's KMS key settings.KMSInvalidStateException
- Lambda was unable to decrypt the environment variables because the KMS key used is in an invalid state
for Decrypt. Check the function's KMS key settings.KMSAccessDeniedException
- Lambda was unable to decrypt the environment variables because KMS access was denied. Check the Lambda
function's KMS permissions.KMSNotFoundException
- Lambda was unable to 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.@Deprecated InvokeAsyncResult invokeAsync(InvokeAsyncRequest invokeAsyncRequest)
For asynchronous function invocation, use Invoke.
Submits an invocation request to AWS Lambda. Upon receiving the request, Lambda executes the specified function asynchronously. To see the logs generated by the Lambda function execution, see the CloudWatch Logs console.
This operation requires permission for the lambda:InvokeFunction
action.
invokeAsyncRequest
- ServiceException
- The AWS Lambda service encountered an internal error.ResourceNotFoundException
- The resource (for example, a Lambda function or access policy statement) 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.ListAliasesResult listAliases(ListAliasesRequest listAliasesRequest)
Returns list of aliases created for a Lambda function. For each alias, the response includes information such as the alias ARN, description, alias name, and the function version to which it points. For more information, see Introduction to AWS Lambda Aliases.
This requires permission for the lambda:ListAliases action.
listAliasesRequest
- ServiceException
- The AWS Lambda service encountered an internal error.ResourceNotFoundException
- The resource (for example, a Lambda function or access policy statement) specified in the request does
not exist.InvalidParameterValueException
- One of the parameters in the request is invalid. For example, if you provided an IAM role for AWS Lambda
to assume in the CreateFunction
or the UpdateFunctionConfiguration
API, that
AWS Lambda is unable to assume you will get this exception.TooManyRequestsException
- Request throughput limit exceededListEventSourceMappingsResult listEventSourceMappings(ListEventSourceMappingsRequest listEventSourceMappingsRequest)
Returns a list of event source mappings you created using the CreateEventSourceMapping
(see
CreateEventSourceMapping).
For each mapping, the API returns configuration information. You can optionally specify filters to retrieve specific event source mappings.
This operation requires permission for the lambda:ListEventSourceMappings
action.
listEventSourceMappingsRequest
- ServiceException
- The AWS Lambda service encountered an internal error.ResourceNotFoundException
- The resource (for example, a Lambda function or access policy statement) specified in the request does
not exist.InvalidParameterValueException
- One of the parameters in the request is invalid. For example, if you provided an IAM role for AWS Lambda
to assume in the CreateFunction
or the UpdateFunctionConfiguration
API, that
AWS Lambda is unable to assume you will get this exception.TooManyRequestsException
- Request throughput limit exceededListEventSourceMappingsResult listEventSourceMappings()
ListFunctionsResult listFunctions(ListFunctionsRequest listFunctionsRequest)
Returns a list of your Lambda functions. For each function, the response includes the function configuration information. You must use GetFunction to retrieve the code for your function.
This operation requires permission for the lambda:ListFunctions
action.
If you are using the versioning feature, you can list all of your functions or only $LATEST
versions. For information about the versioning feature, see AWS Lambda Function Versioning and
Aliases.
listFunctionsRequest
- ServiceException
- The AWS Lambda service encountered an internal error.TooManyRequestsException
- Request throughput limit exceededInvalidParameterValueException
- One of the parameters in the request is invalid. For example, if you provided an IAM role for AWS Lambda
to assume in the CreateFunction
or the UpdateFunctionConfiguration
API, that
AWS Lambda is unable to assume you will get this exception.ListFunctionsResult listFunctions()
listFunctions(ListFunctionsRequest)
ListTagsResult listTags(ListTagsRequest listTagsRequest)
Returns a list of tags assigned to a function when supplied the function ARN (Amazon Resource Name). For more information on Tagging, see Tagging Lambda Functions in the AWS Lambda Developer Guide.
listTagsRequest
- ServiceException
- The AWS Lambda service encountered an internal error.ResourceNotFoundException
- The resource (for example, a Lambda function or access policy statement) specified in the request does
not exist.InvalidParameterValueException
- One of the parameters in the request is invalid. For example, if you provided an IAM role for AWS Lambda
to assume in the CreateFunction
or the UpdateFunctionConfiguration
API, that
AWS Lambda is unable to assume you will get this exception.TooManyRequestsException
- Request throughput limit exceededListVersionsByFunctionResult listVersionsByFunction(ListVersionsByFunctionRequest listVersionsByFunctionRequest)
Lists all versions of a function. For information about versioning, see AWS Lambda Function Versioning and Aliases.
listVersionsByFunctionRequest
- ServiceException
- The AWS Lambda service encountered an internal error.ResourceNotFoundException
- The resource (for example, a Lambda function or access policy statement) specified in the request does
not exist.InvalidParameterValueException
- One of the parameters in the request is invalid. For example, if you provided an IAM role for AWS Lambda
to assume in the CreateFunction
or the UpdateFunctionConfiguration
API, that
AWS Lambda is unable to assume you will get this exception.TooManyRequestsException
- Request throughput limit exceededPublishVersionResult publishVersion(PublishVersionRequest publishVersionRequest)
Publishes a version of your function from the current snapshot of $LATEST. That is, AWS Lambda takes a snapshot of the function code and configuration information from $LATEST and publishes a new version. The code and configuration cannot be modified after publication. For information about the versioning feature, see AWS Lambda Function Versioning and Aliases.
publishVersionRequest
- ServiceException
- The AWS Lambda service encountered an internal error.ResourceNotFoundException
- The resource (for example, a Lambda function or access policy statement) specified in the request does
not exist.InvalidParameterValueException
- One of the parameters in the request is invalid. For example, if you provided an IAM role for AWS Lambda
to assume in the CreateFunction
or the UpdateFunctionConfiguration
API, that
AWS Lambda is unable to assume you will get this exception.TooManyRequestsException
- Request throughput limit exceededCodeStorageExceededException
- You have exceeded your maximum total code size per account. LimitsPreconditionFailedException
- The RevisionId provided does not match the latest RevisionId for the Lambda function or alias. Call the
GetFunction
or the GetAlias
API to retrieve the latest RevisionId for your
resource.PutFunctionConcurrencyResult putFunctionConcurrency(PutFunctionConcurrencyRequest putFunctionConcurrencyRequest)
Sets a limit on the number of concurrent executions available to this function. It is a subset of your account's total concurrent execution limit per region. Note that Lambda automatically reserves a buffer of 100 concurrent executions for functions without any reserved concurrency limit. This means if your account limit is 1000, you have a total of 900 available to allocate to individual functions. For more information, see Managing Concurrency.
putFunctionConcurrencyRequest
- ServiceException
- The AWS Lambda service encountered an internal error.InvalidParameterValueException
- One of the parameters in the request is invalid. For example, if you provided an IAM role for AWS Lambda
to assume in the CreateFunction
or the UpdateFunctionConfiguration
API, that
AWS Lambda is unable to assume you will get this exception.ResourceNotFoundException
- The resource (for example, a Lambda function or access policy statement) specified in the request does
not exist.TooManyRequestsException
- Request throughput limit exceededRemovePermissionResult removePermission(RemovePermissionRequest removePermissionRequest)
Removes permissions from a function. You can remove individual permissions from an resource policy associated with a Lambda function by providing a statement ID that you provided when you added the permission. When you remove permissions, disable the event source mapping or trigger configuration first to avoid errors.
Permissions apply to the Amazon Resource Name (ARN) used to invoke the function, which can be unqualified (the
unpublished version of the function), or include a version or alias. If a client uses a version or alias to
invoke a function, use the Qualifier
parameter to apply permissions to that ARN. For more
information about versioning, see AWS Lambda Function Versioning and
Aliases.
You need permission for the lambda:RemovePermission
action.
removePermissionRequest
- ServiceException
- The AWS Lambda service encountered an internal error.ResourceNotFoundException
- The resource (for example, a Lambda function or access policy statement) specified in the request does
not exist.InvalidParameterValueException
- One of the parameters in the request is invalid. For example, if you provided an IAM role for AWS Lambda
to assume in the CreateFunction
or the UpdateFunctionConfiguration
API, that
AWS Lambda is unable to assume you will get this exception.TooManyRequestsException
- Request throughput limit exceededPreconditionFailedException
- The RevisionId provided does not match the latest RevisionId for the Lambda function or alias. Call the
GetFunction
or the GetAlias
API to retrieve the latest RevisionId for your
resource.TagResourceResult tagResource(TagResourceRequest tagResourceRequest)
Creates a list of tags (key-value pairs) on the Lambda function. Requires the Lambda function ARN (Amazon Resource Name). If a key is specified without a value, Lambda creates a tag with the specified key and a value of null. For more information, see Tagging Lambda Functions in the AWS Lambda Developer Guide.
tagResourceRequest
- ServiceException
- The AWS Lambda service encountered an internal error.ResourceNotFoundException
- The resource (for example, a Lambda function or access policy statement) specified in the request does
not exist.InvalidParameterValueException
- One of the parameters in the request is invalid. For example, if you provided an IAM role for AWS Lambda
to assume in the CreateFunction
or the UpdateFunctionConfiguration
API, that
AWS Lambda is unable to assume you will get this exception.TooManyRequestsException
- Request throughput limit exceededUntagResourceResult untagResource(UntagResourceRequest untagResourceRequest)
Removes tags from a Lambda function. Requires the function ARN (Amazon Resource Name). For more information, see Tagging Lambda Functions in the AWS Lambda Developer Guide.
untagResourceRequest
- ServiceException
- The AWS Lambda service encountered an internal error.ResourceNotFoundException
- The resource (for example, a Lambda function or access policy statement) specified in the request does
not exist.InvalidParameterValueException
- One of the parameters in the request is invalid. For example, if you provided an IAM role for AWS Lambda
to assume in the CreateFunction
or the UpdateFunctionConfiguration
API, that
AWS Lambda is unable to assume you will get this exception.TooManyRequestsException
- Request throughput limit exceededUpdateAliasResult updateAlias(UpdateAliasRequest updateAliasRequest)
Using this API you can update the function version to which the alias points and the alias description. For more information, see Introduction to AWS Lambda Aliases.
This requires permission for the lambda:UpdateAlias action.
updateAliasRequest
- ServiceException
- The AWS Lambda service encountered an internal error.ResourceNotFoundException
- The resource (for example, a Lambda function or access policy statement) specified in the request does
not exist.InvalidParameterValueException
- One of the parameters in the request is invalid. For example, if you provided an IAM role for AWS Lambda
to assume in the CreateFunction
or the UpdateFunctionConfiguration
API, that
AWS Lambda is unable to assume you will get this exception.TooManyRequestsException
- Request throughput limit exceededPreconditionFailedException
- The RevisionId provided does not match the latest RevisionId for the Lambda function or alias. Call the
GetFunction
or the GetAlias
API to retrieve the latest RevisionId for your
resource.UpdateEventSourceMappingResult updateEventSourceMapping(UpdateEventSourceMappingRequest updateEventSourceMappingRequest)
You can update an event source mapping. This is useful if you want to change the parameters of the existing mapping without losing your position in the stream. You can change which function will receive the stream records, but to change the stream itself, you must create a new mapping.
If you disable the event source mapping, AWS Lambda stops polling. If you enable again, it will resume polling from the time it had stopped polling, so you don't lose processing of any records. However, if you delete event source mapping and create it again, it will reset.
This operation requires permission for the lambda:UpdateEventSourceMapping
action.
updateEventSourceMappingRequest
- ServiceException
- The AWS Lambda service encountered an internal error.ResourceNotFoundException
- The resource (for example, a Lambda function or access policy statement) specified in the request does
not exist.InvalidParameterValueException
- One of the parameters in the request is invalid. For example, if you provided an IAM role for AWS Lambda
to assume in the CreateFunction
or the UpdateFunctionConfiguration
API, that
AWS Lambda is unable to assume you will get this exception.TooManyRequestsException
- Request throughput limit exceededResourceConflictException
- The resource already exists.ResourceInUseException
- The operation conflicts with the resource's availability. For example, you attempted to update an
EventSoure Mapping in CREATING, or tried to delete a EventSoure mapping currently in the UPDATING state.UpdateFunctionCodeResult updateFunctionCode(UpdateFunctionCodeRequest updateFunctionCodeRequest)
Updates the code for the specified Lambda function. This operation must only be used on an existing Lambda function and cannot be used to update the function configuration.
If you are using the versioning feature, note this API will always update the $LATEST version of your Lambda function. For information about the versioning feature, see AWS Lambda Function Versioning and Aliases.
This operation requires permission for the lambda:UpdateFunctionCode
action.
updateFunctionCodeRequest
- ServiceException
- The AWS Lambda service encountered an internal error.ResourceNotFoundException
- The resource (for example, a Lambda function or access policy statement) specified in the request does
not exist.InvalidParameterValueException
- One of the parameters in the request is invalid. For example, if you provided an IAM role for AWS Lambda
to assume in the CreateFunction
or the UpdateFunctionConfiguration
API, that
AWS Lambda is unable to assume you will get this exception.TooManyRequestsException
- Request throughput limit exceededCodeStorageExceededException
- You have exceeded your maximum total code size per account. LimitsPreconditionFailedException
- The RevisionId provided does not match the latest RevisionId for the Lambda function or alias. Call the
GetFunction
or the GetAlias
API to retrieve the latest RevisionId for your
resource.UpdateFunctionConfigurationResult updateFunctionConfiguration(UpdateFunctionConfigurationRequest updateFunctionConfigurationRequest)
Updates the configuration parameters for the specified Lambda function by using the values provided in the request. You provide only the parameters you want to change. This operation must only be used on an existing Lambda function and cannot be used to update the function's code.
If you are using the versioning feature, note this API will always update the $LATEST version of your Lambda function. For information about the versioning feature, see AWS Lambda Function Versioning and Aliases.
This operation requires permission for the lambda:UpdateFunctionConfiguration
action.
updateFunctionConfigurationRequest
- ServiceException
- The AWS Lambda service encountered an internal error.ResourceNotFoundException
- The resource (for example, a Lambda function or access policy statement) specified in the request does
not exist.InvalidParameterValueException
- One of the parameters in the request is invalid. For example, if you provided an IAM role for AWS Lambda
to assume in the CreateFunction
or the UpdateFunctionConfiguration
API, that
AWS Lambda is unable to assume you will get this exception.TooManyRequestsException
- Request throughput limit exceededResourceConflictException
- The resource already exists.PreconditionFailedException
- The RevisionId provided does not match the latest RevisionId for the Lambda function or alias. Call the
GetFunction
or the GetAlias
API to retrieve the latest RevisionId for your
resource.void shutdown()
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 a request.
request
- The originally executed request.Copyright © 2018. All rights reserved.