W3cubDocs

/Ansible

execute_lambda - Execute an AWS Lambda function

New in version 2.2.

Synopsis

  • This module executes AWS Lambda functions, allowing synchronous and asynchronous invocation.

Requirements (on host that executes module)

  • boto
  • boto3
  • python >= 2.6

Options

parameter required default choices comments
aws_access_key
 no
AWS access key. If not set then the value of the AWS_ACCESS_KEY_ID, AWS_ACCESS_KEY or EC2_ACCESS_KEY environment variable is used.
aliases: ec2_access_key, access_key
aws_secret_key
 no
AWS secret key. If not set then the value of the AWS_SECRET_ACCESS_KEY, AWS_SECRET_KEY, or EC2_SECRET_KEY environment variable is used.
aliases: ec2_secret_key, secret_key
dry_run
 no
Do not *actually* invoke the function. A DryRun call will check that the caller has permissions to call the function, especially for checking cross-account permissions.
ec2_url
 no
Url to use to connect to EC2 or your Eucalyptus cloud (by default the module will use EC2 endpoints). Ignored for modules where region is required. Must be specified for all other modules if region is not used. If not set then the value of the EC2_URL environment variable, if any, is used.
function_arn
 no None
The name of the function to be invoked
name
 no None
The name of the function to be invoked. This can only be used for invocations within the calling account. To invoke a function in another account, use function_arn to specify the full ARN.
payload
 no
A dictionary in any form to be provided as input to the Lambda function.
profile
(added in 1.6)
 no
Uses a boto profile. Only works with boto >= 2.24.0.
security_token
(added in 1.6)
 no
AWS STS security token. If not set then the value of the AWS_SECURITY_TOKEN or EC2_SECURITY_TOKEN environment variable is used.
aliases: access_token
tail_log
 no
If tail_log=true, the result of the task will include the last 4 KB of the CloudWatch log for the function execution. Log tailing only works if you use synchronous invocation wait=true. This is usually used for development or testing Lambdas.
validate_certs
(added in 1.5)
 no yes
  • yes
  • no
When set to "no", SSL certificates will not be validated for boto versions >= 2.6.0.
version_qualifier
 no LATEST
Which version/alias of the function to run. This defaults to the LATEST revision, but can be set to any existing version or alias. See https;//docs.aws.amazon.com/lambda/latest/dg/versioning-aliases.html for details.
wait
 no True
Whether to wait for the function results or not. If wait is false, the task will not return any results. To wait for the Lambda function to complete, set wait=true and the result will be available in the output key.

Examples

- execute_lambda:
    name: test-function
    # the payload is automatically serialized and sent to the function
    payload:
      foo: bar
      value: 8
  register: response

# Test that you have sufficient permissions to execute a Lambda function in
# another account
- execute_lambda:
    function_arn: arn:aws:lambda:us-east-1:123456789012:function/some-function
    dry_run: true

- execute_lambda:
    name: test-function
    payload:
      foo: bar
      value: 8
    wait: true
    tail_log: true
  register: response
  # the response will have a `logs` key that will contain a log (up to 4KB) of the function execution in Lambda.

- execute_lambda:
    name: test-function
    version_qualifier: PRODUCTION

Return Values

Common return values are documented here Return Values, the following are the fields unique to this module:

name description returned type sample
status
StatusCode of API call exit (200 for synchronous invokes, 202 for async)
 always int 200
output
Function output if wait=true and the function returns a value
 success dict { 'output': 'something' }
logs
The last 4KB of the function logs. Only provided if tail_log is true
 if I(tail_log) == true string

Notes

Note

  • Async invocation will always return an empty output key.
  • Synchronous invocation may result in a function timeout, resulting in an empty output key.
  • If parameters are not set within the module, the following environment variables can be used in decreasing order of precedence AWS_URL or EC2_URL, AWS_ACCESS_KEY_ID or AWS_ACCESS_KEY or EC2_ACCESS_KEY, AWS_SECRET_ACCESS_KEY or AWS_SECRET_KEY or EC2_SECRET_KEY, AWS_SECURITY_TOKEN or EC2_SECURITY_TOKEN, AWS_REGION or EC2_REGION
  • Ansible uses the boto configuration file (typically ~/.boto) if no credentials are provided. See http://boto.readthedocs.org/en/latest/boto_config_tut.html
  • AWS_REGION or EC2_REGION can be typically be used to specify the AWS region, when required, but this can also be configured in the boto config file

Status

This module is flagged as preview which means that it is not guaranteed to have a backwards compatible interface.

For help in developing on modules, should you be so inclined, please read Community Information & Contributing, Testing Ansible and Developing Modules.

© 2012–2017 Michael DeHaan
© 2017 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/latest/execute_lambda_module.html