aws:executeAwsApi - Anrufen und Ausführen von AWS-API-Operationen - AWS Systems Manager

aws:executeAwsApi - Anrufen und Ausführen von AWS-API-Operationen

Ruft AWS-API-Operationen auf und führt sie aus. Die meisten API-Operationen werden unterstützt, es wurden jedoch nicht alle API-Operationen getestet. Streaming-API-Vorgänge, wie z. B. der GetObject-Vorgang werden nicht unterstützt. Wenn Sie sich nicht sicher sind, ob einen API-Vorgang, den Sie verwenden möchten, eine Streaming-Operation ist, lesen Sie die Boto3-Dokumentation für den Service, um festzustellen, ob eine API-Streaming-Eingaben oder -Ausgaben erfordert. Wir aktualisieren regelmäßig die von dieser Aktion verwendete Boto3-Version. Nach der Veröffentlichung einer neuen Boto3-Version kann es jedoch bis zu mehreren Wochen dauern, bis sich die Änderungen in dieser Aktion niederschlagen. Jede aws:executeAwsApi-Aktion kann bis zu einer maximalen Dauer von 25 Sekunden dauern. Weitere Beispiele zur Verwendung dieser Aktion finden Sie unter Weitere Runbook-Beispiele.

Eingaben

Eingaben werden von der ausgewählten API-Operation bestimmt.

YAML
action: aws:executeAwsApi
inputs:
  Service: The official namespace of the service
  Api: The API operation or method name
  API operation inputs or parameters: A value
outputs: # These are user-specified outputs
- Name: The name for a user-specified output key
  Selector: A response object specified by using jsonpath format
  Type: The data type
JSON
{
   "action":"aws:executeAwsApi",
   "inputs":{
      "Service":"The official namespace of the service",
      "Api":"The API operation or method name",
      "API operation inputs or parameters":"A value"
   },
   "outputs":[ These are user-specified outputs
      {
         "Name":"The name for a user-specified output key",
         "Selector":"A response object specified by using JSONPath format",
         "Type":"The data type"
      }
   ]
}
Service

Der AWS-Service-Namespace, der die API-Operation enthält, die Sie ausführen möchten. Sie finden eine Liste der unterstützten AWS-Service-Namespaces im Abschnitt Verfügbare Services des AWS SDK for Python (Boto3). Der Namespace befindet sich im Abschnitt Client . Beispielsweise lautet der Namespace für Systems Manager ssm. Der Namespace für Amazon Elastic Compute Cloud (Amazon EC2) ist ec2.

Typ: Zeichenfolge

Erforderlich: Ja

Api

Der Name der API-Operation, die Sie ausführen möchten. Sie können die API-Operationen (auch als Methoden bezeichnet) anzeigen, indem Sie einen Service in der linken Navigationsleiste auf der folgenden Service-Referenzen-Seite auswählen. Wählen Sie eine Methode im Abschnitt Client für den Service, den Sie aufrufen möchten. Beispielsweise werden alle API-Vorgänge (Methoden) für Amazon Relational Database Service (Amazon RDS) auf der folgenden Seite aufgelistet: Amazon RDS-Methoden.

Typ: Zeichenfolge

Erforderlich: Ja

API-Operation-Eingaben

Eine oder mehrere API-Eingaben. Sie können die verfügbaren Eingaben (auch als Parameter bezeichnet) anzeigen, indem Sie einen Service in der linken Navigationsleiste auf der folgenden Service-Referenzen-Seite auswählen. Wählen Sie eine Methode im Abschnitt Client für den Service, den Sie aufrufen möchten. Beispielsweise sind alle Methoden für Amazon RDS auf der folgenden Seite aufgeführt: Amazon RDS-Methoden. Wählen Sie die Methode describe_db_instances und scrollen Sie abwärts, um die verfügbaren Parameter zu sehen, wie etwa DBInstanceIdentifier, Name und Values (Werte).

YAML
inputs:
  Service: The official namespace of the service
  Api: The API operation name
  API input 1: A value
  API Input 2: A value
  API Input 3: A value
JSON
"inputs":{
      "Service":"The official namespace of the service",
      "Api":"The API operation name",
      "API input 1":"A value",
      "API Input 2":"A value",
      "API Input 3":"A value"
}

Typ: Abhängig von der gewählten API-Operation

Erforderlich: Ja

Outputs

Die Ausgaben werden vom Benutzer basierend auf der Antwort des ausgewählten API-Vorgangs angegeben.

Name

Ein Name für die Ausgabe.

Typ: Zeichenfolge

Erforderlich: Ja

Selector

Der JSONPath zu einem bestimmten Attribut im Antwortobjekt. Sie können die Antwortobjekte anzeigen indem Sie einen Service in der linken Navigationsleiste auf der folgenden Service-Referenzen-Seite auswählen. Wählen Sie eine Methode im Abschnitt Client für den Service, den Sie aufrufen möchten. Beispielsweise sind alle Methoden für Amazon RDS auf der folgenden Seite aufgeführt: Amazon RDS-Methoden. Wählen Sie die Methode describe_db_instances und scrollen Sie abwärts zum Abschnitt Response Structure (Antwortstruktur). DBInstances wird als Antwortobjekt aufgeführt.

Typ: Ganzzahl, Boolesch, Zeichenfolge, StringList, StringMap oder MapList

Erforderlich: Ja

Typ

Der Datentyp für das Antwortelement.

Typ: Unterschiedlich

Erforderlich: Ja