aws:executeAwsApi: llamar y ejecutar operaciones de la API de AWS - AWS Systems Manager

aws:executeAwsApi: llamar y ejecutar operaciones de la API de AWS

Llama y ejecuta operaciones de la API de AWS. Se admiten la mayoría de las operaciones de la API, aunque no todas se han puesto a prueba. No se admiten las operaciones de la API de streaming, como GetObject. Si no estás seguro de si una operación de API que quiere usar es una operación de streaming, revise la documentación de Boto3 del servicio para determinar si una API requiere entradas o salidas de streaming. Actualizamos periódicamente la versión de Boto3 que utiliza esta acción. Sin embargo, tras el lanzamiento de una nueva versión de Boto3, los cambios pueden tardar varias semanas en reflejarse en esta acción. Cada acción aws:executeAwsApi puede ejecutarse hasta un máximo de 25 segundos. Para más ejemplos sobre cómo usar esta acción, consulte Ejemplos adicionales de manuales de procedimientos.

Entradas

Las entradas se definen con la operación de la API que elija.

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

El espacio de nombres del Servicio de AWS que contiene la operación de la API que desea ejecutar. Puede ver una lista de espacios de nombres de espacios de Servicio de AWS admitidos en la sección Available services (Servicios disponibles) de AWS SDK for Python (Boto3). El espacio de nombres se encuentra en la sección Cliente. Por ejemplo, el espacio de nombres para Systems Manager es ssm. El espacio de nombres para Amazon Elastic Compute Cloud (Amazon EC2) es ec2.

Tipo: cadena

Obligatorio: sí

API

El nombre de la operación de la API que desea ejecutar. Puede ver las operaciones de la API (también llamadas métodos) si elige un servicio en el panel de navegación ubicado a la izquierda, en la siguiente página: Services Reference. Elija un método en la sección Cliente para el servicio que desea invocar. Por ejemplo, todas las operaciones de la API (los métodos) para Amazon Relational Database Service (Amazon RDS) se indican en la siguiente página: métodos de Amazon RDS.

Tipo: cadena

Obligatorio: sí

Entradas de la operación de la API

Una o más entradas de la operación de la API. Puede ver las entradas disponibles (también llamadas parámetros) eligiendo un servicio en el panel de navegación izquierdo en la siguiente página de referencia de servicios. Elija un método en la sección Cliente para el servicio que desea invocar. Por ejemplo, todos los métodos para Amazon RDS se indican en la siguiente página: métodos de Amazon RDS. Elija el método describe_db_instances y desplácese hacia abajo para ver los parámetros disponibles, como, por ejemplo, DBInstanceIdentifier, Name y 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: se determina a partir de la operación de la API elegida

Obligatorio: sí

Salidas

El usuario especifica las salidas en función de la respuesta de la operación de la API elegida.

Nombre

Un nombre para la salida.

Tipo: cadena

Obligatorio: sí

Selector

El elemento JSONPath a un atributo específico en el objeto de respuesta. Puede ver los objetos de respuesta eligiendo un servicio en el panel de navegación izquierdo en la siguiente página de referencia de servicios. Elija un método en la sección Cliente para el servicio que desea invocar. Por ejemplo, todos los métodos para Amazon RDS se indican en la siguiente página: métodos de Amazon RDS. Elija el método describe_db_instances y desplácese hasta la sección Response Structure (Estructura de respuesta). DBInstances aparece como un objeto de respuesta.

Tipo: Entero, Booleano, Cadena, StringList, StringMap o MapList

Obligatorio: sí

Tipo

El tipo de datos del elemento de respuesta.

Tipo: varía

Obligatorio: sí