View a markdown version of this page

invocar sam local - AWS Serverless Application Model

Las traducciones son generadas a través de traducción automática. En caso de conflicto entre la traducción y la version original de inglés, prevalecerá la version en inglés.

invocar sam local

Esta página proporciona información de referencia para AWS Serverless Application Model Interfaz de línea de comandos (AWS SAM CLI) sam local invoke subcomando.

El sam local invoke el subcomando inicia una invocación única de un AWS Lambda Función de evento local.

importante

No lo use sam local invoke con código que no es de confianza. Para aislarse completamente del entorno local, ejecute el código directamente en el servicio Lambda.

nota

Para funciones duraderas, sam local invoke admite la ejecución en estado con puntos de control y reproducción automáticos. El contenedor permanece en ejecución durante la ejecución duradera de la función para gestionar la persistencia y la reanudación del estado.

De uso

$ sam local invoke <arguments> <options>
nota

Si tiene más de una función definida en su AWS SAM plantilla, proporcione el identificador lógico de la función que desea invocar.

Argumentos

Resource ID (ID de recurso)

El ID de la función de Lambda que se invocará.

Este argumento es opcional. Si su aplicación contiene una sola función de Lambda, AWS SAM La CLI la invocará. Si la aplicación contiene varias funciones, proporciones el ID de la función que se va a invocar.

Valores válidos: el identificador lógico o el ARN del recurso.

Opciones

--add-host LIST

Pasa una asignación de nombre de host a dirección IP al archivo de host del contenedor de Docker. Este parámetro se puede pasar varias veces.

ejemplo

Ejemplo: --add-host example.com:127.0.0.1

--beta-features | --no-beta-features

Permitir o denegar las características beta.

--config-env TEXT

El nombre del entorno que especifica los valores de los parámetros predeterminados del archivo de configuración que se va a utilizar. El valor por defecto es «predeterminado». Para obtener más información sobre los archivos de configuración, consulta Archivo de configuración de la CLI de AWS SAM.

--config-file PATH

La ruta y el nombre del archivo de configuración que contiene los valores de parámetros predeterminados que se van a utilizar. El valor por defecto es «samconfig.toml» en la raíz del directorio del proyecto. Para obtener más información sobre los archivos de configuración, consulta Archivo de configuración de la CLI de AWS SAM.

--container-env-vars

(Opcional) Pase las variables de entorno al contenedor de imágenes de la función de Lambda al depurar localmente.

--container-host TEXT

Host del contenedor Lambda emulado localmente. El valor predeterminado es localhost. Si quiere ejecutar la CLI de AWS SAM en un contenedor Docker en macOS, puede especificar host.docker.internal. Si desea ejecutar el contenedor en un host diferente al AWS SAM CLI, puede especificar la dirección IP del host remoto.

--container-host-interface TEXT

La dirección IP de la interfaz de red del host a la que deben enlazarse los puertos del contenedor. El valor predeterminado es 127.0.0.1. Utiliza 0.0.0.0 para enlazarse a todas las interfaces.

--container-dns TEXT

Especifica un servidor DNS personalizado para el contenedor Docker. Este parámetro se puede pasar varias veces para especificar varios servidores DNS.

ejemplo

Ejemplo: --container-dns 8.8.8.8

--debug

Activa el registro de depuración para imprimir los mensajes de depuración que genera la CLI de AWS SAM y para mostrar las marcas horarias.

--debug-args TEXT

Argumentos opcionales que se pasan al depurador.

--debug-port, -d TEXT

Cuando se especifica, inicia el contenedor de funciones de Lambda en modo de depuración y expone este puerto en el host local.

--debugger-path TEXT

La ruta del host a un depurador montado en el contenedor de Lambda.

--docker-network TEXT

El nombre o el ID de una red de Docker existente a la que deben conectarse los contenedores de Lambda y Docker, junto con la red en modo puente predeterminada. Si esto no se especifica, los contenedores de Lambda se conectan únicamente a la red Docker en modo puente predeterminada.

--docker-volume-basedir, -v TEXT

La ubicación del directorio base donde se encuentra el AWS SAM existe el archivo. Si Docker se ejecuta en una máquina remota, debe montar la ruta donde AWS SAM el archivo existe en la máquina Docker y modifique este valor para que coincida con la máquina remota.

--durable-execution-name TEXT

Nombre para la ejecución duradera (solo para funciones duraderas)

--env-vars, -n PATH

El JSON o .env archivo que contiene los valores de las variables de entorno de la función Lambda. El formato del archivo se detecta automáticamente. Para obtener más información sobre los archivos de variable de entorno, consulta Archivo de variables de entorno.

--event, -e PATH

El archivo JSON que contiene los datos de eventos que se pasan a la función de Lambda cuando se invoca. Si no especifica esta opción, no se asume ningún evento. Para introducir JSON desde stdin, debe introducir el valor «-». Para obtener más información sobre los diferentes formatos de mensajes de eventos AWS servicios, consulte Trabajando con otros servicios en el AWS Lambda Guía para desarrolladores.

--force-image-build

Especifica si la CLI de AWS SAM debe reconstruir la imagen utilizada para invocar funciones de Lambda con capas.

--help

Muestra este mensaje y sale.

--hook-name TEXT

El nombre del enlace que se utiliza para ampliar la funcionalidad de la CLI de AWS SAM.

Valores aceptados: terraform.

--invoke-image TEXT

El URI de la imagen del contenedor que quieres usar para la invocación de la función local.

Para funciones de Lambda con PackageType: Zip, esto anula la imagen base en tiempo de ejecución. De forma predeterminada, AWS SAM extrae la imagen del contenedor de Amazon ECR Public (que están listadas en Repositorios de imágenes para AWS SAM). Utiliza esta opción para extraer la imagen desde otra ubicación.

Para funciones de Lambda con PackageType: Image, esto anula el ImageUri de la plantilla creada. Utilícela para invocar una imagen de aplicación diferente de forma local sin modificar la plantilla.

Puedes especificar esta opción varias veces. Cada instancia de esta opción puede tomar una cadena o un par clave-valor. Si especificas una cadena, será el URI de la imagen del contenedor que se usará en todas las funciones de la aplicación. Por ejemplo, sam local invoke --invoke-image public.ecr.aws/sam/emu-python3.13. Si especificas un par clave-valor, la clave es el nombre del recurso y el valor es el URI de la imagen del contenedor que se va a usar para ese recurso. Por ejemplo, sam local invoke --invoke-image public.ecr.aws/sam/emu-python3.13 --invoke-image Function1=amazon/aws-sam-cli-emulation-image-python3.13. Con los pares clave-valor, puede especificar distintas imágenes del contenedor para distintos recursos.

--layer-cache-basedir DIRECTORY

Especifica la ubicación del directorio base en el que se descargan las capas que utiliza la plantilla.

--log-file, -l TEXT

El archivo de registro al que se van a enviar los registros de tiempo de ejecución.

Garantiza que la CLI de AWS SAM siempre monte los enlaces simbólicos que están presentes en los archivos para compilarlos o invocarlos. Esto solo se aplica a los enlaces simbólicos del directorio de nivel superior (es decir, los que se encuentran directamente en la raíz de la función). Por defecto, los enlaces simbólicos no se montan, excepto los necesarios para utilizar build-in-source para node_modules en NodeJS.

--no-event

Invoca la función con un evento vacío.

--no-memory-limit

Elimina la limitación de memoria del contenedor durante la invocación local, incluso cuando la memoria está configurada en AWS SAM plantilla.

--parameter-overrides

Una cadena que contiene CloudFormation anulaciones de parámetros codificadas como pares clave-valor. Utilice el mismo formato que el AWS Command Line Interface (AWS CLI). El formato de la CLI de AWS SAM es de palabras clave y de valor explícitas, y cada modificación está separada por un espacio. A continuación, se incluyen dos ejemplos:

  • --parameter-overrides ParameterKey=hello,ParameterValue=world

  • --parameter-overrides ParameterKey=hello,ParameterValue=world ParameterKey=example1,ParameterValue=example2 ParameterKey=apple,ParameterValue=banana

--profile TEXT

El perfil específico de su archivo de credenciales que obtiene AWS credenciales.

--region TEXT

El AWS Región en la que realizar el despliegue. Por ejemplo, us-east-1.

--runtime TEXT

Utiliza el tiempo de ejecución especificado para invocar una función de Lambda de forma local. Esto anula el tiempo de ejecución definido en el archivo template.yml. Esto también permite probar funciones de Lambda con diferentes tiempos de ejecución sin modificar la configuración original de la función.

--save-params

Guarde los parámetros que proporciona en la línea de comandos en AWS SAM archivo de configuración.

--shutdown

Emula un evento de apagado una vez finalizada la invocación, para probar la forma en que la extensión gestiona el comportamiento del apagado.

--skip-prepare-infra

Omite la fase de preparación si no se ha realizado ningún cambio en la infraestructura. Ejecuta con la opción --hook-name.

--skip-pull-image

De forma predeterminada, la CLI de AWS SAM comprueba el tiempo de ejecución remoto más reciente de Lambda y actualiza la imagen local automáticamente para mantenerla sincronizada.

Especifica esta opción para omitir la extracción de la imagen de Docker más reciente de su tiempo de ejecución de Lambda.

--template, -t PATH

El AWS SAM archivo de plantilla.

Esta opción no es compatible con --hook-name.

nota

Si especifica esta opción, AWS SAM carga solo la plantilla y los recursos locales a los que apunta.

--tenant-id TEXT

El ID de inquilino para las funciones de Lambda con varios usuarios. Se usa para garantizar el aislamiento informático entre los diferentes inquilinos. Necesario al invocar funciones configuradas con el modo de aislamiento de inquilinos.

--terraform-plan-file

La ruta relativa o absoluta al archivo del plan local Terraform cuando se utiliza la CLI de AWS SAM con Terraform Cloud. Esta opción requiere que --hook-name esté configurado en terraform.

Ejemplos

En el siguiente ejemplo, se utiliza un evento generado para realizar pruebas locales mediante un evento s3.json para invocar una función de Lambda de forma local.

$ sam local invoke --event events/s3.json S3JsonLoggerFunction

El siguiente ejemplo prueba la función HelloWorldFunction con el tiempo de ejecución de Python 3.11

$ sam local invoke --runtime python3.11 HelloWorldFunction

El siguiente ejemplo prueba la función HelloWorldFunction con un nombre de ejecución duradero

$ sam local invoke HelloWorldFunction --durable-execution-name my-execution