@ThreadSafe @Generated(value="com.amazonaws:aws-java-sdk-code-generator") public class AWSLambdaClient extends AmazonWebServiceClient implements AWSLambda
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 |
---|---|
protected static ClientConfigurationFactory |
configFactory
Client configuration factory providing ClientConfigurations tailored to this client
|
client, clientConfiguration, endpoint, LOGGING_AWS_REQUEST_METRIC, requestHandler2s, timeOffset
ENDPOINT_PREFIX
Constructor and Description |
---|
AWSLambdaClient()
Deprecated.
|
AWSLambdaClient(AWSCredentials awsCredentials)
Deprecated.
use
AwsClientBuilder.withCredentials(AWSCredentialsProvider) for example:
AWSLambdaClientBuilder.standard().withCredentials(new AWSStaticCredentialsProvider(awsCredentials)).build(); |
AWSLambdaClient(AWSCredentials awsCredentials,
ClientConfiguration clientConfiguration)
|
AWSLambdaClient(AWSCredentialsProvider awsCredentialsProvider)
Deprecated.
|
AWSLambdaClient(AWSCredentialsProvider awsCredentialsProvider,
ClientConfiguration clientConfiguration)
|
AWSLambdaClient(AWSCredentialsProvider awsCredentialsProvider,
ClientConfiguration clientConfiguration,
RequestMetricCollector requestMetricCollector)
|
AWSLambdaClient(ClientConfiguration clientConfiguration)
Deprecated.
|
Modifier and Type | Method and Description |
---|---|
AddLayerVersionPermissionResult |
addLayerVersionPermission(AddLayerVersionPermissionRequest request)
Adds permissions to the resource-based policy of a version of an AWS Lambda layer.
|
AddPermissionResult |
addPermission(AddPermissionRequest request)
Grants an AWS service or another account permission to use a function.
|
static AWSLambdaClientBuilder |
builder() |
CreateAliasResult |
createAlias(CreateAliasRequest request)
Creates an alias for a Lambda
function version.
|
CreateEventSourceMappingResult |
createEventSourceMapping(CreateEventSourceMappingRequest request)
Creates a mapping between an event source and an AWS Lambda function.
|
CreateFunctionResult |
createFunction(CreateFunctionRequest request)
Creates a Lambda function.
|
DeleteAliasResult |
deleteAlias(DeleteAliasRequest request)
Deletes a Lambda function alias.
|
DeleteEventSourceMappingResult |
deleteEventSourceMapping(DeleteEventSourceMappingRequest request)
Deletes an event source
mapping.
|
DeleteFunctionResult |
deleteFunction(DeleteFunctionRequest request)
Deletes a Lambda function.
|
DeleteFunctionConcurrencyResult |
deleteFunctionConcurrency(DeleteFunctionConcurrencyRequest request)
Removes a concurrent execution limit from a function.
|
DeleteLayerVersionResult |
deleteLayerVersion(DeleteLayerVersionRequest request)
Deletes a version of an AWS
Lambda layer.
|
GetAccountSettingsResult |
getAccountSettings(GetAccountSettingsRequest request)
Retrieves details about your account's limits and usage in an AWS Region.
|
GetAliasResult |
getAlias(GetAliasRequest request)
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 request)
Returns details about an event source mapping.
|
GetFunctionResult |
getFunction(GetFunctionRequest request)
Returns information about the function or function version, with a link to download the deployment package that's
valid for 10 minutes.
|
GetFunctionConfigurationResult |
getFunctionConfiguration(GetFunctionConfigurationRequest request)
Returns the version-specific settings of a Lambda function or version.
|
GetLayerVersionResult |
getLayerVersion(GetLayerVersionRequest request)
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 request)
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 request)
Returns the permission policy for a version of an AWS Lambda layer.
|
GetPolicyResult |
getPolicy(GetPolicyRequest request)
Returns the resource-based IAM
policy for a function, version, or alias.
|
InvokeResult |
invoke(InvokeRequest request)
Invokes a Lambda function.
|
InvokeAsyncResult |
invokeAsync(InvokeAsyncRequest request)
Deprecated.
|
ListAliasesResult |
listAliases(ListAliasesRequest request)
Returns a list of aliases for
a Lambda function.
|
ListEventSourceMappingsResult |
listEventSourceMappings()
Simplified method form for invoking the ListEventSourceMappings operation.
|
ListEventSourceMappingsResult |
listEventSourceMappings(ListEventSourceMappingsRequest request)
Lists event source mappings.
|
ListFunctionsResult |
listFunctions()
Simplified method form for invoking the ListFunctions operation.
|
ListFunctionsResult |
listFunctions(ListFunctionsRequest request)
Returns a list of Lambda functions, with the version-specific configuration of each.
|
ListLayersResult |
listLayers(ListLayersRequest request)
Lists AWS Lambda layers and
shows information about the latest version of each.
|
ListLayerVersionsResult |
listLayerVersions(ListLayerVersionsRequest request)
Lists the versions of an AWS
Lambda layer.
|
ListTagsResult |
listTags(ListTagsRequest request)
Returns a function's tags.
|
ListVersionsByFunctionResult |
listVersionsByFunction(ListVersionsByFunctionRequest request)
Returns a list of versions,
with the version-specific configuration of each.
|
PublishLayerVersionResult |
publishLayerVersion(PublishLayerVersionRequest request)
Creates an AWS Lambda layer
from a ZIP archive.
|
PublishVersionResult |
publishVersion(PublishVersionRequest request)
Creates a version from the
current code and configuration of a function.
|
PutFunctionConcurrencyResult |
putFunctionConcurrency(PutFunctionConcurrencyRequest request)
Sets the maximum number of simultaneous executions for a function, and reserves capacity for that concurrency
level.
|
RemoveLayerVersionPermissionResult |
removeLayerVersionPermission(RemoveLayerVersionPermissionRequest request)
Removes a statement from the permissions policy for a version of an AWS Lambda layer.
|
RemovePermissionResult |
removePermission(RemovePermissionRequest request)
Revokes function-use permission from an AWS service or another account.
|
void |
shutdown()
Shuts down this client object, releasing any resources that might be held open.
|
TagResourceResult |
tagResource(TagResourceRequest request)
Adds tags to a function.
|
UntagResourceResult |
untagResource(UntagResourceRequest request)
Removes tags from a function.
|
UpdateAliasResult |
updateAlias(UpdateAliasRequest request)
Updates the configuration of a Lambda function alias.
|
UpdateEventSourceMappingResult |
updateEventSourceMapping(UpdateEventSourceMappingRequest request)
Updates an event source mapping.
|
UpdateFunctionCodeResult |
updateFunctionCode(UpdateFunctionCodeRequest request)
Updates a Lambda function's code.
|
UpdateFunctionConfigurationResult |
updateFunctionConfiguration(UpdateFunctionConfigurationRequest request)
Modify the version-specific settings of a Lambda function.
|
AWSLambdaWaiters |
waiters() |
addRequestHandler, addRequestHandler, beforeClientExecution, beforeMarshalling, calculateCRC32FromCompressedData, checkMutability, configureRegion, createExecutionContext, createExecutionContext, createExecutionContext, createSignerProvider, endClientExecution, endClientExecution, getClientConfiguration, getClientId, getEndpointPrefix, getMonitoringListeners, getRequestMetricsCollector, getServiceAbbreviation, getServiceName, getServiceNameIntern, getSigner, getSignerByURI, getSignerOverride, getSignerProvider, getSignerRegionOverride, getSigningRegion, getTimeOffset, isCsmEnabled, isProfilingEnabled, isRequestMetricsEnabled, makeImmutable, removeRequestHandler, removeRequestHandler, requestMetricCollector, setEndpoint, setEndpoint, setEndpointPrefix, setRegion, setServiceNameIntern, setSignerRegionOverride, setTimeOffset, shouldGenerateClientSideMonitoringEvents, useStrictHostNameVerification, withEndpoint, withRegion, withRegion, withTimeOffset
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
setEndpoint, setRegion
protected static final ClientConfigurationFactory configFactory
@Deprecated public AWSLambdaClient()
AWSLambdaClientBuilder.defaultClient()
All service calls made using this new client object are blocking, and will not return until the service call completes.
DefaultAWSCredentialsProviderChain
@Deprecated public AWSLambdaClient(ClientConfiguration clientConfiguration)
AwsClientBuilder.withClientConfiguration(ClientConfiguration)
All service calls made using this new client object are blocking, and will not return until the service call completes.
clientConfiguration
- The client configuration options controlling how this client connects to AWS Lambda (ex: proxy settings,
retry counts, etc.).DefaultAWSCredentialsProviderChain
@Deprecated public AWSLambdaClient(AWSCredentials awsCredentials)
AwsClientBuilder.withCredentials(AWSCredentialsProvider)
for example:
AWSLambdaClientBuilder.standard().withCredentials(new AWSStaticCredentialsProvider(awsCredentials)).build();
All service calls made using this new client object are blocking, and will not return until the service call completes.
awsCredentials
- The AWS credentials (access key ID and secret key) to use when authenticating with AWS services.@Deprecated public AWSLambdaClient(AWSCredentials awsCredentials, ClientConfiguration clientConfiguration)
AwsClientBuilder.withCredentials(AWSCredentialsProvider)
and
AwsClientBuilder.withClientConfiguration(ClientConfiguration)
All service calls made using this new client object are blocking, and will not return until the service call completes.
awsCredentials
- The AWS credentials (access key ID and secret key) to use when authenticating with AWS services.clientConfiguration
- The client configuration options controlling how this client connects to AWS Lambda (ex: proxy settings,
retry counts, etc.).@Deprecated public AWSLambdaClient(AWSCredentialsProvider awsCredentialsProvider)
AwsClientBuilder.withCredentials(AWSCredentialsProvider)
All service calls made using this new client object are blocking, and will not return until the service call completes.
awsCredentialsProvider
- The AWS credentials provider which will provide credentials to authenticate requests with AWS services.@Deprecated public AWSLambdaClient(AWSCredentialsProvider awsCredentialsProvider, ClientConfiguration clientConfiguration)
AwsClientBuilder.withCredentials(AWSCredentialsProvider)
and
AwsClientBuilder.withClientConfiguration(ClientConfiguration)
All service calls made using this new client object are blocking, and will not return until the service call completes.
awsCredentialsProvider
- The AWS credentials provider which will provide credentials to authenticate requests with AWS services.clientConfiguration
- The client configuration options controlling how this client connects to AWS Lambda (ex: proxy settings,
retry counts, etc.).@Deprecated public AWSLambdaClient(AWSCredentialsProvider awsCredentialsProvider, ClientConfiguration clientConfiguration, RequestMetricCollector requestMetricCollector)
AwsClientBuilder.withCredentials(AWSCredentialsProvider)
and
AwsClientBuilder.withClientConfiguration(ClientConfiguration)
and
AwsClientBuilder.withMetricsCollector(RequestMetricCollector)
All service calls made using this new client object are blocking, and will not return until the service call completes.
awsCredentialsProvider
- The AWS credentials provider which will provide credentials to authenticate requests with AWS services.clientConfiguration
- The client configuration options controlling how this client connects to AWS Lambda (ex: proxy settings,
retry counts, etc.).requestMetricCollector
- optional request metric collectorpublic static AWSLambdaClientBuilder builder()
public AddLayerVersionPermissionResult addLayerVersionPermission(AddLayerVersionPermissionRequest request)
Adds permissions to the resource-based policy of a version of an 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.
addLayerVersionPermission
in interface AWSLambda
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.public AddPermissionResult addPermission(AddPermissionRequest request)
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.
addPermission
in interface AWSLambda
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.public CreateAliasResult createAlias(CreateAliasRequest request)
Creates an alias for a Lambda function version. Use aliases to provide clients with a function identifier that you can update to invoke a different version.
You can also map an alias to split invocation requests between two versions. Use the RoutingConfig
parameter to specify a second version and the percentage of invocation requests that it receives.
createAlias
in interface AWSLambda
createAliasRequest
- ServiceException
- The 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.public CreateEventSourceMappingResult createEventSourceMapping(CreateEventSourceMappingRequest request)
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.
createEventSourceMapping
in interface AWSLambda
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.public CreateFunctionResult createFunction(CreateFunctionRequest request)
Creates a Lambda function. To create a function, you need a deployment package and an execution role. The deployment package 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.
createFunction
in interface AWSLambda
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 morepublic DeleteAliasResult deleteAlias(DeleteAliasRequest request)
Deletes a Lambda function alias.
deleteAlias
in interface AWSLambda
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.public DeleteEventSourceMappingResult deleteEventSourceMapping(DeleteEventSourceMappingRequest request)
Deletes an event source mapping. You can get the identifier of a mapping from the output of ListEventSourceMappings.
deleteEventSourceMapping
in interface AWSLambda
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.public DeleteFunctionResult deleteFunction(DeleteFunctionRequest request)
Deletes a Lambda function. To delete a specific function version, use the Qualifier
parameter.
Otherwise, all versions and aliases are deleted.
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.
deleteFunction
in interface AWSLambda
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.public DeleteFunctionConcurrencyResult deleteFunctionConcurrency(DeleteFunctionConcurrencyRequest request)
Removes a concurrent execution limit from a function.
deleteFunctionConcurrency
in interface AWSLambda
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.public DeleteLayerVersionResult deleteLayerVersion(DeleteLayerVersionRequest request)
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.
deleteLayerVersion
in interface AWSLambda
deleteLayerVersionRequest
- ServiceException
- The AWS Lambda service encountered an internal error.TooManyRequestsException
- Request throughput limit exceeded.public GetAccountSettingsResult getAccountSettings(GetAccountSettingsRequest request)
Retrieves details about your account's limits and usage in an AWS Region.
getAccountSettings
in interface AWSLambda
getAccountSettingsRequest
- TooManyRequestsException
- Request throughput limit exceeded.ServiceException
- The AWS Lambda service encountered an internal error.public GetAliasResult getAlias(GetAliasRequest request)
Returns details about a Lambda function alias.
getAlias
in interface AWSLambda
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.public GetEventSourceMappingResult getEventSourceMapping(GetEventSourceMappingRequest request)
Returns details about an event source mapping. You can get the identifier of a mapping from the output of ListEventSourceMappings.
getEventSourceMapping
in interface AWSLambda
getEventSourceMappingRequest
- ServiceException
- The 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.public GetFunctionResult getFunction(GetFunctionRequest request)
Returns information about the function or function version, with a link to download the deployment package that's valid for 10 minutes. If you specify a function version, only details that are specific to that version are returned.
getFunction
in interface AWSLambda
getFunctionRequest
- ServiceException
- The 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.public GetFunctionConfigurationResult getFunctionConfiguration(GetFunctionConfigurationRequest request)
Returns the version-specific settings of a Lambda function or version. The output includes only options that can vary between versions of a function. To modify these settings, use UpdateFunctionConfiguration.
To get all of a function's details, including function-level settings, use GetFunction.
getFunctionConfiguration
in interface AWSLambda
getFunctionConfigurationRequest
- ServiceException
- The 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.public GetLayerVersionResult getLayerVersion(GetLayerVersionRequest request)
Returns information about a version of an AWS Lambda layer, with a link to download the layer archive that's valid for 10 minutes.
getLayerVersion
in interface AWSLambda
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.public GetLayerVersionByArnResult getLayerVersionByArn(GetLayerVersionByArnRequest request)
Returns information about a version of an AWS Lambda layer, with a link to download the layer archive that's valid for 10 minutes.
getLayerVersionByArn
in interface AWSLambda
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.public GetLayerVersionPolicyResult getLayerVersionPolicy(GetLayerVersionPolicyRequest request)
Returns the permission policy for a version of an AWS Lambda layer. For more information, see AddLayerVersionPermission.
getLayerVersionPolicy
in interface AWSLambda
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.public GetPolicyResult getPolicy(GetPolicyRequest request)
Returns the resource-based IAM policy for a function, version, or alias.
getPolicy
in interface AWSLambda
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.public InvokeResult invoke(InvokeRequest request)
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.
invoke
in interface AWSLambda
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 public InvokeAsyncResult invokeAsync(InvokeAsyncRequest request)
For asynchronous function invocation, use Invoke.
Invokes a function asynchronously.
invokeAsync
in interface AWSLambda
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.public ListAliasesResult listAliases(ListAliasesRequest request)
Returns a list of aliases for a Lambda function.
listAliases
in interface AWSLambda
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.public ListEventSourceMappingsResult listEventSourceMappings(ListEventSourceMappingsRequest request)
Lists event source mappings. Specify an EventSourceArn
to only show event source mappings for a
single event source.
listEventSourceMappings
in interface AWSLambda
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.public ListEventSourceMappingsResult listEventSourceMappings()
AWSLambda
listEventSourceMappings
in interface AWSLambda
AWSLambda.listEventSourceMappings(ListEventSourceMappingsRequest)
public ListFunctionsResult listFunctions(ListFunctionsRequest request)
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.
listFunctions
in interface AWSLambda
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.public ListFunctionsResult listFunctions()
AWSLambda
listFunctions
in interface AWSLambda
AWSLambda.listFunctions(ListFunctionsRequest)
public ListLayerVersionsResult listLayerVersions(ListLayerVersionsRequest request)
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.
listLayerVersions
in interface AWSLambda
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.public ListLayersResult listLayers(ListLayersRequest request)
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.
listLayers
in interface AWSLambda
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.public ListTagsResult listTags(ListTagsRequest request)
Returns a function's tags. You can also view tags with GetFunction.
listTags
in interface AWSLambda
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.public ListVersionsByFunctionResult listVersionsByFunction(ListVersionsByFunctionRequest request)
Returns a list of versions, with the version-specific configuration of each.
listVersionsByFunction
in interface AWSLambda
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.public PublishLayerVersionResult publishLayerVersion(PublishLayerVersionRequest request)
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.
publishLayerVersion
in interface AWSLambda
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 morepublic PublishVersionResult publishVersion(PublishVersionRequest request)
Creates a version from the current code and configuration of a function. Use versions to create a snapshot of your function code and configuration that doesn't change.
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.
publishVersion
in interface AWSLambda
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.public PutFunctionConcurrencyResult putFunctionConcurrency(PutFunctionConcurrencyRequest request)
Sets the maximum number of simultaneous executions for a function, and reserves capacity for that concurrency level.
Concurrency settings apply to the function as a whole, including all published versions and the unpublished version. Reserving concurrency both ensures that your function has capacity to process the specified number of events simultaneously, and prevents it from scaling beyond that level. Use GetFunction to see the current setting for a function.
Use GetAccountSettings to see your regional concurrency limit. You can reserve concurrency for as many functions as you like, as long as you leave at least 100 simultaneous executions unreserved for functions that aren't configured with a per-function limit. For more information, see Managing Concurrency.
putFunctionConcurrency
in interface AWSLambda
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.public RemoveLayerVersionPermissionResult removeLayerVersionPermission(RemoveLayerVersionPermissionRequest request)
Removes a statement from the permissions policy for a version of an AWS Lambda layer. For more information, see AddLayerVersionPermission.
removeLayerVersionPermission
in interface AWSLambda
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.public RemovePermissionResult removePermission(RemovePermissionRequest request)
Revokes function-use permission from an AWS service or another account. You can get the ID of the statement from the output of GetPolicy.
removePermission
in interface AWSLambda
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.public TagResourceResult tagResource(TagResourceRequest request)
Adds tags to a function.
tagResource
in interface AWSLambda
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.public UntagResourceResult untagResource(UntagResourceRequest request)
Removes tags from a function.
untagResource
in interface AWSLambda
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.public UpdateAliasResult updateAlias(UpdateAliasRequest request)
Updates the configuration of a Lambda function alias.
updateAlias
in interface AWSLambda
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.public UpdateEventSourceMappingResult updateEventSourceMapping(UpdateEventSourceMappingRequest request)
Updates an event source mapping. You can change the function that AWS Lambda invokes, or pause invocation and resume later from the same location.
updateEventSourceMapping
in interface AWSLambda
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.public UpdateFunctionCodeResult updateFunctionCode(UpdateFunctionCodeRequest request)
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.
updateFunctionCode
in interface AWSLambda
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.public UpdateFunctionConfigurationResult updateFunctionConfiguration(UpdateFunctionConfigurationRequest request)
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.
updateFunctionConfiguration
in interface AWSLambda
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.public ResponseMetadata getCachedResponseMetadata(AmazonWebServiceRequest request)
Response metadata is only cached for a limited period of time, so if you need to access this extra diagnostic information for an executed request, you should use this method to retrieve it as soon as possible after executing the request.
getCachedResponseMetadata
in interface AWSLambda
request
- The originally executed requestpublic AWSLambdaWaiters waiters()
public void shutdown()
AWSLambda
shutdown
in interface AWSLambda
shutdown
in class AmazonWebServiceClient
Copyright © 2019. All rights reserved.