Updates to wrapper and specification.

rlhagerm · rlhagerm · commit 3c0854be5b28 · 2025-11-24T14:06:39.000-06:00
diff --git a/dotnetv4/Redshift/Actions/RedshiftWrapper.cs b/dotnetv4/Redshift/Actions/RedshiftWrapper.cs
@@ -61,9 +61,14 @@ public async Task<Cluster> CreateClusterAsync(string clusterIdentifier, string d
             Console.WriteLine($"Created cluster {clusterIdentifier}");
             return response.Cluster;
         }
+        catch (ClusterAlreadyExistsException ex)
+        {
+            Console.WriteLine($"Cluster already exists: {ex.Message}");
+            throw;
+        }
         catch (Exception ex)
         {
-            Console.WriteLine($"Error creating cluster: {ex.Message}");
+            Console.WriteLine($"Couldn't create cluster. Here's why: {ex.Message}");
             throw;
         }
     }
@@ -88,9 +93,14 @@ public async Task<List<Cluster>> DescribeClustersAsync(string? clusterIdentifier
             var response = await _redshiftClient.DescribeClustersAsync(request);
             return response.Clusters;
         }
+        catch (ClusterNotFoundException ex)
+        {
+            Console.WriteLine($"Cluster not found: {ex.Message}");
+            throw;
+        }
         catch (Exception ex)
         {
-            Console.WriteLine($"Error describing clusters: {ex.Message}");
+            Console.WriteLine($"Couldn't describe clusters. Here's why: {ex.Message}");
             throw;
         }
     }
@@ -117,9 +127,14 @@ public async Task<Cluster> ModifyClusterAsync(string clusterIdentifier, string p
             Console.WriteLine($"The modified cluster was successfully modified and has {preferredMaintenanceWindow} as the maintenance window");
             return response.Cluster;
         }
+        catch (ClusterNotFoundException ex)
+        {
+            Console.WriteLine($"Cluster not found: {ex.Message}");
+            throw;
+        }
         catch (Exception ex)
         {
-            Console.WriteLine($"Error modifying cluster: {ex.Message}");
+            Console.WriteLine($"Couldn't modify cluster. Here's why: {ex.Message}");
             throw;
         }
     }
@@ -145,9 +160,14 @@ public async Task<Cluster> DeleteClusterAsync(string clusterIdentifier)
             Console.WriteLine($"The {clusterIdentifier} was deleted");
             return response.Cluster;
         }
+        catch (ClusterNotFoundException ex)
+        {
+            Console.WriteLine($"Cluster not found: {ex.Message}");
+            throw;
+        }
         catch (Exception ex)
         {
-            Console.WriteLine($"Error deleting cluster: {ex.Message}");
+            Console.WriteLine($"Couldn't delete cluster. Here's why: {ex.Message}");
             throw;
         }
     }
@@ -183,9 +203,14 @@ public async Task<List<string>> ListDatabasesAsync(string clusterIdentifier, str
 
             return databases;
         }
+        catch (Amazon.RedshiftDataAPIService.Model.ValidationException ex)
+        {
+            Console.WriteLine($"Validation error: {ex.Message}");
+            throw;
+        }
         catch (Exception ex)
         {
-            Console.WriteLine($"Error listing databases: {ex.Message}");
+            Console.WriteLine($"Couldn't list databases. Here's why: {ex.Message}");
             throw;
         }
     }
@@ -223,9 +248,14 @@ year INTEGER NOT NULL
             Console.WriteLine("Table created: Movies");
             return response.Id;
         }
+        catch (Amazon.RedshiftDataAPIService.Model.ValidationException ex)
+        {
+            Console.WriteLine($"Validation error: {ex.Message}");
+            throw;
+        }
         catch (Exception ex)
         {
-            Console.WriteLine($"Error creating table: {ex.Message}");
+            Console.WriteLine($"Couldn't create table. Here's why: {ex.Message}");
             throw;
         }
     }
@@ -268,9 +298,14 @@ public async Task<string> InsertMovieAsync(string clusterIdentifier, string data
             Console.WriteLine($"Inserted: {title} ({year})");
             return response.Id;
         }
+        catch (Amazon.RedshiftDataAPIService.Model.ValidationException ex)
+        {
+            Console.WriteLine($"Validation error: {ex.Message}");
+            throw;
+        }
         catch (Exception ex)
         {
-            Console.WriteLine($"Error inserting movie: {ex.Message}");
+            Console.WriteLine($"Couldn't insert movie. Here's why: {ex.Message}");
             throw;
         }
     }
@@ -324,9 +359,14 @@ public async Task<List<string>> QueryMoviesByYearAsync(string clusterIdentifier,
 
             return movieTitles;
         }
+        catch (Amazon.RedshiftDataAPIService.Model.ValidationException ex)
+        {
+            Console.WriteLine($"Validation error: {ex.Message}");
+            throw;
+        }
         catch (Exception ex)
         {
-            Console.WriteLine($"Error querying movies: {ex.Message}");
+            Console.WriteLine($"Couldn't query movies. Here's why: {ex.Message}");
             throw;
         }
     }
@@ -350,9 +390,14 @@ public async Task<DescribeStatementResponse> DescribeStatementAsync(string state
             var response = await _redshiftDataClient.DescribeStatementAsync(request);
             return response;
         }
+        catch (Amazon.RedshiftDataAPIService.Model.ResourceNotFoundException ex)
+        {
+            Console.WriteLine($"Statement not found: {ex.Message}");
+            throw;
+        }
         catch (Exception ex)
         {
-            Console.WriteLine($"Error describing statement: {ex.Message}");
+            Console.WriteLine($"Couldn't describe statement. Here's why: {ex.Message}");
             throw;
         }
     }
@@ -376,9 +421,14 @@ public async Task<List<List<Field>>> GetStatementResultAsync(string statementId)
             var response = await _redshiftDataClient.GetStatementResultAsync(request);
             return response.Records;
         }
+        catch (Amazon.RedshiftDataAPIService.Model.ResourceNotFoundException ex)
+        {
+            Console.WriteLine($"Statement not found: {ex.Message}");
+            throw;
+        }
         catch (Exception ex)
         {
-            Console.WriteLine($"Error getting statement result: {ex.Message}");
+            Console.WriteLine($"Couldn't get statement result. Here's why: {ex.Message}");
             throw;
         }
     }
@@ -411,7 +461,6 @@ private async Task WaitForStatementToCompleteAsync(string statementId)
             var errorMessage = response?.Error ?? "Unknown error";
             Console.WriteLine($"The statement failed with status: {status}");
             Console.WriteLine($"Error message: {errorMessage}");
-            throw new Exception($"Statement execution failed with status: {status}. Error: {errorMessage}");
         }
     }
 
diff --git a/scenarios/basics/redshift/SPECIFICATION.md b/scenarios/basics/redshift/SPECIFICATION.md
@@ -13,6 +13,20 @@ The following user input is required for this SDK getting started scenario:
 - The year to use to query records from the database.
 - Whether or not to delete the Amazon Redshift cluster.
 
+## SQL Statement Requirements
+
+All SQL statements that include user input or variable data MUST use parameterized queries to prevent SQL injection vulnerabilities. This applies to:
+
+- INSERT statements when adding movie records (use parameters for id, title, and year values)
+- SELECT statements when querying by year (use parameters for the year value)
+- Any other SQL operations that incorporate dynamic values
+
+Example of parameterized query usage:
+- Instead of: `SELECT * FROM Movies WHERE year = 2013`
+- Use: `SELECT * FROM Movies WHERE year = :year` with a parameter binding for `:year`
+
+This security best practice ensures that user input is properly escaped and prevents malicious SQL code injection.
+
 ## Hello Redshift
 This program is intended for users not familiar with the Redshift SDK to easily get up an running. The logic is to show use of `redshiftClient.describeClustersPaginator()`.
 
@@ -148,6 +162,21 @@ This concludes the Amazon Redshift SDK Getting Started scenario.
 
 ```
 
+## Exception Handling
+
+The following table lists the exceptions that should be caught and handled for each action in the scenario:
+
+| Action                    | Exception                      | Handling                                                                                    |
+|---------------------------|--------------------------------|---------------------------------------------------------------------------------------------|
+| `createCluster`           | ClusterAlreadyExistsFault      | Notify the user that a cluster with this identifier already exists and exit.                |
+| `describeClusters`        | ClusterNotFoundFault           | Notify the user that the specified cluster was not found.                                   |
+| `listDatabases`           | ValidationException            | Notify the user that the cluster is not available or parameters are invalid.                |
+| `executeStatement`        | ValidationException            | Notify the user of SQL syntax errors or invalid query parameters.                           |
+| `describeStatement`       | ResourceNotFoundException      | Notify the user that the statement ID was not found.                                        |
+| `getStatementResult`      | ResourceNotFoundException      | Notify the user that results are not available for the statement ID.                        |
+| `modifyCluster`           | ClusterNotFoundFault           | Notify the user that the cluster to modify was not found.                                   |
+| `deleteCluster`           | ClusterNotFoundFault           | Notify the user that the cluster to delete was not found.                                   |
+
 ## SOS Tags
 
 The following table describes the metadata used in this SDK Getting Started Scenario.

Original file line number	Diff line number	Diff line change
`@@ -61,9 +61,14 @@ public async Task<Cluster> CreateClusterAsync(string clusterIdentifier, string d`
`61`	`61`	`Console.WriteLine($"Created cluster {clusterIdentifier}");`
`62`	`62`	`return response.Cluster;`
`63`	`63`	`}`
	`64`	`+ catch (ClusterAlreadyExistsException ex)`
	`65`	`+ {`
	`66`	`+ Console.WriteLine($"Cluster already exists: {ex.Message}");`
	`67`	`+ throw;`
	`68`	`+ }`
`64`	`69`	`catch (Exception ex)`
`65`	`70`	`{`
`66`		`- Console.WriteLine($"Error creating cluster: {ex.Message}");`
	`71`	`+ Console.WriteLine($"Couldn't create cluster. Here's why: {ex.Message}");`
`67`	`72`	`throw;`
`68`	`73`	`}`
`69`	`74`	`}`
`@@ -88,9 +93,14 @@ public async Task<List<Cluster>> DescribeClustersAsync(string? clusterIdentifier`
`88`	`93`	`var response = await _redshiftClient.DescribeClustersAsync(request);`
`89`	`94`	`return response.Clusters;`
`90`	`95`	`}`
	`96`	`+ catch (ClusterNotFoundException ex)`
	`97`	`+ {`
	`98`	`+ Console.WriteLine($"Cluster not found: {ex.Message}");`
	`99`	`+ throw;`
	`100`	`+ }`
`91`	`101`	`catch (Exception ex)`
`92`	`102`	`{`
`93`		`- Console.WriteLine($"Error describing clusters: {ex.Message}");`
	`103`	`+ Console.WriteLine($"Couldn't describe clusters. Here's why: {ex.Message}");`
`94`	`104`	`throw;`
`95`	`105`	`}`
`96`	`106`	`}`
`@@ -117,9 +127,14 @@ public async Task<Cluster> ModifyClusterAsync(string clusterIdentifier, string p`
`117`	`127`	`Console.WriteLine($"The modified cluster was successfully modified and has {preferredMaintenanceWindow} as the maintenance window");`
`118`	`128`	`return response.Cluster;`
`119`	`129`	`}`
	`130`	`+ catch (ClusterNotFoundException ex)`
	`131`	`+ {`
	`132`	`+ Console.WriteLine($"Cluster not found: {ex.Message}");`
	`133`	`+ throw;`
	`134`	`+ }`
`120`	`135`	`catch (Exception ex)`
`121`	`136`	`{`
`122`		`- Console.WriteLine($"Error modifying cluster: {ex.Message}");`
	`137`	`+ Console.WriteLine($"Couldn't modify cluster. Here's why: {ex.Message}");`
`123`	`138`	`throw;`
`124`	`139`	`}`
`125`	`140`	`}`
`@@ -145,9 +160,14 @@ public async Task<Cluster> DeleteClusterAsync(string clusterIdentifier)`
`145`	`160`	`Console.WriteLine($"The {clusterIdentifier} was deleted");`
`146`	`161`	`return response.Cluster;`
`147`	`162`	`}`
	`163`	`+ catch (ClusterNotFoundException ex)`
	`164`	`+ {`
	`165`	`+ Console.WriteLine($"Cluster not found: {ex.Message}");`
	`166`	`+ throw;`
	`167`	`+ }`
`148`	`168`	`catch (Exception ex)`
`149`	`169`	`{`
`150`		`- Console.WriteLine($"Error deleting cluster: {ex.Message}");`
	`170`	`+ Console.WriteLine($"Couldn't delete cluster. Here's why: {ex.Message}");`
`151`	`171`	`throw;`
`152`	`172`	`}`
`153`	`173`	`}`
`@@ -183,9 +203,14 @@ public async Task<List<string>> ListDatabasesAsync(string clusterIdentifier, str`
`183`	`203`
`184`	`204`	`return databases;`
`185`	`205`	`}`
	`206`	`+ catch (Amazon.RedshiftDataAPIService.Model.ValidationException ex)`
	`207`	`+ {`
	`208`	`+ Console.WriteLine($"Validation error: {ex.Message}");`
	`209`	`+ throw;`
	`210`	`+ }`
`186`	`211`	`catch (Exception ex)`
`187`	`212`	`{`
`188`		`- Console.WriteLine($"Error listing databases: {ex.Message}");`
	`213`	`+ Console.WriteLine($"Couldn't list databases. Here's why: {ex.Message}");`
`189`	`214`	`throw;`
`190`	`215`	`}`
`191`	`216`	`}`
`@@ -223,9 +248,14 @@ year INTEGER NOT NULL`
`223`	`248`	`Console.WriteLine("Table created: Movies");`
`224`	`249`	`return response.Id;`
`225`	`250`	`}`
	`251`	`+ catch (Amazon.RedshiftDataAPIService.Model.ValidationException ex)`
	`252`	`+ {`
	`253`	`+ Console.WriteLine($"Validation error: {ex.Message}");`
	`254`	`+ throw;`
	`255`	`+ }`
`226`	`256`	`catch (Exception ex)`
`227`	`257`	`{`
`228`		`- Console.WriteLine($"Error creating table: {ex.Message}");`
	`258`	`+ Console.WriteLine($"Couldn't create table. Here's why: {ex.Message}");`
`229`	`259`	`throw;`
`230`	`260`	`}`
`231`	`261`	`}`
`@@ -268,9 +298,14 @@ public async Task<string> InsertMovieAsync(string clusterIdentifier, string data`
`268`	`298`	`Console.WriteLine($"Inserted: {title} ({year})");`
`269`	`299`	`return response.Id;`
`270`	`300`	`}`
	`301`	`+ catch (Amazon.RedshiftDataAPIService.Model.ValidationException ex)`
	`302`	`+ {`
	`303`	`+ Console.WriteLine($"Validation error: {ex.Message}");`
	`304`	`+ throw;`
	`305`	`+ }`
`271`	`306`	`catch (Exception ex)`
`272`	`307`	`{`
`273`		`- Console.WriteLine($"Error inserting movie: {ex.Message}");`
	`308`	`+ Console.WriteLine($"Couldn't insert movie. Here's why: {ex.Message}");`
`274`	`309`	`throw;`
`275`	`310`	`}`
`276`	`311`	`}`
`@@ -324,9 +359,14 @@ public async Task<List<string>> QueryMoviesByYearAsync(string clusterIdentifier,`
`324`	`359`
`325`	`360`	`return movieTitles;`
`326`	`361`	`}`
	`362`	`+ catch (Amazon.RedshiftDataAPIService.Model.ValidationException ex)`
	`363`	`+ {`
	`364`	`+ Console.WriteLine($"Validation error: {ex.Message}");`
	`365`	`+ throw;`
	`366`	`+ }`
`327`	`367`	`catch (Exception ex)`
`328`	`368`	`{`
`329`		`- Console.WriteLine($"Error querying movies: {ex.Message}");`
	`369`	`+ Console.WriteLine($"Couldn't query movies. Here's why: {ex.Message}");`
`330`	`370`	`throw;`
`331`	`371`	`}`
`332`	`372`	`}`
`@@ -350,9 +390,14 @@ public async Task<DescribeStatementResponse> DescribeStatementAsync(string state`
`350`	`390`	`var response = await _redshiftDataClient.DescribeStatementAsync(request);`
`351`	`391`	`return response;`
`352`	`392`	`}`
	`393`	`+ catch (Amazon.RedshiftDataAPIService.Model.ResourceNotFoundException ex)`
	`394`	`+ {`
	`395`	`+ Console.WriteLine($"Statement not found: {ex.Message}");`
	`396`	`+ throw;`
	`397`	`+ }`
`353`	`398`	`catch (Exception ex)`
`354`	`399`	`{`
`355`		`- Console.WriteLine($"Error describing statement: {ex.Message}");`
	`400`	`+ Console.WriteLine($"Couldn't describe statement. Here's why: {ex.Message}");`
`356`	`401`	`throw;`
`357`	`402`	`}`
`358`	`403`	`}`
`@@ -376,9 +421,14 @@ public async Task<List<List<Field>>> GetStatementResultAsync(string statementId)`
`376`	`421`	`var response = await _redshiftDataClient.GetStatementResultAsync(request);`
`377`	`422`	`return response.Records;`
`378`	`423`	`}`
	`424`	`+ catch (Amazon.RedshiftDataAPIService.Model.ResourceNotFoundException ex)`
	`425`	`+ {`
	`426`	`+ Console.WriteLine($"Statement not found: {ex.Message}");`
	`427`	`+ throw;`
	`428`	`+ }`
`379`	`429`	`catch (Exception ex)`
`380`	`430`	`{`
`381`		`- Console.WriteLine($"Error getting statement result: {ex.Message}");`
	`431`	`+ Console.WriteLine($"Couldn't get statement result. Here's why: {ex.Message}");`
`382`	`432`	`throw;`
`383`	`433`	`}`
`384`	`434`	`}`
`@@ -411,7 +461,6 @@ private async Task WaitForStatementToCompleteAsync(string statementId)`
`411`	`461`	`var errorMessage = response?.Error ?? "Unknown error";`
`412`	`462`	`Console.WriteLine($"The statement failed with status: {status}");`
`413`	`463`	`Console.WriteLine($"Error message: {errorMessage}");`
`414`		`- throw new Exception($"Statement execution failed with status: {status}. Error: {errorMessage}");`
`415`	`464`	`}`
`416`	`465`	`}`
`417`	`466`