이 페이지는 워크플로우 자동화 액션 카탈로그에서 사용할 수 있는 AWS Athena 액션에 대한 참조를 제공합니다. 이러한 액션을 사용하여 Amazon Athena를 대상으로 SQL 쿼리를 실행하고, 실행 상태를 확인하며, 워크플로우 정의에서 직접 결과를 가져오십시오.
전제 조건
사전 요구 사항 및 자격 증명 설정에 대해서는 AWS 자격 증명 설정을 참조하십시오.
쿼리 실행을 시작합니다.
작업 식별자는 aws.athena.startQueryExecution입니다.
Amazon Athena를 대상으로 SQL 쿼리를 실행하고 쿼리 실행 ID를 반환합니다. 이 작업은 쿼리가 완료될 때까지 기다리지 않습니다 — 상태를 폴링하려면 aws.athena.getQueryExecution을(를) 사용하고, 결과를 가져오려면 aws.athena.getQueryResults을(를) 사용하십시오.
다음 표에서는 이 작업의 입력 필드를 설명합니다.
입력 | 유형 | 설명 | 예시 |
|---|---|---|---|
| 문자열 | 필수 항목입니다. Athena 작업 그룹의 AWS 리전입니다. |
|
| 문자열 | 필수 항목입니다. 실행할 SQL 문입니다. 길이: 1~262,144자. |
|
| 문자열 | 선택 사항. AWS API 호출을 위해 수임할 IAM 역할 ARN입니다. |
|
| 문자열 | 선택 사항. AWS 액세스 키 ID입니다. 시크릿으로 전달하십시오. |
|
| 문자열 | 선택 사항. AWS 비밀 액세스 키입니다. 시크릿으로 전달하십시오. |
|
| 문자열 | 선택 사항. STS 인증을 위한 임시 세션 토큰. 시크릿으로 전달하십시오. |
|
| 문자열 | 선택 항목입니다. 쿼리를 실행할 Athena 데이터베이스입니다. 길이: 1~255자입니다. |
|
| 문자열 | 선택 항목입니다. 데이터 카탈로그 이름입니다. 길이: 1~256자. |
|
| 문자열 | 선택 항목입니다. 쿼리 결과에 대한 S3 URI입니다. 작업 그룹에 기본 출력 위치가 없는 경우 필수입니다. |
|
| 문자열 | 선택 항목입니다. 결과 파일 암호화입니다. 허용되는 값: |
|
| 문자열 | 선택 항목입니다. KMS 키 ARN 또는 ID입니다. |
|
| 문자열 | 선택 항목입니다. 출력 S3 버킷을 소유해야 하는 12자리 AWS 계정 ID입니다. |
|
| 문자열 | 선택 항목입니다. 결과 객체에 적용되는 사전 정의된 ACL입니다. 허용되는 값: |
|
| 문자열 | 선택 항목입니다. 쿼리를 실행할 Athena 작업 그룹입니다. 생략한 경우 기본값은 |
|
| 문자열 | 선택 항목입니다. 재시도를 위한 멱등성 토큰입니다. 길이: 32~128자. |
|
| 목록 | 선택 항목입니다. 위치 순서대로 적용되는 파라미터화된 쿼리의 파라미터 값입니다. 각 값: 1~1,024자입니다. |
|
| 부울 | 선택 항목입니다. |
|
| 정수 | 선택 항목입니다. 재사용할 수 있는 결과의 최대 경과 시간(분)입니다. 범위: 0~10,080. |
|
| 목록 | 선택 사항. 작업 출력에서 특정 필드를 추출하기 위한 JQ 선택자입니다. |
|
다음 표는 이 작업의 출력 필드를 설명합니다.
산출 | 유형 | 예시 |
|---|---|---|
| 물체 |
|
| 부울 |
|
| 문자열 |
|
예시
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: end쿼리 실행 가져오기
작업 식별자는 aws.athena.getQueryExecution입니다.
실행 ID를 기준으로 단일 Athena 쿼리 실행의 세부 정보 및 현재 상태를 반환합니다. aws.athena.startQueryExecution에 의해 시작된 쿼리가 종료 상태(SUCCEEDED, FAILED 또는 CANCELLED)에 도달할 때까지 해당 쿼리를 폴링하는 데 사용하십시오.
다음 표에서는 이 작업의 입력 필드를 설명합니다.
입력 | 유형 | 설명 | 예시 |
|---|---|---|---|
| 문자열 | 필수 항목입니다. Athena 작업 그룹의 AWS 리전입니다. |
|
| 문자열 | 필수 항목입니다. |
|
| 문자열 | 선택 사항. AWS API 호출을 위해 수임할 IAM 역할 ARN입니다. |
|
| 문자열 | 선택 사항. AWS 액세스 키 ID입니다. 시크릿으로 전달하십시오. |
|
| 문자열 | 선택 사항. AWS 비밀 액세스 키입니다. 시크릿으로 전달하십시오. |
|
| 문자열 | 선택 사항. STS 인증을 위한 임시 세션 토큰. 시크릿으로 전달하십시오. |
|
| 목록 | 선택 사항. 작업 출력에서 특정 필드를 추출하기 위한 JQ 선택자입니다. |
|
다음 표는 이 작업의 출력 필드를 설명합니다.
산출 | 유형 | 예시 |
|---|---|---|
| 물체 |
|
| 부울 |
|
| 문자열 |
|
예시
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: end쿼리 결과 가져오기
작업 식별자는 aws.athena.getQueryResults입니다.
완료된 Athena 쿼리 실행의 행 및 열 메타데이터를 반환합니다. 결과는 페이지 단위로 제공됩니다 ― 응답에 NextToken이(가) 포함된 경우, 다음 페이지를 가져오려면 다음 호출에서 이를 nextToken (으)로 전달하십시오. ResultSet.Rows의 첫 번째 행은 항상 헤더 행(열 이름)입니다.
다음 표에서는 이 작업의 입력 필드를 설명합니다.
입력 | 유형 | 설명 | 예시 |
|---|---|---|---|
| 문자열 | 필수 항목입니다. Athena 작업 그룹의 AWS 리전입니다. |
|
| 문자열 | 필수 항목입니다. 완료된 쿼리 실행의 UUID입니다. 길이: 1~128자. |
|
| 문자열 | 선택 사항. AWS API 호출을 위해 수임할 IAM 역할 ARN입니다. |
|
| 문자열 | 선택 사항. AWS 액세스 키 ID입니다. 시크릿으로 전달하십시오. |
|
| 문자열 | 선택 사항. AWS 비밀 액세스 키입니다. 시크릿으로 전달하십시오. |
|
| 문자열 | 선택 사항. STS 인증을 위한 임시 세션 토큰. 시크릿으로 전달하십시오. |
|
| 문자열 | 선택 항목입니다. 이전의 잘린 응답에서 가져온 페이징 토큰입니다. 첫 번째 페이지부터 시작하려면 생략하십시오. 길이: 1~1,024자. |
|
| 정수 | 선택 항목입니다. 페이지당 반환할 최대 행 수입니다. 범위: 1~1,000. |
|
| 문자열 | 선택 항목입니다. 반환할 결과 유형입니다. 허용되는 값: |
|
| 목록 | 선택 사항. 작업 출력에서 특정 필드를 추출하기 위한 JQ 선택자입니다. |
|
다음 표는 이 작업의 출력 필드를 설명합니다.
산출 | 유형 | 예시 |
|---|---|---|
| 물체 | 더 많은 페이지가 있는 경우 |
| 부울 |
|
| 문자열 |
|
예시
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