@aws-sdk/client-redshift-data 3.325.0 → 3.327.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (11) hide show
  1. package/dist-types/commands/BatchExecuteStatementCommand.d.ts +12 -0
  2. package/dist-types/commands/CancelStatementCommand.d.ts +6 -0
  3. package/dist-types/commands/DescribeStatementCommand.d.ts +43 -0
  4. package/dist-types/commands/DescribeTableCommand.d.ts +24 -0
  5. package/dist-types/commands/ExecuteStatementCommand.d.ts +12 -0
  6. package/dist-types/commands/GetStatementResultCommand.d.ts +36 -0
  7. package/dist-types/commands/ListDatabasesCommand.d.ts +9 -0
  8. package/dist-types/commands/ListSchemasCommand.d.ts +9 -0
  9. package/dist-types/commands/ListStatementsCommand.d.ts +27 -0
  10. package/dist-types/commands/ListTablesCommand.d.ts +13 -0
  11. package/package.json +7 -7
package/dist-types/commands/BatchExecuteStatementCommand.d.ts CHANGED
@@ -77,6 +77,16 @@ export interface BatchExecuteStatementCommandOutput extends BatchExecuteStatemen
77
77
  * };
78
78
  * const command = new BatchExecuteStatementCommand(input);
79
79
  * const response = await client.send(command);
80
+ * // { // BatchExecuteStatementOutput
81
+ * // Id: "STRING_VALUE",
82
+ * // CreatedAt: new Date("TIMESTAMP"),
83
+ * // ClusterIdentifier: "STRING_VALUE",
84
+ * // DbUser: "STRING_VALUE",
85
+ * // Database: "STRING_VALUE",
86
+ * // SecretArn: "STRING_VALUE",
87
+ * // WorkgroupName: "STRING_VALUE",
88
+ * // };
89
+ *
80
90
  * ```
81
91
  *
82
92
  * @param BatchExecuteStatementCommandInput - {@link BatchExecuteStatementCommandInput}
@@ -94,6 +104,8 @@ export interface BatchExecuteStatementCommandOutput extends BatchExecuteStatemen
94
104
  * @throws {@link ValidationException} (client fault)
95
105
  * <p>The Amazon Redshift Data API operation failed due to invalid input. </p>
96
106
  *
107
+ * @throws {@link RedshiftDataServiceException}
108
+ * <p>Base exception class for all service exceptions from RedshiftData service.</p>
97
109
  *
98
110
  */
99
111
  export declare class BatchExecuteStatementCommand extends $Command<BatchExecuteStatementCommandInput, BatchExecuteStatementCommandOutput, RedshiftDataClientResolvedConfig> {
package/dist-types/commands/CancelStatementCommand.d.ts CHANGED
@@ -34,6 +34,10 @@ export interface CancelStatementCommandOutput extends CancelStatementResponse, _
34
34
  * };
35
35
  * const command = new CancelStatementCommand(input);
36
36
  * const response = await client.send(command);
37
+ * // { // CancelStatementResponse
38
+ * // Status: true || false,
39
+ * // };
40
+ *
37
41
  * ```
38
42
  *
39
43
  * @param CancelStatementCommandInput - {@link CancelStatementCommandInput}
@@ -54,6 +58,8 @@ export interface CancelStatementCommandOutput extends CancelStatementResponse, _
54
58
  * @throws {@link ValidationException} (client fault)
55
59
  * <p>The Amazon Redshift Data API operation failed due to invalid input. </p>
56
60
  *
61
+ * @throws {@link RedshiftDataServiceException}
62
+ * <p>Base exception class for all service exceptions from RedshiftData service.</p>
57
63
  *
58
64
  */
59
65
  export declare class CancelStatementCommand extends $Command<CancelStatementCommandInput, CancelStatementCommandOutput, RedshiftDataClientResolvedConfig> {
package/dist-types/commands/DescribeStatementCommand.d.ts CHANGED
@@ -36,6 +36,47 @@ export interface DescribeStatementCommandOutput extends DescribeStatementRespons
36
36
  * };
37
37
  * const command = new DescribeStatementCommand(input);
38
38
  * const response = await client.send(command);
39
+ * // { // DescribeStatementResponse
40
+ * // Id: "STRING_VALUE", // required
41
+ * // SecretArn: "STRING_VALUE",
42
+ * // DbUser: "STRING_VALUE",
43
+ * // Database: "STRING_VALUE",
44
+ * // ClusterIdentifier: "STRING_VALUE",
45
+ * // Duration: Number("long"),
46
+ * // Error: "STRING_VALUE",
47
+ * // Status: "STRING_VALUE",
48
+ * // CreatedAt: new Date("TIMESTAMP"),
49
+ * // UpdatedAt: new Date("TIMESTAMP"),
50
+ * // RedshiftPid: Number("long"),
51
+ * // HasResultSet: true || false,
52
+ * // QueryString: "STRING_VALUE",
53
+ * // ResultRows: Number("long"),
54
+ * // ResultSize: Number("long"),
55
+ * // RedshiftQueryId: Number("long"),
56
+ * // QueryParameters: [ // SqlParametersList
57
+ * // { // SqlParameter
58
+ * // name: "STRING_VALUE", // required
59
+ * // value: "STRING_VALUE", // required
60
+ * // },
61
+ * // ],
62
+ * // SubStatements: [ // SubStatementList
63
+ * // { // SubStatementData
64
+ * // Id: "STRING_VALUE", // required
65
+ * // Duration: Number("long"),
66
+ * // Error: "STRING_VALUE",
67
+ * // Status: "STRING_VALUE",
68
+ * // CreatedAt: new Date("TIMESTAMP"),
69
+ * // UpdatedAt: new Date("TIMESTAMP"),
70
+ * // QueryString: "STRING_VALUE",
71
+ * // ResultRows: Number("long"),
72
+ * // ResultSize: Number("long"),
73
+ * // RedshiftQueryId: Number("long"),
74
+ * // HasResultSet: true || false,
75
+ * // },
76
+ * // ],
77
+ * // WorkgroupName: "STRING_VALUE",
78
+ * // };
79
+ *
39
80
  * ```
40
81
  *
41
82
  * @param DescribeStatementCommandInput - {@link DescribeStatementCommandInput}
@@ -53,6 +94,8 @@ export interface DescribeStatementCommandOutput extends DescribeStatementRespons
53
94
  * @throws {@link ValidationException} (client fault)
54
95
  * <p>The Amazon Redshift Data API operation failed due to invalid input. </p>
55
96
  *
97
+ * @throws {@link RedshiftDataServiceException}
98
+ * <p>Base exception class for all service exceptions from RedshiftData service.</p>
56
99
  *
57
100
  */
58
101
  export declare class DescribeStatementCommand extends $Command<DescribeStatementCommandInput, DescribeStatementCommandOutput, RedshiftDataClientResolvedConfig> {
package/dist-types/commands/DescribeTableCommand.d.ts CHANGED
@@ -77,6 +77,28 @@ export interface DescribeTableCommandOutput extends DescribeTableResponse, __Met
77
77
  * };
78
78
  * const command = new DescribeTableCommand(input);
79
79
  * const response = await client.send(command);
80
+ * // { // DescribeTableResponse
81
+ * // TableName: "STRING_VALUE",
82
+ * // ColumnList: [ // ColumnList
83
+ * // { // ColumnMetadata
84
+ * // isCaseSensitive: true || false,
85
+ * // isCurrency: true || false,
86
+ * // isSigned: true || false,
87
+ * // label: "STRING_VALUE",
88
+ * // name: "STRING_VALUE",
89
+ * // nullable: Number("int"),
90
+ * // precision: Number("int"),
91
+ * // scale: Number("int"),
92
+ * // schemaName: "STRING_VALUE",
93
+ * // tableName: "STRING_VALUE",
94
+ * // typeName: "STRING_VALUE",
95
+ * // length: Number("int"),
96
+ * // columnDefault: "STRING_VALUE",
97
+ * // },
98
+ * // ],
99
+ * // NextToken: "STRING_VALUE",
100
+ * // };
101
+ *
80
102
  * ```
81
103
  *
82
104
  * @param DescribeTableCommandInput - {@link DescribeTableCommandInput}
@@ -94,6 +116,8 @@ export interface DescribeTableCommandOutput extends DescribeTableResponse, __Met
94
116
  * @throws {@link ValidationException} (client fault)
95
117
  * <p>The Amazon Redshift Data API operation failed due to invalid input. </p>
96
118
  *
119
+ * @throws {@link RedshiftDataServiceException}
120
+ * <p>Base exception class for all service exceptions from RedshiftData service.</p>
97
121
  *
98
122
  */
99
123
  export declare class DescribeTableCommand extends $Command<DescribeTableCommandInput, DescribeTableCommandOutput, RedshiftDataClientResolvedConfig> {
package/dist-types/commands/ExecuteStatementCommand.d.ts CHANGED
@@ -81,6 +81,16 @@ export interface ExecuteStatementCommandOutput extends ExecuteStatementOutput, _
81
81
  * };
82
82
  * const command = new ExecuteStatementCommand(input);
83
83
  * const response = await client.send(command);
84
+ * // { // ExecuteStatementOutput
85
+ * // Id: "STRING_VALUE",
86
+ * // CreatedAt: new Date("TIMESTAMP"),
87
+ * // ClusterIdentifier: "STRING_VALUE",
88
+ * // DbUser: "STRING_VALUE",
89
+ * // Database: "STRING_VALUE",
90
+ * // SecretArn: "STRING_VALUE",
91
+ * // WorkgroupName: "STRING_VALUE",
92
+ * // };
93
+ *
84
94
  * ```
85
95
  *
86
96
  * @param ExecuteStatementCommandInput - {@link ExecuteStatementCommandInput}
@@ -98,6 +108,8 @@ export interface ExecuteStatementCommandOutput extends ExecuteStatementOutput, _
98
108
  * @throws {@link ValidationException} (client fault)
99
109
  * <p>The Amazon Redshift Data API operation failed due to invalid input. </p>
100
110
  *
111
+ * @throws {@link RedshiftDataServiceException}
112
+ * <p>Base exception class for all service exceptions from RedshiftData service.</p>
101
113
  *
102
114
  */
103
115
  export declare class ExecuteStatementCommand extends $Command<ExecuteStatementCommandInput, ExecuteStatementCommandOutput, RedshiftDataClientResolvedConfig> {
package/dist-types/commands/GetStatementResultCommand.d.ts CHANGED
@@ -36,6 +36,40 @@ export interface GetStatementResultCommandOutput extends GetStatementResultRespo
36
36
  * };
37
37
  * const command = new GetStatementResultCommand(input);
38
38
  * const response = await client.send(command);
39
+ * // { // GetStatementResultResponse
40
+ * // Records: [ // SqlRecords // required
41
+ * // [ // FieldList
42
+ * // { // Field Union: only one key present
43
+ * // isNull: true || false,
44
+ * // booleanValue: true || false,
45
+ * // longValue: Number("long"),
46
+ * // doubleValue: Number("double"),
47
+ * // stringValue: "STRING_VALUE",
48
+ * // blobValue: "BLOB_VALUE",
49
+ * // },
50
+ * // ],
51
+ * // ],
52
+ * // ColumnMetadata: [ // ColumnMetadataList
53
+ * // { // ColumnMetadata
54
+ * // isCaseSensitive: true || false,
55
+ * // isCurrency: true || false,
56
+ * // isSigned: true || false,
57
+ * // label: "STRING_VALUE",
58
+ * // name: "STRING_VALUE",
59
+ * // nullable: Number("int"),
60
+ * // precision: Number("int"),
61
+ * // scale: Number("int"),
62
+ * // schemaName: "STRING_VALUE",
63
+ * // tableName: "STRING_VALUE",
64
+ * // typeName: "STRING_VALUE",
65
+ * // length: Number("int"),
66
+ * // columnDefault: "STRING_VALUE",
67
+ * // },
68
+ * // ],
69
+ * // TotalNumRows: Number("long"),
70
+ * // NextToken: "STRING_VALUE",
71
+ * // };
72
+ *
39
73
  * ```
40
74
  *
41
75
  * @param GetStatementResultCommandInput - {@link GetStatementResultCommandInput}
@@ -53,6 +87,8 @@ export interface GetStatementResultCommandOutput extends GetStatementResultRespo
53
87
  * @throws {@link ValidationException} (client fault)
54
88
  * <p>The Amazon Redshift Data API operation failed due to invalid input. </p>
55
89
  *
90
+ * @throws {@link RedshiftDataServiceException}
91
+ * <p>Base exception class for all service exceptions from RedshiftData service.</p>
56
92
  *
57
93
  */
58
94
  export declare class GetStatementResultCommand extends $Command<GetStatementResultCommandInput, GetStatementResultCommandOutput, RedshiftDataClientResolvedConfig> {
package/dist-types/commands/ListDatabasesCommand.d.ts CHANGED
@@ -73,6 +73,13 @@ export interface ListDatabasesCommandOutput extends ListDatabasesResponse, __Met
73
73
  * };
74
74
  * const command = new ListDatabasesCommand(input);
75
75
  * const response = await client.send(command);
76
+ * // { // ListDatabasesResponse
77
+ * // Databases: [ // DatabaseList
78
+ * // "STRING_VALUE",
79
+ * // ],
80
+ * // NextToken: "STRING_VALUE",
81
+ * // };
82
+ *
76
83
  * ```
77
84
  *
78
85
  * @param ListDatabasesCommandInput - {@link ListDatabasesCommandInput}
@@ -90,6 +97,8 @@ export interface ListDatabasesCommandOutput extends ListDatabasesResponse, __Met
90
97
  * @throws {@link ValidationException} (client fault)
91
98
  * <p>The Amazon Redshift Data API operation failed due to invalid input. </p>
92
99
  *
100
+ * @throws {@link RedshiftDataServiceException}
101
+ * <p>Base exception class for all service exceptions from RedshiftData service.</p>
93
102
  *
94
103
  */
95
104
  export declare class ListDatabasesCommand extends $Command<ListDatabasesCommandInput, ListDatabasesCommandOutput, RedshiftDataClientResolvedConfig> {
package/dist-types/commands/ListSchemasCommand.d.ts CHANGED
@@ -75,6 +75,13 @@ export interface ListSchemasCommandOutput extends ListSchemasResponse, __Metadat
75
75
  * };
76
76
  * const command = new ListSchemasCommand(input);
77
77
  * const response = await client.send(command);
78
+ * // { // ListSchemasResponse
79
+ * // Schemas: [ // SchemaList
80
+ * // "STRING_VALUE",
81
+ * // ],
82
+ * // NextToken: "STRING_VALUE",
83
+ * // };
84
+ *
78
85
  * ```
79
86
  *
80
87
  * @param ListSchemasCommandInput - {@link ListSchemasCommandInput}
@@ -92,6 +99,8 @@ export interface ListSchemasCommandOutput extends ListSchemasResponse, __Metadat
92
99
  * @throws {@link ValidationException} (client fault)
93
100
  * <p>The Amazon Redshift Data API operation failed due to invalid input. </p>
94
101
  *
102
+ * @throws {@link RedshiftDataServiceException}
103
+ * <p>Base exception class for all service exceptions from RedshiftData service.</p>
95
104
  *
96
105
  */
97
106
  export declare class ListSchemasCommand extends $Command<ListSchemasCommandInput, ListSchemasCommandOutput, RedshiftDataClientResolvedConfig> {
package/dist-types/commands/ListStatementsCommand.d.ts CHANGED
@@ -39,6 +39,31 @@ export interface ListStatementsCommandOutput extends ListStatementsResponse, __M
39
39
  * };
40
40
  * const command = new ListStatementsCommand(input);
41
41
  * const response = await client.send(command);
42
+ * // { // ListStatementsResponse
43
+ * // Statements: [ // StatementList // required
44
+ * // { // StatementData
45
+ * // Id: "STRING_VALUE", // required
46
+ * // QueryString: "STRING_VALUE",
47
+ * // QueryStrings: [ // StatementStringList
48
+ * // "STRING_VALUE",
49
+ * // ],
50
+ * // SecretArn: "STRING_VALUE",
51
+ * // Status: "STRING_VALUE",
52
+ * // StatementName: "STRING_VALUE",
53
+ * // CreatedAt: new Date("TIMESTAMP"),
54
+ * // UpdatedAt: new Date("TIMESTAMP"),
55
+ * // QueryParameters: [ // SqlParametersList
56
+ * // { // SqlParameter
57
+ * // name: "STRING_VALUE", // required
58
+ * // value: "STRING_VALUE", // required
59
+ * // },
60
+ * // ],
61
+ * // IsBatchStatement: true || false,
62
+ * // },
63
+ * // ],
64
+ * // NextToken: "STRING_VALUE",
65
+ * // };
66
+ *
42
67
  * ```
43
68
  *
44
69
  * @param ListStatementsCommandInput - {@link ListStatementsCommandInput}
@@ -53,6 +78,8 @@ export interface ListStatementsCommandOutput extends ListStatementsResponse, __M
53
78
  * @throws {@link ValidationException} (client fault)
54
79
  * <p>The Amazon Redshift Data API operation failed due to invalid input. </p>
55
80
  *
81
+ * @throws {@link RedshiftDataServiceException}
82
+ * <p>Base exception class for all service exceptions from RedshiftData service.</p>
56
83
  *
57
84
  */
58
85
  export declare class ListStatementsCommand extends $Command<ListStatementsCommandInput, ListStatementsCommandOutput, RedshiftDataClientResolvedConfig> {
package/dist-types/commands/ListTablesCommand.d.ts CHANGED
@@ -77,6 +77,17 @@ export interface ListTablesCommandOutput extends ListTablesResponse, __MetadataB
77
77
  * };
78
78
  * const command = new ListTablesCommand(input);
79
79
  * const response = await client.send(command);
80
+ * // { // ListTablesResponse
81
+ * // Tables: [ // TableList
82
+ * // { // TableMember
83
+ * // name: "STRING_VALUE",
84
+ * // type: "STRING_VALUE",
85
+ * // schema: "STRING_VALUE",
86
+ * // },
87
+ * // ],
88
+ * // NextToken: "STRING_VALUE",
89
+ * // };
90
+ *
80
91
  * ```
81
92
  *
82
93
  * @param ListTablesCommandInput - {@link ListTablesCommandInput}
@@ -94,6 +105,8 @@ export interface ListTablesCommandOutput extends ListTablesResponse, __MetadataB
94
105
  * @throws {@link ValidationException} (client fault)
95
106
  * <p>The Amazon Redshift Data API operation failed due to invalid input. </p>
96
107
  *
108
+ * @throws {@link RedshiftDataServiceException}
109
+ * <p>Base exception class for all service exceptions from RedshiftData service.</p>
97
110
  *
98
111
  */
99
112
  export declare class ListTablesCommand extends $Command<ListTablesCommandInput, ListTablesCommandOutput, RedshiftDataClientResolvedConfig> {
package/package.json CHANGED
@@ -1,7 +1,7 @@
1
1
  {
2
2
  "name": "@aws-sdk/client-redshift-data",
3
3
  "description": "AWS SDK for JavaScript Redshift Data Client for Node.js, Browser and React Native",
4
- "version": "3.325.0",
4
+ "version": "3.327.0",
5
5
  "scripts": {
6
6
  "build": "concurrently 'yarn:build:cjs' 'yarn:build:es' 'yarn:build:types'",
7
7
  "build:cjs": "tsc -p tsconfig.cjs.json",
@@ -21,9 +21,9 @@
21
21
  "dependencies": {
22
22
  "@aws-crypto/sha256-browser": "3.0.0",
23
23
  "@aws-crypto/sha256-js": "3.0.0",
24
- "@aws-sdk/client-sts": "3.325.0",
24
+ "@aws-sdk/client-sts": "3.327.0",
25
25
  "@aws-sdk/config-resolver": "3.310.0",
26
- "@aws-sdk/credential-provider-node": "3.325.0",
26
+ "@aws-sdk/credential-provider-node": "3.327.0",
27
27
  "@aws-sdk/fetch-http-handler": "3.310.0",
28
28
  "@aws-sdk/hash-node": "3.310.0",
29
29
  "@aws-sdk/invalid-dependency": "3.310.0",
@@ -32,11 +32,11 @@
32
32
  "@aws-sdk/middleware-host-header": "3.325.0",
33
33
  "@aws-sdk/middleware-logger": "3.325.0",
34
34
  "@aws-sdk/middleware-recursion-detection": "3.325.0",
35
- "@aws-sdk/middleware-retry": "3.325.0",
35
+ "@aws-sdk/middleware-retry": "3.327.0",
36
36
  "@aws-sdk/middleware-serde": "3.325.0",
37
37
  "@aws-sdk/middleware-signing": "3.325.0",
38
38
  "@aws-sdk/middleware-stack": "3.325.0",
39
- "@aws-sdk/middleware-user-agent": "3.325.0",
39
+ "@aws-sdk/middleware-user-agent": "3.327.0",
40
40
  "@aws-sdk/node-config-provider": "3.310.0",
41
41
  "@aws-sdk/node-http-handler": "3.321.1",
42
42
  "@aws-sdk/protocol-http": "3.310.0",
@@ -48,8 +48,8 @@
48
48
  "@aws-sdk/util-body-length-node": "3.310.0",
49
49
  "@aws-sdk/util-defaults-mode-browser": "3.325.0",
50
50
  "@aws-sdk/util-defaults-mode-node": "3.325.0",
51
- "@aws-sdk/util-endpoints": "3.319.0",
52
- "@aws-sdk/util-retry": "3.310.0",
51
+ "@aws-sdk/util-endpoints": "3.327.0",
52
+ "@aws-sdk/util-retry": "3.327.0",
53
53
  "@aws-sdk/util-user-agent-browser": "3.310.0",
54
54
  "@aws-sdk/util-user-agent-node": "3.310.0",
55
55
  "@aws-sdk/util-utf8": "3.310.0",