|
149 | 149 | "traits": { |
150 | 150 | "smithy.api#documentation": "<p>The session identifier of the query.</p>" |
151 | 151 | } |
| 152 | + }, |
| 153 | + "ResultFormat": { |
| 154 | + "target": "com.amazonaws.redshiftdata#ResultFormatString", |
| 155 | + "traits": { |
| 156 | + "smithy.api#documentation": "<p>The data format of the result of the SQL statement. If no format is specified, the default is JSON.</p>" |
| 157 | + } |
152 | 158 | } |
153 | 159 | }, |
154 | 160 | "traits": { |
|
299 | 305 | "smithy.api#length": { |
300 | 306 | "min": 1, |
301 | 307 | "max": 63 |
302 | | - }, |
303 | | - "smithy.api#pattern": "^[a-z]([a-z0-9]|-[a-z0-9])*$" |
| 308 | + } |
304 | 309 | } |
305 | 310 | }, |
306 | 311 | "com.amazonaws.redshiftdata#ColumnList": { |
|
603 | 608 | "traits": { |
604 | 609 | "smithy.api#documentation": "<p>The session identifier of the query.</p>" |
605 | 610 | } |
| 611 | + }, |
| 612 | + "ResultFormat": { |
| 613 | + "target": "com.amazonaws.redshiftdata#ResultFormatString", |
| 614 | + "traits": { |
| 615 | + "smithy.api#documentation": "<p>The data format of the result of the SQL statement.</p>" |
| 616 | + } |
606 | 617 | } |
607 | 618 | }, |
608 | 619 | "traits": { |
|
867 | 878 | "traits": { |
868 | 879 | "smithy.api#documentation": "<p>The session identifier of the query.</p>" |
869 | 880 | } |
| 881 | + }, |
| 882 | + "ResultFormat": { |
| 883 | + "target": "com.amazonaws.redshiftdata#ResultFormatString", |
| 884 | + "traits": { |
| 885 | + "smithy.api#documentation": "<p>The data format of the result of the SQL statement. If no format is specified, the default is JSON.</p>" |
| 886 | + } |
870 | 887 | } |
871 | 888 | }, |
872 | 889 | "traits": { |
|
985 | 1002 | "target": "com.amazonaws.redshiftdata#Field" |
986 | 1003 | } |
987 | 1004 | }, |
| 1005 | + "com.amazonaws.redshiftdata#FormattedSqlRecords": { |
| 1006 | + "type": "list", |
| 1007 | + "member": { |
| 1008 | + "target": "com.amazonaws.redshiftdata#QueryRecords" |
| 1009 | + } |
| 1010 | + }, |
988 | 1011 | "com.amazonaws.redshiftdata#GetStatementResult": { |
989 | 1012 | "type": "operation", |
990 | 1013 | "input": { |
|
1005 | 1028 | } |
1006 | 1029 | ], |
1007 | 1030 | "traits": { |
1008 | | - "smithy.api#documentation": "<p>Fetches the temporarily cached result of an SQL statement. \n A token is returned to page through the statement results. </p>\n <p>For more information about the Amazon Redshift Data API and CLI usage examples, see \n <a href=\"https://docs.aws.amazon.com/redshift/latest/mgmt/data-api.html\">Using the Amazon Redshift Data API</a> in the \n <i>Amazon Redshift Management Guide</i>. </p>", |
| 1031 | + "smithy.api#documentation": "<p>Fetches the temporarily cached result of an SQL statement in JSON format. \n The <code>ExecuteStatement</code> or <code>BatchExecuteStatement</code> operation that ran the SQL statement must have specified <code>ResultFormat</code> as <code>JSON</code>\n , or let the format default to JSON.\n A token is returned to page through the statement results.</p>\n <p>For more information about the Amazon Redshift Data API and CLI usage examples, see \n <a href=\"https://docs.aws.amazon.com/redshift/latest/mgmt/data-api.html\">Using the Amazon Redshift Data API</a> in the \n <i>Amazon Redshift Management Guide</i>. </p>", |
1009 | 1032 | "smithy.api#paginated": { |
1010 | 1033 | "inputToken": "NextToken", |
1011 | 1034 | "outputToken": "NextToken", |
|
1041 | 1064 | "Records": { |
1042 | 1065 | "target": "com.amazonaws.redshiftdata#SqlRecords", |
1043 | 1066 | "traits": { |
1044 | | - "smithy.api#documentation": "<p>The results of the SQL statement.</p>", |
| 1067 | + "smithy.api#documentation": "<p>The results of the SQL statement in JSON format.</p>", |
1045 | 1068 | "smithy.api#required": {} |
1046 | 1069 | } |
1047 | 1070 | }, |
|
1069 | 1092 | "smithy.api#output": {} |
1070 | 1093 | } |
1071 | 1094 | }, |
| 1095 | + "com.amazonaws.redshiftdata#GetStatementResultV2": { |
| 1096 | + "type": "operation", |
| 1097 | + "input": { |
| 1098 | + "target": "com.amazonaws.redshiftdata#GetStatementResultV2Request" |
| 1099 | + }, |
| 1100 | + "output": { |
| 1101 | + "target": "com.amazonaws.redshiftdata#GetStatementResultV2Response" |
| 1102 | + }, |
| 1103 | + "errors": [ |
| 1104 | + { |
| 1105 | + "target": "com.amazonaws.redshiftdata#InternalServerException" |
| 1106 | + }, |
| 1107 | + { |
| 1108 | + "target": "com.amazonaws.redshiftdata#ResourceNotFoundException" |
| 1109 | + }, |
| 1110 | + { |
| 1111 | + "target": "com.amazonaws.redshiftdata#ValidationException" |
| 1112 | + } |
| 1113 | + ], |
| 1114 | + "traits": { |
| 1115 | + "smithy.api#documentation": "<p>Fetches the temporarily cached result of an SQL statement in CSV format. \n The <code>ExecuteStatement</code> or <code>BatchExecuteStatement</code> operation that ran the SQL statement must have specified <code>ResultFormat</code> as <code>CSV</code>.\n A token is returned to page through the statement results.</p>\n <p>For more information about the Amazon Redshift Data API and CLI usage examples, see \n <a href=\"https://docs.aws.amazon.com/redshift/latest/mgmt/data-api.html\">Using the Amazon Redshift Data API</a> in the \n <i>Amazon Redshift Management Guide</i>. </p>", |
| 1116 | + "smithy.api#paginated": { |
| 1117 | + "inputToken": "NextToken", |
| 1118 | + "outputToken": "NextToken", |
| 1119 | + "items": "Records" |
| 1120 | + }, |
| 1121 | + "smithy.api#readonly": {} |
| 1122 | + } |
| 1123 | + }, |
| 1124 | + "com.amazonaws.redshiftdata#GetStatementResultV2Request": { |
| 1125 | + "type": "structure", |
| 1126 | + "members": { |
| 1127 | + "Id": { |
| 1128 | + "target": "com.amazonaws.redshiftdata#UUID", |
| 1129 | + "traits": { |
| 1130 | + "smithy.api#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. \n A suffix indicates then number of the SQL statement.\n 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.\n This identifier is returned by <code>BatchExecuteStatment</code>, <code>ExecuteStatment</code>, and <code>ListStatements</code>. </p>", |
| 1131 | + "smithy.api#required": {} |
| 1132 | + } |
| 1133 | + }, |
| 1134 | + "NextToken": { |
| 1135 | + "target": "com.amazonaws.redshiftdata#String", |
| 1136 | + "traits": { |
| 1137 | + "smithy.api#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>" |
| 1138 | + } |
| 1139 | + } |
| 1140 | + }, |
| 1141 | + "traits": { |
| 1142 | + "smithy.api#input": {} |
| 1143 | + } |
| 1144 | + }, |
| 1145 | + "com.amazonaws.redshiftdata#GetStatementResultV2Response": { |
| 1146 | + "type": "structure", |
| 1147 | + "members": { |
| 1148 | + "Records": { |
| 1149 | + "target": "com.amazonaws.redshiftdata#FormattedSqlRecords", |
| 1150 | + "traits": { |
| 1151 | + "smithy.api#documentation": "<p>The results of the SQL statement in CSV format.</p>", |
| 1152 | + "smithy.api#required": {} |
| 1153 | + } |
| 1154 | + }, |
| 1155 | + "ColumnMetadata": { |
| 1156 | + "target": "com.amazonaws.redshiftdata#ColumnMetadataList", |
| 1157 | + "traits": { |
| 1158 | + "smithy.api#documentation": "<p>The properties (metadata) of a column.</p>" |
| 1159 | + } |
| 1160 | + }, |
| 1161 | + "TotalNumRows": { |
| 1162 | + "target": "com.amazonaws.redshiftdata#Long", |
| 1163 | + "traits": { |
| 1164 | + "smithy.api#default": 0, |
| 1165 | + "smithy.api#documentation": "<p>The total number of rows in the result set returned from a query. \n You can use this number to estimate the number of calls to the <code>GetStatementResultV2</code> operation needed to page through the results. </p>" |
| 1166 | + } |
| 1167 | + }, |
| 1168 | + "ResultFormat": { |
| 1169 | + "target": "com.amazonaws.redshiftdata#ResultFormatString", |
| 1170 | + "traits": { |
| 1171 | + "smithy.api#documentation": "<p>The data format of the result of the SQL statement.</p>" |
| 1172 | + } |
| 1173 | + }, |
| 1174 | + "NextToken": { |
| 1175 | + "target": "com.amazonaws.redshiftdata#String", |
| 1176 | + "traits": { |
| 1177 | + "smithy.api#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>" |
| 1178 | + } |
| 1179 | + } |
| 1180 | + }, |
| 1181 | + "traits": { |
| 1182 | + "smithy.api#output": {} |
| 1183 | + } |
| 1184 | + }, |
1072 | 1185 | "com.amazonaws.redshiftdata#Integer": { |
1073 | 1186 | "type": "integer", |
1074 | 1187 | "traits": { |
|
1564 | 1677 | } |
1565 | 1678 | } |
1566 | 1679 | }, |
| 1680 | + "com.amazonaws.redshiftdata#QueryRecords": { |
| 1681 | + "type": "union", |
| 1682 | + "members": { |
| 1683 | + "CSVRecords": { |
| 1684 | + "target": "com.amazonaws.redshiftdata#String", |
| 1685 | + "traits": { |
| 1686 | + "smithy.api#documentation": "<p>The results of the SQL statement in CSV format.</p>" |
| 1687 | + } |
| 1688 | + } |
| 1689 | + }, |
| 1690 | + "traits": { |
| 1691 | + "smithy.api#documentation": "<p>The results of the SQL statement.</p>" |
| 1692 | + } |
| 1693 | + }, |
1567 | 1694 | "com.amazonaws.redshiftdata#QueryTimeoutException": { |
1568 | 1695 | "type": "structure", |
1569 | 1696 | "members": { |
|
1599 | 1726 | { |
1600 | 1727 | "target": "com.amazonaws.redshiftdata#GetStatementResult" |
1601 | 1728 | }, |
| 1729 | + { |
| 1730 | + "target": "com.amazonaws.redshiftdata#GetStatementResultV2" |
| 1731 | + }, |
1602 | 1732 | { |
1603 | 1733 | "target": "com.amazonaws.redshiftdata#ListDatabases" |
1604 | 1734 | }, |
|
2278 | 2408 | "smithy.api#httpError": 404 |
2279 | 2409 | } |
2280 | 2410 | }, |
| 2411 | + "com.amazonaws.redshiftdata#ResultFormatString": { |
| 2412 | + "type": "string", |
| 2413 | + "traits": { |
| 2414 | + "smithy.api#enum": [ |
| 2415 | + { |
| 2416 | + "name": "JSON", |
| 2417 | + "value": "JSON" |
| 2418 | + }, |
| 2419 | + { |
| 2420 | + "name": "CSV", |
| 2421 | + "value": "CSV" |
| 2422 | + } |
| 2423 | + ] |
| 2424 | + } |
| 2425 | + }, |
2281 | 2426 | "com.amazonaws.redshiftdata#SchemaList": { |
2282 | 2427 | "type": "list", |
2283 | 2428 | "member": { |
|
2416 | 2561 | "traits": { |
2417 | 2562 | "smithy.api#documentation": "<p>The session identifier of the query.</p>" |
2418 | 2563 | } |
| 2564 | + }, |
| 2565 | + "ResultFormat": { |
| 2566 | + "target": "com.amazonaws.redshiftdata#ResultFormatString", |
| 2567 | + "traits": { |
| 2568 | + "smithy.api#documentation": "<p>The data format of the result of the SQL statement.</p>" |
| 2569 | + } |
2419 | 2570 | } |
2420 | 2571 | }, |
2421 | 2572 | "traits": { |
|
0 commit comments