As traduções são geradas por tradução automática. Em caso de conflito entre o conteúdo da tradução e da versão original em inglês, a versão em inglês prevalecerá.

# AWS SAMCLIReferência de comando
<a name="serverless-sam-cli-command-reference"></a>

Esta seção inclui informações de referência sobre comandos da CLI do AWS SAM. Isso inclui detalhes sobre o uso, uma lista abrangente das diferentes opções disponíveis para cada comando e informações adicionais. Quando aplicável, as informações adicionais incluem alguns detalhes, como argumentos, variáveis de ambiente e eventos. Consulte cada comando para obter detalhes. Para obter instruções sobre como instalar o AWS SAMCLI, consulte[Instale o 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 fornece informações de referência para o AWS Serverless Application Model comando Command Line Interface (AWS SAMCLI)`sam build`.
+ Para uma introdução ao AWS SAMCLI, consulte [O que é o AWS SAMCLI?](what-is-sam-overview.md#what-is-sam-cli)
+ Para obter a documentação sobre como usar o AWS SAMCLI `sam build` comando, consulte[Introdução à construção com AWS SAM](using-sam-cli-build.md).

O comando `sam build` prepara um aplicativo para as etapas subsequentes do fluxo de trabalho de desenvolvimento, como testes locais ou implantação no Nuvem AWS.

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

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

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

**Resource ID (ID do recurso)**  <a name="ref-sam-cli-build-args-resource-id"></a>
Opcional. Instrui AWS SAM a criar um único recurso declarado em um [AWS SAM modelo](what-is-sam-overview.md#what-is-sam-template). Os artefatos de construção do recurso especificado serão os únicos disponíveis para comandos subsequentes no fluxo de trabalho, ou seja, `sam package` e `sam deploy`.

## Opções
<a name="ref-sam-cli-build-options"></a>

`--base-dir, -s DIRECTORY`  <a name="ref-sam-cli-build-options-base-dir"></a>
Resolve caminhos relativos para o código-fonte da função ou da camada em relação a esse diretório. Use essa opção se quiser alterar a forma como os caminhos relativos às pastas de código-fonte são resolvidos. Por padrão, os caminhos relativos são resolvidos com relação à localização do modelo AWS SAM .  
Além dos recursos no aplicativo raiz ou na pilha que você está criando, essa opção também aplica aplicativos ou pilhas aninhados.  
Essa opção se aplica aos seguintes tipos e propriedades de recursos:  
+ Tipo de recursos: `AWS::Serverless::Function` Propriedade: `CodeUri`
+ Tipo de recurso: `AWS::Serverless::Function` Atributo do recurso: `Metadata` Entrada: `DockerContext`
+ Tipo de recursos: `AWS::Serverless::LayerVersion` Propriedade: `ContentUri`
+ Tipo de recursos: `AWS::Lambda::Function` Propriedade: `Code`
+ Tipo de recursos: `AWS::Lambda::LayerVersion` Propriedade: `Content`

`--beta-features | --no-beta-features`  <a name="ref-sam-cli-build-options-beta-features"></a>
Permita ou negue recursos beta.

`--build-dir, -b DIRECTORY`  <a name="ref-sam-cli-build-options-build-dir"></a>
O caminho para um diretório onde os artefatos criados são armazenados. Esse diretório e todo o seu conteúdo são removidos com essa opção.

`--build-image TEXT`  <a name="ref-sam-cli-build-options-build-image"></a>
O URI da imagem de contêiner que você deseja extrair para a compilação. Por padrão, o AWS SAM extrai a imagem de contêiner do Amazon ECR Public. Use essa opção para extrair a imagem de outro localização.  
Especifique essa opção várias vezes. Cada instância dessa opção pode ter uma string ou um par de valores-chave. Se você especificar uma string, ela será a URI da imagem do contêiner a ser usada para todos os recursos do seu aplicativo. Por exemplo, `sam build --use-container --build-image amazon/aws-sam-cli-build-image-python3.8`. Se você especificar um par de valores-chave, a chave será o nome do recurso e o valor será o URI da imagem do contêiner a ser usada para esse recurso. Por exemplo `sam build --use-container --build-image Function1=amazon/aws-sam-cli-build-image-python3.8`. Com pares de valores-chave, você pode especificar imagens de contêiner diferentes para recursos diferentes.  
Essa opção só se aplica se a opção `--use-container` for especificada, caso contrário, ocorrerá um erro.

`--build-in-source | --no-build-in-source`  <a name="ref-sam-cli-build-options-build-in-source"></a>
Providencie `--build-in-source` para criar seu projeto diretamente na pasta de origem.  
A opção `--build-in-source` oferece suporte aos seguintes runtimes e métodos de compilação:  
+ **Runtimes** — Qualquer runtime Node.js suportado pela opção `sam init --runtime`.
+ **Métodos de compilação** — `Makefile`, `esbuild`.
A opção `--build-in-source` não é compatível com as seguintes opções:  
+ `--hook-name`
+ `--use-container `
*Padrão*: `--no-build-in-source`

`--cached | --no-cached`  <a name="ref-sam-cli-build-options-cached"></a>
Habilite ou desabilite as compilações em cache. Use essa opção para reutilizar artefatos de construção que não foram alterados em relação às compilações anteriores. AWS SAM avalia se você alterou algum arquivo no diretório do projeto. Por padrão, as compilações não são armazenadas em cache. Se a opção `--no-cached` for invocada, ela substituirá a configuração `cached = true` em samcofig.toml.  
O AWS SAM não avalia se você alterou os módulos de terceiros dos quais seu projeto depende, nos quais você não forneceu uma versão específica. Por exemplo, se sua função Python incluir um `requirements.txt` arquivo com a entrada `requests=1.x` e a versão mais recente do módulo de solicitação mudar de `1.1` para`1.2`, AWS SAM não extrairá a versão mais recente até que você execute uma compilação sem cache.

`--cache-dir`  <a name="ref-sam-cli-build-options-cached-dir"></a>
O diretório em que os artefatos do cache são armazenados quando `--cached` é especificado. O diretório padrão do cache é `.aws-sam/cache`.

`--config-env TEXT`  <a name="ref-sam-cli-build-options-config-env"></a>
O nome do ambiente que especifica os valores de parâmetros padrão no arquivo de configuração a serem usados. O valor padrão é “padrão”. Para obter mais informações sobre esses arquivos de configuração, consulte [Arquivo de configuração do AWS SAM CLI](serverless-sam-cli-config.md).

`--config-file PATH`  <a name="ref-sam-cli-build-options-config-file"></a>
O caminho e o nome do arquivo de configuração contendo valores de parâmetros padrão a serem usados. O valor padrão é “`samconfig.toml`“ na raiz do diretório do projeto. Para obter mais informações sobre esses arquivos de configuração, consulte [Arquivo de configuração do AWS SAM CLI](serverless-sam-cli-config.md).

`--container-env-var, -e TEXT`  <a name="ref-sam-cli-build-options-container-env-var"></a>
Passe as variáveis de ambiente para um contêiner de build. Especifique essa opção várias vezes. Cada instância dessa opção usa um par de valores-chave, em que a chave é a variável de recurso e ambiente, e o valor é o valor da variável de ambiente. Por exemplo: `--container-env-var Function1.GITHUB_TOKEN=TOKEN1 --container-env-var Function2.GITHUB_TOKEN=TOKEN2`.  
Essa opção só se aplica se a opção `--use-container` for especificada, caso contrário, ocorrerá um erro.

`--container-env-var-file, -ef PATH`  <a name="ref-sam-cli-build-options-container-env-var-file"></a>
O caminho e o nome do arquivo JSON que contém valores para as variáveis de ambiente do contêiner. Para obter mais informações sobre arquivos variáveis de ambiente do contêiner, consulte [As variáveis de ambiente do contêiner](serverless-sam-cli-using-build.md#serverless-sam-cli-using-container-environment-file).  
Essa opção só se aplica se a opção `--use-container` for especificada, caso contrário, ocorrerá um erro.

`--debug`  <a name="ref-sam-cli-build-options-debug"></a>
Ativa o registro de depuração para imprimir mensagens de depuração que o AWS SAMCLI gera e para exibir timestamps.

`--docker-network TEXT`  <a name="ref-sam-cli-build-options-docker-network"></a>
Especifica o nome ou ID de uma rede Docker existente à qual os contêineres do Docker Lambda devem se conectar, juntamente com a rede de ponte padrão. Se não for especificado, os contêineres do Lambda se conectarão somente à rede Docker da ponte padrão.

`--exclude, -x`  <a name="ref-sam-cli-build-options-exclude"></a>
O nome do (s) recurso (s) a ser excluído do `sam build`. Por exemplo, se seu modelo contiver `Function1`, `Function2` e `Function3` e você executar `sam build --exclude Function2`, somente `Function1` e `Function3` será criado.

`--help`  <a name="ref-sam-cli-build-options-help"></a>
Mostra esta mensagem e sai.

`--hook-name TEXT`  <a name="ref-sam-cli-build-options-hook-name"></a>
O nome do hook usado para estender a funcionalidade AWS SAMCLI.  
Valores aceitos: `terraform`.

`--manifest , -m PATH`  <a name="ref-sam-cli-build-options-manifest"></a>
O caminho para um arquivo de manifesto de dependência personalizado (por exemplo, package.json) a ser usado em vez do padrão.

`--mount-symlinks`  <a name="ref-sam-cli-build-options-mount-symlinks"></a>
Garante que a CLI do AWS SAM sempre monte symlinks que estão presentes nos arquivos a serem criados ou invocados. Isso se aplica somente aos symlinks no diretório de nível superior (ou seja, links simbólicos que estão diretamente na raiz da função). Por padrão, os symlinks não são montados, exceto aqueles necessários para usar o `build-in-source` no `node_modules` no NodeJS.

`--no-use-container`  <a name="ref-sam-cli-build-options-no-use-container"></a>
Uma opção que permite usar o kit de ferramentas do IDE para definir o comportamento padrão. Você também pode usar `sam build --no-use-container` para executar uma compilação em sua máquina local em vez de um contêiner do Docker.

`--parallel`  <a name="ref-sam-cli-build-options-parallel"></a>
Permite compilações paralelas. Use essa opção para criar as funções e camadas do seu AWS SAM modelo em paralelo. Por padrão, as funções e camadas são criadas em sequência.

`--parameter-overrides`  <a name="ref-sam-cli-build-options-parameter-overrides"></a>
(Opcional) Uma string que contém substituições de CloudFormation parâmetros codificadas como pares de valores-chave. Usa o mesmo formato do AWS Command Line Interface (AWS CLI). Por exemplo: '`ParameterKey`=`KeyPairName`, `ParameterValue`=`MyKey` `ParameterKey`=`InstanceType`, `ParameterValue`=`t1.micro`'. Essa opção não é compatível com o `--hook-name`.

`--profile TEXT`  <a name="ref-sam-cli-build-options-profile"></a>
O perfil específico do seu arquivo de credenciais que obtém as AWS credenciais.

`--region TEXT`  <a name="ref-sam-cli-build-options-region"></a>
O Região da AWS para implantar. Por exemplo, us-east-1.

`--save-params`  <a name="ref-sam-cli-build-options-save-params"></a>
Salve os parâmetros fornecidos na linha de comando no arquivo AWS SAM de configuração.

`--skip-prepare-infra`  <a name="ref-sam-cli-build-options-skip-prepare-infra"></a>
Ignora a fase de preparação se nenhuma alteração na infraestrutura tiver sido feita. Execute com a opção `--hook-name`.

`--skip-pull-image`  <a name="ref-sam-cli-build-options-skip-pull-image"></a>
Especifica se o comando deve ignorar a extração da imagem mais recente do Docker para o runtime do Lambda.

`--template-file, --template, -t PATH`  <a name="ref-sam-cli-build-options-template-file"></a>
O caminho e o nome do arquivo de AWS SAM modelo`[default: template.[yaml|yml]]`. Essa opção não é compatível com o `--hook-name`.

`--terraform-project-root-path`  <a name="ref-sam-cli-build-options-terraform-project-root-path"></a>
O caminho relativo ou absoluto para o diretório de nível superior contendo seus arquivos de configuração Terraform ou código-fonte da função. Se esses arquivos estiverem localizados fora do diretório que contém seu módulo raiz Terraform, use essa opção para especificar seu caminho absoluto ou relativo. Essa opção exige que `--hook-name` seja definida como `terraform`.

`--use-container`, `-u`  <a name="ref-sam-cli-build-options-use-container"></a>
Se as funções dependerem de pacotes com dependências compiladas de forma nativa, use essa opção para desenvolver a função dentro de um contêiner do Docker semelhante ao Lambda.

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

Para obter um exemplo detalhado e uma explicação aprofundada sobre o uso do subcomando `sam build`, consulte [Introdução à construção com AWS SAM](using-sam-cli-build.md).

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

Esta página fornece informações de referência para o AWS Serverless Application Model comando Command Line Interface (AWS SAMCLI)`sam delete`.

Para obter uma introdução ao AWS SAMCLI, consulte [O que é o AWS SAMCLI?](what-is-sam-overview.md#what-is-sam-cli)

O `sam delete` comando exclui um AWS SAM aplicativo excluindo a CloudFormation pilha, os artefatos que foram empacotados e implantados no Amazon S3 e no Amazon ECR e o arquivo de modelo. AWS SAM 

Esse comando também verifica se há uma pilha complementar do Amazon ECR implantada e, em caso afirmativo, solicita ao usuário a exclusão dessa pilha e dos repositórios do Amazon ECR. Se `--no-prompts` for especificado, as pilhas complementares e os repositórios do Amazon ECR serão excluídos por padrão.

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

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

## Opções
<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>
O nome do ambiente que especifica os valores de parâmetros padrão no arquivo de configuração a serem usados. O valor padrão é `default`. Para obter mais informações sobre esses arquivos de configuração, consulte [Arquivo de configuração do AWS SAM CLI](serverless-sam-cli-config.md).

`--config-file PATH`  <a name="sam-cli-command-reference-sam-delete-options-config-file"></a>
O caminho e o nome do arquivo de configuração contendo valores de parâmetros padrão a serem usados. O valor padrão é `samconfig.toml` na raiz do diretório do projeto. Para obter mais informações sobre esses arquivos de configuração, consulte [Arquivo de configuração do AWS SAM CLI](serverless-sam-cli-config.md).

`--debug`  <a name="sam-cli-command-reference-sam-delete-options-debug"></a>
Ativa o registro de depuração para imprimir a mensagem de depuração que o AWS SAMCLI gera e para exibir timestamps.

`--help`  <a name="sam-cli-command-reference-sam-delete-options-help"></a>
Mostra esta mensagem e sai.

`--no-prompts`  <a name="sam-cli-command-reference-sam-delete-options-no-prompts"></a>
Especifique essa opção para AWS SAM operar no modo não interativo. O nome da pilha deve ser fornecido, com a opção `--stack-name` ou no arquivo de configuração `toml`.

`--profile TEXT`  <a name="sam-cli-command-reference-sam-delete-options-profile"></a>
O perfil específico do seu arquivo de credenciais que obtém as AWS credenciais.

`--region TEXT`  <a name="sam-cli-command-reference-sam-delete-options-region"></a>
A AWS região para a qual implantar. Por exemplo, us-east-1.

`--s3-bucket`  <a name="sam-cli-command-reference-sam-delete-options-s3-bucket"></a>
O caminho do bucket do Amazon S3 que deseja excluir.

`--s3-prefix`  <a name="sam-cli-command-reference-sam-delete-options-s3-prefix"></a>
O prefixo do bucket do Amazon S3 que deseja excluir.

`--save-params`  <a name="sam-cli-command-reference-sam-delete-options-save-params"></a>
Salve os parâmetros que você fornece na linha de comando no arquivo AWS SAM de configuração.

`--stack-name TEXT`  <a name="sam-cli-command-reference-sam-delete-options-stack-name"></a>
O nome da CloudFormation pilha que você deseja excluir.

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

O comando a seguir exclui a pilha `MY-STACK`. 

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

O seguinte comando exclui a pilha `MY-STACK` e o bucket do 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 fornece informações de referência para o AWS Serverless Application Model comando Command Line Interface (AWS SAMCLI)`sam deploy`.
+ Para obter uma introdução ao AWS SAMCLI, consulte [O que é o AWS SAMCLI?](what-is-sam-overview.md#what-is-sam-cli)
+ Para obter a documentação sobre como usar o AWS SAMCLI `sam deploy` comando, consulte[Introdução à implantação com AWS SAM](using-sam-cli-deploy.md).

O `sam deploy` comando implanta um aplicativo para o usuário Nuvem AWS . AWS CloudFormation

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

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

## Variáveis de ambiente
<a name="ref-sam-cli-deploy-env"></a>

`SAM_CLI_POLL_DELAY`  <a name="ref-sam-cli-deploy-env-sam-cli-poll-delay"></a>
Defina a variável de `SAM_CLI_POLL_DELAY` ambiente com um valor de segundos em seu shell para configurar com que frequência a CLI do AWS SAM verifica o estado da CloudFormation pilha, o que é útil ao ver a limitação de. CloudFormation Essa variável de ambiente é usada para a sondagem de chamadas de API `describe_stack`, que são feitas durante a execução de `sam deploy`.   
Veja um exemplo dessa variável:  

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

## Opções
<a name="ref-sam-cli-deploy-options"></a>

`--capabilities LIST`  <a name="ref-sam-cli-deploy-options-capabilities"></a>
Uma lista de recursos que você deve especificar para permitir CloudFormation a criação de determinadas pilhas. Alguns modelos de pilha podem incluir recursos que afetam suas permissões Conta da AWS, por exemplo, criando novos usuários AWS Identity and Access Management (IAM). Para essas pilhas, você deve confirmar explicitamente seus recursos especificando esse opção. Os únicos valores válidos são `CAPABILITY_IAM` e `CAPABILITY_NAMED_IAM`. Se você tiver recursos do IAM, então poderá especificar qualquer recurso. Se tiver recursos do IAM com nomes personalizados, então você deverá especificar `CAPABILITY_NAMED_IAM`. Se você não especificar essa opção, a operação retornará um erro `InsufficientCapabilities`.  
Quando você implanta uma aplicação que contém aplicações aninhadas, deve usar `CAPABILITY_AUTO_EXPAND` para reconhecer que a aplicação contém aplicações aninhadas. Para obter mais informações, consulte [Implantar aplicativos aninhados](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>
O nome do ambiente que especifica os valores de parâmetros padrão no arquivo de configuração a serem usados. O valor padrão é `default`. Para obter mais informações sobre esses arquivos de configuração, consulte [Arquivo de configuração do AWS SAM CLI](serverless-sam-cli-config.md).

`--config-file PATH`  <a name="ref-sam-cli-deploy-options-config-file"></a>
O caminho e o nome do arquivo de configuração contendo valores de parâmetros padrão a serem usados. O valor padrão é `samconfig.toml` na raiz do diretório do projeto. Para obter mais informações sobre esses arquivos de configuração, consulte [Arquivo de configuração do AWS SAM CLI](serverless-sam-cli-config.md).

`--confirm-changeset | --no-confirm-changeset`  <a name="ref-sam-cli-deploy-options-confirm-changeset"></a>
Solicite a confirmação se o AWS SAMCLI implanta o conjunto de alterações computado.

`--debug`  <a name="ref-sam-cli-deploy-options-debug"></a>
Ative o registro de depuração para imprimir a mensagem de depuração que o AWS SAMCLI gera e para exibir timestamps.

`--disable-rollback | --no-disable-rollback`  <a name="ref-sam-cli-deploy-options-disable-rollback"></a>
Especifique se deseja reverter sua CloudFormation pilha se ocorrer um erro durante uma implantação. Por padrão, se houver um erro durante uma implantação, sua CloudFormation pilha voltará ao último estado estável. Se você especificar `--disable-rollback` e ocorrer um erro durante uma implantação, os recursos que foram criados ou atualizados antes da ocorrência do erro não serão revertidos.

`--fail-on-empty-changeset | --no-fail-on-empty-changeset`  <a name="ref-sam-cli-deploy-options-fail-on-empty-changeset"></a>
Especifique se deseja retornar um código de saída diferente de zero se não houver alterações a serem feitas na pilha. O comportamento padrão é retornar um código de saída diferente de zero.

`--force-upload`  <a name="ref-sam-cli-deploy-options-force-upload"></a>
Especifique essa opção para fazer upload de artefatos, mesmo que eles correspondam aos artefatos existentes no bucket do Amazon S3. Os artefatos correspondentes são sobrescritos.

`--guided, -g`  <a name="ref-sam-cli-deploy-options-guided"></a>
Especifique essa opção para que o AWS SAMCLI use prompts que o guiem durante a implantação.

`--help`  <a name="ref-sam-cli-deploy-options-help"></a>
Mostre esta mensagem e saia.

`--image-repositories TEXT`  <a name="ref-sam-cli-deploy-options-image-repositories"></a>
Um mapeamento de funções para o URI do repositório Amazon ECR. Funções de referência por meio de sua ID lógica. Veja um exemplo a seguir:  

```
$ sam deploy --image-repositories Function1=123456789012.dkr.ecr.us-east-1.amazonaws.com/my-repo
```
Você pode especificar esta opção várias vezes em um único comando.

`--image-repository TEXT`  <a name="ref-sam-cli-deploy-options-image-repository"></a>
O nome do repositório Amazon ECR em que esse comando carrega a imagem da sua função. Essa opção é necessária para funções declaradas com o tipo de pacote `Image`.

`--kms-key-id TEXT`  <a name="ref-sam-cli-deploy-options-kms-key-id"></a>
O ID de uma chave AWS Key Management Service (AWS KMS) usada para criptografar artefatos que estão em repouso no bucket do Amazon S3. Se você não especificar essa opção, AWS SAM use as chaves de criptografia gerenciadas pelo Amazon S3.

`--metadata`  <a name="ref-sam-cli-deploy-options-metadata"></a>
Um mapa de metadados para anexar a todos os artefatos referenciados em seu modelo.

`--no-execute-changeset`  <a name="ref-sam-cli-deploy-options-no-execute-changeset"></a>
Indica se o conjunto de alterações deve ser aplicado. Especifique essa opção se quiser visualizar as alterações da pilha antes de aplicar o conjunto de alterações. Esse comando cria um conjunto de alterações CloudFormation e, em seguida, sai sem aplicar o conjunto de alterações. Para aplicar o conjunto de alterações, execute o mesmo comando sem essa opção.

`--no-progressbar`  <a name="ref-sam-cli-deploy-options-no-progressbar"></a>
Não exiba uma barra de progresso ao fazer o upload de artefatos para o Amazon S3.

`--notification-arns LIST`  <a name="ref-sam-cli-deploy-options-notification-arns"></a>
Uma lista dos ARNs tópicos CloudFormation do Amazon Simple Notification Service (Amazon SNS) associados à pilha.

`--on-failure [ROLLBACK | DELETE | DO_NOTHING]`  <a name="ref-sam-cli-deploy-options-on-failure"></a>
Especifique a ação a ser tomada quando uma pilha falhar na criação.  
As seguintes opções estão disponíveis:  
+ `ROLLBACK` — Reverte a pilha para um estado anterior em boas condições.
+ `DELETE` — Reverte a pilha para um estado anterior em boas condições, se existir um. Caso contrário, exclui a pilha.
+ `DO_NOTHING` — Nem reverte nem exclui a pilha. O efeito é o mesmo do `--disable-rollback`.
O comportamento padrão é `ROLLBACK`.  
Você pode especificar a opção `--disable-rollback` ou a opção `--on-failure`, mas não ambos.

`--parameter-overrides LIST`  <a name="ref-sam-cli-deploy-options-parameter-overrides"></a>
Uma string que contém substituições de CloudFormation parâmetros codificadas como pares de valores-chave. Cada substituição usa o formato `ParameterKey=name,ParameterValue=value`. As substituições múltiplas são separadas por espaços. Veja dois exemplos a seguir:  

```
$ 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>
O perfil específico do seu arquivo de credenciais que obtém as AWS credenciais.

`--region TEXT`  <a name="ref-sam-cli-deploy-options-region"></a>
O Região da AWS para implantar. Por exemplo, us-east-1.

`--resolve-image-repos`  <a name="ref-sam-cli-deploy-options-resolve-image-repos"></a>
Crie automaticamente repositórios do Amazon ECR para uso no empacotamento e implantação em implantações não guiadas. Esta opção se aplica apenas às funções e camadas com o `PackageType: Image` especificado. Se você especificar a opção `--guided`, então o AWS SAMCLI ignora o `--resolve-image-repos`.  
Se você criar AWS SAM automaticamente qualquer repositório do Amazon ECR para funções ou camadas com essa opção e, posteriormente, você excluir essas funções ou camadas do seu AWS SAM modelo, os repositórios correspondentes do Amazon ECR serão automaticamente excluídos.

`--resolve-s3`  <a name="ref-sam-cli-deploy-options-resolve-s3"></a>
Crie automaticamente um bucket do Amazon S3 para uso no empacotamento e implantação em implantações não guiadas. Se você especificar a opção `--guided`, então a CLI AWS SAM ignora o `--resolve-s3`. Se você especificar as opções `--s3-bucket` e `--resolve-s3`, ocorrerá um erro.

`--role-arn TEXT`  <a name="ref-sam-cli-deploy-options-role-arn"></a>
O Amazon Resource Name (ARN) de uma função do IAM que é CloudFormation assumida ao aplicar o conjunto de alterações.

`--s3-bucket TEXT`  <a name="ref-sam-cli-deploy-options-s3-bucket"></a>
O nome do bucket do Amazon S3 em que esse comando carrega seu modelo. CloudFormation Se seu modelo for maior que 51.200 bytes, a opção `--s3-bucket` ou a opção `--resolve-s3` serão obrigatórias. Se você especificar as opções `--s3-bucket` e `--resolve-s3`, ocorrerá um erro.

`--s3-prefix TEXT`  <a name="ref-sam-cli-deploy-options-s3-prefix"></a>
O prefixo adicionado aos nomes dos artefatos que são enviados ao bucket do Amazon S3. O nome do prefixo é um nome de caminho (nome da pasta) para o bucket do Amazon S3.

`--save-params`  <a name="ref-sam-cli-deploy-options-save-params"></a>
Salve os parâmetros fornecidos na linha de comando no arquivo AWS SAM de configuração.

`--signing-profiles LIST`  <a name="ref-sam-cli-deploy-options-signing-profiles"></a>
A lista de perfis de assinatura com os quais assinar seus pacotes de implantação. Essa opção usa uma lista de pares de valores-chave, em que a chave é o nome da função ou camada a ser assinada e o valor é o perfil de assinatura, com um proprietário de perfil opcional delimitado por `:`. Por exemplo, `FunctionNameToSign=SigningProfileName1 LayerNameToSign=SigningProfileName2:SigningProfileOwner`.

`--stack-name TEXT`  <a name="ref-sam-cli-deploy-options-stack-name"></a>
(Obrigatório) O nome da CloudFormation pilha na qual você está implantando. Se você especificar uma pilha existente, o comando atualizará a pilha. Se você especificar uma nova pilha, o comando a criará.

`--tags LIST`  <a name="ref-sam-cli-deploy-options-tags"></a>
Uma lista de tags a serem associadas à pilha criada ou atualizada. CloudFormation também propaga essas tags para recursos na pilha que as suportam.

`--template-file, --template, -t PATH`  <a name="ref-sam-cli-deploy-options-template-file"></a>
O caminho e o nome do arquivo em que seu AWS SAM modelo está localizado.  
Se você especificar essa opção, AWS SAM implantará somente o modelo e os recursos locais para os quais ele aponta.

`--use-json`  <a name="ref-sam-cli-deploy-options-use-json"></a>
JSON de saída para o CloudFormation modelo. A saída padrão é YAML.

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

Para obter um exemplo detalhado e uma explicação aprofundada sobre o uso do subcomando `sam deploy`, consulte [Introdução à implantação com AWS SAM](using-sam-cli-deploy.md).

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

Esta página fornece informações de referência para o AWS Serverless Application Model comando Command Line Interface (AWS SAMCLI)`sam init`.
+ Para obter uma introdução ao AWS SAMCLI, consulte [O que é o AWS SAMCLI?](what-is-sam-overview.md#what-is-sam-cli)
+ Para obter a documentação sobre o uso do AWS SAMCLI `sam init` comando, consulte[Crie seu aplicativo em AWS SAM](using-sam-cli-init.md).

O comando `sam init` fornece opções para inicializar um novo aplicativo sem servidor.

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

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

## Opções
<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>
O identificador do modelo de aplicativo gerenciado que você deseja usar. Se você não tiver certeza, chame `sam init` sem opções para um fluxo de trabalho interativo.  
Esse parâmetro é obrigatório se `--no-interactive` for especificado e `--location` não for fornecido.  
Esse parâmetro só está disponível na versão 0.30.0 e posterior do AWS SAM CLI. A especificação desse parâmetro com uma versão anterior resulta em um erro.

`--application-insights | --no-application-insights`  <a name="sam-cli-command-reference-sam-init-options-application-insights"></a>
 Ative o monitoramento CloudWatch do Amazon Application Insights para seu aplicativo. Para saber mais, consulte [Usando o CloudWatch Application Insights para monitorar seus aplicativos AWS SAM sem servidor](monitor-app-insights.md).   
 A opção padrão é `--no-application-insights`. 

`--architecture, -a [ x86_64 | arm64 ]`  <a name="sam-cli-command-reference-sam-init-options-architecture"></a>
A arquitetura do conjunto de instruções para as funções do Lambda do seu aplicativo. Especifique um dos `x86_64` ou `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>
A imagem base do seu aplicativo. Essa opção se aplica somente quando o tipo de pacote é `Image`.  
Esse parâmetro é necessário se `--no-interactive` for especificado, `--package-type` for especificado como `Image` e `--location` não for especificado.

`--config-env TEXT`  <a name="sam-cli-command-reference-sam-init-options-config-env"></a>
O nome do ambiente que especifica os valores de parâmetros padrão no arquivo de configuração a serem usados. O valor padrão é “padrão”. Para obter mais informações sobre esses arquivos de configuração, consulte [Arquivo de configuração do AWS SAM CLI](serverless-sam-cli-config.md).

`--config-file PATH`  <a name="sam-cli-command-reference-sam-init-options-config-file"></a>
O caminho e o nome do arquivo de configuração contendo valores de parâmetros padrão a serem usados. O valor padrão é “samconfig.toml” na raiz do diretório do projeto. Para obter mais informações sobre esses arquivos de configuração, consulte [Arquivo de configuração do AWS SAM CLI](serverless-sam-cli-config.md).

`--debug`  <a name="sam-cli-command-reference-sam-init-options-debug"></a>
Ativa o registro de depuração para imprimir as mensagens de depuração que o AWS SAM CLI gera e para exibir timestamps.

`--dependency-manager, -d [ gradle | mod | maven | bundler | npm | cli-package | pip ]`  <a name="sam-cli-command-reference-sam-init-options-dependency-manager"></a>
O gerenciador de dependências do seu tempo de execução do Lambda.

`--extra-content`  <a name="sam-cli-command-reference-sam-init-options-extra-content"></a>
Substitua quaisquer parâmetros personalizados na configuração `cookiecutter.json` do modelo, por exemplo, `{"customParam1": "customValue1", "customParam2":"customValue2"}`.

`--help, -h`  <a name="sam-cli-command-reference-sam-init-options-help"></a>
Mostra esta mensagem e sai.

`--location, -l TEXT`  <a name="sam-cli-command-reference-sam-init-options-location"></a>
O local doo modelo ou aplicativo (Git, Mercurial, HTTP/HTTPS, arquivo.zip, caminho).  
Esse parâmetro é necessário se `--no-interactive` for especificado e `--runtime`,`--name`, e `--app-template` não for fornecido.  
Para repositórios Git, você deve usar a localização da raiz do repositório.  
Para caminhos locais, o modelo deve estar no formato de arquivo.zip ou [Cookiecutter](https://cookiecutter.readthedocs.io/en/latest/README.html).

`--name, -n TEXT`  <a name="sam-cli-command-reference-sam-init-options-name"></a>
O nome do seu projeto a ser gerado como um diretório.  
Esse parâmetro é obrigatório se `--no-interactive` for especificado e `--location` não for fornecido.

`--no-input`  <a name="sam-cli-command-reference-sam-init-options-no-input"></a>
Desativa a solicitação do Cookiecutter e aceita os valores vcfdefault que são definidos na configuração do modelo.

`--no-interactive`  <a name="sam-cli-command-reference-sam-init-options-no-interactive"></a>
Desative a solicitação interativa para os parâmetros de inicialização e falha se algum valor necessário estiver ausente.

`--output-dir, -o PATH`  <a name="sam-cli-command-reference-sam-init-options-output-dir"></a>
O local em que o aplicativo inicializado é gerado.

`--package-type [ Zip | Image ]`  <a name="sam-cli-command-reference-sam-init-options-package-type"></a>
O tipo de pacote do aplicativo de exemplo. `Zip` cria um arquivo .zip e `Image` cria uma imagem de contêiner.

`--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>
O tempo de execução do Lambda do seu aplicativo. Essa opção se aplica somente quando o tipo de pacote é `Zip`.  
Esse parâmetro é necessário se `--no-interactive` for especificado, `--package-type` for especificado como `Zip` e `--location` não for especificado.

`--save-params`  <a name="sam-cli-command-reference-sam-init-options-save-params"></a>
Salve os parâmetros que você fornece na linha de comando no arquivo AWS SAM de configuração.

`--tracing | --no-tracing`  <a name="sam-cli-command-reference-sam-init-options-tracing"></a>
Ative o AWS X-Ray rastreamento para suas funções do Lambda.

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

Para obter um exemplo detalhado e uma explicação aprofundada sobre o uso do subcomando `sam init`, consulte [Crie seu aplicativo em AWS SAM](using-sam-cli-init.md).

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

Esta página fornece informações de referência para o AWS Serverless Application Model comando Command Line Interface (AWS SAMCLI)`sam list`.

Para obter uma introdução ao AWS SAMCLI, consulte [O que é o AWS SAMCLI?](what-is-sam-overview.md#what-is-sam-cli)

O comando `sam list` gera informações importantes sobre os recursos em seu aplicativo sem servidor e o estado do seu aplicativo sem servidor. Use **sam list** antes e depois da implantação para ajudar durante o desenvolvimento local e na nuvem.

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

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

## Opções
<a name="sam-cli-command-reference-sam-list-options"></a>

`--help, -h`  <a name="sam-cli-command-reference-sam-list-options-help"></a>
Mostre esta mensagem e saia.

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

`endpoints`  <a name="sam-cli-command-reference-sam-list-subcommands-endpoints"></a>
Exibe uma lista de endpoints locais e de nuvem da sua CloudFormation pilha. Para obter mais informações, consulte [sam list endpoints](sam-cli-command-reference-sam-list-endpoints.md).

`resources`  <a name="sam-cli-command-reference-sam-list-subcommands-resources"></a>
Exibe os recursos em seu modelo AWS Serverless Application Model (AWS SAM) que são criados AWS CloudFormation na implantação. Para obter mais informações, 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>
Exibe as saídas da sua CloudFormation pilha a partir de um modelo AWS SAM ou CloudFormation . Para obter mais informações, 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 fornece informações de referência para o AWS Serverless Application Model `sam list endpoints` subcomando Command Line Interface (AWS SAMCLI).

Para obter uma introdução ao AWS SAMCLI, consulte [O que é o AWS SAMCLI?](what-is-sam-overview.md#what-is-sam-cli)

O `sam list endpoints` subcomando exibe uma lista de endpoints locais e de nuvem da sua CloudFormation pilha. Você pode interagir com esses recursos por meio dos comandos **sam local** e **sam sync**.

AWS Lambda e os tipos de recursos do Amazon API Gateway são compatíveis com esse comando.

**nota**  
Domínios personalizados são suportados quando configurados para seus recursos do Amazon API Gateway. Esse comando exibirá o domínio personalizado em vez do endpoint padrão.

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

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

## Opções
<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>
O nome do ambiente que especifica os valores de parâmetros padrão no arquivo de configuração a serem usados.  
*Valor padrão*: `default`  
Para obter mais informações sobre esses arquivos de configuração, consulte [Arquivo de configuração do AWS SAM CLI](serverless-sam-cli-config.md).

`--config-file TEXT`  <a name="sam-cli-command-reference-sam-list-endpoints-options-config-file"></a>
O caminho e o nome do arquivo de configuração contendo valores de parâmetros padrão a serem usados.  
*Valor padrão*: O `samconfig.toml` no diretório de trabalho atual.  
Para obter mais informações sobre esses arquivos de configuração, consulte [Arquivo de configuração do AWS SAM CLI](serverless-sam-cli-config.md).

`--debug`  <a name="sam-cli-command-reference-sam-list-endpoints-options-debug"></a>
Ative o registro de depuração para imprimir mensagens de depuração geradas pelo AWS SAMCLI com timestamps.

`--help, -h`  <a name="sam-cli-command-reference-sam-list-endpoints-options-help"></a>
Mostre esta mensagem e saia.

`--output [json|table]`  <a name="sam-cli-command-reference-sam-list-endpoints-options-output"></a>
Especifique o formato para gerar resultados.  
*Valor padrão*: `table`

`--profile TEXT`  <a name="sam-cli-command-reference-sam-list-endpoints-options-profile"></a>
Selecione um perfil específico do seu arquivo de credenciais para obter as AWS credenciais.

`--region TEXT`  <a name="sam-cli-command-reference-sam-list-endpoints-options-region"></a>
Defina a AWS região do serviço. Por exemplo, .`us-east-1`

`--save-params`  <a name="sam-cli-command-reference-sam-list-endpoints-options-save-params"></a>
Salve os parâmetros que você fornece na linha de comando no arquivo AWS SAM de configuração.

`--stack-name TEXT`  <a name="sam-cli-command-reference-sam-list-endpoints-options-stack-name"></a>
Nome da CloudFormation pilha implantada. O nome da pilha pode ser encontrado no `samconfig.toml` arquivo do seu aplicativo ou no arquivo de configuração designado.  
Quando essa opção não for especificada, os recursos locais definidos em seu modelo serão exibidos.

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

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

Exiba uma saída, no formato json, dos endpoints de recursos implantados da sua CloudFormation pilha chamada. `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 fornece informações de referência para o AWS Serverless Application Model `sam list resources` subcomando Command Line Interface (AWS SAMCLI).

Para obter uma introdução ao AWS SAMCLI, consulte [O que é o AWS SAMCLI?](what-is-sam-overview.md#what-is-sam-cli)

O `sam list resources` subcomando exibe os recursos em seu modelo AWS Serverless Application Model (AWS SAM) que são criados AWS CloudFormation pela AWS SAM transformação na implantação.

Use **sam list resources** com um AWS SAM modelo antes da implantação para ver os recursos que serão criados. Forneça um nome de CloudFormation pilha para visualizar uma lista consolidada que inclui recursos implantados.

**nota**  
Para gerar uma lista de recursos do seu AWS SAM modelo, uma transformação local do seu modelo é executada. Os recursos que serão implantados sob condições, como em uma região específica, estão incluídos nessa lista.

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

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

## Opções
<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>
O nome do ambiente que especifica os valores de parâmetros padrão no arquivo de configuração a serem usados.  
*Valor padrão*: `default`  
Para obter mais informações sobre esses arquivos de configuração, consulte [Arquivo de configuração do AWS SAM CLI](serverless-sam-cli-config.md).

`--config-file TEXT`  <a name="sam-cli-command-reference-sam-list-resources-options-config-file"></a>
O caminho e o nome do arquivo de configuração contendo valores de parâmetros padrão a serem usados.  
*Valor padrão*: O `samconfig.toml` no diretório de trabalho atual.  
Para obter mais informações sobre esses arquivos de configuração, consulte [Arquivo de configuração do AWS SAM CLI](serverless-sam-cli-config.md).

`--debug`  <a name="sam-cli-command-reference-sam-list-resources-options-debug"></a>
Ative o registro de depuração para imprimir mensagens de depuração geradas pelo AWS SAMCLI com timestamps.

`--help, -h`  <a name="sam-cli-command-reference-sam-list-resources-options-help"></a>
Mostre esta mensagem e saia.

`--output [json|table]`  <a name="sam-cli-command-reference-sam-list-resources-options-output"></a>
Especifique o formato para gerar resultados.  
*Valor padrão*: `table`

`--profile TEXT`  <a name="sam-cli-command-reference-sam-list-resources-options-profile"></a>
Selecione um perfil específico do seu arquivo de credenciais para obter as AWS credenciais.

`--region TEXT`  <a name="sam-cli-command-reference-sam-list-resources-options-region"></a>
Defina a AWS região do serviço. Por exemplo, .`us-east-1`

`--save-params`  <a name="sam-cli-command-reference-sam-list-resources-options-save-params"></a>
Salve os parâmetros que você fornece na linha de comando no arquivo AWS SAM de configuração.

`--stack-name TEXT`  <a name="sam-cli-command-reference-sam-list-resources-options-stack-name"></a>
Nome da CloudFormation pilha implantada. O nome da pilha pode ser encontrado no `samconfig.toml` arquivo do seu aplicativo ou no arquivo de configuração designado.  
Quando fornecida, a lógica IDs do recurso do seu modelo será mapeada para a entrada física IDs correspondente. CloudFormation Para saber mais sobre física IDs, consulte [Campos de recursos](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/resources-section-structure.html#resources-section-structure-resource-fields) no *Guia AWS CloudFormation do usuário*.  
Quando essa opção não for especificada, os recursos locais definidos em seu modelo serão exibidos.

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

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

Exiba uma saída, em formato de tabela, dos recursos locais do seu AWS SAM modelo e dos recursos implantados da sua CloudFormation pilha chamada. `test-stack` Execute no mesmo diretório do seu modelo 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 fornece informações de referência para o AWS Serverless Application Model `sam list stack-outputs` subcomando Command Line Interface (AWS SAMCLI).

Para uma introdução ao AWS SAMCLI, consulte [O que é o AWS SAMCLI?](what-is-sam-overview.md#what-is-sam-cli)

O `sam list stack-outputs` subcomando exibe as saídas da sua AWS CloudFormation pilha a partir de um AWS Serverless Application Model (AWS SAM) ou modelo. CloudFormation Para obter mais informações sobre `Outputs`, consulte [Resultados](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/outputs-section-structure.html) no *Guia do usuário do AWS CloudFormation *.

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

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

## Opções
<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>
O nome do ambiente que especifica os valores de parâmetros padrão no arquivo de configuração a serem usados.  
*Valor padrão*: `default`  
Para obter mais informações sobre esses arquivos de configuração, consulte [Arquivo de configuração do AWS SAM CLI](serverless-sam-cli-config.md).

`--config-file TEXT`  <a name="sam-cli-command-reference-sam-list-stack-outputs-options-config-file"></a>
O caminho e o nome do arquivo de configuração contendo valores de parâmetros padrão a serem usados.  
*Valor padrão*: O `samconfig.toml` no diretório de trabalho atual.  
Para obter mais informações sobre esses arquivos de configuração, consulte [Arquivo de configuração do AWS SAM CLI](serverless-sam-cli-config.md).

`--debug`  <a name="sam-cli-command-reference-sam-list-stack-outputs-options-debug"></a>
Ative o registro de depuração para imprimir mensagens de depuração geradas pelo AWS SAMCLI com timestamps.

`--help, -h`  <a name="sam-cli-command-reference-sam-list-stack-outputs-options-help"></a>
Mostre esta mensagem e saia.

`--output [json|table]`  <a name="sam-cli-command-reference-sam-list-stack-outputs-options-output"></a>
Especifique o formato para gerar resultados.  
*Valor padrão*: `table`

`--profile TEXT`  <a name="sam-cli-command-reference-sam-list-stack-outputs-options-profile"></a>
Selecione um perfil específico do seu arquivo de credenciais para obter as AWS credenciais.

`--region TEXT`  <a name="sam-cli-command-reference-sam-list-stack-outputs-options-region"></a>
Defina a AWS região do serviço. Por exemplo, .`us-east-1`

`--save-params`  <a name="sam-cli-command-reference-sam-list-stack-outputs-options-save-params"></a>
Salve os parâmetros fornecidos na linha de comando no arquivo AWS SAM de configuração.

`--stack-name TEXT`  <a name="sam-cli-command-reference-sam-list-stack-outputs-options-"></a>
Nome da CloudFormation pilha implantada. O nome da pilha pode ser encontrado no `samconfig.toml` arquivo do seu aplicativo ou no arquivo de configuração designado.  
Essa opção é obrigatória.

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

Exibe as saídas, em formato de tabela, dos recursos em sua CloudFormation pilha denominados. `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 fornece informações de referência para o AWS Serverless Application Model comando Command Line Interface (AWS SAMCLI)`sam local callback`.

Para uma introdução ao AWS SAMCLI, consulte [O que é o AWS SAMCLI?](what-is-sam-overview.md#what-is-sam-cli)

O `sam local callback` comando permite que você envie retornos de chamada para execuções de funções duráveis locais durante o desenvolvimento e o teste.

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

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

## Opções
<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>
Mostre esta mensagem e saia.

## 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>
Envie um retorno de chamada bem-sucedido para uma execução de função durável. Para obter mais informações, 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>
Envie um retorno de chamada de falha para uma execução de função durável. Para obter mais informações, 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>
Envie um retorno de chamada de pulsação para uma execução de função durável. Para obter mais informações, 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>

Envie um retorno de chamada bem-sucedido para uma execução de função durável.

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

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

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

`CALLBACK_ID`  
O identificador exclusivo do retorno de chamada para o qual enviar uma resposta bem-sucedida.

## Opções
<a name="ref-sam-cli-local-callback-succeed-options"></a>

`-r, --result TEXT`  
Carga útil do resultado de sucesso como string.

`--region TEXT`  
Defina a AWS região do serviço (por exemplo,`us-east-1`).

`--profile TEXT`  
Selecione um perfil específico do seu arquivo de credenciais para obter as AWS credenciais.

`--config-env TEXT`  
Nome do ambiente especificando valores de parâmetros padrão no arquivo de configuração. Padrão: `default`

`--config-file TEXT`  
Arquivo de configuração contendo valores de parâmetros padrão. Padrão: `samconfig.toml`

`--save-params`  
Salve os parâmetros fornecidos pela linha de comando no arquivo de configuração.

`--beta-features / --no-beta-features`  
Ativar/desativar recursos beta.

`--debug`  
Ative o registro de depuração para imprimir mensagens de depuração geradas pela AWS SAM CLI e exibir registros de data e hora.

`-h, --help`  
Mostra esta mensagem e sai.

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

Envie um retorno de chamada bem-sucedido sem resultado:

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

Envie um retorno de chamada de sucesso com o resultado:

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

Envie um retorno de chamada bem-sucedido com a opção curta:

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

Envie um retorno de chamada de falha para uma execução de função durável.

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

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

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

`CALLBACK_ID`  
O identificador exclusivo do retorno de chamada para o qual enviar uma resposta de falha.

## Opções
<a name="ref-sam-cli-local-callback-fail-options"></a>

`--error-data TEXT`  
Dados de erro adicionais.

`--stack-trace TEXT`  
Entradas de rastreamento de pilha. Essa opção pode ser especificada várias vezes.

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

`--error-message TEXT`  
Mensagem de erro detalhada.

`--region TEXT`  
Defina a AWS região do serviço (por exemplo,`us-east-1`).

`--profile TEXT`  
Selecione um perfil específico do seu arquivo de credenciais para obter as AWS credenciais.

`--config-env TEXT`  
Nome do ambiente especificando valores de parâmetros padrão no arquivo de configuração. Padrão: `default`

`--config-file TEXT`  
Arquivo de configuração contendo valores de parâmetros padrão. Padrão: `samconfig.toml`

`--save-params`  
Salve os parâmetros fornecidos pela linha de comando no arquivo de configuração.

`--beta-features / --no-beta-features`  
Ativar/desativar recursos beta.

`--debug`  
Ative o registro de depuração para imprimir mensagens de depuração geradas pela AWS SAM CLI e exibir registros de data e hora.

`-h, --help`  
Mostra esta mensagem e sai.

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

Enviar retorno de chamada de falha sem parâmetros:

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

Enviar retorno de chamada de falha com mensagem de erro:

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

Envie um retorno de chamada de falha com todos os 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>

Envie um retorno de chamada de pulsação para uma execução de função durável.

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

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

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

`CALLBACK_ID`  
O identificador exclusivo do retorno de chamada para o qual enviar uma pulsação.

## Opções
<a name="ref-sam-cli-local-callback-heartbeat-options"></a>

`--region TEXT`  
Defina a AWS região do serviço (por exemplo,`us-east-1`).

`--profile TEXT`  
Selecione um perfil específico do seu arquivo de credenciais para obter as AWS credenciais.

`--config-env TEXT`  
Nome do ambiente especificando valores de parâmetros padrão no arquivo de configuração. Padrão: `default`

`--config-file TEXT`  
Arquivo de configuração contendo valores de parâmetros padrão. Padrão: `samconfig.toml`

`--save-params`  
Salve os parâmetros fornecidos pela linha de comando no arquivo de configuração.

`--beta-features / --no-beta-features`  
Ativar/desativar recursos beta.

`--debug`  
Ative o registro de depuração para imprimir mensagens de depuração geradas pela AWS SAM CLI e exibir registros de data e hora.

`-h, --help`  
Mostra esta mensagem e sai.

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

Enviar retorno de chamada de pulsação:

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

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

Esta página fornece informações de referência para o AWS Serverless Application Model comando Command Line Interface (AWS SAMCLI)`sam local execution`.

Para obter uma introdução ao AWS SAMCLI, consulte [O que é o AWS SAMCLI?](what-is-sam-overview.md#what-is-sam-cli)

O `sam local execution` comando permite gerenciar e inspecionar as execuções de funções duráveis locais durante o desenvolvimento e o teste.

**nota**  
Esses comandos podem não exigir acesso às AWS credenciais.

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

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

## Opções
<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>
Mostre esta mensagem e saia.

## 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>
Obtenha detalhes de uma execução de função durável. Para obter mais informações, 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>
Obtenha o histórico de execução de uma função durável. Para obter mais informações, 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>
Interrompa a execução de uma função durável. Para obter mais informações, 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>

Recupere os detalhes da execução de uma função durável específica.

**nota**  
Esse comando pode não exigir acesso às AWS credenciais.

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

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

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

`DURABLE_EXECUTION_ARN`  
O Amazon Resource Name (ARN) da execução da função durável para a qual recuperar detalhes.

## Opções
<a name="ref-sam-cli-local-execution-get-options"></a>

`--format [summary|json]`  
Formato de saída. Padrão: `summary`

`--region TEXT`  
Defina a AWS região do serviço (por exemplo,`us-east-1`).

`--profile TEXT`  
Selecione um perfil específico do seu arquivo de credenciais para obter as AWS credenciais.

`--config-env TEXT`  
Nome do ambiente especificando valores de parâmetros padrão no arquivo de configuração. Padrão: `default`

`--config-file TEXT`  
Arquivo de configuração contendo valores de parâmetros padrão. Padrão: `samconfig.toml`

`--save-params`  
Salve os parâmetros fornecidos pela linha de comando no arquivo de configuração.

`--beta-features / --no-beta-features`  
Ativar/desativar os recursos beta.

`--debug`  
Ative o registro de depuração para imprimir mensagens de depuração geradas pela AWS SAM CLI e exibir registros de data e hora.

`-h, --help`  
Mostra esta mensagem e sai.

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

Obtenha detalhes da execução com o formato de resumo padrão:

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

Obtenha detalhes da execução no 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>

Obtenha o histórico de execução de uma função durável.

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

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

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

`EXECUTION_ID`  
O identificador exclusivo da execução durável da função para a qual recuperar o histórico.

## Opções
<a name="ref-sam-cli-local-execution-history-options"></a>

`--format [table|json]`  
Formato de saída. Padrão: `table`

`--region TEXT`  
Defina a AWS região do serviço (por exemplo,`us-east-1`).

`--profile TEXT`  
Selecione um perfil específico do seu arquivo de credenciais para obter as AWS credenciais.

`--config-env TEXT`  
Nome do ambiente especificando valores de parâmetros padrão no arquivo de configuração. Padrão: `default`

`--config-file TEXT`  
Arquivo de configuração contendo valores de parâmetros padrão. Padrão: `samconfig.toml`

`--save-params`  
Salve os parâmetros fornecidos pela linha de comando no arquivo de configuração.

`--beta-features / --no-beta-features`  
Ativar/desativar recursos beta.

`--debug`  
Ative o registro de depuração para imprimir mensagens de depuração geradas pela AWS SAM CLI e exibir registros de data e hora.

`-h, --help`  
Mostra esta mensagem e sai.

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

Obtenha o histórico de execução em formato de tabela:

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

Obtenha o histórico de execução no 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>

Interrompa a execução de uma função durável em execução.

**nota**  
Esse comando pode não exigir acesso às AWS credenciais.

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

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

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

`DURABLE_EXECUTION_ARN`  
O Amazon Resource Name (ARN) da execução da função durável a ser interrompida.

## Opções
<a name="ref-sam-cli-local-execution-stop-options"></a>

`--error-message TEXT`  
Mensagem de erro a ser associada à execução interrompida.

`--error-type TEXT`  
Tipo de erro a ser associado à execução interrompida.

`--error-data TEXT`  
Dados de erro a serem associados à execução interrompida.

`--stack-trace TEXT`  
Entradas de rastreamento de pilha. Essa opção pode ser especificada várias vezes.

`--region TEXT`  
Defina a AWS região do serviço (por exemplo,`us-east-1`).

`--profile TEXT`  
Selecione um perfil específico do seu arquivo de credenciais para obter as AWS credenciais.

`--config-env TEXT`  
Nome do ambiente especificando valores de parâmetros padrão no arquivo de configuração. Padrão: `default`

`--config-file TEXT`  
Arquivo de configuração contendo valores de parâmetros padrão. Padrão: `samconfig.toml`

`--save-params`  
Salve os parâmetros fornecidos pela linha de comando no arquivo de configuração.

`--beta-features / --no-beta-features`  
Ativar/desativar recursos beta.

`--debug`  
Ative o registro de depuração para imprimir mensagens de depuração geradas pela AWS SAM CLI e exibir registros de data e hora.

`-h, --help`  
Mostra esta mensagem e sai.

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

Pare a execução sem detalhes de erro:

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

Pare a execução com mensagem de erro e digite:

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

Pare a execução com detalhes completos do erro e rastreamento de pilha:

```
$ 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 fornece informações de referência para o AWS Serverless Application Model `sam local generate-event` subcomando Command Line Interface (AWS SAMCLI).
+ Para obter uma introdução ao AWS SAMCLI, consulte [O que é o AWS SAMCLI?](what-is-sam-overview.md#what-is-sam-cli)
+ Para obter a documentação sobre o uso do AWS SAMCLI `sam local generate-event` comando, consulte[Introdução aos testes com sam local generate-event](using-sam-cli-local-generate-event.md).

O subcomando `sam local generate-event` gera amostras de carga útil de eventos para suporte Serviços da AWS.

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

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

## Opções
<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>
O nome do ambiente que especifica os valores de parâmetros padrão no arquivo de configuração a serem usados. O valor padrão é “padrão”. Para obter mais informações sobre esses arquivos de configuração, consulte [Arquivo de configuração do AWS SAM CLI](serverless-sam-cli-config.md).

`--config-file PATH`  <a name="ref-sam-cli-local-generate-event-options-config-file"></a>
O caminho e o nome do arquivo de configuração contendo valores de parâmetros padrão a serem usados. O valor padrão é `samconfig.toml` na raiz do diretório do projeto. Para obter mais informações sobre esses arquivos de configuração, consulte [Arquivo de configuração do AWS SAM CLI](serverless-sam-cli-config.md).

`--help`  <a name="ref-sam-cli-local-generate-event-options-help"></a>
Mostra esta mensagem e sai.

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

Para visualizar uma lista de serviços compatíveis, execute o comando a seguir:

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

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

Para ver uma lista de eventos compatíveis que podem ser gerados para cada serviço, execute o seguinte:

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

## Opções de eventos
<a name="ref-sam-cli-local-generate-event-event-options"></a>

Para ver uma lista das opções de eventos compatíveis que você pode modificar, execute o seguinte:

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

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

Para obter exemplos sobre como usar o subcomando `sam local generate-event`, consulte [Gere eventos de exemplo](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 fornece informações de referência para o AWS Serverless Application Model `sam local invoke` subcomando Command Line Interface (AWS SAMCLI).
+ Para obter uma introdução ao AWS SAMCLI, consulte [O que é o AWS SAMCLI?](what-is-sam-overview.md#what-is-sam-cli)
+ Para obter a documentação sobre o uso do AWS SAMCLI `sam local invoke` subcomando, consulte[Introdução aos testes com sam local invoke](using-sam-cli-local-invoke.md).

O `sam local invoke` subcomando inicia uma invocação única de uma função localmente. AWS Lambda 

**nota**  
Não é recomendável usar os recursos de invocação local do SAM CLI em código não confiável. Para ter um isolamento completo do seu ambiente local, execute o código diretamente no serviço Lambda.

**nota**  
Para funções duráveis, `sam local invoke` suporta execução em estado com verificação e repetição automáticas. O contêiner permanece em execução durante a execução durável da função para lidar com a persistência e a retomada do estado.

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

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

**nota**  
Se você tiver mais de uma função definida em seu AWS SAM modelo, forneça a ID lógica da função que você deseja invocar.

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

**Resource ID (ID do recurso)**  <a name="ref-sam-cli-local-invoke-args-resource-id"></a>
O ID da função do Lambda a ser invocada.  
Esse argumento é opcional. Se seu aplicativo contiver uma única função Lambda, a AWS SAM CLI a invocará. Se seu aplicativo contiver várias funções, forneça o ID da função a ser invocada.  
*Valores válidos*: o ID lógico do recurso ou o ARN do recurso.

## Opções
<a name="ref-sam-cli-local-invoke-options"></a>

`--add-host LIST`  <a name="ref-sam-cli-local-invoke-options-add-host"></a>
Passa um nome de host para mapeamento de endereço IP para o arquivo host do contêiner do Docker. Esse parâmetro pode ser passado várias vezes.  

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

`--beta-features | --no-beta-features`  <a name="ref-sam-cli-local-invoke-options-beta-features"></a>
Permita ou negue recursos beta.

`--config-env TEXT`  <a name="ref-sam-cli-local-invoke-options-config-env"></a>
O nome do ambiente que especifica os valores de parâmetros padrão no arquivo de configuração a serem usados. O valor padrão é “padrão”. Para obter mais informações sobre esses arquivos de configuração, consulte [Arquivo de configuração do AWS SAM CLI](serverless-sam-cli-config.md).

`--config-file PATH`  <a name="ref-sam-cli-local-invoke-options-config-file"></a>
O caminho e o nome do arquivo de configuração contendo valores de parâmetros padrão a serem usados. O valor padrão é “`samconfig.toml`“ na raiz do diretório do projeto. Para obter mais informações sobre esses arquivos de configuração, consulte [Arquivo de configuração do AWS SAM CLI](serverless-sam-cli-config.md).

`--container-env-vars`  <a name="ref-sam-cli-local-invoke-options-container-env-vars"></a>
(Opcional) Passe variáveis de ambiente para o contêiner de imagem da função do Lambda ao depurar localmente.

`--container-host TEXT`  <a name="ref-sam-cli-local-invoke-options-container-host"></a>
Host do contêiner Lambda emulado localmente. O valor padrão é `localhost`. Se você quiser executar AWS SAMCLI em um contêiner do Docker no macOS, você pode especificar `host.docker.internal`. Se você quiser executar o contêiner em um host diferente AWS SAMCLI, você pode especificar o endereço IP do host remoto.

`--container-host-interface TEXT`  <a name="ref-sam-cli-local-invoke-options-container-host-interface"></a>
O endereço IP da interface de rede do host à qual as portas do contêiner devem se vincular. O valor padrão é `127.0.0.1`. Use `0.0.0.0` para vincular a todas as interfaces.

`--debug`  <a name="ref-sam-cli-local-invoke-options-debug"></a>
Ativa o registro de depuração para imprimir mensagens de depuração que o AWS SAMCLI gera e para exibir timestamps.

`--debug-args TEXT`  <a name="ref-sam-cli-local-invoke-options-debug-args"></a>
Argumentos adicionais a serem transmitidos para o depurador.

`--debug-port, -d TEXT`  <a name="ref-sam-cli-local-invoke-options-debug-port"></a>
Quando especificado, inicia o contêiner da função do Lambda no modo de depuração e expõe essa porta no host local.

`--debugger-path TEXT`  <a name="ref-sam-cli-local-invoke-options-debugger-path"></a>
O caminho do host para um depurador montado no contêiner Lambda.

`--docker-network TEXT`  <a name="ref-sam-cli-local-invoke-options-docker-network"></a>
Especifica o nome ou ID de uma rede Docker existente à qual os contêineres do Docker do Lambda devem se conectar, juntamente com a rede de ponte padrão. Se não for especificado, os contêineres do Lambda se conectarão somente à rede de Docker de ponte padrão.

`--docker-volume-basedir, -v TEXT`  <a name="ref-sam-cli-local-invoke-options-docker-volume-basedir"></a>
A localização do diretório base em que o AWS SAM arquivo existe. Se o Docker estiver sendo executado em uma máquina remota, você deverá montar o caminho em que o AWS SAM arquivo existe na máquina Docker e modificar esse valor para corresponder à máquina remota.

`--durable-execution-name TEXT`  <a name="ref-sam-cli-local-invoke-options-durable-execution-name"></a>
Nome da execução durável (somente para funções duráveis)

`--env-vars, -n PATH`  <a name="ref-sam-cli-local-invoke-options-env-vars"></a>
O JSON ou `.env` arquivo que contém valores para as variáveis de ambiente da função Lambda. O formato do arquivo é detectado automaticamente. Para obter mais informações sobre variáveis de ambiente, consulte [Arquivo de variável de ambiente](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>
O arquivo JSON que contém dados de eventos que são passados para a função do Lambda quando ela é invocada. Se você não especificar essa opção, nenhum evento será assumido. Para inserir JSON de`stdin`, você deve passar o valor '-'. Para obter detalhes sobre formatos de mensagens de eventos de diferentes AWS serviços, consulte Como [trabalhar com outros serviços](https://docs.aws.amazon.com/lambda/latest/dg/lambda-services.html) no *Guia do AWS Lambda desenvolvedor*.

`--force-image-build`  <a name="ref-sam-cli-local-invoke-options-force-image-build"></a>
Especifica se o AWS SAMCLI deve reconstruir a imagem usada para invocar função do Lambda com camadas.

`--help`  <a name="ref-sam-cli-local-invoke-options-help"></a>
Mostra esta mensagem e sai.

`--hook-name TEXT`  <a name="ref-sam-cli-local-invoke-options-hook-name"></a>
O nome do hook usado para estender a funcionalidade AWS SAMCLI.  
Valores aceitos: `terraform`.

`--invoke-image TEXT`  <a name="ref-sam-cli-local-invoke-options-invoke-image"></a>
O URI da imagem do contêiner que você deseja usar para a invocação da função local. Por padrão, o AWS SAM extrai a imagem de contêiner do Amazon ECR Public (que está listada em [Repositórios de imagens para AWS SAM](serverless-image-repositories.md)). Use essa opção para extrair a imagem de outro localização.  
Por exemplo, .`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 a localização do diretório base onde as camadas que seu modelo usa são baixadas.

`--log-file, -l TEXT`  <a name="ref-sam-cli-local-invoke-options-log-file"></a>
O arquivo de log para o qual enviar os registros de runtime.

`--mount-symlinks`  <a name="ref-sam-cli-local-invoke-options-mount-symlinks"></a>
Garante que a CLI do AWS SAM sempre monte symlinks que estão presentes nos arquivos a serem criados ou invocados. Isso se aplica somente aos symlinks no diretório de nível superior (ou seja, links simbólicos que estão diretamente na raiz da função). Por padrão, os symlinks não são montados, exceto aqueles necessários para usar o `build-in-source` no `node_modules` no NodeJS.

`--no-event`  <a name="ref-sam-cli-local-invoke-options-no-event"></a>
Invoca a função com um evento vazio.

`--no-memory-limit`  <a name="ref-sam-cli-local-invoke-options-no-memory-limit"></a>
Remove a limitação de memória no contêiner durante a chamada local, mesmo quando a memória está configurada no AWS SAM modelo.

`--parameter-overrides`  <a name="ref-sam-cli-local-invoke-options-parameter-overrides"></a>
Uma string que contém substituições de CloudFormation parâmetros codificadas como pares de valores-chave. Use o mesmo formato do AWS Command Line Interface (AWS CLI). O formato da CLI do AWS SAMé uma palavra-chave explícita de chave e valor e cada substituição é separada por um espaço. Veja dois exemplos a seguir:  
+ `--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>
O perfil específico do seu arquivo de credenciais que obtém as AWS credenciais.

`--region TEXT`  <a name="ref-sam-cli-local-invoke-options-region"></a>
A AWS região para a qual implantar. Por exemplo, us-east-1.

`--runtime TEXT`  <a name="ref-sam-cli-local-invoke-options-runtime"></a>
Usa o runtime especificado para invocar uma função do Lambda localmente. Isso substitui o runtime definido no arquivo `template.yml`. Isso também permite testar as funções do Lambda com diferentes tempos de execução sem modificar a configuração original da função.

`--save-params`  <a name="ref-sam-cli-local-invoke-options-save-params"></a>
Salve os parâmetros fornecidos na linha de comando no arquivo AWS SAM de configuração.

`--shutdown`  <a name="ref-sam-cli-local-invoke-options-shutdown"></a>
Emula um evento de desligamento após a conclusão da invocação, a fim de testar o tratamento da extensão sobre o comportamento de desligamento.

`--skip-prepare-infra`  <a name="ref-sam-cli-local-invoke-options-skip-prepare-infra"></a>
Ignora a fase de preparação se nenhuma alteração na infraestrutura tiver sido feita. Execute com a opção `--hook-name`.

`--skip-pull-image`  <a name="ref-sam-cli-local-invoke-options-skip-pull-image"></a>
Por padrão, ele AWS SAMCLI verifica o ambiente de runtime remoto mais recente do Lambda e atualiza sua imagem local automaticamente para se manter sincronizada.  
Especifique essa opção para pular a remoção da Docker imagem mais recente para seu ambiente de runtime do Lambda.

`--template, -t PATH`  <a name="ref-sam-cli-local-invoke-options-template"></a>
O arquivo AWS SAM de modelo.  
Essa opção não é compatível com o `--hook-name`.  
Se você especificar essa opção, AWS SAM carrega somente o modelo e os recursos locais para os quais ele aponta.

`--tenant-id TEXT`  <a name="ref-sam-cli-local-invoke-options-tenancyconfig"></a>
O ID do locatário para funções Lambda de vários locatários. Usado para garantir o isolamento computacional entre diferentes inquilinos. Obrigatório ao invocar funções configuradas com o modo de isolamento do inquilino.

`--terraform-plan-file`  <a name="ref-sam-cli-local-invoke-options-terraform-plan-file"></a>
O caminho relativo ou absoluto para seu arquivo de Terraform plano local ao usar o AWS SAMCLI com Terraform Cloud. Essa opção exige que `--hook-name` seja definida como `terraform`.

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

O exemplo a seguir usa um evento gerado para testes locais usando um evento `s3.json` para invocar uma função do Lambda localmente

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

O exemplo a seguir testa a função ` HelloWorldFunction` usando o runtime do Python 3.11

```
$ sam local invoke --runtime python3.11 HelloWorldFunction
```

O exemplo a seguir testa a função ` HelloWorldFunction` com nome de execução durável

```
$ 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 fornece informações de referência para o AWS Serverless Application Model `sam local start-api` subcomando Command Line Interface (AWS SAMCLI).
+ Para obter uma introdução ao AWS SAMCLI, consulte [O que é o AWS SAMCLI?](what-is-sam-overview.md#what-is-sam-cli)
+ Para obter a documentação sobre o uso do AWS SAMCLI `sam local start-api` subcomando, consulte[Introdução aos testes com sam local start-api](using-sam-cli-local-start-api.md).

O `sam local start-api` subcomando executa suas AWS Lambda funções localmente para testar por meio de um host de servidor HTTP local.

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

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

## Opções
<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>
Passa um nome de host para mapeamento de endereço IP para o arquivo host do contêiner do Docker. Esse parâmetro pode ser passado várias vezes.  

**Example**  
Exemplo: `--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>
Permita ou negue recursos beta.

`--config-env TEXT`  <a name="ref-sam-cli-local-start-api-options-config-env"></a>
O nome do ambiente que especifica os valores de parâmetros padrão no arquivo de configuração a serem usados. O valor padrão é “padrão”. Para obter mais informações sobre esses arquivos de configuração, consulte [Arquivo de configuração do AWS SAM CLI](serverless-sam-cli-config.md).

`--config-file PATH`  <a name="ref-sam-cli-local-start-api-options-config-file"></a>
O caminho e o nome do arquivo de configuração contendo valores de parâmetros padrão a serem usados. O valor padrão é “samconfig.toml” na raiz do diretório do projeto. Para obter mais informações sobre esses arquivos de configuração, consulte [Arquivo de configuração do AWS SAM CLI](serverless-sam-cli-config.md).

`--container-env-vars`  <a name="ref-sam-cli-local-start-api-options-container-env-vars"></a>
Opcional. Passe variáveis de ambiente para o contêiner de imagem ao depurar localmente.

`--container-host TEXT`  <a name="ref-sam-cli-local-start-api-options-container-host"></a>
Host do contêiner Lambda emulado localmente. O valor padrão é `localhost`. Se você quiser executar AWS SAMCLI em um contêiner do Docker no macOS, você pode especificar `host.docker.internal`. Se você quiser executar o contêiner em um host diferente AWS SAMCLI, você pode especificar o endereço IP do host remoto.

`--container-host-interface TEXT`  <a name="ref-sam-cli-local-start-api-options-container-host-interface"></a>
O endereço IP da interface de rede do host à qual as portas do contêiner devem se vincular. O valor padrão é `127.0.0.1`. Use `0.0.0.0` para vincular a todas as interfaces.

`--debug`  <a name="ref-sam-cli-local-start-api-options-debug"></a>
Ativa o registro de depuração para imprimir a mensagem de depuração gerada pelo AWS SAMCLI e exibir timestamps.

`--debug-args TEXT`  <a name="ref-sam-cli-local-start-api-options-debug-args"></a>
Argumentos adicionais a serem transmitidos para o depurador.

`--debug-function`  <a name="ref-sam-cli-local-start-api-options-debug-function"></a>
Opcional. Especifica a função do Lambda para aplicar opções de depuração quando for especificado como `--warm-containers`. Esse parâmetro se aplica a `--debug-port`, `--debugger-path` e `--debug-args`.

`--debug-port, -d TEXT`  <a name="ref-sam-cli-local-start-api-options-debug-port"></a>
Quando especificado, inicia o contêiner da função do Lambda no modo de depuração e expõe essa porta no host local.

`--debugger-path TEXT`  <a name="ref-sam-cli-local-start-api-options-debugger-path"></a>
O caminho do host para um depurador que será montado no contêiner Lambda.

`--docker-network TEXT`  <a name="ref-sam-cli-local-start-api-options-docker-network"></a>
Especifica o nome ou ID de uma rede Docker existente à qual os contêineres do Docker do Lambda devem se conectar, juntamente com a rede de ponte padrão. Se não for especificado, os contêineres do Lambda se conectarão somente à rede de Docker de ponte padrão.

` --docker-volume-basedir, -v TEXT`  <a name="ref-sam-cli-local-start-api-options-docker-volume-basedir"></a>
A localização do diretório base em que o AWS SAM arquivo existe. Se o Docker estiver sendo executado em uma máquina remota, você deverá montar o caminho em que o AWS SAM arquivo existe na máquina Docker e modificar esse valor para corresponder à máquina remota.

`--env-vars, -n PATH`  <a name="ref-sam-cli-local-start-api-options-env-vars"></a>
O JSON ou `.env` arquivo que contém valores para as variáveis de ambiente da função Lambda. O formato do arquivo é detectado automaticamente.

`--force-image-build`  <a name="ref-sam-cli-local-start-api-options-force-image-build"></a>
Especifica se AWS SAM CLI deve reconstruir a imagem usada para invocar funções com camadas.

`--help`  <a name="ref-sam-cli-local-start-api-options-help"></a>
Mostra esta mensagem e sai.

`--hook-name TEXT`  <a name="ref-sam-cli-local-start-api-options-hook-name"></a>
O nome do hook usado para estender a funcionalidade AWS SAMCLI.  
Valores aceitos: `terraform`.

`--host TEXT`  <a name="ref-sam-cli-local-start-api-options-host"></a>
O nome do host local ou endereço IP ao qual se vincular (padrão: '127.0.0.1').

`--invoke-image TEXT`  <a name="ref-sam-cli-local-start-api-options-invoke-image"></a>
O URI da imagem de contêiner que você deseja usar para suas funções do Lambda. Por padrão, AWS SAM extrai a imagem do contêiner do Amazon ECR Public. Use essa opção para extrair a imagem de outro localização.  
Especifique essa opção várias vezes. Cada instância dessa opção pode ter uma string ou um par de valores-chave. Se você especificar uma string, ela será a URI da imagem do contêiner a ser usada para todas as funções em seu aplicativo. Por exemplo, `sam local start-api --invoke-image public.ecr.aws/sam/emu-python3.8`. Se você especificar um par de valores-chave, a chave será o nome do recurso e o valor será o URI da imagem do contêiner a ser usada para esse recurso. Por exemplo `sam local start-api --invoke-image public.ecr.aws/sam/emu-python3.8 --invoke-image Function1=amazon/aws-sam-cli-emulation-image-python3.8 `. Com pares de valores-chave, você pode especificar imagens de contêiner diferentes para recursos diferentes.

`--layer-cache-basedir DIRECTORY`  <a name="ref-sam-cli-local-start-api-options-layer-cache-basedir"></a>
Especifica a localização com base na qual as camadas que seu modelo usa são baixadas.

`--log-file, -l TEXT`  <a name="ref-sam-cli-local-start-api-options-log-file"></a>
O arquivo de log para o qual enviar os registros de runtime.

`--no-memory-limit`  <a name="ref-sam-cli-local-start-api-options-no-memory-limit"></a>
Remove a limitação de memória no contêiner durante a chamada local, mesmo quando a memória está configurada no AWS SAM modelo.

`--parameter-overrides`  <a name="ref-sam-cli-local-start-api-options-parameter-overrides"></a>
Uma string que contém substituições de CloudFormation parâmetros codificadas como pares de valores-chave. Use o mesmo formato do AWS Command Line Interface (AWS CLI). O formato da CLI do AWS SAMé uma palavra-chave explícita de chave e valor e cada substituição é separada por um espaço. Veja dois exemplos a seguir:  
+ `--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>
O número da porta local para escutar (padrão: '3000').

`--profile TEXT`  <a name="ref-sam-cli-local-start-api-options-profile"></a>
O perfil específico do seu arquivo de credenciais que obtém as AWS credenciais.

`--region TEXT`  <a name="ref-sam-cli-local-start-api-options-region"></a>
A AWS região para a qual implantar. Por exemplo, us-east-1.

`--save-params`  <a name="ref-sam-cli-local-start-api-options-save-params"></a>
Salve os parâmetros que você fornece na linha de comando no arquivo AWS SAM de configuração.

`--shutdown`  <a name="ref-sam-cli-local-start-api-options-shutdown"></a>
Emula um evento de desligamento após a conclusão da invocação, a fim de testar o tratamento da extensão sobre o comportamento de desligamento.

`--skip-prepare-infra`  <a name="ref-sam-cli-local-start-api-options-skip-prepare-infra"></a>
Ignora a fase de preparação se nenhuma alteração na infraestrutura tiver sido feita. Execute com a opção `--hook-name`.

`--skip-pull-image`  <a name="ref-sam-cli-local-start-api-options-skip-pull-image"></a>
Especifica se o comando deve ignorar a extração da imagem mais recente do Docker para o runtime do Lambda.

`--ssl-cert-file PATH`  <a name="ref-sam-cli-local-start-api-options-ssl-cert-file"></a>
Caminho para o arquivo do certificado SSL (padrão: Nenhum). Ao usar essa opção, a opção `--ssl-key-file` também deve ser usada.

`--ssl-key-file PATH`  <a name="ref-sam-cli-local-start-api-options-static-dir"></a>
Caminho para o arquivo de chave SSL (padrão: Nenhum). Ao usar essa opção, a opção `--ssl-cert-file` também deve ser usada.

`--static-dir, -s TEXT`  <a name="ref-sam-cli-local-start-api-options-static-dir"></a>
Todos os arquivos de ativos estáticos (por exemplo,CSS/JavaScript/HTML) localizados nesse diretório são apresentados em`/`.

`--template, -t PATH`  <a name="ref-sam-cli-local-start-api-options-template"></a>
O arquivo AWS SAM de modelo.  
Se você especificar essa opção, AWS SAM carrega somente o modelo e os recursos locais para os quais ele aponta.

`--terraform-plan-file`  <a name="ref-sam-cli-local-start-api-options-terraform-plan-file"></a>
O caminho relativo ou absoluto para seu arquivo de Terraform plano local ao usar o AWS SAMCLI com Terraform Cloud. Essa opção exige que `--hook-name` seja definida como `terraform`.

`--warm-containers [EAGER | LAZY]`  <a name="ref-sam-cli-local-start-api-options-warm-containers"></a>
Opcional. Especifica como AWS SAMCLI gerencia os contêineres para cada função.  
Existem duas opções:  
   `EAGER`: os contêineres de todas as funções são carregados na inicialização e persistem entre as invocações.  
   `LAZY`: os contêineres são carregados somente quando cada função é invocada pela primeira vez. Esses contêineres persistem para invocações adicionais.

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

O exemplo a seguir inicia um servidor local, permitindo que você teste a aplicação por meio da API. Para que esse comando funcione, a aplicação deve estar instalada e o Docker deve estar em execução.

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

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

Esta página fornece informações de referência para o AWS Serverless Application Model `sam local start-lambda` subcomando Command Line Interface (AWS SAMCLI).
+ Para obter uma introdução ao AWS SAMCLI, consulte [O que é o AWS SAMCLI?](what-is-sam-overview.md#what-is-sam-cli)
+ Para obter a documentação sobre o uso do AWS SAMCLI `sam local start-lambda` subcomando, consulte[Introdução aos testes com sam local start-lambda](using-sam-cli-local-start-lambda.md).

O subcomando `sam local start-lambda` inicia um endpoint local para emular AWS Lambda.

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

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

## Opções
<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>
Passa um nome de host para mapeamento de endereço IP para o arquivo host do contêiner do Docker. Esse parâmetro pode ser passado várias vezes.  

**Example**  
Exemplo: `--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>
Permita ou negue recursos beta.

`--config-env TEXT`  <a name="ref-sam-cli-local-start-lambda-options-config-env"></a>
O nome do ambiente que especifica os valores de parâmetros padrão no arquivo de configuração a serem usados. O valor padrão é “padrão”. Para obter mais informações sobre esses arquivos de configuração, consulte [Arquivo de configuração do AWS SAM CLI](serverless-sam-cli-config.md).

`--config-file PATH`  <a name="ref-sam-cli-local-start-lambda-options-config-file"></a>
O caminho e o nome do arquivo de configuração contendo valores de parâmetros padrão a serem usados. O valor padrão é “samconfig.toml” na raiz do diretório do projeto. Para obter mais informações sobre esses arquivos de configuração, consulte [Arquivo de configuração do AWS SAM CLI](serverless-sam-cli-config.md).

`--container-env-vars`  <a name="ref-sam-cli-local-start-lambda-options-container-env-vars"></a>
Opcional. Passe variáveis de ambiente para o contêiner de imagem ao depurar localmente.

`--container-host TEXT`  <a name="ref-sam-cli-local-start-lambda-options-container-host"></a>
Host do contêiner Lambda emulado localmente. O valor padrão é `localhost`. Se você quiser executar AWS SAMCLI em um contêiner do Docker no macOS, você pode especificar `host.docker.internal`. Se você quiser executar o contêiner em um host diferente AWS SAMCLI, você pode especificar o endereço IP do host remoto.

`--container-host-interface TEXT`  <a name="ref-sam-cli-local-start-lambda-options-container-host-interface"></a>
O endereço IP da interface de rede do host à qual as portas do contêiner devem se vincular. O valor padrão é `127.0.0.1`. Use `0.0.0.0` para vincular a todas as interfaces.

`--debug`  <a name="ref-sam-cli-local-start-lambda-options-debug"></a>
Ativa o registro de depuração para imprimir a mensagem de depuração gerada pelo AWS SAMCLI e exibir timestamps.

`--debug-args TEXT`  <a name="ref-sam-cli-local-start-lambda-options-debug-args"></a>
Argumentos adicionais a serem transmitidos para o depurador.

`--debug-function`  <a name="ref-sam-cli-local-start-lambda-options-debug-function"></a>
Opcional. Especifica a função do Lambda para aplicar opções de depuração quando for especificado como `--warm-containers`. Esse parâmetro se aplica a `--debug-port`, `--debugger-path` e `--debug-args`.

`--debug-port, -d TEXT`  <a name="ref-sam-cli-local-start-lambda-options-debug-port"></a>
Quando especificado, inicia o contêiner da função do Lambda no modo de depuração e expõe essa porta no host local.

`--debugger-path TEXT`  <a name="ref-sam-cli-local-start-lambda-options-debugger-path"></a>
O caminho do host para um depurador a ser montado no contêiner Lambda.

`--docker-network TEXT`  <a name="ref-sam-cli-local-start-lambda-options-docker-network"></a>
Especifica o nome ou ID de uma rede Docker existente à qual os contêineres do Docker do Lambda devem se conectar, juntamente com a rede de ponte padrão. Se não for especificado, os contêineres do Lambda se conectarão somente à rede de Docker de ponte padrão.

`--docker-volume-basedir, -v TEXT`  <a name="ref-sam-cli-local-start-lambda-options-docker-volume-basedir"></a>
A localização do diretório base em que o AWS SAM arquivo existe. Se o Docker estiver sendo executado em uma máquina remota, você deverá montar o caminho em que o AWS SAM arquivo existe na máquina Docker e modificar esse valor para corresponder à máquina remota.

`--env-vars, -n PATH`  <a name="ref-sam-cli-local-start-lambda-options-env-vars"></a>
O JSON ou `.env` arquivo que contém valores para as variáveis de ambiente da função Lambda. O formato do arquivo é detectado automaticamente.

`--force-image-build`  <a name="ref-sam-cli-local-start-lambda-options-force-image-build"></a>
Especifique se CLI deve reconstruir a imagem usada para invocar funções com camadas.

`--help`  <a name="ref-sam-cli-local-start-lambda-options-help"></a>
Mostra esta mensagem e sai.

`--hook-name TEXT`  <a name="ref-sam-cli-local-start-lambda-options-hook-name"></a>
O nome do hook usado para estender a funcionalidade AWS SAMCLI.  
Valores aceitos: `terraform`.

`--host TEXT`  <a name="ref-sam-cli-local-start-lambda-options-host"></a>
O nome do host local ou endereço IP ao qual se vincular (padrão: '127.0.0.1').

`--invoke-image TEXT`  <a name="ref-sam-cli-local-start-lambda-options-invoke-image"></a>
O URI da imagem do contêiner que você deseja usar para a invocação da função local. Por padrão, AWS SAM extrai a imagem do contêiner do Amazon ECR Public. Use essa opção para extrair a imagem de outro localização.  
Por exemplo, .`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 a localização com base na qual as camadas que seu modelo usa são baixadas.

`--log-file, -l TEXT`  <a name="ref-sam-cli-local-start-lambda-options-log-file"></a>
O arquivo de log para o qual enviar os registros de runtime.

`--no-memory-limit`  <a name="ref-sam-cli-local-start-lambda-options-no-memory-limit"></a>
Remove a limitação de memória no contêiner durante a chamada local, mesmo quando a memória está configurada no AWS SAM modelo.

`--parameter-overrides`  <a name="ref-sam-cli-local-start-lambda-options-parameter-overrides"></a>
Uma string que contém substituições de CloudFormation parâmetros codificadas como pares de valores-chave. Use o mesmo formato do AWS Command Line Interface (AWS CLI). O formato da CLI do AWS SAMé uma palavra-chave explícita de chave e valor e cada substituição é separada por um espaço. Veja dois exemplos a seguir:  
+ `--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>
O número da porta local para escutar (padrão: '3001').

`--profile TEXT`  <a name="ref-sam-cli-local-start-lambda-options-profile"></a>
O perfil específico do seu arquivo de credenciais que obtém as AWS credenciais.

`--region TEXT`  <a name="ref-sam-cli-local-start-lambda-options-region"></a>
A AWS região para a qual implantar. Por exemplo, us-east-1.

`--save-params`  <a name="ref-sam-cli-local-start-lambda-options-save-params"></a>
Salve os parâmetros fornecidos na linha de comando no arquivo AWS SAM de configuração.

`--shutdown`  <a name="ref-sam-cli-local-start-lambda-options-shutdown"></a>
Emula um evento de desligamento após a conclusão da invocação, a fim de testar o tratamento da extensão sobre o comportamento de desligamento.

`--skip-prepare-infra`  <a name="ref-sam-cli-local-start-lambda-options-skip-prepare-infra"></a>
Ignora a fase de preparação se nenhuma alteração na infraestrutura tiver sido feita. Execute com a opção `--hook-name`.

`--skip-pull-image`  <a name="ref-sam-cli-local-start-lambda-options-skip-pull-image"></a>
Especifica se o comando CLI deve ignorar a extração da imagem do Docker mais recente para o runtime do Lambda.

`--template, -t PATH`  <a name="ref-sam-cli-local-start-lambda-options-template"></a>
O arquivo AWS SAM de modelo.  
Se você especificar essa opção, AWS SAM carrega somente o modelo e os recursos locais para os quais ele aponta. Essa opção não é compatível com `--hook-name`.

`--terraform-plan-file`  <a name="ref-sam-cli-local-start-lambda-options-terraform-plan-file"></a>
O caminho relativo ou absoluto para seu arquivo de Terraform plano local ao usar o AWS SAMCLI com Terraform Cloud. Essa opção exige que `--hook-name` seja definida como `terraform`.

`--warm-containers [EAGER | LAZY]`  <a name="ref-sam-cli-local-start-lambda-options-warm-containers"></a>
Opcional. Especifica como AWS SAMCLI gerencia os contêineres para cada função.  
Existem duas opções:  
+ `EAGER`: os contêineres de todas as funções são carregados na inicialização e persistem entre as invocações.
+ `LAZY`: os contêineres são carregados somente quando cada função é invocada pela primeira vez. Esses contêineres persistem para invocações adicionais.

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

Para obter um exemplo detalhado e uma explicação aprofundada sobre o uso do subcomando `sam local start-lambda`, consulte [Introdução aos testes com 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 fornece informações de referência para o AWS Serverless Application Model comando Command Line Interface (AWS SAMCLI)`sam logs`.

Para obter uma introdução ao AWS SAMCLI, consulte [O que é o AWS SAMCLI?](what-is-sam-overview.md#what-is-sam-cli)

O `sam logs` comando busca registros que são gerados por suas AWS Lambda funções.

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

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

## Opções
<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>
O nome do ambiente que especifica os valores de parâmetros padrão no arquivo de configuração a serem usados. O valor padrão é “padrão”. Para obter mais informações sobre esses arquivos de configuração, consulte [Arquivo de configuração do AWS SAM CLI](serverless-sam-cli-config.md).

`--config-file PATH`  <a name="sam-cli-command-reference-sam-logs-options-config-file"></a>
O caminho e o nome do arquivo de configuração contendo valores de parâmetros padrão a serem usados. O valor padrão é “samconfig.toml” na raiz do diretório do projeto. Para obter mais informações sobre esses arquivos de configuração, consulte [Arquivo de configuração do AWS SAM CLI](serverless-sam-cli-config.md).

`--cw-log-group LIST`  <a name="sam-cli-command-reference-sam-logs-options-cw-log-group"></a>
Inclui registros dos grupos de CloudWatch registros de registros que você especifica. Se você especificar essa opção junto com`name`, AWS SAM incluirá registros dos grupos de registros especificados, além dos registros dos recursos nomeados.

`--debug`  <a name="sam-cli-command-reference-sam-logs-options-debug"></a>
Ativa o registro de depuração para imprimir a mensagem de depuração gerada pelo AWS SAMCLI e exibir timestamps.

`---end-time, e TEXT`  <a name="sam-cli-command-reference-sam-logs-options-end-time"></a>
Busca registros até agora. A hora pode ser valores relativos, como '5 minutos atrás', 'amanhã' ou um carimbo de data/hora formatado como '2018-01-01 10:10:10'.

`--filter TEXT`  <a name="sam-cli-command-reference-sam-logs-options-filter"></a>
Permite especificar uma expressão para encontrar rapidamente registros que correspondam a termos, frases ou valores nos seus eventos de log. Isso pode ser uma palavra-chave simples (por exemplo, “erro”) ou um padrão compatível com o Amazon CloudWatch Logs. Para a sintaxe, consulte a [documentação do 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>
Mostra esta mensagem e sai.

`--include-traces`  <a name="sam-cli-command-reference-sam-logs-options-include-traces"></a>
Inclui traços de X-Ray na saída do log.

`--name, -n TEXT`  <a name="sam-cli-command-reference-sam-logs-options-name"></a>
O nome do recurso para o qual buscar registros. Se esse recurso fizer parte de uma CloudFormation pilha, esse pode ser o ID lógico do recurso da função no AWS SAM modelo CloudFormation/. Vários nomes podem ser fornecidos repetindo o parâmetro novamente. Se o recurso estiver em uma pilha aninhada, o nome poderá ser precedido pelo nome da pilha aninhada para extrair registros desse recurso (/). NestedStackLogicalId ResourceLogicalId Se o nome do recurso não for fornecido, a pilha fornecida será verificada e as informações de registro serão extraídas de todos os recursos compatíveis. Se você não especificar essa opção, AWS SAM buscará os registros de todos os recursos na pilha especificada. Os seguintes tipos de registro são compatíveis:  
+ `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 o formato de saída para logs. Para imprimir registros formatados, especifique`text`. Para imprimir os registros como JSON, especifique `json`.

`--profile TEXT`  <a name="sam-cli-command-reference-sam-logs-options-profile"></a>
O perfil específico do seu arquivo de credenciais que obtém as AWS credenciais.

`--region TEXT`  <a name="sam-cli-command-reference-sam-logs-options-region"></a>
A AWS região para a qual implantar. Por exemplo, us-east-1.

`--save-params`  <a name="sam-cli-command-reference-sam-logs-options-save-params"></a>
Salve os parâmetros que você fornece na linha de comando no arquivo AWS SAM de configuração.

`--stack-name TEXT`  <a name="sam-cli-command-reference-sam-logs-options-stack-name"></a>
O nome da CloudFormation pilha da qual o recurso faz parte.

`--start-time, -s TEXT`  <a name="sam-cli-command-reference-sam-logs-options-start-time"></a>
Busca registros a partir desse momento. A hora pode ser valores relativos, como '5 minutos atrás', 'ontem' ou um carimbo de data/hora formatado como '2018-01-01 10:10:10'. O padrão é '10 minutos atrás'.

` --tail, -t`  <a name="sam-cli-command-reference-sam-logs-options-tail"></a>
Encerra a saída do log. Isso ignora o argumento de horário de término e continua a buscar os registros à medida que eles se tornam disponíveis.

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

Quando suas funções fazem parte de uma CloudFormation pilha, você pode buscar registros usando o ID lógico da função ao especificar o nome da pilha.

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

Visualize os registros de um intervalo de tempo específico usando as opções -s (--start-time) e -e (--end-time).

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

Você também pode adicionar a opção `--tail` de aguardar novos registros e vê-los à medida que chegam.

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

Use a opção `--filter` para encontrar rapidamente os logs que correspondem a determinados termos, frases ou valores nos eventos de log.

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

Visualize os registros de um recurso em uma pilha secundária.

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

Registros finais de todos os recursos compatíveis em seu aplicativo.

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

Busque registros de uma função do Lambda específica e da API Gateway API em seu aplicativo.

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

Busque registros de todos os recursos compatíveis em seu aplicativo e, além disso, dos 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>

A interface de linha de AWS Serverless Application Model comando (AWS SAM CLI) empacota um AWS SAM aplicativo.

Esse comando cria um `.zip` arquivo com seu código e dependências e carrega o arquivo no Amazon Simple Storage Service (Amazon S3). AWS SAM ativa a criptografia para todos os arquivos armazenados no Amazon S3. Em seguida, ele retorna uma cópia do seu AWS SAM modelo, substituindo as referências aos artefatos locais pela localização do Amazon S3 em que o comando carregou os artefatos.

Por padrão, quando você usa esse comando, AWS SAMCLI pressupõe que seu diretório de trabalho atual seja o diretório raiz do seu projeto. O AWS SAMCLI primeiro tenta localizar um arquivo de modelo criado usando o [sam build](sam-cli-command-reference-sam-build.md) comando, localizado na `.aws-sam` subpasta e nomeado`template.yaml`. Em seguida, o AWS SAMCLI tenta localizar um arquivo de modelo chamado `template.yaml` ou `template.yml` no diretório de trabalho atual. Se você especificar a `--template` opção, o comportamento padrão AWS SAMCLI do modelo será substituído e empacotará apenas esse AWS SAM modelo e os recursos locais para os quais ele aponta.

**nota**  
[sam deploy](sam-cli-command-reference-sam-deploy.md) agora executa implicitamente a funcionalidade do `sam package`. Você pode usar o [sam deploy](sam-cli-command-reference-sam-deploy.md) comando diretamente para empacotar e implantar sua aplicação.

## Usage
<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 do recurso)**  <a name="sam-cli-command-reference-sam-package-args-resource-id"></a>
O ID da função do Lambda para empacotar.  
Esse argumento é opcional. Se seu aplicativo contiver uma única função Lambda, a AWS SAM CLI a empacotará. Se seu aplicativo contiver várias funções, forneça o ID da função para empacotar uma única função.  
*Valores válidos*: o ID lógico do recurso ou o ARN do recurso.

## Opções
<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>
O nome do ambiente que especifica os valores de parâmetros padrão no arquivo de configuração a serem usados. O valor padrão é “padrão”. Para obter mais informações sobre esses arquivos de configuração, consulte [Arquivo de configuração do AWS SAM CLI](serverless-sam-cli-config.md).

`--config-file PATH`  <a name="sam-cli-command-reference-sam-package-options-config-file"></a>
O caminho e o nome do arquivo de configuração contendo valores de parâmetros padrão a serem usados. O valor padrão é “samconfig.toml” na raiz do diretório do projeto. Para obter mais informações sobre esses arquivos de configuração, consulte [Arquivo de configuração do AWS SAM CLI](serverless-sam-cli-config.md).

`--debug`  <a name="sam-cli-command-reference-sam-package-options-debug"></a>
Ativa o registro de depuração para imprimir a mensagem de depuração gerada pelo AWS SAMCLI e exibir timestamps.

`--force-upload`  <a name="sam-cli-command-reference-sam-package-options-force-upload"></a>
Substituir arquivos existentes no bucket do Amazon S3. Especifique essa bandeira para fazer upload de artefatos, mesmo que eles correspondam aos artefatos existentes no bucket do Amazon S3.

`--help`  <a name="sam-cli-command-reference-sam-package-options-help"></a>
Mostra esta mensagem e sai.

`--image-repository TEXT`  <a name="sam-cli-command-reference-sam-package-options-image-repository"></a>
O URI do repositório do Amazon Elastic Container Registry (Amazon ECR) onde esse comando faz upload da imagem da função. Necessário para funções declaradas com o tipo de pacote `Image`.

`--kms-key-id TEXT`  <a name="sam-cli-command-reference-sam-package-options-kms-key-id"></a>
O ID de uma chave AWS Key Management Service (AWS KMS) usada para criptografar artefatos que estão em repouso no bucket do Amazon S3. Se essa opção não for especificada, AWS SAM usará as chaves de criptografia gerenciadas pelo Amazon S3.

`--metadata`  <a name="sam-cli-command-reference-sam-package-options-metadata"></a>
(Opcional) Um mapa de metadados para anexar a todos os artefatos referenciados em seu modelo.

`--no-progressbar`  <a name="sam-cli-command-reference-sam-package-options-no-progressbar"></a>
Não exiba uma barra de progresso ao fazer o upload de artefatos para o Amazon S3.

`--output-template-file PATH`  <a name="sam-cli-command-reference-sam-package-options-output-template-file"></a>
O caminho para o arquivo em que o comando grava o modelo empacotado. Se você não especificar um caminho, o comando gravará o modelo na saída padrão.

`--profile TEXT`  <a name="sam-cli-command-reference-sam-package-options-profile"></a>
O perfil específico do seu arquivo de credenciais que obtém as AWS credenciais.

`--region TEXT`  <a name="sam-cli-command-reference-sam-package-options-region"></a>
A AWS região para a qual implantar. Por exemplo, us-east-1.

`--resolve-s3`  <a name="sam-cli-command-reference-sam-package-options-resolve-s3"></a>
Crie automaticamente um bucket do Amazon S3 para usar na embalagem. Se você especificar as opções `--s3-bucket` e `--resolve-s3`, ocorrerá um erro.

`--s3-bucket TEXT`  <a name="sam-cli-command-reference-sam-package-options-s3-bucket"></a>
O nome do bucket do Amazon S3 em que esse comando faz upload do artefato. Se seu artefato for maior que 51.200 bytes, a opção `--s3-bucket` ou a `--resolve-s3` será obrigatória. Se você especificar as opções `--s3-bucket` e `--resolve-s3`, ocorrerá um erro.

`--s3-prefix TEXT`  <a name="sam-cli-command-reference-sam-package-options-s3-prefix"></a>
Prefixo adicionado ao nome do artefato que é carregado para o bucket do Amazon S3. O nome do prefixo é um nome de caminho (nome da pasta) para o bucket do Amazon S3. Isso só se aplica às funções declaradas com o tipo de `Zip` pacote.

`--save-params`  <a name="sam-cli-command-reference-sam-package-options-save-params"></a>
Salve os parâmetros fornecidos na linha de comando no arquivo AWS SAM de configuração.

`--signing-profiles LIST`  <a name="sam-cli-command-reference-sam-package-options-signing-profiles"></a>
(Opcional) A lista de perfis de assinatura com os quais assinar seus pacotes de implantação. Esse parâmetro usa uma lista de pares de valores-chave, em que a chave é o nome da função ou camada a ser assinada e o valor é o perfil de assinatura, com um proprietário de perfil opcional delimitado por `:`. Por exemplo, .`FunctionNameToSign=SigningProfileName1 LayerNameToSign=SigningProfileName2:SigningProfileOwner`

`--template-file, --template, -t PATH`  <a name="sam-cli-command-reference-sam-package-options-template-file"></a>
O caminho e o nome do arquivo em que seu AWS SAM modelo está localizado.  
Se você especificar essa opção, AWS SAM empacotará somente o modelo e os recursos locais para os quais ele aponta.

`--use-json`  <a name="sam-cli-command-reference-sam-package-options-use-json"></a>
JSON de saída para o CloudFormation modelo. YAML é usado por padrão.

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

O exemplo a seguir cria e empacota artefatos para uma função CodeDeploy e aplicativos Lambda. Os artefatos são carregados em um bucket do Amazon S3. A saída do comando é um novo arquivo chamado `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 fornece informações de referência para o AWS Serverless Application Model `sam local pipeline bootstrap` subcomando Command Line Interface (AWS SAMCLI).

Para uma introdução ao AWS SAMCLI, consulte [O que é o AWS SAMCLI?](what-is-sam-overview.md#what-is-sam-cli)

O `sam pipeline bootstrap` subcomando gera os recursos de AWS infraestrutura necessários para se conectar ao seu sistema de CI/CD. Essa etapa deve ser executada em cada estágio de implantação em seu pipeline antes de executar o comando **sam pipeline init**.

Esse subcomando configura os seguintes recursos de AWS infraestrutura:
+ Opção de configurar as permissões do pipeline por meio de:
  + Um usuário do pipeline IAM com ID da chave de acesso e credenciais de acesso à chave secreta a serem compartilhadas com o CI/CD sistema.
**nota**  
Recomendamos alternar as chaves de acesso regularmente. Para obter mais informações, consulte [Alterne as chaves de acesso regularmente para casos de uso que exijam credenciais de longo prazo](https://docs.aws.amazon.com/IAM/latest/UserGuide/best-practices.html#rotate-credentials) no *Guia do usuário do IAM*.
  +  CI/CD Plataformas suportadas por meio do OIDC. Para uma introdução sobre o uso do OIDC com pipeline AWS SAM , vá para [Como usar a autenticação OIDC com pipelines AWS SAM](deploying-with-oidc.md).
+ Uma função CloudFormation de execução do IAM assumida pela CloudFormation para implantar o AWS SAM aplicativo.
+ Um bucket Amazon S3 para armazenar os AWS SAM artefatos.
+ Opcionalmente, um repositório de imagens do Amazon ECR para armazenar pacotes de implantação Lambda de imagens de contêiner (se você tiver um recurso do tipo de pacote `Image`).

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

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

## Opções
<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>
 O UUID do repositório do Bitbucket. Essa opção é específica ao uso do Bitbucket OIDC para obter permissões.  
Esse valor pode ser encontrado em 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>
O ARN do bucket Amazon S3 que contém os artefatos. AWS SAM 

`--cicd-provider TEXT`  <a name="sam-cli-command-reference-sam-pipeline-bootstrap-options-cicd-provider"></a>
A CI/CD plataforma para o AWS SAM gasoduto.

`--cloudformation-execution-role TEXT`  <a name="sam-cli-command-reference-sam-pipeline-bootstrap-options-cloudformation-execution-role"></a>
O ARN da função do IAM a ser assumida CloudFormation durante a implantação da pilha do aplicativo. Forneça somente se quiser usar sua própria função. Caso contrário, o comando criará uma nova função.

`--config-env TEXT`  <a name="sam-cli-command-reference-sam-pipeline-bootstrap-options-config-env"></a>
O nome do ambiente que especifica os valores de parâmetros padrão no arquivo de configuração a serem usados. O valor padrão é **default**. Para obter mais informações sobre esses arquivos de configuração, consulte [Arquivo de configuração do AWS SAM CLI](serverless-sam-cli-config.md).

`--config-file PATH`  <a name="sam-cli-command-reference-sam-pipeline-bootstrap-options-config-file"></a>
O caminho e o nome do arquivo de configuração contendo os valores de parâmetros padrão a serem usados. O valor padrão é `samconfig.toml` na raiz do diretório do projeto. Para obter mais informações sobre esses arquivos de configuração, consulte [Arquivo de configuração do AWS SAM CLI](serverless-sam-cli-config.md).

`--confirm-changeset | --no-confirm-changeset`  <a name="sam-cli-command-reference-sam-pipeline-bootstrap-options-confirm-changeset"></a>
Solicite a confirmação da implantação de seus recursos.

`--create-image-repository | --no-create-image-repository`  <a name="sam-cli-command-reference-sam-pipeline-bootstrap-options-create-image-repository"></a>
Especifique se deseja criar um repositório de imagens do Amazon ECR se nenhum for fornecido. O repositório Amazon ECR contém as imagens de contêiner das funções do Lambda, ou camadas com um tipo de pacote de `Image`. O padrão é `--no-create-image-repository`.

`--debug`  <a name="sam-cli-command-reference-sam-pipeline-bootstrap-options-debug"></a>
Ativa o registro de depuração e imprime as mensagens de depuração que o AWS SAMCLI gera e para exibir timestamps.

`--deployment-branch TEXT`  <a name="sam-cli-command-reference-sam-pipeline-bootstrap-options-deployment-branch"></a>
Nome da filial a partir da qual as implantações ocorrerão. Essa opção é específica para usar GitHub Ações OIDC para obter permissões.

`--github-org TEXT`  <a name="sam-cli-command-reference-sam-pipeline-bootstrap-options-github-org"></a>
A GitHub organização à qual o repositório pertence. Se nenhuma organização existir, insira o nome de usuário do proprietário do repositório. Essa opção é específica para usar GitHub Ações OIDC para obter permissões.

`--github-repo TEXT`  <a name="sam-cli-command-reference-sam-pipeline-bootstrap-options-github-repo"></a>
Nome do GitHub repositório a partir do qual as implantações ocorrerão. Essa opção é específica para usar GitHub Ações OIDC para obter permissões.

`--gitlab-group TEXT`  <a name="sam-cli-command-reference-sam-pipeline-bootstrap-options-gitlab-group"></a>
O GitLab grupo ao qual o repositório pertence. Essa opção é específica para usar o GitLab OIDC para obter permissões.

`--gitlab-project TEXT`  <a name="sam-cli-command-reference-sam-pipeline-bootstrap-options-gitlab-project"></a>
O nome GitLab do projeto. Essa opção é específica para usar o GitLab OIDC para obter permissões.

`--help, -h`  <a name="sam-cli-command-reference-sam-pipeline-bootstrap-options-help"></a>
Mostra esta mensagem e sai.

`--image-repository TEXT`  <a name="sam-cli-command-reference-sam-pipeline-bootstrap-options-image-repository"></a>
O ARN de um repositório de imagens do Amazon ECR que contém as imagens de contêiner das funções do Lambda, ou camadas que têm um tipo de pacote de `Image`. Se fornecidas, as opções `--create-image-repository` serão ignoradas. Se não for fornecido e `--create-image-repository` for especificado, o comando cria um.

`--interactive | --no-interactive`  <a name="sam-cli-command-reference-sam-pipeline-bootstrap-options-interactive"></a>
Desative a solicitação interativa para parâmetros de bootstrap e falhe se algum parâmetro necessário estiver ausente. O valor padrão é `--interactive`. Para esse comando, `--stage` é o único parâmetro obrigatório.  
Se `--no-interactive` for especificado junto com `--use-oidc-provider`, todos os parâmetros necessários para seu provedor de OIDC devem ser incluídos.

`--oidc-client-id TEXT`  <a name="sam-cli-command-reference-sam-pipeline-bootstrap-options-oidc-client-id"></a>
O ID do cliente configurado para uso com seu provedor OIDC.

`--oidc-provider [github-actions | gitlab | bitbucket-pipelines]`  <a name="sam-cli-command-reference-sam-pipeline-bootstrap-options-oidc-provider"></a>
Nome do CI/CD provedor que será usado para permissões do OIDC. GitLab GitHub, e o Bitbucket são compatíveis.

`--oidc-provider-url TEXT`  <a name="sam-cli-command-reference-sam-pipeline-bootstrap-options-oidc-provider-url"></a>
O URL do provedor de OIDC. O valor deve começar com **https://**.

`--permissions-provider [oidc | iam]`  <a name="sam-cli-command-reference-sam-pipeline-bootstrap-options-permissions-provider"></a>
Escolha um provedor de permissões para assumir a função de execução do pipeline. O valor padrão é **iam**.

`--pipeline-execution-role TEXT`  <a name="sam-cli-command-reference-sam-pipeline-bootstrap-options-pipeline-execution-role"></a>
O ARN do perfil do IAM a ser assumida pelo usuário do pipeline para operar nesse estágio. Forneça somente se quiser usar sua própria função. Se não for fornecido, esse comando criará uma nova função.

`--pipeline-user TEXT`  <a name="sam-cli-command-reference-sam-pipeline-bootstrap-options-pipeline-user"></a>
O Amazon Resource Name (ARN) do usuário do IAM com o ID da chave de acesso e a chave de acesso secreta compartilhados com o CI/CD sistema. Ele é usado para conceder permissão a esse usuário do IAM para acessar a AWS conta correspondente. Se não for fornecido, o comando criará um usuário do IAM junto com o ID da chave de acesso e as credenciais da chave de acesso secreta.

`--profile TEXT`  <a name="sam-cli-command-reference-sam-pipeline-bootstrap-options-profile"></a>
O perfil específico do seu arquivo de credenciais que obtém as AWS credenciais.

`--region TEXT`  <a name="sam-cli-command-reference-sam-pipeline-bootstrap-options-region"></a>
A AWS região para a qual implantar. Por exemplo, .`us-east-1`

`--save-params`  <a name="sam-cli-command-reference-sam-pipeline-bootstrap-options-save-params"></a>
Salve os parâmetros fornecidos na linha de comando no arquivo AWS SAM de configuração.

`--stage TEXT`  <a name="sam-cli-command-reference-sam-pipeline-bootstrap-options-stage"></a>
O nome do estágio de implantação correspondente. Ele é usado como um sufixo para os recursos de AWS infraestrutura criados.

## Solução de problemas
<a name="sam-cli-command-reference-sam-pipeline-bootstrap-troubleshooting"></a>

### Erro: Falta o parâmetro necessário
<a name="sam-cli-command-reference-sam-pipeline-bootstrap-troubleshooting-example1"></a>

Quando `--no-interactive` for especificado junto com `--use-oidc-provider` e nenhum dos parâmetros necessários for fornecido, essa mensagem de erro será exibida junto com uma descrição dos parâmetros ausentes.

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

O exemplo a seguir cria os AWS recursos necessários para criar seu CI/CD sistema, ativa o registro de depuração e imprime mensagens de depuração geradas pelo AWS SAMCLI: usa um evento gerado para testes locais usando um evento para invocar uma função `s3.json` Lambda localmente.

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

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

Esta página fornece informações de referência para o AWS Serverless Application Model `sam pipeline init` subcomando Command Line Interface (AWS SAMCLI).

Para obter uma introdução ao AWS SAMCLI, consulte [O que é o AWS SAMCLI?](what-is-sam-overview.md#what-is-sam-cli)

O `sam pipeline init` subcomando gera um arquivo de configuração de pipeline que seu CI/CD sistema pode usar para implantar aplicativos sem servidor usando. AWS SAM

Antes de usar **sam pipeline init**, você deve criar os recursos necessários para cada estágio do seu pipeline. Você pode fazer isso executando **sam pipeline init --bootstrap** para ser guiado pelo processo de geração do arquivo de instalação e configuração ou consultando os recursos que você criou anteriormente com o comando **sam pipeline bootstrap**.

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

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

## Opções
<a name="sam-cli-command-reference-sam-pipeline-init-options"></a>

`--bootstrap`  <a name="sam-cli-command-reference-sam-pipeline-init-options-bootstrap"></a>
Ative o modo interativo que orienta o usuário na criação dos recursos de AWS infraestrutura necessários.

`--config-env TEXT`  <a name="sam-cli-command-reference-sam-pipeline-init-options-config-env"></a>
O nome do ambiente que especifica os valores de parâmetros padrão no arquivo de configuração a serem usados. O valor padrão é `default`. Para obter mais informações sobre esses arquivos de configuração, consulte [Arquivo de configuração do AWS SAM CLI](serverless-sam-cli-config.md).

`--config-file TEXT`  <a name="sam-cli-command-reference-sam-pipeline-init-options-config-file"></a>
O caminho e o nome do arquivo de configuração contendo valores de parâmetros padrão a serem usados. O valor padrão é `samconfig.toml` no diretório raiz do projeto. Para obter mais informações sobre esses arquivos de configuração, consulte [Arquivo de configuração do AWS SAM CLI](serverless-sam-cli-config.md).

`--debug`  <a name="sam-cli-command-reference-sam-pipeline-init-options-debug"></a>
Ativa o registro de depuração para imprimir a mensagem de depuração que o AWS SAMCLI gera e para exibir timestamps.

`--help, -h`  <a name="sam-cli-command-reference-sam-pipeline-init-options-help"></a>
Mostra esta mensagem e sai.

`--save-params`  <a name="sam-cli-command-reference-sam-pipeline-init-options-save-params"></a>
Salve os parâmetros fornecidos na linha de comando no arquivo AWS SAM de configuração.

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

O exemplo a seguir mostra como usar a `--bootstrap` opção para permitir que você percorra um modo interativo que orienta você na criação dos recursos de AWS infraestrutura necessários:

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

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

Esta página fornece informações de referência para o AWS Serverless Application Model comando Command Line Interface (AWS SAMCLI)`sam publish`.

Para obter uma introdução ao AWS SAMCLI, consulte [O que é o AWS SAMCLI?](what-is-sam-overview.md#what-is-sam-cli)

O `sam publish` comando publica um AWS SAM aplicativo no AWS Serverless Application Repository. Esse comando usa um AWS SAM modelo empacotado e publica o aplicativo na região especificada AWS .

O `sam publish` comando espera que o AWS SAM modelo inclua uma `Metadata` seção que contenha os metadados do aplicativo necessários para publicação. Na seção `Metadata`, as propriedades `LicenseUrl` e `ReadmeUrl` devem se referir aos buckets do Amazon Simple Storage Service (Amazon S3), não aos arquivos locais. Para obter mais informações sobre a `Metadata` seção do AWS SAM modelo, consulte[Como publicar a aplicação com a CLI do AWS SAM](serverless-sam-template-publishing-applications.md).

Por padrão, `sam publish` cria o aplicativo como privado. Antes que outras AWS contas possam visualizar e implantar seu aplicativo, você deve compartilhá-lo. Para obter informações sobre o compartilhamento de aplicativos, consulte [Exemplos de políticas AWS Serverless Application Repository baseadas em recursos](https://docs.aws.amazon.com/serverlessrepo/latest/devguide/security_iam_resource-based-policy-examples.html) no Guia do *AWS Serverless Application Repository desenvolvedor*.

**nota**  
Atualmente, `sam publish` não oferece suporte à publicação de aplicativos aninhados especificados localmente. Se seu aplicativo contiver aplicativos aninhados, você deverá publicá-los separadamente no AWS Serverless Application Repository antes de publicar seu aplicativo principal.

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

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

## Opções
<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>
O nome do ambiente que especifica os valores de parâmetros padrão no arquivo de configuração a serem usados. O valor padrão é “padrão”. Para obter mais informações sobre esses arquivos de configuração, consulte [Arquivo de configuração do AWS SAM CLI](serverless-sam-cli-config.md).

`--config-file PATH`  <a name="sam-cli-command-reference-sam-publish-options-config-file"></a>
O caminho e o nome do arquivo de configuração contendo valores de parâmetros padrão a serem usados. O valor padrão é “`samconfig.toml`“ na raiz do diretório do projeto. Para obter mais informações sobre esses arquivos de configuração, consulte [Arquivo de configuração do AWS SAM CLI](serverless-sam-cli-config.md).

`--debug`  <a name="sam-cli-command-reference-sam-publish-options-debug"></a>
Ativa o registro de depuração para imprimir a mensagem de depuração que o AWS SAMCLI gera e para exibir timestamps.

`--help`  <a name="sam-cli-command-reference-sam-publish-options-help"></a>
Mostra esta mensagem e sai.

`--profile TEXT`  <a name="sam-cli-command-reference-sam-publish-options-profile"></a>
O perfil específico do seu arquivo de credenciais que obtém as AWS credenciais.

`--region TEXT`  <a name="sam-cli-command-reference-sam-publish-options-region"></a>
A AWS região para a qual implantar. Por exemplo, us-east-1.

`--save-params`  <a name="sam-cli-command-reference-sam-publish-options-save-params"></a>
Salve os parâmetros fornecidos na linha de comando no arquivo AWS SAM de configuração.

`--semantic-version TEXT`  <a name="sam-cli-command-reference-sam-publish-options-semantic-version"></a>
(Opcional) Use essa opção para fornecer uma versão semântica do seu aplicativo que substitua a propriedade `SemanticVersion` na seção `Metadata` do arquivo de modelo. Para obter mais informações sobre controle de versionamento semântico, consulte a especificação de controle de versão [semântica](https://semver.org/).

`--template, -t PATH`  <a name="sam-cli-command-reference-sam-publish-options-template"></a>
O caminho do arquivo AWS SAM de modelo`[default: template.[yaml|yml]]`.

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

Para publicar um aplicativo:

```
$ 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 fornece informações de referência para o AWS Serverless Application Model comando Command Line Interface (AWS SAMCLI)`sam remote callback`.

Para uma introdução ao AWS SAMCLI, consulte [O que é o AWS SAMCLI?](what-is-sam-overview.md#what-is-sam-cli)

O `sam remote callback` comando permite que você envie retornos de chamada para execuções remotas de funções duráveis em execução no AWS Lambda.

**nota**  
Esses comandos exigem acesso às AWS credenciais.

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

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

## Opções
<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>
Mostre esta mensagem e saia.

## 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>
Envie um retorno de chamada bem-sucedido para uma execução remota de função durável. Para obter mais informações, 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>
Envie uma falha de retorno de chamada para uma execução remota de função durável. Para obter mais informações, 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>
Envie uma pulsação de retorno de chamada para uma execução remota de função durável. Para obter mais informações, 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>

Envie um retorno de chamada bem-sucedido para uma execução remota de função durável.

**nota**  
Esse comando requer acesso às AWS credenciais.

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

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

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

`CALLBACK_ID`  
O identificador exclusivo do retorno de chamada para o qual enviar uma resposta bem-sucedida.

## Opções
<a name="ref-sam-cli-remote-callback-succeed-options"></a>

`-r, --result TEXT`  
Carga útil do resultado de sucesso como string.

`--region TEXT`  
Defina a AWS região do serviço (por exemplo,`us-east-1`).

`--profile TEXT`  
Selecione um perfil específico do seu arquivo de credenciais para obter as AWS credenciais.

`--config-env TEXT`  
Nome do ambiente especificando valores de parâmetros padrão no arquivo de configuração. Padrão: `default`

`--config-file TEXT`  
Arquivo de configuração contendo valores de parâmetros padrão. Padrão: `samconfig.toml`

`--save-params`  
Salve os parâmetros fornecidos pela linha de comando no arquivo de configuração.

`--beta-features / --no-beta-features`  
Ativar/desativar os recursos beta.

`--debug`  
Ative o registro de depuração para imprimir mensagens de depuração geradas pela AWS SAM CLI e exibir registros de data e hora.

`-h, --help`  
Mostra esta mensagem e sai.

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

Envie um retorno de chamada bem-sucedido sem resultado:

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

Envie um retorno de chamada de sucesso com o 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>

Envie uma falha de retorno de chamada para uma execução remota de função durável.

**nota**  
Esse comando requer acesso às AWS credenciais.

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

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

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

`CALLBACK_ID`  
O identificador exclusivo do retorno de chamada para o qual enviar uma resposta de falha.

## Opções
<a name="ref-sam-cli-remote-callback-fail-options"></a>

`--error-data TEXT`  
Dados de erro adicionais.

`--stack-trace TEXT`  
Entradas de rastreamento de pilha. Essa opção pode ser especificada várias vezes.

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

`--error-message TEXT`  
Mensagem de erro detalhada.

`--region TEXT`  
Defina a AWS região do serviço (por exemplo,`us-east-1`).

`--profile TEXT`  
Selecione um perfil específico do seu arquivo de credenciais para obter as AWS credenciais.

`--config-env TEXT`  
Nome do ambiente especificando valores de parâmetros padrão no arquivo de configuração. Padrão: `default`

`--config-file TEXT`  
Arquivo de configuração contendo valores de parâmetros padrão. Padrão: `samconfig.toml`

`--save-params`  
Salve os parâmetros fornecidos pela linha de comando no arquivo de configuração.

`--beta-features / --no-beta-features`  
Ativar/desativar recursos beta.

`--debug`  
Ative o registro de depuração para imprimir mensagens de depuração geradas pela AWS SAM CLI e exibir registros de data e hora.

`-h, --help`  
Mostra esta mensagem e sai.

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

Envie um retorno de chamada de falha sem parâmetros:

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

Enviar retorno de chamada de falha com mensagem de erro:

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

Envie um retorno de chamada de falha com todos os 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>

Envie uma pulsação de retorno de chamada para uma execução remota de função durável.

**nota**  
Esse comando requer acesso às AWS credenciais.

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

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

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

`CALLBACK_ID`  
O identificador exclusivo do retorno de chamada para o qual enviar uma pulsação.

## Opções
<a name="ref-sam-cli-remote-callback-heartbeat-options"></a>

`--region TEXT`  
Defina a AWS região do serviço (por exemplo,`us-east-1`).

`--profile TEXT`  
Selecione um perfil específico do seu arquivo de credenciais para obter as AWS credenciais.

`--config-env TEXT`  
Nome do ambiente especificando valores de parâmetros padrão no arquivo de configuração. Padrão: `default`

`--config-file TEXT`  
Arquivo de configuração contendo valores de parâmetros padrão. Padrão: `samconfig.toml`

`--save-params`  
Salve os parâmetros fornecidos pela linha de comando no arquivo de configuração.

`--beta-features / --no-beta-features`  
Ativar/desativar recursos beta.

`--debug`  
Ative o registro de depuração para imprimir mensagens de depuração geradas pela AWS SAM CLI e exibir registros de data e hora.

`-h, --help`  
Mostra esta mensagem e sai.

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

Enviar retorno de chamada de pulsação:

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

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

Esta página fornece informações de referência para o AWS Serverless Application Model comando Command Line Interface (AWS SAMCLI)`sam remote execution`.

Para obter uma introdução ao AWS SAMCLI, consulte [O que é o AWS SAMCLI?](what-is-sam-overview.md#what-is-sam-cli)

O `sam remote execution` comando permite gerenciar e inspecionar execuções remotas de funções duráveis em execução no AWS Lambda.

**nota**  
Esses comandos exigem acesso às AWS credenciais.

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

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

## Opções
<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>
Mostre esta mensagem e saia.

## 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>
Obtenha detalhes de uma execução duradoura. Para obter mais informações, 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>
Obtenha o histórico de execução de uma função durável. Para obter mais informações, 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>
Interrompa a execução de uma função durável. Para obter mais informações, 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 os detalhes da execução de uma função durável específica do AWS Lambda.

O ARN de execução deve estar no formato retornado pelo Invoke ou encontrado nos registros de execução.

**nota**  
Esse comando requer acesso às AWS credenciais.

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

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

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

`DURABLE_EXECUTION_ARN`  
O Amazon Resource Name (ARN) da execução da função durável para a qual recuperar detalhes.

## Opções
<a name="ref-sam-cli-remote-execution-get-options"></a>

`--format [summary|json]`  
Formato de saída. Padrão: `summary`

`--region TEXT`  
Defina a AWS região do serviço (por exemplo,`us-east-1`).

`--profile TEXT`  
Selecione um perfil específico do seu arquivo de credenciais para obter as AWS credenciais.

`--config-env TEXT`  
Nome do ambiente especificando valores de parâmetros padrão no arquivo de configuração. Padrão: `default`

`--config-file TEXT`  
Arquivo de configuração contendo valores de parâmetros padrão. Padrão: `samconfig.toml`

`--save-params`  
Salve os parâmetros fornecidos pela linha de comando no arquivo de configuração.

`--beta-features / --no-beta-features`  
Ativar/desativar recursos beta.

`--debug`  
Ative o registro de depuração para imprimir mensagens de depuração geradas pela AWS SAM CLI e exibir registros de data e hora.

`-h, --help`  
Mostra esta mensagem e sai.

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

Obtenha detalhes da execução com o formato de resumo padrão:

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

Obtenha detalhes da execução no 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**  
Você deve garantir que os caracteres de controle no ARN de execução `$` sejam escapados corretamente ao usar comandos shell.

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

Recupere o histórico de execução de uma função durável específica do AWS Lambda.

O ARN de execução deve estar no formato retornado StartDurableExecution ou encontrado nos registros de execução.

**nota**  
Esse comando requer acesso às AWS credenciais.

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

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

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

`DURABLE_EXECUTION_ARN`  
O Amazon Resource Name (ARN) da execução da função durável para a qual recuperar o histórico.

## Opções
<a name="ref-sam-cli-remote-execution-history-options"></a>

`--format [table|json]`  
Formato de saída. Padrão: `table`

`--region TEXT`  
Defina a AWS região do serviço (por exemplo,`us-east-1`).

`--profile TEXT`  
Selecione um perfil específico do seu arquivo de credenciais para obter as AWS credenciais.

`--config-env TEXT`  
Nome do ambiente especificando valores de parâmetros padrão no arquivo de configuração. Padrão: `default`

`--config-file TEXT`  
Arquivo de configuração contendo valores de parâmetros padrão. Padrão: `samconfig.toml`

`--save-params`  
Salve os parâmetros fornecidos pela linha de comando no arquivo de configuração.

`--beta-features / --no-beta-features`  
Ativar/desativar recursos beta.

`--debug`  
Ative o registro de depuração para imprimir mensagens de depuração geradas pela AWS SAM CLI e exibir registros de data e hora.

`-h, --help`  
Mostra esta mensagem e sai.

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

Obtenha o histórico de execução com o formato de tabela padrão:

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

Obtenha o histórico de execução no 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>

Interrompa a execução de uma função durável em execução no AWS Lambda.

O ARN de execução deve estar no formato retornado StartDurableExecution ou encontrado nos registros de execução.

**nota**  
Esse comando requer acesso às AWS credenciais.

## Usage
<a name="ref-sam-cli-remote-execution-stop-usage"></a>

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

## Argumentos obrigatórios
<a name="ref-sam-cli-remote-execution-stop-arguments"></a>

`DURABLE_EXECUTION_ARN`  
O Amazon Resource Name (ARN) da execução da função durável a ser interrompida.

## Opções
<a name="ref-sam-cli-remote-execution-stop-options"></a>

`--error-message TEXT`  
Mensagem de erro a ser associada à execução interrompida.

`--error-type TEXT`  
Tipo de erro a ser associado à execução interrompida.

`--error-data TEXT`  
Dados de erro a serem associados à execução interrompida.

`--stack-trace TEXT`  
Entradas de rastreamento de pilha. Essa opção pode ser especificada várias vezes.

`--region TEXT`  
Defina a AWS região do serviço (por exemplo,`us-east-1`).

`--profile TEXT`  
Selecione um perfil específico do seu arquivo de credenciais para obter as AWS credenciais.

`--config-env TEXT`  
Nome do ambiente especificando valores de parâmetros padrão no arquivo de configuração. Padrão: `default`

`--config-file TEXT`  
Arquivo de configuração contendo valores de parâmetros padrão. Padrão: `samconfig.toml`

`--save-params`  
Salve os parâmetros fornecidos pela linha de comando no arquivo de configuração.

`--beta-features / --no-beta-features`  
Ativar/desativar os recursos beta.

`--debug`  
Ative o registro de depuração para imprimir mensagens de depuração geradas pela AWS SAM CLI e exibir registros de data e hora.

`-h, --help`  
Mostra esta mensagem e sai.

## Exemplos
<a name="ref-sam-cli-remote-execution-stop-examples"></a>

Pare a execução sem detalhes de erro:

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

Pare a execução com mensagem de erro e digite:

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

Pare a execução com detalhes completos do erro e rastreamento de pilha:

```
$ 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 fornece informações de referência para o AWS Serverless Application Model comando Command Line Interface (AWS SAMCLI)`sam remote invoke`.
+ Para uma introdução ao AWS SAMCLI, consulte [O que é o AWS SAMCLI?](what-is-sam-overview.md#what-is-sam-cli)
+ Para obter a documentação sobre o uso do AWS SAMCLI `sam remote invoke` comando, consulte[Introdução aos testes na nuvem com sam remote invoke](using-sam-cli-remote-invoke.md).

O `sam remote invoke` comando invoca recursos suportados no . Nuvem AWS

## Usage
<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 do recurso)**  <a name="sam-cli-command-reference-remote-invoke-args-resource-id"></a>
O ID do recurso suportado a ser invocado.  
Esse argumento aceita os seguintes valores:  
+ **O nome de recurso da Amazon (ARN)** - O ARN do conjunto de recursos.
**dica**  
Use `sam list stack-outputs --stack-name <stack-name>` para obter o ARN dos seus recursos.
+ **ID lógico** - O ID lógico do recurso. Você também deve fornecer o nome da AWS CloudFormation pilha usando a `--stack-name` opção.
+ **ID físico** — O ID físico do recurso. Esse ID é criado quando você implanta um recurso usando CloudFormation o.
**dica**  
Use `sam list resources --stack-name <stack-name>` para obter a identificação física dos seus recursos.  
**Quando você fornece um ARN ou ID física:**  
Se você fornecer um ARN ou ID física, não forneça um nome de pilha. Quando o nome da pilha for fornecido usando a `--stack-name` opção, ou quando o nome da pilha for definido em seu arquivo de configuração, ele AWS SAM CLI processará automaticamente sua ID de recurso como um valor de ID lógico da CloudFormation pilha.  
**Quando você não fornece um ID de recurso:**  
Se você não fornecer um ID de recurso, mas fornecer um nome de pilha com a `--stack-name` opção, a AWS SAM CLI tentará invocar automaticamente um recurso em CloudFormation sua pilha usando a seguinte lógica:  

1. Eles AWS SAM CLI identificarão os tipos de recursos na seguinte ordem e passarão para a próxima etapa quando o tipo de recurso for encontrado em sua pilha:

   1. Lambda

   1. Step Functions

   1. Amazon SQS

   1. Kinesis Data Streams

1. Se o tipo de recurso tiver um único recurso em sua pilha, AWS SAM CLI ele o invocará. Se existirem vários recursos do tipo de recurso em sua pilha, eles AWS SAM CLI retornarão um erro.
A seguir estão exemplos do que eles AWS SAM CLI farão:  
+ **Pilha que contém duas funções Lambda e uma fila do Amazon SQS** — Ela AWS SAM CLI localizará o tipo de recurso Lambda e retornará um erro, pois a pilha contém mais de uma função Lambda.
+ **Pilha que contém uma função Lambda e dois aplicativos Amazon Kinesis Data Streams** AWS SAM CLI — Eles localizarão a função Lambda e a invocarão, pois a pilha contém um único recurso Lambda.
+ **Pilha que contém uma única fila do Amazon SQS e dois aplicativos do Kinesis Data Streams — Eles AWS SAM CLI localizarão a fila** do Amazon SQS e a invocarão, pois a pilha contém uma única fila do Amazon SQS.

## Opções
<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>
Permita ou negue recursos beta.

`--config-env TEXT`  <a name="sam-cli-command-reference-remote-invoke-options-config-env"></a>
Especifique o ambiente a ser usado em seu arquivo AWS SAMCLI de configuração.  
*Padrão*: `default`

`--config-file FILENAME`  <a name="sam-cli-command-reference-remote-invoke-options-config-file"></a>
Especifique o caminho e o nome do arquivo de configuração.  
Para obter mais informações sobre esses arquivos de configuração, consulte [Configurando o AWS SAM CLI](using-sam-cli-configure.md).  
*Padrão*: `samconfig.toml` na raiz do diretório do seu projeto. 

`--debug`  <a name="sam-cli-command-reference-remote-invoke-options-debug"></a>
Ative o registro da depuração. Isso imprime mensagens de depuração e registros de data e hora gerados pelo AWS SAM CLI.

`--event, -e TEXT`  <a name="sam-cli-command-reference-remote-invoke-options-event"></a>
O evento a ser enviado ao recurso de destino.

`--event-file FILENAME`  <a name="sam-cli-command-reference-remote-invoke-options-event-file"></a>
O caminho para um arquivo que contém o evento a ser enviado ao recurso de destino.

`--help, -h`  <a name="sam-cli-command-reference-remote-invoke-options-help"></a>
Mostra a mensagem de ajuda e sai.

`--output [ text | json ]`  <a name="sam-cli-command-reference-remote-invoke-options-output"></a>
Exiba os resultados da sua invocação em um formato de saída específico.  
`json`— Os metadados da solicitação e a resposta do recurso são retornados na estrutura JSON. A resposta contém a saída completa do SDK.  
`text`— Os metadados da solicitação são retornados na estrutura de texto. A resposta do recurso é retornada no formato de saída do recurso invocado.

`--parameter`  <a name="sam-cli-command-reference-remote-invoke-options-parameter"></a>
[https://boto3.amazonaws.com/v1/documentation/api/latest/index.html](https://boto3.amazonaws.com/v1/documentation/api/latest/index.html)Parâmetros adicionais que você pode passar para o recurso que está sendo chamado.    
**Amazon Kinesis Data Streams**  <a name="sam-cli-command-reference-remote-invoke-options-parameter-kinesis"></a>
Os seguintes parâmetros adicionais podem ser usados para colocar um registro no fluxo de dados do Kinesis:  
+ `ExplicitHashKey='string'`
+ `PartitionKey='string'`
+ `SequenceNumberForOrdering='string'`
+ `StreamARN='string'`
Para obter uma descrição de cada parâmetro, consulte [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>
Os seguintes parâmetros adicionais podem ser usados para invocar um recurso Lambda e receber uma resposta em buffer:  
+ `ClientContext='base64-encoded string'`
+ `InvocationType='[ DryRun | Event | RequestResponse ]'`
+ `LogType='[ None | Tail ]'`
+ `Qualifier='string'`
Os seguintes parâmetros adicionais podem ser usados para invocar um recurso Lambda com streaming de resposta:  
+ `ClientContext='base64-encoded string'`
+ `InvocationType='[ DryRun | RequestResponse ]'`
+ `LogType='[ None | Tail ]'`
+ `Qualifier='string'`
Para obter uma descrição de cada parâmetro, consulte o seguinte:  
+ [Lambda com resposta em buffer — Lambda.client.invoke](https://boto3.amazonaws.com/v1/documentation/api/latest/reference/services/lambda/client/invoke.html)
+ [Lambda com streaming de resposta — 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>
Os seguintes parâmetros adicionais podem ser usados para enviar uma mensagem para uma fila do Amazon SQS:  
+ `DelaySeconds=integer`
+ `MessageAttributes='json string'`
+ `MessageDeduplicationId='string'`
+ `MessageGroupId='string'`
+ `MessageSystemAttributes='json string'`
Para obter uma descrição de cada parâmetro, consulte [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>
Os seguintes parâmetros adicionais podem ser usados para iniciar uma execução de máquina de estado:  
+ `name='string'`
+ `traceHeader='string'`
Para obter uma descrição de cada parâmetro, consulte [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>
O perfil específico do seu arquivo de credenciais para obter as AWS credenciais.

`--region TEXT`  <a name="sam-cli-command-reference-remote-invoke-options-region"></a>
O Região da AWS do recurso. Por exemplo, .`us-east-1`

`--stack-name TEXT`  <a name="sam-cli-command-reference-remote-invoke-options-stack-name"></a>
O nome da CloudFormation pilha à qual o recurso pertence.

`--tenant-id TEXT`  <a name="ref-sam-cli-local-invoke-options-tenancyconfig"></a>
O ID do locatário para funções Lambda de vários locatários. Usado para garantir o isolamento computacional entre diferentes inquilinos. Obrigatório ao invocar funções configuradas com o modo de isolamento do inquilino.

`--test-event-name NAME`  <a name="sam-cli-command-reference-remote-invoke-options-test-event-name"></a>
O nome do evento de teste compartilhável a ser passado para sua função do Lambda.  
Essa opção oferece suporte apenas às funções Lambda.

## Exemplo
<a name="sam-cli-command-reference-remote-invoke-examples"></a>

O exemplo a seguir invoca recursos compatíveis na AWS nuvem e ativa o registro de depuração, que imprime mensagens de depuração e registros de data e hora gerados pelo: AWS SAMCLI

```
$ sam remote invoke--debug
```

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

Esta página fornece informações de referência para o AWS Serverless Application Model comando Command Line Interface (AWS SAMCLI)`sam remote test-event`.
+ Para obter uma introdução ao AWS SAMCLI, consulte [O que é o AWS SAMCLI?](what-is-sam-overview.md#what-is-sam-cli)
+ Para obter a documentação sobre como usar o AWS SAMCLI `sam remote test-event` comando, consulte[Introdução aos testes em nuvem com sam remote test-event](using-sam-cli-remote-test-event.md).

O `sam remote test-event` comando interage com eventos de teste compartilháveis no registro do EventBridge esquema da Amazon.

## Usage
<a name="sam-cli-command-reference-remote-test-event-usage"></a>

```
$ sam remote test-event <options> <subcommand>
```

## Opções
<a name="sam-cli-command-reference-remote-test-event-options"></a>

`--help, -h`  <a name="sam-cli-command-reference-remote-invoke-options-help"></a>
Mostre a mensagem de ajuda e saia.

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

`delete`  
Exclua um evento de teste compartilhável do registro do EventBridge esquema. Para obter mais informações, consulte [sam remote test-event delete](sam-cli-command-reference-remote-test-event-delete.md).

`get`  
Obtenha um evento de teste compartilhável do registro do EventBridge esquema. Para obter mais informações, consulte [sam remote test-event get](sam-cli-command-reference-remote-test-event-get.md).

`list`  
Listar eventos de teste compartilháveis existentes para uma AWS Lambda função. Para obter mais informações, consulte [sam remote test-event list](sam-cli-command-reference-remote-test-event-list.md).

`put`  
Salve um evento de um arquivo local no registro do EventBridge esquema. Para obter mais informações, consulte [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 fornece informações de referência para o AWS Serverless Application Model `sam remote test-event delete` subcomando Command Line Interface (AWS SAMCLI).
+ Para obter uma introdução ao AWS SAMCLI, consulte [O que é o AWS SAMCLI?](what-is-sam-overview.md#what-is-sam-cli)
+ Para obter a documentação sobre como usar o AWS SAMCLI `sam remote test-event` comando, consulte[Introdução aos testes em nuvem com sam remote test-event](using-sam-cli-remote-test-event.md).

O `sam remote test-event delete` subcomando exclui um evento de teste compartilhável do registro de esquemas da Amazon EventBridge .

## Usage
<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 do recurso)**  <a name="sam-cli-command-reference-remote-test-event-delete-args-resource-id"></a>
O ID da AWS Lambda função associada ao evento de teste compartilhável.  
Se você fornecer uma ID lógica, também deverá fornecer um valor para a AWS CloudFormation pilha associada à função Lambda usando `--stack-name` a opção.  
*Valores válidos*: o ID lógico do recurso ou o recurso ARN.

## Opções
<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>
O nome do ambiente que especifica os valores de parâmetros padrão no arquivo de configuração a serem usados. O valor padrão é “padrão”. Para obter mais informações sobre esses arquivos de configuração, consulte [Arquivo de configuração do AWS SAM CLI](serverless-sam-cli-config.md).

`--config-file PATH`  <a name="sam-cli-command-reference-remote-test-event-delete-options-config-file"></a>
O caminho e o nome do arquivo de configuração contendo valores de parâmetros padrão a serem usados. O valor padrão é “`samconfig.toml`“ na raiz do diretório do projeto. Para obter mais informações sobre esses arquivos de configuração, consulte [Arquivo de configuração do AWS SAM CLI](serverless-sam-cli-config.md).

`--help, -h`  <a name="sam-cli-command-reference-remote-test-event-delete-options-help"></a>
Mostre a mensagem de ajuda e saia.

`--name TEXT`  <a name="sam-cli-command-reference-remote-test-event-delete-options-name"></a>
O nome do evento de teste compartilhável a ser excluído.

`--stack-name TEXT`  <a name="sam-cli-command-reference-remote-test-event-delete-options-stack-name"></a>
O nome da CloudFormation pilha associada à função Lambda.  
Essa opção é necessária se você estiver fornecendo a ID lógica da função do Lambda como argumento.

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

Esta página fornece informações de referência para o AWS Serverless Application Model `sam remote test-event get` subcomando Command Line Interface (AWS SAMCLI).
+ Para obter uma introdução ao AWS SAMCLI, consulte [O que é o AWS SAMCLI?](what-is-sam-overview.md#what-is-sam-cli)
+ Para obter a documentação sobre o uso do AWS SAMCLI `sam remote test-event` comando, consulte[Introdução aos testes em nuvem com sam remote test-event](using-sam-cli-remote-test-event.md).

O `sam remote test-event get` subcomando obtém um evento de teste compartilhável do registro de EventBridge esquemas da Amazon.

## Usage
<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 do recurso)**  <a name="sam-cli-command-reference-remote-test-event-get-args-resource-id"></a>
O ID da AWS Lambda função associada ao evento de teste compartilhável a ser obtido.  
Se você fornecer uma ID lógica, também deverá fornecer um valor para a AWS CloudFormation pilha associada à função Lambda usando `--stack-name` a opção.  
*Valores válidos*: o ID lógico do recurso ou o recurso ARN.

## Opções
<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>
O nome do ambiente que especifica os valores de parâmetros padrão no arquivo de configuração a serem usados. O valor padrão é “padrão”. Para obter mais informações sobre esses arquivos de configuração, consulte [Arquivo de configuração do AWS SAM CLI](serverless-sam-cli-config.md).

`--config-file PATH`  <a name="sam-cli-command-reference-remote-test-event-get-options-config-file"></a>
O caminho e o nome do arquivo de configuração contendo valores de parâmetros padrão a serem usados. O valor padrão é “`samconfig.toml`“ na raiz do diretório do projeto. Para obter mais informações sobre esses arquivos de configuração, consulte [Arquivo de configuração do AWS SAM CLI](serverless-sam-cli-config.md).

`--help, -h`  <a name="sam-cli-command-reference-remote-test-event-get-options-help"></a>
Mostre a mensagem de ajuda e saia.

`--name TEXT`  <a name="sam-cli-command-reference-remote-test-event-get-options-name"></a>
O nome do evento de teste compartilhável a ser obtido.

`--output-file FILENAME`  <a name="sam-cli-command-reference-remote-test-event-get-options-output-file"></a>
O caminho e o nome do arquivo para salvar o evento em sua máquina local.  
Se você não fornecer essa opção, ele AWS SAM CLI exibirá o conteúdo do evento de teste compartilhável para o seu console.

`--stack-name TEXT`  <a name="sam-cli-command-reference-remote-test-event-get-options-stack-name"></a>
O nome da CloudFormation pilha associada à função Lambda.  
Essa opção é necessária se você estiver fornecendo a ID lógica da função do Lambda como argumento.

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

Esta página fornece informações de referência para o AWS Serverless Application Model `sam remote test-event list` subcomando Command Line Interface (AWS SAMCLI).
+ Para uma introdução ao AWS SAMCLI, consulte [O que é o AWS SAMCLI?](what-is-sam-overview.md#what-is-sam-cli)
+ Para obter a documentação sobre como usar o AWS SAMCLI `sam remote test-event` comando, consulte[Introdução aos testes em nuvem com sam remote test-event](using-sam-cli-remote-test-event.md).

O `sam remote test-event list` subcomando lista os eventos de teste compartilháveis existentes para uma AWS Lambda função específica do registro de EventBridge esquemas da Amazon.

## Usage
<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 do recurso)**  <a name="sam-cli-command-reference-remote-test-event-list-args-resource-id"></a>
O ID da função do Lambda associado aos eventos de teste compartilháveis.  
Se você fornecer uma ID lógica, também deverá fornecer um valor para a AWS CloudFormation pilha associada à função Lambda usando `--stack-name` a opção.  
*Valores válidos*: o ID lógico do recurso ou o recurso ARN.

## Opções
<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>
O nome do ambiente que especifica os valores de parâmetros padrão no arquivo de configuração a serem usados. O valor padrão é “padrão”. Para obter mais informações sobre esses arquivos de configuração, consulte [Arquivo de configuração do AWS SAM CLI](serverless-sam-cli-config.md).

`--config-file PATH`  <a name="sam-cli-command-reference-remote-test-event-list-options-config-file"></a>
O caminho e o nome do arquivo de configuração contendo valores de parâmetros padrão a serem usados. O valor padrão é “`samconfig.toml`“ na raiz do diretório do projeto. Para obter mais informações sobre esses arquivos de configuração, consulte [Arquivo de configuração do AWS SAM CLI](serverless-sam-cli-config.md).

`--help, -h`  <a name="sam-cli-command-reference-remote-test-event-list-options-help"></a>
Mostre a mensagem de ajuda e saia.

`--stack-name TEXT`  <a name="sam-cli-command-reference-remote-test-event-list-options-stack-name"></a>
O nome da CloudFormation pilha associada à função Lambda.  
Essa opção é necessária se você estiver fornecendo a ID lógica da função do Lambda como argumento.

## Exemplos
<a name="sam-cli-command-reference-remote-test-event-list-examples"></a>

Para obter exemplos sobre como usar esse comando, consulte [Listando eventos de teste compartilháveis](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 fornece informações de referência para o AWS Serverless Application Model `sam remote test-event put` subcomando Command Line Interface (AWS SAMCLI).
+ Para obter uma introdução ao AWS SAMCLI, consulte [O que é o AWS SAMCLI?](what-is-sam-overview.md#what-is-sam-cli)
+ Para obter a documentação sobre o uso do AWS SAMCLI `sam remote test-event` comando, consulte[Introdução aos testes em nuvem com sam remote test-event](using-sam-cli-remote-test-event.md).

O `sam remote test-event put` subcomando salva um evento de teste compartilhável da sua máquina local no registro do EventBridge esquema da Amazon.

## Usage
<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 do recurso)**  <a name="sam-cli-command-reference-remote-test-event-put-args-resource-id"></a>
O ID da AWS Lambda função associada ao evento de teste compartilhável.  
Se você fornecer uma ID lógica, também deverá fornecer um valor para a AWS CloudFormation pilha associada à função Lambda usando `--stack-name` a opção.  
*Valores válidos*: o ID lógico do recurso ou o recurso ARN.

## Opções
<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>
O nome do ambiente que especifica os valores de parâmetros padrão no arquivo de configuração a serem usados. O valor padrão é “padrão”. Para obter mais informações sobre esses arquivos de configuração, consulte [Arquivo de configuração do AWS SAM CLI](serverless-sam-cli-config.md).

`--config-file PATH`  <a name="sam-cli-command-reference-remote-test-event-put-options-config-file"></a>
O caminho e o nome do arquivo de configuração contendo valores de parâmetros padrão a serem usados. O valor padrão é “`samconfig.toml`“ na raiz do diretório do projeto. Para obter mais informações sobre esses arquivos de configuração, consulte [Arquivo de configuração do AWS SAM CLI](serverless-sam-cli-config.md).

`--file FILENAME`  <a name="sam-cli-command-reference-remote-test-event-put-options-file"></a>
O caminho do arquivo e o nome do evento em sua máquina local.  
Forneça `-` como o valor do nome do arquivo a ser lido de `stdin`.  
Essa opção é obrigatória.

`--force`, `-f`  <a name="sam-cli-command-reference-remote-test-event-put-options-force"></a>
Substitua um evento de teste compartilhável com o mesmo nome.

`--help, -h`  <a name="sam-cli-command-reference-remote-test-event-put-options-help"></a>
Mostre a mensagem de ajuda e saia.

`--name TEXT`  <a name="sam-cli-command-reference-remote-test-event-put-options-name"></a>
O nome para salvar o evento de teste compartilhável como.  
Se existir um evento de teste compartilhável com o mesmo nome no registro do EventBridge esquema, AWS SAM CLI ele não o substituirá. Para sobrescrever, adicione a opção `--force`.

`--output-file FILENAME`  <a name="sam-cli-command-reference-remote-test-event-put-options-output-file"></a>
O caminho e o nome do arquivo para salvar o evento em sua máquina local.  
Se você não fornecer essa opção, ele AWS SAM CLI exibirá o conteúdo do evento de teste compartilhável para o seu console.

`--stack-name TEXT`  <a name="sam-cli-command-reference-remote-test-event-put-options-stack-name"></a>
O nome da CloudFormation pilha associada à função Lambda.  
Essa opção é necessária se você estiver fornecendo a ID lógica da função do Lambda como argumento.

## Exemplo
<a name="sam-cli-command-reference-remote-test-event-put-examples"></a>

Para obter um exemplo sobre como usar esse comando, consulte [Salvando eventos de teste compartilháveis](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 fornece informações de referência para o AWS Serverless Application Model comando Command Line Interface (AWS SAMCLI)`sam sync`.
+ Para uma introdução ao AWS SAMCLI, consulte [O que é o AWS SAMCLI?](what-is-sam-overview.md#what-is-sam-cli)
+ Para obter a documentação sobre o uso do AWS SAMCLI, consulte[AWS SAM CLI](using-sam-cli.md).

O comando `sam sync` sincroniza as alterações do aplicativo local com o Nuvem AWS.

## Usage
<a name="sam-cli-command-reference-sam-sync-usage"></a>

```
$ sam sync <options>
```

## Opções
<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>
Resolve caminhos relativos para o código-fonte da função ou da camada em relação a esse diretório. Use essa opção para alterar a forma como os caminhos relativos para as pastas de código-fonte são resolvidos. Por padrão, os caminhos relativos são resolvidos com relação à localização do AWS SAM modelo.  
Além dos recursos no aplicativo raiz ou na pilha que você está criando, essa opção também se aplica a aplicativos ou pilhas aninhados. Além disso, essa opção se aplica aos seguintes tipos e propriedades de recursos:  
+ Tipo de recursos: `AWS::Serverless::Function` Propriedade: `CodeUri`
+ Tipo de recurso: `AWS::Serverless::Function` Atributo do recurso: `Metadata` Entrada: `DockerContext`
+ Tipo de recursos: `AWS::Serverless::LayerVersion` Propriedade: `ContentUri`
+ Tipo de recursos: `AWS::Lambda::Function` Propriedade: `Code`
+ Tipo de recursos: `AWS::Lambda::LayerVersion` Propriedade: `Content`

`--build-image TEXT`  <a name="sam-cli-command-reference-sam-sync-options-build-image"></a>
O URI da [imagem do contêiner](serverless-image-repositories.md#serverless-image-repository-uris) que você deseja usar ao criar o aplicativo. Por padrão, AWS SAM usa o URI do repositório de imagens de contêiner do [Amazon Elastic Container Registry (Amazon ECR) Public](https://docs.aws.amazon.com/AmazonECR/latest/public/what-is-ecr.html). Especifique essa opção para usar uma imagem diferente.  
Você pode usar essa opção várias vezes em um único comando. Cada opção aceita uma sequência ou um par de chave/valor.  
+ **String** - Especifique o URI da imagem do contêiner que todos os recursos do seu aplicativo usarão. Veja um exemplo a seguir:

  ```
  $ sam sync --build-image amazon/aws-sam-cli-build-image-python3.8
  ```
+ **Par de valores-chave** - especifique o nome do recurso como chave e o URI da imagem do contêiner a ser usado com esse recurso como valor. Use esse formato para especificar um URI de imagem de contêiner diferente para cada recurso em seu aplicativo. Veja um exemplo a seguir:

  ```
  $ sam sync --build-image Function1=amazon/aws-sam-cli-build-image-python3.8
  ```
Essa opção só se aplica se a opção `--use-container` for especificada, caso contrário, ocorrerá um erro.

`--build-in-source | --no-build-in-source`  <a name="sam-cli-command-reference-sam-sync-options-build-in-source"></a>
Providencie `--build-in-source` para compilar seu projeto diretamente na pasta de origem.  
A opção `--build-in-source` oferece suporte aos seguintes runtimes e métodos de compilação:  
+ **Runtimes** — Qualquer runtime Node.js suportado pela opção `sam init --runtime`.
+ **Métodos de compilação** — `Makefile`, `esbuild`.
A opção `--build-in-source` não é compatível com as seguintes opções:  
+ `--use-container `
*Padrão*: `--no-build-in-source`

`--capabilities LIST`  <a name="sam-cli-command-reference-sam-sync-options-capabilities"></a>
Uma lista de recursos que você especifica para permitir CloudFormation a criação de determinadas pilhas. Alguns modelos de pilha podem incluir recursos que podem afetar as permissões em seu Conta da AWS. Por exemplo, criando novos usuários AWS Identity and Access Management (IAM). Especifique essa opção para substituir os valores padrão. Os valores válidos incluem:  
+ CAPACIDADE\$1IAM
+ CAPACIDADE\$1NAMED\$1IAM
+ POLÍTICA DE RECURSOS DE CAPACIDADE
+ CAPABILITY\$1AUTO\$1EXPAND
*Padrão*: `CAPABILITY_NAMED_IAM` e `CAPABILITY_AUTO_EXPAND`

`--code`  <a name="sam-cli-command-reference-sam-sync-options-code"></a>
Por padrão, AWS SAM sincroniza todos os recursos em seu aplicativo. Especifique essa opção para sincronizar somente recursos de código, que incluem o seguinte:  
+ `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 recursos de código, AWS SAM usa o AWS serviço APIs diretamente, em vez de implantar por meio AWS CloudFormation de. Para atualizar sua CloudFormation pilha, execute **sam sync --watch** ou**sam deploy**.

`--config-env TEXT`  <a name="sam-cli-command-reference-sam-sync-options-config-env"></a>
O nome do ambiente que especifica os valores de parâmetros padrão no arquivo de configuração a serem usados. O valor padrão é “padrão”. Para obter mais informações sobre esses arquivos de configuração, consulte [Arquivo de configuração do AWS SAM CLI](serverless-sam-cli-config.md).

`--config-file PATH`  <a name="sam-cli-command-reference-sam-sync-options-config-file"></a>
O caminho e o nome do arquivo de configuração contendo valores de parâmetros padrão a serem usados. O valor padrão é “`samconfig.toml`“ na raiz do diretório do projeto. Para obter mais informações sobre esses arquivos de configuração, consulte [Arquivo de configuração do AWS SAM CLI](serverless-sam-cli-config.md).

`--dependency-layer | --no-dependency-layer`  <a name="sam-cli-command-reference-sam-sync-options-dependency-layer"></a>
Especifica se as dependências de funções individuais devem ser separadas em outra camada para acelerar o processo de sincronização.  
*Padrão*: `--dependency-layer`

`--image-repository TEXT`  <a name="sam-cli-command-reference-sam-sync-options-image-repository"></a>
O nome do repositório do Amazon Elastic Container Registry (Amazon ECR) no qual esse comando faz upload da imagem da função. Necessário para funções declaradas com o tipo de pacote `Image`.

`--image-repositories TEXT`  <a name="sam-cli-command-reference-sam-sync-options-image-repositories"></a>
Um mapeamento de funções para o URI do repositório Amazon ECR. Funções de referência por meio de sua ID lógica. Veja um exemplo a seguir:  

```
$ sam sync --image-repositories Function1=123456789012.dkr.ecr.us-east-1.amazonaws.com/my-repo
```
Você pode especificar esta opção várias vezes em um único comando.

`--kms-key-id TEXT`  <a name="sam-cli-command-reference-sam-sync-options-kms-key-id"></a>
O ID de uma chave AWS Key Management Service (AWS KMS) usada para criptografar artefatos que estão em repouso no bucket do Amazon S3. Se você não especificar essa opção, AWS SAM use as chaves de criptografia gerenciadas pelo Amazon S3.

`--metadata`  <a name="sam-cli-command-reference-sam-sync-options-metadata"></a>
Um mapa de metadados para anexar a todos os artefatos que você faz referência no seu modelo.

`--notification-arns LIST`  <a name="sam-cli-command-reference-sam-sync-options-notification-arns"></a>
Uma lista dos ARNs tópicos CloudFormation do Amazon Simple Notification Service (Amazon SNS) associados à pilha.

`--no-use-container`  <a name="ref-sam-cli-sync-options-no-use-container"></a>
Uma opção que permite usar o kit de ferramentas do IDE para definir o comportamento padrão.

`--parameter-overrides`  <a name="sam-cli-command-reference-sam-sync-options-parameter-overrides"></a>
Uma string que contém substituições de CloudFormation parâmetros codificadas como pares de valores-chave. Use o mesmo formato do AWS Command Line Interface (AWS CLI). O formato da CLI do AWS SAMé uma palavra-chave explícita de chave e valor e cada substituição é separada por um espaço. Veja dois exemplos a seguir:  
+ `--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 o tipo de recurso a ser sincronizado. Para sincronizar vários recursos, você pode especificar essa opção várias vezes. Essa opção é compatível com a opção `--code`. O valor deve ser um dos recursos listados em `--code`. Por exemplo, .`--resource AWS::Serverless::Function --resource AWS::Serverless::LayerVersion`

`--resource-id TEXT`  <a name="sam-cli-command-reference-sam-sync-options-resource-id"></a>
Especifica o ID do recurso a ser sincronizado. Para sincronizar vários recursos, você pode especificar essa opção várias vezes. Essa opção é compatível com a opção `--code`. Por exemplo, .`--resource-id Function1 --resource-id Function2`

`--role-arn TEXT`  <a name="sam-cli-command-reference-sam-sync-options-role-arn"></a>
O Amazon Resource Name (ARN) de uma função do IAM que é CloudFormation assumida ao aplicar o conjunto de alterações.

`--s3-bucket TEXT`  <a name="sam-cli-command-reference-sam-sync-options-s3-bucket"></a>
O nome do bucket do Amazon Simple Storage Service (Amazon S3) no qual esse comando carrega seu modelo. CloudFormation Se seu modelo for maior que 51.200 bytes, a opção `--s3-bucket` ou a opção `--resolve-s3` serão obrigatórias. Se você especificar as opções `--s3-bucket` e `--resolve-s3`, ocorrerá um erro.

`--s3-prefix TEXT`  <a name="sam-cli-command-reference-sam-sync-options-s3-prefix"></a>
O prefixo adicionado aos nomes dos artefatos que você faz upload para o bucket do Amazon S3. O nome do prefixo é um nome de caminho (nome da pasta) para o bucket do Amazon S3. Isso se aplica somente às funções declaradas com o tipo de pacote `Zip`.

`--save-params`  <a name="sam-cli-command-reference-sam-sync-options-save-params"></a>
Salva os parâmetros que você fornece na linha de comando no arquivo AWS SAM de configuração.

`--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 ignorar a sincronização inicial da infraestrutura se ela não for necessária. Ele AWS SAMCLI comparará seu AWS SAM modelo local com o CloudFormation modelo implantado e executará uma implantação somente se uma alteração for detectada.  
Especifica `--no-skip-deploy-sync` a realização de uma CloudFormation implantação sempre que `sam sync` for executada.  
Para saber mais, consulte [Ignore a implantação inicial CloudFormation](using-sam-cli-sync.md#using-sam-cli-sync-options-skip-deploy-sync).  
*Padrão*: `--skip-deploy-sync`

`--stack-name TEXT`  <a name="sam-cli-command-reference-sam-sync-options-stack-name"></a>
O nome da CloudFormation pilha do seu aplicativo.  
Essa opção é obrigatória.

`--tags LIST`  <a name="sam-cli-command-reference-sam-sync-options-tags"></a>
Uma lista de tags a serem associadas à pilha criada ou atualizada. CloudFormation também propaga essas tags para recursos na pilha que as suportam.

`--template-file, --template, -t PATH`  <a name="sam-cli-command-reference-sam-sync-options-template-file"></a>
O caminho e o nome do arquivo em que seu AWS SAM modelo está localizado.  
Se você especificar essa opção, AWS SAM implantará somente o modelo e os recursos locais para os quais ele aponta.

`--use-container, -u`  <a name="sam-cli-command-reference-sam-sync-options-use-container"></a>
Se suas funções dependerem de pacotes que tenham dependências compiladas de forma nativa, use essa opção para criar sua função dentro de um contêiner AWS Lambda semelhante Docker a.  
Atualmente, essa opção não é compatível com o `--dependency-layer`. Se você usa `--use-container` com `--dependency-layer`, AWS SAMCLI informa e continua com `--no-dependency-layer`.

`--watch`  <a name="sam-cli-command-reference-sam-sync-options-watch"></a>
Inicia um processo que monitora o aplicativo local em busca de alterações e as sincroniza automaticamente com o. Nuvem AWS Por padrão, quando você especifica essa opção, AWS SAM sincroniza todos os recursos em seu aplicativo à medida que você os atualiza. Com essa opção, AWS SAM executa uma CloudFormation implantação inicial. Em seguida, AWS SAM usa o AWS serviço APIs para atualizar os recursos de código. AWS SAM usa CloudFormation para atualizar recursos de infraestrutura quando você atualiza seu AWS SAM modelo.

`--watch-exclude TEXT`  <a name="sam-cli-command-reference-sam-sync-options-watch-exclude"></a>
Exclui um arquivo ou pasta da observação de alterações no arquivo. Para usar essa opção, `--watch` deverá ser fornecido.  
Cada opção recebe um par de valores-chave:  
+ **Chave** — O ID lógico de uma função do Lambda em seu aplicativo.
+ **Valor** — O nome do arquivo ou pasta associado a ser excluído.
Quando você atualiza quaisquer arquivos ou pastas especificados com a `--watch-exclude` opção, AWS SAM CLI eles não iniciarão uma sincronização. No entanto, quando uma atualização de outros arquivos ou pastas inicia uma sincronização, esses arquivos ou pastas serão incluídos nessa sincronização.  
Você pode fornecer essa opção várias vezes em um único comando.

## Exemplos
<a name="sam-cli-command-reference-sam-sync-examples"></a>

Para obter exemplos sobre como usar esse comando, consulte [Opções para o comando sam sync](using-sam-cli-sync.md#using-sam-cli-sync-options).

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

Esta página fornece informações de referência para o AWS Serverless Application Model comando Command Line Interface (AWS SAMCLI)`sam traces`.

Para uma introdução ao AWS SAMCLI, consulte [O que é o AWS SAMCLI?](what-is-sam-overview.md#what-is-sam-cli)

O `sam traces` comando busca AWS X-Ray traços em seu Conta da AWS no Região da AWS.

## Usage
<a name="sam-cli-command-reference-sam-traces-usage"></a>

```
$ sam traces <options>
```

## Opções
<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>
O nome do ambiente que especifica os valores de parâmetros padrão no arquivo de configuração a serem usados. O valor padrão é “padrão”. Para obter mais informações sobre esses arquivos de configuração, consulte [Arquivo de configuração do AWS SAM CLI](serverless-sam-cli-config.md).

`--config-file PATH`  <a name="sam-cli-command-reference-sam-traces-options-config-file"></a>
O caminho e o nome do arquivo de configuração contendo valores de parâmetros padrão a serem usados. O valor padrão é “`samconfig.toml`“ na raiz do diretório do projeto. Para obter mais informações sobre esses arquivos de configuração, consulte [Arquivo de configuração do AWS SAM CLI](serverless-sam-cli-config.md).

`--end-time TEXT`  <a name="sam-cli-command-reference-sam-traces-options-end-time"></a>
Busca rastros até agora. A hora pode ser valores relativos, como '5 minutos atrás', 'amanhã' ou um carimbo de data/hora formatado como '2018-01-01 10:10:10'.

`--output TEXT`  <a name="sam-cli-command-reference-sam-traces-options-output"></a>
Especifica o formato de saída para logs. Para imprimir registros formatados, especifique`text`. Para imprimir os registros como JSON, especifique `json`.

`--save-params`  <a name="sam-cli-command-reference-sam-traces-options-save-params"></a>
Salve os parâmetros fornecidos na linha de comando no arquivo AWS SAM de configuração.

`--start-time TEXT`  <a name="sam-cli-command-reference-sam-traces-options-start-time"></a>
Busca traços a partir desse momento. A hora pode ser valores relativos, como '5 minutos atrás', 'ontem' ou um carimbo de data/hora formatado como '2018-01-01 10:10:10'. O padrão é '10 minutos atrás'.

`--tail`  <a name="sam-cli-command-reference-sam-traces-options-tail"></a>
Encerra a saída do rastreamento. Isso ignora o argumento de horário de término e continua exibindo rastreamentos à medida que eles se tornam disponíveis.

`--trace-id TEXT`  <a name="sam-cli-command-reference-sam-traces-options-trace-id"></a>
O identificador exclusivo para rastreamento com X-Ray.

## Exemplos
<a name="sam-cli-command-reference-sam-traces-examples"></a>

Execute o comando a seguir para buscar traços do X-Ray por ID.

```
$ sam traces --trace-id tracing-id-1 --trace-id tracing-id-2
```

Execute o comando a seguir para rastrear traços do X-Ray assim que estiverem disponíveis.

```
$ sam traces --tail
```

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

Esta página fornece informações de referência para o AWS Serverless Application Model comando Command Line Interface (AWS SAMCLI)`sam validate`.

Para uma introdução ao AWS SAMCLI, consulte [O que é o AWS SAMCLI?](what-is-sam-overview.md#what-is-sam-cli)

O `sam validate` comando verifica se um arquivo AWS SAM de modelo é válido.

## Usage
<a name="sam-cli-command-reference-sam-validate-usage"></a>

```
$ sam validate <options>
```

## Opções
<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>
O nome do ambiente que especifica os valores de parâmetros padrão no arquivo de configuração a serem usados. O valor padrão é “padrão”. Para obter mais informações sobre esses arquivos de configuração, consulte [Arquivo de configuração do AWS SAM CLI](serverless-sam-cli-config.md).

`--config-file PATH`  <a name="sam-cli-command-reference-sam-validate-options-config-file"></a>
O caminho e o nome do arquivo de configuração contendo valores de parâmetros padrão a serem usados. O valor padrão é “samconfig.toml” na raiz do diretório do projeto. Para obter mais informações sobre esses arquivos de configuração, consulte [Arquivo de configuração do AWS SAM CLI](serverless-sam-cli-config.md).

`--debug`  <a name="sam-cli-command-reference-sam-validate-options-debug"></a>
Ativa o registro de depuração para imprimir a mensagem de depuração gerada pelo AWS SAMCLI e exibir timestamps.

`--lint`  <a name="sam-cli-command-reference-sam-validate-options-lint"></a>
 Execute a validação de linting no modelo por meio de **cfn-lint**. Crie um arquivo de configuração `cfnlintrc` para especificar parâmetros adicionais. *Para obter mais informações, consulte [cfn-lint no repositório.](https://github.com/aws-cloudformation/cfn-lint)CloudFormation GitHub * 

`--profile TEXT`  <a name="sam-cli-command-reference-sam-validate-options-profile"></a>
O perfil específico do seu arquivo de credenciais que obtém as AWS credenciais.

`--region TEXT`  <a name="sam-cli-command-reference-sam-validate-options-region"></a>
A AWS região para a qual implantar. Por exemplo, us-east-1.

`--save-params`  <a name="sam-cli-command-reference-sam-validate-options-save-params"></a>
Salve os parâmetros fornecidos na linha de comando no arquivo AWS SAM de configuração.

`--template-file, --template, -t PATH`  <a name="sam-cli-command-reference-sam-validate-options-template-file"></a>
 O arquivo AWS SAM de modelo. O valor padrão é `template.[yaml|yml]`.   
 Se o modelo estiver no diretório de trabalho atual e tiver um nome `template.[yaml|yml|json]`, essa opção não será necessária.   
 Se você acabou de executar **sam build**, essa opção não é necessária. 

## Exemplo
<a name="sam-cli-command-reference-sam-validate-examples"></a>

Para obter um exemplo sobre como usar esse comando para validar um modelo, consulte [Validar arquivos AWS SAM de modelo](serverless-sam-cli-using-validate.md).

Para obter em exemplo sobre como usar esse comando com cfn-lint, consulte [Valide seus AWS SAM aplicativos com CloudFormation o Linter](validate-cfn-lint.md).