amazon.aws.lambda_layer_info module – List lambda layer or lambda layer versions
Note
This module is part of the amazon.aws collection (version 7.5.0).
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_layer_info.
New in amazon.aws 5.5.0
Synopsis
This module is used to list the versions of an Lambda layer or all available lambda layers.
The lambda layer versions that have been deleted aren’t listed.
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. |
|
A compatible instruction set architectures. Specify this option without name to include only to list only latest layers versions of layers that are compatible with that instruction set architecture. Specify this option with name to include only layer versions that are compatible with that architecture. |
|
A runtime identifier. Specify this option without name to list only latest layers versions of layers that indicate that they’re compatible with that runtime. Specify this option with name to list only layer versions that indicate that they’re compatible with that runtime. |
|
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 |
|
The name or Amazon Resource Name (ARN) of the Lambda layer. |
|
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. |
|
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:
|
|
The Lambda layer version number to retrieve. Requires name to be provided. |
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
---
# Display information about the versions for the layer named blank-java-lib
- name: Retrieve layer versions
amazon.aws.lambda_layer_info:
name: blank-java-lib
# Display information about the versions for the layer named blank-java-lib compatible with architecture x86_64
- name: Retrieve layer versions
amazon.aws.lambda_layer_info:
name: blank-java-lib
compatible_architecture: x86_64
# list latest versions of available layers
- name: list latest versions for all layers
amazon.aws.lambda_layer_info:
# list latest versions of available layers compatible with runtime python3.7
- name: list latest versions for all layers
amazon.aws.lambda_layer_info:
compatible_runtime: python3.7
# Retrieve specific lambda layer information
- name: Get lambda layer version information
amazon.aws.lambda_layer_info:
name: my-layer
version_number: 1
Return Values
Common return values are documented here, the following are the fields unique to this module:
Key |
Description |
|---|---|
The layers versions that exists. Returned: success |
|
A list of compatible instruction set architectures. Returned: if it was defined for the layer version. |
|
A list of compatible runtimes. Returned: if it was defined for the layer version. Sample: |
|
Details about the layer version. Returned: if version_number was provided |
|
The SHA-256 hash of the layer archive. Returned: success Sample: |
|
The size of the layer archive in bytes. Returned: success Sample: |
|
A link to the layer archive in Amazon S3 that is valid for 10 minutes. Returned: success Sample: |
|
The Amazon Resource Name (ARN) of a signing job. Returned: success |
|
The Amazon Resource Name (ARN) for a signing profile version. Returned: success |
|
The date that the layer version was created, in ISO-8601 format (YYYY-MM-DDThh:mm:ss.sTZD). Returned: if the layer version exists or has been created Sample: |
|
The description of the version. Returned: state=present |
|
The ARN of the layer. Returned: when Sample: |
|
The ARN of the layer version. Returned: if the layer version exists or has been created Sample: |
|
The layer’s software license. Returned: if it was defined for the layer version. Sample: |
|
The version number. Returned: if the layer version exists or has been created Sample: |