aws-sdk-redshiftdataapiservice 1.77.0 → 1.78.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.
- checksums.yaml +4 -4
- data/CHANGELOG.md +5 -0
- data/VERSION +1 -1
- data/lib/aws-sdk-redshiftdataapiservice/client.rb +178 -8
- data/lib/aws-sdk-redshiftdataapiservice/client_api.rb +73 -0
- data/lib/aws-sdk-redshiftdataapiservice/errors.rb +16 -0
- data/lib/aws-sdk-redshiftdataapiservice/types.rb +322 -15
- data/lib/aws-sdk-redshiftdataapiservice.rb +1 -1
- data/sig/client.rbs +36 -5
- data/sig/errors.rbs +3 -0
- data/sig/types.rbs +51 -0
- metadata +1 -1
checksums.yaml
CHANGED
|
@@ -1,7 +1,7 @@
|
|
|
1
1
|
---
|
|
2
2
|
SHA256:
|
|
3
|
-
metadata.gz:
|
|
4
|
-
data.tar.gz:
|
|
3
|
+
metadata.gz: 3aa913fc2a54e63353da22eedf164e22ae5df6d6ca4eb78b6572cb28acaf2ea8
|
|
4
|
+
data.tar.gz: 34f20de9b05f574a0fc0202d679795480dc5ba3f779aa7a5d282df84ccb5f536
|
|
5
5
|
SHA512:
|
|
6
|
-
metadata.gz:
|
|
7
|
-
data.tar.gz:
|
|
6
|
+
metadata.gz: 36b1498a44d3e375c39bf9f55c3a1e0ecdc50731f0b98f25aa98328c6685721f8a7e755e00f9b19ecc4d67677a928cddadc93cf2fbad442b4ecad84e2e9ff81a
|
|
7
|
+
data.tar.gz: d8082b486b15308df4bcdf2e0f7849bb4425e0355502015f21bd9552806c1de86fba4e103abbacd87540679fe9c857285489a4340ed40b0b730bb6c3852c98b7
|
data/CHANGELOG.md
CHANGED
|
@@ -1,6 +1,11 @@
|
|
|
1
1
|
Unreleased Changes
|
|
2
2
|
------------------
|
|
3
3
|
|
|
4
|
+
1.78.0 (2026-07-23)
|
|
5
|
+
------------------
|
|
6
|
+
|
|
7
|
+
* Feature - This release include long polling provids a new parameter wait-time-seconds to 5 API operations, new API ListSessions, and a new parameter execution-mode to BatchExecuteStatement
|
|
8
|
+
|
|
4
9
|
1.77.0 (2026-07-21)
|
|
5
10
|
------------------
|
|
6
11
|
|
data/VERSION
CHANGED
|
@@ -1 +1 @@
|
|
|
1
|
-
1.
|
|
1
|
+
1.78.0
|
|
@@ -525,11 +525,12 @@ module Aws::RedshiftDataAPIService
|
|
|
525
525
|
# [1]: https://docs.aws.amazon.com/redshift/latest/mgmt/data-api.html
|
|
526
526
|
#
|
|
527
527
|
# @option params [required, Array<String>] :sqls
|
|
528
|
-
# One or more SQL statements to run. The SQL statements
|
|
529
|
-
#
|
|
530
|
-
#
|
|
531
|
-
#
|
|
532
|
-
#
|
|
528
|
+
# One or more SQL statements to run. The SQL statements run serially in
|
|
529
|
+
# the order of the array. Subsequent SQL statements don't start until
|
|
530
|
+
# the previous statement in the array completes. By default, the SQL
|
|
531
|
+
# statements are run as a single transaction. If any SQL statement
|
|
532
|
+
# fails, all work is rolled back. To change this behavior, see the
|
|
533
|
+
# `ExecutionMode` parameter.
|
|
533
534
|
#
|
|
534
535
|
# @option params [String] :cluster_identifier
|
|
535
536
|
# The cluster identifier. This parameter is required when connecting to
|
|
@@ -558,8 +559,10 @@ module Aws::RedshiftDataAPIService
|
|
|
558
559
|
# you create them to identify the query.
|
|
559
560
|
#
|
|
560
561
|
# @option params [Array<Types::SqlParameter>] :parameters
|
|
561
|
-
# The parameters for the SQL statements. The parameters are
|
|
562
|
-
#
|
|
562
|
+
# The parameters for the SQL statements. The parameters are available to
|
|
563
|
+
# all SQL statements in the batch. Each statement can reference any
|
|
564
|
+
# subset of the provided parameters. Each provided parameter must be
|
|
565
|
+
# referenced by at least one SQL statement in the batch.
|
|
563
566
|
#
|
|
564
567
|
# @option params [String] :workgroup_name
|
|
565
568
|
# The serverless workgroup name or Amazon Resource Name (ARN). This
|
|
@@ -585,6 +588,19 @@ module Aws::RedshiftDataAPIService
|
|
|
585
588
|
# @option params [String] :session_id
|
|
586
589
|
# The session identifier of the query.
|
|
587
590
|
#
|
|
591
|
+
# @option params [String] :execution_mode
|
|
592
|
+
# Determines how the SQL statements in the batch are run. If set to
|
|
593
|
+
# `TRANSACTION` (the default), all SQL statements are run as a single
|
|
594
|
+
# transaction and they are committed or rolled back together. If set to
|
|
595
|
+
# `AUTO_COMMIT`, each SQL statement is committed individually, and a
|
|
596
|
+
# failure of one statement does not affect the others.
|
|
597
|
+
#
|
|
598
|
+
# @option params [Integer] :wait_time_seconds
|
|
599
|
+
# The number of seconds to wait for all SQL statements in the batch to
|
|
600
|
+
# complete execution before returning the response. If the SQL
|
|
601
|
+
# statements do not complete within the specified time, the response
|
|
602
|
+
# returns the current status. The maximum value is 30 seconds.
|
|
603
|
+
#
|
|
588
604
|
# @return [Types::BatchExecuteStatementOutput] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
|
589
605
|
#
|
|
590
606
|
# * {Types::BatchExecuteStatementOutput#id #id} => String
|
|
@@ -596,6 +612,9 @@ module Aws::RedshiftDataAPIService
|
|
|
596
612
|
# * {Types::BatchExecuteStatementOutput#secret_arn #secret_arn} => String
|
|
597
613
|
# * {Types::BatchExecuteStatementOutput#workgroup_name #workgroup_name} => String
|
|
598
614
|
# * {Types::BatchExecuteStatementOutput#session_id #session_id} => String
|
|
615
|
+
# * {Types::BatchExecuteStatementOutput#status #status} => String
|
|
616
|
+
# * {Types::BatchExecuteStatementOutput#redshift_pid #redshift_pid} => Integer
|
|
617
|
+
# * {Types::BatchExecuteStatementOutput#has_result_set #has_result_set} => Boolean
|
|
599
618
|
#
|
|
600
619
|
# @example Request syntax with placeholder values
|
|
601
620
|
#
|
|
@@ -618,6 +637,8 @@ module Aws::RedshiftDataAPIService
|
|
|
618
637
|
# result_format: "JSON", # accepts JSON, CSV
|
|
619
638
|
# session_keep_alive_seconds: 1,
|
|
620
639
|
# session_id: "UUID",
|
|
640
|
+
# execution_mode: "TRANSACTION", # accepts TRANSACTION, AUTO_COMMIT
|
|
641
|
+
# wait_time_seconds: 1,
|
|
621
642
|
# })
|
|
622
643
|
#
|
|
623
644
|
# @example Response structure
|
|
@@ -632,6 +653,9 @@ module Aws::RedshiftDataAPIService
|
|
|
632
653
|
# resp.secret_arn #=> String
|
|
633
654
|
# resp.workgroup_name #=> String
|
|
634
655
|
# resp.session_id #=> String
|
|
656
|
+
# resp.status #=> String, one of "SUBMITTED", "PICKED", "STARTED", "FINISHED", "ABORTED", "FAILED"
|
|
657
|
+
# resp.redshift_pid #=> Integer
|
|
658
|
+
# resp.has_result_set #=> Boolean
|
|
635
659
|
#
|
|
636
660
|
# @see http://docs.aws.amazon.com/goto/WebAPI/redshift-data-2019-12-20/BatchExecuteStatement AWS API Documentation
|
|
637
661
|
#
|
|
@@ -703,6 +727,11 @@ module Aws::RedshiftDataAPIService
|
|
|
703
727
|
# is returned by `BatchExecuteStatment`, `ExecuteStatement`, and
|
|
704
728
|
# `ListStatements`.
|
|
705
729
|
#
|
|
730
|
+
# @option params [Integer] :wait_time_seconds
|
|
731
|
+
# The number of seconds to wait for the SQL statement to complete
|
|
732
|
+
# execution before returning the description. The maximum value is 30
|
|
733
|
+
# seconds.
|
|
734
|
+
#
|
|
706
735
|
# @return [Types::DescribeStatementResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
|
707
736
|
#
|
|
708
737
|
# * {Types::DescribeStatementResponse#id #id} => String
|
|
@@ -726,11 +755,13 @@ module Aws::RedshiftDataAPIService
|
|
|
726
755
|
# * {Types::DescribeStatementResponse#workgroup_name #workgroup_name} => String
|
|
727
756
|
# * {Types::DescribeStatementResponse#result_format #result_format} => String
|
|
728
757
|
# * {Types::DescribeStatementResponse#session_id #session_id} => String
|
|
758
|
+
# * {Types::DescribeStatementResponse#execution_mode #execution_mode} => String
|
|
729
759
|
#
|
|
730
760
|
# @example Request syntax with placeholder values
|
|
731
761
|
#
|
|
732
762
|
# resp = client.describe_statement({
|
|
733
763
|
# id: "UUID", # required
|
|
764
|
+
# wait_time_seconds: 1,
|
|
734
765
|
# })
|
|
735
766
|
#
|
|
736
767
|
# @example Response structure
|
|
@@ -769,6 +800,7 @@ module Aws::RedshiftDataAPIService
|
|
|
769
800
|
# resp.workgroup_name #=> String
|
|
770
801
|
# resp.result_format #=> String, one of "JSON", "CSV"
|
|
771
802
|
# resp.session_id #=> String
|
|
803
|
+
# resp.execution_mode #=> String, one of "TRANSACTION", "AUTO_COMMIT"
|
|
772
804
|
#
|
|
773
805
|
# @see http://docs.aws.amazon.com/goto/WebAPI/redshift-data-2019-12-20/DescribeStatement AWS API Documentation
|
|
774
806
|
#
|
|
@@ -1022,6 +1054,12 @@ module Aws::RedshiftDataAPIService
|
|
|
1022
1054
|
# @option params [String] :session_id
|
|
1023
1055
|
# The session identifier of the query.
|
|
1024
1056
|
#
|
|
1057
|
+
# @option params [Integer] :wait_time_seconds
|
|
1058
|
+
# The number of seconds to wait for the SQL statement to complete
|
|
1059
|
+
# execution before returning the response. If the SQL statement does not
|
|
1060
|
+
# complete within the specified time, the response returns the current
|
|
1061
|
+
# status. The maximum value is 30 seconds.
|
|
1062
|
+
#
|
|
1025
1063
|
# @return [Types::ExecuteStatementOutput] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
|
1026
1064
|
#
|
|
1027
1065
|
# * {Types::ExecuteStatementOutput#id #id} => String
|
|
@@ -1033,6 +1071,9 @@ module Aws::RedshiftDataAPIService
|
|
|
1033
1071
|
# * {Types::ExecuteStatementOutput#secret_arn #secret_arn} => String
|
|
1034
1072
|
# * {Types::ExecuteStatementOutput#workgroup_name #workgroup_name} => String
|
|
1035
1073
|
# * {Types::ExecuteStatementOutput#session_id #session_id} => String
|
|
1074
|
+
# * {Types::ExecuteStatementOutput#status #status} => String
|
|
1075
|
+
# * {Types::ExecuteStatementOutput#redshift_pid #redshift_pid} => Integer
|
|
1076
|
+
# * {Types::ExecuteStatementOutput#has_result_set #has_result_set} => Boolean
|
|
1036
1077
|
#
|
|
1037
1078
|
# @example Request syntax with placeholder values
|
|
1038
1079
|
#
|
|
@@ -1055,6 +1096,7 @@ module Aws::RedshiftDataAPIService
|
|
|
1055
1096
|
# result_format: "JSON", # accepts JSON, CSV
|
|
1056
1097
|
# session_keep_alive_seconds: 1,
|
|
1057
1098
|
# session_id: "UUID",
|
|
1099
|
+
# wait_time_seconds: 1,
|
|
1058
1100
|
# })
|
|
1059
1101
|
#
|
|
1060
1102
|
# @example Response structure
|
|
@@ -1069,6 +1111,9 @@ module Aws::RedshiftDataAPIService
|
|
|
1069
1111
|
# resp.secret_arn #=> String
|
|
1070
1112
|
# resp.workgroup_name #=> String
|
|
1071
1113
|
# resp.session_id #=> String
|
|
1114
|
+
# resp.status #=> String, one of "SUBMITTED", "PICKED", "STARTED", "FINISHED", "ABORTED", "FAILED"
|
|
1115
|
+
# resp.redshift_pid #=> Integer
|
|
1116
|
+
# resp.has_result_set #=> Boolean
|
|
1072
1117
|
#
|
|
1073
1118
|
# @see http://docs.aws.amazon.com/goto/WebAPI/redshift-data-2019-12-20/ExecuteStatement AWS API Documentation
|
|
1074
1119
|
#
|
|
@@ -1110,6 +1155,11 @@ module Aws::RedshiftDataAPIService
|
|
|
1110
1155
|
# command. If the NextToken field is empty, all response records have
|
|
1111
1156
|
# been retrieved for the request.
|
|
1112
1157
|
#
|
|
1158
|
+
# @option params [Integer] :wait_time_seconds
|
|
1159
|
+
# The number of seconds to wait for the SQL statement to complete
|
|
1160
|
+
# execution before returning the result. The maximum value is 30
|
|
1161
|
+
# seconds.
|
|
1162
|
+
#
|
|
1113
1163
|
# @return [Types::GetStatementResultResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
|
1114
1164
|
#
|
|
1115
1165
|
# * {Types::GetStatementResultResponse#records #records} => Array<Array<Types::Field>>
|
|
@@ -1124,6 +1174,7 @@ module Aws::RedshiftDataAPIService
|
|
|
1124
1174
|
# resp = client.get_statement_result({
|
|
1125
1175
|
# id: "UUID", # required
|
|
1126
1176
|
# next_token: "String",
|
|
1177
|
+
# wait_time_seconds: 1,
|
|
1127
1178
|
# })
|
|
1128
1179
|
#
|
|
1129
1180
|
# @example Response structure
|
|
@@ -1192,6 +1243,11 @@ module Aws::RedshiftDataAPIService
|
|
|
1192
1243
|
# command. If the NextToken field is empty, all response records have
|
|
1193
1244
|
# been retrieved for the request.
|
|
1194
1245
|
#
|
|
1246
|
+
# @option params [Integer] :wait_time_seconds
|
|
1247
|
+
# The number of seconds to wait for the SQL statement to complete
|
|
1248
|
+
# execution before returning the result. The maximum value is 30
|
|
1249
|
+
# seconds.
|
|
1250
|
+
#
|
|
1195
1251
|
# @return [Types::GetStatementResultV2Response] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
|
1196
1252
|
#
|
|
1197
1253
|
# * {Types::GetStatementResultV2Response#records #records} => Array<Types::QueryRecords>
|
|
@@ -1207,6 +1263,7 @@ module Aws::RedshiftDataAPIService
|
|
|
1207
1263
|
# resp = client.get_statement_result_v2({
|
|
1208
1264
|
# id: "UUID", # required
|
|
1209
1265
|
# next_token: "String",
|
|
1266
|
+
# wait_time_seconds: 1,
|
|
1210
1267
|
# })
|
|
1211
1268
|
#
|
|
1212
1269
|
# @example Response structure
|
|
@@ -1477,6 +1534,119 @@ module Aws::RedshiftDataAPIService
|
|
|
1477
1534
|
req.send_request(options)
|
|
1478
1535
|
end
|
|
1479
1536
|
|
|
1537
|
+
# Lists the sessions that the caller created in the last 24 hours. By
|
|
1538
|
+
# default, only sessions with a status of `AVAILABLE` or `BUSY` are
|
|
1539
|
+
# returned. You can filter the results by session status, compute target
|
|
1540
|
+
# (cluster or serverless workgroup), or database. To retrieve the
|
|
1541
|
+
# metadata for a single session, provide the `SessionId` parameter. Use
|
|
1542
|
+
# `NextToken` to page through the session list.
|
|
1543
|
+
#
|
|
1544
|
+
# Returns only the sessions that the caller created. When
|
|
1545
|
+
# identity-enhanced role sessions are used, you must provide either the
|
|
1546
|
+
# `ClusterIdentifier` or `WorkgroupName` parameter to ensure that the
|
|
1547
|
+
# AWS IAM Identity Center user can only access the Amazon Redshift IAM
|
|
1548
|
+
# Identity Center applications they are assigned. For more information,
|
|
1549
|
+
# see [ Trusted identity propagation overview][1].
|
|
1550
|
+
#
|
|
1551
|
+
#
|
|
1552
|
+
#
|
|
1553
|
+
# [1]: https://docs.aws.amazon.com/singlesignon/latest/userguide/trustedidentitypropagation-overview.html
|
|
1554
|
+
#
|
|
1555
|
+
# @option params [String] :next_token
|
|
1556
|
+
# A value that indicates the starting point for the next set of response
|
|
1557
|
+
# records in a subsequent request. If a value is returned in a response,
|
|
1558
|
+
# you can retrieve the next set of records by providing this returned
|
|
1559
|
+
# NextToken value in the next NextToken parameter and retrying the
|
|
1560
|
+
# command. If the NextToken field is empty, all response records have
|
|
1561
|
+
# been retrieved for the request.
|
|
1562
|
+
#
|
|
1563
|
+
# @option params [Integer] :max_results
|
|
1564
|
+
# The maximum number of sessions to return in the response. If more
|
|
1565
|
+
# sessions exist than fit in one response, the operation returns
|
|
1566
|
+
# `NextToken` to paginate the results.
|
|
1567
|
+
#
|
|
1568
|
+
# @option params [String] :session_id
|
|
1569
|
+
# The identifier of a specific session to return metadata for. This
|
|
1570
|
+
# value is a universally unique identifier (UUID) generated by Amazon
|
|
1571
|
+
# Redshift Data API. When you provide `SessionId`, you can't specify
|
|
1572
|
+
# `Status`, `ClusterIdentifier`, `WorkgroupName`, or `Database`.
|
|
1573
|
+
#
|
|
1574
|
+
# @option params [String] :status
|
|
1575
|
+
# The status of the sessions to list. If no status is specified,
|
|
1576
|
+
# sessions with a status of `AVAILABLE` or `BUSY` are returned. Status
|
|
1577
|
+
# values are defined as follows:
|
|
1578
|
+
#
|
|
1579
|
+
# * AVAILABLE – The session is open and ready to run a SQL statement.
|
|
1580
|
+
#
|
|
1581
|
+
# * BUSY – The session is currently running a SQL statement.
|
|
1582
|
+
#
|
|
1583
|
+
# * CLOSED – The session is closed and can no longer run SQL statements.
|
|
1584
|
+
#
|
|
1585
|
+
# @option params [Boolean] :role_level
|
|
1586
|
+
# Specifies whether to return all sessions created by the caller's IAM
|
|
1587
|
+
# role, including sessions from previous IAM sessions. If false, only
|
|
1588
|
+
# sessions created in the current IAM session are returned. The default
|
|
1589
|
+
# is true.
|
|
1590
|
+
#
|
|
1591
|
+
# @option params [String] :cluster_identifier
|
|
1592
|
+
# The cluster identifier. Only sessions on this cluster are returned.
|
|
1593
|
+
# When providing `ClusterIdentifier`, then `WorkgroupName` can't be
|
|
1594
|
+
# specified.
|
|
1595
|
+
#
|
|
1596
|
+
# @option params [String] :workgroup_name
|
|
1597
|
+
# The serverless workgroup name or Amazon Resource Name (ARN). Only
|
|
1598
|
+
# sessions on this workgroup are returned. When providing
|
|
1599
|
+
# `WorkgroupName`, then `ClusterIdentifier` can't be specified.
|
|
1600
|
+
#
|
|
1601
|
+
# @option params [String] :database
|
|
1602
|
+
# The name of the database. Only sessions connected to this database are
|
|
1603
|
+
# returned.
|
|
1604
|
+
#
|
|
1605
|
+
# @return [Types::ListSessionsResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
|
1606
|
+
#
|
|
1607
|
+
# * {Types::ListSessionsResponse#sessions #sessions} => Array<Types::SessionData>
|
|
1608
|
+
# * {Types::ListSessionsResponse#next_token #next_token} => String
|
|
1609
|
+
#
|
|
1610
|
+
# The returned {Seahorse::Client::Response response} is a pageable response and is Enumerable. For details on usage see {Aws::PageableResponse PageableResponse}.
|
|
1611
|
+
#
|
|
1612
|
+
# @example Request syntax with placeholder values
|
|
1613
|
+
#
|
|
1614
|
+
# resp = client.list_sessions({
|
|
1615
|
+
# next_token: "String",
|
|
1616
|
+
# max_results: 1,
|
|
1617
|
+
# session_id: "UUID",
|
|
1618
|
+
# status: "AVAILABLE", # accepts AVAILABLE, BUSY, CLOSED
|
|
1619
|
+
# role_level: false,
|
|
1620
|
+
# cluster_identifier: "ClusterIdentifierString",
|
|
1621
|
+
# workgroup_name: "WorkgroupNameString",
|
|
1622
|
+
# database: "String",
|
|
1623
|
+
# })
|
|
1624
|
+
#
|
|
1625
|
+
# @example Response structure
|
|
1626
|
+
#
|
|
1627
|
+
# resp.sessions #=> Array
|
|
1628
|
+
# resp.sessions[0].session_id #=> String
|
|
1629
|
+
# resp.sessions[0].status #=> String, one of "AVAILABLE", "BUSY", "CLOSED"
|
|
1630
|
+
# resp.sessions[0].created_at #=> Time
|
|
1631
|
+
# resp.sessions[0].updated_at #=> Time
|
|
1632
|
+
# resp.sessions[0].database #=> String
|
|
1633
|
+
# resp.sessions[0].db_user #=> String
|
|
1634
|
+
# resp.sessions[0].cluster_identifier #=> String
|
|
1635
|
+
# resp.sessions[0].workgroup_name #=> String
|
|
1636
|
+
# resp.sessions[0].session_alive_seconds #=> Integer
|
|
1637
|
+
# resp.sessions[0].session_ttl #=> Time
|
|
1638
|
+
# resp.sessions[0].current_statement_id #=> String
|
|
1639
|
+
# resp.next_token #=> String
|
|
1640
|
+
#
|
|
1641
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/redshift-data-2019-12-20/ListSessions AWS API Documentation
|
|
1642
|
+
#
|
|
1643
|
+
# @overload list_sessions(params = {})
|
|
1644
|
+
# @param [Hash] params ({})
|
|
1645
|
+
def list_sessions(params = {}, options = {})
|
|
1646
|
+
req = build_request(:list_sessions, params)
|
|
1647
|
+
req.send_request(options)
|
|
1648
|
+
end
|
|
1649
|
+
|
|
1480
1650
|
# List of SQL statements. By default, only finished statements are
|
|
1481
1651
|
# shown. A token is returned to page through the statement list.
|
|
1482
1652
|
#
|
|
@@ -1765,7 +1935,7 @@ module Aws::RedshiftDataAPIService
|
|
|
1765
1935
|
tracer: tracer
|
|
1766
1936
|
)
|
|
1767
1937
|
context[:gem_name] = 'aws-sdk-redshiftdataapiservice'
|
|
1768
|
-
context[:gem_version] = '1.
|
|
1938
|
+
context[:gem_version] = '1.78.0'
|
|
1769
1939
|
Seahorse::Client::Request.new(handlers, context)
|
|
1770
1940
|
end
|
|
1771
1941
|
|
|
@@ -16,6 +16,7 @@ module Aws::RedshiftDataAPIService
|
|
|
16
16
|
|
|
17
17
|
ActiveSessionsExceededException = Shapes::StructureShape.new(name: 'ActiveSessionsExceededException')
|
|
18
18
|
ActiveStatementsExceededException = Shapes::StructureShape.new(name: 'ActiveStatementsExceededException')
|
|
19
|
+
ActiveWaitingRequestsExceededException = Shapes::StructureShape.new(name: 'ActiveWaitingRequestsExceededException')
|
|
19
20
|
BatchExecuteStatementException = Shapes::StructureShape.new(name: 'BatchExecuteStatementException')
|
|
20
21
|
BatchExecuteStatementInput = Shapes::StructureShape.new(name: 'BatchExecuteStatementInput')
|
|
21
22
|
BatchExecuteStatementOutput = Shapes::StructureShape.new(name: 'BatchExecuteStatementOutput')
|
|
@@ -41,6 +42,7 @@ module Aws::RedshiftDataAPIService
|
|
|
41
42
|
ExecuteStatementException = Shapes::StructureShape.new(name: 'ExecuteStatementException')
|
|
42
43
|
ExecuteStatementInput = Shapes::StructureShape.new(name: 'ExecuteStatementInput')
|
|
43
44
|
ExecuteStatementOutput = Shapes::StructureShape.new(name: 'ExecuteStatementOutput')
|
|
45
|
+
ExecutionMode = Shapes::StringShape.new(name: 'ExecutionMode')
|
|
44
46
|
Field = Shapes::UnionShape.new(name: 'Field')
|
|
45
47
|
FieldList = Shapes::ListShape.new(name: 'FieldList')
|
|
46
48
|
FormattedSqlRecords = Shapes::ListShape.new(name: 'FormattedSqlRecords')
|
|
@@ -54,6 +56,8 @@ module Aws::RedshiftDataAPIService
|
|
|
54
56
|
ListDatabasesResponse = Shapes::StructureShape.new(name: 'ListDatabasesResponse')
|
|
55
57
|
ListSchemasRequest = Shapes::StructureShape.new(name: 'ListSchemasRequest')
|
|
56
58
|
ListSchemasResponse = Shapes::StructureShape.new(name: 'ListSchemasResponse')
|
|
59
|
+
ListSessionsRequest = Shapes::StructureShape.new(name: 'ListSessionsRequest')
|
|
60
|
+
ListSessionsResponse = Shapes::StructureShape.new(name: 'ListSessionsResponse')
|
|
57
61
|
ListStatementsLimit = Shapes::IntegerShape.new(name: 'ListStatementsLimit')
|
|
58
62
|
ListStatementsRequest = Shapes::StructureShape.new(name: 'ListStatementsRequest')
|
|
59
63
|
ListStatementsResponse = Shapes::StructureShape.new(name: 'ListStatementsResponse')
|
|
@@ -70,6 +74,9 @@ module Aws::RedshiftDataAPIService
|
|
|
70
74
|
SchemaList = Shapes::ListShape.new(name: 'SchemaList')
|
|
71
75
|
SecretArn = Shapes::StringShape.new(name: 'SecretArn')
|
|
72
76
|
SessionAliveSeconds = Shapes::IntegerShape.new(name: 'SessionAliveSeconds')
|
|
77
|
+
SessionData = Shapes::StructureShape.new(name: 'SessionData')
|
|
78
|
+
SessionList = Shapes::ListShape.new(name: 'SessionList')
|
|
79
|
+
SessionStatusString = Shapes::StringShape.new(name: 'SessionStatusString')
|
|
73
80
|
SqlList = Shapes::ListShape.new(name: 'SqlList')
|
|
74
81
|
SqlParameter = Shapes::StructureShape.new(name: 'SqlParameter')
|
|
75
82
|
SqlParametersList = Shapes::ListShape.new(name: 'SqlParametersList')
|
|
@@ -89,6 +96,7 @@ module Aws::RedshiftDataAPIService
|
|
|
89
96
|
Timestamp = Shapes::TimestampShape.new(name: 'Timestamp')
|
|
90
97
|
UUID = Shapes::StringShape.new(name: 'UUID')
|
|
91
98
|
ValidationException = Shapes::StructureShape.new(name: 'ValidationException')
|
|
99
|
+
WaitTimeSeconds = Shapes::IntegerShape.new(name: 'WaitTimeSeconds')
|
|
92
100
|
WorkgroupNameString = Shapes::StringShape.new(name: 'WorkgroupNameString')
|
|
93
101
|
bool = Shapes::BooleanShape.new(name: 'bool')
|
|
94
102
|
|
|
@@ -98,6 +106,9 @@ module Aws::RedshiftDataAPIService
|
|
|
98
106
|
ActiveStatementsExceededException.add_member(:message, Shapes::ShapeRef.new(shape: String, location_name: "Message"))
|
|
99
107
|
ActiveStatementsExceededException.struct_class = Types::ActiveStatementsExceededException
|
|
100
108
|
|
|
109
|
+
ActiveWaitingRequestsExceededException.add_member(:message, Shapes::ShapeRef.new(shape: String, location_name: "Message"))
|
|
110
|
+
ActiveWaitingRequestsExceededException.struct_class = Types::ActiveWaitingRequestsExceededException
|
|
111
|
+
|
|
101
112
|
BatchExecuteStatementException.add_member(:message, Shapes::ShapeRef.new(shape: String, required: true, location_name: "Message"))
|
|
102
113
|
BatchExecuteStatementException.add_member(:statement_id, Shapes::ShapeRef.new(shape: String, required: true, location_name: "StatementId"))
|
|
103
114
|
BatchExecuteStatementException.struct_class = Types::BatchExecuteStatementException
|
|
@@ -115,6 +126,8 @@ module Aws::RedshiftDataAPIService
|
|
|
115
126
|
BatchExecuteStatementInput.add_member(:result_format, Shapes::ShapeRef.new(shape: ResultFormatString, location_name: "ResultFormat"))
|
|
116
127
|
BatchExecuteStatementInput.add_member(:session_keep_alive_seconds, Shapes::ShapeRef.new(shape: SessionAliveSeconds, location_name: "SessionKeepAliveSeconds"))
|
|
117
128
|
BatchExecuteStatementInput.add_member(:session_id, Shapes::ShapeRef.new(shape: UUID, location_name: "SessionId"))
|
|
129
|
+
BatchExecuteStatementInput.add_member(:execution_mode, Shapes::ShapeRef.new(shape: ExecutionMode, location_name: "ExecutionMode"))
|
|
130
|
+
BatchExecuteStatementInput.add_member(:wait_time_seconds, Shapes::ShapeRef.new(shape: WaitTimeSeconds, location_name: "WaitTimeSeconds"))
|
|
118
131
|
BatchExecuteStatementInput.struct_class = Types::BatchExecuteStatementInput
|
|
119
132
|
|
|
120
133
|
BatchExecuteStatementOutput.add_member(:id, Shapes::ShapeRef.new(shape: UUID, location_name: "Id"))
|
|
@@ -126,6 +139,9 @@ module Aws::RedshiftDataAPIService
|
|
|
126
139
|
BatchExecuteStatementOutput.add_member(:secret_arn, Shapes::ShapeRef.new(shape: SecretArn, location_name: "SecretArn"))
|
|
127
140
|
BatchExecuteStatementOutput.add_member(:workgroup_name, Shapes::ShapeRef.new(shape: WorkgroupNameString, location_name: "WorkgroupName"))
|
|
128
141
|
BatchExecuteStatementOutput.add_member(:session_id, Shapes::ShapeRef.new(shape: UUID, location_name: "SessionId"))
|
|
142
|
+
BatchExecuteStatementOutput.add_member(:status, Shapes::ShapeRef.new(shape: StatementStatusString, location_name: "Status"))
|
|
143
|
+
BatchExecuteStatementOutput.add_member(:redshift_pid, Shapes::ShapeRef.new(shape: BoxedLong, location_name: "RedshiftPid"))
|
|
144
|
+
BatchExecuteStatementOutput.add_member(:has_result_set, Shapes::ShapeRef.new(shape: BoxedBoolean, location_name: "HasResultSet"))
|
|
129
145
|
BatchExecuteStatementOutput.struct_class = Types::BatchExecuteStatementOutput
|
|
130
146
|
|
|
131
147
|
CancelStatementRequest.add_member(:id, Shapes::ShapeRef.new(shape: UUID, required: true, location_name: "Id"))
|
|
@@ -161,6 +177,7 @@ module Aws::RedshiftDataAPIService
|
|
|
161
177
|
DbGroupList.member = Shapes::ShapeRef.new(shape: String)
|
|
162
178
|
|
|
163
179
|
DescribeStatementRequest.add_member(:id, Shapes::ShapeRef.new(shape: UUID, required: true, location_name: "Id"))
|
|
180
|
+
DescribeStatementRequest.add_member(:wait_time_seconds, Shapes::ShapeRef.new(shape: WaitTimeSeconds, location_name: "WaitTimeSeconds"))
|
|
164
181
|
DescribeStatementRequest.struct_class = Types::DescribeStatementRequest
|
|
165
182
|
|
|
166
183
|
DescribeStatementResponse.add_member(:id, Shapes::ShapeRef.new(shape: UUID, required: true, location_name: "Id"))
|
|
@@ -184,6 +201,7 @@ module Aws::RedshiftDataAPIService
|
|
|
184
201
|
DescribeStatementResponse.add_member(:workgroup_name, Shapes::ShapeRef.new(shape: WorkgroupNameString, location_name: "WorkgroupName"))
|
|
185
202
|
DescribeStatementResponse.add_member(:result_format, Shapes::ShapeRef.new(shape: ResultFormatString, location_name: "ResultFormat"))
|
|
186
203
|
DescribeStatementResponse.add_member(:session_id, Shapes::ShapeRef.new(shape: String, location_name: "SessionId"))
|
|
204
|
+
DescribeStatementResponse.add_member(:execution_mode, Shapes::ShapeRef.new(shape: ExecutionMode, location_name: "ExecutionMode"))
|
|
187
205
|
DescribeStatementResponse.struct_class = Types::DescribeStatementResponse
|
|
188
206
|
|
|
189
207
|
DescribeTableRequest.add_member(:cluster_identifier, Shapes::ShapeRef.new(shape: ClusterIdentifierString, location_name: "ClusterIdentifier"))
|
|
@@ -220,6 +238,7 @@ module Aws::RedshiftDataAPIService
|
|
|
220
238
|
ExecuteStatementInput.add_member(:result_format, Shapes::ShapeRef.new(shape: ResultFormatString, location_name: "ResultFormat"))
|
|
221
239
|
ExecuteStatementInput.add_member(:session_keep_alive_seconds, Shapes::ShapeRef.new(shape: SessionAliveSeconds, location_name: "SessionKeepAliveSeconds"))
|
|
222
240
|
ExecuteStatementInput.add_member(:session_id, Shapes::ShapeRef.new(shape: UUID, location_name: "SessionId"))
|
|
241
|
+
ExecuteStatementInput.add_member(:wait_time_seconds, Shapes::ShapeRef.new(shape: WaitTimeSeconds, location_name: "WaitTimeSeconds"))
|
|
223
242
|
ExecuteStatementInput.struct_class = Types::ExecuteStatementInput
|
|
224
243
|
|
|
225
244
|
ExecuteStatementOutput.add_member(:id, Shapes::ShapeRef.new(shape: UUID, location_name: "Id"))
|
|
@@ -231,6 +250,9 @@ module Aws::RedshiftDataAPIService
|
|
|
231
250
|
ExecuteStatementOutput.add_member(:secret_arn, Shapes::ShapeRef.new(shape: SecretArn, location_name: "SecretArn"))
|
|
232
251
|
ExecuteStatementOutput.add_member(:workgroup_name, Shapes::ShapeRef.new(shape: WorkgroupNameString, location_name: "WorkgroupName"))
|
|
233
252
|
ExecuteStatementOutput.add_member(:session_id, Shapes::ShapeRef.new(shape: UUID, location_name: "SessionId"))
|
|
253
|
+
ExecuteStatementOutput.add_member(:status, Shapes::ShapeRef.new(shape: StatementStatusString, location_name: "Status"))
|
|
254
|
+
ExecuteStatementOutput.add_member(:redshift_pid, Shapes::ShapeRef.new(shape: BoxedLong, location_name: "RedshiftPid"))
|
|
255
|
+
ExecuteStatementOutput.add_member(:has_result_set, Shapes::ShapeRef.new(shape: BoxedBoolean, location_name: "HasResultSet"))
|
|
234
256
|
ExecuteStatementOutput.struct_class = Types::ExecuteStatementOutput
|
|
235
257
|
|
|
236
258
|
Field.add_member(:is_null, Shapes::ShapeRef.new(shape: BoxedBoolean, location_name: "isNull"))
|
|
@@ -255,6 +277,7 @@ module Aws::RedshiftDataAPIService
|
|
|
255
277
|
|
|
256
278
|
GetStatementResultRequest.add_member(:id, Shapes::ShapeRef.new(shape: UUID, required: true, location_name: "Id"))
|
|
257
279
|
GetStatementResultRequest.add_member(:next_token, Shapes::ShapeRef.new(shape: String, location_name: "NextToken"))
|
|
280
|
+
GetStatementResultRequest.add_member(:wait_time_seconds, Shapes::ShapeRef.new(shape: WaitTimeSeconds, location_name: "WaitTimeSeconds"))
|
|
258
281
|
GetStatementResultRequest.struct_class = Types::GetStatementResultRequest
|
|
259
282
|
|
|
260
283
|
GetStatementResultResponse.add_member(:records, Shapes::ShapeRef.new(shape: SqlRecords, required: true, location_name: "Records"))
|
|
@@ -265,6 +288,7 @@ module Aws::RedshiftDataAPIService
|
|
|
265
288
|
|
|
266
289
|
GetStatementResultV2Request.add_member(:id, Shapes::ShapeRef.new(shape: UUID, required: true, location_name: "Id"))
|
|
267
290
|
GetStatementResultV2Request.add_member(:next_token, Shapes::ShapeRef.new(shape: String, location_name: "NextToken"))
|
|
291
|
+
GetStatementResultV2Request.add_member(:wait_time_seconds, Shapes::ShapeRef.new(shape: WaitTimeSeconds, location_name: "WaitTimeSeconds"))
|
|
268
292
|
GetStatementResultV2Request.struct_class = Types::GetStatementResultV2Request
|
|
269
293
|
|
|
270
294
|
GetStatementResultV2Response.add_member(:records, Shapes::ShapeRef.new(shape: FormattedSqlRecords, required: true, location_name: "Records"))
|
|
@@ -305,6 +329,20 @@ module Aws::RedshiftDataAPIService
|
|
|
305
329
|
ListSchemasResponse.add_member(:next_token, Shapes::ShapeRef.new(shape: String, location_name: "NextToken"))
|
|
306
330
|
ListSchemasResponse.struct_class = Types::ListSchemasResponse
|
|
307
331
|
|
|
332
|
+
ListSessionsRequest.add_member(:next_token, Shapes::ShapeRef.new(shape: String, location_name: "NextToken"))
|
|
333
|
+
ListSessionsRequest.add_member(:max_results, Shapes::ShapeRef.new(shape: ListStatementsLimit, location_name: "MaxResults"))
|
|
334
|
+
ListSessionsRequest.add_member(:session_id, Shapes::ShapeRef.new(shape: UUID, location_name: "SessionId"))
|
|
335
|
+
ListSessionsRequest.add_member(:status, Shapes::ShapeRef.new(shape: SessionStatusString, location_name: "Status"))
|
|
336
|
+
ListSessionsRequest.add_member(:role_level, Shapes::ShapeRef.new(shape: Boolean, location_name: "RoleLevel"))
|
|
337
|
+
ListSessionsRequest.add_member(:cluster_identifier, Shapes::ShapeRef.new(shape: ClusterIdentifierString, location_name: "ClusterIdentifier"))
|
|
338
|
+
ListSessionsRequest.add_member(:workgroup_name, Shapes::ShapeRef.new(shape: WorkgroupNameString, location_name: "WorkgroupName"))
|
|
339
|
+
ListSessionsRequest.add_member(:database, Shapes::ShapeRef.new(shape: String, location_name: "Database"))
|
|
340
|
+
ListSessionsRequest.struct_class = Types::ListSessionsRequest
|
|
341
|
+
|
|
342
|
+
ListSessionsResponse.add_member(:sessions, Shapes::ShapeRef.new(shape: SessionList, required: true, location_name: "Sessions"))
|
|
343
|
+
ListSessionsResponse.add_member(:next_token, Shapes::ShapeRef.new(shape: String, location_name: "NextToken"))
|
|
344
|
+
ListSessionsResponse.struct_class = Types::ListSessionsResponse
|
|
345
|
+
|
|
308
346
|
ListStatementsRequest.add_member(:next_token, Shapes::ShapeRef.new(shape: String, location_name: "NextToken"))
|
|
309
347
|
ListStatementsRequest.add_member(:max_results, Shapes::ShapeRef.new(shape: ListStatementsLimit, location_name: "MaxResults"))
|
|
310
348
|
ListStatementsRequest.add_member(:statement_name, Shapes::ShapeRef.new(shape: StatementNameString, location_name: "StatementName"))
|
|
@@ -350,6 +388,21 @@ module Aws::RedshiftDataAPIService
|
|
|
350
388
|
|
|
351
389
|
SchemaList.member = Shapes::ShapeRef.new(shape: String)
|
|
352
390
|
|
|
391
|
+
SessionData.add_member(:session_id, Shapes::ShapeRef.new(shape: UUID, required: true, location_name: "SessionId"))
|
|
392
|
+
SessionData.add_member(:status, Shapes::ShapeRef.new(shape: SessionStatusString, required: true, location_name: "Status"))
|
|
393
|
+
SessionData.add_member(:created_at, Shapes::ShapeRef.new(shape: Timestamp, required: true, location_name: "CreatedAt"))
|
|
394
|
+
SessionData.add_member(:updated_at, Shapes::ShapeRef.new(shape: Timestamp, location_name: "UpdatedAt"))
|
|
395
|
+
SessionData.add_member(:database, Shapes::ShapeRef.new(shape: String, location_name: "Database"))
|
|
396
|
+
SessionData.add_member(:db_user, Shapes::ShapeRef.new(shape: String, location_name: "DbUser"))
|
|
397
|
+
SessionData.add_member(:cluster_identifier, Shapes::ShapeRef.new(shape: String, location_name: "ClusterIdentifier"))
|
|
398
|
+
SessionData.add_member(:workgroup_name, Shapes::ShapeRef.new(shape: WorkgroupNameString, location_name: "WorkgroupName"))
|
|
399
|
+
SessionData.add_member(:session_alive_seconds, Shapes::ShapeRef.new(shape: SessionAliveSeconds, location_name: "SessionAliveSeconds"))
|
|
400
|
+
SessionData.add_member(:session_ttl, Shapes::ShapeRef.new(shape: Timestamp, location_name: "SessionTtl"))
|
|
401
|
+
SessionData.add_member(:current_statement_id, Shapes::ShapeRef.new(shape: UUID, location_name: "CurrentStatementId"))
|
|
402
|
+
SessionData.struct_class = Types::SessionData
|
|
403
|
+
|
|
404
|
+
SessionList.member = Shapes::ShapeRef.new(shape: SessionData)
|
|
405
|
+
|
|
353
406
|
SqlList.member = Shapes::ShapeRef.new(shape: StatementString)
|
|
354
407
|
|
|
355
408
|
SqlParameter.add_member(:name, Shapes::ShapeRef.new(shape: ParameterName, required: true, location_name: "name"))
|
|
@@ -459,6 +512,7 @@ module Aws::RedshiftDataAPIService
|
|
|
459
512
|
o.output = Shapes::ShapeRef.new(shape: DescribeStatementResponse)
|
|
460
513
|
o.errors << Shapes::ShapeRef.new(shape: ValidationException)
|
|
461
514
|
o.errors << Shapes::ShapeRef.new(shape: ResourceNotFoundException)
|
|
515
|
+
o.errors << Shapes::ShapeRef.new(shape: ActiveWaitingRequestsExceededException)
|
|
462
516
|
o.errors << Shapes::ShapeRef.new(shape: InternalServerException)
|
|
463
517
|
end)
|
|
464
518
|
|
|
@@ -503,6 +557,7 @@ module Aws::RedshiftDataAPIService
|
|
|
503
557
|
o.output = Shapes::ShapeRef.new(shape: GetStatementResultResponse)
|
|
504
558
|
o.errors << Shapes::ShapeRef.new(shape: ValidationException)
|
|
505
559
|
o.errors << Shapes::ShapeRef.new(shape: ResourceNotFoundException)
|
|
560
|
+
o.errors << Shapes::ShapeRef.new(shape: ActiveWaitingRequestsExceededException)
|
|
506
561
|
o.errors << Shapes::ShapeRef.new(shape: InternalServerException)
|
|
507
562
|
o[:pager] = Aws::Pager.new(
|
|
508
563
|
tokens: {
|
|
@@ -519,6 +574,7 @@ module Aws::RedshiftDataAPIService
|
|
|
519
574
|
o.output = Shapes::ShapeRef.new(shape: GetStatementResultV2Response)
|
|
520
575
|
o.errors << Shapes::ShapeRef.new(shape: ValidationException)
|
|
521
576
|
o.errors << Shapes::ShapeRef.new(shape: ResourceNotFoundException)
|
|
577
|
+
o.errors << Shapes::ShapeRef.new(shape: ActiveWaitingRequestsExceededException)
|
|
522
578
|
o.errors << Shapes::ShapeRef.new(shape: InternalServerException)
|
|
523
579
|
o[:pager] = Aws::Pager.new(
|
|
524
580
|
tokens: {
|
|
@@ -565,6 +621,23 @@ module Aws::RedshiftDataAPIService
|
|
|
565
621
|
)
|
|
566
622
|
end)
|
|
567
623
|
|
|
624
|
+
api.add_operation(:list_sessions, Seahorse::Model::Operation.new.tap do |o|
|
|
625
|
+
o.name = "ListSessions"
|
|
626
|
+
o.http_method = "POST"
|
|
627
|
+
o.http_request_uri = "/"
|
|
628
|
+
o.input = Shapes::ShapeRef.new(shape: ListSessionsRequest)
|
|
629
|
+
o.output = Shapes::ShapeRef.new(shape: ListSessionsResponse)
|
|
630
|
+
o.errors << Shapes::ShapeRef.new(shape: ValidationException)
|
|
631
|
+
o.errors << Shapes::ShapeRef.new(shape: ResourceNotFoundException)
|
|
632
|
+
o.errors << Shapes::ShapeRef.new(shape: InternalServerException)
|
|
633
|
+
o[:pager] = Aws::Pager.new(
|
|
634
|
+
limit_key: "max_results",
|
|
635
|
+
tokens: {
|
|
636
|
+
"next_token" => "next_token"
|
|
637
|
+
}
|
|
638
|
+
)
|
|
639
|
+
end)
|
|
640
|
+
|
|
568
641
|
api.add_operation(:list_statements, Seahorse::Model::Operation.new.tap do |o|
|
|
569
642
|
o.name = "ListStatements"
|
|
570
643
|
o.http_method = "POST"
|
|
@@ -29,6 +29,7 @@ module Aws::RedshiftDataAPIService
|
|
|
29
29
|
# ## Error Classes
|
|
30
30
|
# * {ActiveSessionsExceededException}
|
|
31
31
|
# * {ActiveStatementsExceededException}
|
|
32
|
+
# * {ActiveWaitingRequestsExceededException}
|
|
32
33
|
# * {BatchExecuteStatementException}
|
|
33
34
|
# * {DatabaseConnectionException}
|
|
34
35
|
# * {ExecuteStatementException}
|
|
@@ -73,6 +74,21 @@ module Aws::RedshiftDataAPIService
|
|
|
73
74
|
end
|
|
74
75
|
end
|
|
75
76
|
|
|
77
|
+
class ActiveWaitingRequestsExceededException < ServiceError
|
|
78
|
+
|
|
79
|
+
# @param [Seahorse::Client::RequestContext] context
|
|
80
|
+
# @param [String] message
|
|
81
|
+
# @param [Aws::RedshiftDataAPIService::Types::ActiveWaitingRequestsExceededException] data
|
|
82
|
+
def initialize(context, message, data = Aws::EmptyStructure.new)
|
|
83
|
+
super(context, message, data)
|
|
84
|
+
end
|
|
85
|
+
|
|
86
|
+
# @return [String]
|
|
87
|
+
def message
|
|
88
|
+
@message || @data[:message]
|
|
89
|
+
end
|
|
90
|
+
end
|
|
91
|
+
|
|
76
92
|
class BatchExecuteStatementException < ServiceError
|
|
77
93
|
|
|
78
94
|
# @param [Seahorse::Client::RequestContext] context
|
|
@@ -37,6 +37,20 @@ module Aws::RedshiftDataAPIService
|
|
|
37
37
|
include Aws::Structure
|
|
38
38
|
end
|
|
39
39
|
|
|
40
|
+
# The number of active requests with `WaitTimeSeconds` for the same SQL
|
|
41
|
+
# statement exceeds the limit.
|
|
42
|
+
#
|
|
43
|
+
# @!attribute [rw] message
|
|
44
|
+
# @return [String]
|
|
45
|
+
#
|
|
46
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/redshift-data-2019-12-20/ActiveWaitingRequestsExceededException AWS API Documentation
|
|
47
|
+
#
|
|
48
|
+
class ActiveWaitingRequestsExceededException < Struct.new(
|
|
49
|
+
:message)
|
|
50
|
+
SENSITIVE = []
|
|
51
|
+
include Aws::Structure
|
|
52
|
+
end
|
|
53
|
+
|
|
40
54
|
# An SQL statement encountered an environmental error while running.
|
|
41
55
|
#
|
|
42
56
|
# @!attribute [rw] message
|
|
@@ -56,11 +70,12 @@ module Aws::RedshiftDataAPIService
|
|
|
56
70
|
end
|
|
57
71
|
|
|
58
72
|
# @!attribute [rw] sqls
|
|
59
|
-
# One or more SQL statements to run. The SQL statements
|
|
60
|
-
#
|
|
61
|
-
#
|
|
62
|
-
#
|
|
63
|
-
#
|
|
73
|
+
# One or more SQL statements to run. The SQL statements run serially
|
|
74
|
+
# in the order of the array. Subsequent SQL statements don't start
|
|
75
|
+
# until the previous statement in the array completes. By default, the
|
|
76
|
+
# SQL statements are run as a single transaction. If any SQL statement
|
|
77
|
+
# fails, all work is rolled back. To change this behavior, see the
|
|
78
|
+
# `ExecutionMode` parameter.
|
|
64
79
|
# @return [Array<String>]
|
|
65
80
|
#
|
|
66
81
|
# @!attribute [rw] cluster_identifier
|
|
@@ -98,8 +113,10 @@ module Aws::RedshiftDataAPIService
|
|
|
98
113
|
# @return [String]
|
|
99
114
|
#
|
|
100
115
|
# @!attribute [rw] parameters
|
|
101
|
-
# The parameters for the SQL statements. The parameters are
|
|
102
|
-
#
|
|
116
|
+
# The parameters for the SQL statements. The parameters are available
|
|
117
|
+
# to all SQL statements in the batch. Each statement can reference any
|
|
118
|
+
# subset of the provided parameters. Each provided parameter must be
|
|
119
|
+
# referenced by at least one SQL statement in the batch.
|
|
103
120
|
# @return [Array<Types::SqlParameter>]
|
|
104
121
|
#
|
|
105
122
|
# @!attribute [rw] workgroup_name
|
|
@@ -133,6 +150,21 @@ module Aws::RedshiftDataAPIService
|
|
|
133
150
|
# The session identifier of the query.
|
|
134
151
|
# @return [String]
|
|
135
152
|
#
|
|
153
|
+
# @!attribute [rw] execution_mode
|
|
154
|
+
# Determines how the SQL statements in the batch are run. If set to
|
|
155
|
+
# `TRANSACTION` (the default), all SQL statements are run as a single
|
|
156
|
+
# transaction and they are committed or rolled back together. If set
|
|
157
|
+
# to `AUTO_COMMIT`, each SQL statement is committed individually, and
|
|
158
|
+
# a failure of one statement does not affect the others.
|
|
159
|
+
# @return [String]
|
|
160
|
+
#
|
|
161
|
+
# @!attribute [rw] wait_time_seconds
|
|
162
|
+
# The number of seconds to wait for all SQL statements in the batch to
|
|
163
|
+
# complete execution before returning the response. If the SQL
|
|
164
|
+
# statements do not complete within the specified time, the response
|
|
165
|
+
# returns the current status. The maximum value is 30 seconds.
|
|
166
|
+
# @return [Integer]
|
|
167
|
+
#
|
|
136
168
|
# @see http://docs.aws.amazon.com/goto/WebAPI/redshift-data-2019-12-20/BatchExecuteStatementInput AWS API Documentation
|
|
137
169
|
#
|
|
138
170
|
class BatchExecuteStatementInput < Struct.new(
|
|
@@ -148,7 +180,9 @@ module Aws::RedshiftDataAPIService
|
|
|
148
180
|
:client_token,
|
|
149
181
|
:result_format,
|
|
150
182
|
:session_keep_alive_seconds,
|
|
151
|
-
:session_id
|
|
183
|
+
:session_id,
|
|
184
|
+
:execution_mode,
|
|
185
|
+
:wait_time_seconds)
|
|
152
186
|
SENSITIVE = []
|
|
153
187
|
include Aws::Structure
|
|
154
188
|
end
|
|
@@ -194,6 +228,33 @@ module Aws::RedshiftDataAPIService
|
|
|
194
228
|
# The session identifier of the query.
|
|
195
229
|
# @return [String]
|
|
196
230
|
#
|
|
231
|
+
# @!attribute [rw] status
|
|
232
|
+
# The status of the SQL statement. Status values are defined as
|
|
233
|
+
# follows:
|
|
234
|
+
#
|
|
235
|
+
# * ABORTED - The query run was stopped by the user.
|
|
236
|
+
#
|
|
237
|
+
# * FAILED - The query run failed.
|
|
238
|
+
#
|
|
239
|
+
# * FINISHED - The query has finished running.
|
|
240
|
+
#
|
|
241
|
+
# * PICKED - The query has been chosen to be run.
|
|
242
|
+
#
|
|
243
|
+
# * STARTED - The query run has started.
|
|
244
|
+
#
|
|
245
|
+
# * SUBMITTED - The query was submitted, but not yet processed.
|
|
246
|
+
# @return [String]
|
|
247
|
+
#
|
|
248
|
+
# @!attribute [rw] redshift_pid
|
|
249
|
+
# The process identifier from Amazon Redshift.
|
|
250
|
+
# @return [Integer]
|
|
251
|
+
#
|
|
252
|
+
# @!attribute [rw] has_result_set
|
|
253
|
+
# A value that indicates whether the statement has a result set. The
|
|
254
|
+
# result set can be empty. The value is true for an empty result set.
|
|
255
|
+
# The value is true if any substatement returns a result set.
|
|
256
|
+
# @return [Boolean]
|
|
257
|
+
#
|
|
197
258
|
# @see http://docs.aws.amazon.com/goto/WebAPI/redshift-data-2019-12-20/BatchExecuteStatementOutput AWS API Documentation
|
|
198
259
|
#
|
|
199
260
|
class BatchExecuteStatementOutput < Struct.new(
|
|
@@ -205,7 +266,10 @@ module Aws::RedshiftDataAPIService
|
|
|
205
266
|
:database,
|
|
206
267
|
:secret_arn,
|
|
207
268
|
:workgroup_name,
|
|
208
|
-
:session_id
|
|
269
|
+
:session_id,
|
|
270
|
+
:status,
|
|
271
|
+
:redshift_pid,
|
|
272
|
+
:has_result_set)
|
|
209
273
|
SENSITIVE = []
|
|
210
274
|
include Aws::Structure
|
|
211
275
|
end
|
|
@@ -337,10 +401,17 @@ module Aws::RedshiftDataAPIService
|
|
|
337
401
|
# `ExecuteStatement`, and `ListStatements`.
|
|
338
402
|
# @return [String]
|
|
339
403
|
#
|
|
404
|
+
# @!attribute [rw] wait_time_seconds
|
|
405
|
+
# The number of seconds to wait for the SQL statement to complete
|
|
406
|
+
# execution before returning the description. The maximum value is 30
|
|
407
|
+
# seconds.
|
|
408
|
+
# @return [Integer]
|
|
409
|
+
#
|
|
340
410
|
# @see http://docs.aws.amazon.com/goto/WebAPI/redshift-data-2019-12-20/DescribeStatementRequest AWS API Documentation
|
|
341
411
|
#
|
|
342
412
|
class DescribeStatementRequest < Struct.new(
|
|
343
|
-
:id
|
|
413
|
+
:id,
|
|
414
|
+
:wait_time_seconds)
|
|
344
415
|
SENSITIVE = []
|
|
345
416
|
include Aws::Structure
|
|
346
417
|
end
|
|
@@ -459,6 +530,12 @@ module Aws::RedshiftDataAPIService
|
|
|
459
530
|
# The session identifier of the query.
|
|
460
531
|
# @return [String]
|
|
461
532
|
#
|
|
533
|
+
# @!attribute [rw] execution_mode
|
|
534
|
+
# The execution mode of the batch request. `TRANSACTION` indicates all
|
|
535
|
+
# SQL statements are run as a single transaction. `AUTO_COMMIT`
|
|
536
|
+
# indicates each SQL statement is committed individually.
|
|
537
|
+
# @return [String]
|
|
538
|
+
#
|
|
462
539
|
# @see http://docs.aws.amazon.com/goto/WebAPI/redshift-data-2019-12-20/DescribeStatementResponse AWS API Documentation
|
|
463
540
|
#
|
|
464
541
|
class DescribeStatementResponse < Struct.new(
|
|
@@ -482,7 +559,8 @@ module Aws::RedshiftDataAPIService
|
|
|
482
559
|
:sub_statements,
|
|
483
560
|
:workgroup_name,
|
|
484
561
|
:result_format,
|
|
485
|
-
:session_id
|
|
562
|
+
:session_id,
|
|
563
|
+
:execution_mode)
|
|
486
564
|
SENSITIVE = []
|
|
487
565
|
include Aws::Structure
|
|
488
566
|
end
|
|
@@ -686,6 +764,13 @@ module Aws::RedshiftDataAPIService
|
|
|
686
764
|
# The session identifier of the query.
|
|
687
765
|
# @return [String]
|
|
688
766
|
#
|
|
767
|
+
# @!attribute [rw] wait_time_seconds
|
|
768
|
+
# The number of seconds to wait for the SQL statement to complete
|
|
769
|
+
# execution before returning the response. If the SQL statement does
|
|
770
|
+
# not complete within the specified time, the response returns the
|
|
771
|
+
# current status. The maximum value is 30 seconds.
|
|
772
|
+
# @return [Integer]
|
|
773
|
+
#
|
|
689
774
|
# @see http://docs.aws.amazon.com/goto/WebAPI/redshift-data-2019-12-20/ExecuteStatementInput AWS API Documentation
|
|
690
775
|
#
|
|
691
776
|
class ExecuteStatementInput < Struct.new(
|
|
@@ -701,7 +786,8 @@ module Aws::RedshiftDataAPIService
|
|
|
701
786
|
:client_token,
|
|
702
787
|
:result_format,
|
|
703
788
|
:session_keep_alive_seconds,
|
|
704
|
-
:session_id
|
|
789
|
+
:session_id,
|
|
790
|
+
:wait_time_seconds)
|
|
705
791
|
SENSITIVE = []
|
|
706
792
|
include Aws::Structure
|
|
707
793
|
end
|
|
@@ -746,6 +832,32 @@ module Aws::RedshiftDataAPIService
|
|
|
746
832
|
# The session identifier of the query.
|
|
747
833
|
# @return [String]
|
|
748
834
|
#
|
|
835
|
+
# @!attribute [rw] status
|
|
836
|
+
# The status of the SQL statement. Status values are defined as
|
|
837
|
+
# follows:
|
|
838
|
+
#
|
|
839
|
+
# * ABORTED - The query run was stopped by the user.
|
|
840
|
+
#
|
|
841
|
+
# * FAILED - The query run failed.
|
|
842
|
+
#
|
|
843
|
+
# * FINISHED - The query has finished running.
|
|
844
|
+
#
|
|
845
|
+
# * PICKED - The query has been chosen to be run.
|
|
846
|
+
#
|
|
847
|
+
# * STARTED - The query run has started.
|
|
848
|
+
#
|
|
849
|
+
# * SUBMITTED - The query was submitted, but not yet processed.
|
|
850
|
+
# @return [String]
|
|
851
|
+
#
|
|
852
|
+
# @!attribute [rw] redshift_pid
|
|
853
|
+
# The process identifier from Amazon Redshift.
|
|
854
|
+
# @return [Integer]
|
|
855
|
+
#
|
|
856
|
+
# @!attribute [rw] has_result_set
|
|
857
|
+
# A value that indicates whether the statement has a result set. The
|
|
858
|
+
# result set can be empty. The value is true for an empty result set.
|
|
859
|
+
# @return [Boolean]
|
|
860
|
+
#
|
|
749
861
|
# @see http://docs.aws.amazon.com/goto/WebAPI/redshift-data-2019-12-20/ExecuteStatementOutput AWS API Documentation
|
|
750
862
|
#
|
|
751
863
|
class ExecuteStatementOutput < Struct.new(
|
|
@@ -757,7 +869,10 @@ module Aws::RedshiftDataAPIService
|
|
|
757
869
|
:database,
|
|
758
870
|
:secret_arn,
|
|
759
871
|
:workgroup_name,
|
|
760
|
-
:session_id
|
|
872
|
+
:session_id,
|
|
873
|
+
:status,
|
|
874
|
+
:redshift_pid,
|
|
875
|
+
:has_result_set)
|
|
761
876
|
SENSITIVE = []
|
|
762
877
|
include Aws::Structure
|
|
763
878
|
end
|
|
@@ -832,11 +947,18 @@ module Aws::RedshiftDataAPIService
|
|
|
832
947
|
# records have been retrieved for the request.
|
|
833
948
|
# @return [String]
|
|
834
949
|
#
|
|
950
|
+
# @!attribute [rw] wait_time_seconds
|
|
951
|
+
# The number of seconds to wait for the SQL statement to complete
|
|
952
|
+
# execution before returning the result. The maximum value is 30
|
|
953
|
+
# seconds.
|
|
954
|
+
# @return [Integer]
|
|
955
|
+
#
|
|
835
956
|
# @see http://docs.aws.amazon.com/goto/WebAPI/redshift-data-2019-12-20/GetStatementResultRequest AWS API Documentation
|
|
836
957
|
#
|
|
837
958
|
class GetStatementResultRequest < Struct.new(
|
|
838
959
|
:id,
|
|
839
|
-
:next_token
|
|
960
|
+
:next_token,
|
|
961
|
+
:wait_time_seconds)
|
|
840
962
|
SENSITIVE = []
|
|
841
963
|
include Aws::Structure
|
|
842
964
|
end
|
|
@@ -894,11 +1016,18 @@ module Aws::RedshiftDataAPIService
|
|
|
894
1016
|
# records have been retrieved for the request.
|
|
895
1017
|
# @return [String]
|
|
896
1018
|
#
|
|
1019
|
+
# @!attribute [rw] wait_time_seconds
|
|
1020
|
+
# The number of seconds to wait for the SQL statement to complete
|
|
1021
|
+
# execution before returning the result. The maximum value is 30
|
|
1022
|
+
# seconds.
|
|
1023
|
+
# @return [Integer]
|
|
1024
|
+
#
|
|
897
1025
|
# @see http://docs.aws.amazon.com/goto/WebAPI/redshift-data-2019-12-20/GetStatementResultV2Request AWS API Documentation
|
|
898
1026
|
#
|
|
899
1027
|
class GetStatementResultV2Request < Struct.new(
|
|
900
1028
|
:id,
|
|
901
|
-
:next_token
|
|
1029
|
+
:next_token,
|
|
1030
|
+
:wait_time_seconds)
|
|
902
1031
|
SENSITIVE = []
|
|
903
1032
|
include Aws::Structure
|
|
904
1033
|
end
|
|
@@ -1134,6 +1263,102 @@ module Aws::RedshiftDataAPIService
|
|
|
1134
1263
|
include Aws::Structure
|
|
1135
1264
|
end
|
|
1136
1265
|
|
|
1266
|
+
# @!attribute [rw] next_token
|
|
1267
|
+
# A value that indicates the starting point for the next set of
|
|
1268
|
+
# response records in a subsequent request. If a value is returned in
|
|
1269
|
+
# a response, you can retrieve the next set of records by providing
|
|
1270
|
+
# this returned NextToken value in the next NextToken parameter and
|
|
1271
|
+
# retrying the command. If the NextToken field is empty, all response
|
|
1272
|
+
# records have been retrieved for the request.
|
|
1273
|
+
# @return [String]
|
|
1274
|
+
#
|
|
1275
|
+
# @!attribute [rw] max_results
|
|
1276
|
+
# The maximum number of sessions to return in the response. If more
|
|
1277
|
+
# sessions exist than fit in one response, the operation returns
|
|
1278
|
+
# `NextToken` to paginate the results.
|
|
1279
|
+
# @return [Integer]
|
|
1280
|
+
#
|
|
1281
|
+
# @!attribute [rw] session_id
|
|
1282
|
+
# The identifier of a specific session to return metadata for. This
|
|
1283
|
+
# value is a universally unique identifier (UUID) generated by Amazon
|
|
1284
|
+
# Redshift Data API. When you provide `SessionId`, you can't specify
|
|
1285
|
+
# `Status`, `ClusterIdentifier`, `WorkgroupName`, or `Database`.
|
|
1286
|
+
# @return [String]
|
|
1287
|
+
#
|
|
1288
|
+
# @!attribute [rw] status
|
|
1289
|
+
# The status of the sessions to list. If no status is specified,
|
|
1290
|
+
# sessions with a status of `AVAILABLE` or `BUSY` are returned. Status
|
|
1291
|
+
# values are defined as follows:
|
|
1292
|
+
#
|
|
1293
|
+
# * AVAILABLE – The session is open and ready to run a SQL statement.
|
|
1294
|
+
#
|
|
1295
|
+
# * BUSY – The session is currently running a SQL statement.
|
|
1296
|
+
#
|
|
1297
|
+
# * CLOSED – The session is closed and can no longer run SQL
|
|
1298
|
+
# statements.
|
|
1299
|
+
# @return [String]
|
|
1300
|
+
#
|
|
1301
|
+
# @!attribute [rw] role_level
|
|
1302
|
+
# Specifies whether to return all sessions created by the caller's
|
|
1303
|
+
# IAM role, including sessions from previous IAM sessions. If false,
|
|
1304
|
+
# only sessions created in the current IAM session are returned. The
|
|
1305
|
+
# default is true.
|
|
1306
|
+
# @return [Boolean]
|
|
1307
|
+
#
|
|
1308
|
+
# @!attribute [rw] cluster_identifier
|
|
1309
|
+
# The cluster identifier. Only sessions on this cluster are returned.
|
|
1310
|
+
# When providing `ClusterIdentifier`, then `WorkgroupName` can't be
|
|
1311
|
+
# specified.
|
|
1312
|
+
# @return [String]
|
|
1313
|
+
#
|
|
1314
|
+
# @!attribute [rw] workgroup_name
|
|
1315
|
+
# The serverless workgroup name or Amazon Resource Name (ARN). Only
|
|
1316
|
+
# sessions on this workgroup are returned. When providing
|
|
1317
|
+
# `WorkgroupName`, then `ClusterIdentifier` can't be specified.
|
|
1318
|
+
# @return [String]
|
|
1319
|
+
#
|
|
1320
|
+
# @!attribute [rw] database
|
|
1321
|
+
# The name of the database. Only sessions connected to this database
|
|
1322
|
+
# are returned.
|
|
1323
|
+
# @return [String]
|
|
1324
|
+
#
|
|
1325
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/redshift-data-2019-12-20/ListSessionsRequest AWS API Documentation
|
|
1326
|
+
#
|
|
1327
|
+
class ListSessionsRequest < Struct.new(
|
|
1328
|
+
:next_token,
|
|
1329
|
+
:max_results,
|
|
1330
|
+
:session_id,
|
|
1331
|
+
:status,
|
|
1332
|
+
:role_level,
|
|
1333
|
+
:cluster_identifier,
|
|
1334
|
+
:workgroup_name,
|
|
1335
|
+
:database)
|
|
1336
|
+
SENSITIVE = []
|
|
1337
|
+
include Aws::Structure
|
|
1338
|
+
end
|
|
1339
|
+
|
|
1340
|
+
# @!attribute [rw] sessions
|
|
1341
|
+
# The sessions that match the request.
|
|
1342
|
+
# @return [Array<Types::SessionData>]
|
|
1343
|
+
#
|
|
1344
|
+
# @!attribute [rw] next_token
|
|
1345
|
+
# A value that indicates the starting point for the next set of
|
|
1346
|
+
# response records in a subsequent request. If a value is returned in
|
|
1347
|
+
# a response, you can retrieve the next set of records by providing
|
|
1348
|
+
# this returned NextToken value in the next NextToken parameter and
|
|
1349
|
+
# retrying the command. If the NextToken field is empty, all response
|
|
1350
|
+
# records have been retrieved for the request.
|
|
1351
|
+
# @return [String]
|
|
1352
|
+
#
|
|
1353
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/redshift-data-2019-12-20/ListSessionsResponse AWS API Documentation
|
|
1354
|
+
#
|
|
1355
|
+
class ListSessionsResponse < Struct.new(
|
|
1356
|
+
:sessions,
|
|
1357
|
+
:next_token)
|
|
1358
|
+
SENSITIVE = []
|
|
1359
|
+
include Aws::Structure
|
|
1360
|
+
end
|
|
1361
|
+
|
|
1137
1362
|
# @!attribute [rw] next_token
|
|
1138
1363
|
# A value that indicates the starting point for the next set of
|
|
1139
1364
|
# response records in a subsequent request. If a value is returned in
|
|
@@ -1404,6 +1629,88 @@ module Aws::RedshiftDataAPIService
|
|
|
1404
1629
|
include Aws::Structure
|
|
1405
1630
|
end
|
|
1406
1631
|
|
|
1632
|
+
# Contains the metadata for a session returned by `ListSessions`,
|
|
1633
|
+
# including its status, compute target, database connection, and
|
|
1634
|
+
# lifecycle timestamps.
|
|
1635
|
+
#
|
|
1636
|
+
# @!attribute [rw] session_id
|
|
1637
|
+
# The session identifier. This value is a universally unique
|
|
1638
|
+
# identifier (UUID) generated by Amazon Redshift Data API.
|
|
1639
|
+
# @return [String]
|
|
1640
|
+
#
|
|
1641
|
+
# @!attribute [rw] status
|
|
1642
|
+
# The status of the session. Status values are defined as follows:
|
|
1643
|
+
#
|
|
1644
|
+
# * AVAILABLE – The session is open and ready to run a SQL statement.
|
|
1645
|
+
#
|
|
1646
|
+
# * BUSY – The session is currently running a SQL statement.
|
|
1647
|
+
#
|
|
1648
|
+
# * CLOSED – The session is closed and can no longer run SQL
|
|
1649
|
+
# statements.
|
|
1650
|
+
# @return [String]
|
|
1651
|
+
#
|
|
1652
|
+
# @!attribute [rw] created_at
|
|
1653
|
+
# The date and time (UTC) when the session was created.
|
|
1654
|
+
# @return [Time]
|
|
1655
|
+
#
|
|
1656
|
+
# @!attribute [rw] updated_at
|
|
1657
|
+
# The date and time (UTC) that the session metadata was last updated.
|
|
1658
|
+
# An example is the time the status last changed.
|
|
1659
|
+
# @return [Time]
|
|
1660
|
+
#
|
|
1661
|
+
# @!attribute [rw] database
|
|
1662
|
+
# The name of the database that the session is connected to.
|
|
1663
|
+
# @return [String]
|
|
1664
|
+
#
|
|
1665
|
+
# @!attribute [rw] db_user
|
|
1666
|
+
# The database user name.
|
|
1667
|
+
# @return [String]
|
|
1668
|
+
#
|
|
1669
|
+
# @!attribute [rw] cluster_identifier
|
|
1670
|
+
# The cluster identifier. This element is not returned when connecting
|
|
1671
|
+
# to a serverless workgroup.
|
|
1672
|
+
# @return [String]
|
|
1673
|
+
#
|
|
1674
|
+
# @!attribute [rw] workgroup_name
|
|
1675
|
+
# The serverless workgroup name or Amazon Resource Name (ARN). This
|
|
1676
|
+
# element is not returned when connecting to a provisioned cluster.
|
|
1677
|
+
# @return [String]
|
|
1678
|
+
#
|
|
1679
|
+
# @!attribute [rw] session_alive_seconds
|
|
1680
|
+
# The number of seconds that the session is kept alive after a query
|
|
1681
|
+
# finishes.
|
|
1682
|
+
# @return [Integer]
|
|
1683
|
+
#
|
|
1684
|
+
# @!attribute [rw] session_ttl
|
|
1685
|
+
# The date and time (UTC) when the session is set to expire and be
|
|
1686
|
+
# closed.
|
|
1687
|
+
# @return [Time]
|
|
1688
|
+
#
|
|
1689
|
+
# @!attribute [rw] current_statement_id
|
|
1690
|
+
# The identifier of the SQL statement currently running in the
|
|
1691
|
+
# session. This value is a universally unique identifier (UUID)
|
|
1692
|
+
# generated by Amazon Redshift Data API. This element is returned only
|
|
1693
|
+
# when the session status is `BUSY`.
|
|
1694
|
+
# @return [String]
|
|
1695
|
+
#
|
|
1696
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/redshift-data-2019-12-20/SessionData AWS API Documentation
|
|
1697
|
+
#
|
|
1698
|
+
class SessionData < Struct.new(
|
|
1699
|
+
:session_id,
|
|
1700
|
+
:status,
|
|
1701
|
+
:created_at,
|
|
1702
|
+
:updated_at,
|
|
1703
|
+
:database,
|
|
1704
|
+
:db_user,
|
|
1705
|
+
:cluster_identifier,
|
|
1706
|
+
:workgroup_name,
|
|
1707
|
+
:session_alive_seconds,
|
|
1708
|
+
:session_ttl,
|
|
1709
|
+
:current_statement_id)
|
|
1710
|
+
SENSITIVE = []
|
|
1711
|
+
include Aws::Structure
|
|
1712
|
+
end
|
|
1713
|
+
|
|
1407
1714
|
# A parameter used in a SQL statement.
|
|
1408
1715
|
#
|
|
1409
1716
|
# @!attribute [rw] name
|
data/sig/client.rbs
CHANGED
|
@@ -90,6 +90,9 @@ module Aws
|
|
|
90
90
|
def secret_arn: () -> ::String
|
|
91
91
|
def workgroup_name: () -> ::String
|
|
92
92
|
def session_id: () -> ::String
|
|
93
|
+
def status: () -> ("SUBMITTED" | "PICKED" | "STARTED" | "FINISHED" | "ABORTED" | "FAILED")
|
|
94
|
+
def redshift_pid: () -> ::Integer
|
|
95
|
+
def has_result_set: () -> bool
|
|
93
96
|
end
|
|
94
97
|
# https://docs.aws.amazon.com/sdk-for-ruby/v3/api/Aws/RedshiftDataAPIService/Client.html#batch_execute_statement-instance_method
|
|
95
98
|
def batch_execute_statement: (
|
|
@@ -110,7 +113,9 @@ module Aws
|
|
|
110
113
|
?client_token: ::String,
|
|
111
114
|
?result_format: ("JSON" | "CSV"),
|
|
112
115
|
?session_keep_alive_seconds: ::Integer,
|
|
113
|
-
?session_id: ::String
|
|
116
|
+
?session_id: ::String,
|
|
117
|
+
?execution_mode: ("TRANSACTION" | "AUTO_COMMIT"),
|
|
118
|
+
?wait_time_seconds: ::Integer
|
|
114
119
|
) -> _BatchExecuteStatementResponseSuccess
|
|
115
120
|
| (Hash[Symbol, untyped] params, ?Hash[Symbol, untyped] options) -> _BatchExecuteStatementResponseSuccess
|
|
116
121
|
|
|
@@ -146,10 +151,12 @@ module Aws
|
|
|
146
151
|
def workgroup_name: () -> ::String
|
|
147
152
|
def result_format: () -> ("JSON" | "CSV")
|
|
148
153
|
def session_id: () -> ::String
|
|
154
|
+
def execution_mode: () -> ("TRANSACTION" | "AUTO_COMMIT")
|
|
149
155
|
end
|
|
150
156
|
# https://docs.aws.amazon.com/sdk-for-ruby/v3/api/Aws/RedshiftDataAPIService/Client.html#describe_statement-instance_method
|
|
151
157
|
def describe_statement: (
|
|
152
|
-
id: ::String
|
|
158
|
+
id: ::String,
|
|
159
|
+
?wait_time_seconds: ::Integer
|
|
153
160
|
) -> _DescribeStatementResponseSuccess
|
|
154
161
|
| (Hash[Symbol, untyped] params, ?Hash[Symbol, untyped] options) -> _DescribeStatementResponseSuccess
|
|
155
162
|
|
|
@@ -185,6 +192,9 @@ module Aws
|
|
|
185
192
|
def secret_arn: () -> ::String
|
|
186
193
|
def workgroup_name: () -> ::String
|
|
187
194
|
def session_id: () -> ::String
|
|
195
|
+
def status: () -> ("SUBMITTED" | "PICKED" | "STARTED" | "FINISHED" | "ABORTED" | "FAILED")
|
|
196
|
+
def redshift_pid: () -> ::Integer
|
|
197
|
+
def has_result_set: () -> bool
|
|
188
198
|
end
|
|
189
199
|
# https://docs.aws.amazon.com/sdk-for-ruby/v3/api/Aws/RedshiftDataAPIService/Client.html#execute_statement-instance_method
|
|
190
200
|
def execute_statement: (
|
|
@@ -205,7 +215,8 @@ module Aws
|
|
|
205
215
|
?client_token: ::String,
|
|
206
216
|
?result_format: ("JSON" | "CSV"),
|
|
207
217
|
?session_keep_alive_seconds: ::Integer,
|
|
208
|
-
?session_id: ::String
|
|
218
|
+
?session_id: ::String,
|
|
219
|
+
?wait_time_seconds: ::Integer
|
|
209
220
|
) -> _ExecuteStatementResponseSuccess
|
|
210
221
|
| (Hash[Symbol, untyped] params, ?Hash[Symbol, untyped] options) -> _ExecuteStatementResponseSuccess
|
|
211
222
|
|
|
@@ -219,7 +230,8 @@ module Aws
|
|
|
219
230
|
# https://docs.aws.amazon.com/sdk-for-ruby/v3/api/Aws/RedshiftDataAPIService/Client.html#get_statement_result-instance_method
|
|
220
231
|
def get_statement_result: (
|
|
221
232
|
id: ::String,
|
|
222
|
-
?next_token: ::String
|
|
233
|
+
?next_token: ::String,
|
|
234
|
+
?wait_time_seconds: ::Integer
|
|
223
235
|
) -> _GetStatementResultResponseSuccess
|
|
224
236
|
| (Hash[Symbol, untyped] params, ?Hash[Symbol, untyped] options) -> _GetStatementResultResponseSuccess
|
|
225
237
|
|
|
@@ -234,7 +246,8 @@ module Aws
|
|
|
234
246
|
# https://docs.aws.amazon.com/sdk-for-ruby/v3/api/Aws/RedshiftDataAPIService/Client.html#get_statement_result_v2-instance_method
|
|
235
247
|
def get_statement_result_v2: (
|
|
236
248
|
id: ::String,
|
|
237
|
-
?next_token: ::String
|
|
249
|
+
?next_token: ::String,
|
|
250
|
+
?wait_time_seconds: ::Integer
|
|
238
251
|
) -> _GetStatementResultV2ResponseSuccess
|
|
239
252
|
| (Hash[Symbol, untyped] params, ?Hash[Symbol, untyped] options) -> _GetStatementResultV2ResponseSuccess
|
|
240
253
|
|
|
@@ -274,6 +287,24 @@ module Aws
|
|
|
274
287
|
) -> _ListSchemasResponseSuccess
|
|
275
288
|
| (Hash[Symbol, untyped] params, ?Hash[Symbol, untyped] options) -> _ListSchemasResponseSuccess
|
|
276
289
|
|
|
290
|
+
interface _ListSessionsResponseSuccess
|
|
291
|
+
include ::Seahorse::Client::_ResponseSuccess[Types::ListSessionsResponse]
|
|
292
|
+
def sessions: () -> ::Array[Types::SessionData]
|
|
293
|
+
def next_token: () -> ::String
|
|
294
|
+
end
|
|
295
|
+
# https://docs.aws.amazon.com/sdk-for-ruby/v3/api/Aws/RedshiftDataAPIService/Client.html#list_sessions-instance_method
|
|
296
|
+
def list_sessions: (
|
|
297
|
+
?next_token: ::String,
|
|
298
|
+
?max_results: ::Integer,
|
|
299
|
+
?session_id: ::String,
|
|
300
|
+
?status: ("AVAILABLE" | "BUSY" | "CLOSED"),
|
|
301
|
+
?role_level: bool,
|
|
302
|
+
?cluster_identifier: ::String,
|
|
303
|
+
?workgroup_name: ::String,
|
|
304
|
+
?database: ::String
|
|
305
|
+
) -> _ListSessionsResponseSuccess
|
|
306
|
+
| (?Hash[Symbol, untyped] params, ?Hash[Symbol, untyped] options) -> _ListSessionsResponseSuccess
|
|
307
|
+
|
|
277
308
|
interface _ListStatementsResponseSuccess
|
|
278
309
|
include ::Seahorse::Client::_ResponseSuccess[Types::ListStatementsResponse]
|
|
279
310
|
def statements: () -> ::Array[Types::StatementData]
|
data/sig/errors.rbs
CHANGED
|
@@ -17,6 +17,9 @@ module Aws
|
|
|
17
17
|
class ActiveStatementsExceededException < ::Aws::Errors::ServiceError
|
|
18
18
|
def message: () -> ::String
|
|
19
19
|
end
|
|
20
|
+
class ActiveWaitingRequestsExceededException < ::Aws::Errors::ServiceError
|
|
21
|
+
def message: () -> ::String
|
|
22
|
+
end
|
|
20
23
|
class BatchExecuteStatementException < ::Aws::Errors::ServiceError
|
|
21
24
|
def message: () -> ::String
|
|
22
25
|
def statement_id: () -> ::String
|
data/sig/types.rbs
CHANGED
|
@@ -18,6 +18,11 @@ module Aws::RedshiftDataAPIService
|
|
|
18
18
|
SENSITIVE: []
|
|
19
19
|
end
|
|
20
20
|
|
|
21
|
+
class ActiveWaitingRequestsExceededException
|
|
22
|
+
attr_accessor message: ::String
|
|
23
|
+
SENSITIVE: []
|
|
24
|
+
end
|
|
25
|
+
|
|
21
26
|
class BatchExecuteStatementException
|
|
22
27
|
attr_accessor message: ::String
|
|
23
28
|
attr_accessor statement_id: ::String
|
|
@@ -38,6 +43,8 @@ module Aws::RedshiftDataAPIService
|
|
|
38
43
|
attr_accessor result_format: ("JSON" | "CSV")
|
|
39
44
|
attr_accessor session_keep_alive_seconds: ::Integer
|
|
40
45
|
attr_accessor session_id: ::String
|
|
46
|
+
attr_accessor execution_mode: ("TRANSACTION" | "AUTO_COMMIT")
|
|
47
|
+
attr_accessor wait_time_seconds: ::Integer
|
|
41
48
|
SENSITIVE: []
|
|
42
49
|
end
|
|
43
50
|
|
|
@@ -51,6 +58,9 @@ module Aws::RedshiftDataAPIService
|
|
|
51
58
|
attr_accessor secret_arn: ::String
|
|
52
59
|
attr_accessor workgroup_name: ::String
|
|
53
60
|
attr_accessor session_id: ::String
|
|
61
|
+
attr_accessor status: ("SUBMITTED" | "PICKED" | "STARTED" | "FINISHED" | "ABORTED" | "FAILED")
|
|
62
|
+
attr_accessor redshift_pid: ::Integer
|
|
63
|
+
attr_accessor has_result_set: bool
|
|
54
64
|
SENSITIVE: []
|
|
55
65
|
end
|
|
56
66
|
|
|
@@ -88,6 +98,7 @@ module Aws::RedshiftDataAPIService
|
|
|
88
98
|
|
|
89
99
|
class DescribeStatementRequest
|
|
90
100
|
attr_accessor id: ::String
|
|
101
|
+
attr_accessor wait_time_seconds: ::Integer
|
|
91
102
|
SENSITIVE: []
|
|
92
103
|
end
|
|
93
104
|
|
|
@@ -113,6 +124,7 @@ module Aws::RedshiftDataAPIService
|
|
|
113
124
|
attr_accessor workgroup_name: ::String
|
|
114
125
|
attr_accessor result_format: ("JSON" | "CSV")
|
|
115
126
|
attr_accessor session_id: ::String
|
|
127
|
+
attr_accessor execution_mode: ("TRANSACTION" | "AUTO_COMMIT")
|
|
116
128
|
SENSITIVE: []
|
|
117
129
|
end
|
|
118
130
|
|
|
@@ -157,6 +169,7 @@ module Aws::RedshiftDataAPIService
|
|
|
157
169
|
attr_accessor result_format: ("JSON" | "CSV")
|
|
158
170
|
attr_accessor session_keep_alive_seconds: ::Integer
|
|
159
171
|
attr_accessor session_id: ::String
|
|
172
|
+
attr_accessor wait_time_seconds: ::Integer
|
|
160
173
|
SENSITIVE: []
|
|
161
174
|
end
|
|
162
175
|
|
|
@@ -170,6 +183,9 @@ module Aws::RedshiftDataAPIService
|
|
|
170
183
|
attr_accessor secret_arn: ::String
|
|
171
184
|
attr_accessor workgroup_name: ::String
|
|
172
185
|
attr_accessor session_id: ::String
|
|
186
|
+
attr_accessor status: ("SUBMITTED" | "PICKED" | "STARTED" | "FINISHED" | "ABORTED" | "FAILED")
|
|
187
|
+
attr_accessor redshift_pid: ::Integer
|
|
188
|
+
attr_accessor has_result_set: bool
|
|
173
189
|
SENSITIVE: []
|
|
174
190
|
end
|
|
175
191
|
|
|
@@ -202,6 +218,7 @@ module Aws::RedshiftDataAPIService
|
|
|
202
218
|
class GetStatementResultRequest
|
|
203
219
|
attr_accessor id: ::String
|
|
204
220
|
attr_accessor next_token: ::String
|
|
221
|
+
attr_accessor wait_time_seconds: ::Integer
|
|
205
222
|
SENSITIVE: []
|
|
206
223
|
end
|
|
207
224
|
|
|
@@ -216,6 +233,7 @@ module Aws::RedshiftDataAPIService
|
|
|
216
233
|
class GetStatementResultV2Request
|
|
217
234
|
attr_accessor id: ::String
|
|
218
235
|
attr_accessor next_token: ::String
|
|
236
|
+
attr_accessor wait_time_seconds: ::Integer
|
|
219
237
|
SENSITIVE: []
|
|
220
238
|
end
|
|
221
239
|
|
|
@@ -269,6 +287,24 @@ module Aws::RedshiftDataAPIService
|
|
|
269
287
|
SENSITIVE: []
|
|
270
288
|
end
|
|
271
289
|
|
|
290
|
+
class ListSessionsRequest
|
|
291
|
+
attr_accessor next_token: ::String
|
|
292
|
+
attr_accessor max_results: ::Integer
|
|
293
|
+
attr_accessor session_id: ::String
|
|
294
|
+
attr_accessor status: ("AVAILABLE" | "BUSY" | "CLOSED")
|
|
295
|
+
attr_accessor role_level: bool
|
|
296
|
+
attr_accessor cluster_identifier: ::String
|
|
297
|
+
attr_accessor workgroup_name: ::String
|
|
298
|
+
attr_accessor database: ::String
|
|
299
|
+
SENSITIVE: []
|
|
300
|
+
end
|
|
301
|
+
|
|
302
|
+
class ListSessionsResponse
|
|
303
|
+
attr_accessor sessions: ::Array[Types::SessionData]
|
|
304
|
+
attr_accessor next_token: ::String
|
|
305
|
+
SENSITIVE: []
|
|
306
|
+
end
|
|
307
|
+
|
|
272
308
|
class ListStatementsRequest
|
|
273
309
|
attr_accessor next_token: ::String
|
|
274
310
|
attr_accessor max_results: ::Integer
|
|
@@ -329,6 +365,21 @@ module Aws::RedshiftDataAPIService
|
|
|
329
365
|
SENSITIVE: []
|
|
330
366
|
end
|
|
331
367
|
|
|
368
|
+
class SessionData
|
|
369
|
+
attr_accessor session_id: ::String
|
|
370
|
+
attr_accessor status: ("AVAILABLE" | "BUSY" | "CLOSED")
|
|
371
|
+
attr_accessor created_at: ::Time
|
|
372
|
+
attr_accessor updated_at: ::Time
|
|
373
|
+
attr_accessor database: ::String
|
|
374
|
+
attr_accessor db_user: ::String
|
|
375
|
+
attr_accessor cluster_identifier: ::String
|
|
376
|
+
attr_accessor workgroup_name: ::String
|
|
377
|
+
attr_accessor session_alive_seconds: ::Integer
|
|
378
|
+
attr_accessor session_ttl: ::Time
|
|
379
|
+
attr_accessor current_statement_id: ::String
|
|
380
|
+
SENSITIVE: []
|
|
381
|
+
end
|
|
382
|
+
|
|
332
383
|
class SqlParameter
|
|
333
384
|
attr_accessor name: ::String
|
|
334
385
|
attr_accessor value: ::String
|