aws:executeAwsApi: chiamata ed esecuzione di operazioni API di AWS - AWS Systems Manager

Le traduzioni sono generate tramite traduzione automatica. In caso di conflitto tra il contenuto di una traduzione e la versione originale in Inglese, quest'ultima prevarrà.

aws:executeAwsApi: chiamata ed esecuzione di operazioni API di AWS

Chiama ed esegue le operazioni API di AWS. È supportata la maggior parte delle operazioni API, sebbene non tutte le operazioni API siano state sottoposte a test. Operazioni dell'API di streaming, come ad esempio l'operazione GetObject, non sono supportate. Se non hai la certezza che un'operazione API che desideri utilizzare sia un'operazione di streaming, consulta la documentazione Boto3 del servizio per stabilire se un'API richiede input o output di streaming. Aggiorniamo regolarmente la versione Boto3 utilizzata da questa operazione. Tuttavia, dopo il rilascio di una nuova versione di Boto3, possono essere necessarie alcune settimane prima che le modifiche vengano applicate in questa operazione. Ogni operazione aws:executeAwsApi può durare al massimo 25 secondi. Per ulteriori esempi di utilizzo di questa operazione, consulta Ulteriori esempi di runbook.

Input

Gli input vengono definiti dall'operazione API selezionata.

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

Spazio dei nomi di Servizio AWS contenente l'operazione API che si desidera eseguire. Puoi visualizzare un elenco di spazi dei nomi di Servizio AWS supportati nella sezione Available services (Servizi disponibili) Servizi disponibili di AWS SDK for Python (Boto3). Lo spazio dei nomi è disponibile nella sezione Client. Ad esempio, lo spazio dei nomi per Systems Manager è ssm. Lo spazio dei nomi per Amazon Elastic Compute Cloud (Amazon EC2) è ec2.

Tipo: stringa

Campo obbligatorio: sì

Api

Nome dell'operazione API da eseguire. Puoi visualizzare le operazioni API (definite anche metodi) scegliendo un servizio nel pannello di navigazione a sinistra nella pagina Services Reference (Informazioni di riferimento relative ai servizi). Scegliere un metodo nella sezione Client del servizio che si desidera chiamare. Ad esempio, tutte le operazioni API (metodi) per Amazon Relational Database Service (Amazon RDS) sono elencate nella seguente pagina: Amazon RDS methods (Metodi Amazon RDS).

Tipo: stringa

Campo obbligatorio: sì

Input dell'operazione API

Uno o più input dell'operazione API. Puoi visualizzare gli input disponibili (definiti anche parametri) scegliendo un servizio nel pannello di navigazione a sinistra nella pagina Services Reference (Informazioni di riferimento relative ai servizi). Scegliere un metodo nella sezione Client del servizio che si desidera chiamare. Ad esempio, tutti i metodi per Amazon RDS sono elencati nella pagina: Amazon RDS methods (metodi di Amazon RDS). Scegliere il metodo describe_db_instances e scorrere verso il basso fino a visualizzare i parametri disponibili, ad esempio DBInstanceIdentifier, Name e 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"
}

Tipo: determinato dall'operazione API selezionata

Campo obbligatorio: sì

Output

Gli output sono specificati dall'utente in base alla risposta dell'operazione API scelta.

Nome

Nome dell'output.

Tipo: stringa

Campo obbligatorio: sì

Selector

Elemento JSONPath di un attributo specifico nell'oggetto di risposta. Puoi visualizzare gli oggetti di risposta scegliendo un servizio nel pannello di navigazione a sinistra nella pagina Services Reference (Informazioni di riferimento relative ai servizi). Scegliere un metodo nella sezione Client del servizio che si desidera chiamare. Ad esempio, tutti i metodi per Amazon RDS sono elencati nella pagina: Amazon RDS methods (metodi di Amazon RDS). Scegliere il metodo describe_db_instances e scorrere fino alla sezione Response Structure (Struttura risposta). DBInstances è presente nell'elenco come oggetto di risposta.

Tipo: Integer, Boolean, String, StringList, StringMap o MapList

Campo obbligatorio: sì

Tipo

Tipo di dati dell'elemento di risposta.

Tipo: vario

Campo obbligatorio: sì