Current section

Files

Jump to
aws lib aws lambda.ex
Raw

lib/aws/lambda.ex

# WARNING: DO NOT EDIT, AUTO-GENERATED CODE!
# See https://github.com/jkakar/aws-codegen for more details.
defmodule AWS.Lambda do
@moduledoc """
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](http://docs.aws.amazon.com/lambda/latest/dg/welcome.html), and
for information about how the service works, go to [AWS Lambda: How it
Works](http://docs.aws.amazon.com/lambda/latest/dg/lambda-introduction.html)
in the *AWS Lambda Developer Guide*.
"""
@doc """
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 "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](http://docs.aws.amazon.com/lambda/latest/dg/lambda-introduction.html).
If you are using versioning feature (see [AWS Lambda Function Versioning
and
Aliases](http://docs.aws.amazon.com/lambda/latest/dg/versioning-aliases-v2.html)),
a Lambda function can have multiple ARNs that can be used to invoke the
function. Note that, each permission you add to resource policy using this
API is specific to an ARN, specified using the `Qualifier` parameter
This operation requires permission for the `lambda:AddPermission` action.
"""
def add_permission(client, function_name, input, options \\ []) do
url = "/2015-03-31/functions/#{URI.encode(function_name)}/policy"
headers = []
request(client, :post, url, headers, input, options, 201)
end
@doc """
Creates an alias to the specified Lambda function version. For more
information, see [Introduction to AWS Lambda
Aliases](http://docs.aws.amazon.com/lambda/latest/dg/versioning-v2-intro-aliases.html)
This requires permission for the lambda:CreateAlias action.
"""
def create_alias(client, function_name, input, options \\ []) do
url = "/2015-03-31/functions/#{URI.encode(function_name)}/aliases"
headers = []
request(client, :post, url, headers, input, options, 201)
end
@doc """
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 is the pull model, where AWS Lambda invokes the function. For more
information, go to [AWS Lambda: How it
Works](http://docs.aws.amazon.com/lambda/latest/dg/lambda-introduction.html)
in the *AWS Lambda Developer Guide*.
This association between an Amazon Kinesis stream and a Lambda function is
called the event source mapping. You provide the configuration information
(for example, which stream to read from and which Lambda function to
invoke) for the event source mapping 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.
This operation requires permission for the
`lambda:CreateEventSourceMapping` action.
"""
def create_event_source_mapping(client, input, options \\ []) do
url = "/2015-03-31/event-source-mappings"
headers = []
request(client, :post, url, headers, input, options, 202)
end
@doc """
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.
This operation requires permission for the `lambda:CreateFunction` action.
"""
def create_function(client, input, options \\ []) do
url = "/2015-03-31/functions"
headers = []
request(client, :post, url, headers, input, options, 201)
end
@doc """
Deletes specified Lambda function alias. For more information, see
[Introduction to AWS Lambda
Aliases](http://docs.aws.amazon.com/lambda/latest/dg/versioning-v2-intro-aliases.html)
This requires permission for the lambda:DeleteAlias action.
"""
def delete_alias(client, function_name, name, input, options \\ []) do
url = "/2015-03-31/functions/#{URI.encode(function_name)}/aliases/#{URI.encode(name)}"
headers = []
request(client, :delete, url, headers, input, options, 204)
end
@doc """
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.
"""
def delete_event_source_mapping(client, uuid, input, options \\ []) do
url = "/2015-03-31/event-source-mappings/#{URI.encode(uuid)}"
headers = []
request(client, :delete, url, headers, input, options, 202)
end
@doc """
Deletes the specified Lambda function code and configuration.
If you don't specify a function version, AWS Lambda will delete the
function, including all its versions, and any aliases pointing to the
function versions.
When you delete a function the associated resource policy is also deleted.
You will need to delete the event source mappings explicitly.
For information about function versioning, see [AWS Lambda Function
Versioning and
Aliases](http://docs.aws.amazon.com/lambda/latest/dg/versioning-aliases-v2.html).
This operation requires permission for the `lambda:DeleteFunction` action.
"""
def delete_function(client, function_name, input, options \\ []) do
url = "/2015-03-31/functions/#{URI.encode(function_name)}"
headers = []
request(client, :delete, url, headers, input, options, 204)
end
@doc """
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](http://docs.aws.amazon.com/lambda/latest/dg/versioning-v2-intro-aliases.html)
This requires permission for the lambda:GetAlias action.
"""
def get_alias(client, function_name, name, options \\ []) do
url = "/2015-03-31/functions/#{URI.encode(function_name)}/aliases/#{URI.encode(name)}"
headers = []
request(client, :get, url, headers, nil, options, 200)
end
@doc """
Returns configuration information for the specified event source mapping
(see `CreateEventSourceMapping`).
This operation requires permission for the `lambda:GetEventSourceMapping`
action.
"""
def get_event_source_mapping(client, uuid, options \\ []) do
url = "/2015-03-31/event-source-mappings/#{URI.encode(uuid)}"
headers = []
request(client, :get, url, headers, nil, options, 200)
end
@doc """
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](http://docs.aws.amazon.com/lambda/latest/dg/versioning-aliases-v2.html).
This operation requires permission for the `lambda:GetFunction` action.
"""
def get_function(client, function_name, options \\ []) do
url = "/2015-03-31/functions/#{URI.encode(function_name)}"
headers = []
request(client, :get, url, headers, nil, options, 200)
end
@doc """
Returns the configuration information of the Lambda function. This the same
information you provided as parameters when uploading the function by using
`CreateFunction`.
You can use the optional `Qualifier` parameter to retrieve configuration
information for a specific Lambda function version. 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](http://docs.aws.amazon.com/lambda/latest/dg/versioning-aliases-v2.html).
This operation requires permission for the
`lambda:GetFunctionConfiguration` operation.
"""
def get_function_configuration(client, function_name, options \\ []) do
url = "/2015-03-31/functions/#{URI.encode(function_name)}/configuration"
headers = []
request(client, :get, url, headers, nil, options, 200)
end
@doc """
Returns the resource policy, containing a list of permissions that apply to
a specific to an ARN that you specify via the `Qualifier` paramter.
For informration about adding permissions, see `AddPermission`.
You need permission for the `lambda:GetPolicy action.`
"""
def get_policy(client, function_name, options \\ []) do
url = "/2015-03-31/functions/#{URI.encode(function_name)}/policy"
headers = []
request(client, :get, url, headers, nil, options, 200)
end
@doc """
Invokes a specific Lambda function version.
If you don't provide the `Qualifier` parameter, it uses the unqualified
function ARN which results in invocation of the $LATEST version of the
Lambda function (when you create a Lambda function, the $LATEST is the
version). The AWS Lambda versioning and aliases feature allows you to
publish multiple versions of a Lambda function and also create aliases for
each function version. So each your Lambda function version can be invoked
using multiple ARNs. For more information, see [AWS Lambda Function
Versioning and
Aliases](http://docs.aws.amazon.com/lambda/latest/dg/versioning-aliases-v2.html).
Using the `Qualifier` parameter, you can specify a function version or
alias name to invoke specific function version. If you specify function
version, the API uses the qualified function ARN to invoke a specific
function version. If you specify alias name, the API uses the alias ARN to
invoke the function version to which the alias points.
This operation requires permission for the `lambda:InvokeFunction` action.
"""
def invoke(client, function_name, input, options \\ []) do
url = "/2015-03-31/functions/#{URI.encode(function_name)}/invocations"
headers = []
if Dict.has_key?(input, "ClientContext") do
headers = [{"ClientContext", input["ClientContext"]}|headers]
input = Dict.delete(input, "ClientContext")
end
if Dict.has_key?(input, "InvocationType") do
headers = [{"InvocationType", input["InvocationType"]}|headers]
input = Dict.delete(input, "InvocationType")
end
if Dict.has_key?(input, "LogType") do
headers = [{"LogType", input["LogType"]}|headers]
input = Dict.delete(input, "LogType")
end
case request(client, :post, url, headers, input, options, nil) do
{:ok, body, response} ->
if !is_nil(response.headers["FunctionError"]) do
body = %{body | "FunctionError" => response.headers["FunctionError"]}
end
if !is_nil(response.headers["LogResult"]) do
body = %{body | "LogResult" => response.headers["LogResult"]}
end
{:ok, body, response}
result ->
result
end
end
@doc """
<important>This API is deprecated. We recommend you use `Invoke` API (see
`Invoke`).</important> 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.
"""
def invoke_async(client, function_name, input, options \\ []) do
url = "/2014-11-13/functions/#{URI.encode(function_name)}/invoke-async"
headers = []
request(client, :post, url, headers, input, options, 202)
end
@doc """
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](http://docs.aws.amazon.com/lambda/latest/dg/versioning-v2-intro-aliases.html)
This requires permission for the lambda:ListAliases action.
"""
def list_aliases(client, function_name, options \\ []) do
url = "/2015-03-31/functions/#{URI.encode(function_name)}/aliases"
headers = []
request(client, :get, url, headers, nil, options, 200)
end
@doc """
Returns a list of event source mappings you created using the
`CreateEventSourceMapping` (see `CreateEventSourceMapping`), where you
identify a stream as an event source. This list does not include Amazon S3
event sources.
For each mapping, the API returns configuration information. You can
optionally specify filters to retrieve specific event source mappings.
This operation requires permission for the `lambda:ListEventSourceMappings`
action.
"""
def list_event_source_mappings(client, options \\ []) do
url = "/2015-03-31/event-source-mappings"
headers = []
request(client, :get, url, headers, nil, options, 200)
end
@doc """
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.
"""
def list_functions(client, options \\ []) do
url = "/2015-03-31/functions"
headers = []
request(client, :get, url, headers, nil, options, 200)
end
@doc """
List all versions of a function.
"""
def list_versions_by_function(client, function_name, options \\ []) do
url = "/2015-03-31/functions/#{URI.encode(function_name)}/versions"
headers = []
request(client, :get, url, headers, nil, options, 200)
end
@doc """
Publishes a version of your function from the current snapshot of HEAD.
That is, AWS Lambda takes a snapshot of the function code and configuration
information from HEAD and publishes a new version. The code and `handler`
of this specific Lambda function version cannot be modified after
publication, but you can modify the configuration information.
"""
def publish_version(client, function_name, input, options \\ []) do
url = "/2015-03-31/functions/#{URI.encode(function_name)}/versions"
headers = []
request(client, :post, url, headers, input, options, 201)
end
@doc """
You can remove individual permissions from an resource policy associated
with a Lambda function by providing a statement ID that you provided when
you addded the permission. The API removes corresponding permission that is
associated with the specific ARN identified by the `Qualifier` parameter.
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.
"""
def remove_permission(client, function_name, statement_id, input, options \\ []) do
url = "/2015-03-31/functions/#{URI.encode(function_name)}/policy/#{URI.encode(statement_id)}"
headers = []
request(client, :delete, url, headers, input, options, 204)
end
@doc """
Using this API you can update function version to which the alias points to
and alias description. For more information, see [Introduction to AWS
Lambda
Aliases](http://docs.aws.amazon.com/lambda/latest/dg/versioning-v2-intro-aliases.html)
This requires permission for the lambda:UpdateAlias action.
"""
def update_alias(client, function_name, name, input, options \\ []) do
url = "/2015-03-31/functions/#{URI.encode(function_name)}/aliases/#{URI.encode(name)}"
headers = []
request(client, :put, url, headers, input, options, 200)
end
@doc """
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.
This operation requires permission for the
`lambda:UpdateEventSourceMapping` action.
"""
def update_event_source_mapping(client, uuid, input, options \\ []) do
url = "/2015-03-31/event-source-mappings/#{URI.encode(uuid)}"
headers = []
request(client, :put, url, headers, input, options, 202)
end
@doc """
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.
This operation requires permission for the `lambda:UpdateFunctionCode`
action.
"""
def update_function_code(client, function_name, input, options \\ []) do
url = "/2015-03-31/functions/#{URI.encode(function_name)}/code"
headers = []
request(client, :put, url, headers, input, options, 200)
end
@doc """
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.
This operation requires permission for the
`lambda:UpdateFunctionConfiguration` action.
"""
def update_function_configuration(client, function_name, input, options \\ []) do
url = "/2015-03-31/functions/#{URI.encode(function_name)}/configuration"
headers = []
request(client, :put, url, headers, input, options, 200)
end
defp request(client, method, url, headers, input, options, success_status_code) do
client = %{client | service: "lambda"}
host = get_host("lambda", client)
url = get_url(host, url, client)
headers = Enum.concat([{"Host", host},
{"Content-Type", "application/x-amz-json-1.1"}],
headers)
payload = encode_payload(input)
headers = AWS.Request.sign_v4(client, method, url, headers, payload)
perform_request(method, url, payload, headers, options, success_status_code)
end
defp perform_request(method, url, payload, headers, options, nil) do
case HTTPoison.request(method, url, payload, headers, options) do
{:ok, response=%HTTPoison.Response{status_code: 200, body: ""}} ->
{:ok, response}
{:ok, response=%HTTPoison.Response{status_code: 200, body: body}} ->
{:ok, Poison.Parser.parse!(body), response}
{:ok, response=%HTTPoison.Response{status_code: 202, body: body}} ->
{:ok, Poison.Parser.parse!(body), response}
{:ok, response=%HTTPoison.Response{status_code: 204, body: body}} ->
{:ok, Poison.Parser.parse!(body), response}
{:ok, _response=%HTTPoison.Response{body: body}} ->
reason = Poison.Parser.parse!(body)["message"]
{:error, reason}
{:error, %HTTPoison.Error{reason: reason}} ->
{:error, %HTTPoison.Error{reason: reason}}
end
end
defp perform_request(method, url, payload, headers, options, success_status_code) do
case HTTPoison.request(method, url, payload, headers, options) do
{:ok, response=%HTTPoison.Response{status_code: ^success_status_code, body: ""}} ->
{:ok, nil, response}
{:ok, response=%HTTPoison.Response{status_code: ^success_status_code, body: body}} ->
{:ok, Poison.Parser.parse!(body), response}
{:ok, _response=%HTTPoison.Response{body: body}} ->
reason = Poison.Parser.parse!(body)["message"]
{:error, reason}
{:error, %HTTPoison.Error{reason: reason}} ->
{:error, %HTTPoison.Error{reason: reason}}
end
end
defp get_host(endpoint_prefix, client) do
if client.region == "local" do
"localhost"
else
"#{endpoint_prefix}.#{client.region}.#{client.endpoint}"
end
end
defp get_url(host, url, %{:proto => proto, :port => port}) do
"#{proto}://#{host}:#{port}#{url}/"
end
defp encode_payload(input) do
if input != nil do
Poison.Encoder.encode(input, [])
else
""
end
end
end