sam remote invoke

Cette page fournit des informations de référence pour la AWS Serverless Application Model commande Command Line Interface (AWS SAMCLI)sam remote invoke.

• Pour une introduction à la AWS SAMCLI, voirQu'est-ce que c'est AWS SAMCLI ?.

• Pour obtenir de la documentation sur l'utilisation de la AWS SAMCLI sam remote invoke commande, consultezPrésentation des tests dans le cloud avec sam remote invoke.

La sam remote invoke commande invoque les ressources prises en charge dans le AWS Cloud.

Utilisation

$ sam remote invoke <arguments> <options>

Arguments

ID de ressource

L'ID de la ressource prise en charge à invoquer.

Cet argument accepte les valeurs suivantes :

• Amazon Resource Name (ARN) — L'ARN de la ressource.

  Astuce

  sam list stack-outputs --stack-name <stack-name>À utiliser pour obtenir l'ARN de vos ressources.

• ID logique — Identifiant logique de la ressource. Vous devez également fournir le nom de la AWS CloudFormation pile à l'aide de l'--stack-nameoption.

• Identifiant physique — Identifiant physique de la ressource. Cet ID est créé lorsque vous déployez une ressource à l'aide de AWS CloudFormation.

  Astuce

  sam list resources --stack-name <stack-name>À utiliser pour obtenir l'identifiant physique de vos ressources.

Lorsque vous fournissez un ARN ou un identifiant physique :

Si vous fournissez un ARN ou un identifiant physique, ne fournissez pas de nom de pile. Lorsque le nom de la pile est fourni à l'aide de l'--stack-nameoption, ou lorsque le nom de la pile est défini dans votre fichier de configuration, votre identifiant de ressource AWS SAM CLI sera automatiquement traité comme une valeur d'identifiant logique issue de la AWS CloudFormation pile.

Lorsque vous ne fournissez pas d'ID de ressource :

Si vous ne fournissez pas d'ID de ressource, mais que vous fournissez un nom de pile avec l'--stack-nameoption, la AWS SAM CLI essaiera d'invoquer automatiquement une ressource dans votre AWS CloudFormation pile en utilisant la logique suivante :

1. Ils AWS SAM CLI identifieront les types de ressources dans l'ordre suivant et passeront à l'étape suivante une fois que le type de ressource aura été trouvé dans votre pile :

   1. Lambda

   2. Step Functions

   3. Amazon SQS

   4. Kinesis Data Streams

2. Si le type de ressource ne contient qu'une seule ressource dans votre pile, il l' AWS SAM CLIinvoquera. Si plusieurs ressources du type de ressource existent dans votre pile, une erreur AWS SAM CLI sera renvoyée.

Voici des exemples de ce qu'ils AWS SAM CLI feront :

• Pile contenant deux fonctions Lambda et une file d'attente Amazon SQS : elle localisera AWS SAM CLI le type de ressource Lambda et renverra une erreur puisque la pile contient plusieurs fonctions Lambda.

• Pile contenant une fonction Lambda et deux applications Amazon Kinesis Data Streams : elle AWS SAM CLI localisera la fonction Lambda et l'invoquera, car la pile contient une seule ressource Lambda.

• Pile contenant une seule file d'attente Amazon SQS et deux applications Kinesis Data Streams. Elle AWS SAM CLI localisera la file d'attente Amazon SQS et l'invoquera, car la pile contient une seule file d'attente Amazon SQS.

Options

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

Autorisez ou refusez les fonctionnalités bêta.

--config-env TEXT

Spécifiez l'environnement à utiliser à partir de votre fichier de configuration CLI  AWS SAM.

Par défaut : default

--config-file FILENAME

Spécifiez le nom de votre compartiment et le nom du fichier de configuration.

Pour plus d'informations sur les fichiers de configuration, consultez Configuration de la CLI  AWS SAM.

Par défaut : samconfig.toml à la racine du répertoire de votre projet.

--debug

Activez la journalisation des débogues. Cela imprime les messages de débogage et les horodatages générés par la CLI  AWS SAM.

--event, -e TEXT

L'événement à envoyer à la ressource cible.

--event-file FILENAME

Le chemin d'accès à un fichier contenant l'événement à envoyer à la ressource cible.

--help, -h

Affichez le message d'aide, puis fermez.

--output [ text | json ]

Exportez les résultats de votre invocation dans un format de sortie spécifique.

json— Les métadonnées de la demande et la réponse aux ressources sont renvoyées dans la structure JSON. La réponse contient la sortie complète du SDK.

text— Les métadonnées de la demande sont renvoyées sous forme de texte. La réponse à la ressource est renvoyée dans le format de sortie de la ressource invoquée.

--parameter

Paramètres supplémentaires Boto3 que vous pouvez transmettre à la ressource invoquée.

Amazon Kinesis Data Streams

Les paramètres supplémentaires suivants peuvent être utilisés pour placer un enregistrement dans le flux de données Kinesis :

• ExplicitHashKey='string'

• PartitionKey='string'

• SequenceNumberForOrdering='string'

• StreamARN='string'

Pour une description de chaque paramètre, consultez Kinesis.client.PUT_RECORD.

AWS Lambda

Les paramètres supplémentaires suivants peuvent être utilisés pour appeler une ressource Lambda et recevoir une réponse mise en mémoire tampon :

• ClientContext='base64-encoded string'

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

• LogType='[ None | Tail ]'

• Qualifier='string'

Les paramètres supplémentaires suivants peuvent être utilisés pour appeler une ressource Lambda avec diffusion des réponses :

• ClientContext='base64-encoded string'

• InvocationType='[ DryRun | RequestResponse ]'

• LogType='[ None | Tail ]'

• Qualifier='string'

Pour obtenir une description de chaque paramètre, consultez les rubriques suivantes :

• Lambda avec réponse mise en mémoire tampon — Lambda.Client.Invoke

• Lambda avec diffusion de réponses — Lambda.Client.Invoke_With_Response_Stream

Amazon Simple Queue Service (Amazon SQS)

Les paramètres supplémentaires suivants peuvent être utilisés pour envoyer un message à une file d'attente Amazon SQS :

• DelaySeconds=integer

• MessageAttributes='json string'

• MessageDeduplicationId='string'

• MessageGroupId='string'

• MessageSystemAttributes='json string'

Pour une description de chaque paramètre, consultez SQS.Client.Send_Message.

AWS Step Functions

Les paramètres supplémentaires suivants peuvent être utilisés pour démarrer l'exécution d'une machine à états :

• name='string'

• traceHeader='string'

Pour une description de chaque paramètre, consultez SFN.Client.Start_Execution.

--profile TEXT

Le profil spécifique de votre fichier d'informations d'identification pour obtenir des AWS informations d'identification.

--region TEXT

Le Région AWS de la ressource. Par exemple, us-east-1.

--stack-name TEXT

Nom de la AWS CloudFormation pile à laquelle appartient la ressource.

--test-event-name NAME

Nom de l'événement de test partageable à transmettre à votre fonction Lambda.

Note

Cette option prend uniquement en charge les fonctions Lambda.