

• O AWS Systems Manager CloudWatch Dashboard não estará mais disponível a partir de 30 de abril de 2026. Os clientes podem continuar usando o console do Amazon CloudWatch para visualizar, criar e gerenciar os painéis do Amazon CloudWatch exatamente como fazem hoje. Para obter mais informações, consulte a [documentação do Amazon CloudWatch](https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/CloudWatch_Dashboards.html). 

# `aws:executeAwsApi`: chama e executa as operações de API do AWS
<a name="automation-action-executeAwsApi"></a>

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](https://docs.aws.amazon.com/AmazonS3/latest/API/RESTObjectGET.html), 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](https://boto3.amazonaws.com/v1/documentation/api/latest/reference/services/index.html) 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](automation-document-examples.md).

**nota**  
A ação `aws:executeAwsApi` suporta uma nova tentativa automática de controle de utilização. Para obter mais informações, consulte [Configurar a repetição automática para operações com controle de utilização](automation-throttling-retry.md).

**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](https://boto3.amazonaws.com/v1/documentation/api/latest/reference/services/index.html) (Serviços disponíveis) no AWS SDK para 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  
Exigido: 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](https://boto3.amazonaws.com/v1/documentation/api/latest/reference/services/index.html): 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](https://boto3.amazonaws.com/v1/documentation/api/latest/reference/services/rds.html) (Métodos do Amazon RDS).  
Tipo: String  
Exigido: 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](https://boto3.amazonaws.com/v1/documentation/api/latest/reference/services/index.html). 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](https://boto3.amazonaws.com/v1/documentation/api/latest/reference/services/rds.html). Escolha o método [describe\$1db\$1instances](https://boto3.amazonaws.com/v1/documentation/api/latest/reference/services/rds.html#RDS.Client.describe_db_instances) e role para baixo para ver os parâmetros disponíveis, como **DBInstanceIdentifier**, **Name (Nome)** e **Values (Valores)**.  

```
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
```

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

**Saídas**  
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  
Exigido: sim

Seletor  
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](https://boto3.amazonaws.com/v1/documentation/api/latest/reference/services/index.html). 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](https://boto3.amazonaws.com/v1/documentation/api/latest/reference/services/rds.html). Escolha o método [describe\$1db\$1instances](https://boto3.amazonaws.com/v1/documentation/api/latest/reference/services/rds.html#RDS.Client.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