sam remote invoke - AWS Serverless Application Model
UsoArgumentosOpçõesExemplo

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á.

sam remote invoke

Esta página fornece informações de referência para a interface de linha de AWS Serverless Application Model comando (AWS SAM CLI) sam remote invoke comando.

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

Uso

$ sam remote invoke <arguments> <options>

Argumentos

ID do recurso

O ID do recurso suportado a ser invocado.

Esse argumento aceita os seguintes valores:

  • Nome do recurso da Amazon (ARN) — O ARN do recurso.

    dica

    Use sam list stack-outputs --stack-name <stack-name> para obter seus recursos. ARN

  • 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 AWS CloudFormation o.

    dica

    Use sam list resources --stack-name <stack-name> para obter a identificação física dos seus recursos.

Quando você fornece uma identificação física ARN ou física:

Se você fornecer uma ID física ARN ou física, não forneça um nome de pilha. Quando o nome da pilha é fornecido usando a --stack-name opção, ou quando o nome da pilha é definido em seu arquivo de configuração, o AWS SAM CLI processará automaticamente seu ID de recurso como um valor lógico de ID da AWS 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, eles AWS SAM CLI tentarão invocar automaticamente um recurso em sua AWS CloudFormation pilha usando a seguinte lógica:

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

    1. Lambda

    2. Step Functions

    3. Amazon SQS

    4. Kinesis Data Streams

  2. Se o tipo de recurso tiver um único recurso em sua pilha, o AWS SAM CLI vai invocá-lo. Se existirem vários recursos do tipo de recurso em sua pilha, o AWS SAM CLI retornará um erro.

A seguir estão exemplos do que AWS SAM CLI fará:

  • Pilha que contém duas funções Lambda e uma fila da SQS Amazon — A AWS SAM CLI localizará o tipo de recurso Lambda e o retorno e o 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 — The AWS SAM CLI localizará a função Lambda e a invocará, pois a pilha contém um único recurso Lambda.

  • Pilha que contém uma única SQS fila da Amazon e dois aplicativos Kinesis Data Streams — The AWS SAM CLI localizará a SQS fila da Amazon e a invocará, pois a pilha contém uma única fila da Amazon. SQS

Opções

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

Permita ou negue recursos beta.

--config-env TEXT

Especifique o ambiente a ser usado a partir do seu AWS SAM CLI arquivo de configuração.

Padrão: default

--config-file FILENAME

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.

Padrão: samconfig.toml na raiz do diretório do seu projeto.

--debug

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

O evento a ser enviado ao recurso de destino.

--event-file FILENAME

O caminho para um arquivo que contém o evento a ser enviado ao recurso de destino.

--help, -h

Mostra a mensagem de ajuda e sai.

--output [ text | json ]

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 JSON estrutura. A resposta contém a SDK saída completa.

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

adicionaisBoto3parâmetros que você pode passar para o recurso que está sendo chamado.

Amazon Kinesis Data Streams

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_RECORD.

AWS Lambda

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:

Amazon Simple Queue Service (AmazonSQS)

Os seguintes parâmetros adicionais podem ser usados para enviar uma mensagem para uma SQS fila da Amazon:

  • 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_MESSAGE.

AWS Step Functions

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_EXECUTION.

--profile TEXT

O perfil específico do seu arquivo de credenciais para obter as AWS credenciais.

--region TEXT

O Região da AWS do recurso. Por exemplo, us-east-1.

--stack-name TEXT

O nome da AWS CloudFormation pilha à qual o recurso pertence.

--test-event-name NAME

O nome do evento de teste compartilhável a ser passado para sua função do Lambda.

nota

Essa opção oferece suporte apenas às funções Lambda.

Exemplo

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 SAM CLI:

$ sam remote invoke--debug