@Generated(value="com.amazonaws:aws-java-sdk-code-generator") public class AbstractAWSLambda extends Object implements AWSLambda
AWSLambda
. Convenient method forms pass through to the corresponding overload that
takes a request object, which throws an UnsupportedOperationException
.ENDPOINT_PREFIX
Modifier and Type | Method and Description |
---|---|
AddPermissionResult |
addPermission(AddPermissionRequest request)
Adds a permission to the resource policy associated with the specified AWS Lambda function.
|
CreateAliasResult |
createAlias(CreateAliasRequest request)
Creates an alias that points to the specified Lambda function version.
|
CreateEventSourceMappingResult |
createEventSourceMapping(CreateEventSourceMappingRequest request)
Identifies a stream as an event source for a Lambda function.
|
CreateFunctionResult |
createFunction(CreateFunctionRequest request)
Creates a new Lambda function.
|
DeleteAliasResult |
deleteAlias(DeleteAliasRequest request)
Deletes the specified Lambda function alias.
|
DeleteEventSourceMappingResult |
deleteEventSourceMapping(DeleteEventSourceMappingRequest request)
Removes an event source mapping.
|
DeleteFunctionResult |
deleteFunction(DeleteFunctionRequest request)
Deletes the specified Lambda function code and configuration.
|
GetAccountSettingsResult |
getAccountSettings(GetAccountSettingsRequest request)
Returns a customer's account settings.
|
GetAliasResult |
getAlias(GetAliasRequest request)
Returns the specified alias information such as the alias ARN, description, and function version it is pointing
to.
|
ResponseMetadata |
getCachedResponseMetadata(AmazonWebServiceRequest request)
Returns additional metadata for a previously executed successful request, typically used for debugging issues
where a service isn't acting as expected.
|
GetEventSourceMappingResult |
getEventSourceMapping(GetEventSourceMappingRequest request)
Returns configuration information for the specified event source mapping (see CreateEventSourceMapping).
|
GetFunctionResult |
getFunction(GetFunctionRequest request)
Returns the configuration information of the Lambda function and a presigned URL link to the .zip file you
uploaded with CreateFunction so you can download the .zip file.
|
GetFunctionConfigurationResult |
getFunctionConfiguration(GetFunctionConfigurationRequest request)
Returns the configuration information of the Lambda function.
|
GetPolicyResult |
getPolicy(GetPolicyRequest request)
Returns the resource policy associated with the specified Lambda function.
|
InvokeResult |
invoke(InvokeRequest request)
Invokes a specific Lambda function.
|
InvokeAsyncResult |
invokeAsync(InvokeAsyncRequest request)
Deprecated.
|
ListAliasesResult |
listAliases(ListAliasesRequest request)
Returns list of aliases created for a Lambda function.
|
ListEventSourceMappingsResult |
listEventSourceMappings()
Simplified method form for invoking the ListEventSourceMappings operation.
|
ListEventSourceMappingsResult |
listEventSourceMappings(ListEventSourceMappingsRequest request)
Returns a list of event source mappings you created using the
CreateEventSourceMapping (see
CreateEventSourceMapping). |
ListFunctionsResult |
listFunctions()
Simplified method form for invoking the ListFunctions operation.
|
ListFunctionsResult |
listFunctions(ListFunctionsRequest request)
Returns a list of your Lambda functions.
|
ListTagsResult |
listTags(ListTagsRequest request)
Returns a list of tags assigned to a function when supplied the function ARN (Amazon Resource Name).
|
ListVersionsByFunctionResult |
listVersionsByFunction(ListVersionsByFunctionRequest request)
List all versions of a function.
|
PublishVersionResult |
publishVersion(PublishVersionRequest request)
Publishes a version of your function from the current snapshot of $LATEST.
|
RemovePermissionResult |
removePermission(RemovePermissionRequest request)
You can remove individual permissions from an resource policy associated with a Lambda function by providing a
statement ID that you provided when you added the permission.
|
void |
setEndpoint(String endpoint)
Overrides the default endpoint for this client ("lambda.us-east-1.amazonaws.com").
|
void |
setRegion(Region region)
An alternative to
AWSLambda.setEndpoint(String) , sets the regional endpoint for this client's service
calls. |
void |
shutdown()
Shuts down this client object, releasing any resources that might be held open.
|
TagResourceResult |
tagResource(TagResourceRequest request)
Creates a list of tags (key-value pairs) on the Lambda function.
|
UntagResourceResult |
untagResource(UntagResourceRequest request)
Removes tags from a Lambda function.
|
UpdateAliasResult |
updateAlias(UpdateAliasRequest request)
Using this API you can update the function version to which the alias points and the alias description.
|
UpdateEventSourceMappingResult |
updateEventSourceMapping(UpdateEventSourceMappingRequest request)
You can update an event source mapping.
|
UpdateFunctionCodeResult |
updateFunctionCode(UpdateFunctionCodeRequest request)
Updates the code for the specified Lambda function.
|
UpdateFunctionConfigurationResult |
updateFunctionConfiguration(UpdateFunctionConfigurationRequest request)
Updates the configuration parameters for the specified Lambda function by using the values provided in the
request.
|
public void setEndpoint(String endpoint)
AWSLambda
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: http://developer.amazonwebservices.com/connect/entry.jspa?externalID=3912
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.
setEndpoint
in interface AWSLambda
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.public void setRegion(Region region)
AWSLambda
AWSLambda.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.
setRegion
in interface AWSLambda
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)
public AddPermissionResult addPermission(AddPermissionRequest request)
AWSLambda
Adds a permission to the resource policy associated with the specified AWS Lambda function. You use resource policies to grant permissions to event sources that use push model. In a push model, event sources (such as Amazon S3 and custom applications) invoke your Lambda function. Each permission you add to the resource policy allows an event source, permission to invoke the Lambda function.
For information about the push model, see AWS Lambda: How it Works.
If you are using versioning, the permissions you add are specific to the Lambda function version or alias you
specify in the AddPermission
request via the Qualifier
parameter. For more information
about versioning, see AWS Lambda
Function Versioning and Aliases.
This operation requires permission for the lambda:AddPermission
action.
addPermission
in interface AWSLambda
public CreateAliasResult createAlias(CreateAliasRequest request)
AWSLambda
Creates an alias that points to the specified Lambda function version. For more information, see Introduction to AWS Lambda Aliases.
Alias names are unique for a given function. This requires permission for the lambda:CreateAlias action.
createAlias
in interface AWSLambda
public CreateEventSourceMappingResult createEventSourceMapping(CreateEventSourceMappingRequest request)
AWSLambda
Identifies a stream as an event source for a Lambda function. It can be either an Amazon Kinesis stream or an Amazon DynamoDB stream. AWS Lambda invokes the specified function when records are posted to the stream.
This association between a stream source and a Lambda function is called the event source mapping.
This event source mapping is relevant only in the AWS Lambda pull model, where AWS Lambda invokes the function. For more information, see AWS Lambda: How it Works in the AWS Lambda Developer Guide.
You provide mapping information (for example, which stream to read from and which Lambda function to invoke) in the request body.
Each event source, such as an Amazon Kinesis or a DynamoDB stream, can be associated with multiple AWS Lambda function. A given Lambda function can be associated with multiple AWS event sources.
If you are using versioning, you can specify a specific function version or an alias via the function name parameter. For more information about versioning, see AWS Lambda Function Versioning and Aliases.
This operation requires permission for the lambda:CreateEventSourceMapping
action.
createEventSourceMapping
in interface AWSLambda
public CreateFunctionResult createFunction(CreateFunctionRequest request)
AWSLambda
Creates a new Lambda function. The function metadata is created from the request parameters, and the code for the function is provided by a .zip file in the request body. If the function name already exists, the operation will fail. Note that the function name is case-sensitive.
If you are using versioning, you can also publish a version of the Lambda function you are creating using the
Publish
parameter. For more information about versioning, see AWS Lambda Function Versioning and
Aliases.
This operation requires permission for the lambda:CreateFunction
action.
createFunction
in interface AWSLambda
public DeleteAliasResult deleteAlias(DeleteAliasRequest request)
AWSLambda
Deletes the specified Lambda function alias. For more information, see Introduction to AWS Lambda Aliases.
This requires permission for the lambda:DeleteAlias action.
deleteAlias
in interface AWSLambda
public DeleteEventSourceMappingResult deleteEventSourceMapping(DeleteEventSourceMappingRequest request)
AWSLambda
Removes an event source mapping. This means AWS Lambda will no longer invoke the function for events in the associated source.
This operation requires permission for the lambda:DeleteEventSourceMapping
action.
deleteEventSourceMapping
in interface AWSLambda
public DeleteFunctionResult deleteFunction(DeleteFunctionRequest request)
AWSLambda
Deletes the specified Lambda function code and configuration.
If you are using the versioning feature and you don't specify a function version in your
DeleteFunction
request, AWS Lambda will delete the function, including all its versions, and any
aliases pointing to the function versions. To delete a specific function version, you must provide the function
version via the Qualifier
parameter. For information about function versioning, see AWS Lambda Function Versioning and
Aliases.
When you delete a function the associated resource policy is also deleted. You will need to delete the event source mappings explicitly.
This operation requires permission for the lambda:DeleteFunction
action.
deleteFunction
in interface AWSLambda
public GetAccountSettingsResult getAccountSettings(GetAccountSettingsRequest request)
AWSLambda
Returns a customer's account settings.
You can use this operation to retrieve Lambda limits information, such as code size and concurrency limits. For more information about limits, see AWS Lambda Limits. You can also retrieve resource usage statistics, such as code storage usage and function count.
getAccountSettings
in interface AWSLambda
public GetAliasResult getAlias(GetAliasRequest request)
AWSLambda
Returns the specified alias information such as the alias ARN, description, and function version it is pointing to. For more information, see Introduction to AWS Lambda Aliases.
This requires permission for the lambda:GetAlias
action.
getAlias
in interface AWSLambda
public GetEventSourceMappingResult getEventSourceMapping(GetEventSourceMappingRequest request)
AWSLambda
Returns configuration information for the specified event source mapping (see CreateEventSourceMapping).
This operation requires permission for the lambda:GetEventSourceMapping
action.
getEventSourceMapping
in interface AWSLambda
public GetFunctionResult getFunction(GetFunctionRequest request)
AWSLambda
Returns the configuration information of the Lambda function and a presigned URL link to the .zip file you uploaded with CreateFunction so you can download the .zip file. Note that the URL is valid for up to 10 minutes. The configuration information is the same information you provided as parameters when uploading the function.
Using the optional Qualifier
parameter, you can specify a specific function version for which you
want this information. If you don't specify this parameter, the API uses unqualified function ARN which return
information about the $LATEST
version of the Lambda function. For more information, see AWS Lambda Function Versioning and
Aliases.
This operation requires permission for the lambda:GetFunction
action.
getFunction
in interface AWSLambda
public GetFunctionConfigurationResult getFunctionConfiguration(GetFunctionConfigurationRequest request)
AWSLambda
Returns the configuration information of the Lambda function. This the same information you provided as parameters when uploading the function by using CreateFunction.
If you are using the versioning feature, you can retrieve this information for a specific function version by
using the optional Qualifier
parameter and specifying the function version or alias that points to
it. If you don't provide it, the API returns information about the $LATEST version of the function. For more
information about versioning, see AWS Lambda Function Versioning and
Aliases.
This operation requires permission for the lambda:GetFunctionConfiguration
operation.
getFunctionConfiguration
in interface AWSLambda
public GetPolicyResult getPolicy(GetPolicyRequest request)
AWSLambda
Returns the resource policy associated with the specified Lambda function.
If you are using the versioning feature, you can get the resource policy associated with the specific Lambda
function version or alias by specifying the version or alias name using the Qualifier
parameter. For
more information about versioning, see AWS Lambda Function Versioning and
Aliases.
You need permission for the lambda:GetPolicy action.
getPolicy
in interface AWSLambda
public InvokeResult invoke(InvokeRequest request)
AWSLambda
Invokes a specific Lambda function. For an example, see Create the Lambda Function and Test It Manually.
If you are using the versioning feature, you can invoke the specific function version by providing function
version or alias name that is pointing to the function version using the Qualifier
parameter in the
request. If you don't provide the Qualifier
parameter, the $LATEST
version of the
Lambda function is invoked. Invocations occur at least once in response to an event and functions must be
idempotent to handle this. For information about the versioning feature, see AWS Lambda Function Versioning and
Aliases.
This operation requires permission for the lambda:InvokeFunction
action.
invoke
in interface AWSLambda
@Deprecated public InvokeAsyncResult invokeAsync(InvokeAsyncRequest request)
AWSLambda
This API is deprecated. We recommend you use Invoke
API (see Invoke).
Submits an invocation request to AWS Lambda. Upon receiving the request, Lambda executes the specified function asynchronously. To see the logs generated by the Lambda function execution, see the CloudWatch Logs console.
This operation requires permission for the lambda:InvokeFunction
action.
invokeAsync
in interface AWSLambda
public ListAliasesResult listAliases(ListAliasesRequest request)
AWSLambda
Returns list of aliases created for a Lambda function. For each alias, the response includes information such as the alias ARN, description, alias name, and the function version to which it points. For more information, see Introduction to AWS Lambda Aliases.
This requires permission for the lambda:ListAliases action.
listAliases
in interface AWSLambda
public ListEventSourceMappingsResult listEventSourceMappings(ListEventSourceMappingsRequest request)
AWSLambda
Returns a list of event source mappings you created using the CreateEventSourceMapping
(see
CreateEventSourceMapping).
For each mapping, the API returns configuration information. You can optionally specify filters to retrieve specific event source mappings.
If you are using the versioning feature, you can get list of event source mappings for a specific Lambda function
version or an alias as described in the FunctionName
parameter. For information about the versioning
feature, see AWS Lambda Function
Versioning and Aliases.
This operation requires permission for the lambda:ListEventSourceMappings
action.
listEventSourceMappings
in interface AWSLambda
public ListEventSourceMappingsResult listEventSourceMappings()
AWSLambda
listEventSourceMappings
in interface AWSLambda
AWSLambda.listEventSourceMappings(ListEventSourceMappingsRequest)
public ListFunctionsResult listFunctions(ListFunctionsRequest request)
AWSLambda
Returns a list of your Lambda functions. For each function, the response includes the function configuration information. You must use GetFunction to retrieve the code for your function.
This operation requires permission for the lambda:ListFunctions
action.
If you are using the versioning feature, you can list all of your functions or only $LATEST
versions. For information about the versioning feature, see AWS Lambda Function Versioning and
Aliases.
listFunctions
in interface AWSLambda
public ListFunctionsResult listFunctions()
AWSLambda
listFunctions
in interface AWSLambda
AWSLambda.listFunctions(ListFunctionsRequest)
public ListTagsResult listTags(ListTagsRequest request)
AWSLambda
Returns a list of tags assigned to a function when supplied the function ARN (Amazon Resource Name).
listTags
in interface AWSLambda
public ListVersionsByFunctionResult listVersionsByFunction(ListVersionsByFunctionRequest request)
AWSLambda
List all versions of a function. For information about the versioning feature, see AWS Lambda Function Versioning and Aliases.
listVersionsByFunction
in interface AWSLambda
public PublishVersionResult publishVersion(PublishVersionRequest request)
AWSLambda
Publishes a version of your function from the current snapshot of $LATEST. That is, AWS Lambda takes a snapshot of the function code and configuration information from $LATEST and publishes a new version. The code and configuration cannot be modified after publication. For information about the versioning feature, see AWS Lambda Function Versioning and Aliases.
publishVersion
in interface AWSLambda
public RemovePermissionResult removePermission(RemovePermissionRequest request)
AWSLambda
You can remove individual permissions from an resource policy associated with a Lambda function by providing a statement ID that you provided when you added the permission.
If you are using versioning, the permissions you remove are specific to the Lambda function version or alias you
specify in the AddPermission
request via the Qualifier
parameter. For more information
about versioning, see AWS Lambda
Function Versioning and Aliases.
Note that removal of a permission will cause an active event source to lose permission to the function.
You need permission for the lambda:RemovePermission
action.
removePermission
in interface AWSLambda
public TagResourceResult tagResource(TagResourceRequest request)
AWSLambda
Creates a list of tags (key-value pairs) on the Lambda function. Requires the Lambda function ARN (Amazon Resource Name). If a key is specified without a value, Lambda creates a tag with the specified key and a value of null.
tagResource
in interface AWSLambda
public UntagResourceResult untagResource(UntagResourceRequest request)
AWSLambda
Removes tags from a Lambda function. Requires the function ARN (Amazon Resource Name).
untagResource
in interface AWSLambda
public UpdateAliasResult updateAlias(UpdateAliasRequest request)
AWSLambda
Using this API you can update the function version to which the alias points and the alias description. For more information, see Introduction to AWS Lambda Aliases.
This requires permission for the lambda:UpdateAlias action.
updateAlias
in interface AWSLambda
public UpdateEventSourceMappingResult updateEventSourceMapping(UpdateEventSourceMappingRequest request)
AWSLambda
You can update an event source mapping. This is useful if you want to change the parameters of the existing mapping without losing your position in the stream. You can change which function will receive the stream records, but to change the stream itself, you must create a new mapping.
If you are using the versioning feature, you can update the event source mapping to map to a specific Lambda
function version or alias as described in the FunctionName
parameter. For information about the
versioning feature, see AWS Lambda
Function Versioning and Aliases.
If you disable the event source mapping, AWS Lambda stops polling. If you enable again, it will resume polling from the time it had stopped polling, so you don't lose processing of any records. However, if you delete event source mapping and create it again, it will reset.
This operation requires permission for the lambda:UpdateEventSourceMapping
action.
updateEventSourceMapping
in interface AWSLambda
public UpdateFunctionCodeResult updateFunctionCode(UpdateFunctionCodeRequest request)
AWSLambda
Updates the code for the specified Lambda function. This operation must only be used on an existing Lambda function and cannot be used to update the function configuration.
If you are using the versioning feature, note this API will always update the $LATEST version of your Lambda function. For information about the versioning feature, see AWS Lambda Function Versioning and Aliases.
This operation requires permission for the lambda:UpdateFunctionCode
action.
updateFunctionCode
in interface AWSLambda
public UpdateFunctionConfigurationResult updateFunctionConfiguration(UpdateFunctionConfigurationRequest request)
AWSLambda
Updates the configuration parameters for the specified Lambda function by using the values provided in the request. You provide only the parameters you want to change. This operation must only be used on an existing Lambda function and cannot be used to update the function's code.
If you are using the versioning feature, note this API will always update the $LATEST version of your Lambda function. For information about the versioning feature, see AWS Lambda Function Versioning and Aliases.
This operation requires permission for the lambda:UpdateFunctionConfiguration
action.
updateFunctionConfiguration
in interface AWSLambda
public void shutdown()
AWSLambda
public ResponseMetadata getCachedResponseMetadata(AmazonWebServiceRequest request)
AWSLambda
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.
getCachedResponseMetadata
in interface AWSLambda
request
- The originally executed request.Copyright © 2013 Amazon Web Services, Inc. All Rights Reserved.