Class: Aws::RedshiftDataAPIService::Client
- Inherits:
-
Seahorse::Client::Base
- Object
- Seahorse::Client::Base
- Aws::RedshiftDataAPIService::Client
- Includes:
- ClientStubs
- Defined in:
- gems/aws-sdk-redshiftdataapiservice/lib/aws-sdk-redshiftdataapiservice/client.rb
Overview
An API client for RedshiftDataAPIService. To construct a client, you need to configure a :region
and :credentials
.
client = Aws::RedshiftDataAPIService::Client.new(
region: region_name,
credentials: credentials,
# ...
)
For details on configuring region and credentials see the developer guide.
See #initialize for a full list of supported configuration options.
Instance Attribute Summary
Attributes inherited from Seahorse::Client::Base
API Operations collapse
-
#batch_execute_statement(params = {}) ⇒ Types::BatchExecuteStatementOutput
Runs one or more SQL statements, which can be data manipulation language (DML) or data definition language (DDL).
-
#cancel_statement(params = {}) ⇒ Types::CancelStatementResponse
Cancels a running query.
-
#describe_statement(params = {}) ⇒ Types::DescribeStatementResponse
Describes the details about a specific instance when a query was run by the Amazon Redshift Data API.
-
#describe_table(params = {}) ⇒ Types::DescribeTableResponse
Describes the detailed information about a table from metadata in the cluster.
-
#execute_statement(params = {}) ⇒ Types::ExecuteStatementOutput
Runs an SQL statement, which can be data manipulation language (DML) or data definition language (DDL).
-
#get_statement_result(params = {}) ⇒ Types::GetStatementResultResponse
Fetches the temporarily cached result of an SQL statement.
-
#list_databases(params = {}) ⇒ Types::ListDatabasesResponse
List the databases in a cluster.
-
#list_schemas(params = {}) ⇒ Types::ListSchemasResponse
Lists the schemas in a database.
-
#list_statements(params = {}) ⇒ Types::ListStatementsResponse
List of SQL statements.
-
#list_tables(params = {}) ⇒ Types::ListTablesResponse
List the tables in a database.
Instance Method Summary collapse
-
#initialize(options) ⇒ Client
constructor
A new instance of Client.
Methods included from ClientStubs
#api_requests, #stub_data, #stub_responses
Methods inherited from Seahorse::Client::Base
add_plugin, api, clear_plugins, define, new, #operation_names, plugins, remove_plugin, set_api, set_plugins
Methods included from Seahorse::Client::HandlerBuilder
#handle, #handle_request, #handle_response
Constructor Details
#initialize(options) ⇒ Client
Returns a new instance of Client.
358 359 360 |
# File 'gems/aws-sdk-redshiftdataapiservice/lib/aws-sdk-redshiftdataapiservice/client.rb', line 358 def initialize(*args) super end |
Instance Method Details
#batch_execute_statement(params = {}) ⇒ Types::BatchExecuteStatementOutput
Runs one or more SQL statements, which can be data manipulation language (DML) or data definition language (DDL). Depending on the authorization method, use one of the following combinations of request parameters:
Secrets Manager - when connecting to a cluster, specify the Amazon Resource Name (ARN) of the secret, the database name, and the cluster identifier that matches the cluster in the secret. When connecting to a serverless workgroup, specify the Amazon Resource Name (ARN) of the secret and the database name.
Temporary credentials - when connecting to a cluster, specify the cluster identifier, the database name, and the database user name. Also, permission to call the
redshift:GetClusterCredentials
operation is required. When connecting to a serverless workgroup, specify the workgroup name and database name. Also, permission to call theredshift-serverless:GetCredentials
operation is required.
452 453 454 455 |
# File 'gems/aws-sdk-redshiftdataapiservice/lib/aws-sdk-redshiftdataapiservice/client.rb', line 452 def batch_execute_statement(params = {}, = {}) req = build_request(:batch_execute_statement, params) req.send_request() end |
#cancel_statement(params = {}) ⇒ Types::CancelStatementResponse
Cancels a running query. To be canceled, a query must be running.
483 484 485 486 |
# File 'gems/aws-sdk-redshiftdataapiservice/lib/aws-sdk-redshiftdataapiservice/client.rb', line 483 def cancel_statement(params = {}, = {}) req = build_request(:cancel_statement, params) req.send_request() end |
#describe_statement(params = {}) ⇒ Types::DescribeStatementResponse
Describes the details about a specific instance when a query was run by the Amazon Redshift Data API. The information includes when the query started, when it finished, the query status, the number of rows returned, and the SQL statement.
569 570 571 572 |
# File 'gems/aws-sdk-redshiftdataapiservice/lib/aws-sdk-redshiftdataapiservice/client.rb', line 569 def describe_statement(params = {}, = {}) req = build_request(:describe_statement, params) req.send_request() end |
#describe_table(params = {}) ⇒ Types::DescribeTableResponse
Describes the detailed information about a table from metadata in the cluster. The information includes its columns. A token is returned to page through the column list. Depending on the authorization method, use one of the following combinations of request parameters:
Secrets Manager - when connecting to a cluster, specify the Amazon Resource Name (ARN) of the secret, the database name, and the cluster identifier that matches the cluster in the secret. When connecting to a serverless workgroup, specify the Amazon Resource Name (ARN) of the secret and the database name.
Temporary credentials - when connecting to a cluster, specify the cluster identifier, the database name, and the database user name. Also, permission to call the
redshift:GetClusterCredentials
operation is required. When connecting to a serverless workgroup, specify the workgroup name and database name. Also, permission to call theredshift-serverless:GetCredentials
operation is required.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
687 688 689 690 |
# File 'gems/aws-sdk-redshiftdataapiservice/lib/aws-sdk-redshiftdataapiservice/client.rb', line 687 def describe_table(params = {}, = {}) req = build_request(:describe_table, params) req.send_request() end |
#execute_statement(params = {}) ⇒ Types::ExecuteStatementOutput
Runs an SQL statement, which can be data manipulation language (DML) or data definition language (DDL). This statement must be a single SQL statement. Depending on the authorization method, use one of the following combinations of request parameters:
Secrets Manager - when connecting to a cluster, specify the Amazon Resource Name (ARN) of the secret, the database name, and the cluster identifier that matches the cluster in the secret. When connecting to a serverless workgroup, specify the Amazon Resource Name (ARN) of the secret and the database name.
Temporary credentials - when connecting to a cluster, specify the cluster identifier, the database name, and the database user name. Also, permission to call the
redshift:GetClusterCredentials
operation is required. When connecting to a serverless workgroup, specify the workgroup name and database name. Also, permission to call theredshift-serverless:GetCredentials
operation is required.
789 790 791 792 |
# File 'gems/aws-sdk-redshiftdataapiservice/lib/aws-sdk-redshiftdataapiservice/client.rb', line 789 def execute_statement(params = {}, = {}) req = build_request(:execute_statement, params) req.send_request() end |
#get_statement_result(params = {}) ⇒ Types::GetStatementResultResponse
Fetches the temporarily cached result of an SQL statement. A token is returned to page through the statement results.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
861 862 863 864 |
# File 'gems/aws-sdk-redshiftdataapiservice/lib/aws-sdk-redshiftdataapiservice/client.rb', line 861 def get_statement_result(params = {}, = {}) req = build_request(:get_statement_result, params) req.send_request() end |
#list_databases(params = {}) ⇒ Types::ListDatabasesResponse
List the databases in a cluster. A token is returned to page through the database list. Depending on the authorization method, use one of the following combinations of request parameters:
Secrets Manager - when connecting to a cluster, specify the Amazon Resource Name (ARN) of the secret, the database name, and the cluster identifier that matches the cluster in the secret. When connecting to a serverless workgroup, specify the Amazon Resource Name (ARN) of the secret and the database name.
Temporary credentials - when connecting to a cluster, specify the cluster identifier, the database name, and the database user name. Also, permission to call the
redshift:GetClusterCredentials
operation is required. When connecting to a serverless workgroup, specify the workgroup name and database name. Also, permission to call theredshift-serverless:GetCredentials
operation is required.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
947 948 949 950 |
# File 'gems/aws-sdk-redshiftdataapiservice/lib/aws-sdk-redshiftdataapiservice/client.rb', line 947 def list_databases(params = {}, = {}) req = build_request(:list_databases, params) req.send_request() end |
#list_schemas(params = {}) ⇒ Types::ListSchemasResponse
Lists the schemas in a database. A token is returned to page through the schema list. Depending on the authorization method, use one of the following combinations of request parameters:
Secrets Manager - when connecting to a cluster, specify the Amazon Resource Name (ARN) of the secret, the database name, and the cluster identifier that matches the cluster in the secret. When connecting to a serverless workgroup, specify the Amazon Resource Name (ARN) of the secret and the database name.
Temporary credentials - when connecting to a cluster, specify the cluster identifier, the database name, and the database user name. Also, permission to call the
redshift:GetClusterCredentials
operation is required. When connecting to a serverless workgroup, specify the workgroup name and database name. Also, permission to call theredshift-serverless:GetCredentials
operation is required.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
1046 1047 1048 1049 |
# File 'gems/aws-sdk-redshiftdataapiservice/lib/aws-sdk-redshiftdataapiservice/client.rb', line 1046 def list_schemas(params = {}, = {}) req = build_request(:list_schemas, params) req.send_request() end |
#list_statements(params = {}) ⇒ Types::ListStatementsResponse
List of SQL statements. By default, only finished statements are shown. A token is returned to page through the statement list.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
1140 1141 1142 1143 |
# File 'gems/aws-sdk-redshiftdataapiservice/lib/aws-sdk-redshiftdataapiservice/client.rb', line 1140 def list_statements(params = {}, = {}) req = build_request(:list_statements, params) req.send_request() end |
#list_tables(params = {}) ⇒ Types::ListTablesResponse
List the tables in a database. If neither SchemaPattern
nor
TablePattern
are specified, then all tables in the database are
returned. A token is returned to page through the table list.
Depending on the authorization method, use one of the following
combinations of request parameters:
Secrets Manager - when connecting to a cluster, specify the Amazon Resource Name (ARN) of the secret, the database name, and the cluster identifier that matches the cluster in the secret. When connecting to a serverless workgroup, specify the Amazon Resource Name (ARN) of the secret and the database name.
Temporary credentials - when connecting to a cluster, specify the cluster identifier, the database name, and the database user name. Also, permission to call the
redshift:GetClusterCredentials
operation is required. When connecting to a serverless workgroup, specify the workgroup name and database name. Also, permission to call theredshift-serverless:GetCredentials
operation is required.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
1256 1257 1258 1259 |
# File 'gems/aws-sdk-redshiftdataapiservice/lib/aws-sdk-redshiftdataapiservice/client.rb', line 1256 def list_tables(params = {}, = {}) req = build_request(:list_tables, params) req.send_request() end |