aws-sdk-redshiftdataapiservice 1.64.0 → 1.65.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 +289 -289
- data/lib/aws-sdk-redshiftdataapiservice/client_api.rb +97 -89
- data/lib/aws-sdk-redshiftdataapiservice/types.rb +506 -507
- data/lib/aws-sdk-redshiftdataapiservice.rb +1 -1
- data/sig/client.rbs +68 -68
- data/sig/types.rbs +91 -91
- metadata +1 -1
|
@@ -526,104 +526,104 @@ module Aws::RedshiftDataAPIService
|
|
|
526
526
|
#
|
|
527
527
|
# [1]: https://docs.aws.amazon.com/redshift/latest/mgmt/data-api.html
|
|
528
528
|
#
|
|
529
|
-
# @option params [String] :
|
|
530
|
-
#
|
|
531
|
-
#
|
|
532
|
-
#
|
|
533
|
-
#
|
|
534
|
-
#
|
|
529
|
+
# @option params [required, Array<String>] :sqls
|
|
530
|
+
# One or more SQL statements to run. The SQL statements are run as a
|
|
531
|
+
# single transaction. They run serially in the order of the array.
|
|
532
|
+
# Subsequent SQL statements don't start until the previous statement in
|
|
533
|
+
# the array completes. If any SQL statement fails, then because they are
|
|
534
|
+
# run as one transaction, all work is rolled back.
|
|
535
535
|
#
|
|
536
536
|
# @option params [String] :cluster_identifier
|
|
537
537
|
# The cluster identifier. This parameter is required when connecting to
|
|
538
538
|
# a cluster and authenticating using either Secrets Manager or temporary
|
|
539
539
|
# credentials.
|
|
540
540
|
#
|
|
541
|
-
# @option params [String] :
|
|
542
|
-
# The name of the
|
|
543
|
-
# authenticating using
|
|
541
|
+
# @option params [String] :secret_arn
|
|
542
|
+
# The name or ARN of the secret that enables access to the database.
|
|
543
|
+
# This parameter is required when authenticating using Secrets Manager.
|
|
544
544
|
#
|
|
545
545
|
# @option params [String] :db_user
|
|
546
546
|
# The database user name. This parameter is required when connecting to
|
|
547
547
|
# a cluster as a database user and authenticating using temporary
|
|
548
548
|
# credentials.
|
|
549
549
|
#
|
|
550
|
-
# @option params [String] :
|
|
551
|
-
# The
|
|
552
|
-
#
|
|
553
|
-
#
|
|
554
|
-
# @option params [String] :secret_arn
|
|
555
|
-
# The name or ARN of the secret that enables access to the database.
|
|
556
|
-
# This parameter is required when authenticating using Secrets Manager.
|
|
557
|
-
#
|
|
558
|
-
# @option params [String] :session_id
|
|
559
|
-
# The session identifier of the query.
|
|
560
|
-
#
|
|
561
|
-
# @option params [Integer] :session_keep_alive_seconds
|
|
562
|
-
# The number of seconds to keep the session alive after the query
|
|
563
|
-
# finishes. The maximum time a session can keep alive is 24 hours. After
|
|
564
|
-
# 24 hours, the session is forced closed and the query is terminated.
|
|
550
|
+
# @option params [String] :database
|
|
551
|
+
# The name of the database. This parameter is required when
|
|
552
|
+
# authenticating using either Secrets Manager or temporary credentials.
|
|
565
553
|
#
|
|
566
|
-
# @option params [
|
|
567
|
-
#
|
|
568
|
-
#
|
|
569
|
-
# Subsequent SQL statements don't start until the previous statement in
|
|
570
|
-
# the array completes. If any SQL statement fails, then because they are
|
|
571
|
-
# run as one transaction, all work is rolled back.</p>
|
|
554
|
+
# @option params [Boolean] :with_event
|
|
555
|
+
# A value that indicates whether to send an event to the Amazon
|
|
556
|
+
# EventBridge event bus after the SQL statements run.
|
|
572
557
|
#
|
|
573
558
|
# @option params [String] :statement_name
|
|
574
559
|
# The name of the SQL statements. You can name the SQL statements when
|
|
575
560
|
# you create them to identify the query.
|
|
576
561
|
#
|
|
577
|
-
# @option params [Boolean] :with_event
|
|
578
|
-
# A value that indicates whether to send an event to the Amazon
|
|
579
|
-
# EventBridge event bus after the SQL statements run.
|
|
580
|
-
#
|
|
581
562
|
# @option params [String] :workgroup_name
|
|
582
563
|
# The serverless workgroup name or Amazon Resource Name (ARN). This
|
|
583
564
|
# parameter is required when connecting to a serverless workgroup and
|
|
584
565
|
# authenticating using either Secrets Manager or temporary credentials.
|
|
585
566
|
#
|
|
567
|
+
# @option params [String] :client_token
|
|
568
|
+
# A unique, case-sensitive identifier that you provide to ensure the
|
|
569
|
+
# idempotency of the request.
|
|
570
|
+
#
|
|
571
|
+
# **A suitable default value is auto-generated.** You should normally
|
|
572
|
+
# not need to pass this option.**
|
|
573
|
+
#
|
|
574
|
+
# @option params [String] :result_format
|
|
575
|
+
# The data format of the result of the SQL statement. If no format is
|
|
576
|
+
# specified, the default is JSON.
|
|
577
|
+
#
|
|
578
|
+
# @option params [Integer] :session_keep_alive_seconds
|
|
579
|
+
# The number of seconds to keep the session alive after the query
|
|
580
|
+
# finishes. The maximum time a session can keep alive is 24 hours. After
|
|
581
|
+
# 24 hours, the session is forced closed and the query is terminated.
|
|
582
|
+
#
|
|
583
|
+
# @option params [String] :session_id
|
|
584
|
+
# The session identifier of the query.
|
|
585
|
+
#
|
|
586
586
|
# @return [Types::BatchExecuteStatementOutput] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
|
587
587
|
#
|
|
588
|
-
# * {Types::BatchExecuteStatementOutput#
|
|
588
|
+
# * {Types::BatchExecuteStatementOutput#id #id} => String
|
|
589
589
|
# * {Types::BatchExecuteStatementOutput#created_at #created_at} => Time
|
|
590
|
-
# * {Types::BatchExecuteStatementOutput#
|
|
591
|
-
# * {Types::BatchExecuteStatementOutput#db_groups #db_groups} => Array<String>
|
|
590
|
+
# * {Types::BatchExecuteStatementOutput#cluster_identifier #cluster_identifier} => String
|
|
592
591
|
# * {Types::BatchExecuteStatementOutput#db_user #db_user} => String
|
|
593
|
-
# * {Types::BatchExecuteStatementOutput#
|
|
592
|
+
# * {Types::BatchExecuteStatementOutput#db_groups #db_groups} => Array<String>
|
|
593
|
+
# * {Types::BatchExecuteStatementOutput#database #database} => String
|
|
594
594
|
# * {Types::BatchExecuteStatementOutput#secret_arn #secret_arn} => String
|
|
595
|
-
# * {Types::BatchExecuteStatementOutput#session_id #session_id} => String
|
|
596
595
|
# * {Types::BatchExecuteStatementOutput#workgroup_name #workgroup_name} => String
|
|
596
|
+
# * {Types::BatchExecuteStatementOutput#session_id #session_id} => String
|
|
597
597
|
#
|
|
598
598
|
# @example Request syntax with placeholder values
|
|
599
599
|
#
|
|
600
600
|
# resp = client.batch_execute_statement({
|
|
601
|
-
#
|
|
601
|
+
# sqls: ["StatementString"], # required
|
|
602
602
|
# cluster_identifier: "ClusterIdentifierString",
|
|
603
|
-
# database: "String",
|
|
604
|
-
# db_user: "String",
|
|
605
|
-
# result_format: "JSON", # accepts JSON, CSV
|
|
606
603
|
# secret_arn: "SecretArn",
|
|
607
|
-
#
|
|
608
|
-
#
|
|
609
|
-
# sqls: ["StatementString"], # required
|
|
610
|
-
# statement_name: "StatementNameString",
|
|
604
|
+
# db_user: "String",
|
|
605
|
+
# database: "String",
|
|
611
606
|
# with_event: false,
|
|
607
|
+
# statement_name: "StatementNameString",
|
|
612
608
|
# workgroup_name: "WorkgroupNameString",
|
|
609
|
+
# client_token: "ClientToken",
|
|
610
|
+
# result_format: "JSON", # accepts JSON, CSV
|
|
611
|
+
# session_keep_alive_seconds: 1,
|
|
612
|
+
# session_id: "UUID",
|
|
613
613
|
# })
|
|
614
614
|
#
|
|
615
615
|
# @example Response structure
|
|
616
616
|
#
|
|
617
|
-
# resp.
|
|
617
|
+
# resp.id #=> String
|
|
618
618
|
# resp.created_at #=> Time
|
|
619
|
-
# resp.
|
|
619
|
+
# resp.cluster_identifier #=> String
|
|
620
|
+
# resp.db_user #=> String
|
|
620
621
|
# resp.db_groups #=> Array
|
|
621
622
|
# resp.db_groups[0] #=> String
|
|
622
|
-
# resp.
|
|
623
|
-
# resp.id #=> String
|
|
623
|
+
# resp.database #=> String
|
|
624
624
|
# resp.secret_arn #=> String
|
|
625
|
-
# resp.session_id #=> String
|
|
626
625
|
# resp.workgroup_name #=> String
|
|
626
|
+
# resp.session_id #=> String
|
|
627
627
|
#
|
|
628
628
|
# @see http://docs.aws.amazon.com/goto/WebAPI/redshift-data-2019-12-20/BatchExecuteStatement AWS API Documentation
|
|
629
629
|
#
|
|
@@ -697,27 +697,27 @@ module Aws::RedshiftDataAPIService
|
|
|
697
697
|
#
|
|
698
698
|
# @return [Types::DescribeStatementResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
|
699
699
|
#
|
|
700
|
-
# * {Types::DescribeStatementResponse#
|
|
701
|
-
# * {Types::DescribeStatementResponse#
|
|
702
|
-
# * {Types::DescribeStatementResponse#database #database} => String
|
|
700
|
+
# * {Types::DescribeStatementResponse#id #id} => String
|
|
701
|
+
# * {Types::DescribeStatementResponse#secret_arn #secret_arn} => String
|
|
703
702
|
# * {Types::DescribeStatementResponse#db_user #db_user} => String
|
|
703
|
+
# * {Types::DescribeStatementResponse#database #database} => String
|
|
704
|
+
# * {Types::DescribeStatementResponse#cluster_identifier #cluster_identifier} => String
|
|
704
705
|
# * {Types::DescribeStatementResponse#duration #duration} => Integer
|
|
705
706
|
# * {Types::DescribeStatementResponse#error #error} => String
|
|
707
|
+
# * {Types::DescribeStatementResponse#status #status} => String
|
|
708
|
+
# * {Types::DescribeStatementResponse#created_at #created_at} => Time
|
|
709
|
+
# * {Types::DescribeStatementResponse#updated_at #updated_at} => Time
|
|
710
|
+
# * {Types::DescribeStatementResponse#redshift_pid #redshift_pid} => Integer
|
|
706
711
|
# * {Types::DescribeStatementResponse#has_result_set #has_result_set} => Boolean
|
|
707
|
-
# * {Types::DescribeStatementResponse#id #id} => String
|
|
708
|
-
# * {Types::DescribeStatementResponse#query_parameters #query_parameters} => Array<Types::SqlParameter>
|
|
709
712
|
# * {Types::DescribeStatementResponse#query_string #query_string} => String
|
|
710
|
-
# * {Types::DescribeStatementResponse#redshift_pid #redshift_pid} => Integer
|
|
711
|
-
# * {Types::DescribeStatementResponse#redshift_query_id #redshift_query_id} => Integer
|
|
712
|
-
# * {Types::DescribeStatementResponse#result_format #result_format} => String
|
|
713
713
|
# * {Types::DescribeStatementResponse#result_rows #result_rows} => Integer
|
|
714
714
|
# * {Types::DescribeStatementResponse#result_size #result_size} => Integer
|
|
715
|
-
# * {Types::DescribeStatementResponse#
|
|
716
|
-
# * {Types::DescribeStatementResponse#
|
|
717
|
-
# * {Types::DescribeStatementResponse#status #status} => String
|
|
715
|
+
# * {Types::DescribeStatementResponse#redshift_query_id #redshift_query_id} => Integer
|
|
716
|
+
# * {Types::DescribeStatementResponse#query_parameters #query_parameters} => Array<Types::SqlParameter>
|
|
718
717
|
# * {Types::DescribeStatementResponse#sub_statements #sub_statements} => Array<Types::SubStatementData>
|
|
719
|
-
# * {Types::DescribeStatementResponse#updated_at #updated_at} => Time
|
|
720
718
|
# * {Types::DescribeStatementResponse#workgroup_name #workgroup_name} => String
|
|
719
|
+
# * {Types::DescribeStatementResponse#result_format #result_format} => String
|
|
720
|
+
# * {Types::DescribeStatementResponse#session_id #session_id} => String
|
|
721
721
|
#
|
|
722
722
|
# @example Request syntax with placeholder values
|
|
723
723
|
#
|
|
@@ -727,40 +727,40 @@ module Aws::RedshiftDataAPIService
|
|
|
727
727
|
#
|
|
728
728
|
# @example Response structure
|
|
729
729
|
#
|
|
730
|
-
# resp.
|
|
731
|
-
# resp.
|
|
732
|
-
# resp.database #=> String
|
|
730
|
+
# resp.id #=> String
|
|
731
|
+
# resp.secret_arn #=> String
|
|
733
732
|
# resp.db_user #=> String
|
|
733
|
+
# resp.database #=> String
|
|
734
|
+
# resp.cluster_identifier #=> String
|
|
734
735
|
# resp.duration #=> Integer
|
|
735
736
|
# resp.error #=> String
|
|
737
|
+
# resp.status #=> String, one of "SUBMITTED", "PICKED", "STARTED", "FINISHED", "ABORTED", "FAILED", "ALL"
|
|
738
|
+
# resp.created_at #=> Time
|
|
739
|
+
# resp.updated_at #=> Time
|
|
740
|
+
# resp.redshift_pid #=> Integer
|
|
736
741
|
# resp.has_result_set #=> Boolean
|
|
737
|
-
# resp.id #=> String
|
|
738
|
-
# resp.query_parameters #=> Array
|
|
739
|
-
# resp.query_parameters[0].name #=> String
|
|
740
|
-
# resp.query_parameters[0].value #=> String
|
|
741
742
|
# resp.query_string #=> String
|
|
742
|
-
# resp.redshift_pid #=> Integer
|
|
743
|
-
# resp.redshift_query_id #=> Integer
|
|
744
|
-
# resp.result_format #=> String, one of "JSON", "CSV"
|
|
745
743
|
# resp.result_rows #=> Integer
|
|
746
744
|
# resp.result_size #=> Integer
|
|
747
|
-
# resp.
|
|
748
|
-
# resp.
|
|
749
|
-
# resp.
|
|
745
|
+
# resp.redshift_query_id #=> Integer
|
|
746
|
+
# resp.query_parameters #=> Array
|
|
747
|
+
# resp.query_parameters[0].name #=> String
|
|
748
|
+
# resp.query_parameters[0].value #=> String
|
|
750
749
|
# resp.sub_statements #=> Array
|
|
751
|
-
# resp.sub_statements[0].
|
|
750
|
+
# resp.sub_statements[0].id #=> String
|
|
752
751
|
# resp.sub_statements[0].duration #=> Integer
|
|
753
752
|
# resp.sub_statements[0].error #=> String
|
|
754
|
-
# resp.sub_statements[0].
|
|
755
|
-
# resp.sub_statements[0].
|
|
753
|
+
# resp.sub_statements[0].status #=> String, one of "SUBMITTED", "PICKED", "STARTED", "FINISHED", "ABORTED", "FAILED"
|
|
754
|
+
# resp.sub_statements[0].created_at #=> Time
|
|
755
|
+
# resp.sub_statements[0].updated_at #=> Time
|
|
756
756
|
# resp.sub_statements[0].query_string #=> String
|
|
757
|
-
# resp.sub_statements[0].redshift_query_id #=> Integer
|
|
758
757
|
# resp.sub_statements[0].result_rows #=> Integer
|
|
759
758
|
# resp.sub_statements[0].result_size #=> Integer
|
|
760
|
-
# resp.sub_statements[0].
|
|
761
|
-
# resp.sub_statements[0].
|
|
762
|
-
# resp.updated_at #=> Time
|
|
759
|
+
# resp.sub_statements[0].redshift_query_id #=> Integer
|
|
760
|
+
# resp.sub_statements[0].has_result_set #=> Boolean
|
|
763
761
|
# resp.workgroup_name #=> String
|
|
762
|
+
# resp.result_format #=> String, one of "JSON", "CSV"
|
|
763
|
+
# resp.session_id #=> String
|
|
764
764
|
#
|
|
765
765
|
# @see http://docs.aws.amazon.com/goto/WebAPI/redshift-data-2019-12-20/DescribeStatement AWS API Documentation
|
|
766
766
|
#
|
|
@@ -819,46 +819,46 @@ module Aws::RedshiftDataAPIService
|
|
|
819
819
|
# a cluster and authenticating using either Secrets Manager or temporary
|
|
820
820
|
# credentials.
|
|
821
821
|
#
|
|
822
|
-
# @option params [String] :
|
|
823
|
-
#
|
|
824
|
-
#
|
|
825
|
-
#
|
|
826
|
-
# @option params [required, String] :database
|
|
827
|
-
# The name of the database that contains the tables to be described. If
|
|
828
|
-
# `ConnectedDatabase` is not specified, this is also the database to
|
|
829
|
-
# connect to with your authentication credentials.
|
|
822
|
+
# @option params [String] :secret_arn
|
|
823
|
+
# The name or ARN of the secret that enables access to the database.
|
|
824
|
+
# This parameter is required when authenticating using Secrets Manager.
|
|
830
825
|
#
|
|
831
826
|
# @option params [String] :db_user
|
|
832
827
|
# The database user name. This parameter is required when connecting to
|
|
833
828
|
# a cluster as a database user and authenticating using temporary
|
|
834
829
|
# credentials.
|
|
835
830
|
#
|
|
836
|
-
# @option params [
|
|
837
|
-
# The
|
|
838
|
-
#
|
|
839
|
-
#
|
|
831
|
+
# @option params [required, String] :database
|
|
832
|
+
# The name of the database that contains the tables to be described. If
|
|
833
|
+
# `ConnectedDatabase` is not specified, this is also the database to
|
|
834
|
+
# connect to with your authentication credentials.
|
|
840
835
|
#
|
|
841
|
-
# @option params [String] :
|
|
842
|
-
# A
|
|
843
|
-
#
|
|
844
|
-
# you can retrieve the next set of records by providing this returned
|
|
845
|
-
# NextToken value in the next NextToken parameter and retrying the
|
|
846
|
-
# command. If the NextToken field is empty, all response records have
|
|
847
|
-
# been retrieved for the request.
|
|
836
|
+
# @option params [String] :connected_database
|
|
837
|
+
# A database name. The connected database is specified when you connect
|
|
838
|
+
# with your authentication credentials.
|
|
848
839
|
#
|
|
849
840
|
# @option params [String] :schema
|
|
850
841
|
# The schema that contains the table. If no schema is specified, then
|
|
851
842
|
# matching tables for all schemas are returned.
|
|
852
843
|
#
|
|
853
|
-
# @option params [String] :secret_arn
|
|
854
|
-
# The name or ARN of the secret that enables access to the database.
|
|
855
|
-
# This parameter is required when authenticating using Secrets Manager.
|
|
856
|
-
#
|
|
857
844
|
# @option params [String] :table
|
|
858
845
|
# The table name. If no table is specified, then all tables for all
|
|
859
846
|
# matching schemas are returned. If no table and no schema is specified,
|
|
860
847
|
# then all tables for all schemas in the database are returned
|
|
861
848
|
#
|
|
849
|
+
# @option params [String] :next_token
|
|
850
|
+
# A value that indicates the starting point for the next set of response
|
|
851
|
+
# records in a subsequent request. If a value is returned in a response,
|
|
852
|
+
# you can retrieve the next set of records by providing this returned
|
|
853
|
+
# NextToken value in the next NextToken parameter and retrying the
|
|
854
|
+
# command. If the NextToken field is empty, all response records have
|
|
855
|
+
# been retrieved for the request.
|
|
856
|
+
#
|
|
857
|
+
# @option params [Integer] :max_results
|
|
858
|
+
# The maximum number of tables to return in the response. If more tables
|
|
859
|
+
# exist than fit in one response, then `NextToken` is returned to page
|
|
860
|
+
# through the results.
|
|
861
|
+
#
|
|
862
862
|
# @option params [String] :workgroup_name
|
|
863
863
|
# The serverless workgroup name or Amazon Resource Name (ARN). This
|
|
864
864
|
# parameter is required when connecting to a serverless workgroup and
|
|
@@ -866,9 +866,9 @@ module Aws::RedshiftDataAPIService
|
|
|
866
866
|
#
|
|
867
867
|
# @return [Types::DescribeTableResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
|
868
868
|
#
|
|
869
|
+
# * {Types::DescribeTableResponse#table_name #table_name} => String
|
|
869
870
|
# * {Types::DescribeTableResponse#column_list #column_list} => Array<Types::ColumnMetadata>
|
|
870
871
|
# * {Types::DescribeTableResponse#next_token #next_token} => String
|
|
871
|
-
# * {Types::DescribeTableResponse#table_name #table_name} => String
|
|
872
872
|
#
|
|
873
873
|
# The returned {Seahorse::Client::Response response} is a pageable response and is Enumerable. For details on usage see {Aws::PageableResponse PageableResponse}.
|
|
874
874
|
#
|
|
@@ -876,26 +876,25 @@ module Aws::RedshiftDataAPIService
|
|
|
876
876
|
#
|
|
877
877
|
# resp = client.describe_table({
|
|
878
878
|
# cluster_identifier: "ClusterIdentifierString",
|
|
879
|
-
#
|
|
880
|
-
# database: "String", # required
|
|
879
|
+
# secret_arn: "SecretArn",
|
|
881
880
|
# db_user: "String",
|
|
882
|
-
#
|
|
883
|
-
#
|
|
881
|
+
# database: "String", # required
|
|
882
|
+
# connected_database: "String",
|
|
884
883
|
# schema: "String",
|
|
885
|
-
# secret_arn: "SecretArn",
|
|
886
884
|
# table: "String",
|
|
885
|
+
# next_token: "String",
|
|
886
|
+
# max_results: 1,
|
|
887
887
|
# workgroup_name: "WorkgroupNameString",
|
|
888
888
|
# })
|
|
889
889
|
#
|
|
890
890
|
# @example Response structure
|
|
891
891
|
#
|
|
892
|
+
# resp.table_name #=> String
|
|
892
893
|
# resp.column_list #=> Array
|
|
893
|
-
# resp.column_list[0].column_default #=> String
|
|
894
894
|
# resp.column_list[0].is_case_sensitive #=> Boolean
|
|
895
895
|
# resp.column_list[0].is_currency #=> Boolean
|
|
896
896
|
# resp.column_list[0].is_signed #=> Boolean
|
|
897
897
|
# resp.column_list[0].label #=> String
|
|
898
|
-
# resp.column_list[0].length #=> Integer
|
|
899
898
|
# resp.column_list[0].name #=> String
|
|
900
899
|
# resp.column_list[0].nullable #=> Integer
|
|
901
900
|
# resp.column_list[0].precision #=> Integer
|
|
@@ -903,8 +902,9 @@ module Aws::RedshiftDataAPIService
|
|
|
903
902
|
# resp.column_list[0].schema_name #=> String
|
|
904
903
|
# resp.column_list[0].table_name #=> String
|
|
905
904
|
# resp.column_list[0].type_name #=> String
|
|
905
|
+
# resp.column_list[0].length #=> Integer
|
|
906
|
+
# resp.column_list[0].column_default #=> String
|
|
906
907
|
# resp.next_token #=> String
|
|
907
|
-
# resp.table_name #=> String
|
|
908
908
|
#
|
|
909
909
|
# @see http://docs.aws.amazon.com/goto/WebAPI/redshift-data-2019-12-20/DescribeTable AWS API Documentation
|
|
910
910
|
#
|
|
@@ -958,109 +958,109 @@ module Aws::RedshiftDataAPIService
|
|
|
958
958
|
#
|
|
959
959
|
# [1]: https://docs.aws.amazon.com/redshift/latest/mgmt/data-api.html
|
|
960
960
|
#
|
|
961
|
-
# @option params [String] :
|
|
962
|
-
#
|
|
963
|
-
# idempotency of the request.
|
|
964
|
-
#
|
|
965
|
-
# **A suitable default value is auto-generated.** You should normally
|
|
966
|
-
# not need to pass this option.**
|
|
961
|
+
# @option params [required, String] :sql
|
|
962
|
+
# The SQL statement text to run.
|
|
967
963
|
#
|
|
968
964
|
# @option params [String] :cluster_identifier
|
|
969
965
|
# The cluster identifier. This parameter is required when connecting to
|
|
970
966
|
# a cluster and authenticating using either Secrets Manager or temporary
|
|
971
967
|
# credentials.
|
|
972
968
|
#
|
|
973
|
-
# @option params [String] :
|
|
974
|
-
# The name of the
|
|
975
|
-
# authenticating using
|
|
969
|
+
# @option params [String] :secret_arn
|
|
970
|
+
# The name or ARN of the secret that enables access to the database.
|
|
971
|
+
# This parameter is required when authenticating using Secrets Manager.
|
|
976
972
|
#
|
|
977
973
|
# @option params [String] :db_user
|
|
978
974
|
# The database user name. This parameter is required when connecting to
|
|
979
975
|
# a cluster as a database user and authenticating using temporary
|
|
980
976
|
# credentials.
|
|
981
977
|
#
|
|
978
|
+
# @option params [String] :database
|
|
979
|
+
# The name of the database. This parameter is required when
|
|
980
|
+
# authenticating using either Secrets Manager or temporary credentials.
|
|
981
|
+
#
|
|
982
|
+
# @option params [Boolean] :with_event
|
|
983
|
+
# A value that indicates whether to send an event to the Amazon
|
|
984
|
+
# EventBridge event bus after the SQL statement runs.
|
|
985
|
+
#
|
|
986
|
+
# @option params [String] :statement_name
|
|
987
|
+
# The name of the SQL statement. You can name the SQL statement when you
|
|
988
|
+
# create it to identify the query.
|
|
989
|
+
#
|
|
982
990
|
# @option params [Array<Types::SqlParameter>] :parameters
|
|
983
991
|
# The parameters for the SQL statement.
|
|
984
992
|
#
|
|
993
|
+
# @option params [String] :workgroup_name
|
|
994
|
+
# The serverless workgroup name or Amazon Resource Name (ARN). This
|
|
995
|
+
# parameter is required when connecting to a serverless workgroup and
|
|
996
|
+
# authenticating using either Secrets Manager or temporary credentials.
|
|
997
|
+
#
|
|
998
|
+
# @option params [String] :client_token
|
|
999
|
+
# A unique, case-sensitive identifier that you provide to ensure the
|
|
1000
|
+
# idempotency of the request.
|
|
1001
|
+
#
|
|
1002
|
+
# **A suitable default value is auto-generated.** You should normally
|
|
1003
|
+
# not need to pass this option.**
|
|
1004
|
+
#
|
|
985
1005
|
# @option params [String] :result_format
|
|
986
1006
|
# The data format of the result of the SQL statement. If no format is
|
|
987
1007
|
# specified, the default is JSON.
|
|
988
1008
|
#
|
|
989
|
-
# @option params [String] :secret_arn
|
|
990
|
-
# The name or ARN of the secret that enables access to the database.
|
|
991
|
-
# This parameter is required when authenticating using Secrets Manager.
|
|
992
|
-
#
|
|
993
|
-
# @option params [String] :session_id
|
|
994
|
-
# The session identifier of the query.
|
|
995
|
-
#
|
|
996
1009
|
# @option params [Integer] :session_keep_alive_seconds
|
|
997
1010
|
# The number of seconds to keep the session alive after the query
|
|
998
1011
|
# finishes. The maximum time a session can keep alive is 24 hours. After
|
|
999
1012
|
# 24 hours, the session is forced closed and the query is terminated.
|
|
1000
1013
|
#
|
|
1001
|
-
# @option params [
|
|
1002
|
-
# The
|
|
1003
|
-
#
|
|
1004
|
-
# @option params [String] :statement_name
|
|
1005
|
-
# The name of the SQL statement. You can name the SQL statement when you
|
|
1006
|
-
# create it to identify the query.
|
|
1007
|
-
#
|
|
1008
|
-
# @option params [Boolean] :with_event
|
|
1009
|
-
# A value that indicates whether to send an event to the Amazon
|
|
1010
|
-
# EventBridge event bus after the SQL statement runs.
|
|
1011
|
-
#
|
|
1012
|
-
# @option params [String] :workgroup_name
|
|
1013
|
-
# The serverless workgroup name or Amazon Resource Name (ARN). This
|
|
1014
|
-
# parameter is required when connecting to a serverless workgroup and
|
|
1015
|
-
# authenticating using either Secrets Manager or temporary credentials.
|
|
1014
|
+
# @option params [String] :session_id
|
|
1015
|
+
# The session identifier of the query.
|
|
1016
1016
|
#
|
|
1017
1017
|
# @return [Types::ExecuteStatementOutput] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
|
1018
1018
|
#
|
|
1019
|
-
# * {Types::ExecuteStatementOutput#
|
|
1019
|
+
# * {Types::ExecuteStatementOutput#id #id} => String
|
|
1020
1020
|
# * {Types::ExecuteStatementOutput#created_at #created_at} => Time
|
|
1021
|
-
# * {Types::ExecuteStatementOutput#
|
|
1022
|
-
# * {Types::ExecuteStatementOutput#db_groups #db_groups} => Array<String>
|
|
1021
|
+
# * {Types::ExecuteStatementOutput#cluster_identifier #cluster_identifier} => String
|
|
1023
1022
|
# * {Types::ExecuteStatementOutput#db_user #db_user} => String
|
|
1024
|
-
# * {Types::ExecuteStatementOutput#
|
|
1023
|
+
# * {Types::ExecuteStatementOutput#db_groups #db_groups} => Array<String>
|
|
1024
|
+
# * {Types::ExecuteStatementOutput#database #database} => String
|
|
1025
1025
|
# * {Types::ExecuteStatementOutput#secret_arn #secret_arn} => String
|
|
1026
|
-
# * {Types::ExecuteStatementOutput#session_id #session_id} => String
|
|
1027
1026
|
# * {Types::ExecuteStatementOutput#workgroup_name #workgroup_name} => String
|
|
1027
|
+
# * {Types::ExecuteStatementOutput#session_id #session_id} => String
|
|
1028
1028
|
#
|
|
1029
1029
|
# @example Request syntax with placeholder values
|
|
1030
1030
|
#
|
|
1031
1031
|
# resp = client.execute_statement({
|
|
1032
|
-
#
|
|
1032
|
+
# sql: "StatementString", # required
|
|
1033
1033
|
# cluster_identifier: "ClusterIdentifierString",
|
|
1034
|
-
#
|
|
1034
|
+
# secret_arn: "SecretArn",
|
|
1035
1035
|
# db_user: "String",
|
|
1036
|
+
# database: "String",
|
|
1037
|
+
# with_event: false,
|
|
1038
|
+
# statement_name: "StatementNameString",
|
|
1036
1039
|
# parameters: [
|
|
1037
1040
|
# {
|
|
1038
1041
|
# name: "ParameterName", # required
|
|
1039
1042
|
# value: "ParameterValue", # required
|
|
1040
1043
|
# },
|
|
1041
1044
|
# ],
|
|
1045
|
+
# workgroup_name: "WorkgroupNameString",
|
|
1046
|
+
# client_token: "ClientToken",
|
|
1042
1047
|
# result_format: "JSON", # accepts JSON, CSV
|
|
1043
|
-
# secret_arn: "SecretArn",
|
|
1044
|
-
# session_id: "UUID",
|
|
1045
1048
|
# session_keep_alive_seconds: 1,
|
|
1046
|
-
#
|
|
1047
|
-
# statement_name: "StatementNameString",
|
|
1048
|
-
# with_event: false,
|
|
1049
|
-
# workgroup_name: "WorkgroupNameString",
|
|
1049
|
+
# session_id: "UUID",
|
|
1050
1050
|
# })
|
|
1051
1051
|
#
|
|
1052
1052
|
# @example Response structure
|
|
1053
1053
|
#
|
|
1054
|
-
# resp.
|
|
1054
|
+
# resp.id #=> String
|
|
1055
1055
|
# resp.created_at #=> Time
|
|
1056
|
-
# resp.
|
|
1056
|
+
# resp.cluster_identifier #=> String
|
|
1057
|
+
# resp.db_user #=> String
|
|
1057
1058
|
# resp.db_groups #=> Array
|
|
1058
1059
|
# resp.db_groups[0] #=> String
|
|
1059
|
-
# resp.
|
|
1060
|
-
# resp.id #=> String
|
|
1060
|
+
# resp.database #=> String
|
|
1061
1061
|
# resp.secret_arn #=> String
|
|
1062
|
-
# resp.session_id #=> String
|
|
1063
1062
|
# resp.workgroup_name #=> String
|
|
1063
|
+
# resp.session_id #=> String
|
|
1064
1064
|
#
|
|
1065
1065
|
# @see http://docs.aws.amazon.com/goto/WebAPI/redshift-data-2019-12-20/ExecuteStatement AWS API Documentation
|
|
1066
1066
|
#
|
|
@@ -1104,10 +1104,10 @@ module Aws::RedshiftDataAPIService
|
|
|
1104
1104
|
#
|
|
1105
1105
|
# @return [Types::GetStatementResultResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
|
1106
1106
|
#
|
|
1107
|
-
# * {Types::GetStatementResultResponse#column_metadata #column_metadata} => Array<Types::ColumnMetadata>
|
|
1108
|
-
# * {Types::GetStatementResultResponse#next_token #next_token} => String
|
|
1109
1107
|
# * {Types::GetStatementResultResponse#records #records} => Array<Array<Types::Field>>
|
|
1108
|
+
# * {Types::GetStatementResultResponse#column_metadata #column_metadata} => Array<Types::ColumnMetadata>
|
|
1110
1109
|
# * {Types::GetStatementResultResponse#total_num_rows #total_num_rows} => Integer
|
|
1110
|
+
# * {Types::GetStatementResultResponse#next_token #next_token} => String
|
|
1111
1111
|
#
|
|
1112
1112
|
# The returned {Seahorse::Client::Response response} is a pageable response and is Enumerable. For details on usage see {Aws::PageableResponse PageableResponse}.
|
|
1113
1113
|
#
|
|
@@ -1120,13 +1120,19 @@ module Aws::RedshiftDataAPIService
|
|
|
1120
1120
|
#
|
|
1121
1121
|
# @example Response structure
|
|
1122
1122
|
#
|
|
1123
|
+
# resp.records #=> Array
|
|
1124
|
+
# resp.records[0] #=> Array
|
|
1125
|
+
# resp.records[0][0].is_null #=> Boolean
|
|
1126
|
+
# resp.records[0][0].boolean_value #=> Boolean
|
|
1127
|
+
# resp.records[0][0].long_value #=> Integer
|
|
1128
|
+
# resp.records[0][0].double_value #=> Float
|
|
1129
|
+
# resp.records[0][0].string_value #=> String
|
|
1130
|
+
# resp.records[0][0].blob_value #=> String
|
|
1123
1131
|
# resp.column_metadata #=> Array
|
|
1124
|
-
# resp.column_metadata[0].column_default #=> String
|
|
1125
1132
|
# resp.column_metadata[0].is_case_sensitive #=> Boolean
|
|
1126
1133
|
# resp.column_metadata[0].is_currency #=> Boolean
|
|
1127
1134
|
# resp.column_metadata[0].is_signed #=> Boolean
|
|
1128
1135
|
# resp.column_metadata[0].label #=> String
|
|
1129
|
-
# resp.column_metadata[0].length #=> Integer
|
|
1130
1136
|
# resp.column_metadata[0].name #=> String
|
|
1131
1137
|
# resp.column_metadata[0].nullable #=> Integer
|
|
1132
1138
|
# resp.column_metadata[0].precision #=> Integer
|
|
@@ -1134,16 +1140,10 @@ module Aws::RedshiftDataAPIService
|
|
|
1134
1140
|
# resp.column_metadata[0].schema_name #=> String
|
|
1135
1141
|
# resp.column_metadata[0].table_name #=> String
|
|
1136
1142
|
# resp.column_metadata[0].type_name #=> String
|
|
1137
|
-
# resp.
|
|
1138
|
-
# resp.
|
|
1139
|
-
# resp.records[0] #=> Array
|
|
1140
|
-
# resp.records[0][0].blob_value #=> String
|
|
1141
|
-
# resp.records[0][0].boolean_value #=> Boolean
|
|
1142
|
-
# resp.records[0][0].double_value #=> Float
|
|
1143
|
-
# resp.records[0][0].is_null #=> Boolean
|
|
1144
|
-
# resp.records[0][0].long_value #=> Integer
|
|
1145
|
-
# resp.records[0][0].string_value #=> String
|
|
1143
|
+
# resp.column_metadata[0].length #=> Integer
|
|
1144
|
+
# resp.column_metadata[0].column_default #=> String
|
|
1146
1145
|
# resp.total_num_rows #=> Integer
|
|
1146
|
+
# resp.next_token #=> String
|
|
1147
1147
|
#
|
|
1148
1148
|
# @see http://docs.aws.amazon.com/goto/WebAPI/redshift-data-2019-12-20/GetStatementResult AWS API Documentation
|
|
1149
1149
|
#
|
|
@@ -1186,11 +1186,11 @@ module Aws::RedshiftDataAPIService
|
|
|
1186
1186
|
#
|
|
1187
1187
|
# @return [Types::GetStatementResultV2Response] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
|
1188
1188
|
#
|
|
1189
|
-
# * {Types::GetStatementResultV2Response#column_metadata #column_metadata} => Array<Types::ColumnMetadata>
|
|
1190
|
-
# * {Types::GetStatementResultV2Response#next_token #next_token} => String
|
|
1191
1189
|
# * {Types::GetStatementResultV2Response#records #records} => Array<Types::QueryRecords>
|
|
1192
|
-
# * {Types::GetStatementResultV2Response#
|
|
1190
|
+
# * {Types::GetStatementResultV2Response#column_metadata #column_metadata} => Array<Types::ColumnMetadata>
|
|
1193
1191
|
# * {Types::GetStatementResultV2Response#total_num_rows #total_num_rows} => Integer
|
|
1192
|
+
# * {Types::GetStatementResultV2Response#result_format #result_format} => String
|
|
1193
|
+
# * {Types::GetStatementResultV2Response#next_token #next_token} => String
|
|
1194
1194
|
#
|
|
1195
1195
|
# The returned {Seahorse::Client::Response response} is a pageable response and is Enumerable. For details on usage see {Aws::PageableResponse PageableResponse}.
|
|
1196
1196
|
#
|
|
@@ -1203,13 +1203,13 @@ module Aws::RedshiftDataAPIService
|
|
|
1203
1203
|
#
|
|
1204
1204
|
# @example Response structure
|
|
1205
1205
|
#
|
|
1206
|
+
# resp.records #=> Array
|
|
1207
|
+
# resp.records[0].csv_records #=> String
|
|
1206
1208
|
# resp.column_metadata #=> Array
|
|
1207
|
-
# resp.column_metadata[0].column_default #=> String
|
|
1208
1209
|
# resp.column_metadata[0].is_case_sensitive #=> Boolean
|
|
1209
1210
|
# resp.column_metadata[0].is_currency #=> Boolean
|
|
1210
1211
|
# resp.column_metadata[0].is_signed #=> Boolean
|
|
1211
1212
|
# resp.column_metadata[0].label #=> String
|
|
1212
|
-
# resp.column_metadata[0].length #=> Integer
|
|
1213
1213
|
# resp.column_metadata[0].name #=> String
|
|
1214
1214
|
# resp.column_metadata[0].nullable #=> Integer
|
|
1215
1215
|
# resp.column_metadata[0].precision #=> Integer
|
|
@@ -1217,11 +1217,11 @@ module Aws::RedshiftDataAPIService
|
|
|
1217
1217
|
# resp.column_metadata[0].schema_name #=> String
|
|
1218
1218
|
# resp.column_metadata[0].table_name #=> String
|
|
1219
1219
|
# resp.column_metadata[0].type_name #=> String
|
|
1220
|
-
# resp.
|
|
1221
|
-
# resp.
|
|
1222
|
-
# resp.records[0].csv_records #=> String
|
|
1223
|
-
# resp.result_format #=> String, one of "JSON", "CSV"
|
|
1220
|
+
# resp.column_metadata[0].length #=> Integer
|
|
1221
|
+
# resp.column_metadata[0].column_default #=> String
|
|
1224
1222
|
# resp.total_num_rows #=> Integer
|
|
1223
|
+
# resp.result_format #=> String, one of "JSON", "CSV"
|
|
1224
|
+
# resp.next_token #=> String
|
|
1225
1225
|
#
|
|
1226
1226
|
# @see http://docs.aws.amazon.com/goto/WebAPI/redshift-data-2019-12-20/GetStatementResultV2 AWS API Documentation
|
|
1227
1227
|
#
|
|
@@ -1283,16 +1283,15 @@ module Aws::RedshiftDataAPIService
|
|
|
1283
1283
|
# The name of the database. This parameter is required when
|
|
1284
1284
|
# authenticating using either Secrets Manager or temporary credentials.
|
|
1285
1285
|
#
|
|
1286
|
+
# @option params [String] :secret_arn
|
|
1287
|
+
# The name or ARN of the secret that enables access to the database.
|
|
1288
|
+
# This parameter is required when authenticating using Secrets Manager.
|
|
1289
|
+
#
|
|
1286
1290
|
# @option params [String] :db_user
|
|
1287
1291
|
# The database user name. This parameter is required when connecting to
|
|
1288
1292
|
# a cluster as a database user and authenticating using temporary
|
|
1289
1293
|
# credentials.
|
|
1290
1294
|
#
|
|
1291
|
-
# @option params [Integer] :max_results
|
|
1292
|
-
# The maximum number of databases to return in the response. If more
|
|
1293
|
-
# databases exist than fit in one response, then `NextToken` is returned
|
|
1294
|
-
# to page through the results.
|
|
1295
|
-
#
|
|
1296
1295
|
# @option params [String] :next_token
|
|
1297
1296
|
# A value that indicates the starting point for the next set of response
|
|
1298
1297
|
# records in a subsequent request. If a value is returned in a response,
|
|
@@ -1301,9 +1300,10 @@ module Aws::RedshiftDataAPIService
|
|
|
1301
1300
|
# command. If the NextToken field is empty, all response records have
|
|
1302
1301
|
# been retrieved for the request.
|
|
1303
1302
|
#
|
|
1304
|
-
# @option params [
|
|
1305
|
-
# The
|
|
1306
|
-
#
|
|
1303
|
+
# @option params [Integer] :max_results
|
|
1304
|
+
# The maximum number of databases to return in the response. If more
|
|
1305
|
+
# databases exist than fit in one response, then `NextToken` is returned
|
|
1306
|
+
# to page through the results.
|
|
1307
1307
|
#
|
|
1308
1308
|
# @option params [String] :workgroup_name
|
|
1309
1309
|
# The serverless workgroup name or Amazon Resource Name (ARN). This
|
|
@@ -1322,10 +1322,10 @@ module Aws::RedshiftDataAPIService
|
|
|
1322
1322
|
# resp = client.list_databases({
|
|
1323
1323
|
# cluster_identifier: "ClusterIdentifierString",
|
|
1324
1324
|
# database: "String", # required
|
|
1325
|
+
# secret_arn: "SecretArn",
|
|
1325
1326
|
# db_user: "String",
|
|
1326
|
-
# max_results: 1,
|
|
1327
1327
|
# next_token: "String",
|
|
1328
|
-
#
|
|
1328
|
+
# max_results: 1,
|
|
1329
1329
|
# workgroup_name: "WorkgroupNameString",
|
|
1330
1330
|
# })
|
|
1331
1331
|
#
|
|
@@ -1391,24 +1391,29 @@ module Aws::RedshiftDataAPIService
|
|
|
1391
1391
|
# a cluster and authenticating using either Secrets Manager or temporary
|
|
1392
1392
|
# credentials.
|
|
1393
1393
|
#
|
|
1394
|
-
# @option params [String] :
|
|
1395
|
-
#
|
|
1396
|
-
#
|
|
1394
|
+
# @option params [String] :secret_arn
|
|
1395
|
+
# The name or ARN of the secret that enables access to the database.
|
|
1396
|
+
# This parameter is required when authenticating using Secrets Manager.
|
|
1397
|
+
#
|
|
1398
|
+
# @option params [String] :db_user
|
|
1399
|
+
# The database user name. This parameter is required when connecting to
|
|
1400
|
+
# a cluster as a database user and authenticating using temporary
|
|
1401
|
+
# credentials.
|
|
1397
1402
|
#
|
|
1398
1403
|
# @option params [required, String] :database
|
|
1399
1404
|
# The name of the database that contains the schemas to list. If
|
|
1400
1405
|
# `ConnectedDatabase` is not specified, this is also the database to
|
|
1401
1406
|
# connect to with your authentication credentials.
|
|
1402
1407
|
#
|
|
1403
|
-
# @option params [String] :
|
|
1404
|
-
#
|
|
1405
|
-
#
|
|
1406
|
-
# credentials.
|
|
1408
|
+
# @option params [String] :connected_database
|
|
1409
|
+
# A database name. The connected database is specified when you connect
|
|
1410
|
+
# with your authentication credentials.
|
|
1407
1411
|
#
|
|
1408
|
-
# @option params [
|
|
1409
|
-
#
|
|
1410
|
-
#
|
|
1411
|
-
#
|
|
1412
|
+
# @option params [String] :schema_pattern
|
|
1413
|
+
# A pattern to filter results by schema name. Within a schema pattern,
|
|
1414
|
+
# "%" means match any substring of 0 or more characters and "\_"
|
|
1415
|
+
# means match any one character. Only schema name entries matching the
|
|
1416
|
+
# search pattern are returned.
|
|
1412
1417
|
#
|
|
1413
1418
|
# @option params [String] :next_token
|
|
1414
1419
|
# A value that indicates the starting point for the next set of response
|
|
@@ -1418,15 +1423,10 @@ module Aws::RedshiftDataAPIService
|
|
|
1418
1423
|
# command. If the NextToken field is empty, all response records have
|
|
1419
1424
|
# been retrieved for the request.
|
|
1420
1425
|
#
|
|
1421
|
-
# @option params [
|
|
1422
|
-
#
|
|
1423
|
-
#
|
|
1424
|
-
#
|
|
1425
|
-
# search pattern are returned.
|
|
1426
|
-
#
|
|
1427
|
-
# @option params [String] :secret_arn
|
|
1428
|
-
# The name or ARN of the secret that enables access to the database.
|
|
1429
|
-
# This parameter is required when authenticating using Secrets Manager.
|
|
1426
|
+
# @option params [Integer] :max_results
|
|
1427
|
+
# The maximum number of schemas to return in the response. If more
|
|
1428
|
+
# schemas exist than fit in one response, then `NextToken` is returned
|
|
1429
|
+
# to page through the results.
|
|
1430
1430
|
#
|
|
1431
1431
|
# @option params [String] :workgroup_name
|
|
1432
1432
|
# The serverless workgroup name or Amazon Resource Name (ARN). This
|
|
@@ -1435,8 +1435,8 @@ module Aws::RedshiftDataAPIService
|
|
|
1435
1435
|
#
|
|
1436
1436
|
# @return [Types::ListSchemasResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
|
1437
1437
|
#
|
|
1438
|
-
# * {Types::ListSchemasResponse#next_token #next_token} => String
|
|
1439
1438
|
# * {Types::ListSchemasResponse#schemas #schemas} => Array<String>
|
|
1439
|
+
# * {Types::ListSchemasResponse#next_token #next_token} => String
|
|
1440
1440
|
#
|
|
1441
1441
|
# The returned {Seahorse::Client::Response response} is a pageable response and is Enumerable. For details on usage see {Aws::PageableResponse PageableResponse}.
|
|
1442
1442
|
#
|
|
@@ -1444,21 +1444,21 @@ module Aws::RedshiftDataAPIService
|
|
|
1444
1444
|
#
|
|
1445
1445
|
# resp = client.list_schemas({
|
|
1446
1446
|
# cluster_identifier: "ClusterIdentifierString",
|
|
1447
|
-
#
|
|
1448
|
-
# database: "String", # required
|
|
1447
|
+
# secret_arn: "SecretArn",
|
|
1449
1448
|
# db_user: "String",
|
|
1450
|
-
#
|
|
1451
|
-
#
|
|
1449
|
+
# database: "String", # required
|
|
1450
|
+
# connected_database: "String",
|
|
1452
1451
|
# schema_pattern: "String",
|
|
1453
|
-
#
|
|
1452
|
+
# next_token: "String",
|
|
1453
|
+
# max_results: 1,
|
|
1454
1454
|
# workgroup_name: "WorkgroupNameString",
|
|
1455
1455
|
# })
|
|
1456
1456
|
#
|
|
1457
1457
|
# @example Response structure
|
|
1458
1458
|
#
|
|
1459
|
-
# resp.next_token #=> String
|
|
1460
1459
|
# resp.schemas #=> Array
|
|
1461
1460
|
# resp.schemas[0] #=> String
|
|
1461
|
+
# resp.next_token #=> String
|
|
1462
1462
|
#
|
|
1463
1463
|
# @see http://docs.aws.amazon.com/goto/WebAPI/redshift-data-2019-12-20/ListSchemas AWS API Documentation
|
|
1464
1464
|
#
|
|
@@ -1487,20 +1487,6 @@ module Aws::RedshiftDataAPIService
|
|
|
1487
1487
|
# [1]: https://docs.aws.amazon.com/singlesignon/latest/userguide/trustedidentitypropagation-overview.html
|
|
1488
1488
|
# [2]: https://docs.aws.amazon.com/redshift/latest/mgmt/data-api.html
|
|
1489
1489
|
#
|
|
1490
|
-
# @option params [String] :cluster_identifier
|
|
1491
|
-
# The cluster identifier. Only statements that ran on this cluster are
|
|
1492
|
-
# returned. When providing `ClusterIdentifier`, then `WorkgroupName`
|
|
1493
|
-
# can't be specified.
|
|
1494
|
-
#
|
|
1495
|
-
# @option params [String] :database
|
|
1496
|
-
# The name of the database when listing statements run against a
|
|
1497
|
-
# `ClusterIdentifier` or `WorkgroupName`.
|
|
1498
|
-
#
|
|
1499
|
-
# @option params [Integer] :max_results
|
|
1500
|
-
# The maximum number of SQL statements to return in the response. If
|
|
1501
|
-
# more SQL statements exist than fit in one response, then `NextToken`
|
|
1502
|
-
# is returned to page through the results.
|
|
1503
|
-
#
|
|
1504
1490
|
# @option params [String] :next_token
|
|
1505
1491
|
# A value that indicates the starting point for the next set of response
|
|
1506
1492
|
# records in a subsequent request. If a value is returned in a response,
|
|
@@ -1509,11 +1495,10 @@ module Aws::RedshiftDataAPIService
|
|
|
1509
1495
|
# command. If the NextToken field is empty, all response records have
|
|
1510
1496
|
# been retrieved for the request.
|
|
1511
1497
|
#
|
|
1512
|
-
# @option params [
|
|
1513
|
-
#
|
|
1514
|
-
#
|
|
1515
|
-
#
|
|
1516
|
-
# IAM session are returned. The default is true.
|
|
1498
|
+
# @option params [Integer] :max_results
|
|
1499
|
+
# The maximum number of SQL statements to return in the response. If
|
|
1500
|
+
# more SQL statements exist than fit in one response, then `NextToken`
|
|
1501
|
+
# is returned to page through the results.
|
|
1517
1502
|
#
|
|
1518
1503
|
# @option params [String] :statement_name
|
|
1519
1504
|
# The name of the SQL statement specified as input to
|
|
@@ -1543,6 +1528,21 @@ module Aws::RedshiftDataAPIService
|
|
|
1543
1528
|
#
|
|
1544
1529
|
# * SUBMITTED - The query was submitted, but not yet processed.
|
|
1545
1530
|
#
|
|
1531
|
+
# @option params [Boolean] :role_level
|
|
1532
|
+
# A value that filters which statements to return in the response. If
|
|
1533
|
+
# true, all statements run by the caller's IAM role are returned. If
|
|
1534
|
+
# false, only statements run by the caller's IAM role in the current
|
|
1535
|
+
# IAM session are returned. The default is true.
|
|
1536
|
+
#
|
|
1537
|
+
# @option params [String] :database
|
|
1538
|
+
# The name of the database when listing statements run against a
|
|
1539
|
+
# `ClusterIdentifier` or `WorkgroupName`.
|
|
1540
|
+
#
|
|
1541
|
+
# @option params [String] :cluster_identifier
|
|
1542
|
+
# The cluster identifier. Only statements that ran on this cluster are
|
|
1543
|
+
# returned. When providing `ClusterIdentifier`, then `WorkgroupName`
|
|
1544
|
+
# can't be specified.
|
|
1545
|
+
#
|
|
1546
1546
|
# @option params [String] :workgroup_name
|
|
1547
1547
|
# The serverless workgroup name or Amazon Resource Name (ARN). Only
|
|
1548
1548
|
# statements that ran on this workgroup are returned. When providing
|
|
@@ -1550,43 +1550,43 @@ module Aws::RedshiftDataAPIService
|
|
|
1550
1550
|
#
|
|
1551
1551
|
# @return [Types::ListStatementsResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
|
1552
1552
|
#
|
|
1553
|
-
# * {Types::ListStatementsResponse#next_token #next_token} => String
|
|
1554
1553
|
# * {Types::ListStatementsResponse#statements #statements} => Array<Types::StatementData>
|
|
1554
|
+
# * {Types::ListStatementsResponse#next_token #next_token} => String
|
|
1555
1555
|
#
|
|
1556
1556
|
# The returned {Seahorse::Client::Response response} is a pageable response and is Enumerable. For details on usage see {Aws::PageableResponse PageableResponse}.
|
|
1557
1557
|
#
|
|
1558
1558
|
# @example Request syntax with placeholder values
|
|
1559
1559
|
#
|
|
1560
1560
|
# resp = client.list_statements({
|
|
1561
|
-
# cluster_identifier: "ClusterIdentifierString",
|
|
1562
|
-
# database: "String",
|
|
1563
|
-
# max_results: 1,
|
|
1564
1561
|
# next_token: "String",
|
|
1565
|
-
#
|
|
1562
|
+
# max_results: 1,
|
|
1566
1563
|
# statement_name: "StatementNameString",
|
|
1567
1564
|
# status: "SUBMITTED", # accepts SUBMITTED, PICKED, STARTED, FINISHED, ABORTED, FAILED, ALL
|
|
1565
|
+
# role_level: false,
|
|
1566
|
+
# database: "String",
|
|
1567
|
+
# cluster_identifier: "ClusterIdentifierString",
|
|
1568
1568
|
# workgroup_name: "WorkgroupNameString",
|
|
1569
1569
|
# })
|
|
1570
1570
|
#
|
|
1571
1571
|
# @example Response structure
|
|
1572
1572
|
#
|
|
1573
|
-
# resp.next_token #=> String
|
|
1574
1573
|
# resp.statements #=> Array
|
|
1575
|
-
# resp.statements[0].created_at #=> Time
|
|
1576
1574
|
# resp.statements[0].id #=> String
|
|
1577
|
-
# resp.statements[0].is_batch_statement #=> Boolean
|
|
1578
|
-
# resp.statements[0].query_parameters #=> Array
|
|
1579
|
-
# resp.statements[0].query_parameters[0].name #=> String
|
|
1580
|
-
# resp.statements[0].query_parameters[0].value #=> String
|
|
1581
1575
|
# resp.statements[0].query_string #=> String
|
|
1582
1576
|
# resp.statements[0].query_strings #=> Array
|
|
1583
1577
|
# resp.statements[0].query_strings[0] #=> String
|
|
1584
|
-
# resp.statements[0].result_format #=> String, one of "JSON", "CSV"
|
|
1585
1578
|
# resp.statements[0].secret_arn #=> String
|
|
1586
|
-
# resp.statements[0].session_id #=> String
|
|
1587
|
-
# resp.statements[0].statement_name #=> String
|
|
1588
1579
|
# resp.statements[0].status #=> String, one of "SUBMITTED", "PICKED", "STARTED", "FINISHED", "ABORTED", "FAILED", "ALL"
|
|
1580
|
+
# resp.statements[0].statement_name #=> String
|
|
1581
|
+
# resp.statements[0].created_at #=> Time
|
|
1589
1582
|
# resp.statements[0].updated_at #=> Time
|
|
1583
|
+
# resp.statements[0].query_parameters #=> Array
|
|
1584
|
+
# resp.statements[0].query_parameters[0].name #=> String
|
|
1585
|
+
# resp.statements[0].query_parameters[0].value #=> String
|
|
1586
|
+
# resp.statements[0].is_batch_statement #=> Boolean
|
|
1587
|
+
# resp.statements[0].result_format #=> String, one of "JSON", "CSV"
|
|
1588
|
+
# resp.statements[0].session_id #=> String
|
|
1589
|
+
# resp.next_token #=> String
|
|
1590
1590
|
#
|
|
1591
1591
|
# @see http://docs.aws.amazon.com/goto/WebAPI/redshift-data-2019-12-20/ListStatements AWS API Documentation
|
|
1592
1592
|
#
|
|
@@ -1646,32 +1646,23 @@ module Aws::RedshiftDataAPIService
|
|
|
1646
1646
|
# a cluster and authenticating using either Secrets Manager or temporary
|
|
1647
1647
|
# credentials.
|
|
1648
1648
|
#
|
|
1649
|
-
# @option params [String] :
|
|
1650
|
-
#
|
|
1651
|
-
#
|
|
1652
|
-
#
|
|
1653
|
-
# @option params [required, String] :database
|
|
1654
|
-
# The name of the database that contains the tables to list. If
|
|
1655
|
-
# `ConnectedDatabase` is not specified, this is also the database to
|
|
1656
|
-
# connect to with your authentication credentials.
|
|
1649
|
+
# @option params [String] :secret_arn
|
|
1650
|
+
# The name or ARN of the secret that enables access to the database.
|
|
1651
|
+
# This parameter is required when authenticating using Secrets Manager.
|
|
1657
1652
|
#
|
|
1658
1653
|
# @option params [String] :db_user
|
|
1659
1654
|
# The database user name. This parameter is required when connecting to
|
|
1660
1655
|
# a cluster as a database user and authenticating using temporary
|
|
1661
1656
|
# credentials.
|
|
1662
1657
|
#
|
|
1663
|
-
# @option params [
|
|
1664
|
-
# The
|
|
1665
|
-
#
|
|
1666
|
-
#
|
|
1658
|
+
# @option params [required, String] :database
|
|
1659
|
+
# The name of the database that contains the tables to list. If
|
|
1660
|
+
# `ConnectedDatabase` is not specified, this is also the database to
|
|
1661
|
+
# connect to with your authentication credentials.
|
|
1667
1662
|
#
|
|
1668
|
-
# @option params [String] :
|
|
1669
|
-
# A
|
|
1670
|
-
#
|
|
1671
|
-
# you can retrieve the next set of records by providing this returned
|
|
1672
|
-
# NextToken value in the next NextToken parameter and retrying the
|
|
1673
|
-
# command. If the NextToken field is empty, all response records have
|
|
1674
|
-
# been retrieved for the request.
|
|
1663
|
+
# @option params [String] :connected_database
|
|
1664
|
+
# A database name. The connected database is specified when you connect
|
|
1665
|
+
# with your authentication credentials.
|
|
1675
1666
|
#
|
|
1676
1667
|
# @option params [String] :schema_pattern
|
|
1677
1668
|
# A pattern to filter results by schema name. Within a schema pattern,
|
|
@@ -1682,10 +1673,6 @@ module Aws::RedshiftDataAPIService
|
|
|
1682
1673
|
# `SchemaPattern` or `TablePattern` are specified, then all tables are
|
|
1683
1674
|
# returned.
|
|
1684
1675
|
#
|
|
1685
|
-
# @option params [String] :secret_arn
|
|
1686
|
-
# The name or ARN of the secret that enables access to the database.
|
|
1687
|
-
# This parameter is required when authenticating using Secrets Manager.
|
|
1688
|
-
#
|
|
1689
1676
|
# @option params [String] :table_pattern
|
|
1690
1677
|
# A pattern to filter results by table name. Within a table pattern,
|
|
1691
1678
|
# "%" means match any substring of 0 or more characters and "\_"
|
|
@@ -1695,6 +1682,19 @@ module Aws::RedshiftDataAPIService
|
|
|
1695
1682
|
# `SchemaPattern` or `TablePattern` are specified, then all tables are
|
|
1696
1683
|
# returned.
|
|
1697
1684
|
#
|
|
1685
|
+
# @option params [String] :next_token
|
|
1686
|
+
# A value that indicates the starting point for the next set of response
|
|
1687
|
+
# records in a subsequent request. If a value is returned in a response,
|
|
1688
|
+
# you can retrieve the next set of records by providing this returned
|
|
1689
|
+
# NextToken value in the next NextToken parameter and retrying the
|
|
1690
|
+
# command. If the NextToken field is empty, all response records have
|
|
1691
|
+
# been retrieved for the request.
|
|
1692
|
+
#
|
|
1693
|
+
# @option params [Integer] :max_results
|
|
1694
|
+
# The maximum number of tables to return in the response. If more tables
|
|
1695
|
+
# exist than fit in one response, then `NextToken` is returned to page
|
|
1696
|
+
# through the results.
|
|
1697
|
+
#
|
|
1698
1698
|
# @option params [String] :workgroup_name
|
|
1699
1699
|
# The serverless workgroup name or Amazon Resource Name (ARN). This
|
|
1700
1700
|
# parameter is required when connecting to a serverless workgroup and
|
|
@@ -1702,8 +1702,8 @@ module Aws::RedshiftDataAPIService
|
|
|
1702
1702
|
#
|
|
1703
1703
|
# @return [Types::ListTablesResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
|
1704
1704
|
#
|
|
1705
|
-
# * {Types::ListTablesResponse#next_token #next_token} => String
|
|
1706
1705
|
# * {Types::ListTablesResponse#tables #tables} => Array<Types::TableMember>
|
|
1706
|
+
# * {Types::ListTablesResponse#next_token #next_token} => String
|
|
1707
1707
|
#
|
|
1708
1708
|
# The returned {Seahorse::Client::Response response} is a pageable response and is Enumerable. For details on usage see {Aws::PageableResponse PageableResponse}.
|
|
1709
1709
|
#
|
|
@@ -1711,24 +1711,24 @@ module Aws::RedshiftDataAPIService
|
|
|
1711
1711
|
#
|
|
1712
1712
|
# resp = client.list_tables({
|
|
1713
1713
|
# cluster_identifier: "ClusterIdentifierString",
|
|
1714
|
-
#
|
|
1715
|
-
# database: "String", # required
|
|
1714
|
+
# secret_arn: "SecretArn",
|
|
1716
1715
|
# db_user: "String",
|
|
1717
|
-
#
|
|
1718
|
-
#
|
|
1716
|
+
# database: "String", # required
|
|
1717
|
+
# connected_database: "String",
|
|
1719
1718
|
# schema_pattern: "String",
|
|
1720
|
-
# secret_arn: "SecretArn",
|
|
1721
1719
|
# table_pattern: "String",
|
|
1720
|
+
# next_token: "String",
|
|
1721
|
+
# max_results: 1,
|
|
1722
1722
|
# workgroup_name: "WorkgroupNameString",
|
|
1723
1723
|
# })
|
|
1724
1724
|
#
|
|
1725
1725
|
# @example Response structure
|
|
1726
1726
|
#
|
|
1727
|
-
# resp.next_token #=> String
|
|
1728
1727
|
# resp.tables #=> Array
|
|
1729
1728
|
# resp.tables[0].name #=> String
|
|
1730
|
-
# resp.tables[0].schema #=> String
|
|
1731
1729
|
# resp.tables[0].type #=> String
|
|
1730
|
+
# resp.tables[0].schema #=> String
|
|
1731
|
+
# resp.next_token #=> String
|
|
1732
1732
|
#
|
|
1733
1733
|
# @see http://docs.aws.amazon.com/goto/WebAPI/redshift-data-2019-12-20/ListTables AWS API Documentation
|
|
1734
1734
|
#
|
|
@@ -1757,7 +1757,7 @@ module Aws::RedshiftDataAPIService
|
|
|
1757
1757
|
tracer: tracer
|
|
1758
1758
|
)
|
|
1759
1759
|
context[:gem_name] = 'aws-sdk-redshiftdataapiservice'
|
|
1760
|
-
context[:gem_version] = '1.
|
|
1760
|
+
context[:gem_version] = '1.65.0'
|
|
1761
1761
|
Seahorse::Client::Request.new(handlers, context)
|
|
1762
1762
|
end
|
|
1763
1763
|
|