Модуль amazon.aws.lambda_execute — выполнение функции AWS Lambda

Примечание

Этот модуль входит в коллекцию amazon.aws (версия 11.3.0).

Возможно, эта коллекция уже установлена, если вы используете пакет ansible. Она не входит в ansible-core. Чтобы проверить, установлена ли она, выполните ansible-galaxy collection list.

Для установки используйте: ansible-galaxy collection install amazon.aws. Для использования этого модуля могут потребоваться дополнительные компоненты. Подробности см. в разделе Требования.

Чтобы использовать модуль в плейбуке, укажите: amazon.aws.lambda_execute.

Добавлено в amazon.aws 5.0.0

Краткое описание
Требования
Параметры
Примечания
Примеры
Возвращаемые значения

Краткое описание

Этот модуль выполняет функции AWS Lambda, поддерживая синхронный и асинхронный вызов.
До выпуска версии 5.0.0 этот модуль назывался community.aws.execute_lambda. Использование не изменилось.
Впервые этот модуль был добавлен в community.aws в версии 1.0.0.

Псевдонимы: execute_lambda

Требования

На узле, выполняющем этот модуль, должны быть установлены следующие компоненты.

python >= 3.6
boto3 >= 1.35.0
botocore >= 1.35.0

Параметры

Параметр	Комментарии
access_key псевдонимы: aws_access_key_id, aws_access_key строка	Идентификатор ключа доступа AWS. Дополнительные сведения о токенах доступа см. в документации AWS: https://docs.aws.amazon.com/general/latest/gr/aws-sec-cred-types.html#access-keys-and-secret-access-keys. Также можно использовать переменные среды `AWS_ACCESS_KEY_ID` или `AWS_ACCESS_KEY` (в порядке убывания приоритета). Параметры aws_access_key и profile являются взаимоисключающими. Псевдоним aws_access_key_id добавлен в версии 5.1.0 для согласованности с AWS botocore SDK.
aws_ca_bundle путь	Путь к пакету сертификатов CA, используемому для проверки SSL-сертификатов. Также можно использовать переменную среды `AWS_CA_BUNDLE`.
aws_config словарь	Словарь для изменения конфигурации botocore. Список параметров приведён в документации AWS: https://botocore.amazonaws.com/v1/documentation/api/latest/reference/config.html#botocore.config.Config.
debug_botocore_endpoint_logs логическое значение	Использовать регистратор `botocore.endpoint` для подсчёта уникальных (а не общего числа) вызовов API `"resource:action"`, выполненных во время задачи, и записывать их список в ключ resource_actions результатов задачи. Используйте обратный вызов `aws_resource_action`, чтобы вывести общий список вызовов, выполненных во время плейбука. Также можно использовать переменную среды `ANSIBLE_DEBUG_BOTOCORE_LOGS`. Варианты: `false` ← (по умолчанию) `true`
dry_run логическое значение	Не выполнять функцию фактически. Вызов `DryRun` проверит, есть ли у вызывающего права на вызов функции, в частности — права между учётными записями. Варианты: `false` ← (по умолчанию) `true`
endpoint_url псевдонимы: aws_endpoint_url строка	URL для подключения вместо конечных точек AWS по умолчанию. Его можно использовать для подключения к другим совместимым с AWS сервисам, однако коллекции amazon.aws и community.aws тестируются только с AWS. Также можно использовать переменную среды `AWS_URL`.
function_arn строка	Имя вызываемой функции.
name строка	Имя вызываемой функции. Этот параметр можно использовать только для вызовов в пределах вызывающей учётной записи. Чтобы вызвать функцию в другой учётной записи, используйте `function_arn`, указав полный ARN.
payload словарь	Словарь произвольной формы, передаваемый функции Lambda в качестве входных данных. По умолчанию: `{}`
profile псевдонимы: aws_profile строка	Именованный профиль AWS для аутентификации. Дополнительные сведения об именованных профилях см. в документации AWS: https://docs.aws.amazon.com/cli/latest/userguide/cli-configure-profiles.html. Также можно использовать переменную среды `AWS_PROFILE`. Параметр profile является взаимоисключающим с параметрами aws_access_key, aws_secret_key и session_token.
region псевдонимы: aws_region строка	Регион AWS для использования. Для глобальных сервисов, таких как IAM, Route53 и CloudFront, параметр region игнорируется. Также можно использовать переменную среды `AWS_REGION`. Дополнительные сведения см. в документации Amazon AWS: http://docs.aws.amazon.com/general/latest/gr/rande.html#ec2_region.
secret_key псевдонимы: aws_secret_access_key, aws_secret_key строка	Секретный ключ доступа AWS. Дополнительные сведения о токенах доступа см. в документации AWS: https://docs.aws.amazon.com/general/latest/gr/aws-sec-cred-types.html#access-keys-and-secret-access-keys. Также можно использовать переменные среды `AWS_SECRET_ACCESS_KEY` или `AWS_SECRET_KEY` (в порядке убывания приоритета). Параметры secret_key и profile являются взаимоисключающими. Псевдоним aws_secret_access_key добавлен в версии 5.1.0 для согласованности с AWS botocore SDK.
session_token псевдонимы: aws_session_token строка	Токен сеанса AWS STS для использования с временными учётными данными. Дополнительные сведения о токенах доступа см. в документации AWS: https://docs.aws.amazon.com/general/latest/gr/aws-sec-cred-types.html#access-keys-and-secret-access-keys. Также можно использовать переменную среды `AWS_SESSION_TOKEN`. Параметры session_token и profile являются взаимоисключающими.
tail_log логическое значение	Если `tail_log=true`, результат задачи будет содержать последние 4 КБ журнала CloudWatch, относящегося к выполнению функции. Получение конца журнала работает только при синхронном вызове `wait=true`. Обычно эта возможность используется при разработке или тестировании функций Lambda. Варианты: `false` ← (по умолчанию) `true`
validate_certs логическое значение	Если установлено значение `false`, SSL-сертификаты при взаимодействии с API AWS проверяться не будут. Настоятельно не рекомендуется устанавливать validate_certs=false. Вместо этого рассмотрите возможность задать параметр aws_ca_bundle. Варианты: `false` `true` ← (по умолчанию)
version_qualifier строка	Версия или псевдоним функции для запуска. По умолчанию используется ревизия `LATEST`, но можно указать любую существующую версию или псевдоним. Подробности см. на странице https://docs.aws.amazon.com/lambda/latest/dg/versioning-aliases.html.
wait логическое значение	Ожидать ли результаты выполнения функции. Если `wait=no`, задача не вернёт результаты. Чтобы дождаться завершения функции Lambda, задайте `wait=true`; результат будет доступен в ключе output. Варианты: `false` `true` ← (по умолчанию)

Примечания

Примечание

Асинхронный вызов всегда возвращает пустой ключ result.output.
Синхронный вызов может завершиться по тайм-ауту функции, в результате чего ключ result.output будет пустым.
Внимание: Для модулей переменные среды и файлы конфигурации считываются в контексте «узла» Ansible, а не в контексте «контроллера». Поэтому файлы может потребоваться явно скопировать на «узел». Для плагинов поиска и подключения переменные среды и файлы конфигурации считываются в контексте «контроллера» Ansible, а не «узла».
Используемый Ansible пакет AWS SDK (boto3) также может считывать значения по умолчанию для учётных данных и других параметров, например региона, из файлов конфигурации в контексте «узла» Ansible (обычно ~/.aws/credentials). Дополнительные сведения см. на странице https://boto3.amazonaws.com/v1/documentation/api/latest/guide/credentials.html.

Примеры

- amazon.aws.lambda_execute:
    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
- amazon.aws.lambda_execute:
    function_arn: arn:aws:lambda:us-east-1:123456789012:function/some-function
    dry_run: true

- amazon.aws.lambda_execute:
    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

# Pass the Lambda event payload as a json file.
- amazon.aws.lambda_execute:
    name: test-function
    payload: "{{ lookup('file','lambda_event.json') }}"
  register: response

- amazon.aws.lambda_execute:
    name: test-function
    version_qualifier: PRODUCTION

Возвращаемые значения

Общие возвращаемые значения описаны здесь. Ниже перечислены поля, уникальные для этого модуля:

Ключ	Описание
result словарь	Структура данных, полученная в результате успешного выполнения задачи. Возвращается: при успехе
logs строка	Последние 4 КБ журналов функции. Предоставляется только если `tail_log=true`. Возвращается: если `tail_log=true`
output словарь	Результат функции, если `wait=true` и функция возвращает значение. Возвращается: при успехе Пример: `{"output": "something"}`
status целое число	`StatusCode` завершения вызова API (200 для синхронных вызовов, 202 для асинхронных). Возвращается: всегда Пример: `200`

Авторы

Ryan Scott Brown (@ryansb)

Ссылки на коллекцию

© 2012–2018 Michael DeHaan
© 2018–2025 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/projects/ansible/latest/collections/amazon/aws/lambda_execute_module.html