

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.

# Referencia de los comandos AWS SAM CLI
<a name="serverless-sam-cli-command-reference"></a>

En esta sección se incluye información de referencia sobre los comandos de la CLI de AWS SAM. Se incluyen detalles sobre el uso, una lista completa de las diferentes opciones disponibles para cada comando e información adicional. Cuando proceda, la información adicional incluye detalles como los argumentos, las variables de entorno y los eventos. Para obtener más información, consulte cada comando. Para obtener instrucciones sobre cómo instalar el AWS SAMCLI, consulte[Instala la AWS SAM CLI](install-sam-cli.md).

**Topics**
+ [sam build](sam-cli-command-reference-sam-build.md)
+ [sam delete](sam-cli-command-reference-sam-delete.md)
+ [sam deploy](sam-cli-command-reference-sam-deploy.md)
+ [sam init](sam-cli-command-reference-sam-init.md)
+ [sam list](sam-cli-command-reference-sam-list.md)
+ [sam local callback](sam-cli-command-reference-sam-local-callback.md)
+ [sam local execution](sam-cli-command-reference-sam-local-execution.md)
+ [sam local generate-event](sam-cli-command-reference-sam-local-generate-event.md)
+ [sam local invoke](sam-cli-command-reference-sam-local-invoke.md)
+ [sam local start-api](sam-cli-command-reference-sam-local-start-api.md)
+ [sam local start-lambda](sam-cli-command-reference-sam-local-start-lambda.md)
+ [sam logs](sam-cli-command-reference-sam-logs.md)
+ [sam package](sam-cli-command-reference-sam-package.md)
+ [sam pipeline bootstrap](sam-cli-command-reference-sam-pipeline-bootstrap.md)
+ [sam pipeline init](sam-cli-command-reference-sam-pipeline-init.md)
+ [sam publish](sam-cli-command-reference-sam-publish.md)
+ [sam remote callback](sam-cli-command-reference-sam-remote-callback.md)
+ [sam remote execution](sam-cli-command-reference-sam-remote-execution.md)
+ [sam remote invoke](sam-cli-command-reference-remote-invoke.md)
+ [sam remote test-event](sam-cli-command-reference-remote-test-event.md)
+ [sam sync](sam-cli-command-reference-sam-sync.md)
+ [sam traces](sam-cli-command-reference-sam-traces.md)
+ [sam validate](sam-cli-command-reference-sam-validate.md)

# sam build
<a name="sam-cli-command-reference-sam-build"></a>

Esta página proporciona información de referencia para el AWS Serverless Application Model comando Command Line Interface (AWS SAMCLI)`sam build`.
+ Para obtener una introducción al AWS SAMCLI, consulte [¿Qué es el? AWS SAMCLI](what-is-sam-overview.md#what-is-sam-cli)
+ Para obtener documentación sobre el uso del AWS SAMCLI `sam build` comando, consulte[Introducción a la construcción con AWS SAM](using-sam-cli-build.md).

El comando `sam build` prepara una aplicación para los pasos posteriores del flujo de trabajo del desarrollador, como las pruebas locales o la implementación en Nube de AWS.

## De uso
<a name="ref-sam-cli-build-usage"></a>

```
$ sam build <arguments> <options>
```

## Argumentos
<a name="ref-sam-cli-build-args"></a>

**Resource ID (ID de recurso)**  <a name="ref-sam-cli-build-args-resource-id"></a>
Opcional. Indica AWS SAM que se cree un único recurso declarado en una [AWS SAM plantilla](what-is-sam-overview.md#what-is-sam-template). Los artefactos de compilación del recurso especificado serán los únicos disponibles para los siguientes comandos del flujo de trabajo, es decir, `sam package` y `sam deploy`.

## Opciones
<a name="ref-sam-cli-build-options"></a>

`--base-dir, -s DIRECTORY`  <a name="ref-sam-cli-build-options-base-dir"></a>
Resuelve las rutas relativas al código fuente de la función o capa con respecto a este directorio. Utiliza esta opción si desea cambiar la forma en que se resuelven las rutas relativas a las carpetas de código fuente. De forma predeterminada, las rutas relativas se resuelven con respecto a la ubicación de la plantilla de AWS SAM .  
Además de los recursos de la aplicación o pila raíz que está creando, esta opción también se aplica a las aplicaciones o pilas anidadas.  
Esta opción se aplica a los siguientes tipos y propiedades de recursos:  
+ Tipo de recurso: `AWS::Serverless::Function` Propiedad: `CodeUri`
+ Tipo de recurso: `AWS::Serverless::Function` Atributo de recurso: `Metadata` Entrada: `DockerContext`
+ Tipo de recurso: `AWS::Serverless::LayerVersion` Propiedad: `ContentUri`
+ Tipo de recurso: `AWS::Lambda::Function` Propiedad: `Code`
+ Tipo de recurso: `AWS::Lambda::LayerVersion` Propiedad: `Content`

`--beta-features | --no-beta-features`  <a name="ref-sam-cli-build-options-beta-features"></a>
Permitir o denegar las características beta.

`--build-dir, -b DIRECTORY`  <a name="ref-sam-cli-build-options-build-dir"></a>
La ruta a un directorio en el que se almacenan los artefactos creados. Este directorio y todo su contenido se eliminan con esta opción.

`--build-image TEXT`  <a name="ref-sam-cli-build-options-build-image"></a>
URI de la imagen del contenedor que quiere extraer para la compilación. De forma predeterminada, AWS SAM extrae la imagen del contenedor de Amazon ECR Public. Utiliza esta opción para extraer la imagen desde otra ubicación.  
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á para todos los recursos de la aplicación. Por ejemplo, `sam build --use-container --build-image amazon/aws-sam-cli-build-image-python3.8`. 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 build --use-container --build-image Function1=amazon/aws-sam-cli-build-image-python3.8`. Con los pares clave-valor, puede especificar distintas imágenes del contenedor para distintos recursos.  
Esta opción solo se aplica si se especifica la opción `--use-container`; de lo contrario, se producirá un error.

`--build-in-source | --no-build-in-source`  <a name="ref-sam-cli-build-options-build-in-source"></a>
Proporciona `--build-in-source` para compilar el proyecto directamente en la carpeta de origen.  
La opción `--build-in-source` admite los siguientes tiempos de ejecución y métodos de compilación:  
+ **Tiempos de ejecución**: cualquier tiempo de ejecución Node.js compatible con la opción `sam init --runtime`.
+ **Métodos de compilación**: `Makefile`, `esbuild`.
La opción `--build-in-source` no es compatible con las siguientes opciones:  
+ `--hook-name`
+ `--use-container `
*Valor predeterminado*: `--no-build-in-source`

`--cached | --no-cached`  <a name="ref-sam-cli-build-options-cached"></a>
Habilitar o desactivar las compilaciones en caché. Usa esta opción para reutilizar los artefactos de compilación que no hayan cambiado con respecto a compilaciones anteriores. AWS SAM evalúa si ha cambiado algún archivo del directorio del proyecto. De forma predeterminada, las compilaciones no se almacenan en caché. Si se invoca la opción `--no-cached`, anula la configuración `cached = true` de samcofig.toml.  
AWS SAM no evalúa si ha cambiado los módulos de terceros de los que depende su proyecto si no ha proporcionado una versión específica. Por ejemplo, si tu función de Python incluye un `requirements.txt` archivo con la entrada `requests=1.x` y la última versión del módulo de solicitud cambia de `1.1` a`1.2`, AWS SAM no extraerá la última versión hasta que ejecutes una compilación no almacenada en caché.

`--cache-dir`  <a name="ref-sam-cli-build-options-cached-dir"></a>
El directorio en el que se almacenan los artefactos de la caché cuando se especifica `--cached`. El directorio predeterminado de la caché es `.aws-sam/cache`.

`--config-env TEXT`  <a name="ref-sam-cli-build-options-config-env"></a>
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](serverless-sam-cli-config.md).

`--config-file PATH`  <a name="ref-sam-cli-build-options-config-file"></a>
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](serverless-sam-cli-config.md).

`--container-env-var, -e TEXT`  <a name="ref-sam-cli-build-options-container-env-var"></a>
Las variables de entorno que transferir al contenedor de compilaciones. Puedes especificar esta opción varias veces. Cada instancia de esta opción utiliza un par clave-valor, donde la clave es la variable de recurso y entorno, y el valor es el valor de la variable de entorno. Por ejemplo: `--container-env-var Function1.GITHUB_TOKEN=TOKEN1 --container-env-var Function2.GITHUB_TOKEN=TOKEN2`.  
Esta opción solo se aplica si se especifica la opción `--use-container`; de lo contrario, se producirá un error.

`--container-env-var-file, -ef PATH`  <a name="ref-sam-cli-build-options-container-env-var-file"></a>
La ruta y el nombre de un archivo JSON que contiene valores para las variables de entorno del contenedor. Para obtener más información sobre archivos de variable de entorno del contenedor, consulta [Archivo de variables del entorno del contenedor.](serverless-sam-cli-using-build.md#serverless-sam-cli-using-container-environment-file).  
Esta opción solo se aplica si se especifica la opción `--use-container`; de lo contrario, se producirá un error.

`--debug`  <a name="ref-sam-cli-build-options-debug"></a>
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 temporales.

`--docker-network TEXT`  <a name="ref-sam-cli-build-options-docker-network"></a>
Especifica el nombre o el ID de una red de Docker existente a la que deben conectarse los contenedores de Docker , junto con la red en modo puente predeterminada. Si no se especifica, los contenedores de Lambda se conectan únicamente a la red Docker en modo puente predeterminada.

`--exclude, -x`  <a name="ref-sam-cli-build-options-exclude"></a>
El nombre de los recursos que se van a excluir de `sam build`. Por ejemplo, si tu plantilla contiene `Function1`, `Function2` y `Function3` y usted ejecuta `sam build --exclude Function2`, solo se compilarán `Function1` y `Function3`.

`--help`  <a name="ref-sam-cli-build-options-help"></a>
Muestra este mensaje y sale.

`--hook-name TEXT`  <a name="ref-sam-cli-build-options-hook-name"></a>
El nombre del enlace que se utiliza para ampliar la funcionalidad de la CLI de AWS SAM.  
Valores aceptados: `terraform`.

`--manifest , -m PATH`  <a name="ref-sam-cli-build-options-manifest"></a>
La ruta a un archivo de manifiesto de dependencias personalizado (por ejemplo, package.json) para usarlo en lugar del predeterminado.

`--mount-symlinks`  <a name="ref-sam-cli-build-options-mount-symlinks"></a>
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-use-container`  <a name="ref-sam-cli-build-options-no-use-container"></a>
Una opción que permite usar el kit de herramientas de IDE para establecer el comportamiento predeterminado. También puede utilizar `sam build --no-use-container` para ejecutar una compilación en su máquina local en lugar de en un contenedor de Docker.

`--parallel`  <a name="ref-sam-cli-build-options-parallel"></a>
Habilitar compilaciones paralelas. Utilice esta opción para crear las funciones y capas de la AWS SAM plantilla en paralelo. De forma predeterminada, las funciones y las capas se crean en secuencia.

`--parameter-overrides`  <a name="ref-sam-cli-build-options-parameter-overrides"></a>
(Opcional) Una cadena que contiene anulaciones de CloudFormation parámetros codificadas como pares clave-valor. Usa el mismo formato que (). AWS Command Line Interface AWS CLI Por ejemplo: '`ParameterKey`=`KeyPairName`, `ParameterValue`=`MyKey` `ParameterKey`=`InstanceType`, `ParameterValue`=`t1.micro`'. Esta opción no es compatible con `--hook-name`.

`--profile TEXT`  <a name="ref-sam-cli-build-options-profile"></a>
El perfil específico del archivo de credenciales que recibe AWS las credenciales.

`--region TEXT`  <a name="ref-sam-cli-build-options-region"></a>
El en el Región de AWS que se va a implementar. Por ejemplo, us-east-1.

`--save-params`  <a name="ref-sam-cli-build-options-save-params"></a>
Guarde los parámetros que proporcione en la línea de comandos en el archivo AWS SAM de configuración.

`--skip-prepare-infra`  <a name="ref-sam-cli-build-options-skip-prepare-infra"></a>
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`  <a name="ref-sam-cli-build-options-skip-pull-image"></a>
Especifica si el comando debe omitir la extracción de la última imagen de Docker para el tiempo de ejecución de Lambda.

`--template-file, --template, -t PATH`  <a name="ref-sam-cli-build-options-template-file"></a>
La ruta y el nombre del archivo de AWS SAM plantilla`[default: template.[yaml|yml]]`. Esta opción no es compatible con `--hook-name`.

`--terraform-project-root-path`  <a name="ref-sam-cli-build-options-terraform-project-root-path"></a>
La ruta relativa o absoluta al directorio de nivel superior que contiene los archivos de configuración de Terraform o el código fuente de la función. Si estos archivos se encuentran fuera del directorio que contiene el módulo raíz de Terraform, utilice esta opción para especificar su ruta absoluta o relativa. Esta opción requiere que `--hook-name` se establezca en `terraform`.

`--use-container`, `-u`  <a name="ref-sam-cli-build-options-use-container"></a>
Si las funciones dependen de paquetes que tienen dependencias compiladas de forma nativa, utilice esta opción para crear la función dentro de un contenedor de Docker tipo Lambda.

## Ejemplo
<a name="sam-cli-command-reference-sam-build-examples"></a>

Para ver un ejemplo y un tutorial detallados sobre el uso del subcomando `sam build`, consulte [Introducción a la construcción con AWS SAM](using-sam-cli-build.md).

# sam delete
<a name="sam-cli-command-reference-sam-delete"></a>

Esta página proporciona información de referencia para el AWS Serverless Application Model comando Command Line Interface (AWS SAMCLI)`sam delete`.

Para obtener una introducción al AWS SAMCLI, consulte [¿Qué es el? AWS SAMCLI](what-is-sam-overview.md#what-is-sam-cli)

El `sam delete` comando elimina una AWS SAM aplicación eliminando la CloudFormation pila, los artefactos que se empaquetaron e implementaron en Amazon S3 y Amazon ECR y el archivo de AWS SAM plantilla.

Este comando también comprueba si se ha implementado una pila complementaria de Amazon ECR y, de ser así, solicita al usuario que elimine esa pila y los repositorios de Amazon ECR. Si se especifica `--no-prompts`, las pilas complementarias y los repositorios de Amazon ECR se eliminan de forma predeterminada.

## De uso
<a name="sam-cli-command-reference-sam-delete-usage"></a>

```
$ sam delete <options>
```

## Opciones
<a name="sam-cli-command-reference-sam-delete-options"></a>

`--config-env TEXT`  <a name="sam-cli-command-reference-sam-delete-options-config-env"></a>
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 predeterminado es `default`. Para obtener más información sobre los archivos de configuración, consulta [Archivo de configuración de la CLI de AWS SAM](serverless-sam-cli-config.md).

`--config-file PATH`  <a name="sam-cli-command-reference-sam-delete-options-config-file"></a>
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](serverless-sam-cli-config.md).

`--debug`  <a name="sam-cli-command-reference-sam-delete-options-debug"></a>
Activa el registro de depuración para imprimir el mensaje de depuración que AWS SAMCLI genera y para mostrar las marcas temporales.

`--help`  <a name="sam-cli-command-reference-sam-delete-options-help"></a>
Muestra este mensaje y sale.

`--no-prompts`  <a name="sam-cli-command-reference-sam-delete-options-no-prompts"></a>
Especifique esta opción para que AWS SAM funcione en modo no interactivo. El nombre de la pila debe proporcionarse junto con la opción `--stack-name` o en el archivo de configuración `toml`.

`--profile TEXT`  <a name="sam-cli-command-reference-sam-delete-options-profile"></a>
El perfil específico del archivo de credenciales que recibe AWS las credenciales.

`--region TEXT`  <a name="sam-cli-command-reference-sam-delete-options-region"></a>
La AWS región en la que se va a realizar el despliegue. Por ejemplo, us-east-1.

`--s3-bucket`  <a name="sam-cli-command-reference-sam-delete-options-s3-bucket"></a>
La ruta del bucket de Amazon S3 que desea eliminar.

`--s3-prefix`  <a name="sam-cli-command-reference-sam-delete-options-s3-prefix"></a>
El prefijo del bucket de Amazon S3 que desea eliminar.

`--save-params`  <a name="sam-cli-command-reference-sam-delete-options-save-params"></a>
Guarde los parámetros que proporcione en la línea de comandos en el archivo AWS SAM de configuración.

`--stack-name TEXT`  <a name="sam-cli-command-reference-sam-delete-options-stack-name"></a>
El nombre de la CloudFormation pila que desea eliminar.

## Ejemplos
<a name="sam-cli-command-reference-sam-delete-examples"></a>

El siguiente comando elimina la pila `MY-STACK`. 

```
$ sam delete --stack-name MY-STACK
```

El siguiente comando elimina la pila `MY-STACK` y el bucket de S3 `sam-s3-demo-bucket`:

```
$ sam delete \
    --stack-name MyStack \
    --s3-bucket MySAMBucket
```

# sam deploy
<a name="sam-cli-command-reference-sam-deploy"></a>

Esta página proporciona información de referencia para el AWS Serverless Application Model comando Command Line Interface (AWS SAMCLI)`sam deploy`.
+ Para obtener una introducción al AWS SAMCLI, consulte [¿Qué es el? AWS SAMCLI](what-is-sam-overview.md#what-is-sam-cli)
+ Para obtener documentación sobre el uso del AWS SAMCLI `sam deploy` comando, consulte[Introducción a la implementación con AWS SAM](using-sam-cli-deploy.md).

El `sam deploy` comando despliega una aplicación para el usuario Nube de AWS . AWS CloudFormation

## De uso
<a name="ref-sam-cli-deploy-usage"></a>

```
$ <environment variables> sam deploy <options>
```

## Variables de entorno
<a name="ref-sam-cli-deploy-env"></a>

`SAM_CLI_POLL_DELAY`  <a name="ref-sam-cli-deploy-env-sam-cli-poll-delay"></a>
Establezca la variable de `SAM_CLI_POLL_DELAY` entorno con un valor de segundos en su shell para configurar la frecuencia con la que la CLI de AWS SAM comprueba el estado de la CloudFormation pila, lo cual es útil cuando se ve la aceleración desde. CloudFormation Esta variable de entorno se utiliza para sondear las llamadas a la API `describe_stack`, que se realizan durante la ejecución de `sam deploy`.   
A continuación se muestra un ejemplo de la variable.  

```
$ SAM_CLI_POLL_DELAY=5 sam deploy
```

## Opciones
<a name="ref-sam-cli-deploy-options"></a>

`--capabilities LIST`  <a name="ref-sam-cli-deploy-options-capabilities"></a>
Una lista de capacidades que debe especificar para CloudFormation permitir la creación de determinadas pilas. Algunas plantillas de pila pueden incluir recursos que afectan a sus permisos, por ejemplo Cuenta de AWS, mediante la creación de nuevos usuarios AWS Identity and Access Management (de IAM). Para estas pilas, debe reconocer explícitamente sus capacidades especificando esta opción. Los únicos valores válidos son `CAPABILITY_IAM` y `CAPABILITY_NAMED_IAM`. Si tiene recursos de IAM, puede especificar cualquiera de las dos capacidades. Si tiene recursos de IAM con nombres personalizados, debe especificar `CAPABILITY_NAMED_IAM`. Si no especifica esta opción, la operación devuelve un error `InsufficientCapabilities`.  
Cuando implementa una aplicación que contiene aplicaciones anidadas, debe usar `CAPABILITY_AUTO_EXPAND` para reconocer que la aplicación contiene aplicaciones anidadas. Para obtener más información, consulte [Implementar aplicaciones anidadas](serverless-sam-template-nested-applications.md#serverless-sam-templates-nested-applications-deploying).

`--config-env TEXT`  <a name="ref-sam-cli-deploy-options-config-env"></a>
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 predeterminado es `default`. Para obtener más información sobre los archivos de configuración, consulta [Archivo de configuración de la CLI de AWS SAM](serverless-sam-cli-config.md).

`--config-file PATH`  <a name="ref-sam-cli-deploy-options-config-file"></a>
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](serverless-sam-cli-config.md).

`--confirm-changeset | --no-confirm-changeset`  <a name="ref-sam-cli-deploy-options-confirm-changeset"></a>
Solicita confirmar si la CLI de AWS SAM implementa el conjunto de cambios calculado.

`--debug`  <a name="ref-sam-cli-deploy-options-debug"></a>
Active el registro de depuración para imprimir el mensaje de depuración que la CLI de AWS SAM genera y para mostrar las marcas temporales.

`--disable-rollback | --no-disable-rollback`  <a name="ref-sam-cli-deploy-options-disable-rollback"></a>
Especifique si desea revertir la CloudFormation pila en caso de que se produzca un error durante una implementación. De forma predeterminada, si se produce un error durante una implementación, la CloudFormation pila vuelve al último estado estable. Si especificas `--disable-rollback` y se produce un error durante una implementación, los recursos que se crearon o actualizaron antes de que se produjera el error no se revertirán.

`--fail-on-empty-changeset | --no-fail-on-empty-changeset`  <a name="ref-sam-cli-deploy-options-fail-on-empty-changeset"></a>
Especifica si desea devolver un código de salida distinto de cero si no hay cambios que realizar en la pila. El comportamiento predeterminado es devolver un código de salida distinto de cero.

`--force-upload`  <a name="ref-sam-cli-deploy-options-force-upload"></a>
Especifica esta opción para cargar artefactos incluso si coinciden con los artefactos existentes en el bucket de Amazon S3. Los artefactos coincidentes se sobrescriben.

`--guided, -g`  <a name="ref-sam-cli-deploy-options-guided"></a>
Especifica esta opción para que la CLI de AWS SAM utilice indicaciones que le guíen durante la implementación.

`--help`  <a name="ref-sam-cli-deploy-options-help"></a>
Muestre este mensaje y salga de él.

`--image-repositories TEXT`  <a name="ref-sam-cli-deploy-options-image-repositories"></a>
Un mapeo de funciones a su URI del repositorio de Amazon ECR. Haga referencia a las funciones por su ID lógico. A continuación, se muestra un ejemplo:  

```
$ sam deploy --image-repositories Function1=123456789012.dkr.ecr.us-east-1.amazonaws.com/my-repo
```
Puede especificar esta opción varias veces con un solo comando.

`--image-repository TEXT`  <a name="ref-sam-cli-deploy-options-image-repository"></a>
El nombre del repositorio de Amazon ECR en el que este comando carga la imagen de la función. Esta opción es necesaria para las funciones declaradas con el tipo de paquete `Image`.

`--kms-key-id TEXT`  <a name="ref-sam-cli-deploy-options-kms-key-id"></a>
El ID de una clave AWS Key Management Service (AWS KMS) que se utiliza para cifrar los artefactos que se encuentran en reposo en el bucket de Amazon S3. Si no especifica esta opción, utilizará claves de cifrado administradas por Amazon S3. AWS SAM 

`--metadata`  <a name="ref-sam-cli-deploy-options-metadata"></a>
Un mapa de metadatos para adjuntar a todos los artefactos a los que se hace referencia en la plantilla.

`--no-execute-changeset`  <a name="ref-sam-cli-deploy-options-no-execute-changeset"></a>
Indica si se debe aplicar el conjunto de cambios. Especifica esta opción si desea ver los cambios de la pila antes de aplicar el conjunto de cambios. Este comando crea un conjunto de cambios CloudFormation y, a continuación, se cierra sin aplicar el conjunto de cambios. Para aplicar el conjunto de cambios, ejecuta el mismo comando sin esta opción.

`--no-progressbar`  <a name="ref-sam-cli-deploy-options-no-progressbar"></a>
No muestre una barra de progreso al cargar artefactos en Amazon S3.

`--notification-arns LIST`  <a name="ref-sam-cli-deploy-options-notification-arns"></a>
Una lista de los ARNs temas del Amazon Simple Notification Service (Amazon SNS) asociados a la CloudFormation pila.

`--on-failure [ROLLBACK | DELETE | DO_NOTHING]`  <a name="ref-sam-cli-deploy-options-on-failure"></a>
Especifica la acción que se debe realizar cuando no se pueda crear una pila.  
Están disponibles las siguientes opciones:  
+ `ROLLBACK`: hace retroceder la pila a un estado válido conocido anteriormente.
+ `DELETE`: hace retroceder la pila a un estado válido conocido anteriormente, si es que existe alguno. De lo contrario, elimina la pila.
+ `DO_NOTHING`: no revierte ni elimina la pila. El efecto es el mismo que el de `--disable-rollback`.
El comportamiento predeterminado es `ROLLBACK`.  
Especifica la opción `--disable-rollback` o la `--on-failure`, pero no ambas.

`--parameter-overrides LIST`  <a name="ref-sam-cli-deploy-options-parameter-overrides"></a>
Cadena que contiene anulaciones de CloudFormation parámetros codificadas como pares clave-valor. Cada anulación usa el formato `ParameterKey=name,ParameterValue=value`. Las anulaciones múltiples están separadas por espacios. A continuación, se incluyen dos ejemplos:  

```
$ sam deploy --parameter-overrides ParameterKey=value1,ParameterValue=value2
```

```
$ sam deploy --parameter-overrides ParameterKey=value1,ParameterValue=value2 ParameterKey=hello,ParameterValue=world ParameterKey=apple,ParameterValue=banana
```

`--profile TEXT`  <a name="ref-sam-cli-deploy-options-profile"></a>
El perfil específico del archivo de credenciales que recibe las credenciales. AWS 

`--region TEXT`  <a name="ref-sam-cli-deploy-options-region"></a>
El en el Región de AWS que se va a implementar. Por ejemplo, us-east-1.

`--resolve-image-repos`  <a name="ref-sam-cli-deploy-options-resolve-image-repos"></a>
Crea automáticamente repositorios de Amazon ECR para usarlos en el empaquetado y la implementación de implementaciones no guiadas. Esta opción solo se aplica a funciones y capas con la especificación `PackageType: Image`. Si especificas la opción `--guided`, entonces la CLI de AWS SAM ignora `--resolve-image-repos`.  
Si crea AWS SAM automáticamente cualquier repositorio de Amazon ECR para funciones o capas con esta opción y, posteriormente, elimina esas funciones o capas de la AWS SAM plantilla, los repositorios de Amazon ECR correspondientes se eliminarán automáticamente.

`--resolve-s3`  <a name="ref-sam-cli-deploy-options-resolve-s3"></a>
Crea automáticamente un bucket de Amazon S3 para utilizarlo en el empaquetado y la implementación de implementaciones no guiadas. Si especificas la opción `--guided`, entonces la CLI AWS SAM ignora `--resolve-s3`. Si especificas las opciones `--s3-bucket` y `--resolve-s3`, entonces se produce un error.

`--role-arn TEXT`  <a name="ref-sam-cli-deploy-options-role-arn"></a>
El nombre de recurso de Amazon (ARN) de una función de IAM que se CloudFormation asume al aplicar el conjunto de cambios.

`--s3-bucket TEXT`  <a name="ref-sam-cli-deploy-options-s3-bucket"></a>
El nombre del bucket de Amazon S3 en el que este comando carga la CloudFormation plantilla. Si la plantilla tiene más de 51 200 bytes, es necesaria la opción `--s3-bucket` o la opción `--resolve-s3`. Si especificas ambas opciones `--s3-bucket` y `--resolve-s3`, se producirá un error.

`--s3-prefix TEXT`  <a name="ref-sam-cli-deploy-options-s3-prefix"></a>
El prefijo que se ha añadido a los nombres de los artefactos que se cargan en el bucket de Amazon S3. El nombre del prefijo es un nombre de ruta (nombre de la carpeta) del bucket de Amazon S3.

`--save-params`  <a name="ref-sam-cli-deploy-options-save-params"></a>
Guarde los parámetros que proporcione en la línea de comandos en el archivo de AWS SAM configuración.

`--signing-profiles LIST`  <a name="ref-sam-cli-deploy-options-signing-profiles"></a>
La lista de perfiles de firma con los que firmar los paquetes de implementación. Esta opción utiliza una lista de pares clave-valor, donde la clave es el nombre de la función o capa que se va a firmar y el valor es el perfil de firma, con un propietario del perfil opcional delimitado con `:`. Por ejemplo, `FunctionNameToSign=SigningProfileName1 LayerNameToSign=SigningProfileName2:SigningProfileOwner`.

`--stack-name TEXT`  <a name="ref-sam-cli-deploy-options-stack-name"></a>
(Obligatorio) El nombre de la CloudFormation pila en la que se va a realizar la implementación. Si especificas una pila existente, el comando la actualiza. Si especificas una nueva pila, el comando la crea.

`--tags LIST`  <a name="ref-sam-cli-deploy-options-tags"></a>
Una lista de etiquetas para asociarlas a la pila que se crea o actualiza. CloudFormation también propaga estas etiquetas a los recursos de la pila que las admiten.

`--template-file, --template, -t PATH`  <a name="ref-sam-cli-deploy-options-template-file"></a>
La ruta y el nombre del archivo donde se encuentra la AWS SAM plantilla.  
Si especifica esta opción, solo se AWS SAM despliega la plantilla y los recursos locales a los que apunta.

`--use-json`  <a name="ref-sam-cli-deploy-options-use-json"></a>
Genera JSON para la CloudFormation plantilla. El resultado predeterminado es YAML.

## Ejemplo
<a name="sam-cli-command-reference-sam-deploy-examples"></a>

Para ver un ejemplo y un tutorial detallados sobre el uso del subcomando `sam deploy`, consulte [Introducción a la implementación con AWS SAM](using-sam-cli-deploy.md).

# sam init
<a name="sam-cli-command-reference-sam-init"></a>

Esta página proporciona información de referencia para el AWS Serverless Application Model comando Command Line Interface (AWS SAMCLI)`sam init`.
+ Para obtener una introducción al AWS SAMCLI, consulte [¿Qué es el? AWS SAMCLI](what-is-sam-overview.md#what-is-sam-cli)
+ Para obtener documentación sobre el uso del AWS SAMCLI `sam init` comando, consulte[Crea tu aplicación en AWS SAM](using-sam-cli-init.md).

El comando `sam init` proporciona opciones para inicializar una nueva aplicación sin servidor.

## De uso
<a name="sam-cli-command-reference-sam-init-usage"></a>

```
$ sam init <options>
```

## Opciones
<a name="sam-cli-command-reference-sam-init-options"></a>

`--app-template TEXT`  <a name="sam-cli-command-reference-sam-init-options-app-template"></a>
El identificador de la plantilla de la aplicación gestionada que recomendamos utilizar. Si no está seguro, llame a `sam init` sin opciones para disfrutar de un flujo de trabajo interactivo.  
Este parámetro es obligatorio si se especifica `--no-interactive`, y `--location` si no se proporciona.  
Esta característica solo está disponible en la versión 0.30.0 o posterior de la CLIde AWS SAM. Si se especifica este parámetro con una versión anterior, se produce un error.

`--application-insights | --no-application-insights`  <a name="sam-cli-command-reference-sam-init-options-application-insights"></a>
 Active la supervisión de Amazon CloudWatch Application Insights para su aplicación. Para obtener más información, consulte [Uso de CloudWatch Application Insights para monitorear sus aplicaciones AWS SAM sin servidor](monitor-app-insights.md).   
 La opción predeterminada es `--no-application-insights`. 

`--architecture, -a [ x86_64 | arm64 ]`  <a name="sam-cli-command-reference-sam-init-options-architecture"></a>
La arquitectura del conjunto de instrucciones para las funciones de Lambda de la aplicación. Especifica una de las siguientes opciones: `x86_64` o `arm64`

`--base-image [ amazon/dotnet8-base | amazon/dotnet6-base | amazon/java25-base | amazon/java21-base | amazon/java17-base | amazon/java11-base | amazon/nodejs24.x-base | amazon/nodejs22.x-base | amazon/nodejs20.x-base | amazon/nodejs18.x-base | amazon/nodejs16.x-base | amazon/python3.14-base | amazon/python3.13-base | amazon/python3.12-base | amazon/python3.11-base | amazon/python3.10-base | amazon/python3.9-base | amazon/python3.8-base | amazon/ruby3.4-base | amazon/ruby3.3-base | amazon/ruby3.2-base ]`  <a name="sam-cli-command-reference-sam-init-options-base-image"></a>
La imagen base de su aplicación. Esta opción solo se aplica cuando el tipo de paquete es `Image`.  
Este parámetro es obligatorio si `--no-interactive` se especifica, `--package-type` se especifica como `Image` y `--location` no se especifica.

`--config-env TEXT`  <a name="sam-cli-command-reference-sam-init-options-config-env"></a>
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](serverless-sam-cli-config.md).

`--config-file PATH`  <a name="sam-cli-command-reference-sam-init-options-config-file"></a>
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 predeterminado 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](serverless-sam-cli-config.md).

`--debug`  <a name="sam-cli-command-reference-sam-init-options-debug"></a>
Activa el registro de depuración para imprimir los mensajes de depuración que genera la AWS SAM de CLI y para mostrar las marcas temporales.

`--dependency-manager, -d [ gradle | mod | maven | bundler | npm | cli-package | pip ]`  <a name="sam-cli-command-reference-sam-init-options-dependency-manager"></a>
El administrador de dependencias de su tiempo de ejecución de Lambda.

`--extra-content`  <a name="sam-cli-command-reference-sam-init-options-extra-content"></a>
Anule cualquier parámetro personalizado de la configuración `cookiecutter.json` de la plantilla, por ejemplo, `{"customParam1": "customValue1", "customParam2":"customValue2"}`.

`--help, -h`  <a name="sam-cli-command-reference-sam-init-options-help"></a>
Muestra este mensaje y sale.

`--location, -l TEXT`  <a name="sam-cli-command-reference-sam-init-options-location"></a>
La ubicación de la plantilla o aplicación (Git, Mercurial, HTTP/HTTPS, archivo.zip, ruta).  
Este parámetro es obligatorio si se especifica `--no-interactive`, `--runtime` o `--name`, y `--app-template` si no se proporciona.  
Para los repositorios Git, debe usar la ubicación de la raíz del repositorio.  
Para las rutas locales, la plantilla debe estar en formato de archivo.zip o [Cookiecutter](https://cookiecutter.readthedocs.io/en/latest/README.html).

`--name, -n TEXT`  <a name="sam-cli-command-reference-sam-init-options-name"></a>
El nombre del proyecto que se generará como un directorio.  
Este parámetro es obligatorio si se especifica `--no-interactive`, y `--location` si no se proporciona.

`--no-input`  <a name="sam-cli-command-reference-sam-init-options-no-input"></a>
Desactiva las solicitudes de Cookiecutter y acepta los valores vcfdefault que se definen en la configuración de plantilla.

`--no-interactive`  <a name="sam-cli-command-reference-sam-init-options-no-interactive"></a>
Deshabilita la solicitud interactiva para los parámetros de inicio y falla si falta algún valor obligatorio.

`--output-dir, -o PATH`  <a name="sam-cli-command-reference-sam-init-options-output-dir"></a>
La ubicación en la que se muestra la aplicación inicializada.

`--package-type [ Zip | Image ]`  <a name="sam-cli-command-reference-sam-init-options-package-type"></a>
El tipo de paquete de la aplicación de ejemplo. `Zip` crea un archivo .zip y `Image` crea una imagen del contenedor.

`--runtime, -r [ dotnet8 | dotnet6 | java25 | java21 | java17 | java11 | nodejs24.x | nodejs22.x | nodejs20.x | nodejs18.x | nodejs16.x | python3.14 | python3.13 | python3.12 | python3.11 | python3.10 | python3.9 | python3.8 | ruby3.4 | ruby3.3 | ruby3.2 ]`  <a name="sam-cli-command-reference-sam-init-options-runtime"></a>
El tiempo de ejecución Lambda de su aplicación. Esta opción solo se aplica cuando el tipo de paquete es `Zip`.  
Este parámetro es obligatorio si `--no-interactive` se especifica, `--package-type` se especifica como `Zip` y `--location` no se especifica.

`--save-params`  <a name="sam-cli-command-reference-sam-init-options-save-params"></a>
Guarde los parámetros que proporcione en la línea de comandos en el archivo AWS SAM de configuración.

`--tracing | --no-tracing`  <a name="sam-cli-command-reference-sam-init-options-tracing"></a>
Active el AWS X-Ray rastreo para sus funciones Lambda.

## Ejemplo
<a name="sam-cli-command-reference-sam-init-examples"></a>

Para ver un ejemplo y un tutorial detallados sobre el uso del subcomando `sam init`, consulte [Crea tu aplicación en AWS SAM](using-sam-cli-init.md).

# sam list
<a name="sam-cli-command-reference-sam-list"></a>

Esta página proporciona información de referencia para el AWS Serverless Application Model comando Command Line Interface (AWS SAMCLI)`sam list`.

Para obtener una introducción al AWS SAMCLI, consulte [¿Qué es el? AWS SAMCLI](what-is-sam-overview.md#what-is-sam-cli)

El comando `sam list` genera información importante sobre los recursos de la aplicación sin servidor y el estado de la aplicación sin servidor. Usa **sam list** antes y después de la implementación para ayudar durante el desarrollo local y en la nube.

## De uso
<a name="sam-cli-command-reference-sam-list-usage"></a>

```
$ sam list <options> <subcommand>
```

## Opciones
<a name="sam-cli-command-reference-sam-list-options"></a>

`--help, -h`  <a name="sam-cli-command-reference-sam-list-options-help"></a>
Muestre este mensaje y salga de él.

## Subcomandos
<a name="sam-cli-command-reference-sam-list-subcommands"></a>

`endpoints`  <a name="sam-cli-command-reference-sam-list-subcommands-endpoints"></a>
Muestra una lista de puntos finales locales y en la nube de su CloudFormation pila. Para obtener más información, consulte [sam list endpoints](sam-cli-command-reference-sam-list-endpoints.md).

`resources`  <a name="sam-cli-command-reference-sam-list-subcommands-resources"></a>
Muestra los recursos de tu plantilla AWS Serverless Application Model (AWS SAM) que se crean en el AWS CloudFormation momento de la implementación. Para obtener más información, consulte [sam list resources](sam-cli-command-reference-sam-list-resources.md).

`stack-outputs`  <a name="sam-cli-command-reference-sam-list-subcommands-stack-outputs"></a>
Muestra los resultados de la CloudFormation pila a partir de una CloudFormation plantilla AWS SAM o. Para obtener más información, consulte [sam list stack-outputs](sam-cli-command-reference-sam-list-stack-outputs.md).

# sam list endpoints
<a name="sam-cli-command-reference-sam-list-endpoints"></a>

Esta página proporciona información de referencia para el AWS Serverless Application Model `sam list endpoints` subcomando Command Line Interface (AWS SAMCLI).

Para obtener una introducción al AWS SAMCLI, consulte [¿Qué es el? AWS SAMCLI](what-is-sam-overview.md#what-is-sam-cli)

El `sam list endpoints` subcomando muestra una lista de puntos finales locales y en la nube de su CloudFormation pila. Puede interactuar con estos recursos mediante los comandos **sam local** y **sam sync**.

AWS Lambda y los tipos de recursos de Amazon API Gateway son compatibles con este comando.

**nota**  
Los dominios personalizados se admiten cuando se configuran para sus recursos de Amazon API Gateway. Este comando generará el dominio personalizado en lugar del punto de conexión predeterminado.

## De uso
<a name="sam-cli-command-reference-sam-list-endpoints-usage"></a>

```
$ sam list endpoints <options>
```

## Opciones
<a name="sam-cli-command-reference-sam-list-endpoints-options"></a>

`--config-env TEXT`  <a name="sam-cli-command-reference-sam-list-endpoints-options-config-env"></a>
El nombre del entorno que especifica los valores de los parámetros predeterminados del archivo de configuración que se va a utilizar.  
*Valor predeterminado:* `default`  
Para obtener más información sobre los archivos de configuración, consulta [Archivo de configuración de la CLI de AWS SAM](serverless-sam-cli-config.md).

`--config-file TEXT`  <a name="sam-cli-command-reference-sam-list-endpoints-options-config-file"></a>
La ruta y el nombre del archivo de configuración que contiene los valores de parámetros predeterminados que se van a utilizar.  
*Valor predeterminado*: `samconfig.toml` en el directorio de trabajo actual.  
Para obtener más información sobre los archivos de configuración, consulta [Archivo de configuración de la CLI de AWS SAM](serverless-sam-cli-config.md).

`--debug`  <a name="sam-cli-command-reference-sam-list-endpoints-options-debug"></a>
Active el registro de depuración para imprimir los mensajes de depuración generados por el AWS SAMCLI con marcas temporales.

`--help, -h`  <a name="sam-cli-command-reference-sam-list-endpoints-options-help"></a>
Muestre este mensaje y salga de él.

`--output [json|table]`  <a name="sam-cli-command-reference-sam-list-endpoints-options-output"></a>
Especifica el formato de salida de los resultados.  
*Valor predeterminado:* `table`

`--profile TEXT`  <a name="sam-cli-command-reference-sam-list-endpoints-options-profile"></a>
Seleccione un perfil específico de su archivo de credenciales para obtener AWS las credenciales.

`--region TEXT`  <a name="sam-cli-command-reference-sam-list-endpoints-options-region"></a>
Defina la AWS región del servicio. Por ejemplo, `us-east-1`.

`--save-params`  <a name="sam-cli-command-reference-sam-list-endpoints-options-save-params"></a>
Guarde los parámetros que proporcione en la línea de comandos en el archivo AWS SAM de configuración.

`--stack-name TEXT`  <a name="sam-cli-command-reference-sam-list-endpoints-options-stack-name"></a>
Nombre de la CloudFormation pila implementada. El nombre de la pila se encuentra en el archivo de la aplicación o en el archivo de configuración `samconfig.toml` designado.  
Si no se especifica esta opción, se mostrarán los recursos locales definidos en la plantilla.

`--template-file, --template, -t PATH`  <a name="sam-cli-command-reference-sam-list-endpoints-options-template"></a>
AWS SAM archivo de plantilla.  
*Valor predeterminado:* `template.[yaml|yml|json]`

## Ejemplos
<a name="sam-cli-command-reference-sam-list-endpoints-examples"></a>

Muestre una salida, en formato json, de los puntos finales de recursos implementados de su CloudFormation pila con el nombre`test-stack`.

```
$ sam list endpoints --stack-name test-stack --output json
			
[
  {
    "LogicalResourceId": "HelloWorldFunction",
    "PhysicalResourceId": "sam-app-test-list-HelloWorldFunction-H85Y7yIV7ZLq",
    "CloudEndpoint": "https://zt55oi7kbljxjmcoahsj3cknwu0rposq.lambda-url.us-east-1.on.aws/",
    "Methods": "-"
  },
  {
    "LogicalResourceId": "ServerlessRestApi",
    "PhysicalResourceId": "uj80uoe2o2",
    "CloudEndpoint": [
      "https://uj80uoe2o2.execute-api.us-east-1.amazonaws.com/Prod",
      "https://uj80uoe2o2.execute-api.us-east-1.amazonaws.com/Stage"
    ],
    "Methods": [
      "/hello['get']"
    ]
  }
]
```

# sam list resources
<a name="sam-cli-command-reference-sam-list-resources"></a>

Esta página proporciona información de referencia para el AWS Serverless Application Model `sam list resources` subcomando Command Line Interface (AWS SAMCLI).

Para obtener una introducción al AWS SAMCLI, consulte [¿Qué es el? AWS SAMCLI](what-is-sam-overview.md#what-is-sam-cli)

El `sam list resources` subcomando muestra los recursos de la plantilla AWS Serverless Application Model (AWS SAM) que se crean AWS CloudFormation mediante la AWS SAM transformación en el momento del despliegue.

**sam list resources**Utilícelo con una AWS SAM plantilla antes del despliegue para ver los recursos que se crearán. Proporcione un nombre de CloudFormation pila para ver una lista consolidada que incluya los recursos desplegados.

**nota**  
Para generar una lista de recursos a partir de la AWS SAM plantilla, se realiza una transformación local de la plantilla. En esta lista se incluyen los recursos que se implementarán con determinadas condiciones, por ejemplo, en una región específica.

## De uso
<a name="sam-cli-command-reference-sam-list-resources-usage"></a>

```
$ sam list resources <options>
```

## Opciones
<a name="sam-cli-command-reference-sam-list-resources-options"></a>

`--config-env TEXT`  <a name="sam-cli-command-reference-sam-list-resources-options-config-env"></a>
El nombre del entorno que especifica los valores de los parámetros predeterminados del archivo de configuración que se va a utilizar.  
*Valor predeterminado:* `default`  
Para obtener más información sobre los archivos de configuración, consulta [Archivo de configuración de la CLI de AWS SAM](serverless-sam-cli-config.md).

`--config-file TEXT`  <a name="sam-cli-command-reference-sam-list-resources-options-config-file"></a>
La ruta y el nombre del archivo de configuración que contiene los valores de parámetros predeterminados que se van a utilizar.  
*Valor predeterminado*: `samconfig.toml` en el directorio de trabajo actual.  
Para obtener más información sobre los archivos de configuración, consulta [Archivo de configuración de la CLI de AWS SAM](serverless-sam-cli-config.md).

`--debug`  <a name="sam-cli-command-reference-sam-list-resources-options-debug"></a>
Active el registro de depuración para imprimir los mensajes de depuración generados por el AWS SAMCLI con marcas temporales.

`--help, -h`  <a name="sam-cli-command-reference-sam-list-resources-options-help"></a>
Muestre este mensaje y salga de él.

`--output [json|table]`  <a name="sam-cli-command-reference-sam-list-resources-options-output"></a>
Especifica el formato de salida de los resultados.  
*Valor predeterminado:* `table`

`--profile TEXT`  <a name="sam-cli-command-reference-sam-list-resources-options-profile"></a>
Seleccione un perfil específico de su archivo de credenciales para obtener AWS las credenciales.

`--region TEXT`  <a name="sam-cli-command-reference-sam-list-resources-options-region"></a>
Defina la AWS región del servicio. Por ejemplo, `us-east-1`.

`--save-params`  <a name="sam-cli-command-reference-sam-list-resources-options-save-params"></a>
Guarde los parámetros que proporcione en la línea de comandos en el archivo AWS SAM de configuración.

`--stack-name TEXT`  <a name="sam-cli-command-reference-sam-list-resources-options-stack-name"></a>
Nombre de la CloudFormation pila implementada. El nombre de la pila se encuentra en el archivo de la aplicación o en el archivo de configuración `samconfig.toml` designado.  
Cuando se proporcione, la lógica IDs de recursos de la plantilla se asignará a su entrada física IDs correspondiente. CloudFormation Para obtener más información sobre la física IDs, consulte [los campos de recursos](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/resources-section-structure.html#resources-section-structure-resource-fields) en la *Guía del AWS CloudFormation usuario*.  
Si no se especifica esta opción, se mostrarán los recursos locales definidos en la plantilla.

`--template-file, --template, -t PATH`  <a name="sam-cli-command-reference-sam-list-resources-options-"></a>
AWS SAM archivo de plantilla.  
*Valor predeterminado:* `template.[yaml|yml|json]`

## Ejemplos
<a name="sam-cli-command-reference-sam-list-resources-examples"></a>

Muestra una salida, en formato de tabla, de los recursos locales de tu AWS SAM plantilla y de los recursos desplegados de tu CloudFormation pila denominada`test-stack`. Se ejecuta en el mismo directorio que la plantilla local.

```
$ sam list resources --stack-name test-stack --output table
			
-------------------------------------------------------------------------------------------------------------------------
Logical ID                                                   Physical ID
-------------------------------------------------------------------------------------------------------------------------
HelloWorldFunction                                           sam-app-test-list-HelloWorldFunction-H85Y7yIV7ZLq
HelloWorldFunctionHelloWorldPermissionProd                   sam-app-test-list-
                                                             HelloWorldFunctionHelloWorldPermissionProd-1QH7CPOCBL2IK
HelloWorldFunctionRole                                       sam-app-test-list-HelloWorldFunctionRole-SRJDMJ6F7F41
ServerlessRestApi                                            uj80uoe2o2
ServerlessRestApiDeployment47fc2d5f9d                        pncw5f
ServerlessRestApiProdStage                                   Prod
ServerlessRestApiDeploymentf5716dc08b                        -
-------------------------------------------------------------------------------------------------------------------------
```

# sam list stack-outputs
<a name="sam-cli-command-reference-sam-list-stack-outputs"></a>

Esta página proporciona información de referencia para el AWS Serverless Application Model `sam list stack-outputs` subcomando Command Line Interface (AWS SAMCLI).

Para obtener una introducción al AWS SAMCLI, consulte [¿Qué es el? AWS SAMCLI](what-is-sam-overview.md#what-is-sam-cli)

El `sam list stack-outputs` subcomando muestra los resultados de la AWS CloudFormation pila a partir de un AWS Serverless Application Model (AWS SAM) o una CloudFormation plantilla. Para obtener más información sobre `Outputs`, consulta [Salidas](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/outputs-section-structure.html) en la *Guía del usuario de AWS CloudFormation *.

## De uso
<a name="sam-cli-command-reference-sam-list-stack-outputs-usage"></a>

```
$ sam list stack-outputs <options>
```

## Opciones
<a name="sam-cli-command-reference-sam-list-stack-outputs-options"></a>

`--config-env TEXT`  <a name="sam-cli-command-reference-sam-list-stack-outputs-options-config-env"></a>
El nombre del entorno que especifica los valores de los parámetros predeterminados del archivo de configuración que se va a utilizar.  
*Valor predeterminado:* `default`  
Para obtener más información sobre los archivos de configuración, consulta [Archivo de configuración de la CLI de AWS SAM](serverless-sam-cli-config.md).

`--config-file TEXT`  <a name="sam-cli-command-reference-sam-list-stack-outputs-options-config-file"></a>
La ruta y el nombre del archivo de configuración que contiene los valores de parámetros predeterminados que se van a utilizar.  
*Valor predeterminado*: `samconfig.toml` en el directorio de trabajo actual.  
Para obtener más información sobre los archivos de configuración, consulta [Archivo de configuración de la CLI de AWS SAM](serverless-sam-cli-config.md).

`--debug`  <a name="sam-cli-command-reference-sam-list-stack-outputs-options-debug"></a>
Active el registro de depuración para imprimir los mensajes de depuración generados por el AWS SAMCLI con marcas temporales.

`--help, -h`  <a name="sam-cli-command-reference-sam-list-stack-outputs-options-help"></a>
Muestre este mensaje y salga de él.

`--output [json|table]`  <a name="sam-cli-command-reference-sam-list-stack-outputs-options-output"></a>
Especifica el formato de salida de los resultados.  
*Valor predeterminado:* `table`

`--profile TEXT`  <a name="sam-cli-command-reference-sam-list-stack-outputs-options-profile"></a>
Seleccione un perfil específico de su archivo de credenciales para obtener AWS las credenciales.

`--region TEXT`  <a name="sam-cli-command-reference-sam-list-stack-outputs-options-region"></a>
Defina la AWS región del servicio. Por ejemplo, `us-east-1`.

`--save-params`  <a name="sam-cli-command-reference-sam-list-stack-outputs-options-save-params"></a>
Guarde los parámetros que proporcione en la línea de comandos en el archivo AWS SAM de configuración.

`--stack-name TEXT`  <a name="sam-cli-command-reference-sam-list-stack-outputs-options-"></a>
Nombre de la CloudFormation pila implementada. El nombre de la pila se encuentra en el archivo de la aplicación o en el archivo de configuración `samconfig.toml` designado.  
Esta opción es obligatoria.

## Ejemplos
<a name="sam-cli-command-reference-sam-list-stack-outputs-examples"></a>

Muestra los resultados, en formato de tabla, de los recursos nombrados en la CloudFormation pila`test-stack`.

```
$ sam list stack-outputs --stack-name test-stack --output table
			
------------------------------------------------------------------------------------------------------------------------
OutputKey                                OutputValue                              Description
------------------------------------------------------------------------------------------------------------------------
HelloWorldFunctionIamRole                arn:aws:iam::account-number:role/sam-      Implicit IAM Role created for Hello
                                         app-test-list-HelloWorldFunctionRole-    World function
                                         SRJDMJ6F7F41
HelloWorldApi                            https://uj80uoe2o2.execute-api.us-       API Gateway endpoint URL for Prod
                                         east-1.amazonaws.com/Prod/hello/         stage for Hello World function
HelloWorldFunction                       arn:aws:lambda:us-                       Hello World Lambda Function ARN
                                         east-1:account-number:function:sam-app-
                                         test-list-
                                         HelloWorldFunction-H85Y7yIV7ZLq
------------------------------------------------------------------------------------------------------------------------
```

# sam local callback
<a name="sam-cli-command-reference-sam-local-callback"></a>

Esta página proporciona información de referencia para el AWS Serverless Application Model comando Command Line Interface (AWS SAMCLI)`sam local callback`.

Para obtener una introducción al AWS SAMCLI, consulte [¿Qué es el? AWS SAMCLI](what-is-sam-overview.md#what-is-sam-cli)

El `sam local callback` comando permite enviar llamadas a la ejecución local de funciones duraderas durante el desarrollo y las pruebas.

## De uso
<a name="sam-cli-command-reference-sam-local-callback-usage"></a>

```
$ sam local callback <subcommand> <options>
```

## Opciones
<a name="sam-cli-command-reference-sam-local-callback-options"></a>

`--help, -h`  <a name="sam-cli-command-reference-sam-local-callback-options-help"></a>
Muestre este mensaje y salga de él.

## Subcomandos
<a name="sam-cli-command-reference-sam-local-callback-subcommands"></a>

`succeed`  <a name="sam-cli-command-reference-sam-local-callback-subcommands-succeed"></a>
Envíe una llamada de éxito a la ejecución de una función duradera. Para obtener más información, consulte [sam local callback succeed](sam-cli-command-reference-sam-local-callback-succeed.md).

`fail`  <a name="sam-cli-command-reference-sam-local-callback-subcommands-fail"></a>
Envíe una llamada de error a la ejecución de una función duradera. Para obtener más información, consulte [sam local callback fail](sam-cli-command-reference-sam-local-callback-fail.md).

`heartbeat`  <a name="sam-cli-command-reference-sam-local-callback-subcommands-heartbeat"></a>
Envíe una llamada rápida a la ejecución de una función duradera. Para obtener más información, consulte [sam local callback heartbeat](sam-cli-command-reference-sam-local-callback-heartbeat.md).

# sam local callback succeed
<a name="sam-cli-command-reference-sam-local-callback-succeed"></a>

Envíe una llamada de éxito a la ejecución de una función duradera.

## De uso
<a name="ref-sam-cli-local-callback-succeed-usage"></a>

```
$ sam local callback succeed CALLBACK_ID [OPTIONS]
```

## Argumentos necesarios
<a name="ref-sam-cli-local-callback-succeed-arguments"></a>

`CALLBACK_ID`  
El identificador único de la devolución de llamada a la que se debe enviar una respuesta correcta.

## Opciones
<a name="ref-sam-cli-local-callback-succeed-options"></a>

`-r, --result TEXT`  
El resultado fue exitoso: carga útil como cadena.

`--region TEXT`  
Defina la AWS región del servicio (por ejemplo,`us-east-1`).

`--profile TEXT`  
Seleccione un perfil específico de su archivo de credenciales para obtener AWS las credenciales.

`--config-env TEXT`  
Nombre del entorno que especifica los valores de los parámetros predeterminados en el archivo de configuración. Valor predeterminado: `default`

`--config-file TEXT`  
Archivo de configuración que contiene los valores de los parámetros predeterminados. Valor predeterminado: `samconfig.toml`

`--save-params`  
Guarde los parámetros proporcionados a través de la línea de comandos en el archivo de configuración.

`--beta-features / --no-beta-features`  
Activar/desactivar las funciones beta.

`--debug`  
Active el registro de depuración para imprimir los mensajes de depuración generados por la AWS SAM CLI y mostrar las marcas de tiempo.

`-h, --help`  
Muestra este mensaje y sale.

## Ejemplos
<a name="ref-sam-cli-local-callback-succeed-examples"></a>

Enviar una llamada de éxito sin resultado:

```
$ sam local callback succeed my-callback-id
```

Envía una llamada de confirmación con el resultado:

```
$ sam local callback succeed my-callback-id --result 'Task completed successfully'
```

Envía una llamada de éxito con una opción corta:

```
$ sam local callback succeed my-callback-id -r 'Success result'
```

# sam local callback fail
<a name="sam-cli-command-reference-sam-local-callback-fail"></a>

Envía una llamada de error a la ejecución de una función duradera.

## De uso
<a name="ref-sam-cli-local-callback-fail-usage"></a>

```
$ sam local callback fail CALLBACK_ID [OPTIONS]
```

## Argumentos necesarios
<a name="ref-sam-cli-local-callback-fail-arguments"></a>

`CALLBACK_ID`  
El identificador único de la devolución de llamada a la que se va a enviar una respuesta de error.

## Opciones
<a name="ref-sam-cli-local-callback-fail-options"></a>

`--error-data TEXT`  
Datos de error adicionales.

`--stack-trace TEXT`  
Apila las entradas de rastreo. Esta opción se puede especificar varias veces.

`--error-type TEXT`  
Tipo de error.

`--error-message TEXT`  
Mensaje de error detallado.

`--region TEXT`  
Defina la AWS región del servicio (por ejemplo,`us-east-1`).

`--profile TEXT`  
Seleccione un perfil específico de su archivo de credenciales para obtener AWS las credenciales.

`--config-env TEXT`  
Nombre del entorno que especifica los valores de los parámetros predeterminados en el archivo de configuración. Valor predeterminado: `default`

`--config-file TEXT`  
Archivo de configuración que contiene los valores de los parámetros predeterminados. Valor predeterminado: `samconfig.toml`

`--save-params`  
Guarde los parámetros proporcionados a través de la línea de comandos en el archivo de configuración.

`--beta-features / --no-beta-features`  
Activar/desactivar las funciones beta.

`--debug`  
Active el registro de depuración para imprimir los mensajes de depuración generados por la AWS SAM CLI y mostrar las marcas de tiempo.

`-h, --help`  
Muestra este mensaje y sale.

## Ejemplos
<a name="ref-sam-cli-local-callback-fail-examples"></a>

Envía una llamada de error sin parámetros:

```
$ sam local callback fail my-callback-id
```

Envía una llamada de error con un mensaje de error:

```
$ sam local callback fail my-callback-id --error-message 'Task failed'
```

Envía una llamada de error con todos los parámetros:

```
$ sam local callback fail my-callback-id --error-message 'Task failed' --error-type 'ValidationError' --stack-trace 'at line 42' --error-data '{"code": 500}'
```

# sam local callback heartbeat
<a name="sam-cli-command-reference-sam-local-callback-heartbeat"></a>

Envíe una llamada de latido a la ejecución de una función duradera.

## De uso
<a name="ref-sam-cli-local-callback-heartbeat-usage"></a>

```
$ sam local callback heartbeat CALLBACK_ID [OPTIONS]
```

## Argumentos necesarios
<a name="ref-sam-cli-local-callback-heartbeat-arguments"></a>

`CALLBACK_ID`  
El identificador único de la devolución de llamada a la que se va a enviar un latido.

## Opciones
<a name="ref-sam-cli-local-callback-heartbeat-options"></a>

`--region TEXT`  
Defina la AWS región del servicio (por ejemplo,`us-east-1`).

`--profile TEXT`  
Seleccione un perfil específico de su archivo de credenciales para obtener AWS las credenciales.

`--config-env TEXT`  
Nombre del entorno que especifica los valores de los parámetros predeterminados en el archivo de configuración. Valor predeterminado: `default`

`--config-file TEXT`  
Archivo de configuración que contiene los valores de los parámetros predeterminados. Valor predeterminado: `samconfig.toml`

`--save-params`  
Guarde los parámetros proporcionados a través de la línea de comandos en el archivo de configuración.

`--beta-features / --no-beta-features`  
Activar/desactivar las funciones beta.

`--debug`  
Active el registro de depuración para imprimir los mensajes de depuración generados por la AWS SAM CLI y mostrar las marcas de tiempo.

`-h, --help`  
Muestra este mensaje y sale.

## Ejemplos
<a name="ref-sam-cli-local-callback-heartbeat-examples"></a>

Enviar una llamada de latido:

```
$ sam local callback heartbeat my-callback-id
```

# sam local execution
<a name="sam-cli-command-reference-sam-local-execution"></a>

Esta página proporciona información de referencia para el AWS Serverless Application Model comando Command Line Interface (AWS SAMCLI)`sam local execution`.

Para obtener una introducción al AWS SAMCLI, consulte [¿Qué es el? AWS SAMCLI](what-is-sam-overview.md#what-is-sam-cli)

El `sam local execution` comando permite gestionar e inspeccionar las ejecuciones locales de funciones duraderas durante el desarrollo y las pruebas.

**nota**  
Es posible que estos comandos no requieran acceso a AWS las credenciales.

## De uso
<a name="sam-cli-command-reference-sam-local-execution-usage"></a>

```
$ sam local execution <subcommand> <options>
```

## Opciones
<a name="sam-cli-command-reference-sam-local-execution-options"></a>

`--help, -h`  <a name="sam-cli-command-reference-sam-local-execution-options-help"></a>
Muestre este mensaje y salga de él.

## Subcomandos
<a name="sam-cli-command-reference-sam-local-execution-subcommands"></a>

`get`  <a name="sam-cli-command-reference-sam-local-execution-subcommands-get"></a>
Obtenga detalles de la ejecución de una función duradera. Para obtener más información, consulte [sam local execution get](sam-cli-command-reference-sam-local-execution-get.md).

`history`  <a name="sam-cli-command-reference-sam-local-execution-subcommands-history"></a>
Obtenga el historial de ejecución de una función duradera. Para obtener más información, consulte [sam local execution history](sam-cli-command-reference-sam-local-execution-history.md).

`stop`  <a name="sam-cli-command-reference-sam-local-execution-subcommands-stop"></a>
Detenga la ejecución duradera de una función. Para obtener más información, consulte [sam local execution stop](sam-cli-command-reference-sam-local-execution-stop.md).

# sam local execution get
<a name="sam-cli-command-reference-sam-local-execution-get"></a>

Recupera los detalles de la ejecución de una función duradera específica.

**nota**  
Es posible que este comando no requiera acceso a AWS las credenciales.

## De uso
<a name="ref-sam-cli-local-execution-get-usage"></a>

```
$ sam local execution get DURABLE_EXECUTION_ARN [OPTIONS]
```

## Argumentos necesarios
<a name="ref-sam-cli-local-execution-get-arguments"></a>

`DURABLE_EXECUTION_ARN`  
El nombre del recurso de Amazon (ARN) de la ejecución de la función duradera de la que se van a recuperar los detalles.

## Opciones
<a name="ref-sam-cli-local-execution-get-options"></a>

`--format [summary|json]`  
Formato de salida. Valor predeterminado: `summary`

`--region TEXT`  
Defina la AWS región del servicio (por ejemplo,`us-east-1`).

`--profile TEXT`  
Seleccione un perfil específico de su archivo de credenciales para obtener AWS las credenciales.

`--config-env TEXT`  
Nombre del entorno que especifica los valores de los parámetros predeterminados en el archivo de configuración. Valor predeterminado: `default`

`--config-file TEXT`  
Archivo de configuración que contiene los valores de los parámetros predeterminados. Valor predeterminado: `samconfig.toml`

`--save-params`  
Guarde los parámetros proporcionados a través de la línea de comandos en el archivo de configuración.

`--beta-features / --no-beta-features`  
Activar/desactivar las funciones beta.

`--debug`  
Active el registro de depuración para imprimir los mensajes de depuración generados por la AWS SAM CLI y mostrar las marcas de tiempo.

`-h, --help`  
Muestra este mensaje y sale.

## Ejemplos
<a name="ref-sam-cli-local-execution-get-examples"></a>

Obtenga los detalles de la ejecución con el formato de resumen predeterminado:

```
$ sam local execution get arn:aws:lambda:us-east-1:123456789012:function:MyFunction:$LATEST/durable-execution/my-execution-name/my-execution-id
```

Obtenga los detalles de la ejecución en formato JSON:

```
$ sam local execution get arn:aws:lambda:us-east-1:123456789012:function:MyFunction:$LATEST/durable-execution/my-execution-name/my-execution-id --format json
```

# sam local execution history
<a name="sam-cli-command-reference-sam-local-execution-history"></a>

Obtenga el historial de ejecución de una función duradera.

## De uso
<a name="ref-sam-cli-local-execution-history-usage"></a>

```
$ sam local execution history EXECUTION_ID [OPTIONS]
```

## Argumentos necesarios
<a name="ref-sam-cli-local-execution-history-arguments"></a>

`EXECUTION_ID`  
El identificador único de la ejecución duradera de la función de la que se va a recuperar el historial.

## Opciones
<a name="ref-sam-cli-local-execution-history-options"></a>

`--format [table|json]`  
Formato de salida. Valor predeterminado: `table`

`--region TEXT`  
Defina la AWS región del servicio (por ejemplo,`us-east-1`).

`--profile TEXT`  
Seleccione un perfil específico de su archivo de credenciales para obtener AWS las credenciales.

`--config-env TEXT`  
Nombre del entorno que especifica los valores de los parámetros predeterminados en el archivo de configuración. Valor predeterminado: `default`

`--config-file TEXT`  
Archivo de configuración que contiene los valores de los parámetros predeterminados. Valor predeterminado: `samconfig.toml`

`--save-params`  
Guarde los parámetros proporcionados a través de la línea de comandos en el archivo de configuración.

`--beta-features / --no-beta-features`  
Activar/desactivar las funciones beta.

`--debug`  
Active el registro de depuración para imprimir los mensajes de depuración generados por la AWS SAM CLI y mostrar las marcas de tiempo.

`-h, --help`  
Muestra este mensaje y sale.

## Ejemplos
<a name="ref-sam-cli-local-execution-history-examples"></a>

Obtenga el historial de ejecuciones en formato de tabla:

```
$ sam local execution history my-execution-id
```

Obtenga el historial de ejecuciones en formato JSON:

```
$ sam local execution history my-execution-id --format json
```

# sam local execution stop
<a name="sam-cli-command-reference-sam-local-execution-stop"></a>

Detenga la ejecución de una función duradera en ejecución.

**nota**  
Es posible que este comando no requiera acceso a AWS las credenciales.

## De uso
<a name="ref-sam-cli-local-execution-stop-usage"></a>

```
$ sam local execution stop DURABLE_EXECUTION_ARN [OPTIONS]
```

## Argumentos necesarios
<a name="ref-sam-cli-local-execution-stop-arguments"></a>

`DURABLE_EXECUTION_ARN`  
El nombre del recurso de Amazon (ARN) de la ejecución duradera de la función que se va a detener.

## Opciones
<a name="ref-sam-cli-local-execution-stop-options"></a>

`--error-message TEXT`  
Mensaje de error asociado a la ejecución detenida.

`--error-type TEXT`  
Tipo de error que se va a asociar a la ejecución detenida.

`--error-data TEXT`  
Datos de error que se van a asociar a la ejecución detenida.

`--stack-trace TEXT`  
Apila las entradas de rastreo. Esta opción se puede especificar varias veces.

`--region TEXT`  
Defina la AWS región del servicio (por ejemplo,`us-east-1`).

`--profile TEXT`  
Seleccione un perfil específico de su archivo de credenciales para obtener AWS las credenciales.

`--config-env TEXT`  
Nombre del entorno que especifica los valores de los parámetros predeterminados en el archivo de configuración. Valor predeterminado: `default`

`--config-file TEXT`  
Archivo de configuración que contiene los valores de los parámetros predeterminados. Valor predeterminado: `samconfig.toml`

`--save-params`  
Guarde los parámetros proporcionados a través de la línea de comandos en el archivo de configuración.

`--beta-features / --no-beta-features`  
Activar/desactivar las funciones beta.

`--debug`  
Active el registro de depuración para imprimir los mensajes de depuración generados por la AWS SAM CLI y mostrar las marcas de tiempo.

`-h, --help`  
Muestra este mensaje y sale.

## Ejemplos
<a name="ref-sam-cli-local-execution-stop-examples"></a>

Detenga la ejecución sin detalles del error:

```
$ sam local execution stop arn:aws:lambda:us-east-1:123456789012:function:MyFunction:$LATEST/durable-execution/my-execution-name/my-execution-id
```

Detenga la ejecución con un mensaje de error y escriba:

```
$ sam local execution stop arn:aws:lambda:us-east-1:123456789012:function:MyFunction:$LATEST/durable-execution/my-execution-name/my-execution-id --error-message "Execution cancelled" --error-type "UserCancellation"
```

Detenga la ejecución con todos los detalles del error y el seguimiento de la pila:

```
$ sam local execution stop arn:aws:lambda:us-east-1:123456789012:function:MyFunction:$LATEST/durable-execution/my-execution-name/my-execution-id --error-message "Task failed" --error-type "TaskFailure" --error-data '{"reason":"timeout"}' --stack-trace "at function1()" --stack-trace "at function2()"
```

# sam local generate-event
<a name="sam-cli-command-reference-sam-local-generate-event"></a>

Esta página proporciona información de referencia para el AWS Serverless Application Model `sam local generate-event` subcomando de la interfaz de línea de comandos (AWS SAMCLI).
+ Para obtener una introducción al AWS SAMCLI, consulte [¿Qué es el? AWS SAMCLI](what-is-sam-overview.md#what-is-sam-cli)
+ Para obtener documentación sobre el uso del AWS SAMCLI `sam local generate-event` comando, consulte[Introducción a las pruebas con sam local generate-event](using-sam-cli-local-generate-event.md).

El subcomando `sam local generate-event` genera muestras de carga útil de eventos para los Servicios de AWS compatibles.

## De uso
<a name="ref-sam-cli-local-generate-event-usage"></a>

```
$ sam local generate-event <options> <service> <event> <event-options>
```

## Opciones
<a name="ref-sam-cli-local-generate-event-options"></a>

`--config-env TEXT`  <a name="ref-sam-cli-local-generate-event-options-config-env"></a>
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](serverless-sam-cli-config.md).

`--config-file PATH`  <a name="ref-sam-cli-local-generate-event-options-config-file"></a>
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](serverless-sam-cli-config.md).

`--help`  <a name="ref-sam-cli-local-generate-event-options-help"></a>
Muestra este mensaje y sale.

## Servicio
<a name="ref-sam-cli-local-generate-event-service"></a>

Para ver una lista de los servicios compatibles, ejecuta lo siguiente:

```
$ sam local generate-event
```

## Event
<a name="ref-sam-cli-local-generate-event-event"></a>

Para ver una lista de los eventos compatibles que se pueden generar para cada servicio, ejecuta lo siguiente:

```
$ sam local generate-event <service>
```

## Opciones de eventos
<a name="ref-sam-cli-local-generate-event-event-options"></a>

Para ver una lista de las opciones de eventos compatibles que puede modificar, ejecuta lo siguiente:

```
$ sam local generate-event <service> <event> --help
```

## Ejemplos
<a name="sam-cli-command-reference-sam-local-generate-event-examples"></a>

Para ver ejemplos sobre el uso del subcomando `sam local generate-event`, consulte [Generar eventos de ejemplo](using-sam-cli-local-generate-event.md#using-sam-cli-local-generate-event-generate).

# sam local invoke
<a name="sam-cli-command-reference-sam-local-invoke"></a>

Esta página proporciona información de referencia para el AWS Serverless Application Model `sam local invoke` subcomando de la interfaz de línea de comandos (AWS SAMCLI).
+ Para obtener una introducción al AWS SAMCLI, consulte [¿Qué es el? AWS SAMCLI](what-is-sam-overview.md#what-is-sam-cli)
+ Para obtener documentación sobre el uso del AWS SAMCLI `sam local invoke` subcomando, consulte[Introducción a las pruebas con sam local invoke](using-sam-cli-local-invoke.md).

El `sam local invoke` subcomando inicia una invocación única de una función de forma local. AWS Lambda 

**nota**  
No se recomienda utilizar las capacidades de invocación local de la CLI de SAM en código que no sea de confianza. Para tener un aislamiento completo del entorno local, ejecute el código directamente en el servicio Lambda.

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

## De uso
<a name="ref-sam-cli-local-invoke-usage"></a>

```
$ sam local invoke <arguments> <options>
```

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

## Argumentos
<a name="ref-sam-cli-local-invoke-args"></a>

**Resource ID (ID de recurso)**  <a name="ref-sam-cli-local-invoke-args-resource-id"></a>
El ID de la función de Lambda que se invocará.  
Este argumento es opcional. Si la aplicación contiene una sola función Lambda, la AWS SAM 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
<a name="ref-sam-cli-local-invoke-options"></a>

`--add-host LIST`  <a name="ref-sam-cli-local-invoke-options-add-host"></a>
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.  

**Example**  
Ejemplo: `--add-host example.com:127.0.0.1`

`--beta-features | --no-beta-features`  <a name="ref-sam-cli-local-invoke-options-beta-features"></a>
Permitir o denegar las características beta.

`--config-env TEXT`  <a name="ref-sam-cli-local-invoke-options-config-env"></a>
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](serverless-sam-cli-config.md).

`--config-file PATH`  <a name="ref-sam-cli-local-invoke-options-config-file"></a>
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](serverless-sam-cli-config.md).

`--container-env-vars`  <a name="ref-sam-cli-local-invoke-options-container-env-vars"></a>
(Opcional) Pase las variables de entorno al contenedor de imágenes de la función de Lambda al depurar localmente.

`--container-host TEXT`  <a name="ref-sam-cli-local-invoke-options-container-host"></a>
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 de AWS SAMCLI, puede especificar la dirección IP del host remoto.

`--container-host-interface TEXT`  <a name="ref-sam-cli-local-invoke-options-container-host-interface"></a>
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.

`--debug`  <a name="ref-sam-cli-local-invoke-options-debug"></a>
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`  <a name="ref-sam-cli-local-invoke-options-debug-args"></a>
Argumentos opcionales que se pasan al depurador.

`--debug-port, -d TEXT`  <a name="ref-sam-cli-local-invoke-options-debug-port"></a>
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`  <a name="ref-sam-cli-local-invoke-options-debugger-path"></a>
La ruta del host a un depurador montado en el contenedor de Lambda.

`--docker-network TEXT`  <a name="ref-sam-cli-local-invoke-options-docker-network"></a>
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`  <a name="ref-sam-cli-local-invoke-options-docker-volume-basedir"></a>
La ubicación del directorio base en el que se encuentra el AWS SAM archivo. Si Docker se ejecuta en una máquina remota, debe montar la ruta en la que se encuentra el AWS SAM archivo en la máquina Docker y modificar este valor para que coincida con la máquina remota.

`--durable-execution-name TEXT`  <a name="ref-sam-cli-local-invoke-options-durable-execution-name"></a>
Nombre de la ejecución duradera (solo para funciones duraderas)

`--env-vars, -n PATH`  <a name="ref-sam-cli-local-invoke-options-env-vars"></a>
El JSON o el `.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](serverless-sam-cli-using-invoke.md#serverless-sam-cli-using-invoke-environment-file).

`--event, -e PATH`  <a name="ref-sam-cli-local-invoke-options-event"></a>
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 formatos de los mensajes de eventos de AWS los distintos servicios, consulte [Trabajar con otros servicios](https://docs.aws.amazon.com/lambda/latest/dg/lambda-services.html) en la *Guía para AWS Lambda desarrolladores*.

`--force-image-build`  <a name="ref-sam-cli-local-invoke-options-force-image-build"></a>
Especifica si la CLI de AWS SAM debe reconstruir la imagen utilizada para invocar funciones de Lambda con capas.

`--help`  <a name="ref-sam-cli-local-invoke-options-help"></a>
Muestra este mensaje y sale.

`--hook-name TEXT`  <a name="ref-sam-cli-local-invoke-options-hook-name"></a>
El nombre del enlace que se utiliza para ampliar la funcionalidad de la CLI de AWS SAM.  
Valores aceptados: `terraform`.

`--invoke-image TEXT`  <a name="ref-sam-cli-local-invoke-options-invoke-image"></a>
El URI de la imagen del contenedor que quieres usar para la invocación de la función local. 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](serverless-image-repositories.md)). Utiliza esta opción para extraer la imagen desde otra ubicación.  
Por ejemplo, `sam local invoke MyFunction --invoke-image amazon/aws-sam-cli-emulation-image-python3.8`.

`--layer-cache-basedir DIRECTORY`  <a name="ref-sam-cli-local-invoke-options-layer-cache-basedir"></a>
Especifica la ubicación del directorio base en el que se descargan las capas que utiliza la plantilla.

`--log-file, -l TEXT`  <a name="ref-sam-cli-local-invoke-options-log-file"></a>
El archivo de registro al que se van a enviar los registros de tiempo de ejecución.

`--mount-symlinks`  <a name="ref-sam-cli-local-invoke-options-mount-symlinks"></a>
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`  <a name="ref-sam-cli-local-invoke-options-no-event"></a>
Invoca la función con un evento vacío.

`--no-memory-limit`  <a name="ref-sam-cli-local-invoke-options-no-memory-limit"></a>
Elimina la limitación de memoria en el contenedor durante la invocación local, incluso cuando la memoria está configurada en la AWS SAM plantilla.

`--parameter-overrides`  <a name="ref-sam-cli-local-invoke-options-parameter-overrides"></a>
Cadena que contiene anulaciones de CloudFormation parámetros codificadas como pares clave-valor. Usa el mismo formato que (). 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`  <a name="ref-sam-cli-local-invoke-options-profile"></a>
El perfil específico del archivo de credenciales que recibe AWS las credenciales.

`--region TEXT`  <a name="ref-sam-cli-local-invoke-options-region"></a>
La AWS región en la que se va a realizar el despliegue. Por ejemplo, us-east-1.

`--runtime TEXT`  <a name="ref-sam-cli-local-invoke-options-runtime"></a>
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`  <a name="ref-sam-cli-local-invoke-options-save-params"></a>
Guarde los parámetros que proporcione en la línea de comandos en el archivo AWS SAM de configuración.

`--shutdown`  <a name="ref-sam-cli-local-invoke-options-shutdown"></a>
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`  <a name="ref-sam-cli-local-invoke-options-skip-prepare-infra"></a>
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`  <a name="ref-sam-cli-local-invoke-options-skip-pull-image"></a>
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`  <a name="ref-sam-cli-local-invoke-options-template"></a>
El archivo AWS SAM de plantilla.  
Esta opción no es compatible con `--hook-name`.  
Si especifica esta opción, AWS SAM carga únicamente la plantilla y los recursos locales a los que apunta.

`--tenant-id TEXT`  <a name="ref-sam-cli-local-invoke-options-tenancyconfig"></a>
El ID de inquilino de las funciones Lambda multiusuario. Se utiliza para garantizar el aislamiento informático entre distintos inquilinos. Se requiere cuando se invocan funciones configuradas con el modo de aislamiento de inquilinos.

`--terraform-plan-file`  <a name="ref-sam-cli-local-invoke-options-terraform-plan-file"></a>
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
<a name="sam-cli-command-reference-sam-local-invoke-examples"></a>

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
```

# sam local start-api
<a name="sam-cli-command-reference-sam-local-start-api"></a>

Esta página proporciona información de referencia para el AWS Serverless Application Model `sam local start-api` subcomando de la interfaz de línea de comandos (AWS SAMCLI).
+ Para obtener una introducción al AWS SAMCLI, consulte [¿Qué es el? AWS SAMCLI](what-is-sam-overview.md#what-is-sam-cli)
+ Para obtener documentación sobre el uso del AWS SAMCLI `sam local start-api` subcomando, consulte[Introducción a las pruebas con sam local start-api](using-sam-cli-local-start-api.md).

El `sam local start-api` subcomando ejecuta AWS Lambda las funciones de forma local para probarlas a través de un servidor HTTP local.

## De uso
<a name="ref-sam-cli-local-start-api-usage"></a>

```
$ sam local start-api <options>
```

## Opciones
<a name="ref-sam-cli-local-start-api-options"></a>

`--add-host LIST`  <a name="ref-sam-cli-local-start-api-options-add-host"></a>
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.  

**Example**  
Ejemplo: `--add-host example.com:127.0.0.1`

`--beta-features | --no-beta-features`  <a name="ref-sam-cli-local-start-api-options-beta-features"></a>
Permitir o denegar las características beta.

`--config-env TEXT`  <a name="ref-sam-cli-local-start-api-options-config-env"></a>
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](serverless-sam-cli-config.md).

`--config-file PATH`  <a name="ref-sam-cli-local-start-api-options-config-file"></a>
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 predeterminado 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](serverless-sam-cli-config.md).

`--container-env-vars`  <a name="ref-sam-cli-local-start-api-options-container-env-vars"></a>
Opcional. Al realizar la depuración local, pasa las variables de entorno al contenedor de imágenes.

`--container-host TEXT`  <a name="ref-sam-cli-local-start-api-options-container-host"></a>
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 de AWS SAMCLI, puede especificar la dirección IP del host remoto.

`--container-host-interface TEXT`  <a name="ref-sam-cli-local-start-api-options-container-host-interface"></a>
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.

`--debug`  <a name="ref-sam-cli-local-start-api-options-debug"></a>
Activa el registro de depuración para imprimir el mensaje de depuración que genera la CLI de AWS SAM y muestra las marcas temporales.

`--debug-args TEXT`  <a name="ref-sam-cli-local-start-api-options-debug-args"></a>
Los argumentos adicionales que se pasarán al depurador.

`--debug-function`  <a name="ref-sam-cli-local-start-api-options-debug-function"></a>
Opcional. Especifica la función de Lambda a la que se aplicarán las opciones de depuración cuando `--warm-containers` se especifica. Este parámetro se aplica a `--debug-port`, `--debugger-path` y `--debug-args`.

`--debug-port, -d TEXT`  <a name="ref-sam-cli-local-start-api-options-debug-port"></a>
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`  <a name="ref-sam-cli-local-start-api-options-debugger-path"></a>
La ruta del host a un depurador que se montará en el contenedor de Lambda.

`--docker-network TEXT`  <a name="ref-sam-cli-local-start-api-options-docker-network"></a>
Especifica 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 solo se conectan a la red Docker en modo puente predeterminada.

` --docker-volume-basedir, -v TEXT`  <a name="ref-sam-cli-local-start-api-options-docker-volume-basedir"></a>
La ubicación del directorio base en el que se encuentra el AWS SAM archivo. Si Docker se ejecuta en una máquina remota, debe montar la ruta en la que se encuentra el AWS SAM archivo en la máquina Docker y modificar este valor para que coincida con la máquina remota.

`--env-vars, -n PATH`  <a name="ref-sam-cli-local-start-api-options-env-vars"></a>
El JSON o el `.env` archivo que contiene los valores de las variables de entorno de la función Lambda. El formato del archivo se detecta automáticamente.

`--force-image-build`  <a name="ref-sam-cli-local-start-api-options-force-image-build"></a>
Especifica si se AWS SAM CLI debe reconstruir la imagen utilizada para invocar funciones con capas.

`--help`  <a name="ref-sam-cli-local-start-api-options-help"></a>
Muestra este mensaje y sale.

`--hook-name TEXT`  <a name="ref-sam-cli-local-start-api-options-hook-name"></a>
El nombre del enlace que se utiliza para ampliar la funcionalidad de la CLI de AWS SAM.  
Valores aceptados: `terraform`.

`--host TEXT`  <a name="ref-sam-cli-local-start-api-options-host"></a>
El nombre de host local o la dirección IP a la que se va a vincular (predeterminado: «127.0.0.1»).

`--invoke-image TEXT`  <a name="ref-sam-cli-local-start-api-options-invoke-image"></a>
El URI de la imagen del contenedor que quiere usar para las funciones de Lambda. De forma predeterminada, AWS SAM extrae la imagen del contenedor de Amazon ECR Public. Utiliza esta opción para extraer la imagen desde otra ubicación.  
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 start-api --invoke-image public.ecr.aws/sam/emu-python3.8`. 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 start-api --invoke-image public.ecr.aws/sam/emu-python3.8 --invoke-image Function1=amazon/aws-sam-cli-emulation-image-python3.8 `. Con los pares clave-valor, puede especificar distintas imágenes de contenedor para distintos recursos.

`--layer-cache-basedir DIRECTORY`  <a name="ref-sam-cli-local-start-api-options-layer-cache-basedir"></a>
Especifica la ubicación basada en el lugar en el que se descargan las capas que utiliza la plantilla.

`--log-file, -l TEXT`  <a name="ref-sam-cli-local-start-api-options-log-file"></a>
El archivo de registro al que se van a enviar los registros de tiempo de ejecución.

`--no-memory-limit`  <a name="ref-sam-cli-local-start-api-options-no-memory-limit"></a>
Elimina la limitación de memoria en el contenedor durante la invocación local, incluso cuando la memoria está configurada en la plantilla. AWS SAM 

`--parameter-overrides`  <a name="ref-sam-cli-local-start-api-options-parameter-overrides"></a>
Cadena que contiene anulaciones de CloudFormation parámetros codificadas como pares clave-valor. Usa el mismo formato que (). 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`

`--port, -p INTEGER`  <a name="ref-sam-cli-local-start-api-options-port"></a>
El número de puerto local en el que se va a escuchar (valor predeterminado: «3000»).

`--profile TEXT`  <a name="ref-sam-cli-local-start-api-options-profile"></a>
El perfil específico del archivo de credenciales que recibe AWS las credenciales.

`--region TEXT`  <a name="ref-sam-cli-local-start-api-options-region"></a>
La AWS región en la que se va a realizar el despliegue. Por ejemplo, us-east-1.

`--save-params`  <a name="ref-sam-cli-local-start-api-options-save-params"></a>
Guarde los parámetros que proporcione en la línea de comandos en el archivo AWS SAM de configuración.

`--shutdown`  <a name="ref-sam-cli-local-start-api-options-shutdown"></a>
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`  <a name="ref-sam-cli-local-start-api-options-skip-prepare-infra"></a>
Omite la fase de preparación si no se ha realizado ningún cambio en la infraestructura. Úsalo con la opción `--hook-name`.

`--skip-pull-image`  <a name="ref-sam-cli-local-start-api-options-skip-pull-image"></a>
Especifica si la CLI debe omitir la extracción de la última imagen de Docker para el tiempo de ejecución de Lambda.

`--ssl-cert-file PATH`  <a name="ref-sam-cli-local-start-api-options-ssl-cert-file"></a>
Ruta al archivo de certificado SSL (predeterminado: ninguno). Al usar esta opción, también debes usarse la opción `--ssl-key-file`.

`--ssl-key-file PATH`  <a name="ref-sam-cli-local-start-api-options-static-dir"></a>
Ruta al archivo de clave SSL (predeterminado: ninguno). Al usar esta opción, también debes usarse la opción `--ssl-cert-file`.

`--static-dir, -s TEXT`  <a name="ref-sam-cli-local-start-api-options-static-dir"></a>
Todos los archivos de activos estáticos (por ejemplo,CSS/JavaScript/HTML) ubicados en este directorio se presentan en`/`.

`--template, -t PATH`  <a name="ref-sam-cli-local-start-api-options-template"></a>
El archivo AWS SAM de plantilla.  
Si especifica esta opción, AWS SAM carga únicamente la plantilla y los recursos locales a los que apunta.

`--terraform-plan-file`  <a name="ref-sam-cli-local-start-api-options-terraform-plan-file"></a>
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`.

`--warm-containers [EAGER | LAZY]`  <a name="ref-sam-cli-local-start-api-options-warm-containers"></a>
Opcional. Especifica cómo la CLI de AWS SAM administra los contenedores para cada función.  
Hay dos opciones disponibles:  
   `EAGER`: los contenedores de todas las funciones se cargan al inicio y se conservan entre las invocaciones.  
   `LAZY`: los contenedores solo se cargan cuando se invoca cada función por primera vez. Esos contenedores se conservan para realizar más invocaciones.

## Ejemplo
<a name="sam-cli-command-reference-sam-local-start-api-examples"></a>

En el siguiente ejemplo se inicia un servidor local, lo que le permite probar la aplicación mediante la API. Para que este comando funcione, la aplicación debe estar instalada y Docker debe estar en ejecución.

```
$ sam local start-api --port 3000
```

# sam local start-lambda
<a name="sam-cli-command-reference-sam-local-start-lambda"></a>

Esta página proporciona información de referencia para el AWS Serverless Application Model `sam local start-lambda` subcomando de la interfaz de línea de comandos (AWS SAMCLI).
+ Para obtener una introducción al AWS SAMCLI, consulte [¿Qué es el? AWS SAMCLI](what-is-sam-overview.md#what-is-sam-cli)
+ Para obtener documentación sobre el uso del AWS SAMCLI `sam local start-lambda` subcomando, consulte[Introducción a las pruebas con sam local start-lambda](using-sam-cli-local-start-lambda.md).

El subcomando `sam local start-lambda` inicia un punto de conexión local para emular AWS Lambda.

## De uso
<a name="ref-sam-cli-local-start-lambda-usage"></a>

```
$ sam local start-lambda <options>
```

## Opciones
<a name="ref-sam-cli-local-start-lambda-options"></a>

`--add-host LIST`  <a name="ref-sam-cli-local-start-lambda-options-add-host"></a>
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.  

**Example**  
Ejemplo: `--add-host example.com:127.0.0.1`

`--beta-features | --no-beta-features`  <a name="ref-sam-cli-local-start-lambda-options-beta-features"></a>
Permitir o denegar las características beta.

`--config-env TEXT`  <a name="ref-sam-cli-local-start-lambda-options-config-env"></a>
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](serverless-sam-cli-config.md).

`--config-file PATH`  <a name="ref-sam-cli-local-start-lambda-options-config-file"></a>
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 predeterminado 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](serverless-sam-cli-config.md).

`--container-env-vars`  <a name="ref-sam-cli-local-start-lambda-options-container-env-vars"></a>
Opcional. Al realizar la depuración local, pasa las variables de entorno al contenedor de imágenes.

`--container-host TEXT`  <a name="ref-sam-cli-local-start-lambda-options-container-host"></a>
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 de AWS SAMCLI, puede especificar la dirección IP del host remoto.

`--container-host-interface TEXT`  <a name="ref-sam-cli-local-start-lambda-options-container-host-interface"></a>
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.

`--debug`  <a name="ref-sam-cli-local-start-lambda-options-debug"></a>
Activa el registro de depuración para imprimir el mensaje de depuración que genera la CLI de AWS SAM y muestra las marcas temporales.

`--debug-args TEXT`  <a name="ref-sam-cli-local-start-lambda-options-debug-args"></a>
Los argumentos adicionales que se pasarán al depurador.

`--debug-function`  <a name="ref-sam-cli-local-start-lambda-options-debug-function"></a>
Opcional. Especifica la función de Lambda a la que se aplicarán las opciones de depuración cuando `--warm-containers` se especifica. Este parámetro se aplica a `--debug-port`, `--debugger-path` y `--debug-args`.

`--debug-port, -d TEXT`  <a name="ref-sam-cli-local-start-lambda-options-debug-port"></a>
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`  <a name="ref-sam-cli-local-start-lambda-options-debugger-path"></a>
La ruta del host a un depurador que se montará en el contenedor de Lambda.

`--docker-network TEXT`  <a name="ref-sam-cli-local-start-lambda-options-docker-network"></a>
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 solo a la red Docker en modo puente predeterminada.

`--docker-volume-basedir, -v TEXT`  <a name="ref-sam-cli-local-start-lambda-options-docker-volume-basedir"></a>
La ubicación del directorio base en el que se encuentra el AWS SAM archivo. Si Docker se ejecuta en una máquina remota, debe montar la ruta en la que se encuentra el AWS SAM archivo en la máquina Docker y modificar este valor para que coincida con la máquina remota.

`--env-vars, -n PATH`  <a name="ref-sam-cli-local-start-lambda-options-env-vars"></a>
El JSON o el `.env` archivo que contiene los valores de las variables de entorno de la función Lambda. El formato del archivo se detecta automáticamente.

`--force-image-build`  <a name="ref-sam-cli-local-start-lambda-options-force-image-build"></a>
Especifica si la CLI debe reconstruir la imagen utilizada para invocar funciones con capas.

`--help`  <a name="ref-sam-cli-local-start-lambda-options-help"></a>
Muestra este mensaje y sale.

`--hook-name TEXT`  <a name="ref-sam-cli-local-start-lambda-options-hook-name"></a>
El nombre del enlace que se utiliza para ampliar la funcionalidad de la CLI de AWS SAM.  
Valores aceptados: `terraform`.

`--host TEXT`  <a name="ref-sam-cli-local-start-lambda-options-host"></a>
El nombre de host local o la dirección IP a la que se va a vincular (predeterminado: «127.0.0.1»).

`--invoke-image TEXT`  <a name="ref-sam-cli-local-start-lambda-options-invoke-image"></a>
El URI de la imagen del contenedor que quiere usar para la invocación de la función local. De forma predeterminada, AWS SAM extrae la imagen del contenedor de Amazon ECR Public. Utiliza esta opción para extraer la imagen desde otra ubicación.  
Por ejemplo, `sam local start-lambda MyFunction --invoke-image amazon/aws-sam-cli-emulation-image-python3.8`.

`--layer-cache-basedir DIRECTORY`  <a name="ref-sam-cli-local-start-lambda-options-layer-cache-basedir"></a>
Especifica la ubicación basada en el lugar en el que se descargan las capas que utiliza la plantilla.

`--log-file, -l TEXT`  <a name="ref-sam-cli-local-start-lambda-options-log-file"></a>
El archivo de registro al que se van a enviar los registros de tiempo de ejecución.

`--no-memory-limit`  <a name="ref-sam-cli-local-start-lambda-options-no-memory-limit"></a>
Elimina la limitación de memoria en el contenedor durante la invocación local, incluso cuando la memoria está configurada en la plantilla. AWS SAM 

`--parameter-overrides`  <a name="ref-sam-cli-local-start-lambda-options-parameter-overrides"></a>
Cadena que contiene anulaciones de CloudFormation parámetros codificadas como pares clave-valor. Usa el mismo formato que (). 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`

`--port, -p INTEGER`  <a name="ref-sam-cli-local-start-lambda-options-port"></a>
El número de puerto local en el que se va a escuchar (valor predeterminado: «3001»).

`--profile TEXT`  <a name="ref-sam-cli-local-start-lambda-options-profile"></a>
El perfil específico del archivo de credenciales que recibe AWS las credenciales.

`--region TEXT`  <a name="ref-sam-cli-local-start-lambda-options-region"></a>
La AWS región en la que se va a realizar el despliegue. Por ejemplo, us-east-1.

`--save-params`  <a name="ref-sam-cli-local-start-lambda-options-save-params"></a>
Guarde los parámetros que proporcione en la línea de comandos en el archivo AWS SAM de configuración.

`--shutdown`  <a name="ref-sam-cli-local-start-lambda-options-shutdown"></a>
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`  <a name="ref-sam-cli-local-start-lambda-options-skip-prepare-infra"></a>
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`  <a name="ref-sam-cli-local-start-lambda-options-skip-pull-image"></a>
Especifica si la CLI debe omitir la extracción de la última imagen de Docker para el tiempo de ejecución de Lambda.

`--template, -t PATH`  <a name="ref-sam-cli-local-start-lambda-options-template"></a>
El archivo AWS SAM de plantilla.  
Si especifica esta opción, AWS SAM carga únicamente la plantilla y los recursos locales a los que apunta. Esta opción no es compatible con `--hook-name`.

`--terraform-plan-file`  <a name="ref-sam-cli-local-start-lambda-options-terraform-plan-file"></a>
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`.

`--warm-containers [EAGER | LAZY]`  <a name="ref-sam-cli-local-start-lambda-options-warm-containers"></a>
Opcional. Especifica cómo la CLI de AWS SAM administra los contenedores para cada función.  
Hay dos opciones disponibles:  
+ `EAGER`: los contenedores de todas las funciones se cargan al inicio y se conservan entre las invocaciones.
+ `LAZY`: los contenedores solo se cargan cuando se invoca cada función por primera vez. Esos contenedores se conservan para realizar más invocaciones.

## Ejemplo
<a name="sam-cli-command-reference-sam-local-start-lambda-examples"></a>

Para ver un ejemplo y un tutorial detallados sobre el uso del subcomando `sam local start-lambda`, consulte [Introducción a las pruebas con sam local start-lambda](using-sam-cli-local-start-lambda.md).

# sam logs
<a name="sam-cli-command-reference-sam-logs"></a>

Esta página proporciona información de referencia para el AWS Serverless Application Model comando Command Line Interface (AWS SAMCLI)`sam logs`.

Para obtener una introducción al AWS SAMCLI, consulte [¿Qué es el? AWS SAMCLI](what-is-sam-overview.md#what-is-sam-cli)

El `sam logs` comando busca los registros generados por sus AWS Lambda funciones.

## De uso
<a name="sam-cli-command-reference-sam-logs-usage"></a>

```
$ sam logs <options>
```

## Opciones
<a name="sam-cli-command-reference-sam-logs-options"></a>

`--config-env TEXT`  <a name="sam-cli-command-reference-sam-logs-options-config-env"></a>
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](serverless-sam-cli-config.md).

`--config-file PATH`  <a name="sam-cli-command-reference-sam-logs-options-config-file"></a>
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 predeterminado 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](serverless-sam-cli-config.md).

`--cw-log-group LIST`  <a name="sam-cli-command-reference-sam-logs-options-cw-log-group"></a>
Incluye los registros de CloudWatch los grupos de registros que especifique. Si especifica esta opción junto con`name`, AWS SAM incluye los registros de los grupos de registros especificados, además de los registros de los recursos nombrados.

`--debug`  <a name="sam-cli-command-reference-sam-logs-options-debug"></a>
Activa el registro de depuración para imprimir el mensaje de depuración que genera la CLI de AWS SAM y muestra las marcas temporales.

`---end-time, e TEXT`  <a name="sam-cli-command-reference-sam-logs-options-end-time"></a>
Recupera los registros hasta este momento. La hora puede estar formada con valores relativos como «Hace 5 minutos», «mañana» o una marca de tiempo con formato como «01-01-2018 10:10:10».

`--filter TEXT`  <a name="sam-cli-command-reference-sam-logs-options-filter"></a>
Permite especificar una expresión para encontrar rápidamente registros que coincidan con términos, frases o valores en los eventos de registro. Puede ser una palabra clave simple (por ejemplo, «error») o un patrón compatible con Amazon CloudWatch Logs. Para obtener información sobre la sintaxis, consulte la [documentación de Amazon CloudWatch Logs](https://docs.aws.amazon.com/AmazonCloudWatch/latest/logs/FilterAndPatternSyntax.html).

`--help`  <a name="sam-cli-command-reference-sam-logs-options-help"></a>
Muestra este mensaje y sale.

`--include-traces`  <a name="sam-cli-command-reference-sam-logs-options-include-traces"></a>
Incluye los seguimientos de X-Ray en la salida del registro.

`--name, -n TEXT`  <a name="sam-cli-command-reference-sam-logs-options-name"></a>
El nombre del recurso según el cual se van a buscar los registros. Si este recurso forma parte de una CloudFormation pila, puede ser el ID lógico del recurso de la función en la AWS SAM plantilla CloudFormation/. Para proporcionar varios nombres, repita de nuevo el parámetro. Si el recurso está en una pila anidada, el nombre puede ir precedido del nombre de la pila anidada para extraer los registros de ese recurso (/). NestedStackLogicalId ResourceLogicalId Si no se proporciona el nombre del recurso, se escaneará la pila en cuestión y se extraerá la información de registro de todos los recursos compatibles. Si no especificas esta opción, AWS SAM busca los registros de todos los recursos de la pila que especifiques. Los tipos de recurso siguientes son compatibles:  
+ `AWS::Serverless::Function`
+ `AWS::Lambda::Function`
+ `AWS::Serverless::Api`
+ `AWS::ApiGateway::RestApi`
+ `AWS::Serverless::HttpApi`
+ `AWS::ApiGatewayV2::Api`
+ `AWS::Serverless::StateMachine`
+ `AWS::StepFunctions::StateMachine`

`--output TEXT`  <a name="sam-cli-command-reference-sam-logs-options-output"></a>
Especifica el formato de salida de los registros. Para imprimir registros formateados, especifica `text`. Para imprimir los registros como JSON, especifica `json`.

`--profile TEXT`  <a name="sam-cli-command-reference-sam-logs-options-profile"></a>
El perfil específico del archivo de credenciales que obtiene AWS las credenciales.

`--region TEXT`  <a name="sam-cli-command-reference-sam-logs-options-region"></a>
La AWS región en la que se va a realizar el despliegue. Por ejemplo, us-east-1.

`--save-params`  <a name="sam-cli-command-reference-sam-logs-options-save-params"></a>
Guarde los parámetros que proporcione en la línea de comandos en el archivo AWS SAM de configuración.

`--stack-name TEXT`  <a name="sam-cli-command-reference-sam-logs-options-stack-name"></a>
El nombre de la CloudFormation pila de la que forma parte el recurso.

`--start-time, -s TEXT`  <a name="sam-cli-command-reference-sam-logs-options-start-time"></a>
Recupera los registros que comienzan en este momento. La hora puede estar formada con valores relativos como «Hace 5 minutos», «ayer» o una marca de tiempo con formato como «01-01-2018 10:10:10». El valor predeterminado es «Hace 10 minutos».

` --tail, -t`  <a name="sam-cli-command-reference-sam-logs-options-tail"></a>
Sigue la salida del registro. Esto ignora el argumento de la hora de finalización y continúa buscando los registros a medida que están disponibles.

## Ejemplos
<a name="sam-cli-command-reference-sam-logs-examples"></a>

Cuando las funciones forman parte de una CloudFormation pila, puede recuperar los registros mediante el ID lógico de la función al especificar el nombre de la pila.

```
$ sam logs -n HelloWorldFunction --stack-name myStack
```

Consulte los registros de un intervalo de tiempo específico mediante las opciones -s (--start-time) y -e (--end-time).

```
$ sam logs -n HelloWorldFunction --stack-name myStack -s '10min ago' -e '2min ago'
```

También puede agregar la opción `--tail` para esperar a que lleguen nuevos registros y verlos a medida que lleguen.

```
$ sam logs -n HelloWorldFunction --stack-name myStack --tail
```

Utiliza la opción `--filter` para encontrar rápidamente registros que coincidan con términos, frases o valores de sus eventos de registro.

```
$ sam logs -n HelloWorldFunction --stack-name myStack --filter "error"
```

Vea los registros de un recurso en una pila secundaria.

```
$ sam logs --stack-name myStack -n childStack/HelloWorldFunction
```

Registros finales de todos los recursos compatibles con la aplicación.

```
$ sam logs --stack-name sam-app --tail
```

Obtén los registros de una función de Lambda específica y de la API correspondiente a API Gateway de su aplicación.

```
$ sam logs --stack-name sam-app --name HelloWorldFunction --name HelloWorldRestApi
```

Obtén los registros de todos los recursos admitidos en su aplicación y, además, de los grupos de registros especificados.

```
$ sam logs --cw-log-group /aws/lambda/myfunction-123 --cw-log-group /aws/lambda/myfunction-456
```

# sam package
<a name="sam-cli-command-reference-sam-package"></a>

La interfaz de línea de AWS Serverless Application Model comandos (AWS SAM CLI) empaqueta una AWS SAM aplicación.

Este comando crea un `.zip` archivo con el código y las dependencias y lo carga en Amazon Simple Storage Service (Amazon S3). AWS SAM permite el cifrado de todos los archivos almacenados en Amazon S3. A continuación, devuelve una copia de la AWS SAM plantilla y reemplaza las referencias a los artefactos locales por la ubicación de Amazon S3 en la que el comando cargó los artefactos.

De forma predeterminada, cuando utiliza este comando, CLI de AWS SAM asume que su directorio de trabajo actual es el directorio raíz del proyecto. El AWS SAMCLI primero intenta localizar un archivo de plantilla creado con el [sam build](sam-cli-command-reference-sam-build.md) comando, que se encuentra en la `.aws-sam` subcarpeta y tiene un nombre`template.yaml`. A continuación, la CLI de AWS SAM intenta localizar un archivo de plantilla llamado `template.yaml` o `template.yml` en el directorio de trabajo actual. Si especificas la `--template` opción, se AWS SAMCLI anula su comportamiento predeterminado y empaquetará solo esa AWS SAM plantilla y los recursos locales a los que apunte.

**nota**  
[sam deploy](sam-cli-command-reference-sam-deploy.md) ahora ejecuta implícitamente la funcionalidad del `sam package`. Puede utilizar el comando [sam deploy](sam-cli-command-reference-sam-deploy.md) directamente para empaquetar e implementar su aplicación.

## De uso
<a name="sam-cli-command-reference-sam-package-usage"></a>

```
$ sam package <arguments> <options>
```

## Argumentos
<a name="sam-cli-command-reference-sam-package-args"></a>

**Resource ID (ID de recurso)**  <a name="sam-cli-command-reference-sam-package-args-resource-id"></a>
El ID de la función de Lambda que se va a empaquetar.  
Este argumento es opcional. Si la aplicación contiene una sola función Lambda, la AWS SAM CLI la empaquetará. Si la aplicación contiene varias funciones, proporciones el ID de la función para empaquetar una sola función.  
*Valores válidos*: el identificador lógico o el ARN del recurso.

## Opciones
<a name="sam-cli-command-reference-sam-package-options"></a>

`--config-env TEXT`  <a name="sam-cli-command-reference-sam-package-options-config-env"></a>
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](serverless-sam-cli-config.md).

`--config-file PATH`  <a name="sam-cli-command-reference-sam-package-options-config-file"></a>
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 predeterminado 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](serverless-sam-cli-config.md).

`--debug`  <a name="sam-cli-command-reference-sam-package-options-debug"></a>
Activa el registro de depuración para imprimir el mensaje de depuración que genera la CLI de AWS SAM y muestra las marcas temporales.

`--force-upload`  <a name="sam-cli-command-reference-sam-package-options-force-upload"></a>
Anular los archivos existentes en el bucket de Amazon S3. Especificar este indicador para cargar artefactos incluso si coinciden con los artefactos existentes en el bucket de Amazon S3.

`--help`  <a name="sam-cli-command-reference-sam-package-options-help"></a>
Muestra este mensaje y sale.

`--image-repository TEXT`  <a name="sam-cli-command-reference-sam-package-options-image-repository"></a>
La URI del repositorio Amazon Elastic Container Registry (Amazon ECR) donde este comando sube la imagen de la función. Necesario para las funciones declaradas con el tipo de paquete `Image`.

`--kms-key-id TEXT`  <a name="sam-cli-command-reference-sam-package-options-kms-key-id"></a>
El ID de una clave AWS Key Management Service (AWS KMS) que se utiliza para cifrar los artefactos que se encuentran en reposo en el bucket de Amazon S3. Si no se especifica esta opción, AWS SAM utiliza claves de cifrado gestionadas por Amazon S3.

`--metadata`  <a name="sam-cli-command-reference-sam-package-options-metadata"></a>
(Opcional) Un mapa de metadatos para adjuntarlo a todos los artefactos a los que se hace referencia en la plantilla.

`--no-progressbar`  <a name="sam-cli-command-reference-sam-package-options-no-progressbar"></a>
No muestre una barra de progreso al cargar artefactos en Amazon S3.

`--output-template-file PATH`  <a name="sam-cli-command-reference-sam-package-options-output-template-file"></a>
La ruta al archivo donde el comando escribe la plantilla empaquetada. Si especificas una ruta, el comando escribe la plantilla en la salida estándar.

`--profile TEXT`  <a name="sam-cli-command-reference-sam-package-options-profile"></a>
El perfil específico del archivo de credenciales que recibe las credenciales. AWS 

`--region TEXT`  <a name="sam-cli-command-reference-sam-package-options-region"></a>
La AWS región en la que se va a realizar el despliegue. Por ejemplo, us-east-1.

`--resolve-s3`  <a name="sam-cli-command-reference-sam-package-options-resolve-s3"></a>
Creación automática de un bucket de Amazon S3 para empaquetar. Si especificas las opciones `--s3-bucket` y `--resolve-s3`, entonces se producirá un error.

`--s3-bucket TEXT`  <a name="sam-cli-command-reference-sam-package-options-s3-bucket"></a>
El nombre del bucket de Amazon S3 donde este comando carga el artefacto. Si el artefacto tiene más de 51 200 bytes, necesitará la opción `--s3-bucket` o `--resolve-s3`. Si especificas las opciones `--s3-bucket` y `--resolve-s3`, entonces se producirá un error.

`--s3-prefix TEXT`  <a name="sam-cli-command-reference-sam-package-options-s3-prefix"></a>
Prefijo agregado al nombre de los artefactos que se cargan en el bucket de Amazon S3. El nombre del prefijo es un nombre de ruta (nombre de la carpeta) del bucket de Amazon S3. Esto solo se aplica a las funciones declaradas con el tipo de paquete `Zip`.

`--save-params`  <a name="sam-cli-command-reference-sam-package-options-save-params"></a>
Guarde los parámetros que proporcione en la línea de comandos en el archivo AWS SAM de configuración.

`--signing-profiles LIST`  <a name="sam-cli-command-reference-sam-package-options-signing-profiles"></a>
(Opcional) La lista de perfiles de firma con los que firmar los paquetes de implementación. Este parámetro toma una lista de pares clave-valor, donde la clave es el nombre de la función o capa que se va a firmar y el valor es el perfil de firma, con un propietario del perfil opcional delimitado con `:`. Por ejemplo, `FunctionNameToSign=SigningProfileName1 LayerNameToSign=SigningProfileName2:SigningProfileOwner`.

`--template-file, --template, -t PATH`  <a name="sam-cli-command-reference-sam-package-options-template-file"></a>
La ruta y el nombre del archivo donde se encuentra la AWS SAM plantilla.  
Si especifica esta opción, AWS SAM empaqueta solo la plantilla y los recursos locales a los que apunta.

`--use-json`  <a name="sam-cli-command-reference-sam-package-options-use-json"></a>
Genera JSON para la CloudFormation plantilla. YAML se utiliza de forma predeterminada.

## Ejemplo
<a name="sam-cli-command-reference-sam-package-examples"></a>

El siguiente ejemplo crea y empaqueta artefactos para una función y CodeDeploy aplicaciones de Lambda. Los artefactos se cargan en un bucket de Amazon S3. El resultado del comando es un nuevo archivo llamado `package.yml`.

```
$ sam package \
  --template-file template.yml \
  --output-template-file package.yml \
  --s3-bucket amzn-s3-demo-bucket
```

# sam pipeline bootstrap
<a name="sam-cli-command-reference-sam-pipeline-bootstrap"></a>

Esta página proporciona información de referencia para el AWS Serverless Application Model `sam local pipeline bootstrap` subcomando de la Interfaz de línea de comandos (AWS SAMCLI).

Para obtener una introducción al AWS SAMCLI, consulte [¿Qué es el? AWS SAMCLI](what-is-sam-overview.md#what-is-sam-cli)

El `sam pipeline bootstrap` subcomando genera los recursos de AWS infraestructura necesarios para conectarse a su sistema de CI/CD. Este paso debe ejecutarse en cada etapa de implementación de la canalización antes de ejecutar el comando **sam pipeline init**.

Este subcomando configura los siguientes recursos de infraestructura: AWS 
+ Opción de configurar los permisos de canalización mediante:
  + Un usuario de Pipeline IAM con un identificador de clave de acceso y unas credenciales de acceso con clave secreta que se compartirán con el CI/CD sistema.
**nota**  
Recomendamos rotar periódicamente las claves de acceso de forma regular. Para obtener más información, consulta [ Rotar las claves de acceso periódicamente para casos de uso que requieran credenciales de larga duración ](https://docs.aws.amazon.com/IAM/latest/UserGuide/best-practices.html#rotate-credentials) en la *Guía del usuario de IAM*.
  +  CI/CD Plataformas compatibles a través del OIDC. Para obtener una introducción sobre el uso de OIDC con la canalización AWS SAM , vaya a [Cómo utilizar la autenticación OIDC con canalizaciones AWS SAM](deploying-with-oidc.md).
+ Función de IAM de CloudFormation ejecución que asume el despliegue de CloudFormation la aplicación. AWS SAM 
+ Un depósito de Amazon S3 para guardar los AWS SAM artefactos.
+ Opcionalmente, un repositorio de imágenes de Amazon ECR para almacenar paquetes de implementación de Lambda con imágenes de contenedor (si tiene un recurso del tipo de paquete `Image`).

## De uso
<a name="sam-cli-command-reference-sam-pipeline-bootstrap-usage"></a>

```
$ sam pipeline bootstrap <options>
```

## Opciones
<a name="sam-cli-command-reference-sam-pipeline-bootstrap-options"></a>

`--bitbucket-repo-uuid TEXT`  <a name="sam-cli-command-reference-sam-pipeline-bootstrap-options-bitbucket-repo-uuid"></a>
 El UUID del repositorio de Bitbucket. Esta opción es específica del uso de Bitbucket OIDC para permisos.  
Este valor se encuentra en https://bitbucket.org/*workspace*/*repository*/admin/addon/admin/pipelines/openid-connect 

`--bucket TEXT`  <a name="sam-cli-command-reference-sam-pipeline-bootstrap-options-bucket"></a>
El ARN del depósito de Amazon S3 que contiene los AWS SAM artefactos.

`--cicd-provider TEXT`  <a name="sam-cli-command-reference-sam-pipeline-bootstrap-options-cicd-provider"></a>
La CI/CD plataforma para la AWS SAM canalización.

`--cloudformation-execution-role TEXT`  <a name="sam-cli-command-reference-sam-pipeline-bootstrap-options-cloudformation-execution-role"></a>
El ARN de la función de IAM que debe asumir CloudFormation al implementar la pila de aplicaciones. índícalo solo si quiere utilizar su propio rol. De lo contrario, el comando creará un nuevo rol.

`--config-env TEXT`  <a name="sam-cli-command-reference-sam-pipeline-bootstrap-options-config-env"></a>
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 predeterminado es **default**. Para obtener más información sobre los archivos de configuración, consulta [Archivo de configuración de la CLI de AWS SAM](serverless-sam-cli-config.md).

`--config-file PATH`  <a name="sam-cli-command-reference-sam-pipeline-bootstrap-options-config-file"></a>
La ruta y el nombre del archivo de configuración que contiene los valores de los 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](serverless-sam-cli-config.md).

`--confirm-changeset | --no-confirm-changeset`  <a name="sam-cli-command-reference-sam-pipeline-bootstrap-options-confirm-changeset"></a>
Permite solicitar la confirmación de la implementación de los recursos.

`--create-image-repository | --no-create-image-repository`  <a name="sam-cli-command-reference-sam-pipeline-bootstrap-options-create-image-repository"></a>
Especifica si quiere crear un repositorio de imágenes de Amazon ECR si no se proporciona ninguno. En el repositorio de Amazon ECR se encuentran las imágenes de contenedor de las funciones o capas de Lambda que tienen un tipo de paquete de `Image`. El valor predeterminado es `--no-create-image-repository`.

`--debug`  <a name="sam-cli-command-reference-sam-pipeline-bootstrap-options-debug"></a>
Activa el registro de depuración e imprime los mensajes de depuración que genera la CLI de AWS SAM, además de mostrar las marcas de tiempo.

`--deployment-branch TEXT`  <a name="sam-cli-command-reference-sam-pipeline-bootstrap-options-deployment-branch"></a>
Nombre de la rama desde la que se realizarán las implementaciones. Esta opción es específica del uso de GitHub Actions OIDC para los permisos.

`--github-org TEXT`  <a name="sam-cli-command-reference-sam-pipeline-bootstrap-options-github-org"></a>
La GitHub organización a la que pertenece el repositorio. Si no existe ninguna organización, escriba el nombre de usuario del propietario del repositorio. Esta opción es específica del uso de GitHub Actions OIDC para los permisos.

`--github-repo TEXT`  <a name="sam-cli-command-reference-sam-pipeline-bootstrap-options-github-repo"></a>
Nombre del GitHub repositorio desde el que se realizarán las implementaciones. Esta opción es específica del uso de GitHub Actions OIDC para los permisos.

`--gitlab-group TEXT`  <a name="sam-cli-command-reference-sam-pipeline-bootstrap-options-gitlab-group"></a>
El GitLab grupo al que pertenece el repositorio. Esta opción es específica del uso de GitLab OIDC para los permisos.

`--gitlab-project TEXT`  <a name="sam-cli-command-reference-sam-pipeline-bootstrap-options-gitlab-project"></a>
El nombre del GitLab proyecto. Esta opción es específica del uso de GitLab OIDC para los permisos.

`--help, -h`  <a name="sam-cli-command-reference-sam-pipeline-bootstrap-options-help"></a>
Muestra este mensaje y sale.

`--image-repository TEXT`  <a name="sam-cli-command-reference-sam-pipeline-bootstrap-options-image-repository"></a>
El ARN de un repositorio de imágenes de Amazon ECR en el que se encuentran las imágenes de contenedor de las funciones de Lambda o las capas que tienen un tipo de paquete de `Image`. Si se proporcionan, se ignora la opción `--create-image-repository`. Si no se proporciona y `--create-image-repository` se especifica, el comando crea una.

`--interactive | --no-interactive`  <a name="sam-cli-command-reference-sam-pipeline-bootstrap-options-interactive"></a>
Se deshabilita la solicitud interactiva de los parámetros de arranque y devuelve un error si falta alguno de los parámetros necesarios. El valor predeterminado es `--interactive`. Para este comando, `--stage` es el único parámetro requerido.  
Si `--no-interactive` se especifica junto con `--use-oidc-provider`, se deben incluir todos los parámetros necesarios de su proveedor de OIDC.

`--oidc-client-id TEXT`  <a name="sam-cli-command-reference-sam-pipeline-bootstrap-options-oidc-client-id"></a>
El ID de cliente configurado para su uso con su proveedor de OIDC.

`--oidc-provider [github-actions | gitlab | bitbucket-pipelines]`  <a name="sam-cli-command-reference-sam-pipeline-bootstrap-options-oidc-provider"></a>
Nombre del CI/CD proveedor que se utilizará para los permisos de OIDC. GitLab GitHub, y Bitbucket son compatibles.

`--oidc-provider-url TEXT`  <a name="sam-cli-command-reference-sam-pipeline-bootstrap-options-oidc-provider-url"></a>
La dirección URL del emisor del proveedor OIDC. El valor debe empezar por **https://**.

`--permissions-provider [oidc | iam]`  <a name="sam-cli-command-reference-sam-pipeline-bootstrap-options-permissions-provider"></a>
Elija un proveedor de permisos para que asuma la función de ejecución de la canalización. El valor predeterminado es **iam**.

`--pipeline-execution-role TEXT`  <a name="sam-cli-command-reference-sam-pipeline-bootstrap-options-pipeline-execution-role"></a>
El ARN del rol de IAM que asumirá el usuario de la canalización y que usará en esta etapa. índícalo solo si quiere utilizar su propio rol. Si no se proporciona, este comando creará un nuevo rol.

`--pipeline-user TEXT`  <a name="sam-cli-command-reference-sam-pipeline-bootstrap-options-pipeline-user"></a>
El nombre de recurso de Amazon (ARN) del usuario de IAM que comparte con el sistema su ID de clave de acceso y su clave de acceso secreta. CI/CD Se utiliza para conceder permiso a este usuario de IAM para acceder a la cuenta correspondiente. AWS Si no se proporciona, el comando creará un usuario de IAM junto con el ID de clave de acceso y las credenciales de clave de acceso secreta.

`--profile TEXT`  <a name="sam-cli-command-reference-sam-pipeline-bootstrap-options-profile"></a>
El perfil específico del archivo de credenciales que recibe AWS las credenciales.

`--region TEXT`  <a name="sam-cli-command-reference-sam-pipeline-bootstrap-options-region"></a>
La AWS región en la que se va a realizar el despliegue. Por ejemplo, `us-east-1`.

`--save-params`  <a name="sam-cli-command-reference-sam-pipeline-bootstrap-options-save-params"></a>
Guarde los parámetros que proporcione en la línea de comandos en el archivo AWS SAM de configuración.

`--stage TEXT`  <a name="sam-cli-command-reference-sam-pipeline-bootstrap-options-stage"></a>
El nombre de la fase de implementación correspondiente. Se utiliza como sufijo para los recursos de AWS infraestructura creados.

## Resolución de problemas
<a name="sam-cli-command-reference-sam-pipeline-bootstrap-troubleshooting"></a>

### Error: falta el parámetro obligatorio
<a name="sam-cli-command-reference-sam-pipeline-bootstrap-troubleshooting-example1"></a>

Si `--no-interactive` se especifica junto con `--use-oidc-provider` y ninguno de los parámetros requeridos se proporciona, se mostrará este mensaje de error junto con una descripción de los parámetros que faltan.

## Ejemplo
<a name="sam-cli-command-reference-sam-pipeline-bootstrap-examples"></a>

El siguiente ejemplo crea los AWS recursos necesarios para crear el CI/CD sistema, activa el registro de depuración e imprime los mensajes de depuración generados por AWS SAMCLI: usa un evento generado para pruebas locales mediante el uso de un `s3.json` evento para invocar una función Lambda localmente

```
$ sam pipeline bootstrap --debug
```

# sam pipeline init
<a name="sam-cli-command-reference-sam-pipeline-init"></a>

Esta página proporciona información de referencia para el AWS Serverless Application Model `sam pipeline init` subcomando de la Interfaz de línea de comandos (AWS SAMCLI).

Para obtener una introducción al AWS SAMCLI, consulte [¿Qué es el? AWS SAMCLI](what-is-sam-overview.md#what-is-sam-cli)

El `sam pipeline init` subcomando genera un archivo de configuración de canalización que el CI/CD sistema puede utilizar para implementar aplicaciones sin servidor. AWS SAM

Antes de usar **sam pipeline init**, debe iniciar los recursos necesarios para cada etapa de la canalización. Puede hacer esto ejecutando **sam pipeline init --bootstrap** para que lo guíen a través del proceso de instalación y generación de archivos de configuración, o consulta los recursos que haya creado previamente con el comando **sam pipeline bootstrap**.

## De uso
<a name="sam-cli-command-reference-sam-pipeline-init-usage"></a>

```
$ sam pipeline init <options>
```

## Opciones
<a name="sam-cli-command-reference-sam-pipeline-init-options"></a>

`--bootstrap`  <a name="sam-cli-command-reference-sam-pipeline-init-options-bootstrap"></a>
Habilite el modo interactivo que guíe al usuario a través de la creación de los recursos de AWS infraestructura necesarios.

`--config-env TEXT`  <a name="sam-cli-command-reference-sam-pipeline-init-options-config-env"></a>
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 predeterminado es `default`. Para obtener más información sobre los archivos de configuración, consulta [Archivo de configuración de la CLI de AWS SAM](serverless-sam-cli-config.md).

`--config-file TEXT`  <a name="sam-cli-command-reference-sam-pipeline-init-options-config-file"></a>
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 predeterminado es `samconfig.toml` en el directorio raíz 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](serverless-sam-cli-config.md).

`--debug`  <a name="sam-cli-command-reference-sam-pipeline-init-options-debug"></a>
Activa el registro de depuración para imprimir los mensajes de depuración que genera la AWS SAM de CLI y para mostrar las marcas temporales.

`--help, -h`  <a name="sam-cli-command-reference-sam-pipeline-init-options-help"></a>
Muestra este mensaje y sale.

`--save-params`  <a name="sam-cli-command-reference-sam-pipeline-init-options-save-params"></a>
Guarde los parámetros que proporcione en la línea de comandos en el archivo AWS SAM de configuración.

## Ejemplo
<a name="sam-cli-command-reference-sam-pipeline-init-examples"></a>

En el siguiente ejemplo, se muestra cómo utilizar la `--bootstrap` opción para realizar un recorrido por un modo interactivo que le guiará por la creación de los recursos de AWS infraestructura necesarios:

```
$ sam pipeline init --bootstrap
```

# sam publish
<a name="sam-cli-command-reference-sam-publish"></a>

Esta página proporciona información de referencia para el AWS Serverless Application Model comando Command Line Interface (AWS SAMCLI)`sam publish`.

Para obtener una introducción al AWS SAMCLI, consulte [¿Qué es el? AWS SAMCLI](what-is-sam-overview.md#what-is-sam-cli)

El `sam publish` comando publica una AWS SAM aplicación en AWS Serverless Application Repository. Este comando toma una AWS SAM plantilla empaquetada y publica la aplicación en la AWS región especificada.

El `sam publish` comando espera que la AWS SAM plantilla incluya una `Metadata` sección que contenga los metadatos de la aplicación necesarios para la publicación. En la sección `Metadata`, las propiedades `LicenseUrl` y `ReadmeUrl` deben hacer referencia a buckets de Amazon Simple Storage Service (Amazon S3), no a archivos locales. Para obtener más información sobre la `Metadata` sección de la AWS SAM plantilla, consulte[Publicación de la aplicación con la CLI de AWS SAM](serverless-sam-template-publishing-applications.md).

De forma predeterminada, `sam publish` crea la aplicación como privada. Antes de que otras cuentas AWS puedan ver e implementar su aplicación, debe compartirla. Para obtener información sobre cómo compartir aplicaciones, consulta [los ejemplos de políticas basadas en recursos de AWS Serverless Application Repository](https://docs.aws.amazon.com/serverlessrepo/latest/devguide/security_iam_resource-based-policy-examples.html) en la *Guía para desarrolladores de AWS Serverless Application Repository *.

**nota**  
Por el momento, `sam publish` no admite la publicación de aplicaciones anidadas especificadas localmente. Si la aplicación contiene aplicaciones anidadas, debe publicarlas por separado AWS Serverless Application Repository antes de publicar la aplicación principal.

## De uso
<a name="sam-cli-command-reference-sam-publish-usage"></a>

```
$ sam publish <options>
```

## Opciones
<a name="sam-cli-command-reference-sam-publish-options"></a>

`--config-env TEXT`  <a name="sam-cli-command-reference-sam-publish-options-config-env"></a>
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](serverless-sam-cli-config.md).

`--config-file PATH`  <a name="sam-cli-command-reference-sam-publish-options-config-file"></a>
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](serverless-sam-cli-config.md).

`--debug`  <a name="sam-cli-command-reference-sam-publish-options-debug"></a>
Activa el registro de depuración para imprimir los mensajes de depuración que genera la AWS SAM de CLI y para mostrar las marcas temporales.

`--help`  <a name="sam-cli-command-reference-sam-publish-options-help"></a>
Muestra este mensaje y sale.

`--profile TEXT`  <a name="sam-cli-command-reference-sam-publish-options-profile"></a>
El perfil específico del archivo de credenciales que recibe AWS las credenciales.

`--region TEXT`  <a name="sam-cli-command-reference-sam-publish-options-region"></a>
La AWS región en la que se va a realizar el despliegue. Por ejemplo, us-east-1.

`--save-params`  <a name="sam-cli-command-reference-sam-publish-options-save-params"></a>
Guarde los parámetros que proporcione en la línea de comandos en el archivo AWS SAM de configuración.

`--semantic-version TEXT`  <a name="sam-cli-command-reference-sam-publish-options-semantic-version"></a>
(Opcional) Utiliza esta opción para proporcionar una versión semántica de la aplicación que anule la propiedad `SemanticVersion` de la sección `Metadata` del archivo de plantilla. Para obtener más información sobre el control de versiones semántico, consulta la [especificación del control de versiones semántico.](https://semver.org/)

`--template, -t PATH`  <a name="sam-cli-command-reference-sam-publish-options-template"></a>
La ruta del archivo de AWS SAM plantilla`[default: template.[yaml|yml]]`.

## Ejemplos
<a name="sam-cli-command-reference-sam-publish-examples"></a>

Para publicar una aplicación:

```
$ sam publish --template packaged.yaml --region us-east-1
```

# sam remote callback
<a name="sam-cli-command-reference-sam-remote-callback"></a>

Esta página proporciona información de referencia para el AWS Serverless Application Model comando Command Line Interface (AWS SAMCLI)`sam remote callback`.

Para obtener una introducción al AWS SAMCLI, consulte [¿Qué es el? AWS SAMCLI](what-is-sam-overview.md#what-is-sam-cli)

El `sam remote callback` comando le permite enviar llamadas a ejecuciones remotas de funciones duraderas que se ejecutan en AWS Lambda.

**nota**  
Estos comandos requieren acceso a AWS las credenciales.

## De uso
<a name="sam-cli-command-reference-sam-remote-callback-usage"></a>

```
$ sam remote callback <subcommand> <options>
```

## Opciones
<a name="sam-cli-command-reference-sam-remote-callback-options"></a>

`--help, -h`  <a name="sam-cli-command-reference-sam-remote-callback-options-help"></a>
Muestre este mensaje y salga de él.

## Subcomandos
<a name="sam-cli-command-reference-sam-remote-callback-subcommands"></a>

`succeed`  <a name="sam-cli-command-reference-sam-remote-callback-subcommands-succeed"></a>
Envíe una llamada de respuesta correcta a una ejecución remota de una función duradera. Para obtener más información, consulte [sam remote callback succeed](sam-cli-command-reference-sam-remote-callback-succeed.md).

`fail`  <a name="sam-cli-command-reference-sam-remote-callback-subcommands-fail"></a>
Envía un error de devolución de llamada a una ejecución remota de una función duradera. Para obtener más información, consulte [sam remote callback fail](sam-cli-command-reference-sam-remote-callback-fail.md).

`heartbeat`  <a name="sam-cli-command-reference-sam-remote-callback-subcommands-heartbeat"></a>
Envía una llamada de retorno a una ejecución remota de una función duradera. Para obtener más información, consulte [sam remote callback heartbeat](sam-cli-command-reference-sam-remote-callback-heartbeat.md).

# sam remote callback succeed
<a name="sam-cli-command-reference-sam-remote-callback-succeed"></a>

Envíe una llamada correcta a una ejecución remota de una función duradera.

**nota**  
Este comando requiere acceso a AWS las credenciales.

## De uso
<a name="ref-sam-cli-remote-callback-succeed-usage"></a>

```
$ sam remote callback succeed CALLBACK_ID [OPTIONS]
```

## Argumentos necesarios
<a name="ref-sam-cli-remote-callback-succeed-arguments"></a>

`CALLBACK_ID`  
El identificador único de la devolución de llamada a la que se debe enviar una respuesta correcta.

## Opciones
<a name="ref-sam-cli-remote-callback-succeed-options"></a>

`-r, --result TEXT`  
Resultado correcto: carga útil en forma de cadena.

`--region TEXT`  
Defina la AWS región del servicio (por ejemplo,`us-east-1`).

`--profile TEXT`  
Seleccione un perfil específico de su archivo de credenciales para obtener AWS las credenciales.

`--config-env TEXT`  
Nombre del entorno que especifica los valores de los parámetros predeterminados en el archivo de configuración. Valor predeterminado: `default`

`--config-file TEXT`  
Archivo de configuración que contiene los valores de los parámetros predeterminados. Valor predeterminado: `samconfig.toml`

`--save-params`  
Guarde los parámetros proporcionados a través de la línea de comandos en el archivo de configuración.

`--beta-features / --no-beta-features`  
Activar/desactivar las funciones beta.

`--debug`  
Active el registro de depuración para imprimir los mensajes de depuración generados por la AWS SAM CLI y mostrar las marcas de tiempo.

`-h, --help`  
Muestra este mensaje y sale.

## Ejemplos
<a name="ref-sam-cli-remote-callback-succeed-examples"></a>

Enviar una llamada de éxito sin resultado:

```
$ sam remote callback succeed my-callback-id
```

Envía una llamada de confirmación con el resultado:

```
$ sam remote callback succeed my-callback-id --result 'Task completed successfully'
```

# sam remote callback fail
<a name="sam-cli-command-reference-sam-remote-callback-fail"></a>

Envía una llamada fallida a una ejecución remota de una función duradera.

**nota**  
Este comando requiere acceso a AWS las credenciales.

## De uso
<a name="ref-sam-cli-remote-callback-fail-usage"></a>

```
$ sam remote callback fail CALLBACK_ID [OPTIONS]
```

## Argumentos necesarios
<a name="ref-sam-cli-remote-callback-fail-arguments"></a>

`CALLBACK_ID`  
El identificador único de la devolución de llamada a la que se va a enviar una respuesta de error.

## Opciones
<a name="ref-sam-cli-remote-callback-fail-options"></a>

`--error-data TEXT`  
Datos de error adicionales.

`--stack-trace TEXT`  
Apila las entradas de rastreo. Esta opción se puede especificar varias veces.

`--error-type TEXT`  
Tipo de error.

`--error-message TEXT`  
Mensaje de error detallado.

`--region TEXT`  
Defina la AWS región del servicio (por ejemplo,`us-east-1`).

`--profile TEXT`  
Seleccione un perfil específico de su archivo de credenciales para obtener AWS las credenciales.

`--config-env TEXT`  
Nombre del entorno que especifica los valores de los parámetros predeterminados en el archivo de configuración. Valor predeterminado: `default`

`--config-file TEXT`  
Archivo de configuración que contiene los valores de los parámetros predeterminados. Valor predeterminado: `samconfig.toml`

`--save-params`  
Guarde los parámetros proporcionados a través de la línea de comandos en el archivo de configuración.

`--beta-features / --no-beta-features`  
Activar/desactivar las funciones beta.

`--debug`  
Active el registro de depuración para imprimir los mensajes de depuración generados por la AWS SAM CLI y mostrar las marcas de tiempo.

`-h, --help`  
Muestra este mensaje y sale.

## Ejemplos
<a name="ref-sam-cli-remote-callback-fail-examples"></a>

Envía una llamada de error sin parámetros:

```
$ sam remote callback fail my-callback-id
```

Envía una llamada de error con un mensaje de error:

```
$ sam remote callback fail my-callback-id --error-message 'Task failed'
```

Envía una llamada de error con todos los parámetros:

```
$ sam remote callback fail my-callback-id --error-message 'Task failed' --error-type 'ValidationError' --stack-trace 'at line 42' --error-data '{"code": 500}'
```

# sam remote callback heartbeat
<a name="sam-cli-command-reference-sam-remote-callback-heartbeat"></a>

Envíe un latido de llamada a una ejecución remota de una función duradera.

**nota**  
Este comando requiere acceso a AWS las credenciales.

## De uso
<a name="ref-sam-cli-remote-callback-heartbeat-usage"></a>

```
$ sam remote callback heartbeat CALLBACK_ID [OPTIONS]
```

## Argumentos necesarios
<a name="ref-sam-cli-remote-callback-heartbeat-arguments"></a>

`CALLBACK_ID`  
El identificador único de la devolución de llamada a la que se va a enviar un latido.

## Opciones
<a name="ref-sam-cli-remote-callback-heartbeat-options"></a>

`--region TEXT`  
Defina la AWS región del servicio (por ejemplo,`us-east-1`).

`--profile TEXT`  
Seleccione un perfil específico de su archivo de credenciales para obtener AWS las credenciales.

`--config-env TEXT`  
Nombre del entorno que especifica los valores de los parámetros predeterminados en el archivo de configuración. Valor predeterminado: `default`

`--config-file TEXT`  
Archivo de configuración que contiene los valores de los parámetros predeterminados. Valor predeterminado: `samconfig.toml`

`--save-params`  
Guarde los parámetros proporcionados a través de la línea de comandos en el archivo de configuración.

`--beta-features / --no-beta-features`  
Activar/desactivar las funciones beta.

`--debug`  
Active el registro de depuración para imprimir los mensajes de depuración generados por la AWS SAM CLI y mostrar las marcas de tiempo.

`-h, --help`  
Muestra este mensaje y sale.

## Ejemplos
<a name="ref-sam-cli-remote-callback-heartbeat-examples"></a>

Enviar una llamada de latido:

```
$ sam remote callback heartbeat my-callback-id
```

# sam remote execution
<a name="sam-cli-command-reference-sam-remote-execution"></a>

Esta página proporciona información de referencia para el AWS Serverless Application Model comando Command Line Interface (AWS SAMCLI)`sam remote execution`.

Para obtener una introducción al AWS SAMCLI, consulte [¿Qué es el? AWS SAMCLI](what-is-sam-overview.md#what-is-sam-cli)

El `sam remote execution` comando le permite gestionar e inspeccionar las ejecuciones remotas de funciones duraderas que se ejecutan en AWS Lambda.

**nota**  
Estos comandos requieren acceso a AWS las credenciales.

## De uso
<a name="sam-cli-command-reference-sam-remote-execution-usage"></a>

```
$ sam remote execution <subcommand> <options>
```

## Opciones
<a name="sam-cli-command-reference-sam-remote-execution-options"></a>

`--help, -h`  <a name="sam-cli-command-reference-sam-remote-execution-options-help"></a>
Muestre este mensaje y salga de él.

## Subcomandos
<a name="sam-cli-command-reference-sam-remote-execution-subcommands"></a>

`get`  <a name="sam-cli-command-reference-sam-remote-execution-subcommands-get"></a>
Obtenga detalles de una ejecución duradera. Para obtener más información, consulte [sam remote execution get](sam-cli-command-reference-sam-remote-execution-get.md).

`history`  <a name="sam-cli-command-reference-sam-remote-execution-subcommands-history"></a>
Obtenga el historial de ejecución de una función duradera. Para obtener más información, consulte [sam remote execution history](sam-cli-command-reference-sam-remote-execution-history.md).

`stop`  <a name="sam-cli-command-reference-sam-remote-execution-subcommands-stop"></a>
Detenga la ejecución duradera de una función. Para obtener más información, consulte [sam remote execution stop](sam-cli-command-reference-sam-remote-execution-stop.md).

# sam remote execution get
<a name="sam-cli-command-reference-sam-remote-execution-get"></a>

Recupere los detalles de la ejecución de una función duradera específica de AWS Lambda.

El ARN de ejecución debe tener el formato devuelto por Invoke o encontrarse en los registros de ejecución.

**nota**  
Este comando requiere acceso a AWS las credenciales.

## De uso
<a name="ref-sam-cli-remote-execution-get-usage"></a>

```
$ sam remote execution get DURABLE_EXECUTION_ARN [OPTIONS]
```

## Argumentos necesarios
<a name="ref-sam-cli-remote-execution-get-arguments"></a>

`DURABLE_EXECUTION_ARN`  
El nombre del recurso de Amazon (ARN) de la ejecución de la función duradera de la que se van a recuperar los detalles.

## Opciones
<a name="ref-sam-cli-remote-execution-get-options"></a>

`--format [summary|json]`  
Formato de salida. Valor predeterminado: `summary`

`--region TEXT`  
Defina la AWS región del servicio (por ejemplo,`us-east-1`).

`--profile TEXT`  
Seleccione un perfil específico de su archivo de credenciales para obtener AWS las credenciales.

`--config-env TEXT`  
Nombre del entorno que especifica los valores de los parámetros predeterminados en el archivo de configuración. Valor predeterminado: `default`

`--config-file TEXT`  
Archivo de configuración que contiene los valores de los parámetros predeterminados. Valor predeterminado: `samconfig.toml`

`--save-params`  
Guarde los parámetros proporcionados a través de la línea de comandos en el archivo de configuración.

`--beta-features / --no-beta-features`  
Activar/desactivar las funciones beta.

`--debug`  
Active el registro de depuración para imprimir los mensajes de depuración generados por la AWS SAM CLI y mostrar las marcas de tiempo.

`-h, --help`  
Muestra este mensaje y sale.

## Ejemplos
<a name="ref-sam-cli-remote-execution-get-examples"></a>

Obtenga los detalles de la ejecución con el formato de resumen predeterminado:

```
$ sam remote execution get 'arn:aws:lambda:us-east-1:123456789012:function:my-function:$LATEST/durable-execution/c63eec67-3415-4eb4-a495-116aa3a86278/1d454231-a3ad-3694-aa03-c917c175db55'
```

Obtenga los detalles de la ejecución en formato JSON:

```
$ sam remote execution get 'arn:aws:lambda:us-east-1:123456789012:function:my-function:$LATEST/durable-execution/c63eec67-3415-4eb4-a495-116aa3a86278/1d454231-a3ad-3694-aa03-c917c175db55' --format json
```

**nota**  
Debe asegurarse de que los caracteres de control del ARN de ejecución `$` se escapen correctamente cuando utilice comandos de shell.

# sam remote execution history
<a name="sam-cli-command-reference-sam-remote-execution-history"></a>

Recupere el historial de ejecución de una función duradera específica de AWS Lambda.

El ARN de ejecución debe tener el formato devuelto StartDurableExecution o encontrado en los registros de ejecución.

**nota**  
Este comando requiere acceso a AWS las credenciales.

## De uso
<a name="ref-sam-cli-remote-execution-history-usage"></a>

```
$ sam remote execution history DURABLE_EXECUTION_ARN [OPTIONS]
```

## Argumentos necesarios
<a name="ref-sam-cli-remote-execution-history-arguments"></a>

`DURABLE_EXECUTION_ARN`  
El nombre del recurso de Amazon (ARN) de la ejecución duradera de la función para recuperar el historial.

## Opciones
<a name="ref-sam-cli-remote-execution-history-options"></a>

`--format [table|json]`  
Formato de salida. Valor predeterminado: `table`

`--region TEXT`  
Defina la AWS región del servicio (por ejemplo,`us-east-1`).

`--profile TEXT`  
Seleccione un perfil específico de su archivo de credenciales para obtener AWS las credenciales.

`--config-env TEXT`  
Nombre del entorno que especifica los valores de los parámetros predeterminados en el archivo de configuración. Valor predeterminado: `default`

`--config-file TEXT`  
Archivo de configuración que contiene los valores de los parámetros predeterminados. Valor predeterminado: `samconfig.toml`

`--save-params`  
Guarde los parámetros proporcionados a través de la línea de comandos en el archivo de configuración.

`--beta-features / --no-beta-features`  
Activar/desactivar las funciones beta.

`--debug`  
Active el registro de depuración para imprimir los mensajes de depuración generados por la AWS SAM CLI y mostrar las marcas de tiempo.

`-h, --help`  
Muestra este mensaje y sale.

## Ejemplos
<a name="ref-sam-cli-remote-execution-history-examples"></a>

Obtenga el historial de ejecuciones con el formato de tabla predeterminado:

```
$ sam remote execution history arn:aws:lambda:us-east-1:123456789012:function:MyFunction:$LATEST/durable-execution/my-execution-name/my-execution-id
```

Obtenga el historial de ejecuciones en formato JSON:

```
$ sam remote execution history arn:aws:lambda:us-east-1:123456789012:function:MyFunction:$LATEST/durable-execution/my-execution-name/my-execution-id --format json
```

# sam remote execution stop
<a name="sam-cli-command-reference-sam-remote-execution-stop"></a>

Detenga la ejecución duradera de una función en AWS Lambda.

El ARN de ejecución debe tener el formato devuelto StartDurableExecution o encontrado en los registros de ejecución.

**nota**  
Este comando requiere acceso a AWS las credenciales.

## De uso
<a name="ref-sam-cli-remote-execution-stop-usage"></a>

```
$ sam remote execution stop DURABLE_EXECUTION_ARN [OPTIONS]
```

## Argumentos necesarios
<a name="ref-sam-cli-remote-execution-stop-arguments"></a>

`DURABLE_EXECUTION_ARN`  
El nombre del recurso de Amazon (ARN) de la ejecución duradera de la función que se va a detener.

## Opciones
<a name="ref-sam-cli-remote-execution-stop-options"></a>

`--error-message TEXT`  
Mensaje de error asociado a la ejecución detenida.

`--error-type TEXT`  
Tipo de error que se va a asociar a la ejecución detenida.

`--error-data TEXT`  
Datos de error que se van a asociar a la ejecución detenida.

`--stack-trace TEXT`  
Apila las entradas de rastreo. Esta opción se puede especificar varias veces.

`--region TEXT`  
Defina la AWS región del servicio (por ejemplo,`us-east-1`).

`--profile TEXT`  
Seleccione un perfil específico de su archivo de credenciales para obtener AWS las credenciales.

`--config-env TEXT`  
Nombre del entorno que especifica los valores de los parámetros predeterminados en el archivo de configuración. Valor predeterminado: `default`

`--config-file TEXT`  
Archivo de configuración que contiene los valores de los parámetros predeterminados. Valor predeterminado: `samconfig.toml`

`--save-params`  
Guarde los parámetros proporcionados a través de la línea de comandos en el archivo de configuración.

`--beta-features / --no-beta-features`  
Activar/desactivar las funciones beta.

`--debug`  
Active el registro de depuración para imprimir los mensajes de depuración generados por la AWS SAM CLI y mostrar las marcas de tiempo.

`-h, --help`  
Muestra este mensaje y sale.

## Ejemplos
<a name="ref-sam-cli-remote-execution-stop-examples"></a>

Detenga la ejecución sin detalles del error:

```
$ sam remote execution stop arn:aws:lambda:us-east-1:123456789012:function:MyFunction:$LATEST/durable-execution/my-execution-name/my-execution-id
```

Detenga la ejecución con un mensaje de error y escriba:

```
$ sam remote execution stop arn:aws:lambda:us-east-1:123456789012:function:MyFunction:$LATEST/durable-execution/my-execution-name/my-execution-id --error-message "Execution cancelled" --error-type "UserCancellation"
```

Detenga la ejecución con todos los detalles del error y el seguimiento de la pila:

```
$ sam remote execution stop arn:aws:lambda:us-east-1:123456789012:function:MyFunction:$LATEST/durable-execution/my-execution-name/my-execution-id --error-message "Task failed" --error-type "TaskFailure" --error-data '{"reason":"timeout"}' --stack-trace "at function1()" --stack-trace "at function2()"
```

# sam remote invoke
<a name="sam-cli-command-reference-remote-invoke"></a>

Esta página proporciona información de referencia para el AWS Serverless Application Model comando Command Line Interface (AWS SAMCLI)`sam remote invoke`.
+ Para obtener una introducción al AWS SAMCLI, consulte [¿Qué es el? AWS SAMCLI](what-is-sam-overview.md#what-is-sam-cli)
+ Para obtener documentación sobre el uso del AWS SAMCLI `sam remote invoke` comando, consulte[Introducción a las pruebas en la nube con sam remote invoke](using-sam-cli-remote-invoke.md).

El comando `sam remote invoke` invoca los recursos compatibles en Nube de AWS.

## De uso
<a name="sam-cli-command-reference-remote-invoke-usage"></a>

```
$ sam remote invoke <arguments> <options>
```

## Argumentos
<a name="sam-cli-command-reference-remote-invoke-args"></a>

**Resource ID (ID de recurso)**  <a name="sam-cli-command-reference-remote-invoke-args-resource-id"></a>
El ID del recurso admitido a invocar.  
Este argumento acepta los valores siguientes:  
+ El **Nombre de recurso de Amazon (ARN)**: el ARN del recurso.
**sugerencia**  
Usa `sam list stack-outputs --stack-name <stack-name>` para obtener el ARN de sus recursos.
+ **ID lógico**: el ID lógico del recurso. También debe proporcionar el nombre de la AWS CloudFormation pila mediante la `--stack-name` opción.
+ **ID físico**: el ID físico del recurso. Este ID se crea al implementar un recurso utilizando CloudFormation.
**sugerencia**  
Usa `sam list resources --stack-name <stack-name>` para obtener el ID físico de sus recursos.  
**Cuando proporciona un ARN o una identificación física:**  
Si proporcionas un ARN o un ID físico, no proporciones un nombre de pila. Cuando el nombre de la pila se proporciona mediante la `--stack-name` opción, o cuando el nombre de la pila se define en el archivo de configuración, AWS SAM CLI procesará automáticamente el ID de recurso como un valor de ID lógico de la CloudFormation pila.  
**Cuando no proporciona un ID de recurso:**  
Si no proporciona un ID de recurso, pero sí proporciona un nombre de pila con la `--stack-name` opción, la AWS SAM CLI intentará invocar automáticamente un recurso de la CloudFormation pila mediante la siguiente lógica:  

1.  AWS SAM CLIIdentificará los tipos de recursos en el siguiente orden y pasará al siguiente paso una vez que el tipo de recurso se encuentre en la pila:

   1. Lambda

   1. Step Functions

   1. Amazon SQS

   1. Kinesis Data Streams

1. Si el tipo de recurso tiene un solo recurso en tu pila, lo AWS SAM CLI invocará. Si hay varios recursos del mismo tipo en tu pila, se AWS SAM CLI mostrará un error.
Los siguientes son ejemplos de lo que AWS SAM CLI hará:  
+ **Pila que contiene dos funciones de Lambda y una cola de Amazon SQS**: AWS SAM CLI localizará el tipo de recurso de Lambda y devolverá un error, ya que la pila contiene más de una función de Lambda.
+ **Pila que contiene una función Lambda y dos aplicaciones de Amazon Kinesis Data Streams**: AWS SAM CLI localizará la función Lambda y la invocará, ya que la pila contiene un único recurso de Lambda.
+ **Pila que contiene una sola cola de Amazon SQS y dos aplicaciones de Kinesis Data Streams**: localizará la cola de Amazon SQS y AWS SAM CLI la invocará, ya que la pila contiene una sola cola de Amazon SQS.

## Opciones
<a name="sam-cli-command-reference-remote-invoke-options"></a>

`--beta-features | --no-beta-features`  <a name="sam-cli-command-reference-remote-invoke-options-beta-features"></a>
Permitir o denegar las características beta.

`--config-env TEXT`  <a name="sam-cli-command-reference-remote-invoke-options-config-env"></a>
Especifica el entorno que se va a utilizar en el archivo de configuración de la CLI de AWS SAM.  
*Valor predeterminado*: `default`

`--config-file FILENAME`  <a name="sam-cli-command-reference-remote-invoke-options-config-file"></a>
Especifica la ruta y el nombre del archivo de configuración.  
Para obtener más información sobre los archivos de configuración, consulta [Configuración de la AWS SAM de CLI](using-sam-cli-configure.md).  
*Predeterminado*: `samconfig.toml` en la raíz del directorio del proyecto. 

`--debug`  <a name="sam-cli-command-reference-remote-invoke-options-debug"></a>
Activar el registro de depuración. Esto imprime los mensajes de depuración y las marcas temporales generados por AWS SAMCLI.

`--event, -e TEXT`  <a name="sam-cli-command-reference-remote-invoke-options-event"></a>
El evento que se va a enviar al recurso de destino.

`--event-file FILENAME`  <a name="sam-cli-command-reference-remote-invoke-options-event-file"></a>
La ruta a un archivo que contiene el evento que se va a enviar al recurso de destino.

`--help, -h`  <a name="sam-cli-command-reference-remote-invoke-options-help"></a>
Muestre el mensaje de ayuda y salga.

`--output [ text | json ]`  <a name="sam-cli-command-reference-remote-invoke-options-output"></a>
Genera los resultados de la invocación en un formato de salida específico.  
`json`: los metadatos de la solicitud y la respuesta del recurso se devuelven en una estructura JSON. La respuesta contiene el resultado completo del SDK.  
`text`: los metadatos de la solicitud se devuelven en una estructura de texto. La respuesta del recurso se devuelve en el formato de salida del recurso invocado.

`--parameter`  <a name="sam-cli-command-reference-remote-invoke-options-parameter"></a>
Parámetros [https://boto3.amazonaws.com/v1/documentation/api/latest/index.html](https://boto3.amazonaws.com/v1/documentation/api/latest/index.html) adicionales que puede pasar al recurso que se está invocando.    
**Amazon Kinesis Data Streams**  <a name="sam-cli-command-reference-remote-invoke-options-parameter-kinesis"></a>
Los parámetros adicionales siguientes se pueden utilizar para incluir un registro en el flujo de datos de Kinesis:  
+ `ExplicitHashKey='string'`
+ `PartitionKey='string'`
+ `SequenceNumberForOrdering='string'`
+ `StreamARN='string'`
Para obtener una descripción de cada parámetro, consulta [Kinesis.Client.put\$1record](https://boto3.amazonaws.com/v1/documentation/api/latest/reference/services/kinesis/client/put_record.html).  
**AWS Lambda**  <a name="sam-cli-command-reference-remote-invoke-options-parameter-lambda"></a>
Los siguientes parámetros adicionales se pueden usar para invocar un recurso de Lambda y recibir una respuesta almacenada en búfer:  
+ `ClientContext='base64-encoded string'`
+ `InvocationType='[ DryRun | Event | RequestResponse ]'`
+ `LogType='[ None | Tail ]'`
+ `Qualifier='string'`
Los siguientes parámetros adicionales se pueden usar para invocar un recurso de Lambda con transmisión de respuesta:  
+ `ClientContext='base64-encoded string'`
+ `InvocationType='[ DryRun | RequestResponse ]'`
+ `LogType='[ None | Tail ]'`
+ `Qualifier='string'`
Para ver una descripción de los parámetros, consulta lo siguiente:  
+ Lambda con respuesta almacenada en búfer: [Lambda.Client.invoke](https://boto3.amazonaws.com/v1/documentation/api/latest/reference/services/lambda/client/invoke.html)
+ Lambda con transmisión de respuestas: [Lambda.Client.invoke\$1with\$1response\$1stream](https://boto3.amazonaws.com/v1/documentation/api/latest/reference/services/lambda/client/invoke_with_response_stream.html)  
**Amazon Simple Queue Service (Amazon SQS)**  <a name="sam-cli-command-reference-remote-invoke-options-parameter-sqs"></a>
Los parámetros adicionales siguientes se pueden utilizar para enviar un mensaje a una cola de Amazon SQS:  
+ `DelaySeconds=integer`
+ `MessageAttributes='json string'`
+ `MessageDeduplicationId='string'`
+ `MessageGroupId='string'`
+ `MessageSystemAttributes='json string'`
Para obtener una descripción de cada parámetro, consulta [SQS.Client.send\$1message](https://boto3.amazonaws.com/v1/documentation/api/latest/reference/services/sqs/client/send_message.html).  
**AWS Step Functions**  <a name="sam-cli-command-reference-remote-invoke-options-parameter-sf"></a>
Los parámetros adicionales siguientes se pueden utilizar para iniciar la ejecución de una máquina de estado:  
+ `name='string'`
+ `traceHeader='string'`
Para obtener una descripción de cada parámetro, consulta [SFN.Client.start\$1execution](https://boto3.amazonaws.com/v1/documentation/api/latest/reference/services/stepfunctions/client/start_execution.html).

`--profile TEXT`  <a name="sam-cli-command-reference-remote-invoke-options-profile"></a>
El perfil específico del archivo de credenciales para obtener AWS las credenciales.

`--region TEXT`  <a name="sam-cli-command-reference-remote-invoke-options-region"></a>
El Región de AWS del recurso. Por ejemplo, `us-east-1`.

`--stack-name TEXT`  <a name="sam-cli-command-reference-remote-invoke-options-stack-name"></a>
El nombre de la CloudFormation pila a la que pertenece el recurso.

`--tenant-id TEXT`  <a name="ref-sam-cli-local-invoke-options-tenancyconfig"></a>
El ID de inquilino de las funciones Lambda multiusuario. Se utiliza para garantizar el aislamiento informático entre distintos inquilinos. Se requiere cuando se invocan funciones configuradas con el modo de aislamiento de inquilinos.

`--test-event-name NAME`  <a name="sam-cli-command-reference-remote-invoke-options-test-event-name"></a>
El nombre del evento de prueba compartible y pasarlo a la función de Lambda.  
Esta opción solo admite funciones de Lambda.

## Ejemplo
<a name="sam-cli-command-reference-remote-invoke-examples"></a>

El siguiente ejemplo invoca los recursos compatibles de la AWS nube y activa el registro de depuración, que imprime los mensajes de depuración y las marcas de tiempo generados por: AWS SAMCLI

```
$ sam remote invoke--debug
```

# sam remote test-event
<a name="sam-cli-command-reference-remote-test-event"></a>

Esta página proporciona información de referencia para el AWS Serverless Application Model comando Command Line Interface (AWS SAMCLI)`sam remote test-event`.
+ Para obtener una introducción al AWS SAMCLI, consulte [¿Qué es el? AWS SAMCLI](what-is-sam-overview.md#what-is-sam-cli)
+ Para obtener documentación sobre el uso del AWS SAMCLI `sam remote test-event` comando, consulte[Introducción a las pruebas en la nube con sam remote test-event](using-sam-cli-remote-test-event.md).

El `sam remote test-event` comando interactúa con los eventos de prueba que se pueden compartir en el registro de EventBridge esquemas de Amazon.

## De uso
<a name="sam-cli-command-reference-remote-test-event-usage"></a>

```
$ sam remote test-event <options> <subcommand>
```

## Opciones
<a name="sam-cli-command-reference-remote-test-event-options"></a>

`--help, -h`  <a name="sam-cli-command-reference-remote-invoke-options-help"></a>
Muestre el mensaje de ayuda y salga.

## Subcomandos
<a name="sam-cli-command-reference-remote-test-event-subcommands"></a>

`delete`  
Elimine un evento de prueba que se pueda compartir del registro del EventBridge esquema. Para obtener más información de referencia, consulta [sam remote test-event delete](sam-cli-command-reference-remote-test-event-delete.md).

`get`  
Obtenga un evento de prueba que se pueda compartir del registro de EventBridge esquemas. Para obtener más información de referencia, consulta [sam remote test-event get](sam-cli-command-reference-remote-test-event-get.md).

`list`  
Enumere los eventos de prueba existentes que se pueden compartir para una AWS Lambda función. Para obtener más información de referencia, consulta [sam remote test-event list](sam-cli-command-reference-remote-test-event-list.md).

`put`  
Guarde un evento de un archivo local en el registro de EventBridge esquemas. Para obtener más información de referencia, consulta [sam remote test-event put](sam-cli-command-reference-remote-test-event-put.md).

# sam remote test-event delete
<a name="sam-cli-command-reference-remote-test-event-delete"></a>

Esta página proporciona información de referencia para el AWS Serverless Application Model `sam remote test-event delete` subcomando Command Line Interface (AWS SAMCLI).
+ Para obtener una introducción al AWS SAMCLI, consulte [¿Qué es el? AWS SAMCLI](what-is-sam-overview.md#what-is-sam-cli)
+ Para obtener documentación sobre el uso del AWS SAMCLI `sam remote test-event` comando, consulte[Introducción a las pruebas en la nube con sam remote test-event](using-sam-cli-remote-test-event.md).

El `sam remote test-event delete` subcomando elimina un evento de prueba que se puede compartir del registro de esquemas de Amazon EventBridge .

## De uso
<a name="sam-cli-command-reference-remote-test-event-delete-usage"></a>

```
$ sam remote test-event delete <arguments> <options>
```

## Argumentos
<a name="sam-cli-command-reference-remote-test-event-delete-args"></a>

**Resource ID (ID de recurso)**  <a name="sam-cli-command-reference-remote-test-event-delete-args-resource-id"></a>
El ID de la AWS Lambda función asociada al evento de prueba que se puede compartir.  
Si proporciona un identificador lógico, también debe proporcionar un valor para la AWS CloudFormation pila asociada a la función Lambda mediante la `--stack-name` opción.  
*Valores válidos*: el identificador lógico o el ARN del recurso ARN.

## Opciones
<a name="sam-cli-command-reference-remote-test-event-delete-options"></a>

`--config-env TEXT`  <a name="sam-cli-command-reference-remote-test-event-delete-options-config-env"></a>
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](serverless-sam-cli-config.md).

`--config-file PATH`  <a name="sam-cli-command-reference-remote-test-event-delete-options-config-file"></a>
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](serverless-sam-cli-config.md).

`--help, -h`  <a name="sam-cli-command-reference-remote-test-event-delete-options-help"></a>
Muestre el mensaje de ayuda y salga.

`--name TEXT`  <a name="sam-cli-command-reference-remote-test-event-delete-options-name"></a>
El nombre del evento de prueba compartible y se va a eliminar.

`--stack-name TEXT`  <a name="sam-cli-command-reference-remote-test-event-delete-options-stack-name"></a>
El nombre de la CloudFormation pila asociada a la función Lambda.  
Esta opción es obligatoria si proporciona el ID lógico de la función de Lambda como argumento.

# sam remote test-event get
<a name="sam-cli-command-reference-remote-test-event-get"></a>

Esta página proporciona información de referencia para el AWS Serverless Application Model `sam remote test-event get` subcomando Command Line Interface (AWS SAMCLI).
+ Para obtener una introducción al AWS SAMCLI, consulte [¿Qué es el? AWS SAMCLI](what-is-sam-overview.md#what-is-sam-cli)
+ Para obtener documentación sobre el uso del AWS SAMCLI `sam remote test-event` comando, consulte[Introducción a las pruebas en la nube con sam remote test-event](using-sam-cli-remote-test-event.md).

El `sam remote test-event get` subcomando obtiene un evento de prueba que se puede compartir del registro de EventBridge esquemas de Amazon.

## De uso
<a name="sam-cli-command-reference-remote-test-event-get-usage"></a>

```
$ sam remote test-event get <arguments> <options>
```

## Argumentos
<a name="sam-cli-command-reference-remote-test-event-get-args"></a>

**Resource ID (ID de recurso)**  <a name="sam-cli-command-reference-remote-test-event-get-args-resource-id"></a>
El ID de la AWS Lambda función asociada al evento de prueba que se puede compartir y que se va a obtener.  
Si proporciona un identificador lógico, también debe proporcionar un valor para la AWS CloudFormation pila asociada a la función Lambda mediante la `--stack-name` opción.  
*Valores válidos*: el identificador lógico o el ARN del recurso ARN.

## Opciones
<a name="sam-cli-command-reference-remote-test-event-get-options"></a>

`--config-env TEXT`  <a name="sam-cli-command-reference-remote-test-event-get-options-config-env"></a>
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](serverless-sam-cli-config.md).

`--config-file PATH`  <a name="sam-cli-command-reference-remote-test-event-get-options-config-file"></a>
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](serverless-sam-cli-config.md).

`--help, -h`  <a name="sam-cli-command-reference-remote-test-event-get-options-help"></a>
Muestre el mensaje de ayuda y salga.

`--name TEXT`  <a name="sam-cli-command-reference-remote-test-event-get-options-name"></a>
El nombre del evento de prueba compartible y que se va a obtener.

`--output-file FILENAME`  <a name="sam-cli-command-reference-remote-test-event-get-options-output-file"></a>
La ruta y el nombre del archivo en el que se guardará el evento en su máquina local.  
Si no proporciona esta opción, AWS SAM CLI mostrará el contenido del evento de prueba que se puede compartir en su consola.

`--stack-name TEXT`  <a name="sam-cli-command-reference-remote-test-event-get-options-stack-name"></a>
El nombre de la CloudFormation pila asociada a la función Lambda.  
Esta opción es obligatoria si proporciona el ID lógico de la función de Lambda como argumento.

# sam remote test-event list
<a name="sam-cli-command-reference-remote-test-event-list"></a>

Esta página proporciona información de referencia para el AWS Serverless Application Model `sam remote test-event list` subcomando Command Line Interface (AWS SAMCLI).
+ Para obtener una introducción al AWS SAMCLI, consulte [¿Qué es el? AWS SAMCLI](what-is-sam-overview.md#what-is-sam-cli)
+ Para obtener documentación sobre el uso del AWS SAMCLI `sam remote test-event` comando, consulte[Introducción a las pruebas en la nube con sam remote test-event](using-sam-cli-remote-test-event.md).

El `sam remote test-event list` subcomando muestra los eventos de prueba que se pueden compartir existentes para una AWS Lambda función específica del registro de EventBridge esquemas de Amazon.

## De uso
<a name="sam-cli-command-reference-remote-test-event-list-usage"></a>

```
$ sam remote test-event list <arguments> <options>
```

## Argumentos
<a name="sam-cli-command-reference-remote-test-event-list-args"></a>

**Resource ID (ID de recurso)**  <a name="sam-cli-command-reference-remote-test-event-list-args-resource-id"></a>
El ID de la función de Lambda asociada a los eventos de prueba que se pueden compartir.  
Si proporciona un identificador lógico, también debe proporcionar un valor para la AWS CloudFormation pila asociada a la función Lambda mediante la `--stack-name` opción.  
*Valores válidos*: el identificador lógico o el ARN del recurso ARN.

## Opciones
<a name="sam-cli-command-reference-remote-test-event-list-options"></a>

`--config-env TEXT`  <a name="sam-cli-command-reference-remote-test-event-list-options-config-env"></a>
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](serverless-sam-cli-config.md).

`--config-file PATH`  <a name="sam-cli-command-reference-remote-test-event-list-options-config-file"></a>
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](serverless-sam-cli-config.md).

`--help, -h`  <a name="sam-cli-command-reference-remote-test-event-list-options-help"></a>
Muestre el mensaje de ayuda y salga.

`--stack-name TEXT`  <a name="sam-cli-command-reference-remote-test-event-list-options-stack-name"></a>
El nombre de la CloudFormation pila asociada a la función Lambda.  
Esta opción es obligatoria si proporciona el ID lógico de la función de Lambda como argumento.

## Ejemplos
<a name="sam-cli-command-reference-remote-test-event-list-examples"></a>

Para ver ejemplos sobre el uso de este comando, consulte [Enumeración de eventos de prueba compartibles](using-sam-cli-remote-test-event.md#using-sam-cli-remote-test-event-use-list).

# sam remote test-event put
<a name="sam-cli-command-reference-remote-test-event-put"></a>

Esta página proporciona información de referencia para el AWS Serverless Application Model `sam remote test-event put` subcomando Command Line Interface (AWS SAMCLI).
+ Para obtener una introducción al AWS SAMCLI, consulte [¿Qué es el? AWS SAMCLI](what-is-sam-overview.md#what-is-sam-cli)
+ Para obtener documentación sobre el uso del AWS SAMCLI `sam remote test-event` comando, consulte[Introducción a las pruebas en la nube con sam remote test-event](using-sam-cli-remote-test-event.md).

El `sam remote test-event put` subcomando guarda un evento de prueba que se puede compartir desde su máquina local en el registro de EventBridge esquemas de Amazon.

## De uso
<a name="sam-cli-command-reference-remote-test-event-put-usage"></a>

```
$ sam remote test-event put <arguments> <options>
```

## Argumentos
<a name="sam-cli-command-reference-remote-test-event-put-args"></a>

**Resource ID (ID de recurso)**  <a name="sam-cli-command-reference-remote-test-event-put-args-resource-id"></a>
El ID de la AWS Lambda función asociada al evento de prueba que se puede compartir.  
Si proporciona un identificador lógico, también debe proporcionar un valor para la AWS CloudFormation pila asociada a la función Lambda mediante la `--stack-name` opción.  
*Valores válidos*: el identificador lógico o el ARN del recurso ARN.

## Opciones
<a name="sam-cli-command-reference-remote-test-event-put-options"></a>

`--config-env TEXT`  <a name="sam-cli-command-reference-remote-test-event-put-options-config-env"></a>
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](serverless-sam-cli-config.md).

`--config-file PATH`  <a name="sam-cli-command-reference-remote-test-event-put-options-config-file"></a>
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](serverless-sam-cli-config.md).

`--file FILENAME`  <a name="sam-cli-command-reference-remote-test-event-put-options-file"></a>
La ruta del archivo y el nombre del evento en su máquina local.  
Proporciona `-` como valor del nombre del archivo a leer de `stdin`.  
Esta opción es obligatoria.

`--force`, `-f`  <a name="sam-cli-command-reference-remote-test-event-put-options-force"></a>
Sobrescriba un evento de prueba compartible con el mismo nombre.

`--help, -h`  <a name="sam-cli-command-reference-remote-test-event-put-options-help"></a>
Muestre el mensaje de ayuda y salga.

`--name TEXT`  <a name="sam-cli-command-reference-remote-test-event-put-options-name"></a>
El nombre con el que se guardará el evento de prueba compartible.  
Si existe un evento de prueba que se pueda compartir con el mismo nombre en el registro del EventBridge esquema, no AWS SAM CLI lo sobrescribirá. Para sobrescribirlo, añada la opción de `--force`.

`--output-file FILENAME`  <a name="sam-cli-command-reference-remote-test-event-put-options-output-file"></a>
La ruta y el nombre del archivo en el que se guardará el evento en su máquina local.  
Si no incluyes esta opción, AWS SAM CLI se mostrará el contenido del evento de prueba que se puede compartir en tu consola.

`--stack-name TEXT`  <a name="sam-cli-command-reference-remote-test-event-put-options-stack-name"></a>
El nombre de la CloudFormation pila asociada a la función Lambda.  
Esta opción es obligatoria si proporciona el ID lógico de la función de Lambda como argumento.

## Ejemplo
<a name="sam-cli-command-reference-remote-test-event-put-examples"></a>

Para ver un ejemplo sobre el uso de este comando, consulte [Almacenamiento de eventos de prueba compartibles](using-sam-cli-remote-test-event.md#using-sam-cli-remote-test-event-use-put).

# sam sync
<a name="sam-cli-command-reference-sam-sync"></a>

Esta página proporciona información de referencia para el AWS Serverless Application Model comando Command Line Interface (AWS SAMCLI)`sam sync`.
+ Para obtener una introducción al AWS SAMCLI, consulte [¿Qué es el? AWS SAMCLI](what-is-sam-overview.md#what-is-sam-cli)
+ Para obtener documentación sobre el uso del AWS SAMCLI, consulte[AWS SAM CLI](using-sam-cli.md).

El comando `sam sync` sincroniza los cambios de la aplicación local con Nube de AWS.

## De uso
<a name="sam-cli-command-reference-sam-sync-usage"></a>

```
$ sam sync <options>
```

## Opciones
<a name="sam-cli-command-reference-sam-sync-options"></a>

`--base-dir, -s DIRECTORY`  <a name="sam-cli-command-reference-sam-sync-options-base-dir"></a>
Resuelve las rutas relativas al código fuente de la función o capa con respecto a este directorio. Utiliza esta opción para cambiar la forma en que se resuelven las rutas relativas a las carpetas de código fuente. De forma predeterminada, las rutas relativas se resuelven con respecto a la ubicación de la AWS SAM plantilla.  
Además de los recursos de la aplicación o pila raíz que esté creando, esta opción también se aplica a las aplicaciones o pilas anidadas. Además, esta opción se aplica a los siguientes tipos y propiedades de recursos:  
+ Tipo de recurso: `AWS::Serverless::Function` Propiedad: `CodeUri`
+ Tipo de recurso: `AWS::Serverless::Function` Atributo de recurso: `Metadata` Entrada: `DockerContext`
+ Tipo de recurso: `AWS::Serverless::LayerVersion` Propiedad: `ContentUri`
+ Tipo de recurso: `AWS::Lambda::Function` Propiedad: `Code`
+ Tipo de recurso: `AWS::Lambda::LayerVersion` Propiedad: `Content`

`--build-image TEXT`  <a name="sam-cli-command-reference-sam-sync-options-build-image"></a>
El URI de la [imagen de contenedor](serverless-image-repositories.md#serverless-image-repository-uris) que quiere utilizar al crear la aplicación. De forma predeterminada, AWS SAM utiliza el URI del repositorio de imágenes del contenedor de [Amazon Elastic Container Registry (Amazon ECR) Public](https://docs.aws.amazon.com/AmazonECR/latest/public/what-is-ecr.html). Especifica esta opción para utilizar una imagen diferente.  
Puede utilizar esta opción varias veces con un solo comando. Cada opción acepta una cadena o un par clave-valor.  
+ **Cadena**: especifica el URI de la imagen del contenedor que utilizarán todos los recursos de la aplicación. A continuación, se muestra un ejemplo:

  ```
  $ sam sync --build-image amazon/aws-sam-cli-build-image-python3.8
  ```
+ **Par clave-valor**: especifica el nombre del recurso como clave y el URI de la imagen del contenedor que se utilizará con ese recurso como valor. Utiliza este formato para especificar un URI de imagen de contenedor diferente para cada recurso de la aplicación. A continuación, se muestra un ejemplo:

  ```
  $ sam sync --build-image Function1=amazon/aws-sam-cli-build-image-python3.8
  ```
Esta opción solo se aplica si se especifica la opción `--use-container`; de lo contrario, se producirá un error.

`--build-in-source | --no-build-in-source`  <a name="sam-cli-command-reference-sam-sync-options-build-in-source"></a>
Proporciona `--build-in-source` para compilar el proyecto directamente en la carpeta de origen.  
La opción `--build-in-source` admite los siguientes tiempos de ejecución y métodos de compilación:  
+ **Tiempos de ejecución**: cualquier tiempo de ejecución Node.js compatible con la opción `sam init --runtime`.
+ **Métodos de compilación**: `Makefile`, `esbuild`.
La opción `--build-in-source` no es compatible con las siguientes opciones:  
+ `--use-container `
*Valor predeterminado*: `--no-build-in-source`

`--capabilities LIST`  <a name="sam-cli-command-reference-sam-sync-options-capabilities"></a>
Una lista de capacidades que especifique para CloudFormation permitir la creación de determinadas pilas. Algunas plantillas de pila pueden incluir recursos que pueden afectar a los permisos de tu Cuenta de AWS. Por ejemplo, mediante la creación de nuevos usuarios AWS Identity and Access Management (IAM). Especifica esta opción para anular los valores predeterminados. Entre los valores válidos se incluyen:  
+ CAPABILITY\$1IAM
+ CAPABILITY\$1NAMED\$1IAM
+ CAPABILITY\$1RESOURCE\$1POLICY
+ CAPABILITY\$1AUTO\$1EXPAND
*Valores predeterminados*: `CAPABILITY_NAMED_IAM` y `CAPABILITY_AUTO_EXPAND`

`--code`  <a name="sam-cli-command-reference-sam-sync-options-code"></a>
De forma predeterminada, AWS SAM sincroniza todos los recursos de la aplicación. Especifica esta opción para sincronizar solo los recursos de código, que incluyen lo siguiente:  
+ `AWS::Serverless::Function`
+ `AWS::Lambda::Function`
+ `AWS::Serverless::LayerVersion`
+ `AWS::Lambda::LayerVersion`
+ `AWS::Serverless::Api`
+ `AWS::ApiGateway::RestApi`
+ `AWS::Serverless::HttpApi`
+ `AWS::ApiGatewayV2::Api`
+ `AWS::Serverless::StateMachine`
+ `AWS::StepFunctions::StateMachine`
Para sincronizar los recursos de código, AWS SAM utiliza el AWS servicio APIs directamente, en lugar de desplegarlo directamente. AWS CloudFormation Para actualizar tu CloudFormation stack, ejecuta **sam sync --watch** o**sam deploy**.

`--config-env TEXT`  <a name="sam-cli-command-reference-sam-sync-options-config-env"></a>
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](serverless-sam-cli-config.md).

`--config-file PATH`  <a name="sam-cli-command-reference-sam-sync-options-config-file"></a>
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](serverless-sam-cli-config.md).

`--dependency-layer | --no-dependency-layer`  <a name="sam-cli-command-reference-sam-sync-options-dependency-layer"></a>
Especifica si se deben separar las dependencias de las funciones individuales en otra capa para acelerar el proceso de sincronización.  
*Valor predeterminado*: `--dependency-layer`

`--image-repository TEXT`  <a name="sam-cli-command-reference-sam-sync-options-image-repository"></a>
El nombre del repositorio Amazon Elastic Container Registry (Amazon ECR) en el que este comando carga la imagen de la función. Es necesario para las funciones declaradas con el tipo de paquete `Image`.

`--image-repositories TEXT`  <a name="sam-cli-command-reference-sam-sync-options-image-repositories"></a>
Una asignación de funciones a su URI de repositorio de Amazon ECR. Haga referencia a las funciones por su ID lógico. A continuación, se muestra un ejemplo:  

```
$ sam sync --image-repositories Function1=123456789012.dkr.ecr.us-east-1.amazonaws.com/my-repo
```
Puede especificar esta opción varias veces con un solo comando.

`--kms-key-id TEXT`  <a name="sam-cli-command-reference-sam-sync-options-kms-key-id"></a>
El ID de una clave AWS Key Management Service (AWS KMS) que se utiliza para cifrar los artefactos que se encuentran en reposo en el bucket de Amazon S3. Si no especifica esta opción, utilizará claves de cifrado administradas por Amazon S3. AWS SAM 

`--metadata`  <a name="sam-cli-command-reference-sam-sync-options-metadata"></a>
Un mapa de metadatos para adjuntar a todos los artefactos a los que haga referencia en la plantilla.

`--notification-arns LIST`  <a name="sam-cli-command-reference-sam-sync-options-notification-arns"></a>
Una lista de los ARNs temas del Amazon Simple Notification Service (Amazon SNS) asociados a la CloudFormation pila.

`--no-use-container`  <a name="ref-sam-cli-sync-options-no-use-container"></a>
Una opción que permite usar el kit de herramientas de IDE para establecer el comportamiento predeterminado.

`--parameter-overrides`  <a name="sam-cli-command-reference-sam-sync-options-parameter-overrides"></a>
Una cadena que contiene anulaciones de CloudFormation parámetros codificadas como pares clave-valor. Usa el mismo formato que (). 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`

`--resource TEXT`  <a name="sam-cli-command-reference-sam-sync-options-resource"></a>
Especifica el tipo de recurso que se va a sincronizar. Para sincronizar varios recursos, puede especificar esta opción varias veces. Esta opción es compatible con la opción `--code`. El valor debe ser uno de los recursos que se enumeran en `--code`. Por ejemplo, `--resource AWS::Serverless::Function --resource AWS::Serverless::LayerVersion`.

`--resource-id TEXT`  <a name="sam-cli-command-reference-sam-sync-options-resource-id"></a>
Especifica el ID del recurso que se va a sincronizar. Para sincronizar varios recursos, puede especificar esta opción varias veces. Esta opción es compatible con la opción `--code`. Por ejemplo, `--resource-id Function1 --resource-id Function2`.

`--role-arn TEXT`  <a name="sam-cli-command-reference-sam-sync-options-role-arn"></a>
El nombre de recurso de Amazon (ARN) de una función de IAM que se CloudFormation asume al aplicar el conjunto de cambios.

`--s3-bucket TEXT`  <a name="sam-cli-command-reference-sam-sync-options-s3-bucket"></a>
El nombre del depósito de Amazon Simple Storage Service (Amazon S3) en el que este comando carga CloudFormation la plantilla. Si la plantilla tiene más de 51 200 bytes, se requiere la opción `--s3-bucket` o la `--resolve-s3`. Si especificas ambas opciones `--s3-bucket` y `--resolve-s3`, se producirá un error.

`--s3-prefix TEXT`  <a name="sam-cli-command-reference-sam-sync-options-s3-prefix"></a>
El prefijo que se agrega a los nombres de los artefactos que carga en el bucket de Amazon S3. El nombre del prefijo es un nombre de ruta (nombre de carpeta) del bucket de Amazon S3. Esto se aplica únicamente a las funciones declaradas con el tipo de paquete `Zip`.

`--save-params`  <a name="sam-cli-command-reference-sam-sync-options-save-params"></a>
Guarda los parámetros que proporciona en la línea de comandos en el archivo de AWS SAM configuración.

`--skip-deploy-sync | --no-skip-deploy-sync`  <a name="sam-cli-command-reference-sam-sync-options-skip-deploy-sync"></a>
Especifica `--skip-deploy-sync` para omitir la sincronización inicial de la infraestructura si no es necesaria. AWS SAMCLIComparará su AWS SAM plantilla local con la CloudFormation plantilla desplegada y realizará una implementación solo si se detecta un cambio.  
`--no-skip-deploy-sync`Especifica que se debe realizar un CloudFormation despliegue cada vez `sam sync` que se ejecute.  
Para obtener más información, consulte [Omita la CloudFormation implementación inicial](using-sam-cli-sync.md#using-sam-cli-sync-options-skip-deploy-sync).  
*Valor predeterminado*: `--skip-deploy-sync`

`--stack-name TEXT`  <a name="sam-cli-command-reference-sam-sync-options-stack-name"></a>
El nombre de la CloudFormation pila de la aplicación.  
Esta opción es obligatoria.

`--tags LIST`  <a name="sam-cli-command-reference-sam-sync-options-tags"></a>
Una lista de etiquetas para asociarlas a la pila que se crea o actualiza. CloudFormation también propaga estas etiquetas a los recursos de la pila que las admiten.

`--template-file, --template, -t PATH`  <a name="sam-cli-command-reference-sam-sync-options-template-file"></a>
La ruta y el nombre del archivo donde se encuentra la AWS SAM plantilla.  
Si especifica esta opción, solo se AWS SAM despliega la plantilla y los recursos locales a los que apunta.

`--use-container, -u`  <a name="sam-cli-command-reference-sam-sync-options-use-container"></a>
Si sus funciones dependen de paquetes que tienen dependencias compiladas de forma nativa, utilice esta opción para crear la función dentro de un AWS Lambda contenedor similar. Docker  
Actualmente, esta opción no es compatible con `--dependency-layer`. Si usas `--use-container` con `--dependency-layer`, la CLI de AWS SAM le informará y continuará con `--no-dependency-layer`.

`--watch`  <a name="sam-cli-command-reference-sam-sync-options-watch"></a>
Inicia un proceso que vigila la aplicación local en busca de cambios y los sincroniza automáticamente con la. Nube de AWS De forma predeterminada, al especificar esta opción, AWS SAM sincroniza todos los recursos de la aplicación a medida que los actualiza. Con esta opción, AWS SAM realiza un CloudFormation despliegue inicial. A continuación, AWS SAM utiliza el AWS servicio APIs para actualizar los recursos de código. AWS SAM CloudFormation se utiliza para actualizar los recursos de infraestructura al actualizar la AWS SAM plantilla.

`--watch-exclude TEXT`  <a name="sam-cli-command-reference-sam-sync-options-watch-exclude"></a>
Excluye un archivo o carpeta de ser observado para cambios de archivo. Para utilizar esta opción, también se debe proporcionar `--watch`.  
Esta opción recibe un par de clave-valor:  
+ **Clave**: el identificador lógico de una función de Lambda en la aplicación.
+ **Valor**: el nombre del archivo o la carpeta asociados que se van a excluir.
Al actualizar los archivos o carpetas especificados en la `--watch-exclude` opción, no AWS SAM CLI se iniciará la sincronización. Sin embargo, cuando una actualización de otros archivos o carpetas inicie una sincronización, estos archivos o carpetas se incluirán en dicha sincronización.  
Puede proporcionar esta opción varias veces en un mismo comando.

## Ejemplos
<a name="sam-cli-command-reference-sam-sync-examples"></a>

Para ver ejemplos sobre el uso de este comando, consulte [Opciones para el comando de sincronización sam](using-sam-cli-sync.md#using-sam-cli-sync-options).

# sam traces
<a name="sam-cli-command-reference-sam-traces"></a>

Esta página proporciona información de referencia para el AWS Serverless Application Model comando Command Line Interface (AWS SAMCLI)`sam traces`.

Para obtener una introducción al AWS SAMCLI, consulte [¿Qué es el? AWS SAMCLI](what-is-sam-overview.md#what-is-sam-cli)

El `sam traces` comando busca AWS X-Ray trazas Cuenta de AWS en tu. Región de AWS

## De uso
<a name="sam-cli-command-reference-sam-traces-usage"></a>

```
$ sam traces <options>
```

## Opciones
<a name="sam-cli-command-reference-sam-traces-options"></a>

`--config-env TEXT`  <a name="sam-cli-command-reference-sam-traces-options-config-env"></a>
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](serverless-sam-cli-config.md).

`--config-file PATH`  <a name="sam-cli-command-reference-sam-traces-options-config-file"></a>
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](serverless-sam-cli-config.md).

`--end-time TEXT`  <a name="sam-cli-command-reference-sam-traces-options-end-time"></a>
Busca rastros hasta este momento. El momento puede darse en valores relativos como «Hace 5 minutos», «mañana» o como una marca de tiempo formateada como «2018-01-01 10:10:10».

`--output TEXT`  <a name="sam-cli-command-reference-sam-traces-options-output"></a>
Especifica el formato de salida para los registros. Para imprimir registros formateados, especifica `text`. Para imprimir los registros como JSON, especifica `json`.

`--save-params`  <a name="sam-cli-command-reference-sam-traces-options-save-params"></a>
Guarde los parámetros que proporcione en la línea de comandos en el archivo AWS SAM de configuración.

`--start-time TEXT`  <a name="sam-cli-command-reference-sam-traces-options-start-time"></a>
Busca rastros a partir de este momento. El momento puede darse en valores relativos como «Hace 5 minutos», «ayer» o como una marca de tiempo formateada como «2018-01-01 10:10:10». El valor predeterminado es «Hace 10 minutos».

`--tail`  <a name="sam-cli-command-reference-sam-traces-options-tail"></a>
Sigue el resultado de la traza. Esto ignora el argumento de la hora de finalización y sigue mostrando las trazas a medida que están disponibles.

`--trace-id TEXT`  <a name="sam-cli-command-reference-sam-traces-options-trace-id"></a>
El identificador único para un rastreo de X-Ray.

## Ejemplos
<a name="sam-cli-command-reference-sam-traces-examples"></a>

Ejecuta el siguiente comando para obtener los rastros de X-Ray por ID.

```
$ sam traces --trace-id tracing-id-1 --trace-id tracing-id-2
```

Ejecuta el siguiente comando para rastrear las trazas de rayos X a medida que estén disponibles.

```
$ sam traces --tail
```

# sam validate
<a name="sam-cli-command-reference-sam-validate"></a>

Esta página proporciona información de referencia para el AWS Serverless Application Model comando Command Line Interface (AWS SAMCLI)`sam validate`.

Para obtener una introducción al AWS SAMCLI, consulte [¿Qué es el? AWS SAMCLI](what-is-sam-overview.md#what-is-sam-cli)

El `sam validate` comando comprueba si un archivo AWS SAM de plantilla es válido.

## De uso
<a name="sam-cli-command-reference-sam-validate-usage"></a>

```
$ sam validate <options>
```

## Opciones
<a name="sam-cli-command-reference-sam-validate-options"></a>

`--config-env TEXT`  <a name="sam-cli-command-reference-sam-validate-options-config-env"></a>
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](serverless-sam-cli-config.md).

`--config-file PATH`  <a name="sam-cli-command-reference-sam-validate-options-config-file"></a>
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 predeterminado 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](serverless-sam-cli-config.md).

`--debug`  <a name="sam-cli-command-reference-sam-validate-options-debug"></a>
Activa el registro de depuración para imprimir el mensaje de depuración generado por la CLI de AWS SAM y muestra las marcas horarias.

`--lint`  <a name="sam-cli-command-reference-sam-validate-options-lint"></a>
 Ejecuta la validación del elemento lint en la plantilla a través de **cfn-lint**. Crea un archivo de configuración `cfnlintrc` para especificar parámetros adicionales. *Para obtener más información, consulte [cfn-lint en el repositorio.](https://github.com/aws-cloudformation/cfn-lint)CloudFormation GitHub * 

`--profile TEXT`  <a name="sam-cli-command-reference-sam-validate-options-profile"></a>
El perfil específico del archivo de credenciales que recibe las credenciales. AWS 

`--region TEXT`  <a name="sam-cli-command-reference-sam-validate-options-region"></a>
La AWS región en la que se va a realizar el despliegue. Por ejemplo, us-east-1.

`--save-params`  <a name="sam-cli-command-reference-sam-validate-options-save-params"></a>
Guarde los parámetros que proporcione en la línea de comandos en el archivo AWS SAM de configuración.

`--template-file, --template, -t PATH`  <a name="sam-cli-command-reference-sam-validate-options-template-file"></a>
 El archivo AWS SAM de plantilla. El valor predeterminado es `template.[yaml|yml]`.   
 Si la plantilla se encuentra en el directorio de trabajo actual y se denomina `template.[yaml|yml|json]`, esta opción no es necesaria.   
 Si acaba de ejecutar **sam build**, esta opción no es necesaria. 

## Ejemplo
<a name="sam-cli-command-reference-sam-validate-examples"></a>

Para ver un ejemplo sobre el uso de este comando para validar una plantilla, consulte [Validar archivos AWS SAM de plantilla](serverless-sam-cli-using-validate.md).

Para ver un ejemplo sobre el uso de este comando con cfn-lint, consulte [Valide sus AWS SAM aplicaciones con CloudFormation Linter](validate-cfn-lint.md).