aws-elixir v0.1.0 AWS.Lambda
AWS Lambda
Overview
This is the AWS Lambda API Reference. The AWS Lambda Developer Guide provides additional information. For the service overview, go to What is AWS Lambda, and for information about how the service works, go to AWS Lambda: How it Works in the AWS Lambda Developer Guide.
Summary
Functions
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
Creates an alias that points to the specified Lambda function version. For more information, see Introduction to AWS Lambda Aliases
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
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
Deletes the specified Lambda function alias. For more information, see Introduction to AWS Lambda Aliases
Removes an event source mapping. This means AWS Lambda will no longer invoke the function for events in the associated source
Deletes the specified Lambda function code and configuration
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
Returns configuration information for the specified event source mapping
(see CreateEventSourceMapping
)
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
Returns the configuration information of the Lambda function. This the same
information you provided as parameters when uploading the function by using
CreateFunction
Returns the resource policy associated with the specified Lambda function
Invokes a specific Lambda function
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
Returns a list of event source mappings you created using the
CreateEventSourceMapping
(see CreateEventSourceMapping
)
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
List all versions of a function. For information about the versioning feature, see AWS Lambda Function Versioning and Aliases
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
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
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
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
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
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
Functions
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.
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.
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.
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.
Deletes the specified Lambda function alias. For more information, see Introduction to AWS Lambda Aliases.
This requires permission for the lambda:DeleteAlias action.
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.
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.
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.
Returns configuration information for the specified event source mapping
(see CreateEventSourceMapping
).
This operation requires permission for the lambda:GetEventSourceMapping
action.
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.
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.
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.
For information about adding permissions, see AddPermission
.
You need permission for the lambda:GetPolicy action.
Invokes a specific Lambda function.
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. For information about the
versioning feature, see AWS Lambda Function Versioning and
Aliases.
This operation requires permission for the lambda:InvokeFunction
action.
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.
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.
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 versioning feature, the response returns list of $LATEST versions of your functions. For information about the versioning feature, see AWS Lambda Function Versioning and Aliases.
List all versions of a function. For information about the versioning feature, see AWS Lambda Function Versioning and Aliases.
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.
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.
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.
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.
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.
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.