amazon.aws.lambda_info module – Gathers AWS Lambda function details
Note
This module is part of the amazon.aws collection (version 8.2.1).
You might already have this collection installed if you are using the ansible package.
It is not included in ansible-core.
To check whether it is installed, run ansible-galaxy collection list.
To install it, use: ansible-galaxy collection install amazon.aws.
You need further requirements to be able to use this module,
see Requirements for details.
To use it in a playbook, specify: amazon.aws.lambda_info.
New in amazon.aws 5.0.0
Synopsis
Gathers various details related to Lambda functions, including aliases, versions and event source mappings.
Use module amazon.aws.lambda to manage the lambda function itself, amazon.aws.lambda_alias to manage function aliases, amazon.aws.lambda_event to manage lambda event source mappings, and amazon.aws.lambda_policy to manage policy statements.
This module was originally added to
community.awsin release 1.0.0.
Requirements
The below requirements are needed on the host that executes this module.
python >= 3.6
boto3 >= 1.26.0
botocore >= 1.29.0
Parameters
Parameter |
Comments |
|---|---|
AWS access key ID. See the AWS documentation for more information about access tokens https://docs.aws.amazon.com/general/latest/gr/aws-sec-cred-types.html#access-keys-and-secret-access-keys. The The aws_access_key and profile options are mutually exclusive. The aws_access_key_id alias was added in release 5.1.0 for consistency with the AWS botocore SDK. The ec2_access_key alias has been deprecated and will be removed in a release after 2024-12-01. Support for the |
|
The location of a CA Bundle to use when validating SSL certificates. The |
|
A dictionary to modify the botocore configuration. Parameters can be found in the AWS documentation https://botocore.amazonaws.com/v1/documentation/api/latest/reference/config.html#botocore.config.Config. |
|
Use a The Choices:
|
|
URL to connect to instead of the default AWS endpoints. While this can be used to connection to other AWS-compatible services the amazon.aws and community.aws collections are only tested against AWS. The The ec2_url and s3_url aliases have been deprecated and will be removed in a release after 2024-12-01. Support for the |
|
When |
|
The name of the lambda function for which information is requested. |
|
A named AWS profile to use for authentication. See the AWS documentation for more information about named profiles https://docs.aws.amazon.com/cli/latest/userguide/cli-configure-profiles.html. The The profile option is mutually exclusive with the aws_access_key, aws_secret_key and security_token options. |
|
Specifies the resource type for which to gather information. Defaults to Defaults to Choices:
|
|
The AWS region to use. For global services such as IAM, Route53 and CloudFront, region is ignored. The See the Amazon AWS documentation for more information http://docs.aws.amazon.com/general/latest/gr/rande.html#ec2_region. The Support for the |
|
AWS secret access key. See the AWS documentation for more information about access tokens https://docs.aws.amazon.com/general/latest/gr/aws-sec-cred-types.html#access-keys-and-secret-access-keys. The The secret_key and profile options are mutually exclusive. The aws_secret_access_key alias was added in release 5.1.0 for consistency with the AWS botocore SDK. The ec2_secret_key alias has been deprecated and will be removed in a release after 2024-12-01. Support for the |
|
AWS STS session token for use with temporary credentials. See the AWS documentation for more information about access tokens https://docs.aws.amazon.com/general/latest/gr/aws-sec-cred-types.html#access-keys-and-secret-access-keys. The The security_token and profile options are mutually exclusive. Aliases aws_session_token and session_token were added in release 3.2.0, with the parameter being renamed from security_token to session_token in release 6.0.0. The security_token, aws_security_token, and access_token aliases have been deprecated and will be removed in a release after 2024-12-01. Support for the |
|
When set to Setting validate_certs=false is strongly discouraged, as an alternative, consider setting aws_ca_bundle instead. Choices:
|
Notes
Note
Caution: For modules, environment variables and configuration files are read from the Ansible ‘host’ context and not the ‘controller’ context. As such, files may need to be explicitly copied to the ‘host’. For lookup and connection plugins, environment variables and configuration files are read from the Ansible ‘controller’ context and not the ‘host’ context.
The AWS SDK (boto3) that Ansible uses may also read defaults for credentials and other settings, such as the region, from its configuration files in the Ansible ‘host’ context (typically
~/.aws/credentials). See https://boto3.amazonaws.com/v1/documentation/api/latest/guide/credentials.html for more information.
Examples
---
# Simple example of listing all info for a function
- name: List all for a specific function
amazon.aws.lambda_info:
query: all
function_name: myFunction
register: my_function_details
# List all versions of a function
- name: List function versions
amazon.aws.lambda_info:
query: versions
function_name: myFunction
register: my_function_versions
# List all info for all functions
- name: List all functions
amazon.aws.lambda_info:
query: all
register: output
- name: show Lambda information
ansible.builtin.debug:
msg: "{{ output['function'] }}"
Return Values
Common return values are documented here, the following are the fields unique to this module:
Key |
Description |
|---|---|
Lambda function list.
Returned: success |
|
Lambda function information, including event, mapping, and version information.
Returned: success |
|
List of information for each lambda function matching the query. Returned: always |
|
The aliases associated with the function. Returned: when |
|
The architectures supported by the function. Returned: success Sample: |
|
The SHA256 hash of the function’s deployment package. Returned: success Sample: |
|
The size of the function’s deployment package in bytes. Returned: success Sample: |
|
The function’s dead letter queue. Returned: when the function has a dead letter queue configured Sample: |
|
The ARN of an SQS queue or SNS topic. Returned: when the function has a dead letter queue configured Sample: |
|
The function’s description. Returned: success Sample: |
|
The function’s environment variables. Returned: when environment variables exist |
|
Error message for environment variables that could not be applied. Returned: when there is an error applying environment variables |
|
The error code. Returned: when there is an error applying environment variables |
|
The error message. Returned: when there is an error applying environment variables |
|
Environment variable key-value pairs. Returned: when environment variables exist Sample: |
|
The size of the function /tmp directory in MB. Returned: success |
|
The size of the function /tmp directory. Returned: always Sample: |
|
The function’s Amazon Resource Name (ARN). Returned: on success Sample: |
|
The function’s name. Returned: on success Sample: |
|
The function Lambda calls to begin executing your function. Returned: on success Sample: |
|
The date and time that the function was last updated, in ISO-8601 format (YYYY-MM-DDThh:mm:ssTZD). Returned: on success Sample: |
|
List of configuration information for each event source mapping. Returned: when |
|
The largest number of records that AWS Lambda will retrieve from the event source at the time of invoking the function. Returned: on success |
|
The ARN of the Amazon Kinesis or DyanmoDB stream that is the source of events. Returned: on success |
|
The Lambda function to invoke when AWS Lambda detects an event on the poll-based source. Returned: on success |
|
The UTC time string indicating the last time the event mapping was updated. Returned: on success |
|
The result of the last AWS Lambda invocation of your Lambda function. Returned: on success |
|
The state of the event source mapping. Returned: on success |
|
The reason the event source mapping is in its current state. Returned: on success |
|
The AWS Lambda assigned opaque identifier for the mapping. Returned: on success |
|
The memory allocated to the function. Returned: on success Sample: |
|
The type of deployment package. Returned: always Sample: |
|
The policy associated with the function. Returned: when |
|
The latest updated revision of the function or alias. Returned: on success Sample: |
|
The function’s execution role. Returned: on success Sample: |
|
The funtime environment for the Lambda function. Returned: on success Sample: |
|
The ARN of the runtime and any errors that occured. Returned: success |
|
The ARN of the runtime version you want the function to use. Returned: always Sample: |
|
Snapshot of the initialized execution environment when you publish a function version. Returned: success |
|
When set to Returned: always Sample: |
|
This element indicates whether SnapStart is activated for the specified function version. Returned: always Sample: |
|
The amount of time that Lambda allows a function to run before terminating it. Returned: on success Sample: |
|
The function’s AWS X-Ray tracing configuration. Returned: on success Sample: |
|
The tracing mode. Returned: on success Sample: |
|
The version of the Lambda function. Returned: on success Sample: |
|
List of Lambda function versions. Returned: when |
|
The function’s networking configuration. Returned: on success Sample: |