sam remote invoke - AWS Serverless Application Model
VerwendungArgumenteOptionenBeispiel

Die vorliegende Übersetzung wurde maschinell erstellt. Im Falle eines Konflikts oder eines Widerspruchs zwischen dieser übersetzten Fassung und der englischen Fassung (einschließlich infolge von Verzögerungen bei der Übersetzung) ist die englische Fassung maßgeblich.

sam remote invoke

Diese Seite enthält Referenzinformationen für die AWS Serverless Application Model Befehlszeilenschnittstelle (AWS SAM CLIsam remote invokeBefehl.

Der sam remote invoke Befehl ruft unterstützte Ressourcen in der AWS Cloud auf.

Verwendung

$ sam remote invoke <arguments> <options>

Argumente

Ressourcen-ID

Die ID der unterstützten Ressource, die aufgerufen werden soll.

Dieses Argument akzeptiert die folgenden Werte:

  • Amazon Resource Name (ARN) — Der ARN der Ressource.

    Tipp

    Verwenden Siesam list stack-outputs --stack-name <stack-name>, um den ARN Ihrer Ressourcen zu erhalten.

  • Logische ID — Die logische ID der Ressource. Sie müssen auch den AWS CloudFormation Stack-Namen mithilfe der --stack-name Option angeben.

  • Physikalische ID — Die physische ID der Ressource. Diese ID wird erstellt, wenn Sie eine Ressource mithilfe von bereitstellen AWS CloudFormation.

    Tipp

    Verwenden Siesam list resources --stack-name <stack-name>, um die physische ID Ihrer Ressourcen abzurufen.

Wenn Sie einen ARN oder eine physische ID angeben:

Wenn Sie einen ARN oder eine physische ID angeben, geben Sie keinen Stack-Namen an. Wenn der Stack-Name mithilfe der --stack-name Option bereitgestellt wird oder wenn der Stack-Name in Ihrer Konfigurationsdatei definiert ist, AWS SAM CLI verarbeitet Ihre Ressourcen-ID automatisch als logischen ID-Wert aus dem AWS CloudFormation Stack.

Wenn Sie keine Ressourcen-ID angeben:

Wenn Sie keine Ressourcen-ID angeben, aber mit der --stack-name Option einen Stacknamen angeben, versucht die AWS SAM CLI, mithilfe der folgenden Logik automatisch eine Ressource in Ihrem AWS CloudFormation Stack aufzurufen:

  1. Die AWS SAM CLI identifiziert Ressourcentypen in der folgenden Reihenfolge und fährt mit dem nächsten Schritt fort, sobald der Ressourcentyp in Ihrem Stack gefunden wurde:

    1. Lambda

    2. Step Functions

    3. Amazon SQS

    4. Kinesis Data Streams

  2. Wenn der Ressourcentyp eine einzelne Ressource in Ihrem Stapel hat, AWS SAM CLI wird es aufrufen. Wenn mehrere Ressourcen des Ressourcentyps in Ihrem Stack existieren, AWS SAM CLI gibt einen Fehler zurück.

Im Folgenden finden Sie Beispiele dafür, was AWS SAM CLI wird reichen:

  • Stack, der zwei Lambda-Funktionen und eine Amazon SQS SQS-Warteschlange enthält — The AWS SAM CLI findet den Lambda-Ressourcentyp und gibt Fehler zurück, da der Stack mehr als eine Lambda-Funktion enthält.

  • Stack, der eine Lambda-Funktion und zwei Amazon Kinesis Data Streams Streams-Anwendungen enthält — Der AWS SAM CLI findet die Lambda-Funktion und ruft sie auf, da der Stack eine einzige Lambda-Ressource enthält.

  • Stack, der eine einzelne Amazon SQS SQS-Warteschlange und zwei Kinesis Data Streams Streams-Anwendungen enthält — Der AWS SAM CLI sucht die Amazon SQS SQS-Warteschlange und ruft sie auf, da der Stack eine einzige Amazon SQS SQS-Warteschlange enthält.

Optionen

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

Betafunktionen zulassen oder ablehnen.

--config-env TEXT

Geben Sie die Umgebung an, die Sie von Ihrem aus verwenden möchten AWS SAM CLI Konfigurationsdatei.

Standardwert: default

--config-file FILENAME

Geben Sie den Pfad und den Dateinamen Ihrer Konfigurationsdatei an.

Weitere Informationen zu Konfigurationsdateien finden Sie unter Konfiguration der AWS SAM CLI.

Standard: samconfig.toml im Stammverzeichnis Ihres Projektverzeichnisses.

--debug

Aktivieren Sie die Debug-Protokollierung. Dadurch werden Debug-Meldungen und Zeitstempel gedruckt, die von AWS SAM CLI.

--event, -e TEXT

Das Ereignis, das an die Zielressource gesendet werden soll.

--event-file FILENAME

Der Pfad zu einer Datei, die das Ereignis enthält, das an die Zielressource gesendet werden soll.

--help, -h

Zeigt die Hilfemeldung an und beendet den Vorgang.

--output [ text | json ]

Geben Sie die Ergebnisse Ihres Aufrufs in einem bestimmten Ausgabeformat aus.

json— Die Anforderungsmetadaten und die Ressourcenantwort werden in der JSON-Struktur zurückgegeben. Die Antwort enthält die vollständige SDK-Ausgabe.

text— Die Metadaten der Anfrage werden in Textstruktur zurückgegeben. Die Ressourcenantwort wird im Ausgabeformat der aufgerufenen Ressource zurückgegeben.

--parameter

Zusätzliches Boto3Parameter, die Sie an die aufgerufene Ressource übergeben können.

Amazon Kinesis Data Streams

Die folgenden zusätzlichen Parameter können verwendet werden, um einen Datensatz in den Kinesis-Datenstrom aufzunehmen:

  • ExplicitHashKey='string'

  • PartitionKey='string'

  • SequenceNumberForOrdering='string'

  • StreamARN='string'

Eine Beschreibung der einzelnen Parameter finden Sie unter kinesis.client.PUT_RECORD.

AWS Lambda

Die folgenden zusätzlichen Parameter können verwendet werden, um eine Lambda-Ressource aufzurufen und eine gepufferte Antwort zu erhalten:

  • ClientContext='base64-encoded string'

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

  • LogType='[ None | Tail ]'

  • Qualifier='string'

Die folgenden zusätzlichen Parameter können verwendet werden, um eine Lambda-Ressource mit Antwortstreaming aufzurufen:

  • ClientContext='base64-encoded string'

  • InvocationType='[ DryRun | RequestResponse ]'

  • LogType='[ None | Tail ]'

  • Qualifier='string'

Eine Beschreibung der einzelnen Parameter finden Sie im Folgenden:

Amazon-Simple-Queue-Service (Amazon SQS)

Die folgenden zusätzlichen Parameter können verwendet werden, um eine Nachricht an eine Amazon SQS SQS-Warteschlange zu senden:

  • DelaySeconds=integer

  • MessageAttributes='json string'

  • MessageDeduplicationId='string'

  • MessageGroupId='string'

  • MessageSystemAttributes='json string'

Eine Beschreibung der einzelnen Parameter finden Sie unter sqs.client.send_Message.

AWS Step Functions

Die folgenden zusätzlichen Parameter können verwendet werden, um die Ausführung einer Zustandsmaschine zu starten:

  • name='string'

  • traceHeader='string'

Eine Beschreibung der einzelnen Parameter finden Sie unter SFN.Client.Start_Execution.

--profile TEXT

Das spezifische Profil aus Ihrer Anmeldeinformationsdatei zum Abrufen der Anmeldeinformationen. AWS

--region TEXT

Das AWS-Region der Ressource. Beispiel, us-east-1.

--stack-name TEXT

Der Name des AWS CloudFormation Stacks, zu dem die Ressource gehört.

--test-event-name NAME

Der Name des gemeinsam nutzbaren Testereignisses, das an Ihre Lambda-Funktion übergeben werden soll.

Anmerkung

Diese Option unterstützt nur Lambda-Funktionen.

Beispiel

Das folgende Beispiel ruft unterstützte Ressourcen in der AWS Cloud auf und aktiviert die Debug-Protokollierung, bei der Debug-Nachrichten und Zeitstempel gedruckt werden, die von AWS SAM CLI:

$ sam remote invoke--debug