Esta página fornece uma referência para as ações do AWS Athena disponíveis no catálogo de ações de automação de fluxo de trabalho. Use estas ações para executar consultas SQL no Amazon Athena, verificar seu status de execução e recuperar resultados diretamente de uma definição de fluxo de trabalho.
Pré-requisitos
Para pré-requisitos e configuração de credenciais, consulte Configurar credenciais da AWS.
Iniciar a execução de uma consulta
O identificador da ação é aws.athena.startQueryExecution.
Executa uma consulta SQL no Amazon Athena e retorna o ID de execução da consulta. Esta ação não aguarda a conclusão da consulta — use aws.athena.getQueryExecution para verificar o status e aws.athena.getQueryResults para recuperar os resultados.
A tabela a seguir descreve os campos de entrada para esta ação.
Entrada | Tipo | Descrição | Exemplo |
|---|---|---|---|
| Corda | Obrigatório. Região da AWS do grupo de trabalho do Athena. |
|
| Corda | Obrigatório. A instrução SQL a ser executada. Comprimento: 1–262.144 caracteres. |
|
| Corda | Opcional. ARN da função do IAM a ser assumida para chamadas de API da AWS. |
|
| Corda | Opcional. ID da chave de acesso da AWS. Passe como um segredo. |
|
| Corda | Opcional. Chave de acesso secreta da AWS. Passe como um segredo. |
|
| Corda | Opcional. Token de sessão temporário para autenticação STS. Passe como um segredo. |
|
| Corda | Opcional. Banco de dados Athena no qual a consulta será executada. Comprimento: 1–255 caracteres. |
|
| Corda | Opcional. Nome do catálogo de dados. Comprimento: 1–256 caracteres. |
|
| Corda | Opcional. URI do S3 para os resultados da consulta. Obrigatório se o grupo de trabalho não tiver um local de saída padrão. |
|
| Corda | Opcional. Criptografia para os arquivos de resultados. Valores permitidos: |
|
| Corda | Opcional. ARN ou ID da chave do KMS. Obrigatório quando |
|
| Corda | Opcional. ID da conta da AWS de 12 dígitos que deve ser a proprietária do bucket do S3 de saída. |
|
| Corda | Opcional. ACL predefinida aplicada aos objetos de resultado. Valor permitido: |
|
| Corda | Opcional. Grupo de trabalho do Athena para executar a consulta. O padrão é |
|
| Corda | Opcional. Token de idempotência para novas tentativas. Comprimento: 32–128 caracteres. |
|
| Lista | Opcional. Valores de parâmetro para uma consulta parametrizada, aplicados em ordem posicional. Cada valor: 1–1.024 caracteres. |
|
| Boleano | Opcional. Se |
|
| Inteiro | Opcional. Idade máxima em minutos dos resultados que podem ser reutilizados. Intervalo: 0–10.080. |
|
| Lista | Opcional. Seletores JQ para extrair campos específicos da saída da ação. |
|
A tabela a seguir descreve os campos de saída para esta ação.
Saída | Tipo | Exemplo |
|---|---|---|
| Objeto |
|
| Boleano |
|
| Corda |
|
Exemplo
name: start-athena-querydescription: Run a SQL query against Athenasteps: - name: startQuery type: action action: aws.athena.startQueryExecution version: '1' inputs: awsRoleArn: ${{ :secrets:awsRoleArn }} region: us-east-2 queryString: "SELECT * FROM my_table LIMIT 10" database: "my-database" catalog: "AwsDataCatalog" outputLocation: "s3://my-athena-results-bucket/path/" workGroup: "primary" selectors: - name: queryExecutionId expression: ".response.QueryExecutionId" next: endObter a execução de uma consulta
O identificador da ação é aws.athena.getQueryExecution.
Retorna os detalhes e o status atual da execução de uma única consulta do Athena pelo seu ID de execução. Isso pode ser usado para sondar uma consulta iniciada por aws.athena.startQueryExecution até que ela atinja um estado terminal (SUCCEEDED, FAILED ou CANCELLED).
A tabela a seguir descreve os campos de entrada para esta ação.
Entrada | Tipo | Descrição | Exemplo |
|---|---|---|---|
| Corda | Obrigatório. Região da AWS do grupo de trabalho do Athena. |
|
| Corda | Obrigatório. UUID da execução da consulta retornado por |
|
| Corda | Opcional. ARN da função do IAM a ser assumida para chamadas de API da AWS. |
|
| Corda | Opcional. ID da chave de acesso da AWS. Passe como um segredo. |
|
| Corda | Opcional. Chave de acesso secreta da AWS. Passe como um segredo. |
|
| Corda | Opcional. Token de sessão temporário para autenticação STS. Passe como um segredo. |
|
| Lista | Opcional. Seletores JQ para extrair campos específicos da saída da ação. |
|
A tabela a seguir descreve os campos de saída para esta ação.
Saída | Tipo | Exemplo |
|---|---|---|
| Objeto | Contém |
| Boleano |
|
| Corda |
|
Exemplo
name: get-athena-query-executiondescription: Check the status of an Athena query executionsteps: - name: getExecution type: action action: aws.athena.getQueryExecution version: '1' inputs: awsRoleArn: ${{ :secrets:awsRoleArn }} region: us-east-2 queryExecutionId: "ef4a125f-9e79-466d-bae5-d6d36536fbee" selectors: - name: state expression: ".response.QueryExecution.Status.State" - name: stateChangeReason expression: ".response.QueryExecution.Status.StateChangeReason" next: endObter resultados da consulta
O identificador da ação é aws.athena.getQueryResults.
Retorna as linhas e os metadados de coluna de uma execução de consulta concluída do Athena. Os resultados são paginados — quando a resposta incluir um NextToken, passe-o como nextToken na próxima chamada para recuperar a página seguinte. A primeira linha de ResultSet.Rows é sempre a linha de cabeçalho (nomes das colunas).
A tabela a seguir descreve os campos de entrada para esta ação.
Entrada | Tipo | Descrição | Exemplo |
|---|---|---|---|
| Corda | Obrigatório. Região da AWS do grupo de trabalho do Athena. |
|
| Corda | Obrigatório. UUID da execução da consulta concluída. Comprimento: 1–128 caracteres. |
|
| Corda | Opcional. ARN da função do IAM a ser assumida para chamadas de API da AWS. |
|
| Corda | Opcional. ID da chave de acesso da AWS. Passe como um segredo. |
|
| Corda | Opcional. Chave de acesso secreta da AWS. Passe como um segredo. |
|
| Corda | Opcional. Token de sessão temporário para autenticação STS. Passe como um segredo. |
|
| Corda | Opcional. Token de paginação de uma resposta truncada anterior. Omita para iniciar a partir da primeira página. Comprimento: 1–1.024 caracteres. |
|
| Inteiro | Opcional. Número máximo de linhas a serem retornadas por página. Intervalo: 1–1.000. |
|
| Corda | Opcional. Tipo de resultado a retornar. Valores permitidos: |
|
| Lista | Opcional. Seletores JQ para extrair campos específicos da saída da ação. |
|
A tabela a seguir descreve os campos de saída para esta ação.
Saída | Tipo | Exemplo |
|---|---|---|
| Objeto | Contém |
| Boleano |
|
| Corda |
|
Exemplo
name: get-athena-query-resultsdescription: Fetch results of a completed Athena querysteps: - name: getResults type: action action: aws.athena.getQueryResults version: '1' inputs: awsRoleArn: ${{ :secrets:awsRoleArn }} region: us-east-2 queryExecutionId: "8d0105c1-30b5-4b8f-a23e-a1b60047c43f" maxResults: 100 selectors: - name: rows expression: ".response.ResultSet.Rows" - name: columnInfo expression: ".response.ResultSet.ResultSetMetadata.ColumnInfo" - name: nextToken expression: ".response.NextToken" next: end