sam remote invoke - AWS Serverless Application Model
UsoArgumentosOpciones

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

sam remote invoke

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

El comando sam remote invoke invoca los recursos compatibles en Nube de AWS.

Uso

$ sam remote invoke <arguments> <options>

Argumentos

ID de recurso

El ID del recurso admitido a invocar.

Este argumento acepta los valores siguientes:

  • El Nombre de recurso de Amazon (ARN): el ARN del recurso.

    sugerencia

    Use sam list stack-outputs --stack-name <stack-name> para obtener el ARN de sus recursos.

  • ID lógico: el ID lógico del recurso. También debe proporcionar el nombre de la AWS CloudFormation pila mediante la --stack-name opción.

  • ID físico: el ID físico del recurso. Este ID se crea al implementar un recurso utilizando AWS CloudFormation.

    sugerencia

    Use sam list resources --stack-name <stack-name> para obtener el ID físico de sus recursos.

Cuando proporciona un ARN o una identificación física:

Si proporciona un ARN o un ID físico, no proporcione un nombre de pila. Cuando el nombre de la pila se proporciona mediante la --stack-name opción, o cuando el nombre de la pila se define en el archivo de configuración, AWS SAM CLI procesará automáticamente el ID de recurso como un valor de ID lógico de la AWS CloudFormation pila.

Cuando no proporciona un ID de recurso:

Si no proporciona un ID de recurso, pero sí proporciona un nombre de pila con la --stack-name opción, la AWS SAM CLI intentará invocar automáticamente un recurso de la AWS CloudFormation pila mediante la siguiente lógica:

  1. AWS SAM CLIIdentificará los tipos de recursos en el siguiente orden y pasará al siguiente paso una vez que el tipo de recurso se encuentre en la pila:

    1. Lambda

    2. Step Functions

    3. Amazon SQS

    4. Kinesis Data Streams

  2. Si el tipo de recurso tiene un único recurso en tu pila, lo AWS SAM CLI invocará. Si hay varios recursos del mismo tipo en tu pila, se AWS SAM CLI mostrará un error.

Los siguientes son ejemplos de lo que AWS SAM CLI hará:

  • Pila que contiene dos funciones de Lambda y una cola de Amazon SQS: AWS SAM CLI localizará el tipo de recurso de Lambda y devolverá un error, ya que la pila contiene más de una función de Lambda.

  • Pila que contiene una función Lambda y dos aplicaciones de Amazon Kinesis Data Streams: AWS SAM CLI localizará la función Lambda y la invocará, ya que la pila contiene un único recurso de Lambda.

  • Pila que contiene una sola cola de Amazon SQS y dos aplicaciones de Kinesis Data Streams: localizará la cola de Amazon SQS y AWS SAM CLI la invocará, ya que la pila contiene una sola cola de Amazon SQS.

Opciones

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

Permitir o denegar las características beta.

--config-env TEXT

Especifique el entorno que se va a utilizar en el archivo de configuración de la CLI de AWS SAM.

Valor predeterminado: default

--config-file FILENAME

Especifique la ruta y el nombre del archivo de configuración.

Para obtener más información sobre los archivos de configuración, consulte Configuración de la AWS SAM de CLI.

Predeterminado: samconfig.toml en la raíz del directorio del proyecto.

--debug

Activar el registro de depuración. Esto imprime los mensajes de depuración y las marcas temporales generados por AWS SAMCLI.

--event, -e TEXT

El evento que se va a enviar al recurso de destino.

--event-file FILENAME

La ruta a un archivo que contiene el evento que se va a enviar al recurso de destino.

--help, -h

Muestre el mensaje de ayuda y salga.

--output [ text | json ]

Genera los resultados de la invocación en un formato de salida específico.

json: los metadatos de la solicitud y la respuesta del recurso se devuelven en una estructura JSON. La respuesta contiene el resultado completo del SDK.

text: los metadatos de la solicitud se devuelven en una estructura de texto. La respuesta del recurso se devuelve en el formato de salida del recurso invocado.

--parameter

Parámetros Boto3 adicionales que puede pasar al recurso que se está invocando.

Amazon Kinesis Data Streams

Los parámetros adicionales siguientes se pueden utilizar para incluir un registro en el flujo de datos de Kinesis:

  • ExplicitHashKey='string'

  • PartitionKey='string'

  • SequenceNumberForOrdering='string'

  • StreamARN='string'

Para obtener una descripción de cada parámetro, consulte Kinesis.Client.put_record.

AWS Lambda

Los siguientes parámetros adicionales se pueden usar para invocar un recurso de Lambda y recibir una respuesta almacenada en búfer:

  • ClientContext='base64-encoded string'

  • InvocationType='[ DryRun | Event | RequestResponse ]'

  • LogType='[ None | Tail ]'

  • Qualifier='string'

Los siguientes parámetros adicionales se pueden usar para invocar un recurso de Lambda con transmisión de respuesta:

  • ClientContext='base64-encoded string'

  • InvocationType='[ DryRun | RequestResponse ]'

  • LogType='[ None | Tail ]'

  • Qualifier='string'

Para ver una descripción de los parámetros, consulte lo siguiente:

Amazon Simple Queue Service (Amazon SQS)

Los parámetros adicionales siguientes se pueden utilizar para enviar un mensaje a una cola de Amazon SQS:

  • DelaySeconds=integer

  • MessageAttributes='json string'

  • MessageDeduplicationId='string'

  • MessageGroupId='string'

  • MessageSystemAttributes='json string'

Para obtener una descripción de cada parámetro, consulte SQS.Client.send_message.

AWS Step Functions

Los parámetros adicionales siguientes se pueden utilizar para iniciar la ejecución de una máquina de estado:

  • name='string'

  • traceHeader='string'

Para obtener una descripción de cada parámetro, consulte SFN.Client.start_execution.

--profile TEXT

El perfil específico de su archivo de credenciales para obtener AWS las credenciales.

--region TEXT

El Región de AWS del recurso. Por ejemplo, us-east-1.

--stack-name TEXT

El nombre de la AWS CloudFormation pila a la que pertenece el recurso.

--test-event-name NAME

El nombre del evento de prueba compartible y pasarlo a la función de Lambda.

nota

Esta opción solo admite funciones de Lambda.