Skip to content

Commit 9df4652

Browse files
author
AWS
committed
Redshift Data API Service Update: Adding a new API GetStatementResultV2 that supports CSV formatted results from ExecuteStatement and BatchExecuteStatement calls.
1 parent 278c59e commit 9df4652

File tree

3 files changed

+109
-5
lines changed

3 files changed

+109
-5
lines changed

‎.changes/next-release/feature-RedshiftDataAPIService-2272a74.json

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,6 @@
1+
{
2+
"type": "feature",
3+
"category": "Redshift Data API Service",
4+
"contributor": "",
5+
"description": "Adding a new API GetStatementResultV2 that supports CSV formatted results from ExecuteStatement and BatchExecuteStatement calls."
6+
}

‎services/redshiftdata/src/main/resources/codegen-resources/paginators-1.json

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -11,6 +11,11 @@
1111
"output_token": "NextToken",
1212
"result_key": "Records"
1313
},
14+
"GetStatementResultV2": {
15+
"input_token": "NextToken",
16+
"output_token": "NextToken",
17+
"result_key": "Records"
18+
},
1419
"ListDatabases": {
1520
"input_token": "NextToken",
1621
"output_token": "NextToken",

‎services/redshiftdata/src/main/resources/codegen-resources/service-2.json

Lines changed: 98 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -11,7 +11,8 @@
1111
"signatureVersion":"v4",
1212
"signingName":"redshift-data",
1313
"targetPrefix":"RedshiftData",
14-
"uid":"redshift-data-2019-12-20"
14+
"uid":"redshift-data-2019-12-20",
15+
"auth":["aws.auth#sigv4"]
1516
},
1617
"operations":{
1718
"BatchExecuteStatement":{
@@ -108,7 +109,22 @@
108109
{"shape":"ResourceNotFoundException"},
109110
{"shape":"InternalServerException"}
110111
],
111-
"documentation":"<p>Fetches the temporarily cached result of an SQL statement. A token is returned to page through the statement results. </p> <p>For more information about the Amazon Redshift Data API and CLI usage examples, see <a href=\"https://docs.aws.amazon.com/redshift/latest/mgmt/data-api.html\">Using the Amazon Redshift Data API</a> in the <i>Amazon Redshift Management Guide</i>. </p>"
112+
"documentation":"<p>Fetches the temporarily cached result of an SQL statement in JSON format. The <code>ExecuteStatement</code> or <code>BatchExecuteStatement</code> operation that ran the SQL statement must have specified <code>ResultFormat</code> as <code>JSON</code> , or let the format default to JSON. A token is returned to page through the statement results.</p> <p>For more information about the Amazon Redshift Data API and CLI usage examples, see <a href=\"https://docs.aws.amazon.com/redshift/latest/mgmt/data-api.html\">Using the Amazon Redshift Data API</a> in the <i>Amazon Redshift Management Guide</i>. </p>"
113+
},
114+
"GetStatementResultV2":{
115+
"name":"GetStatementResultV2",
116+
"http":{
117+
"method":"POST",
118+
"requestUri":"/"
119+
},
120+
"input":{"shape":"GetStatementResultV2Request"},
121+
"output":{"shape":"GetStatementResultV2Response"},
122+
"errors":[
123+
{"shape":"ValidationException"},
124+
{"shape":"ResourceNotFoundException"},
125+
{"shape":"InternalServerException"}
126+
],
127+
"documentation":"<p>Fetches the temporarily cached result of an SQL statement in CSV format. The <code>ExecuteStatement</code> or <code>BatchExecuteStatement</code> operation that ran the SQL statement must have specified <code>ResultFormat</code> as <code>CSV</code>. A token is returned to page through the statement results.</p> <p>For more information about the Amazon Redshift Data API and CLI usage examples, see <a href=\"https://docs.aws.amazon.com/redshift/latest/mgmt/data-api.html\">Using the Amazon Redshift Data API</a> in the <i>Amazon Redshift Management Guide</i>. </p>"
112128
},
113129
"ListDatabases":{
114130
"name":"ListDatabases",
@@ -228,6 +244,10 @@
228244
"shape":"String",
229245
"documentation":"<p>The database user name. This parameter is required when connecting to a cluster as a database user and authenticating using temporary credentials. </p>"
230246
},
247+
"ResultFormat":{
248+
"shape":"ResultFormatString",
249+
"documentation":"<p>The data format of the result of the SQL statement. If no format is specified, the default is JSON.</p>"
250+
},
231251
"SecretArn":{
232252
"shape":"SecretArn",
233253
"documentation":"<p>The name or ARN of the secret that enables access to the database. This parameter is required when authenticating using Secrets Manager. </p>"
@@ -343,8 +363,7 @@
343363
"ClusterIdentifierString":{
344364
"type":"string",
345365
"max":63,
346-
"min":1,
347-
"pattern":"^[a-z]([a-z0-9]|-[a-z0-9])*$"
366+
"min":1
348367
},
349368
"ColumnList":{
350369
"type":"list",
@@ -492,6 +511,10 @@
492511
"shape":"Long",
493512
"documentation":"<p>The identifier of the query generated by Amazon Redshift. These identifiers are also available in the <code>query</code> column of the <code>STL_QUERY</code> system view. </p>"
494513
},
514+
"ResultFormat":{
515+
"shape":"ResultFormatString",
516+
"documentation":"<p>The data format of the result of the SQL statement.</p>"
517+
},
495518
"ResultRows":{
496519
"shape":"Long",
497520
"documentation":"<p>Either the number of rows returned from the SQL statement or the number of rows affected. If result size is greater than zero, the result rows can be the number of rows affected by SQL statements such as INSERT, UPDATE, DELETE, COPY, and others. A <code>-1</code> indicates the value is null.</p>"
@@ -634,6 +657,10 @@
634657
"shape":"SqlParametersList",
635658
"documentation":"<p>The parameters for the SQL statement.</p>"
636659
},
660+
"ResultFormat":{
661+
"shape":"ResultFormatString",
662+
"documentation":"<p>The data format of the result of the SQL statement. If no format is specified, the default is JSON.</p>"
663+
},
637664
"SecretArn":{
638665
"shape":"SecretArn",
639666
"documentation":"<p>The name or ARN of the secret that enables access to the database. This parameter is required when authenticating using Secrets Manager. </p>"
@@ -740,6 +767,10 @@
740767
"type":"list",
741768
"member":{"shape":"Field"}
742769
},
770+
"FormattedSqlRecords":{
771+
"type":"list",
772+
"member":{"shape":"QueryRecords"}
773+
},
743774
"GetStatementResultRequest":{
744775
"type":"structure",
745776
"required":["Id"],
@@ -768,14 +799,54 @@
768799
},
769800
"Records":{
770801
"shape":"SqlRecords",
771-
"documentation":"<p>The results of the SQL statement.</p>"
802+
"documentation":"<p>The results of the SQL statement in JSON format.</p>"
772803
},
773804
"TotalNumRows":{
774805
"shape":"Long",
775806
"documentation":"<p>The total number of rows in the result set returned from a query. You can use this number to estimate the number of calls to the <code>GetStatementResult</code> operation needed to page through the results. </p>"
776807
}
777808
}
778809
},
810+
"GetStatementResultV2Request":{
811+
"type":"structure",
812+
"required":["Id"],
813+
"members":{
814+
"Id":{
815+
"shape":"UUID",
816+
"documentation":"<p>The identifier of the SQL statement whose results are to be fetched. This value is a universally unique identifier (UUID) generated by Amazon Redshift Data API. A suffix indicates then number of the SQL statement. For example, <code>d9b6c0c9-0747-4bf4-b142-e8883122f766:2</code> has a suffix of <code>:2</code> that indicates the second SQL statement of a batch query. This identifier is returned by <code>BatchExecuteStatment</code>, <code>ExecuteStatment</code>, and <code>ListStatements</code>. </p>"
817+
},
818+
"NextToken":{
819+
"shape":"String",
820+
"documentation":"<p>A value that indicates the starting point for the next set of response records in a subsequent request. If a value is returned in a response, you can retrieve the next set of records by providing this returned NextToken value in the next NextToken parameter and retrying the command. If the NextToken field is empty, all response records have been retrieved for the request.</p>"
821+
}
822+
}
823+
},
824+
"GetStatementResultV2Response":{
825+
"type":"structure",
826+
"required":["Records"],
827+
"members":{
828+
"ColumnMetadata":{
829+
"shape":"ColumnMetadataList",
830+
"documentation":"<p>The properties (metadata) of a column.</p>"
831+
},
832+
"NextToken":{
833+
"shape":"String",
834+
"documentation":"<p>A value that indicates the starting point for the next set of response records in a subsequent request. If a value is returned in a response, you can retrieve the next set of records by providing this returned NextToken value in the next NextToken parameter and retrying the command. If the NextToken field is empty, all response records have been retrieved for the request. </p>"
835+
},
836+
"Records":{
837+
"shape":"FormattedSqlRecords",
838+
"documentation":"<p>The results of the SQL statement in CSV format.</p>"
839+
},
840+
"ResultFormat":{
841+
"shape":"ResultFormatString",
842+
"documentation":"<p>The data format of the result of the SQL statement.</p>"
843+
},
844+
"TotalNumRows":{
845+
"shape":"Long",
846+
"documentation":"<p>The total number of rows in the result set returned from a query. You can use this number to estimate the number of calls to the <code>GetStatementResultV2</code> operation needed to page through the results. </p>"
847+
}
848+
}
849+
},
779850
"Integer":{"type":"integer"},
780851
"InternalServerException":{
781852
"type":"structure",
@@ -1009,6 +1080,17 @@
10091080
"type":"string",
10101081
"min":1
10111082
},
1083+
"QueryRecords":{
1084+
"type":"structure",
1085+
"members":{
1086+
"CSVRecords":{
1087+
"shape":"String",
1088+
"documentation":"<p>The results of the SQL statement in CSV format.</p>"
1089+
}
1090+
},
1091+
"documentation":"<p>The results of the SQL statement.</p>",
1092+
"union":true
1093+
},
10121094
"QueryTimeoutException":{
10131095
"type":"structure",
10141096
"members":{
@@ -1036,6 +1118,13 @@
10361118
"documentation":"<p>The Amazon Redshift Data API operation failed due to a missing resource. </p>",
10371119
"exception":true
10381120
},
1121+
"ResultFormatString":{
1122+
"type":"string",
1123+
"enum":[
1124+
"JSON",
1125+
"CSV"
1126+
]
1127+
},
10391128
"SchemaList":{
10401129
"type":"list",
10411130
"member":{"shape":"String"}
@@ -1108,6 +1197,10 @@
11081197
"shape":"StatementStringList",
11091198
"documentation":"<p>One or more SQL statements. Each query string in the array corresponds to one of the queries in a batch query request.</p>"
11101199
},
1200+
"ResultFormat":{
1201+
"shape":"ResultFormatString",
1202+
"documentation":"<p>The data format of the result of the SQL statement.</p>"
1203+
},
11111204
"SecretArn":{
11121205
"shape":"SecretArn",
11131206
"documentation":"<p>The name or Amazon Resource Name (ARN) of the secret that enables access to the database. </p>"

0 commit comments

Comments
 (0)