aws:executeAwsApi - Appelle et exécute des opérations d'API AWS - AWS Systems Manager

aws:executeAwsApi - Appelle et exécute des opérations d'API AWS

Appelle et exécute des opérations d'API AWS. La plupart des opérations d'API sont prises en charge, bien que toutes n'aient pas été testées. Les opérations d'API de streaming telles que GetObject ne sont pas prises en charge. Si vous n’êtes pas sûr qu’une opération d’API que vous voulez utiliser est une opération de streaming, consultez la documentation Boto3 pour le service afin de déterminer si une API nécessite des entrées ou des sorties en streaming. Nous mettons régulièrement à jour la version Boto3 utilisée par cette action. Cependant, après la sortie d'une nouvelle version de Boto3, quelques semaines peuvent être nécessaires pour que les modifications soient prises en compte dans cette action. Chaque action aws:executeAwsApi peut être exécutée jusqu'à une durée maximale de 25 secondes. Pour plus d'exemples sur l'utilisation de cette action, veuillez consulter la rubrique Exemples supplémentaires de runbook.

Inputs

Les entrées sont définies par l'opération d'API que vous sélectionnez.

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

L'espace de noms Service AWS qui contient l'opération d'API que vous souhaitez exécuter. Vous pouvez accéder à la liste des espaces de noms Service AWS pris en charge dans la section Available services (Services disponibles) de AWS SDK for Python (Boto3). L'espace de noms se trouve dans la section Client . Par exemple, l'espace de noms pour Systems Manager est ssm. L'espace de noms pour Amazon Elastic Compute Cloud (Amazon EC2) est ec2.

Type : String

Obligatoire : oui

Api

Le nom de l'opération d'API que vous voulez exécuter. Vous pouvez afficher les opérations d'API (également appelées méthodes) en choisissant un service dans le panneau de navigation de gauche sur la page Services Reference (Référence des services) suivante. Sélectionnez une méthode dans la section Client pour le service que vous voulez appeler. Par exemple, toutes les opérations d'API (méthodes) pour Amazon Relational Database Service (Amazon RDS) sont répertoriées à la page suivante : Méthodes pour Amazon RDS.

Type : String

Obligatoire : oui

Entrées d'opérations d'API

Une ou plusieurs entrées d'opérations d'API. Vous pouvez afficher les entrées disponibles (également appelées paramètres) en choisissant un service dans le panneau de navigation de gauche sur la page Services Reference (Référence des services) suivante. Sélectionnez une méthode dans la section Client pour le service que vous voulez appeler. Par exemple, toutes les méthodes pour Amazon RDS sont répertoriées sur la page suivante : Méthodes Amazon RDS. Sélectionnez la méthode describe_db_instances et faites défiler la page vers le bas pour voir les paramètres disponibles, tels que DBInstanceIdentifier, Name et Values.

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"
}

Type : déterminé par l'opération d'API choisie

Obligatoire : oui

Outputs

Les sorties sont spécifiées par l'utilisateur en fonction de la réponse de l'opération d'API choisie.

Nom

Nom de la sortie.

Type : String

Obligatoire : oui

Selector

Chemin JSONPath vers un attribut dans l'objet de réponse. Vous pouvez afficher les objets de réponse en choisissant un service dans le panneau de navigation de gauche sur la page Services Reference (Référence des services) suivante. Sélectionnez une méthode dans la section Client pour le service que vous voulez appeler. Par exemple, toutes les méthodes pour Amazon RDS sont répertoriées sur la page suivante : Méthodes Amazon RDS. Sélectionnez la méthode describe_db_instances et faites défiler la page jusqu'à la section Response Structure (Structure d'une réponse). DBInstances est répertorié comme objet de réponse.

Type : Integer, Boolean, String, StringList, StringMap ou MapList

Obligatoire : oui

Type

Type de données de l'élément de réponse.

Type : variable

Obligatoire : oui