Cette page fournit une référence pour les actions AWS Athena disponibles dans le catalogue des actions d'automatisation des workflows. Utilisez ces actions pour exécuter des requêtes SQL sur Amazon Athena, vérifier leur statut d'exécution, et récupérer les résultats directement depuis une définition de workflow.
Prérequis
Pour les prérequis et la configuration des identifiants, consultez Configurer les identifiants AWS.
Démarrer l’exécution d’une requête
L’identifiant de l’action est aws.athena.startQueryExecution.
Exécute une requête SQL sur Amazon Athena et renvoie l'ID d'exécution de la requête. Cette action n'attend pas que la requête soit terminée : utilisez aws.athena.getQueryExecution pour vérifier le statut et aws.athena.getQueryResults pour récupérer les résultats.
Le tableau suivant décrit les champs d’entrée pour cette action.
Saisir | Type | Description | Exemple |
|---|---|---|---|
| Chaîne | Obligatoire. Région AWS du groupe de travail Athena. |
|
| Chaîne | Obligatoire. L’instruction SQL à exécuter. Longueur : 1 à 262 144 caractères. |
|
| Chaîne | Facultatif. ARN du rôle IAM à assumer pour les appels d'API AWS. |
|
| Chaîne | Facultatif. ID de clé d’accès AWS. Passer en tant que secret. |
|
| Chaîne | Facultatif. Clé d’accès secrète AWS. Passer en tant que secret. |
|
| Chaîne | Facultatif. Jeton de session temporaire pour l'authentification STS. Transmettez en tant que secret. |
|
| Chaîne | Facultatif. Base de données Athena sur laquelle exécuter la requête. Longueur : 1 à 255 caractères. |
|
| Chaîne | Facultatif. Nom du catalogue de données. Longueur : 1 à 256 caractères. |
|
| Chaîne | Facultatif. URI S3 pour les résultats de la requête. Requis si le groupe de travail n’a pas d’emplacement de sortie par défaut. |
|
| Chaîne | Facultatif. Chiffrement des fichiers de résultats. Valeurs autorisées : |
|
| Chaîne | Facultatif. ARN ou ID de la clé KMS. Requis lorsque |
|
| Chaîne | Facultatif. ID de compte AWS à 12 chiffres qui doit posséder le bucket S3 de sortie. |
|
| Chaîne | Facultatif. ACL prédéfinie appliquée aux objets de résultat. Valeur autorisée : |
|
| Chaîne | Facultatif. Groupe de travail Athena dans lequel exécuter la requête. La valeur par défaut est |
|
| Chaîne | Facultatif. Jeton d'idempotence pour les nouvelles tentatives. Longueur : 32 à 128 caractères. |
|
| List | Facultatif. Valeurs de paramètre pour une requête paramétrée, appliquées par ordre de position. Chaque valeur : de 1 à 1024 caractères. |
|
| Booléen | Facultatif. Si |
|
| Entier | Facultatif. Âge maximal en minutes des résultats pouvant être réutilisés. Plage : 0 à 10 080. |
|
| List | Facultatif. Sélecteurs JQ pour extraire des champs spécifiques de la sortie de l'action. |
|
Le tableau suivant décrit les champs de sortie pour cette action.
Sortir | Type | Exemple |
|---|---|---|
| Objet |
|
| Booléen |
|
| Chaîne |
|
Exemple
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: endObtenir une exécution de requête
L’identifiant de l’action est aws.athena.getQueryExecution.
Renvoie les détails et le statut actuel d'une seule exécution de requête Athena par son ID d'exécution. Utilisez ceci pour interroger une requête démarrée par aws.athena.startQueryExecution jusqu'à ce qu'elle atteigne un état terminal (SUCCEEDED, FAILED, ou CANCELLED).
Le tableau suivant décrit les champs d’entrée pour cette action.
Saisir | Type | Description | Exemple |
|---|---|---|---|
| Chaîne | Obligatoire. Région AWS du groupe de travail Athena. |
|
| Chaîne | Obligatoire. UUID de l'exécution de la requête renvoyé par |
|
| Chaîne | Facultatif. ARN du rôle IAM à assumer pour les appels d'API AWS. |
|
| Chaîne | Facultatif. ID de clé d’accès AWS. Passer en tant que secret. |
|
| Chaîne | Facultatif. Clé d’accès secrète AWS. Passer en tant que secret. |
|
| Chaîne | Facultatif. Jeton de session temporaire pour l'authentification STS. Transmettez en tant que secret. |
|
| List | Facultatif. Sélecteurs JQ pour extraire des champs spécifiques de la sortie de l'action. |
|
Le tableau suivant décrit les champs de sortie pour cette action.
Sortir | Type | Exemple |
|---|---|---|
| Objet | Contient |
| Booléen |
|
| Chaîne |
|
Exemple
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: endObtenir les résultats de la requête
L’identifiant de l’action est aws.athena.getQueryResults.
Renvoie les lignes et les métadonnées de colonne de l’exécution d’une requête Athena terminée. Les résultats sont paginés ; lorsque la réponse inclut un NextToken, transmettez-le en tant que nextToken lors de l’appel suivant pour récupérer la page suivante. La première ligne de ResultSet.Rows est toujours la ligne d’en-tête (noms des colonnes).
Le tableau suivant décrit les champs d’entrée pour cette action.
Saisir | Type | Description | Exemple |
|---|---|---|---|
| Chaîne | Obligatoire. Région AWS du groupe de travail Athena. |
|
| Chaîne | Obligatoire. UUID de l'exécution de requête terminée. Longueur : 1 à 128 caractères. |
|
| Chaîne | Facultatif. ARN du rôle IAM à assumer pour les appels d'API AWS. |
|
| Chaîne | Facultatif. ID de clé d’accès AWS. Passer en tant que secret. |
|
| Chaîne | Facultatif. Clé d’accès secrète AWS. Passer en tant que secret. |
|
| Chaîne | Facultatif. Jeton de session temporaire pour l'authentification STS. Transmettez en tant que secret. |
|
| Chaîne | Facultatif. Jeton de pagination provenant d'une réponse tronquée précédente. Omettez-le pour commencer à la 1re page. Longueur : 1 à 1024 caractères. |
|
| Entier | Facultatif. Nombre maximal de lignes à renvoyer par page. Plage : 1 à 1000. |
|
| Chaîne | Facultatif. Type de résultat à renvoyer. Valeurs autorisées : |
|
| List | Facultatif. Sélecteurs JQ pour extraire des champs spécifiques de la sortie de l'action. |
|
Le tableau suivant décrit les champs de sortie pour cette action.
Sortir | Type | Exemple |
|---|---|---|
| Objet | Contient |
| Booléen |
|
| Chaîne |
|
Exemple
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