Skip to content

Commit

Permalink
feat(client-redshift-data): The release include the new Redshift Data…
Browse files Browse the repository at this point in the history 
…API feature for session use, customer execute query with --session-keep-alive-seconds parameter and can submit follow-up queries to same sessions with returned`session-id`
  • Loading branch information
awstools committed Aug 30, 2024
1 parent 4723f34 commit fd2bbc5
Show file tree
Hide file tree
Showing 11 changed files with 450 additions and 62 deletions.
14 changes: 13 additions & 1 deletion clients/client-redshift-data/src/commands/BatchExecuteStatementCommand.ts
View file
Original file line number Diff line number Diff line change
Expand Up @@ -78,11 +78,13 @@ export interface BatchExecuteStatementCommandOutput extends BatchExecuteStatemen
* ClusterIdentifier: "STRING_VALUE",
* SecretArn: "STRING_VALUE",
* DbUser: "STRING_VALUE",
* Database: "STRING_VALUE", // required
* Database: "STRING_VALUE",
* WithEvent: true || false,
* StatementName: "STRING_VALUE",
* WorkgroupName: "STRING_VALUE",
* ClientToken: "STRING_VALUE",
* SessionKeepAliveSeconds: Number("int"),
* SessionId: "STRING_VALUE",
* };
* const command = new BatchExecuteStatementCommand(input);
* const response = await client.send(command);
Expand All @@ -91,9 +93,13 @@ export interface BatchExecuteStatementCommandOutput extends BatchExecuteStatemen
* // CreatedAt: new Date("TIMESTAMP"),
* // ClusterIdentifier: "STRING_VALUE",
* // DbUser: "STRING_VALUE",
* // DbGroups: [ // DbGroupList
* // "STRING_VALUE",
* // ],
* // Database: "STRING_VALUE",
* // SecretArn: "STRING_VALUE",
* // WorkgroupName: "STRING_VALUE",
* // SessionId: "STRING_VALUE",
* // };
*
* ```
Expand All @@ -104,12 +110,18 @@ export interface BatchExecuteStatementCommandOutput extends BatchExecuteStatemen
* @see {@link BatchExecuteStatementCommandOutput} for command's `response` shape.
* @see {@link RedshiftDataClientResolvedConfig | config} for RedshiftDataClient's `config` shape.
*
* @throws {@link ActiveSessionsExceededException} (client fault)
* <p>The Amazon Redshift Data API operation failed because the maximum number of active sessions exceeded.</p>
*
* @throws {@link ActiveStatementsExceededException} (client fault)
* <p>The number of active statements exceeds the limit.</p>
*
* @throws {@link BatchExecuteStatementException} (server fault)
* <p>An SQL statement encountered an environmental error while running.</p>
*
* @throws {@link InternalServerException} (server fault)
* <p>The Amazon Redshift Data API operation failed due to invalid input. </p>
*
* @throws {@link ValidationException} (client fault)
* <p>The Amazon Redshift Data API operation failed due to invalid input. </p>
*
Expand Down
1 change: 1 addition & 0 deletions clients/client-redshift-data/src/commands/DescribeStatementCommand.ts
View file
Original file line number Diff line number Diff line change
Expand Up @@ -84,6 +84,7 @@ export interface DescribeStatementCommandOutput extends DescribeStatementRespons
* // },
* // ],
* // WorkgroupName: "STRING_VALUE",
* // SessionId: "STRING_VALUE",
* // };
*
* ```
Expand Down
3 changes: 3 additions & 0 deletions clients/client-redshift-data/src/commands/DescribeTableCommand.ts
View file
Original file line number Diff line number Diff line change
Expand Up @@ -122,6 +122,9 @@ export interface DescribeTableCommandOutput extends DescribeTableResponse, __Met
* @throws {@link InternalServerException} (server fault)
* <p>The Amazon Redshift Data API operation failed due to invalid input. </p>
*
* @throws {@link QueryTimeoutException} (client fault)
* <p>The Amazon Redshift Data API operation failed due to timeout.</p>
*
* @throws {@link ValidationException} (client fault)
* <p>The Amazon Redshift Data API operation failed due to invalid input. </p>
*
Expand Down
14 changes: 13 additions & 1 deletion clients/client-redshift-data/src/commands/ExecuteStatementCommand.ts
View file
Original file line number Diff line number Diff line change
Expand Up @@ -76,7 +76,7 @@ export interface ExecuteStatementCommandOutput extends ExecuteStatementOutput, _
* ClusterIdentifier: "STRING_VALUE",
* SecretArn: "STRING_VALUE",
* DbUser: "STRING_VALUE",
* Database: "STRING_VALUE", // required
* Database: "STRING_VALUE",
* WithEvent: true || false,
* StatementName: "STRING_VALUE",
* Parameters: [ // SqlParametersList
Expand All @@ -87,6 +87,8 @@ export interface ExecuteStatementCommandOutput extends ExecuteStatementOutput, _
* ],
* WorkgroupName: "STRING_VALUE",
* ClientToken: "STRING_VALUE",
* SessionKeepAliveSeconds: Number("int"),
* SessionId: "STRING_VALUE",
* };
* const command = new ExecuteStatementCommand(input);
* const response = await client.send(command);
Expand All @@ -95,9 +97,13 @@ export interface ExecuteStatementCommandOutput extends ExecuteStatementOutput, _
* // CreatedAt: new Date("TIMESTAMP"),
* // ClusterIdentifier: "STRING_VALUE",
* // DbUser: "STRING_VALUE",
* // DbGroups: [ // DbGroupList
* // "STRING_VALUE",
* // ],
* // Database: "STRING_VALUE",
* // SecretArn: "STRING_VALUE",
* // WorkgroupName: "STRING_VALUE",
* // SessionId: "STRING_VALUE",
* // };
*
* ```
Expand All @@ -108,12 +114,18 @@ export interface ExecuteStatementCommandOutput extends ExecuteStatementOutput, _
* @see {@link ExecuteStatementCommandOutput} for command's `response` shape.
* @see {@link RedshiftDataClientResolvedConfig | config} for RedshiftDataClient's `config` shape.
*
* @throws {@link ActiveSessionsExceededException} (client fault)
* <p>The Amazon Redshift Data API operation failed because the maximum number of active sessions exceeded.</p>
*
* @throws {@link ActiveStatementsExceededException} (client fault)
* <p>The number of active statements exceeds the limit.</p>
*
* @throws {@link ExecuteStatementException} (server fault)
* <p>The SQL statement encountered an environmental error while running.</p>
*
* @throws {@link InternalServerException} (server fault)
* <p>The Amazon Redshift Data API operation failed due to invalid input. </p>
*
* @throws {@link ValidationException} (client fault)
* <p>The Amazon Redshift Data API operation failed due to invalid input. </p>
*
Expand Down
3 changes: 3 additions & 0 deletions clients/client-redshift-data/src/commands/ListDatabasesCommand.ts
View file
Original file line number Diff line number Diff line change
Expand Up @@ -103,6 +103,9 @@ export interface ListDatabasesCommandOutput extends ListDatabasesResponse, __Met
* @throws {@link InternalServerException} (server fault)
* <p>The Amazon Redshift Data API operation failed due to invalid input. </p>
*
* @throws {@link QueryTimeoutException} (client fault)
* <p>The Amazon Redshift Data API operation failed due to timeout.</p>
*
* @throws {@link ValidationException} (client fault)
* <p>The Amazon Redshift Data API operation failed due to invalid input. </p>
*
Expand Down
3 changes: 3 additions & 0 deletions clients/client-redshift-data/src/commands/ListSchemasCommand.ts
View file
Original file line number Diff line number Diff line change
Expand Up @@ -105,6 +105,9 @@ export interface ListSchemasCommandOutput extends ListSchemasResponse, __Metadat
* @throws {@link InternalServerException} (server fault)
* <p>The Amazon Redshift Data API operation failed due to invalid input. </p>
*
* @throws {@link QueryTimeoutException} (client fault)
* <p>The Amazon Redshift Data API operation failed due to timeout.</p>
*
* @throws {@link ValidationException} (client fault)
* <p>The Amazon Redshift Data API operation failed due to invalid input. </p>
*
Expand Down
1 change: 1 addition & 0 deletions clients/client-redshift-data/src/commands/ListStatementsCommand.ts
View file
Original file line number Diff line number Diff line change
Expand Up @@ -68,6 +68,7 @@ export interface ListStatementsCommandOutput extends ListStatementsResponse, __M
* // },
* // ],
* // IsBatchStatement: true || false,
* // SessionId: "STRING_VALUE",
* // },
* // ],
* // NextToken: "STRING_VALUE",
Expand Down
3 changes: 3 additions & 0 deletions clients/client-redshift-data/src/commands/ListTablesCommand.ts
View file
Original file line number Diff line number Diff line change
Expand Up @@ -111,6 +111,9 @@ export interface ListTablesCommandOutput extends ListTablesResponse, __MetadataB
* @throws {@link InternalServerException} (server fault)
* <p>The Amazon Redshift Data API operation failed due to invalid input. </p>
*
* @throws {@link QueryTimeoutException} (client fault)
* <p>The Amazon Redshift Data API operation failed due to timeout.</p>
*
* @throws {@link ValidationException} (client fault)
* <p>The Amazon Redshift Data API operation failed due to invalid input. </p>
*
Expand Down
Loading

0 comments on commit fd2bbc5

Please sign in to comment.