@aws-sdk/client-redshift-data 3.36.0 → 3.36.1
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.
- package/CHANGELOG.md +11 -0
- package/dist-cjs/RedshiftData.js +0 -7
- package/dist-cjs/RedshiftDataClient.js +0 -12
- package/dist-cjs/commands/BatchExecuteStatementCommand.js +0 -38
- package/dist-cjs/commands/CancelStatementCommand.js +0 -24
- package/dist-cjs/commands/DescribeStatementCommand.js +0 -26
- package/dist-cjs/commands/DescribeTableCommand.js +0 -39
- package/dist-cjs/commands/ExecuteStatementCommand.js +0 -38
- package/dist-cjs/commands/GetStatementResultCommand.js +0 -25
- package/dist-cjs/commands/ListDatabasesCommand.js +0 -38
- package/dist-cjs/commands/ListSchemasCommand.js +0 -38
- package/dist-cjs/commands/ListStatementsCommand.js +0 -25
- package/dist-cjs/commands/ListTablesCommand.js +0 -39
- package/dist-cjs/models/models_0.js +0 -96
- package/dist-cjs/pagination/DescribeTablePaginator.js +0 -10
- package/dist-cjs/pagination/GetStatementResultPaginator.js +0 -10
- package/dist-cjs/pagination/ListDatabasesPaginator.js +0 -10
- package/dist-cjs/pagination/ListSchemasPaginator.js +0 -10
- package/dist-cjs/pagination/ListStatementsPaginator.js +0 -10
- package/dist-cjs/pagination/ListTablesPaginator.js +0 -10
- package/dist-cjs/protocols/Aws_json1_1.js +0 -5
- package/dist-cjs/runtimeConfig.browser.js +1 -5
- package/dist-cjs/runtimeConfig.js +1 -5
- package/dist-cjs/runtimeConfig.native.js +0 -3
- package/dist-cjs/runtimeConfig.shared.js +0 -3
- package/dist-types/ts3.4/RedshiftData.d.ts +11 -127
- package/dist-types/ts3.4/RedshiftDataClient.d.ts +24 -93
- package/dist-types/ts3.4/commands/BatchExecuteStatementCommand.d.ts +2 -34
- package/dist-types/ts3.4/commands/CancelStatementCommand.d.ts +2 -20
- package/dist-types/ts3.4/commands/DescribeStatementCommand.d.ts +2 -22
- package/dist-types/ts3.4/commands/DescribeTableCommand.d.ts +2 -35
- package/dist-types/ts3.4/commands/ExecuteStatementCommand.d.ts +2 -34
- package/dist-types/ts3.4/commands/GetStatementResultCommand.d.ts +2 -21
- package/dist-types/ts3.4/commands/ListDatabasesCommand.d.ts +2 -34
- package/dist-types/ts3.4/commands/ListSchemasCommand.d.ts +2 -34
- package/dist-types/ts3.4/commands/ListStatementsCommand.d.ts +2 -21
- package/dist-types/ts3.4/commands/ListTablesCommand.d.ts +2 -35
- package/dist-types/ts3.4/models/models_0.d.ts +198 -688
- package/dist-types/ts3.4/runtimeConfig.browser.d.ts +1 -3
- package/dist-types/ts3.4/runtimeConfig.d.ts +1 -3
- package/dist-types/ts3.4/runtimeConfig.native.d.ts +1 -3
- package/dist-types/ts3.4/runtimeConfig.shared.d.ts +1 -3
- package/package.json +3 -3
|
@@ -10,161 +10,45 @@ import { ListSchemasCommandInput, ListSchemasCommandOutput } from "./commands/Li
|
|
|
10
10
|
import { ListStatementsCommandInput, ListStatementsCommandOutput } from "./commands/ListStatementsCommand";
|
|
11
11
|
import { ListTablesCommandInput, ListTablesCommandOutput } from "./commands/ListTablesCommand";
|
|
12
12
|
import { RedshiftDataClient } from "./RedshiftDataClient";
|
|
13
|
-
|
|
14
|
-
* <p>You can use the Amazon Redshift Data API to run queries on Amazon Redshift tables. You
|
|
15
|
-
* can run SQL statements, which are committed if the statement succeeds. </p>
|
|
16
|
-
* <p>For more information about the Amazon Redshift Data API, see
|
|
17
|
-
* <a href="https://docs.aws.amazon.com/redshift/latest/mgmt/data-api.html">Using the Amazon Redshift Data API</a> in the
|
|
18
|
-
* <i>Amazon Redshift Cluster Management Guide</i>. </p>
|
|
19
|
-
*/
|
|
13
|
+
|
|
20
14
|
export declare class RedshiftData extends RedshiftDataClient {
|
|
21
|
-
|
|
22
|
-
* <p>Runs one or more SQL statements, which can be data manipulation language (DML) or data definition
|
|
23
|
-
* language (DDL).
|
|
24
|
-
* Depending on the authorization
|
|
25
|
-
* method, use one of the following combinations of request parameters: </p>
|
|
26
|
-
* <ul>
|
|
27
|
-
* <li>
|
|
28
|
-
* <p>Secrets Manager - specify the Amazon Resource Name (ARN) of the secret, the database name, and the
|
|
29
|
-
* cluster identifier that matches the cluster in the secret. </p>
|
|
30
|
-
* </li>
|
|
31
|
-
* <li>
|
|
32
|
-
* <p>Temporary credentials - specify the cluster identifier, the database name, and the
|
|
33
|
-
* database user name. Permission to call the <code>redshift:GetClusterCredentials</code>
|
|
34
|
-
* operation is required to use this method. </p>
|
|
35
|
-
* </li>
|
|
36
|
-
* </ul>
|
|
37
|
-
*/
|
|
15
|
+
|
|
38
16
|
batchExecuteStatement(args: BatchExecuteStatementCommandInput, options?: __HttpHandlerOptions): Promise<BatchExecuteStatementCommandOutput>;
|
|
39
17
|
batchExecuteStatement(args: BatchExecuteStatementCommandInput, cb: (err: any, data?: BatchExecuteStatementCommandOutput) => void): void;
|
|
40
18
|
batchExecuteStatement(args: BatchExecuteStatementCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: BatchExecuteStatementCommandOutput) => void): void;
|
|
41
|
-
|
|
42
|
-
* <p>Cancels a running query. To be canceled, a query must be running. </p>
|
|
43
|
-
*/
|
|
19
|
+
|
|
44
20
|
cancelStatement(args: CancelStatementCommandInput, options?: __HttpHandlerOptions): Promise<CancelStatementCommandOutput>;
|
|
45
21
|
cancelStatement(args: CancelStatementCommandInput, cb: (err: any, data?: CancelStatementCommandOutput) => void): void;
|
|
46
22
|
cancelStatement(args: CancelStatementCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: CancelStatementCommandOutput) => void): void;
|
|
47
|
-
|
|
48
|
-
* <p>Describes the details about a specific instance when a query was run by the Amazon Redshift Data API. The information
|
|
49
|
-
* includes when the query started, when it finished, the query status, the number of rows returned, and the SQL
|
|
50
|
-
* statement. </p>
|
|
51
|
-
*/
|
|
23
|
+
|
|
52
24
|
describeStatement(args: DescribeStatementCommandInput, options?: __HttpHandlerOptions): Promise<DescribeStatementCommandOutput>;
|
|
53
25
|
describeStatement(args: DescribeStatementCommandInput, cb: (err: any, data?: DescribeStatementCommandOutput) => void): void;
|
|
54
26
|
describeStatement(args: DescribeStatementCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DescribeStatementCommandOutput) => void): void;
|
|
55
|
-
|
|
56
|
-
* <p>Describes the detailed information about a table from metadata in the cluster. The
|
|
57
|
-
* information includes its columns.
|
|
58
|
-
* A token is returned to page through the column list.
|
|
59
|
-
* Depending on the authorization method, use one of the
|
|
60
|
-
* following combinations of request parameters: </p>
|
|
61
|
-
* <ul>
|
|
62
|
-
* <li>
|
|
63
|
-
* <p>Secrets Manager - specify the Amazon Resource Name (ARN) of the secret, the database name, and the
|
|
64
|
-
* cluster identifier that matches the cluster in the secret. </p>
|
|
65
|
-
* </li>
|
|
66
|
-
* <li>
|
|
67
|
-
* <p>Temporary credentials - specify the cluster identifier, the database name, and the database
|
|
68
|
-
* user name. Permission to call the <code>redshift:GetClusterCredentials</code> operation is
|
|
69
|
-
* required to use this method. </p>
|
|
70
|
-
* </li>
|
|
71
|
-
* </ul>
|
|
72
|
-
*/
|
|
27
|
+
|
|
73
28
|
describeTable(args: DescribeTableCommandInput, options?: __HttpHandlerOptions): Promise<DescribeTableCommandOutput>;
|
|
74
29
|
describeTable(args: DescribeTableCommandInput, cb: (err: any, data?: DescribeTableCommandOutput) => void): void;
|
|
75
30
|
describeTable(args: DescribeTableCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DescribeTableCommandOutput) => void): void;
|
|
76
|
-
|
|
77
|
-
* <p>Runs an SQL statement, which can be data manipulation language (DML) or data definition
|
|
78
|
-
* language (DDL). This statement must be a single SQL statement.
|
|
79
|
-
* Depending on the authorization
|
|
80
|
-
* method, use one of the following combinations of request parameters: </p>
|
|
81
|
-
* <ul>
|
|
82
|
-
* <li>
|
|
83
|
-
* <p>Secrets Manager - specify the Amazon Resource Name (ARN) of the secret, the database name, and the
|
|
84
|
-
* cluster identifier that matches the cluster in the secret. </p>
|
|
85
|
-
* </li>
|
|
86
|
-
* <li>
|
|
87
|
-
* <p>Temporary credentials - specify the cluster identifier, the database name, and the
|
|
88
|
-
* database user name. Permission to call the <code>redshift:GetClusterCredentials</code>
|
|
89
|
-
* operation is required to use this method. </p>
|
|
90
|
-
* </li>
|
|
91
|
-
* </ul>
|
|
92
|
-
*/
|
|
31
|
+
|
|
93
32
|
executeStatement(args: ExecuteStatementCommandInput, options?: __HttpHandlerOptions): Promise<ExecuteStatementCommandOutput>;
|
|
94
33
|
executeStatement(args: ExecuteStatementCommandInput, cb: (err: any, data?: ExecuteStatementCommandOutput) => void): void;
|
|
95
34
|
executeStatement(args: ExecuteStatementCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ExecuteStatementCommandOutput) => void): void;
|
|
96
|
-
|
|
97
|
-
* <p>Fetches the temporarily cached result of an SQL statement.
|
|
98
|
-
* A token is returned to page through the statement results. </p>
|
|
99
|
-
*/
|
|
35
|
+
|
|
100
36
|
getStatementResult(args: GetStatementResultCommandInput, options?: __HttpHandlerOptions): Promise<GetStatementResultCommandOutput>;
|
|
101
37
|
getStatementResult(args: GetStatementResultCommandInput, cb: (err: any, data?: GetStatementResultCommandOutput) => void): void;
|
|
102
38
|
getStatementResult(args: GetStatementResultCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetStatementResultCommandOutput) => void): void;
|
|
103
|
-
|
|
104
|
-
* <p>List the databases in a cluster.
|
|
105
|
-
* A token is returned to page through the database list.
|
|
106
|
-
* Depending on the authorization method, use one of the
|
|
107
|
-
* following combinations of request parameters: </p>
|
|
108
|
-
* <ul>
|
|
109
|
-
* <li>
|
|
110
|
-
* <p>Secrets Manager - specify the Amazon Resource Name (ARN) of the secret, the database name, and the
|
|
111
|
-
* cluster identifier that matches the cluster in the secret. </p>
|
|
112
|
-
* </li>
|
|
113
|
-
* <li>
|
|
114
|
-
* <p>Temporary credentials - specify the cluster identifier, the database name, and the
|
|
115
|
-
* database user name. Permission to call the <code>redshift:GetClusterCredentials</code>
|
|
116
|
-
* operation is required to use this method. </p>
|
|
117
|
-
* </li>
|
|
118
|
-
* </ul>
|
|
119
|
-
*/
|
|
39
|
+
|
|
120
40
|
listDatabases(args: ListDatabasesCommandInput, options?: __HttpHandlerOptions): Promise<ListDatabasesCommandOutput>;
|
|
121
41
|
listDatabases(args: ListDatabasesCommandInput, cb: (err: any, data?: ListDatabasesCommandOutput) => void): void;
|
|
122
42
|
listDatabases(args: ListDatabasesCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListDatabasesCommandOutput) => void): void;
|
|
123
|
-
|
|
124
|
-
* <p>Lists the schemas in a database.
|
|
125
|
-
* A token is returned to page through the schema list.
|
|
126
|
-
* Depending on the authorization method, use one of the
|
|
127
|
-
* following combinations of request parameters: </p>
|
|
128
|
-
* <ul>
|
|
129
|
-
* <li>
|
|
130
|
-
* <p>Secrets Manager - specify the Amazon Resource Name (ARN) of the secret, the database name, and the
|
|
131
|
-
* cluster identifier that matches the cluster in the secret. </p>
|
|
132
|
-
* </li>
|
|
133
|
-
* <li>
|
|
134
|
-
* <p>Temporary credentials - specify the cluster identifier, the database name, and the
|
|
135
|
-
* database user name. Permission to call the <code>redshift:GetClusterCredentials</code>
|
|
136
|
-
* operation is required to use this method. </p>
|
|
137
|
-
* </li>
|
|
138
|
-
* </ul>
|
|
139
|
-
*/
|
|
43
|
+
|
|
140
44
|
listSchemas(args: ListSchemasCommandInput, options?: __HttpHandlerOptions): Promise<ListSchemasCommandOutput>;
|
|
141
45
|
listSchemas(args: ListSchemasCommandInput, cb: (err: any, data?: ListSchemasCommandOutput) => void): void;
|
|
142
46
|
listSchemas(args: ListSchemasCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListSchemasCommandOutput) => void): void;
|
|
143
|
-
|
|
144
|
-
* <p>List of SQL statements. By default, only finished statements are shown.
|
|
145
|
-
* A token is returned to page through the statement list. </p>
|
|
146
|
-
*/
|
|
47
|
+
|
|
147
48
|
listStatements(args: ListStatementsCommandInput, options?: __HttpHandlerOptions): Promise<ListStatementsCommandOutput>;
|
|
148
49
|
listStatements(args: ListStatementsCommandInput, cb: (err: any, data?: ListStatementsCommandOutput) => void): void;
|
|
149
50
|
listStatements(args: ListStatementsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListStatementsCommandOutput) => void): void;
|
|
150
|
-
|
|
151
|
-
* <p>List the tables in a database. If neither <code>SchemaPattern</code> nor <code>TablePattern</code> are specified, then
|
|
152
|
-
* all tables in the database are returned.
|
|
153
|
-
* A token is returned to page through the table list.
|
|
154
|
-
* Depending on the authorization method, use one of the
|
|
155
|
-
* following combinations of request parameters: </p>
|
|
156
|
-
* <ul>
|
|
157
|
-
* <li>
|
|
158
|
-
* <p>Secrets Manager - specify the Amazon Resource Name (ARN) of the secret, the database name, and the
|
|
159
|
-
* cluster identifier that matches the cluster in the secret. </p>
|
|
160
|
-
* </li>
|
|
161
|
-
* <li>
|
|
162
|
-
* <p>Temporary credentials - specify the cluster identifier, the database name, and the
|
|
163
|
-
* database user name. Permission to call the <code>redshift:GetClusterCredentials</code>
|
|
164
|
-
* operation is required to use this method. </p>
|
|
165
|
-
* </li>
|
|
166
|
-
* </ul>
|
|
167
|
-
*/
|
|
51
|
+
|
|
168
52
|
listTables(args: ListTablesCommandInput, options?: __HttpHandlerOptions): Promise<ListTablesCommandOutput>;
|
|
169
53
|
listTables(args: ListTablesCommandInput, cb: (err: any, data?: ListTablesCommandOutput) => void): void;
|
|
170
54
|
listTables(args: ListTablesCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListTablesCommandOutput) => void): void;
|
|
@@ -19,128 +19,59 @@ import { ListTablesCommandInput, ListTablesCommandOutput } from "./commands/List
|
|
|
19
19
|
export declare type ServiceInputTypes = BatchExecuteStatementCommandInput | CancelStatementCommandInput | DescribeStatementCommandInput | DescribeTableCommandInput | ExecuteStatementCommandInput | GetStatementResultCommandInput | ListDatabasesCommandInput | ListSchemasCommandInput | ListStatementsCommandInput | ListTablesCommandInput;
|
|
20
20
|
export declare type ServiceOutputTypes = BatchExecuteStatementCommandOutput | CancelStatementCommandOutput | DescribeStatementCommandOutput | DescribeTableCommandOutput | ExecuteStatementCommandOutput | GetStatementResultCommandOutput | ListDatabasesCommandOutput | ListSchemasCommandOutput | ListStatementsCommandOutput | ListTablesCommandOutput;
|
|
21
21
|
export interface ClientDefaults extends Partial<__SmithyResolvedConfiguration<__HttpHandlerOptions>> {
|
|
22
|
-
|
|
23
|
-
* The HTTP handler to use. Fetch in browser and Https in Nodejs.
|
|
24
|
-
*/
|
|
22
|
+
|
|
25
23
|
requestHandler?: __HttpHandler;
|
|
26
|
-
|
|
27
|
-
* A constructor for a class implementing the {@link __Hash} interface
|
|
28
|
-
* that computes the SHA-256 HMAC or checksum of a string or binary buffer.
|
|
29
|
-
* @internal
|
|
30
|
-
*/
|
|
24
|
+
|
|
31
25
|
sha256?: __HashConstructor;
|
|
32
|
-
|
|
33
|
-
* The function that will be used to convert strings into HTTP endpoints.
|
|
34
|
-
* @internal
|
|
35
|
-
*/
|
|
26
|
+
|
|
36
27
|
urlParser?: __UrlParser;
|
|
37
|
-
|
|
38
|
-
* A function that can calculate the length of a request body.
|
|
39
|
-
* @internal
|
|
40
|
-
*/
|
|
28
|
+
|
|
41
29
|
bodyLengthChecker?: (body: any) => number | undefined;
|
|
42
|
-
|
|
43
|
-
* A function that converts a stream into an array of bytes.
|
|
44
|
-
* @internal
|
|
45
|
-
*/
|
|
30
|
+
|
|
46
31
|
streamCollector?: __StreamCollector;
|
|
47
|
-
|
|
48
|
-
* The function that will be used to convert a base64-encoded string to a byte array.
|
|
49
|
-
* @internal
|
|
50
|
-
*/
|
|
32
|
+
|
|
51
33
|
base64Decoder?: __Decoder;
|
|
52
|
-
|
|
53
|
-
* The function that will be used to convert binary data to a base64-encoded string.
|
|
54
|
-
* @internal
|
|
55
|
-
*/
|
|
34
|
+
|
|
56
35
|
base64Encoder?: __Encoder;
|
|
57
|
-
|
|
58
|
-
* The function that will be used to convert a UTF8-encoded string to a byte array.
|
|
59
|
-
* @internal
|
|
60
|
-
*/
|
|
36
|
+
|
|
61
37
|
utf8Decoder?: __Decoder;
|
|
62
|
-
|
|
63
|
-
* The function that will be used to convert binary data to a UTF-8 encoded string.
|
|
64
|
-
* @internal
|
|
65
|
-
*/
|
|
38
|
+
|
|
66
39
|
utf8Encoder?: __Encoder;
|
|
67
|
-
|
|
68
|
-
* The runtime environment.
|
|
69
|
-
* @internal
|
|
70
|
-
*/
|
|
40
|
+
|
|
71
41
|
runtime?: string;
|
|
72
|
-
|
|
73
|
-
* Disable dyanamically changing the endpoint of the client based on the hostPrefix
|
|
74
|
-
* trait of an operation.
|
|
75
|
-
*/
|
|
42
|
+
|
|
76
43
|
disableHostPrefix?: boolean;
|
|
77
|
-
|
|
78
|
-
* Value for how many times a request will be made at most in case of retry.
|
|
79
|
-
*/
|
|
44
|
+
|
|
80
45
|
maxAttempts?: number | __Provider<number>;
|
|
81
|
-
|
|
82
|
-
* Specifies which retry algorithm to use.
|
|
83
|
-
*/
|
|
46
|
+
|
|
84
47
|
retryMode?: string | __Provider<string>;
|
|
85
|
-
|
|
86
|
-
* Optional logger for logging debug/info/warn/error.
|
|
87
|
-
*/
|
|
48
|
+
|
|
88
49
|
logger?: __Logger;
|
|
89
|
-
|
|
90
|
-
* Unique service identifier.
|
|
91
|
-
* @internal
|
|
92
|
-
*/
|
|
50
|
+
|
|
93
51
|
serviceId?: string;
|
|
94
|
-
|
|
95
|
-
* The AWS region to which this client will send requests
|
|
96
|
-
*/
|
|
52
|
+
|
|
97
53
|
region?: string | __Provider<string>;
|
|
98
|
-
|
|
99
|
-
* Default credentials provider; Not available in browser runtime.
|
|
100
|
-
* @internal
|
|
101
|
-
*/
|
|
54
|
+
|
|
102
55
|
credentialDefaultProvider?: (input: any) => __Provider<__Credentials>;
|
|
103
|
-
|
|
104
|
-
* Fetch related hostname, signing name or signing region with given region.
|
|
105
|
-
* @internal
|
|
106
|
-
*/
|
|
56
|
+
|
|
107
57
|
regionInfoProvider?: RegionInfoProvider;
|
|
108
|
-
|
|
109
|
-
* The provider populating default tracking information to be sent with `user-agent`, `x-amz-user-agent` header
|
|
110
|
-
* @internal
|
|
111
|
-
*/
|
|
58
|
+
|
|
112
59
|
defaultUserAgentProvider?: Provider<__UserAgent>;
|
|
113
60
|
}
|
|
114
61
|
declare type RedshiftDataClientConfigType = Partial<__SmithyConfiguration<__HttpHandlerOptions>> & ClientDefaults & RegionInputConfig & EndpointsInputConfig & RetryInputConfig & HostHeaderInputConfig & AwsAuthInputConfig & UserAgentInputConfig;
|
|
115
|
-
|
|
116
|
-
* The configuration interface of RedshiftDataClient class constructor that set the region, credentials and other options.
|
|
117
|
-
*/
|
|
62
|
+
|
|
118
63
|
export interface RedshiftDataClientConfig extends RedshiftDataClientConfigType {
|
|
119
64
|
}
|
|
120
65
|
declare type RedshiftDataClientResolvedConfigType = __SmithyResolvedConfiguration<__HttpHandlerOptions> & Required<ClientDefaults> & RegionResolvedConfig & EndpointsResolvedConfig & RetryResolvedConfig & HostHeaderResolvedConfig & AwsAuthResolvedConfig & UserAgentResolvedConfig;
|
|
121
|
-
|
|
122
|
-
* The resolved configuration interface of RedshiftDataClient class. This is resolved and normalized from the {@link RedshiftDataClientConfig | constructor configuration interface}.
|
|
123
|
-
*/
|
|
66
|
+
|
|
124
67
|
export interface RedshiftDataClientResolvedConfig extends RedshiftDataClientResolvedConfigType {
|
|
125
68
|
}
|
|
126
|
-
|
|
127
|
-
* <p>You can use the Amazon Redshift Data API to run queries on Amazon Redshift tables. You
|
|
128
|
-
* can run SQL statements, which are committed if the statement succeeds. </p>
|
|
129
|
-
* <p>For more information about the Amazon Redshift Data API, see
|
|
130
|
-
* <a href="https://docs.aws.amazon.com/redshift/latest/mgmt/data-api.html">Using the Amazon Redshift Data API</a> in the
|
|
131
|
-
* <i>Amazon Redshift Cluster Management Guide</i>. </p>
|
|
132
|
-
*/
|
|
69
|
+
|
|
133
70
|
export declare class RedshiftDataClient extends __Client<__HttpHandlerOptions, ServiceInputTypes, ServiceOutputTypes, RedshiftDataClientResolvedConfig> {
|
|
134
|
-
|
|
135
|
-
* The resolved configuration of RedshiftDataClient class. This is resolved and normalized from the {@link RedshiftDataClientConfig | constructor configuration interface}.
|
|
136
|
-
*/
|
|
71
|
+
|
|
137
72
|
readonly config: RedshiftDataClientResolvedConfig;
|
|
138
73
|
constructor(configuration: RedshiftDataClientConfig);
|
|
139
|
-
|
|
140
|
-
* Destroy underlying resources, like sockets. It's usually not necessary to do this.
|
|
141
|
-
* However in Node.js, it's best to explicitly shut down the client's agent when it is no longer needed.
|
|
142
|
-
* Otherwise, sockets might stay open for quite a long time before the server terminates them.
|
|
143
|
-
*/
|
|
74
|
+
|
|
144
75
|
destroy(): void;
|
|
145
76
|
}
|
|
146
77
|
export {};
|
|
@@ -6,43 +6,11 @@ export interface BatchExecuteStatementCommandInput extends BatchExecuteStatement
|
|
|
6
6
|
}
|
|
7
7
|
export interface BatchExecuteStatementCommandOutput extends BatchExecuteStatementOutput, __MetadataBearer {
|
|
8
8
|
}
|
|
9
|
-
|
|
10
|
-
* <p>Runs one or more SQL statements, which can be data manipulation language (DML) or data definition
|
|
11
|
-
* language (DDL).
|
|
12
|
-
* Depending on the authorization
|
|
13
|
-
* method, use one of the following combinations of request parameters: </p>
|
|
14
|
-
* <ul>
|
|
15
|
-
* <li>
|
|
16
|
-
* <p>Secrets Manager - specify the Amazon Resource Name (ARN) of the secret, the database name, and the
|
|
17
|
-
* cluster identifier that matches the cluster in the secret. </p>
|
|
18
|
-
* </li>
|
|
19
|
-
* <li>
|
|
20
|
-
* <p>Temporary credentials - specify the cluster identifier, the database name, and the
|
|
21
|
-
* database user name. Permission to call the <code>redshift:GetClusterCredentials</code>
|
|
22
|
-
* operation is required to use this method. </p>
|
|
23
|
-
* </li>
|
|
24
|
-
* </ul>
|
|
25
|
-
* @example
|
|
26
|
-
* Use a bare-bones client and the command you need to make an API call.
|
|
27
|
-
* ```javascript
|
|
28
|
-
* import { RedshiftDataClient, BatchExecuteStatementCommand } from "@aws-sdk/client-redshift-data"; // ES Modules import
|
|
29
|
-
* // const { RedshiftDataClient, BatchExecuteStatementCommand } = require("@aws-sdk/client-redshift-data"); // CommonJS import
|
|
30
|
-
* const client = new RedshiftDataClient(config);
|
|
31
|
-
* const command = new BatchExecuteStatementCommand(input);
|
|
32
|
-
* const response = await client.send(command);
|
|
33
|
-
* ```
|
|
34
|
-
*
|
|
35
|
-
* @see {@link BatchExecuteStatementCommandInput} for command's `input` shape.
|
|
36
|
-
* @see {@link BatchExecuteStatementCommandOutput} for command's `response` shape.
|
|
37
|
-
* @see {@link RedshiftDataClientResolvedConfig | config} for command's `input` shape.
|
|
38
|
-
*
|
|
39
|
-
*/
|
|
9
|
+
|
|
40
10
|
export declare class BatchExecuteStatementCommand extends $Command<BatchExecuteStatementCommandInput, BatchExecuteStatementCommandOutput, RedshiftDataClientResolvedConfig> {
|
|
41
11
|
readonly input: BatchExecuteStatementCommandInput;
|
|
42
12
|
constructor(input: BatchExecuteStatementCommandInput);
|
|
43
|
-
|
|
44
|
-
* @internal
|
|
45
|
-
*/
|
|
13
|
+
|
|
46
14
|
resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: RedshiftDataClientResolvedConfig, options?: __HttpHandlerOptions): Handler<BatchExecuteStatementCommandInput, BatchExecuteStatementCommandOutput>;
|
|
47
15
|
private serialize;
|
|
48
16
|
private deserialize;
|
|
@@ -6,29 +6,11 @@ export interface CancelStatementCommandInput extends CancelStatementRequest {
|
|
|
6
6
|
}
|
|
7
7
|
export interface CancelStatementCommandOutput extends CancelStatementResponse, __MetadataBearer {
|
|
8
8
|
}
|
|
9
|
-
|
|
10
|
-
* <p>Cancels a running query. To be canceled, a query must be running. </p>
|
|
11
|
-
* @example
|
|
12
|
-
* Use a bare-bones client and the command you need to make an API call.
|
|
13
|
-
* ```javascript
|
|
14
|
-
* import { RedshiftDataClient, CancelStatementCommand } from "@aws-sdk/client-redshift-data"; // ES Modules import
|
|
15
|
-
* // const { RedshiftDataClient, CancelStatementCommand } = require("@aws-sdk/client-redshift-data"); // CommonJS import
|
|
16
|
-
* const client = new RedshiftDataClient(config);
|
|
17
|
-
* const command = new CancelStatementCommand(input);
|
|
18
|
-
* const response = await client.send(command);
|
|
19
|
-
* ```
|
|
20
|
-
*
|
|
21
|
-
* @see {@link CancelStatementCommandInput} for command's `input` shape.
|
|
22
|
-
* @see {@link CancelStatementCommandOutput} for command's `response` shape.
|
|
23
|
-
* @see {@link RedshiftDataClientResolvedConfig | config} for command's `input` shape.
|
|
24
|
-
*
|
|
25
|
-
*/
|
|
9
|
+
|
|
26
10
|
export declare class CancelStatementCommand extends $Command<CancelStatementCommandInput, CancelStatementCommandOutput, RedshiftDataClientResolvedConfig> {
|
|
27
11
|
readonly input: CancelStatementCommandInput;
|
|
28
12
|
constructor(input: CancelStatementCommandInput);
|
|
29
|
-
|
|
30
|
-
* @internal
|
|
31
|
-
*/
|
|
13
|
+
|
|
32
14
|
resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: RedshiftDataClientResolvedConfig, options?: __HttpHandlerOptions): Handler<CancelStatementCommandInput, CancelStatementCommandOutput>;
|
|
33
15
|
private serialize;
|
|
34
16
|
private deserialize;
|
|
@@ -6,31 +6,11 @@ export interface DescribeStatementCommandInput extends DescribeStatementRequest
|
|
|
6
6
|
}
|
|
7
7
|
export interface DescribeStatementCommandOutput extends DescribeStatementResponse, __MetadataBearer {
|
|
8
8
|
}
|
|
9
|
-
|
|
10
|
-
* <p>Describes the details about a specific instance when a query was run by the Amazon Redshift Data API. The information
|
|
11
|
-
* includes when the query started, when it finished, the query status, the number of rows returned, and the SQL
|
|
12
|
-
* statement. </p>
|
|
13
|
-
* @example
|
|
14
|
-
* Use a bare-bones client and the command you need to make an API call.
|
|
15
|
-
* ```javascript
|
|
16
|
-
* import { RedshiftDataClient, DescribeStatementCommand } from "@aws-sdk/client-redshift-data"; // ES Modules import
|
|
17
|
-
* // const { RedshiftDataClient, DescribeStatementCommand } = require("@aws-sdk/client-redshift-data"); // CommonJS import
|
|
18
|
-
* const client = new RedshiftDataClient(config);
|
|
19
|
-
* const command = new DescribeStatementCommand(input);
|
|
20
|
-
* const response = await client.send(command);
|
|
21
|
-
* ```
|
|
22
|
-
*
|
|
23
|
-
* @see {@link DescribeStatementCommandInput} for command's `input` shape.
|
|
24
|
-
* @see {@link DescribeStatementCommandOutput} for command's `response` shape.
|
|
25
|
-
* @see {@link RedshiftDataClientResolvedConfig | config} for command's `input` shape.
|
|
26
|
-
*
|
|
27
|
-
*/
|
|
9
|
+
|
|
28
10
|
export declare class DescribeStatementCommand extends $Command<DescribeStatementCommandInput, DescribeStatementCommandOutput, RedshiftDataClientResolvedConfig> {
|
|
29
11
|
readonly input: DescribeStatementCommandInput;
|
|
30
12
|
constructor(input: DescribeStatementCommandInput);
|
|
31
|
-
|
|
32
|
-
* @internal
|
|
33
|
-
*/
|
|
13
|
+
|
|
34
14
|
resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: RedshiftDataClientResolvedConfig, options?: __HttpHandlerOptions): Handler<DescribeStatementCommandInput, DescribeStatementCommandOutput>;
|
|
35
15
|
private serialize;
|
|
36
16
|
private deserialize;
|
|
@@ -6,44 +6,11 @@ export interface DescribeTableCommandInput extends DescribeTableRequest {
|
|
|
6
6
|
}
|
|
7
7
|
export interface DescribeTableCommandOutput extends DescribeTableResponse, __MetadataBearer {
|
|
8
8
|
}
|
|
9
|
-
|
|
10
|
-
* <p>Describes the detailed information about a table from metadata in the cluster. The
|
|
11
|
-
* information includes its columns.
|
|
12
|
-
* A token is returned to page through the column list.
|
|
13
|
-
* Depending on the authorization method, use one of the
|
|
14
|
-
* following combinations of request parameters: </p>
|
|
15
|
-
* <ul>
|
|
16
|
-
* <li>
|
|
17
|
-
* <p>Secrets Manager - specify the Amazon Resource Name (ARN) of the secret, the database name, and the
|
|
18
|
-
* cluster identifier that matches the cluster in the secret. </p>
|
|
19
|
-
* </li>
|
|
20
|
-
* <li>
|
|
21
|
-
* <p>Temporary credentials - specify the cluster identifier, the database name, and the database
|
|
22
|
-
* user name. Permission to call the <code>redshift:GetClusterCredentials</code> operation is
|
|
23
|
-
* required to use this method. </p>
|
|
24
|
-
* </li>
|
|
25
|
-
* </ul>
|
|
26
|
-
* @example
|
|
27
|
-
* Use a bare-bones client and the command you need to make an API call.
|
|
28
|
-
* ```javascript
|
|
29
|
-
* import { RedshiftDataClient, DescribeTableCommand } from "@aws-sdk/client-redshift-data"; // ES Modules import
|
|
30
|
-
* // const { RedshiftDataClient, DescribeTableCommand } = require("@aws-sdk/client-redshift-data"); // CommonJS import
|
|
31
|
-
* const client = new RedshiftDataClient(config);
|
|
32
|
-
* const command = new DescribeTableCommand(input);
|
|
33
|
-
* const response = await client.send(command);
|
|
34
|
-
* ```
|
|
35
|
-
*
|
|
36
|
-
* @see {@link DescribeTableCommandInput} for command's `input` shape.
|
|
37
|
-
* @see {@link DescribeTableCommandOutput} for command's `response` shape.
|
|
38
|
-
* @see {@link RedshiftDataClientResolvedConfig | config} for command's `input` shape.
|
|
39
|
-
*
|
|
40
|
-
*/
|
|
9
|
+
|
|
41
10
|
export declare class DescribeTableCommand extends $Command<DescribeTableCommandInput, DescribeTableCommandOutput, RedshiftDataClientResolvedConfig> {
|
|
42
11
|
readonly input: DescribeTableCommandInput;
|
|
43
12
|
constructor(input: DescribeTableCommandInput);
|
|
44
|
-
|
|
45
|
-
* @internal
|
|
46
|
-
*/
|
|
13
|
+
|
|
47
14
|
resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: RedshiftDataClientResolvedConfig, options?: __HttpHandlerOptions): Handler<DescribeTableCommandInput, DescribeTableCommandOutput>;
|
|
48
15
|
private serialize;
|
|
49
16
|
private deserialize;
|
|
@@ -6,43 +6,11 @@ export interface ExecuteStatementCommandInput extends ExecuteStatementInput {
|
|
|
6
6
|
}
|
|
7
7
|
export interface ExecuteStatementCommandOutput extends ExecuteStatementOutput, __MetadataBearer {
|
|
8
8
|
}
|
|
9
|
-
|
|
10
|
-
* <p>Runs an SQL statement, which can be data manipulation language (DML) or data definition
|
|
11
|
-
* language (DDL). This statement must be a single SQL statement.
|
|
12
|
-
* Depending on the authorization
|
|
13
|
-
* method, use one of the following combinations of request parameters: </p>
|
|
14
|
-
* <ul>
|
|
15
|
-
* <li>
|
|
16
|
-
* <p>Secrets Manager - specify the Amazon Resource Name (ARN) of the secret, the database name, and the
|
|
17
|
-
* cluster identifier that matches the cluster in the secret. </p>
|
|
18
|
-
* </li>
|
|
19
|
-
* <li>
|
|
20
|
-
* <p>Temporary credentials - specify the cluster identifier, the database name, and the
|
|
21
|
-
* database user name. Permission to call the <code>redshift:GetClusterCredentials</code>
|
|
22
|
-
* operation is required to use this method. </p>
|
|
23
|
-
* </li>
|
|
24
|
-
* </ul>
|
|
25
|
-
* @example
|
|
26
|
-
* Use a bare-bones client and the command you need to make an API call.
|
|
27
|
-
* ```javascript
|
|
28
|
-
* import { RedshiftDataClient, ExecuteStatementCommand } from "@aws-sdk/client-redshift-data"; // ES Modules import
|
|
29
|
-
* // const { RedshiftDataClient, ExecuteStatementCommand } = require("@aws-sdk/client-redshift-data"); // CommonJS import
|
|
30
|
-
* const client = new RedshiftDataClient(config);
|
|
31
|
-
* const command = new ExecuteStatementCommand(input);
|
|
32
|
-
* const response = await client.send(command);
|
|
33
|
-
* ```
|
|
34
|
-
*
|
|
35
|
-
* @see {@link ExecuteStatementCommandInput} for command's `input` shape.
|
|
36
|
-
* @see {@link ExecuteStatementCommandOutput} for command's `response` shape.
|
|
37
|
-
* @see {@link RedshiftDataClientResolvedConfig | config} for command's `input` shape.
|
|
38
|
-
*
|
|
39
|
-
*/
|
|
9
|
+
|
|
40
10
|
export declare class ExecuteStatementCommand extends $Command<ExecuteStatementCommandInput, ExecuteStatementCommandOutput, RedshiftDataClientResolvedConfig> {
|
|
41
11
|
readonly input: ExecuteStatementCommandInput;
|
|
42
12
|
constructor(input: ExecuteStatementCommandInput);
|
|
43
|
-
|
|
44
|
-
* @internal
|
|
45
|
-
*/
|
|
13
|
+
|
|
46
14
|
resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: RedshiftDataClientResolvedConfig, options?: __HttpHandlerOptions): Handler<ExecuteStatementCommandInput, ExecuteStatementCommandOutput>;
|
|
47
15
|
private serialize;
|
|
48
16
|
private deserialize;
|
|
@@ -6,30 +6,11 @@ export interface GetStatementResultCommandInput extends GetStatementResultReques
|
|
|
6
6
|
}
|
|
7
7
|
export interface GetStatementResultCommandOutput extends GetStatementResultResponse, __MetadataBearer {
|
|
8
8
|
}
|
|
9
|
-
|
|
10
|
-
* <p>Fetches the temporarily cached result of an SQL statement.
|
|
11
|
-
* A token is returned to page through the statement results. </p>
|
|
12
|
-
* @example
|
|
13
|
-
* Use a bare-bones client and the command you need to make an API call.
|
|
14
|
-
* ```javascript
|
|
15
|
-
* import { RedshiftDataClient, GetStatementResultCommand } from "@aws-sdk/client-redshift-data"; // ES Modules import
|
|
16
|
-
* // const { RedshiftDataClient, GetStatementResultCommand } = require("@aws-sdk/client-redshift-data"); // CommonJS import
|
|
17
|
-
* const client = new RedshiftDataClient(config);
|
|
18
|
-
* const command = new GetStatementResultCommand(input);
|
|
19
|
-
* const response = await client.send(command);
|
|
20
|
-
* ```
|
|
21
|
-
*
|
|
22
|
-
* @see {@link GetStatementResultCommandInput} for command's `input` shape.
|
|
23
|
-
* @see {@link GetStatementResultCommandOutput} for command's `response` shape.
|
|
24
|
-
* @see {@link RedshiftDataClientResolvedConfig | config} for command's `input` shape.
|
|
25
|
-
*
|
|
26
|
-
*/
|
|
9
|
+
|
|
27
10
|
export declare class GetStatementResultCommand extends $Command<GetStatementResultCommandInput, GetStatementResultCommandOutput, RedshiftDataClientResolvedConfig> {
|
|
28
11
|
readonly input: GetStatementResultCommandInput;
|
|
29
12
|
constructor(input: GetStatementResultCommandInput);
|
|
30
|
-
|
|
31
|
-
* @internal
|
|
32
|
-
*/
|
|
13
|
+
|
|
33
14
|
resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: RedshiftDataClientResolvedConfig, options?: __HttpHandlerOptions): Handler<GetStatementResultCommandInput, GetStatementResultCommandOutput>;
|
|
34
15
|
private serialize;
|
|
35
16
|
private deserialize;
|
|
@@ -6,43 +6,11 @@ export interface ListDatabasesCommandInput extends ListDatabasesRequest {
|
|
|
6
6
|
}
|
|
7
7
|
export interface ListDatabasesCommandOutput extends ListDatabasesResponse, __MetadataBearer {
|
|
8
8
|
}
|
|
9
|
-
|
|
10
|
-
* <p>List the databases in a cluster.
|
|
11
|
-
* A token is returned to page through the database list.
|
|
12
|
-
* Depending on the authorization method, use one of the
|
|
13
|
-
* following combinations of request parameters: </p>
|
|
14
|
-
* <ul>
|
|
15
|
-
* <li>
|
|
16
|
-
* <p>Secrets Manager - specify the Amazon Resource Name (ARN) of the secret, the database name, and the
|
|
17
|
-
* cluster identifier that matches the cluster in the secret. </p>
|
|
18
|
-
* </li>
|
|
19
|
-
* <li>
|
|
20
|
-
* <p>Temporary credentials - specify the cluster identifier, the database name, and the
|
|
21
|
-
* database user name. Permission to call the <code>redshift:GetClusterCredentials</code>
|
|
22
|
-
* operation is required to use this method. </p>
|
|
23
|
-
* </li>
|
|
24
|
-
* </ul>
|
|
25
|
-
* @example
|
|
26
|
-
* Use a bare-bones client and the command you need to make an API call.
|
|
27
|
-
* ```javascript
|
|
28
|
-
* import { RedshiftDataClient, ListDatabasesCommand } from "@aws-sdk/client-redshift-data"; // ES Modules import
|
|
29
|
-
* // const { RedshiftDataClient, ListDatabasesCommand } = require("@aws-sdk/client-redshift-data"); // CommonJS import
|
|
30
|
-
* const client = new RedshiftDataClient(config);
|
|
31
|
-
* const command = new ListDatabasesCommand(input);
|
|
32
|
-
* const response = await client.send(command);
|
|
33
|
-
* ```
|
|
34
|
-
*
|
|
35
|
-
* @see {@link ListDatabasesCommandInput} for command's `input` shape.
|
|
36
|
-
* @see {@link ListDatabasesCommandOutput} for command's `response` shape.
|
|
37
|
-
* @see {@link RedshiftDataClientResolvedConfig | config} for command's `input` shape.
|
|
38
|
-
*
|
|
39
|
-
*/
|
|
9
|
+
|
|
40
10
|
export declare class ListDatabasesCommand extends $Command<ListDatabasesCommandInput, ListDatabasesCommandOutput, RedshiftDataClientResolvedConfig> {
|
|
41
11
|
readonly input: ListDatabasesCommandInput;
|
|
42
12
|
constructor(input: ListDatabasesCommandInput);
|
|
43
|
-
|
|
44
|
-
* @internal
|
|
45
|
-
*/
|
|
13
|
+
|
|
46
14
|
resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: RedshiftDataClientResolvedConfig, options?: __HttpHandlerOptions): Handler<ListDatabasesCommandInput, ListDatabasesCommandOutput>;
|
|
47
15
|
private serialize;
|
|
48
16
|
private deserialize;
|