You are viewing documentation for version 2 of the AWS SDK for Ruby. Version 3 documentation can be found here.

Class: Aws::RedshiftDataAPIService::Client

Inherits:

Seahorse::Client::Base

Object
Seahorse::Client::Base
Aws::RedshiftDataAPIService::Client

show all

Defined in:: (unknown)

Overview

An API client for Redshift Data API Service. To construct a client, you need to configure a :region and :credentials.

redshiftdataapiservice = Aws::RedshiftDataAPIService::Client.new(
  region: region_name,
  credentials: credentials,
  # ...
)

See #initialize for a full list of supported configuration options.

Region

You can configure a default region in the following locations:

ENV['AWS_REGION']
Aws.config[:region]

Go here for a list of supported regions.

Credentials

Default credentials are loaded automatically from the following locations:

ENV['AWS_ACCESS_KEY_ID'] and ENV['AWS_SECRET_ACCESS_KEY']
Aws.config[:credentials]
The shared credentials ini file at ~/.aws/credentials (more information)
From an instance profile when running on EC2

You can also construct a credentials object from one of the following classes:

Alternatively, you configure credentials with :access_key_id and :secret_access_key:

# load credentials from disk
creds = YAML.load(File.read('/path/to/secrets'))

Aws::RedshiftDataAPIService::Client.new(
  access_key_id: creds['access_key_id'],
  secret_access_key: creds['secret_access_key']
)

Always load your credentials from outside your application. Avoid configuring credentials statically and never commit them to source control.

Instance Attribute Summary

Attributes inherited from Seahorse::Client::Base

#config, #handlers

Constructor collapse

#initialize(options = {}) ⇒ Aws::RedshiftDataAPIService::Client constructor
Constructs an API client.

API Operations collapse

#cancel_statement(options = {}) ⇒ Types::CancelStatementResponse
Cancels a running query.
#describe_statement(options = {}) ⇒ Types::DescribeStatementResponse
Describes the details about a specific instance when a query was run by the Amazon Redshift Data API.
#describe_table(options = {}) ⇒ Types::DescribeTableResponse
Describes the detailed information about a table from metadata in the cluster.
#execute_statement(options = {}) ⇒ Types::ExecuteStatementOutput
Runs an SQL statement, which can be data manipulation language (DML) or data definition language (DDL).
#get_statement_result(options = {}) ⇒ Types::GetStatementResultResponse
Fetches the temporarily cached result of an SQL statement.
#list_databases(options = {}) ⇒ Types::ListDatabasesResponse
List the databases in a cluster.
#list_schemas(options = {}) ⇒ Types::ListSchemasResponse
Lists the schemas in a database.
#list_statements(options = {}) ⇒ Types::ListStatementsResponse
List of SQL statements.
#list_tables(options = {}) ⇒ Types::ListTablesResponse
List the tables in a database.

Instance Method Summary collapse

#wait_until(waiter_name, params = {}) {|waiter| ... } ⇒ Boolean
Waiters polls an API operation until a resource enters a desired state.
#waiter_names ⇒ Array<Symbol>
Returns the list of supported waiters.

Methods inherited from Seahorse::Client::Base

add_plugin, api, #build_request, clear_plugins, define, new, #operation, #operation_names, plugins, remove_plugin, set_api, set_plugins

Methods included from Seahorse::Client::HandlerBuilder

#handle, #handle_request, #handle_response

Constructor Details

#initialize(options = {}) ⇒ `Aws::RedshiftDataAPIService::Client`

Constructs an API client.

Options Hash (options):

:access_key_id (String) —
Used to set credentials statically. See Plugins::RequestSigner for more details.
:active_endpoint_cache (Boolean) —
When set to true, a thread polling for endpoints will be running in the background every 60 secs (default). Defaults to false. See Plugins::EndpointDiscovery for more details.
:convert_params (Boolean) — default: true —
When true, an attempt is made to coerce request parameters into the required types. See Plugins::ParamConverter for more details.
:credentials (required, Credentials) —
Your AWS credentials. The following locations will be searched in order for credentials:
- :access_key_id, :secret_access_key, and :session_token options
- ENV['AWS_ACCESS_KEY_ID'], ENV['AWS_SECRET_ACCESS_KEY']
- HOME/.aws/credentials shared credentials file
- EC2 instance profile credentials See Plugins::RequestSigner for more details.
:disable_host_prefix_injection (Boolean) —
Set to true to disable SDK automatically adding host prefix to default service endpoint when available. See Plugins::EndpointPattern for more details.
:endpoint (String) —
A default endpoint is constructed from the :region. See Plugins::RegionalEndpoint for more details.
:endpoint_cache_max_entries (Integer) —
Used for the maximum size limit of the LRU cache storing endpoints data for endpoint discovery enabled operations. Defaults to 1000. See Plugins::EndpointDiscovery for more details.
:endpoint_cache_max_threads (Integer) —
Used for the maximum threads in use for polling endpoints to be cached, defaults to 10. See Plugins::EndpointDiscovery for more details.
:endpoint_cache_poll_interval (Integer) —
When :endpoint_discovery and :active_endpoint_cache is enabled, Use this option to config the time interval in seconds for making requests fetching endpoints information. Defaults to 60 sec. See Plugins::EndpointDiscovery for more details.
:endpoint_discovery (Boolean) —
When set to true, endpoint discovery will be enabled for operations when available. Defaults to false. See Plugins::EndpointDiscovery for more details.
:http_continue_timeout (Float) — default: 1 —
See Seahorse::Client::Plugins::NetHttp for more details.
:http_idle_timeout (Integer) — default: 5 —
See Seahorse::Client::Plugins::NetHttp for more details.
:http_open_timeout (Integer) — default: 15 —
See Seahorse::Client::Plugins::NetHttp for more details.
:http_proxy (String) —
See Seahorse::Client::Plugins::NetHttp for more details.
:http_read_timeout (Integer) — default: 60 —
See Seahorse::Client::Plugins::NetHttp for more details.
:http_wire_trace (Boolean) — default: false —
See Seahorse::Client::Plugins::NetHttp for more details.
:log_level (Symbol) — default: :info —
The log level to send messages to the logger at. See Plugins::Logging for more details.
:log_formatter (Logging::LogFormatter) —
The log formatter. Defaults to Seahorse::Client::Logging::Formatter.default. See Plugins::Logging for more details.
:logger (Logger) — default: nil —
The Logger instance to send log messages to. If this option is not set, logging will be disabled. See Plugins::Logging for more details.
:profile (String) —
Used when loading credentials from the shared credentials file at HOME/.aws/credentials. When not specified, 'default' is used. See Plugins::RequestSigner for more details.
:raise_response_errors (Boolean) — default: true —
When true, response errors are raised. See Seahorse::Client::Plugins::RaiseResponseErrors for more details.
:region (required, String) —
The AWS region to connect to. The region is used to construct the client endpoint. Defaults to ENV['AWS_REGION']. Also checks AMAZON_REGION and AWS_DEFAULT_REGION. See Plugins::RegionalEndpoint for more details.
:retry_limit (Integer) — default: 3 —
The maximum number of times to retry failed requests. Only ~ 500 level server errors and certain ~ 400 level client errors are retried. Generally, these are throttling errors, data checksum errors, networking errors, timeout errors and auth errors from expired credentials. See Plugins::RetryErrors for more details.
:secret_access_key (String) —
Used to set credentials statically. See Plugins::RequestSigner for more details.
:session_token (String) —
Used to set credentials statically. See Plugins::RequestSigner for more details.
:simple_json (Boolean) — default: false —
Disables request parameter conversion, validation, and formatting. Also disable response data type conversions. This option is useful when you want to ensure the highest level of performance by avoiding overhead of walking request parameters and response data structures.

When :simple_json is enabled, the request parameters hash must be formatted exactly as the DynamoDB API expects. See Plugins::Protocols::JsonRpc for more details.
:ssl_ca_bundle (String) —
See Seahorse::Client::Plugins::NetHttp for more details.
:ssl_ca_directory (String) —
See Seahorse::Client::Plugins::NetHttp for more details.
:ssl_ca_store (String) —
See Seahorse::Client::Plugins::NetHttp for more details.
:ssl_verify_peer (Boolean) — default: true —
See Seahorse::Client::Plugins::NetHttp for more details.
:stub_responses (Boolean) — default: false —
Causes the client to return stubbed responses. By default fake responses are generated and returned. You can specify the response data to return or errors to raise by calling ClientStubs#stub_responses. See ClientStubs for more information.

Please note When response stubbing is enabled, no HTTP requests are made, and retries are disabled. See Plugins::StubResponses for more details.
:validate_params (Boolean) — default: true —
When true, request parameters are validated before sending the request. See Plugins::ParamValidator for more details.

Instance Method Details

#cancel_statement(options = {}) ⇒ `Types::CancelStatementResponse`

Cancels a running query. To be canceled, a query must be running.

Examples:

Request syntax with placeholder values


resp = client.cancel_statement({
  id: "UUID", # required
})

Response structure


resp.status #=> true/false

Options Hash (options):

:id (required, String) —
The identifier of the SQL statement to cancel. This value is a universally unique identifier (UUID) generated by Amazon Redshift Data API. This identifier is returned by ExecuteStatment and ListStatements.

Returns:

(Types::CancelStatementResponse) —
Returns a response object which responds to the following methods:
- #status => Boolean

See Also:

AWS API Documentation

#describe_statement(options = {}) ⇒ `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.

Examples:

Request syntax with placeholder values


resp = client.describe_statement({
  id: "UUID", # required
})

Response structure


resp.cluster_identifier #=> String
resp.created_at #=> Time
resp.database #=> String
resp.db_user #=> String
resp.duration #=> Integer
resp.error #=> String
resp.id #=> String
resp.query_string #=> String
resp.redshift_pid #=> Integer
resp.redshift_query_id #=> Integer
resp.result_rows #=> Integer
resp.result_size #=> Integer
resp.secret_arn #=> String
resp.status #=> String, one of "ABORTED", "ALL", "FAILED", "FINISHED", "PICKED", "STARTED", "SUBMITTED"
resp.updated_at #=> Time

Options Hash (options):

:id (required, String) —
The identifier of the SQL statement to describe. This value is a universally unique identifier (UUID) generated by Amazon Redshift Data API. This identifier is returned by ExecuteStatment and ListStatements.

Returns:

(Types::DescribeStatementResponse) —
Returns a response object which responds to the following methods:
- #cluster_identifier => String
- #created_at => Time
- #database => String
- #db_user => String
- #duration => Integer
- #error => String
- #id => String
- #query_string => String
- #redshift_pid => Integer
- #redshift_query_id => Integer
- #result_rows => Integer
- #result_size => Integer
- #secret_arn => String
- #status => String
- #updated_at => Time

See Also:

AWS API Documentation

#describe_table(options = {}) ⇒ `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:

AWS Secrets Manager - specify the Amazon Resource Name (ARN) of the secret and the cluster identifier that matches the cluster in the secret.
Temporary credentials - specify the cluster identifier, the database name, and the database user name. Permission to call the redshift:GetClusterCredentials operation is required to use this method.

Examples:

Request syntax with placeholder values


resp = client.describe_table({
  cluster_identifier: "Location", # required
  database: "String",
  db_user: "String",
  max_results: 1,
  next_token: "String",
  schema: "String",
  secret_arn: "SecretArn",
  table: "String",
})

Response structure


resp.column_list #=> Array
resp.column_list[0].column_default #=> String
resp.column_list[0].is_case_sensitive #=> true/false
resp.column_list[0].is_currency #=> true/false
resp.column_list[0].is_signed #=> true/false
resp.column_list[0].label #=> String
resp.column_list[0].length #=> Integer
resp.column_list[0].name #=> String
resp.column_list[0].nullable #=> Integer
resp.column_list[0].precision #=> Integer
resp.column_list[0].scale #=> Integer
resp.column_list[0].schema_name #=> String
resp.column_list[0].table_name #=> String
resp.column_list[0].type_name #=> String
resp.next_token #=> String
resp.table_name #=> String

Options Hash (options):

:cluster_identifier (required, String) —
The cluster identifier. This parameter is required when authenticating using either AWS Secrets Manager or temporary credentials.
:database (String) —
The name of the database. This parameter is required when authenticating using temporary credentials.
:db_user (String) —
The database user name. This parameter is required when authenticating using temporary credentials.
:max_results (Integer) —
The maximum number of tables to return in the response. If more tables exist than fit in one response, then NextToken is returned to page through the results.
:next_token (String) —
A value that indicates the starting point for the next set of response records in a subsequent request. If a value is returned in a response, you can retrieve the next set of records by providing this returned NextToken value in the next NextToken parameter and retrying the command. If the NextToken field is empty, all response records have been retrieved for the request.
:schema (String) —
The schema that contains the table. If no schema is specified, then matching tables for all schemas are returned.
:secret_arn (String) —
The name or ARN of the secret that enables access to the database. This parameter is required when authenticating using AWS Secrets Manager.
:table (String) —
The table name. If no table is specified, then all tables for all matching schemas are returned. If no table and no schema is specified, then all tables for all schemas in the database are returned

Returns:

(Types::DescribeTableResponse) —
Returns a response object which responds to the following methods:
- #column_list => Array<Types::ColumnMetadata>
- #next_token => String
- #table_name => String

See Also:

AWS API Documentation

#execute_statement(options = {}) ⇒ `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:

AWS Secrets Manager - specify the Amazon Resource Name (ARN) of the secret and the cluster identifier that matches the cluster in the secret.
Temporary credentials - specify the cluster identifier, the database name, and the database user name. Permission to call the redshift:GetClusterCredentials operation is required to use this method.

Examples:

Request syntax with placeholder values


resp = client.execute_statement({
  cluster_identifier: "Location", # required
  database: "String",
  db_user: "String",
  secret_arn: "SecretArn",
  sql: "StatementString", # required
  statement_name: "StatementNameString",
  with_event: false,
})

Response structure


resp.cluster_identifier #=> String
resp.created_at #=> Time
resp.database #=> String
resp.db_user #=> String
resp.id #=> String
resp.secret_arn #=> String

Options Hash (options):

:cluster_identifier (required, String) —
The cluster identifier. This parameter is required when authenticating using either AWS Secrets Manager or temporary credentials.
:database (String) —
The name of the database. This parameter is required when authenticating using temporary credentials.
:db_user (String) —
The database user name. This parameter is required when authenticating using temporary credentials.
:secret_arn (String) —
The name or ARN of the secret that enables access to the database. This parameter is required when authenticating using AWS Secrets Manager.
:sql (required, String) —
The SQL statement text to run.
:statement_name (String) —
The name of the SQL statement. You can name the SQL statement when you create it to identify the query.
:with_event (Boolean) —
A value that indicates whether to send an event to the Amazon EventBridge event bus after the SQL statement runs.

Returns:

(Types::ExecuteStatementOutput) —
Returns a response object which responds to the following methods:
- #cluster_identifier => String
- #created_at => Time
- #database => String
- #db_user => String
- #id => String
- #secret_arn => String

See Also:

AWS API Documentation

#get_statement_result(options = {}) ⇒ `Types::GetStatementResultResponse`

Fetches the temporarily cached result of an SQL statement. A token is returned to page through the statement results.

Examples:

Request syntax with placeholder values


resp = client.get_statement_result({
  id: "UUID", # required
  next_token: "String",
})

Response structure


resp.column_metadata #=> Array
resp.column_metadata[0].column_default #=> String
resp.column_metadata[0].is_case_sensitive #=> true/false
resp.column_metadata[0].is_currency #=> true/false
resp.column_metadata[0].is_signed #=> true/false
resp.column_metadata[0].label #=> String
resp.column_metadata[0].length #=> Integer
resp.column_metadata[0].name #=> String
resp.column_metadata[0].nullable #=> Integer
resp.column_metadata[0].precision #=> Integer
resp.column_metadata[0].scale #=> Integer
resp.column_metadata[0].schema_name #=> String
resp.column_metadata[0].table_name #=> String
resp.column_metadata[0].type_name #=> String
resp.next_token #=> String
resp.records #=> Array
resp.records[0] #=> Array
resp.records[0][0].blob_value #=> IO
resp.records[0][0].boolean_value #=> true/false
resp.records[0][0].double_value #=> Float
resp.records[0][0].is_null #=> true/false
resp.records[0][0].long_value #=> Integer
resp.records[0][0].string_value #=> String
resp.total_num_rows #=> Integer

Options Hash (options):

:id (required, String) —
The identifier of the SQL statement whose results are to be fetched. This value is a universally unique identifier (UUID) generated by Amazon Redshift Data API. This identifier is returned by ExecuteStatment and ListStatements.
:next_token (String) —
A value that indicates the starting point for the next set of response records in a subsequent request. If a value is returned in a response, you can retrieve the next set of records by providing this returned NextToken value in the next NextToken parameter and retrying the command. If the NextToken field is empty, all response records have been retrieved for the request.

Returns:

(Types::GetStatementResultResponse) —
Returns a response object which responds to the following methods:
- #column_metadata => Array<Types::ColumnMetadata>
- #next_token => String
- #records => Array<Array<Types::Field>>
- #total_num_rows => Integer

See Also:

AWS API Documentation

#list_databases(options = {}) ⇒ `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:

AWS Secrets Manager - specify the Amazon Resource Name (ARN) of the secret and the cluster identifier that matches the cluster in the secret.
Temporary credentials - specify the cluster identifier, the database name, and the database user name. Permission to call the redshift:GetClusterCredentials operation is required to use this method.

Examples:

Request syntax with placeholder values


resp = client.list_databases({
  cluster_identifier: "Location", # required
  database: "String",
  db_user: "String",
  max_results: 1,
  next_token: "String",
  secret_arn: "SecretArn",
})

Response structure


resp.databases #=> Array
resp.databases[0] #=> String
resp.next_token #=> String

Options Hash (options):

:cluster_identifier (required, String) —
The cluster identifier. This parameter is required when authenticating using either AWS Secrets Manager or temporary credentials.
:database (String) —
The name of the database. This parameter is required when authenticating using temporary credentials.
:db_user (String) —
The database user name. This parameter is required when authenticating using temporary credentials.
:max_results (Integer) —
The maximum number of databases to return in the response. If more databases exist than fit in one response, then NextToken is returned to page through the results.
:next_token (String) —
A value that indicates the starting point for the next set of response records in a subsequent request. If a value is returned in a response, you can retrieve the next set of records by providing this returned NextToken value in the next NextToken parameter and retrying the command. If the NextToken field is empty, all response records have been retrieved for the request.
:secret_arn (String) —
The name or ARN of the secret that enables access to the database. This parameter is required when authenticating using AWS Secrets Manager.

Returns:

(Types::ListDatabasesResponse) —
Returns a response object which responds to the following methods:
- #databases => Array<String>
- #next_token => String

See Also:

AWS API Documentation

#list_schemas(options = {}) ⇒ `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:

AWS Secrets Manager - specify the Amazon Resource Name (ARN) of the secret and the cluster identifier that matches the cluster in the secret.
Temporary credentials - specify the cluster identifier, the database name, and the database user name. Permission to call the redshift:GetClusterCredentials operation is required to use this method.

Examples:

Request syntax with placeholder values


resp = client.list_schemas({
  cluster_identifier: "Location", # required
  database: "String", # required
  db_user: "String",
  max_results: 1,
  next_token: "String",
  schema_pattern: "String",
  secret_arn: "SecretArn",
})

Response structure


resp.next_token #=> String
resp.schemas #=> Array
resp.schemas[0] #=> String

Options Hash (options):

:cluster_identifier (required, String) —
The cluster identifier. This parameter is required when authenticating using either AWS Secrets Manager or temporary credentials.
:database (required, String) —
The name of the database. This parameter is required when authenticating using temporary credentials.
:db_user (String) —
The database user name. This parameter is required when authenticating using temporary credentials.
:max_results (Integer) —
The maximum number of schemas to return in the response. If more schemas exist than fit in one response, then NextToken is returned to page through the results.
:next_token (String) —
A value that indicates the starting point for the next set of response records in a subsequent request. If a value is returned in a response, you can retrieve the next set of records by providing this returned NextToken value in the next NextToken parameter and retrying the command. If the NextToken field is empty, all response records have been retrieved for the request.
:schema_pattern (String) —
A pattern to filter results by schema name. Within a schema pattern, \"%\" means match any substring of 0 or more characters and \"_\" means match any one character. Only schema name entries matching the search pattern are returned.
:secret_arn (String) —
The name or ARN of the secret that enables access to the database. This parameter is required when authenticating using AWS Secrets Manager.

Returns:

(Types::ListSchemasResponse) —
Returns a response object which responds to the following methods:
- #next_token => String
- #schemas => Array<String>

See Also:

AWS API Documentation

#list_statements(options = {}) ⇒ `Types::ListStatementsResponse`

List of SQL statements. By default, only finished statements are shown. A token is returned to page through the statement list.

Examples:

Request syntax with placeholder values


resp = client.list_statements({
  max_results: 1,
  next_token: "String",
  statement_name: "StatementNameString",
  status: "ABORTED", # accepts ABORTED, ALL, FAILED, FINISHED, PICKED, STARTED, SUBMITTED
})

Response structure


resp.next_token #=> String
resp.statements #=> Array
resp.statements[0].created_at #=> Time
resp.statements[0].id #=> String
resp.statements[0].query_string #=> String
resp.statements[0].secret_arn #=> String
resp.statements[0].statement_name #=> String
resp.statements[0].status #=> String, one of "ABORTED", "ALL", "FAILED", "FINISHED", "PICKED", "STARTED", "SUBMITTED"
resp.statements[0].updated_at #=> Time

Options Hash (options):

:max_results (Integer) —
The maximum number of SQL statements to return in the response. If more SQL statements exist than fit in one response, then NextToken is returned to page through the results.
:next_token (String) —
A value that indicates the starting point for the next set of response records in a subsequent request. If a value is returned in a response, you can retrieve the next set of records by providing this returned NextToken value in the next NextToken parameter and retrying the command. If the NextToken field is empty, all response records have been retrieved for the request.
:statement_name (String) —
The name of the SQL statement specified as input to ExecuteStatement to identify the query. You can list multiple statements by providing a prefix that matches the beginning of the statement name. For example, to list myStatement1, myStatement2, myStatement3, and so on, then provide the a value of myStatement. Data API does a case-sensitive match of SQL statement names to the prefix value you provide.
:status (String) —
The status of the SQL statement to list. Status values are defined as follows:
- ABORTED - The query run was stopped by the user.
- ALL - A status value that includes all query statuses. This value can be used to filter results.
- FAILED - The query run failed.
- FINISHED - The query has finished running.
- PICKED - The query has been chosen to be run.
- STARTED - The query run has started.
- SUBMITTED - The query was submitted, but not yet processed.

Returns:

(Types::ListStatementsResponse) —
Returns a response object which responds to the following methods:
- #next_token => String
- #statements => Array<Types::StatementData>

See Also:

AWS API Documentation

#list_tables(options = {}) ⇒ `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:

AWS Secrets Manager - specify the Amazon Resource Name (ARN) of the secret and the cluster identifier that matches the cluster in the secret.
Temporary credentials - specify the cluster identifier, the database name, and the database user name. Permission to call the redshift:GetClusterCredentials operation is required to use this method.

Examples:

Request syntax with placeholder values


resp = client.list_tables({
  cluster_identifier: "Location", # required
  database: "String", # required
  db_user: "String",
  max_results: 1,
  next_token: "String",
  schema_pattern: "String",
  secret_arn: "SecretArn",
  table_pattern: "String",
})

Response structure


resp.next_token #=> String
resp.tables #=> Array
resp.tables[0].name #=> String
resp.tables[0].schema #=> String
resp.tables[0].type #=> String

Options Hash (options):

:cluster_identifier (required, String) —
The cluster identifier. This parameter is required when authenticating using either AWS Secrets Manager or temporary credentials.
:database (required, String) —
The name of the database. This parameter is required when authenticating using temporary credentials.
:db_user (String) —
The database user name. This parameter is required when authenticating using temporary credentials.
:max_results (Integer) —
The maximum number of tables to return in the response. If more tables exist than fit in one response, then NextToken is returned to page through the results.
:next_token (String) —
A value that indicates the starting point for the next set of response records in a subsequent request. If a value is returned in a response, you can retrieve the next set of records by providing this returned NextToken value in the next NextToken parameter and retrying the command. If the NextToken field is empty, all response records have been retrieved for the request.
:schema_pattern (String) —
A pattern to filter results by schema name. Within a schema pattern, \"%\" means match any substring of 0 or more characters and \"_\" means match any one character. Only schema name entries matching the search pattern are returned. If SchemaPattern is not specified, then all tables that match TablePattern are returned. If neither SchemaPattern or TablePattern are specified, then all tables are returned.
:secret_arn (String) —
The name or ARN of the secret that enables access to the database. This parameter is required when authenticating using AWS Secrets Manager.
:table_pattern (String) —
A pattern to filter results by table name. Within a table pattern, \"%\" means match any substring of 0 or more characters and \"_\" means match any one character. Only table name entries matching the search pattern are returned. If TablePattern is not specified, then all tables that match SchemaPatternare returned. If neither SchemaPattern or TablePattern are specified, then all tables are returned.

Returns:

(Types::ListTablesResponse) —
Returns a response object which responds to the following methods:
- #next_token => String
- #tables => Array<Types::TableMember>

See Also:

AWS API Documentation

#wait_until(waiter_name, params = {}) {|waiter| ... } ⇒ `Boolean`

Waiters polls an API operation until a resource enters a desired state.

Basic Usage

Waiters will poll until they are succesful, they fail by entering a terminal state, or until a maximum number of attempts are made.

# polls in a loop, sleeping between attempts client.waiter_until(waiter_name, params)

Configuration

You can configure the maximum number of polling attempts, and the delay (in seconds) between each polling attempt. You configure waiters by passing a block to #wait_until:

# poll for ~25 seconds
client.wait_until(...) do |w|
  w.max_attempts = 5
  w.delay = 5
end

Callbacks

You can be notified before each polling attempt and before each delay. If you throw :success or :failure from these callbacks, it will terminate the waiter.

started_at = Time.now
client.wait_until(...) do |w|

  # disable max attempts
  w.max_attempts = nil

  # poll for 1 hour, instead of a number of attempts
  w.before_wait do |attempts, response|
    throw :failure if Time.now - started_at > 3600
  end

end

Handling Errors

When a waiter is successful, it returns true. When a waiter fails, it raises an error. All errors raised extend from Waiters::Errors::WaiterFailed.

begin
  client.wait_until(...)
rescue Aws::Waiters::Errors::WaiterFailed
  # resource did not enter the desired state in time
end

Parameters:

waiter_name (Symbol) —
The name of the waiter. See #waiter_names for a full list of supported waiters.
params (Hash) (defaults to: {}) —
Additional request parameters. See the #waiter_names for a list of supported waiters and what request they call. The called request determines the list of accepted parameters.

Yield Parameters:

waiter (Waiters::Waiter) —
Yields a Waiter object that can be configured prior to waiting.

Returns:

(Boolean) —
Returns true if the waiter was successful.

Raises:

(Errors::FailureStateError) —
Raised when the waiter terminates because the waiter has entered a state that it will not transition out of, preventing success.
(Errors::TooManyAttemptsError) —
Raised when the configured maximum number of attempts have been made, and the waiter is not yet successful.
(Errors::UnexpectedError) —
Raised when an error is encounted while polling for a resource that is not expected.
(Errors::NoSuchWaiterError) —
Raised when you request to wait for an unknown state.

#waiter_names ⇒ `Array<Symbol>`

Returns the list of supported waiters. The following table lists the supported waiters and the client method they call:

Waiter Name	Client Method	Default Delay:	Default Max Attempts:

Returns:

(Array<Symbol>) —
the list of supported waiters.

Class: Aws::RedshiftDataAPIService::Client

Overview

Region

Credentials

Instance Attribute Summary

Attributes inherited from Seahorse::Client::Base

Constructor collapse

API Operations collapse

Instance Method Summary collapse

Methods inherited from Seahorse::Client::Base

Methods included from Seahorse::Client::HandlerBuilder

Constructor Details

#initialize(options = {}) ⇒ Aws::RedshiftDataAPIService::Client

Instance Method Details

#cancel_statement(options = {}) ⇒ Types::CancelStatementResponse

#describe_statement(options = {}) ⇒ Types::DescribeStatementResponse

#describe_table(options = {}) ⇒ Types::DescribeTableResponse

#execute_statement(options = {}) ⇒ Types::ExecuteStatementOutput

#get_statement_result(options = {}) ⇒ Types::GetStatementResultResponse

#list_databases(options = {}) ⇒ Types::ListDatabasesResponse

#list_schemas(options = {}) ⇒ Types::ListSchemasResponse

#list_statements(options = {}) ⇒ Types::ListStatementsResponse

#list_tables(options = {}) ⇒ Types::ListTablesResponse

#wait_until(waiter_name, params = {}) {|waiter| ... } ⇒ Boolean

Basic Usage

Configuration

Callbacks

Handling Errors

#waiter_names ⇒ Array<Symbol>

#initialize(options = {}) ⇒ `Aws::RedshiftDataAPIService::Client`

#cancel_statement(options = {}) ⇒ `Types::CancelStatementResponse`

#describe_statement(options = {}) ⇒ `Types::DescribeStatementResponse`

#describe_table(options = {}) ⇒ `Types::DescribeTableResponse`

#execute_statement(options = {}) ⇒ `Types::ExecuteStatementOutput`

#get_statement_result(options = {}) ⇒ `Types::GetStatementResultResponse`

#list_databases(options = {}) ⇒ `Types::ListDatabasesResponse`

#list_schemas(options = {}) ⇒ `Types::ListSchemasResponse`

#list_statements(options = {}) ⇒ `Types::ListStatementsResponse`

#list_tables(options = {}) ⇒ `Types::ListTablesResponse`

#wait_until(waiter_name, params = {}) {|waiter| ... } ⇒ `Boolean`

#waiter_names ⇒ `Array<Symbol>`