@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 |
---|---|
AddLayerVersionPermissionResult |
addLayerVersionPermission(AddLayerVersionPermissionRequest addLayerVersionPermissionRequest)
Adds permissions to the resource-based policy of a version of an AWS Lambda layer.
|
AddPermissionResult |
addPermission(AddPermissionRequest addPermissionRequest)
Grants an AWS service or another account permission to use a function.
|
CreateAliasResult |
createAlias(CreateAliasRequest createAliasRequest)
Creates an alias for a Lambda
function version.
|
CreateEventSourceMappingResult |
createEventSourceMapping(CreateEventSourceMappingRequest createEventSourceMappingRequest)
Creates a mapping between an event source and an AWS Lambda function.
|
CreateFunctionResult |
createFunction(CreateFunctionRequest createFunctionRequest)
Creates a Lambda function.
|
DeleteAliasResult |
deleteAlias(DeleteAliasRequest deleteAliasRequest)
Deletes a Lambda function alias.
|
DeleteEventSourceMappingResult |
deleteEventSourceMapping(DeleteEventSourceMappingRequest deleteEventSourceMappingRequest)
Deletes an event source
mapping.
|
DeleteFunctionResult |
deleteFunction(DeleteFunctionRequest deleteFunctionRequest)
Deletes a Lambda function.
|
DeleteFunctionConcurrencyResult |
deleteFunctionConcurrency(DeleteFunctionConcurrencyRequest deleteFunctionConcurrencyRequest)
Removes a concurrent execution limit from a function.
|
DeleteLayerVersionResult |
deleteLayerVersion(DeleteLayerVersionRequest deleteLayerVersionRequest)
Deletes a version of an AWS
Lambda layer.
|
GetAccountSettingsResult |
getAccountSettings(GetAccountSettingsRequest getAccountSettingsRequest)
Retrieves details about your account's limits and usage in an AWS Region.
|
GetAliasResult |
getAlias(GetAliasRequest getAliasRequest)
Returns details about a Lambda function alias.
|
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 details about an event source mapping.
|
GetFunctionResult |
getFunction(GetFunctionRequest getFunctionRequest)
Returns information about the function or function version, with a link to download the deployment package that's
valid for 10 minutes.
|
GetFunctionConfigurationResult |
getFunctionConfiguration(GetFunctionConfigurationRequest getFunctionConfigurationRequest)
Returns the version-specific settings of a Lambda function or version.
|
GetLayerVersionResult |
getLayerVersion(GetLayerVersionRequest getLayerVersionRequest)
Returns information about a version of an AWS Lambda layer, with a link
to download the layer archive that's valid for 10 minutes.
|
GetLayerVersionByArnResult |
getLayerVersionByArn(GetLayerVersionByArnRequest getLayerVersionByArnRequest)
Returns information about a version of an AWS Lambda layer, with a link
to download the layer archive that's valid for 10 minutes.
|
GetLayerVersionPolicyResult |
getLayerVersionPolicy(GetLayerVersionPolicyRequest getLayerVersionPolicyRequest)
Returns the permission policy for a version of an AWS Lambda layer.
|
GetPolicyResult |
getPolicy(GetPolicyRequest getPolicyRequest)
Returns the resource-based IAM
policy for a function, version, or alias.
|
InvokeResult |
invoke(InvokeRequest invokeRequest)
Invokes a Lambda function.
|
InvokeAsyncResult |
invokeAsync(InvokeAsyncRequest invokeAsyncRequest)
Deprecated.
|
ListAliasesResult |
listAliases(ListAliasesRequest listAliasesRequest)
Returns a list of aliases for
a Lambda function.
|
ListEventSourceMappingsResult |
listEventSourceMappings()
Simplified method form for invoking the ListEventSourceMappings operation.
|
ListEventSourceMappingsResult |
listEventSourceMappings(ListEventSourceMappingsRequest listEventSourceMappingsRequest)
Lists event source mappings.
|
ListFunctionsResult |
listFunctions()
Simplified method form for invoking the ListFunctions operation.
|
ListFunctionsResult |
listFunctions(ListFunctionsRequest listFunctionsRequest)
Returns a list of Lambda functions, with the version-specific configuration of each.
|
ListLayersResult |
listLayers(ListLayersRequest listLayersRequest)
Lists AWS Lambda layers and
shows information about the latest version of each.
|
ListLayerVersionsResult |
listLayerVersions(ListLayerVersionsRequest listLayerVersionsRequest)
Lists the versions of an AWS
Lambda layer.
|
ListTagsResult |
listTags(ListTagsRequest listTagsRequest)
Returns a function's tags.
|
ListVersionsByFunctionResult |
listVersionsByFunction(ListVersionsByFunctionRequest listVersionsByFunctionRequest)
Returns a list of versions,
with the version-specific configuration of each.
|
PublishLayerVersionResult |
publishLayerVersion(PublishLayerVersionRequest publishLayerVersionRequest)
Creates an AWS Lambda layer
from a ZIP archive.
|
PublishVersionResult |
publishVersion(PublishVersionRequest publishVersionRequest)
Creates a version from the
current code and configuration of a function.
|
PutFunctionConcurrencyResult |
putFunctionConcurrency(PutFunctionConcurrencyRequest putFunctionConcurrencyRequest)
Sets the maximum number of simultaneous executions for a function, and reserves capacity for that concurrency
level.
|
RemoveLayerVersionPermissionResult |
removeLayerVersionPermission(RemoveLayerVersionPermissionRequest removeLayerVersionPermissionRequest)
Removes a statement from the permissions policy for a version of an AWS Lambda layer.
|
RemovePermissionResult |
removePermission(RemovePermissionRequest removePermissionRequest)
Revokes function-use permission from an AWS service or another account.
|
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)
Adds tags to a function.
|
UntagResourceResult |
untagResource(UntagResourceRequest untagResourceRequest)
Removes tags from a function.
|
UpdateAliasResult |
updateAlias(UpdateAliasRequest updateAliasRequest)
Updates the configuration of a Lambda function alias.
|
UpdateEventSourceMappingResult |
updateEventSourceMapping(UpdateEventSourceMappingRequest updateEventSourceMappingRequest)
Updates an event source mapping.
|
UpdateFunctionCodeResult |
updateFunctionCode(UpdateFunctionCodeRequest updateFunctionCodeRequest)
Updates a Lambda function's code.
|
UpdateFunctionConfigurationResult |
updateFunctionConfiguration(UpdateFunctionConfigurationRequest updateFunctionConfigurationRequest)
Modify the version-specific settings of a Lambda function.
|
AWSLambdaWaiters |
waiters() |
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)
AddLayerVersionPermissionResult addLayerVersionPermission(AddLayerVersionPermissionRequest addLayerVersionPermissionRequest)
Adds permissions to the resource-based policy of a version of an AWS Lambda layer. Use this action to grant layer usage permission to other accounts. You can grant permission to a single account, all AWS accounts, or all accounts in an organization.
To revoke permission, call RemoveLayerVersionPermission with the statement ID that you specified when you added it.
addLayerVersionPermissionRequest
- 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.TooManyRequestsException
- Request throughput limit exceeded.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
- The permissions policy for the resource is too large. Learn morePreconditionFailedException
- 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.AddPermissionResult addPermission(AddPermissionRequest addPermissionRequest)
Grants an AWS service or another account 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.
To grant permission to another account, specify the account ID as the Principal
. For AWS services,
the principal is a domain-style identifier defined by the service, like s3.amazonaws.com
or
sns.amazonaws.com
. For AWS services, you can also specify the ARN or owning account of the
associated resource as the SourceArn
or SourceAccount
. 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 action adds a statement to a resource-based permission policy for the function. For more information about function policies, see Lambda Function Policies.
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
- The permissions policy for the resource is too large. Learn moreTooManyRequestsException
- Request throughput limit exceeded.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.CreateAliasResult createAlias(CreateAliasRequest createAliasRequest)
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.
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 exceeded.CreateEventSourceMappingResult createEventSourceMapping(CreateEventSourceMappingRequest createEventSourceMappingRequest)
Creates a mapping between an event source and an AWS Lambda function. Lambda reads items from the event source and triggers the function.
For details about each event source type, see the following topics.
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 exceeded.ResourceNotFoundException
- The resource (for example, a Lambda function or access policy statement) specified in the request does
not exist.CreateFunctionResult createFunction(CreateFunctionRequest createFunctionRequest)
Creates a Lambda function. To create a function, you need a deployment package and an execution role. The deployment package contains your function code. The execution role grants the function permission to use AWS services, such as Amazon CloudWatch Logs for log streaming and AWS X-Ray for request tracing.
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).
If another account or an AWS service invokes your function, use AddPermission to grant permission by creating a resource-based 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 AWS services, create an event source mapping (CreateEventSourceMapping), or configure a function trigger in the other service. For more information, see Invoking Functions.
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 exceeded.CodeStorageExceededException
- You have exceeded your maximum total code size per account. Learn moreDeleteAliasResult deleteAlias(DeleteAliasRequest deleteAliasRequest)
Deletes a Lambda function alias.
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 exceeded.DeleteEventSourceMappingResult deleteEventSourceMapping(DeleteEventSourceMappingRequest deleteEventSourceMappingRequest)
Deletes an event source mapping. You can get the identifier of a mapping from the output of ListEventSourceMappings.
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 exceeded.ResourceInUseException
- The operation conflicts with the resource's availability. For example, you attempted to update an
EventSource Mapping in CREATING, or tried to delete a EventSource 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.
To delete Lambda event source mappings that invoke a function, use DeleteEventSourceMapping. For AWS services and resources that invoke your function directly, delete the trigger in the service where you originally configured it.
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 exceeded.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.DeleteFunctionConcurrencyResult deleteFunctionConcurrency(DeleteFunctionConcurrencyRequest deleteFunctionConcurrencyRequest)
Removes a concurrent execution limit from a function.
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 exceeded.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.DeleteLayerVersionResult deleteLayerVersion(DeleteLayerVersionRequest deleteLayerVersionRequest)
Deletes a version of an AWS 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.
deleteLayerVersionRequest
- ServiceException
- The AWS Lambda service encountered an internal error.TooManyRequestsException
- Request throughput limit exceeded.GetAccountSettingsResult getAccountSettings(GetAccountSettingsRequest getAccountSettingsRequest)
Retrieves details about your account's limits and usage in an AWS Region.
getAccountSettingsRequest
- TooManyRequestsException
- Request throughput limit exceeded.ServiceException
- The AWS Lambda service encountered an internal error.GetAliasResult getAlias(GetAliasRequest getAliasRequest)
Returns details about a Lambda function alias.
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 exceeded.GetEventSourceMappingResult getEventSourceMapping(GetEventSourceMappingRequest getEventSourceMappingRequest)
Returns details about an event source mapping. You can get the identifier of a mapping from the output of ListEventSourceMappings.
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 exceeded.GetFunctionResult getFunction(GetFunctionRequest getFunctionRequest)
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.
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 exceeded.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.GetFunctionConfigurationResult getFunctionConfiguration(GetFunctionConfigurationRequest getFunctionConfigurationRequest)
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.
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 exceeded.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.GetLayerVersionResult getLayerVersion(GetLayerVersionRequest getLayerVersionRequest)
Returns information about a version of an AWS Lambda layer, with a link to download the layer archive that's valid for 10 minutes.
getLayerVersionRequest
- 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 exceeded.ResourceNotFoundException
- The resource (for example, a Lambda function or access policy statement) specified in the request does
not exist.GetLayerVersionByArnResult getLayerVersionByArn(GetLayerVersionByArnRequest getLayerVersionByArnRequest)
Returns information about a version of an AWS Lambda layer, with a link to download the layer archive that's valid for 10 minutes.
getLayerVersionByArnRequest
- 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 exceeded.ResourceNotFoundException
- The resource (for example, a Lambda function or access policy statement) specified in the request does
not exist.GetLayerVersionPolicyResult getLayerVersionPolicy(GetLayerVersionPolicyRequest getLayerVersionPolicyRequest)
Returns the permission policy for a version of an AWS Lambda layer. For more information, see AddLayerVersionPermission.
getLayerVersionPolicyRequest
- 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 exceeded.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.GetPolicyResult getPolicy(GetPolicyRequest getPolicyRequest)
Returns the resource-based IAM policy for a function, version, or alias.
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 exceeded.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.InvokeResult invoke(InvokeRequest invokeRequest)
Invokes a Lambda function. You can invoke a function synchronously (and wait for the response), or
asynchronously. To invoke a function asynchronously, set InvocationType
to Event
.
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. To record function errors for asynchronous invocations, configure your function with a dead letter queue.
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 Retry Behavior.
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, limit errors, or issues with your function's
code and configuration. For example, Lambda returns TooManyRequestsException
if executing 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 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.
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 exceeded.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.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.
Invokes a function asynchronously.
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 a list of aliases for a Lambda function.
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 exceeded.ListEventSourceMappingsResult listEventSourceMappings(ListEventSourceMappingsRequest listEventSourceMappingsRequest)
Lists event source mappings. Specify an EventSourceArn
to only show event source mappings for a
single event source.
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 exceeded.ListEventSourceMappingsResult listEventSourceMappings()
ListFunctionsResult listFunctions(ListFunctionsRequest listFunctionsRequest)
Returns a list of Lambda functions, with the version-specific configuration of each.
Set FunctionVersion
to ALL
to include all published versions of each function in
addition to the unpublished version. To get more information about a function or version, use GetFunction.
listFunctionsRequest
- ServiceException
- The AWS Lambda service encountered an internal error.TooManyRequestsException
- Request throughput limit exceeded.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.ListFunctionsResult listFunctions()
listFunctions(ListFunctionsRequest)
ListLayerVersionsResult listLayerVersions(ListLayerVersionsRequest listLayerVersionsRequest)
Lists the versions of an AWS 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.
listLayerVersionsRequest
- 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 exceeded.ListLayersResult listLayers(ListLayersRequest listLayersRequest)
Lists AWS 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.
listLayersRequest
- 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 exceeded.ListTagsResult listTags(ListTagsRequest listTagsRequest)
Returns a function's tags. You can also view tags with GetFunction.
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 exceeded.ListVersionsByFunctionResult listVersionsByFunction(ListVersionsByFunctionRequest listVersionsByFunctionRequest)
Returns a list of versions, with the version-specific configuration of each.
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 exceeded.PublishLayerVersionResult publishLayerVersion(PublishLayerVersionRequest publishLayerVersionRequest)
Creates an AWS Lambda layer
from a ZIP archive. Each time you call PublishLayerVersion
with the same version name, a new version
is created.
Add layers to your function with CreateFunction or UpdateFunctionConfiguration.
publishLayerVersionRequest
- 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 exceeded.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.CodeStorageExceededException
- You have exceeded your maximum total code size per account. Learn morePublishVersionResult publishVersion(PublishVersionRequest publishVersionRequest)
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.
AWS 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.
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 exceeded.CodeStorageExceededException
- You have exceeded your maximum total code size per account. Learn morePreconditionFailedException
- 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 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 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 exceeded.RemoveLayerVersionPermissionResult removeLayerVersionPermission(RemoveLayerVersionPermissionRequest removeLayerVersionPermissionRequest)
Removes a statement from the permissions policy for a version of an AWS Lambda layer. For more information, see AddLayerVersionPermission.
removeLayerVersionPermissionRequest
- 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 exceeded.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.RemovePermissionResult removePermission(RemovePermissionRequest removePermissionRequest)
Revokes function-use permission from an AWS service or another account. You can get the ID of the statement from the output of GetPolicy.
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 exceeded.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.TagResourceResult tagResource(TagResourceRequest tagResourceRequest)
Adds tags to a function.
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 exceeded.UntagResourceResult untagResource(UntagResourceRequest untagResourceRequest)
Removes tags from a function.
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 exceeded.UpdateAliasResult updateAlias(UpdateAliasRequest updateAliasRequest)
Updates the configuration of a Lambda function alias.
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 exceeded.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.UpdateEventSourceMappingResult updateEventSourceMapping(UpdateEventSourceMappingRequest updateEventSourceMappingRequest)
Updates an event source mapping. You can change the function that AWS Lambda invokes, or pause invocation and resume later from the same location.
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 exceeded.ResourceConflictException
- The resource already exists.ResourceInUseException
- The operation conflicts with the resource's availability. For example, you attempted to update an
EventSource Mapping in CREATING, or tried to delete a EventSource mapping currently in the UPDATING
state.UpdateFunctionCodeResult updateFunctionCode(UpdateFunctionCodeRequest updateFunctionCodeRequest)
Updates a Lambda function's code.
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.
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 exceeded.CodeStorageExceededException
- You have exceeded your maximum total code size per account. Learn morePreconditionFailedException
- 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)
Modify the version-specific settings of a Lambda function.
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 account or AWS service, use AddPermission.
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 exceeded.ResourceConflictException
- 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.AWSLambdaWaiters waiters()
Copyright © 2019. All rights reserved.