Skip to main content

Amazon Athena - Download Query Results to Shipyard

Overview​

Turn the results of your SQL SELECT statement into a CSV file. Extract your Amazon Athena data into files for easier delivery to clients and partners.

Variables​

NameReferenceTypeRequiredDefaultOptionsDescription
DatabaseATHENA_DATABASEAlphanumericβœ…--The name of the Athena database the run the query against.
QueryATHENA_QUERYAlphanumericβœ…--The SQL-style query to run against the Athena database.
S3 Log Bucket NameATHENA_BUCKET_NAMEAlphanumericβœ…--The S3 bucket to output the query logs into.
S3 Log Folder NameATHENA_LOG_FOLDERAlphanumericβž–--The optional subdirectory within the S3 bucket to store query logs.
Shipyard File NameATHENA_DESTINATION_FILE_NAMEAlphanumericβœ…output.csv-The file name that you want your generated CSV to have.
Shipyard Folder NameATHENA_DESTINATION_FOLDER_NAMEAlphanumericβž–--The folder structure that you want your CSV to be created in. If left blank, the file will be created in the home directory.
Access Key IDAWS_ACCESS_KEY_IDPasswordβœ…--The access key ID for programmatic IAM user used to download the file. See Authorization documentation for more information.
Secret Access KeyAWS_SECRET_ACCESS_KEYPasswordβœ…--The secret access key for programmatic IAM user used to download the file. See Authorization documentation for more information.
RegionAWS_DEFAULT_REGIONSelectβœ…us-east-2us-east-2,us-east-1,us-west-1,us-west-2,af-south-1,ap-east-1,ap-south-1,ap-northeast-3,ap-northeast-2,ap-southeast-1,ap-southeast-2,ap-northeast-1,ca-central-1,cn-north-1,cn-northwest-1,eu-central-1,eu-west-1,eu-west-2,eu-south-1,eu-west-3,eu-north-1,sa-east-1,me-south-1,The AWS region for the S3 bucket and IAM user.

YAML​

Below is the YAML template for this Blueprint and can be used in the Fleet YAML Editor.

source:
blueprint: Amazon Athena - Download Query Results to Shipyard
inputs:
ATHENA_DATABASE: null ## REQUIRED
ATHENA_QUERY: null ## REQUIRED
ATHENA_BUCKET_NAME: null ## REQUIRED
ATHENA_LOG_FOLDER: null
ATHENA_DESTINATION_FILE_NAME: output.csv ## REQUIRED
ATHENA_DESTINATION_FOLDER_NAME: null
AWS_ACCESS_KEY_ID: null ## REQUIRED
AWS_SECRET_ACCESS_KEY: null ## REQUIRED
AWS_DEFAULT_REGION: us-east-2 ## REQUIRED
type: BLUEPRINT
guardrails:
retry_count: 1
retry_wait: 0h0m0s
runtime_cutoff: 1h0m0s
exclude_exit_code_ranges:
- '0'