Automate Amazon Athena Integration Tasks from PowerShell

The CData Cmdlets for Amazon Athena are standard PowerShell cmdlets that make it easy to accomplish data cleansing, normalization, backup, and other integration tasks by enabling real-time and bidirectional access to Amazon Athena.

Getting Started

---

PowerShell Cmdlets or ADO.NET Provider?

The Cmdlets are not only a PowerShell interface to Amazon Athena, but also an SQL interface; this tutorial shows how to use both to create, retrieve, update, and delete Amazon Athena data. We also show examples of the ADO.NET equivalent, which is possible with the CData ADO.NET Provider for Amazon Athena. To access Amazon Athena data from other .NET applications, like LINQPad, use the CData ADO.NET Provider for Amazon Athena.

Once you have acquired the necessary connection properties, accessing Amazon Athena data in PowerShell can be enabled in three steps.

Authenticating to Amazon Athena

To authorize Amazon Athena requests, provide the credentials for an administrator account or for an IAM user with custom permissions: Set to the access key Id. Set to the secret access key.

Note: Though you can connect as the AWS account administrator, it is recommended to use IAM user credentials to access AWS services.

Obtaining the Access Key

To obtain the credentials for an IAM user, follow the steps below:

1. Sign into the IAM console.
2. In the navigation pane, select Users.
3. To create or manage the access keys for a user, select the user and then select the Security Credentials tab.

To obtain the credentials for your AWS root account, follow the steps below:

1. Sign into the AWS Management console with the credentials for your root account.
2. Select your account name or number and select My Security Credentials in the menu that is displayed.
3. Click Continue to Security Credentials and expand the Access Keys section to manage or create root account access keys.

Authenticating from an EC2 Instance

If you are using the CData Data Provider for Amazon Athena 2018 from an EC2 Instance and have an IAM Role assigned to the instance, you can use the IAM Role to authenticate. To do so, set to true and leave and empty. The CData Data Provider for Amazon Athena 2018 will automatically obtain your IAM Role credentials and authenticate with them.

Authenticating as an AWS Role

In many situations it may be preferable to use an IAM role for authentication instead of the direct security credentials of an AWS root user. An AWS role may be used instead by specifying the . This will cause the CData Data Provider for Amazon Athena 2018 to attempt to retrieve credentials for the specified role. If you are connecting to AWS (instead of already being connected such as on an EC2 instance), you must additionally specify the and of an IAM user to assume the role for. Roles may not be used when specifying the and of an AWS root user.

Authenticating with MFA

For users and roles that require Multi-factor Authentication, specify the and connection properties. This will cause the CData Data Provider for Amazon Athena 2018 to submit the MFA credentials in a request to retrieve temporary authentication credentials. Note that the duration of the temporary credentials may be controlled via the (default 3600 seconds).

Connecting to Amazon Athena

In addition to the and properties, specify , and . Set to the region where your Amazon Athena data is hosted. Set to a folder in S3 where you would like to store the results of queries.

If is not set in the connection, the data provider connects to the default database set in Amazon Athena.

PowerShell

1. Install the module:

   Install-Module AmazonAthenaCmdlets

2. Connect:

   $amazonathena = Connect-AmazonAthena -AWSAccessKey "$AWSAccessKey" -AWSSecretKey "$AWSSecretKey" -AWSRegion "$AWSRegion" -Database "$Database" -S3StagingDirectory "$S3StagingDirectory"
   

3. Search for and retrieve data:

   $customerid = "12345"
   $customers = Select-AmazonAthena -Connection $amazonathena -Table "Customers" -Where "CustomerId = `'$CustomerId`'"
   $customers
   

   You can also use the Invoke-AmazonAthena cmdlet to execute SQL commands:

   $customers = Invoke-AmazonAthena -Connection $amazonathena -Query 'SELECT * FROM Customers WHERE CustomerId = @CustomerId' -Params @{'@CustomerId'='12345'}
   

ADO.NET

1. Load the provider's assembly:

   [Reflection.Assembly]::LoadFile("C:\Program Files\CData\CData ADO.NET Provider for Amazon Athena\lib\System.Data.CData.AmazonAthena.dll")
    

2. Connect to Amazon Athena:

    
   $conn= New-Object System.Data.CData.AmazonAthena.AmazonAthenaConnection("AWSAccessKey='a123';AWSSecretKey='s123';AWSRegion='IRELAND';Database='sampledb';S3StagingDirectory='s3://bucket/staging/';")
   $conn.Open()
   

3. Instantiate the AmazonAthenaDataAdapter, execute an SQL query, and output the results:

   $sql="SELECT Name, TotalDue from Customers"
   
   $da= New-Object System.Data.CData.AmazonAthena.AmazonAthenaDataAdapter($sql, $conn)
   $dt= New-Object System.Data.DataTable
   $da.Fill($dt)
   
   $dt.Rows | foreach {
   	Write-Host $_.name $_.totaldue
   }
    

Update Amazon Athena Data

PowerShell

Update-AmazonAthena -Connection $AmazonAthena -Columns @('Name','TotalDue') -Values @('MyName', 'MyTotalDue') -Table Customers -Id "MyId"

ADO.NET

$cmd = New-Object System.Data.CData.AmazonAthena.AmazonAthenaCommand("UPDATE Customers SET CustomerId='12345' WHERE Id = @myId", $conn)
$cmd.Parameters.Add((New-Object System.Data.CData.AmazonAthena.AmazonAthenaParameter("@myId","10456255-0015501366")))
$cmd.ExecuteNonQuery()

Insert Amazon Athena Data

PowerShell

Add-AmazonAthena -Connection $AmazonAthena -Table Customers -Columns @("Name", "TotalDue") -Values @("MyName", "MyTotalDue") 

ADO.NET

$cmd = New-Object System.Data.CData.AmazonAthena.AmazonAthenaCommand("INSERT INTO Customers (CustomerId) VALUES (@myCustomerId)", $conn)
$cmd.Parameters.Add((New-Object System.Data.CData.AmazonAthena.AmazonAthenaParameter("@myCustomerId","12345")))
$cmd.ExecuteNonQuery()

Delete Amazon Athena Data

PowerShell

Remove-AmazonAthena -Connection $AmazonAthena -Table "Customers" -Id "MyId"

ADO.NET

$cmd = New-Object System.Data.CData.AmazonAthena.AmazonAthenaCommand("DELETE FROM Customers WHERE Id=@myId", $conn)
$cmd.Parameters.Add((New-Object System.Data.CData.AmazonAthena.AmazonAthenaParameter("@myId","001d000000YBRseAAH")))
$cmd.ExecuteNonQuery()

CodeProject