aws:executeAwsApi: chama e executa as operações de API do AWS - AWS Systems Manager

aws:executeAwsApi: chama e executa as operações de API do AWS

Chama e executa as operações de API da AWS. A maioria das operações de API são suportadas, embora nem todas elas tenham sido testadas. Operações de API por transmissão, como a operação Get Object, não são compatíveis. Se você não tiver certeza se uma operação de API que deseja usar é uma operação de transmissão, revise a documentação do Boto3 do serviço para determinar se uma API requer entradas ou saídas de transmissão. Atualizamos regularmente a versão do Boto3 que essa ação usa. No entanto, após o lançamento de uma nova versão do Boto3, poderá levar algumas semanas para que as alterações sejam refletidas na ação. A execução de cada ação aws:executeAwsApi pode durar, no máximo, 25 segundos. Para obter mais exemplos de como usar essa ação, consulte Exemplos adicionais de runbook.

Entradas

As entradas são definidas pela operação de API que você escolher.

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"
      }
   ]
}
Serviço

O namespace do AWS service (Serviço da AWS) que contém a operação de API que você deseja executar. Você pode visualizar uma lista de namespaces de AWS service (Serviço da AWS) compatíveis em Available services (Serviços disponíveis) no AWS SDK for Python (Boto3). O namespace pode ser encontrado na seção Cliente. Por exemplo, o namespace para o Systems Manager é ssm. O namespace do Amazon Elastic Compute Cloud (Amazon EC2) é ec2.

Tipo: string

Obrigatório: Sim

API

O nome da operação de API que você deseja executar. Você pode visualizar as operações de API (também chamadas de métodos), escolhendo um serviço na navegação à esquerda na seguinte página de Referência de serviços: Escolha um método na seção Client (Cliente) para o serviço que você deseja invocar. Por exemplo, todas as operações de API (métodos) do Amazon Relational Database Service (Amazon RDS) estão listadas na seguinte página: Amazon RDS methods (Métodos do Amazon RDS).

Tipo: string

Obrigatório: Sim

Entradas de operação da API

Uma ou mais entradas de operação da API. Você pode visualizar as entradas disponíveis (também chamadas de parâmetros), escolhendo um serviço na navegação à esquerda na seguinte página de Referência de serviços. Escolha um método na seção Client (Cliente) para o serviço que você deseja invocar. Por exemplo, todos os métodos de API estão listados na página a seguir: Métodos do Amazon RDS. Escolha o método describe_db_instances e role para baixo para ver os parâmetros disponíveis, como DBInstanceIdentifier, Name (Nome) e Values (Valores).

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: determinado pela ação de API escolhida

Obrigatório: Sim

Outputs

As saídas são especificadas pelo usuário com base na resposta da operação da API escolhida.

Nome

Um nome para a saída.

Tipo: string

Obrigatório: Sim

Selector

O JSONPath para um determinado atributo no objeto de resposta. Você pode visualizar os objetos de resposta escolhendo um serviço na navegação à esquerda na seguinte página de Referência de serviços. Escolha um método na seção Client (Cliente) para o serviço que você deseja invocar. Por exemplo, todos os métodos de API estão listados na página a seguir: Métodos do Amazon RDS. Escolha o método describe_db_instances e role para baixo até a seção Response Structure (Estrutura de resposta). DBInstances é listado como um objeto de resposta.

Tipo: inteiro, booliano, String, StringList, StringMap ou MapList

Obrigatório: Sim

Tipo

O tipo de dados para o elemento de resposta.

Tipo: Varia

Obrigatório: Sim