Class: Aws::RedshiftDataAPIService::Client

Inherits:
Seahorse::Client::Base
  • Object
show all
Includes:
ClientStubs
Defined in:
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](/sdk-for-ruby/v3/developer-guide/setup-config.html).

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

Class Attribute Summary collapse

API Operations collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(options) ⇒ Client

Returns a new instance of Client.

Parameters:

  • options (Hash)

Options Hash (options):

  • :plugins (Array<Seahorse::Client::Plugin>) — default: []] —

    A list of plugins to apply to the client. Each plugin is either a class name or an instance of a plugin class.

  • :credentials (required, Aws::CredentialProvider) —

    Your AWS credentials. This can be an instance of any one of the following classes:

    • ‘Aws::Credentials` - Used for configuring static, non-refreshing credentials.

    • ‘Aws::SharedCredentials` - Used for loading static credentials from a shared file, such as `~/.aws/config`.

    • ‘Aws::AssumeRoleCredentials` - Used when you need to assume a role.

    • ‘Aws::AssumeRoleWebIdentityCredentials` - Used when you need to assume a role after providing credentials via the web.

    • ‘Aws::SSOCredentials` - Used for loading credentials from AWS SSO using an access token generated from `aws login`.

    • ‘Aws::ProcessCredentials` - Used for loading credentials from a process that outputs to stdout.

    • ‘Aws::InstanceProfileCredentials` - Used for loading credentials from an EC2 IMDS on an EC2 instance.

    • ‘Aws::ECSCredentials` - Used for loading credentials from instances running in ECS.

    • ‘Aws::CognitoIdentityCredentials` - Used for loading credentials from the Cognito Identity service.

    When ‘:credentials` are not configured directly, the following locations will be searched for credentials:

    • ‘Aws.config`

    • The ‘:access_key_id`, `:secret_access_key`, `:session_token`, and `:account_id` options.

    • ENV, ENV, ENV, and ENV

    • ‘~/.aws/credentials`

    • ‘~/.aws/config`

    • EC2/ECS IMDS instance profile - When used by default, the timeouts are very aggressive. Construct and pass an instance of ‘Aws::InstanceProfileCredentials` or `Aws::ECSCredentials` to enable retries and extended timeouts. Instance profile credential fetching can be disabled by setting ENV to true.

  • :region (required, String) —

    The AWS region to connect to. The configured ‘:region` is used to determine the service `:endpoint`. When not passed, a default `:region` is searched for in the following locations:

  • :access_key_id (String)
  • :account_id (String)
  • :active_endpoint_cache (Boolean) — default: false —

    When set to ‘true`, a thread polling for endpoints will be running in the background every 60 secs (default). Defaults to `false`.

  • :adaptive_retry_wait_to_fill (Boolean) — default: true —

    Used only in ‘adaptive` retry mode. When true, the request will sleep until there is sufficent client side capacity to retry the request. When false, the request will raise a `RetryCapacityNotAvailableError` and will not retry instead of sleeping.

  • :client_side_monitoring (Boolean) — default: false —

    When ‘true`, client-side metrics will be collected for all API requests from this client.

  • :client_side_monitoring_client_id (String) — default: "" —

    Allows you to provide an identifier for this client which will be attached to all generated client side metrics. Defaults to an empty string.

  • :client_side_monitoring_host (String) — default: "127.0.0.1" —

    Allows you to specify the DNS hostname or IPv4 or IPv6 address that the client side monitoring agent is running on, where client metrics will be published via UDP.

  • :client_side_monitoring_port (Integer) — default: 31000 —

    Required for publishing client metrics. The port that the client side monitoring agent is running on, where client metrics will be published via UDP.

  • :client_side_monitoring_publisher (Aws::ClientSideMonitoring::Publisher) — default: Aws::ClientSideMonitoring::Publisher —

    Allows you to provide a custom client-side monitoring publisher class. By default, will use the Client Side Monitoring Agent Publisher.

  • :convert_params (Boolean) — default: true —

    When ‘true`, an attempt is made to coerce request parameters into the required types.

  • :correct_clock_skew (Boolean) — default: true —

    Used only in ‘standard` and adaptive retry modes. Specifies whether to apply a clock skew correction and retry requests with skewed client clocks.

  • :defaults_mode (String) — default: "legacy" —

    See DefaultsModeConfiguration for a list of the accepted modes and the configuration defaults that are included.

  • :disable_host_prefix_injection (Boolean) — default: false —

    Set to true to disable SDK automatically adding host prefix to default service endpoint when available.

  • :disable_request_compression (Boolean) — default: false —

    When set to ‘true’ the request body will not be compressed for supported operations.

  • :endpoint (String, URI::HTTPS, URI::HTTP) —

    Normally you should not configure the ‘:endpoint` option directly. This is normally constructed from the `:region` option. Configuring `:endpoint` is normally reserved for connecting to test or custom endpoints. The endpoint should be a URI formatted like:

    'http://example.com'
'https://example.com'
'http://example.com:123'
  • :endpoint_cache_max_entries (Integer) — default: 1000 —

    Used for the maximum size limit of the LRU cache storing endpoints data for endpoint discovery enabled operations. Defaults to 1000.

  • :endpoint_cache_max_threads (Integer) — default: 10 —

    Used for the maximum threads in use for polling endpoints to be cached, defaults to 10.

  • :endpoint_cache_poll_interval (Integer) — default: 60 —

    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.

  • :endpoint_discovery (Boolean) — default: false —

    When set to ‘true`, endpoint discovery will be enabled for operations when available.

  • :ignore_configured_endpoint_urls (Boolean) —

    Setting to true disables use of endpoint URLs provided via environment variables and the shared configuration file.

  • :log_formatter (Aws::Log::Formatter) — default: Aws::Log::Formatter.default —

    The log formatter.

  • :log_level (Symbol) — default: :info —

    The log level to send messages to the ‘:logger` at.

  • :logger (Logger) —

    The Logger instance to send log messages to. If this option is not set, logging will be disabled.

  • :max_attempts (Integer) — default: 3 —

    An integer representing the maximum number attempts that will be made for a single request, including the initial attempt. For example, setting this value to 5 will result in a request being retried up to 4 times. Used in ‘standard` and `adaptive` retry modes.

  • :profile (String) — default: "default" —

    Used when loading credentials from the shared credentials file at HOME/.aws/credentials. When not specified, ‘default’ is used.

  • :request_checksum_calculation (String) — default: "when_supported" —

    Determines when a checksum will be calculated for request payloads. Values are:

    • ‘when_supported` - (default) When set, a checksum will be calculated for all request payloads of operations modeled with the `httpChecksum` trait where `requestChecksumRequired` is `true` and/or a `requestAlgorithmMember` is modeled.

    • ‘when_required` - When set, a checksum will only be calculated for request payloads of operations modeled with the `httpChecksum` trait where `requestChecksumRequired` is `true` or where a `requestAlgorithmMember` is modeled and supplied.

  • :request_min_compression_size_bytes (Integer) — default: 10240 —

    The minimum size in bytes that triggers compression for request bodies. The value must be non-negative integer value between 0 and 10485780 bytes inclusive.

  • :response_checksum_validation (String) — default: "when_supported" —

    Determines when checksum validation will be performed on response payloads. Values are:

    • ‘when_supported` - (default) When set, checksum validation is performed on all response payloads of operations modeled with the `httpChecksum` trait where `responseAlgorithms` is modeled, except when no modeled checksum algorithms are supported.

    • ‘when_required` - When set, checksum validation is not performed on response payloads of operations unless the checksum algorithm is supported and the `requestValidationModeMember` member is set to `ENABLED`.

  • :retry_backoff (Proc) —

    A proc or lambda used for backoff. Defaults to 2**retries * retry_base_delay. This option is only used in the ‘legacy` retry mode.

  • :retry_base_delay (Float) — default: 0.3 —

    The base delay in seconds used by the default backoff function. This option is only used in the ‘legacy` retry mode.

  • :retry_jitter (Symbol) — default: :none —

    A delay randomiser function used by the default backoff function. Some predefined functions can be referenced by name - :none, :equal, :full, otherwise a Proc that takes and returns a number. This option is only used in the ‘legacy` retry mode.

    @see www.awsarchitectureblog.com/2015/03/backoff.html

  • :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, auth errors, endpoint discovery, and errors from expired credentials. This option is only used in the ‘legacy` retry mode.

  • :retry_max_delay (Integer) — default: 0 —

    The maximum number of seconds to delay between retries (0 for no limit) used by the default backoff function. This option is only used in the ‘legacy` retry mode.

  • :retry_mode (String) — default: "legacy" —

    Specifies which retry algorithm to use. Values are:

    • ‘legacy` - The pre-existing retry behavior. This is default value if no retry mode is provided.

    • ‘standard` - A standardized set of retry rules across the AWS SDKs. This includes support for retry quotas, which limit the number of unsuccessful retries a client can make.

    • ‘adaptive` - An experimental retry mode that includes all the functionality of `standard` mode along with automatic client side throttling. This is a provisional mode that may change behavior in the future.

  • :sdk_ua_app_id (String) —

    A unique and opaque application ID that is appended to the User-Agent header as app/sdk_ua_app_id. It should have a maximum length of 50. This variable is sourced from environment variable AWS_SDK_UA_APP_ID or the shared config profile attribute sdk_ua_app_id.

  • :secret_access_key (String)
  • :session_token (String)
  • :sigv4a_signing_region_set (Array) —

    A list of regions that should be signed with SigV4a signing. When not passed, a default ‘:sigv4a_signing_region_set` is searched for in the following locations:

  • :simple_json (Boolean) — default: false —

    Disables request parameter conversion, validation, and formatting. Also disables response data type conversions. The request parameters hash must be formatted exactly as the API expects.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.

  • :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.

  • :telemetry_provider (Aws::Telemetry::TelemetryProviderBase) — default: Aws::Telemetry::NoOpTelemetryProvider —

    Allows you to provide a telemetry provider, which is used to emit telemetry data. By default, uses ‘NoOpTelemetryProvider` which will not record or emit any telemetry data. The SDK supports the following telemetry providers:

    • OpenTelemetry (OTel) - To use the OTel provider, install and require the

    ‘opentelemetry-sdk` gem and then, pass in an instance of a `Aws::Telemetry::OTelProvider` for telemetry provider.

  • :token_provider (Aws::TokenProvider) —

    A Bearer Token Provider. This can be an instance of any one of the following classes:

    • ‘Aws::StaticTokenProvider` - Used for configuring static, non-refreshing tokens.

    • ‘Aws::SSOTokenProvider` - Used for loading tokens from AWS SSO using an access token generated from `aws login`.

    When ‘:token_provider` is not configured directly, the `Aws::TokenProviderChain` will be used to search for tokens configured for your profile in shared configuration files.

  • :use_dualstack_endpoint (Boolean) —

    When set to ‘true`, dualstack enabled endpoints (with `.aws` TLD) will be used if available.

  • :use_fips_endpoint (Boolean) —

    When set to ‘true`, fips compatible endpoints will be used if available. When a `fips` region is used, the region is normalized and this config is set to `true`.

  • :validate_params (Boolean) — default: true —

    When ‘true`, request parameters are validated before sending the request.

  • :endpoint_provider (Aws::RedshiftDataAPIService::EndpointProvider) —

    The endpoint provider used to resolve endpoints. Any object that responds to ‘#resolve_endpoint(parameters)` where `parameters` is a Struct similar to `Aws::RedshiftDataAPIService::EndpointParameters`.

  • :http_continue_timeout (Float) — default: 1 —

    The number of seconds to wait for a 100-continue response before sending the request body. This option has no effect unless the request has “Expect” header set to “100-continue”. Defaults to ‘nil` which disables this behaviour. This value can safely be set per request on the session.

  • :http_idle_timeout (Float) — default: 5 —

    The number of seconds a connection is allowed to sit idle before it is considered stale. Stale connections are closed and removed from the pool before making a request.

  • :http_open_timeout (Float) — default: 15 —

    The default number of seconds to wait for response data. This value can safely be set per-request on the session.

  • :http_proxy (URI::HTTP, String) —

    A proxy to send requests through. Formatted like ‘proxy.com:123’.

  • :http_read_timeout (Float) — default: 60 —

    The default number of seconds to wait for response data. This value can safely be set per-request on the session.

  • :http_wire_trace (Boolean) — default: false —

    When ‘true`, HTTP debug output will be sent to the `:logger`.

  • :on_chunk_received (Proc) —

    When a Proc object is provided, it will be used as callback when each chunk of the response body is received. It provides three arguments: the chunk, the number of bytes received, and the total number of bytes in the response (or nil if the server did not send a ‘content-length`).

  • :on_chunk_sent (Proc) —

    When a Proc object is provided, it will be used as callback when each chunk of the request body is sent. It provides three arguments: the chunk, the number of bytes read from the body, and the total number of bytes in the body.

  • :raise_response_errors (Boolean) — default: true —

    When ‘true`, response errors are raised.

  • :ssl_ca_bundle (String) —

    Full path to the SSL certificate authority bundle file that should be used when verifying peer certificates. If you do not pass ‘:ssl_ca_bundle` or `:ssl_ca_directory` the the system default will be used if available.

  • :ssl_ca_directory (String) —

    Full path of the directory that contains the unbundled SSL certificate authority files for verifying peer certificates. If you do not pass ‘:ssl_ca_bundle` or `:ssl_ca_directory` the the system default will be used if available.

  • :ssl_ca_store (String) —

    Sets the X509::Store to verify peer certificate.

  • :ssl_cert (OpenSSL::X509::Certificate) —

    Sets a client certificate when creating http connections.

  • :ssl_key (OpenSSL::PKey) —

    Sets a client key when creating http connections.

  • :ssl_timeout (Float) —

    Sets the SSL timeout in seconds

  • :ssl_verify_peer (Boolean) — default: true —

    When ‘true`, SSL peer certificates are verified when establishing a connection.



474
475
476
 
# File 'lib/aws-sdk-redshiftdataapiservice/client.rb', line 474

def initialize(*args)
  super
end

Class Attribute Details

.identifier ⇒ Object (readonly)

This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future. 



1743
1744
1745
 
# File 'lib/aws-sdk-redshiftdataapiservice/client.rb', line 1743

def identifier
  @identifier
end

Class Method Details

.errors_module ⇒ Object

This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future. 



1746
1747
1748
 
# File 'lib/aws-sdk-redshiftdataapiservice/client.rb', line 1746

def errors_module
  Errors
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, provide the ‘secret-arn` of a secret stored in Secrets Manager which has `username` and `password`. The specified secret contains credentials to connect to the `database` you specify. When you are connecting to a cluster, you also supply the database name, If you provide a cluster identifier (`dbClusterIdentifier`), it must match the cluster identifier stored in the secret. When you are connecting to a serverless workgroup, you also supply the database name.

  • Temporary credentials - when connecting to your data warehouse, choose one of the following options:

    • When connecting to a serverless workgroup, specify the workgroup name and database name. The database user name is derived from the IAM identity. For example, ‘arn:iam::123456789012:user:foo` has the database user name `IAM:foo`. Also, permission to call the `redshift-serverless:GetCredentials` operation is required.

    • When connecting to a cluster as an IAM identity, specify the cluster identifier and the database name. The database user name is derived from the IAM identity. For example, ‘arn:iam::123456789012:user:foo` has the database user name `IAM:foo`. Also, permission to call the `redshift:GetClusterCredentialsWithIAM` operation is required.

    • When connecting to a cluster as a database user, specify the cluster identifier, the database name, and the database user name. Also, permission to call the ‘redshift:GetClusterCredentials` operation is required.

For more information about the Amazon Redshift Data API and CLI usage examples, see [Using the Amazon Redshift Data API] in the *Amazon Redshift Management Guide*.

[1]: docs.aws.amazon.com/redshift/latest/mgmt/data-api.html

Examples:

Request syntax with placeholder values


resp = client.batch_execute_statement({
  client_token: "ClientToken",
  cluster_identifier: "ClusterIdentifierString",
  database: "String",
  db_user: "String",
  result_format: "JSON", # accepts JSON, CSV
  secret_arn: "SecretArn",
  session_id: "UUID",
  session_keep_alive_seconds: 1,
  sqls: ["StatementString"], # required
  statement_name: "StatementNameString",
  with_event: false,
  workgroup_name: "WorkgroupNameString",
})

Response structure


resp.cluster_identifier #=> String
resp.created_at #=> Time
resp.database #=> String
resp.db_groups #=> Array
resp.db_groups[0] #=> String
resp.db_user #=> String
resp.id #=> String
resp.secret_arn #=> String
resp.session_id #=> String
resp.workgroup_name #=> String

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :client_token (String) —

    A unique, case-sensitive identifier that you provide to ensure the idempotency of the request.

    **A suitable default value is auto-generated.** You should normally not need to pass this option.**

  • :cluster_identifier (String) —

    The cluster identifier. This parameter is required when connecting to a cluster and authenticating using either Secrets Manager or temporary credentials.

  • :database (String) —

    The name of the database. This parameter is required when authenticating using either Secrets Manager or temporary credentials.

  • :db_user (String) —

    The database user name. This parameter is required when connecting to a cluster as a database user and authenticating using temporary credentials.

  • :result_format (String) —

    The data format of the result of the SQL statement. If no format is specified, the default is JSON.

  • :secret_arn (String) —

    The name or ARN of the secret that enables access to the database. This parameter is required when authenticating using Secrets Manager.

  • :session_id (String) —

    The session identifier of the query.

  • :session_keep_alive_seconds (Integer) —

    The number of seconds to keep the session alive after the query finishes. The maximum time a session can keep alive is 24 hours. After 24 hours, the session is forced closed and the query is terminated.

  • :sqls (required, Array<String>) —

    One or more SQL statements to run. The SQL statements are run as a single transaction. They run serially in the order of the array. Subsequent SQL statements don’t start until the previous statement in the array completes. If any SQL statement fails, then because they are run as one transaction, all work is rolled back.</p>

  • :statement_name (String) —

    The name of the SQL statements. You can name the SQL statements when you create them 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 statements run.

  • :workgroup_name (String) —

    The serverless workgroup name or Amazon Resource Name (ARN). This parameter is required when connecting to a serverless workgroup and authenticating using either Secrets Manager or temporary credentials.

Returns:

See Also:



626
627
628
629
 
# File 'lib/aws-sdk-redshiftdataapiservice/client.rb', line 626

def batch_execute_statement(params = {}, options = {})
  req = build_request(:batch_execute_statement, params)
  req.send_request(options)
end

#build_request(operation_name, params = {}) ⇒ Object

This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future.

Parameters:

  • params ({}) (defaults to: {}) 


1716
1717
1718
1719
1720
1721
1722
1723
1724
1725
1726
1727
1728
1729
1730
1731
1732
 
# File 'lib/aws-sdk-redshiftdataapiservice/client.rb', line 1716

def build_request(operation_name, params = {})
  handlers = @handlers.for(operation_name)
  tracer = config.telemetry_provider.tracer_provider.tracer(
    Aws::Telemetry.module_to_tracer_name('Aws::RedshiftDataAPIService')
  )
  context = Seahorse::Client::RequestContext.new(
    operation_name: operation_name,
    operation: config.api.operation(operation_name),
    client: self,
    params: params,
    config: config,
    tracer: tracer
  )
  context[:gem_name] = 'aws-sdk-redshiftdataapiservice'
  context[:gem_version] = '1.51.0'
  Seahorse::Client::Request.new(handlers, context)
end

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

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

For more information about the Amazon Redshift Data API and CLI usage examples, see [Using the Amazon Redshift Data API] in the *Amazon Redshift Management Guide*.

[1]: docs.aws.amazon.com/redshift/latest/mgmt/data-api.html

Examples:

Request syntax with placeholder values


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

Response structure


resp.status #=> Boolean

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :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 ‘BatchExecuteStatment`, `ExecuteStatment`, and `ListStatements`.

Returns:

See Also:



665
666
667
668
 
# File 'lib/aws-sdk-redshiftdataapiservice/client.rb', line 665

def cancel_statement(params = {}, options = {})
  req = build_request(:cancel_statement, params)
  req.send_request(options)
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.

For more information about the Amazon Redshift Data API and CLI usage examples, see [Using the Amazon Redshift Data API] in the *Amazon Redshift Management Guide*.

[1]: docs.aws.amazon.com/redshift/latest/mgmt/data-api.html

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.has_result_set #=> Boolean
resp.id #=> String
resp.query_parameters #=> Array
resp.query_parameters[0].name #=> String
resp.query_parameters[0].value #=> String
resp.query_string #=> String
resp.redshift_pid #=> Integer
resp.redshift_query_id #=> Integer
resp.result_format #=> String, one of "JSON", "CSV"
resp.result_rows #=> Integer
resp.result_size #=> Integer
resp.secret_arn #=> String
resp.session_id #=> String
resp.status #=> String, one of "SUBMITTED", "PICKED", "STARTED", "FINISHED", "ABORTED", "FAILED", "ALL"
resp.sub_statements #=> Array
resp.sub_statements[0].created_at #=> Time
resp.sub_statements[0].duration #=> Integer
resp.sub_statements[0].error #=> String
resp.sub_statements[0].has_result_set #=> Boolean
resp.sub_statements[0].id #=> String
resp.sub_statements[0].query_string #=> String
resp.sub_statements[0].redshift_query_id #=> Integer
resp.sub_statements[0].result_rows #=> Integer
resp.sub_statements[0].result_size #=> Integer
resp.sub_statements[0].status #=> String, one of "SUBMITTED", "PICKED", "STARTED", "FINISHED", "ABORTED", "FAILED"
resp.sub_statements[0].updated_at #=> Time
resp.updated_at #=> Time
resp.workgroup_name #=> String

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :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. A suffix indicates the number of the SQL statement. For example, ‘d9b6c0c9-0747-4bf4-b142-e8883122f766:2` has a suffix of `:2` that indicates the second SQL statement of a batch query. This identifier is returned by `BatchExecuteStatment`, `ExecuteStatement`, and `ListStatements`.

Returns:

See Also:



763
764
765
766
 
# File 'lib/aws-sdk-redshiftdataapiservice/client.rb', line 763

def describe_statement(params = {}, options = {})
  req = build_request(:describe_statement, params)
  req.send_request(options)
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, provide the ‘secret-arn` of a secret stored in Secrets Manager which has `username` and `password`. The specified secret contains credentials to connect to the `database` you specify. When you are connecting to a cluster, you also supply the database name, If you provide a cluster identifier (`dbClusterIdentifier`), it must match the cluster identifier stored in the secret. When you are connecting to a serverless workgroup, you also supply the database name.

  • Temporary credentials - when connecting to your data warehouse, choose one of the following options:

    • When connecting to a serverless workgroup, specify the workgroup name and database name. The database user name is derived from the IAM identity. For example, ‘arn:iam::123456789012:user:foo` has the database user name `IAM:foo`. Also, permission to call the `redshift-serverless:GetCredentials` operation is required.

    • When connecting to a cluster as an IAM identity, specify the cluster identifier and the database name. The database user name is derived from the IAM identity. For example, ‘arn:iam::123456789012:user:foo` has the database user name `IAM:foo`. Also, permission to call the `redshift:GetClusterCredentialsWithIAM` operation is required.

    • When connecting to a cluster as a database user, specify the cluster identifier, the database name, and the database user name. Also, permission to call the ‘redshift:GetClusterCredentials` operation is required.

For more information about the Amazon Redshift Data API and CLI usage examples, see [Using the Amazon Redshift Data API] in the *Amazon Redshift Management Guide*.

[1]: docs.aws.amazon.com/redshift/latest/mgmt/data-api.html

The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.

Examples:

Request syntax with placeholder values


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

Response structure


resp.column_list #=> Array
resp.column_list[0].column_default #=> String
resp.column_list[0].is_case_sensitive #=> Boolean
resp.column_list[0].is_currency #=> Boolean
resp.column_list[0].is_signed #=> Boolean
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

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :cluster_identifier (String) —

    The cluster identifier. This parameter is required when connecting to a cluster and authenticating using either Secrets Manager or temporary credentials.

  • :connected_database (String) —

    A database name. The connected database is specified when you connect with your authentication credentials.

  • :database (required, String) —

    The name of the database that contains the tables to be described. If ‘ConnectedDatabase` is not specified, this is also the database to connect to with your authentication credentials.

  • :db_user (String) —

    The database user name. This parameter is required when connecting to a cluster as a database user and 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 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

  • :workgroup_name (String) —

    The serverless workgroup name or Amazon Resource Name (ARN). This parameter is required when connecting to a serverless workgroup and authenticating using either Secrets Manager or temporary credentials.

Returns:

See Also:



907
908
909
910
 
# File 'lib/aws-sdk-redshiftdataapiservice/client.rb', line 907

def describe_table(params = {}, options = {})
  req = build_request(:describe_table, params)
  req.send_request(options)
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, provide the ‘secret-arn` of a secret stored in Secrets Manager which has `username` and `password`. The specified secret contains credentials to connect to the `database` you specify. When you are connecting to a cluster, you also supply the database name, If you provide a cluster identifier (`dbClusterIdentifier`), it must match the cluster identifier stored in the secret. When you are connecting to a serverless workgroup, you also supply the database name.

  • Temporary credentials - when connecting to your data warehouse, choose one of the following options:

    • When connecting to a serverless workgroup, specify the workgroup name and database name. The database user name is derived from the IAM identity. For example, ‘arn:iam::123456789012:user:foo` has the database user name `IAM:foo`. Also, permission to call the `redshift-serverless:GetCredentials` operation is required.

    • When connecting to a cluster as an IAM identity, specify the cluster identifier and the database name. The database user name is derived from the IAM identity. For example, ‘arn:iam::123456789012:user:foo` has the database user name `IAM:foo`. Also, permission to call the `redshift:GetClusterCredentialsWithIAM` operation is required.

    • When connecting to a cluster as a database user, specify the cluster identifier, the database name, and the database user name. Also, permission to call the ‘redshift:GetClusterCredentials` operation is required.

For more information about the Amazon Redshift Data API and CLI usage examples, see [Using the Amazon Redshift Data API] in the *Amazon Redshift Management Guide*.

[1]: docs.aws.amazon.com/redshift/latest/mgmt/data-api.html

Examples:

Request syntax with placeholder values


resp = client.execute_statement({
  client_token: "ClientToken",
  cluster_identifier: "ClusterIdentifierString",
  database: "String",
  db_user: "String",
  parameters: [
    {
      name: "ParameterName", # required
      value: "ParameterValue", # required
    },
  ],
  result_format: "JSON", # accepts JSON, CSV
  secret_arn: "SecretArn",
  session_id: "UUID",
  session_keep_alive_seconds: 1,
  sql: "StatementString", # required
  statement_name: "StatementNameString",
  with_event: false,
  workgroup_name: "WorkgroupNameString",
})

Response structure


resp.cluster_identifier #=> String
resp.created_at #=> Time
resp.database #=> String
resp.db_groups #=> Array
resp.db_groups[0] #=> String
resp.db_user #=> String
resp.id #=> String
resp.secret_arn #=> String
resp.session_id #=> String
resp.workgroup_name #=> String

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :client_token (String) —

    A unique, case-sensitive identifier that you provide to ensure the idempotency of the request.

    **A suitable default value is auto-generated.** You should normally not need to pass this option.**

  • :cluster_identifier (String) —

    The cluster identifier. This parameter is required when connecting to a cluster and authenticating using either Secrets Manager or temporary credentials.

  • :database (String) —

    The name of the database. This parameter is required when authenticating using either Secrets Manager or temporary credentials.

  • :db_user (String) —

    The database user name. This parameter is required when connecting to a cluster as a database user and authenticating using temporary credentials.

  • :parameters (Array<Types::SqlParameter>) —

    The parameters for the SQL statement.

  • :result_format (String) —

    The data format of the result of the SQL statement. If no format is specified, the default is JSON.

  • :secret_arn (String) —

    The name or ARN of the secret that enables access to the database. This parameter is required when authenticating using Secrets Manager.

  • :session_id (String) —

    The session identifier of the query.

  • :session_keep_alive_seconds (Integer) —

    The number of seconds to keep the session alive after the query finishes. The maximum time a session can keep alive is 24 hours. After 24 hours, the session is forced closed and the query is terminated.

  • :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.

  • :workgroup_name (String) —

    The serverless workgroup name or Amazon Resource Name (ARN). This parameter is required when connecting to a serverless workgroup and authenticating using either Secrets Manager or temporary credentials.

Returns:

See Also:



1063
1064
1065
1066
 
# File 'lib/aws-sdk-redshiftdataapiservice/client.rb', line 1063

def execute_statement(params = {}, options = {})
  req = build_request(:execute_statement, params)
  req.send_request(options)
end

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

Fetches the temporarily cached result of an SQL statement in JSON format. The ‘ExecuteStatement` or `BatchExecuteStatement` operation that ran the SQL statement must have specified `ResultFormat` as `JSON` , or let the format default to JSON. A token is returned to page through the statement results.

For more information about the Amazon Redshift Data API and CLI usage examples, see [Using the Amazon Redshift Data API] in the *Amazon Redshift Management Guide*.

[1]: docs.aws.amazon.com/redshift/latest/mgmt/data-api.html

The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.

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 #=> Boolean
resp.column_metadata[0].is_currency #=> Boolean
resp.column_metadata[0].is_signed #=> Boolean
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 #=> String
resp.records[0][0].boolean_value #=> Boolean
resp.records[0][0].double_value #=> Float
resp.records[0][0].is_null #=> Boolean
resp.records[0][0].long_value #=> Integer
resp.records[0][0].string_value #=> String
resp.total_num_rows #=> Integer

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :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. A suffix indicates then number of the SQL statement. For example, ‘d9b6c0c9-0747-4bf4-b142-e8883122f766:2` has a suffix of `:2` that indicates the second SQL statement of a batch query. This identifier is returned by `BatchExecuteStatment`, `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:

See Also:



1146
1147
1148
1149
 
# File 'lib/aws-sdk-redshiftdataapiservice/client.rb', line 1146

def get_statement_result(params = {}, options = {})
  req = build_request(:get_statement_result, params)
  req.send_request(options)
end

#get_statement_result_v2(params = {}) ⇒ Types::GetStatementResultV2Response

Fetches the temporarily cached result of an SQL statement in CSV format. The ‘ExecuteStatement` or `BatchExecuteStatement` operation that ran the SQL statement must have specified `ResultFormat` as `CSV`. A token is returned to page through the statement results.

For more information about the Amazon Redshift Data API and CLI usage examples, see [Using the Amazon Redshift Data API] in the *Amazon Redshift Management Guide*.

[1]: docs.aws.amazon.com/redshift/latest/mgmt/data-api.html

The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.

Examples:

Request syntax with placeholder values


resp = client.get_statement_result_v2({
  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 #=> Boolean
resp.column_metadata[0].is_currency #=> Boolean
resp.column_metadata[0].is_signed #=> Boolean
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].csv_records #=> String
resp.result_format #=> String, one of "JSON", "CSV"
resp.total_num_rows #=> Integer

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :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. A suffix indicates then number of the SQL statement. For example, ‘d9b6c0c9-0747-4bf4-b142-e8883122f766:2` has a suffix of `:2` that indicates the second SQL statement of a batch query. This identifier is returned by `BatchExecuteStatment`, `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:

See Also:



1224
1225
1226
1227
 
# File 'lib/aws-sdk-redshiftdataapiservice/client.rb', line 1224

def get_statement_result_v2(params = {}, options = {})
  req = build_request(:get_statement_result_v2, params)
  req.send_request(options)
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, provide the ‘secret-arn` of a secret stored in Secrets Manager which has `username` and `password`. The specified secret contains credentials to connect to the `database` you specify. When you are connecting to a cluster, you also supply the database name, If you provide a cluster identifier (`dbClusterIdentifier`), it must match the cluster identifier stored in the secret. When you are connecting to a serverless workgroup, you also supply the database name.

  • Temporary credentials - when connecting to your data warehouse, choose one of the following options:

    • When connecting to a serverless workgroup, specify the workgroup name and database name. The database user name is derived from the IAM identity. For example, ‘arn:iam::123456789012:user:foo` has the database user name `IAM:foo`. Also, permission to call the `redshift-serverless:GetCredentials` operation is required.

    • When connecting to a cluster as an IAM identity, specify the cluster identifier and the database name. The database user name is derived from the IAM identity. For example, ‘arn:iam::123456789012:user:foo` has the database user name `IAM:foo`. Also, permission to call the `redshift:GetClusterCredentialsWithIAM` operation is required.

    • When connecting to a cluster as a database user, specify the cluster identifier, the database name, and the database user name. Also, permission to call the ‘redshift:GetClusterCredentials` operation is required.

For more information about the Amazon Redshift Data API and CLI usage examples, see [Using the Amazon Redshift Data API] in the *Amazon Redshift Management Guide*.

[1]: docs.aws.amazon.com/redshift/latest/mgmt/data-api.html

The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.

Examples:

Request syntax with placeholder values


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

Response structure


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

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :cluster_identifier (String) —

    The cluster identifier. This parameter is required when connecting to a cluster and authenticating using either Secrets Manager or temporary credentials.

  • :database (required, String) —

    The name of the database. This parameter is required when authenticating using either Secrets Manager or temporary credentials.

  • :db_user (String) —

    The database user name. This parameter is required when connecting to a cluster as a database user and 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 Secrets Manager.

  • :workgroup_name (String) —

    The serverless workgroup name or Amazon Resource Name (ARN). This parameter is required when connecting to a serverless workgroup and authenticating using either Secrets Manager or temporary credentials.

Returns:

See Also:



1336
1337
1338
1339
 
# File 'lib/aws-sdk-redshiftdataapiservice/client.rb', line 1336

def list_databases(params = {}, options = {})
  req = build_request(:list_databases, params)
  req.send_request(options)
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, provide the ‘secret-arn` of a secret stored in Secrets Manager which has `username` and `password`. The specified secret contains credentials to connect to the `database` you specify. When you are connecting to a cluster, you also supply the database name, If you provide a cluster identifier (`dbClusterIdentifier`), it must match the cluster identifier stored in the secret. When you are connecting to a serverless workgroup, you also supply the database name.

  • Temporary credentials - when connecting to your data warehouse, choose one of the following options:

    • When connecting to a serverless workgroup, specify the workgroup name and database name. The database user name is derived from the IAM identity. For example, ‘arn:iam::123456789012:user:foo` has the database user name `IAM:foo`. Also, permission to call the `redshift-serverless:GetCredentials` operation is required.

    • When connecting to a cluster as an IAM identity, specify the cluster identifier and the database name. The database user name is derived from the IAM identity. For example, ‘arn:iam::123456789012:user:foo` has the database user name `IAM:foo`. Also, permission to call the `redshift:GetClusterCredentialsWithIAM` operation is required.

    • When connecting to a cluster as a database user, specify the cluster identifier, the database name, and the database user name. Also, permission to call the ‘redshift:GetClusterCredentials` operation is required.

For more information about the Amazon Redshift Data API and CLI usage examples, see [Using the Amazon Redshift Data API] in the *Amazon Redshift Management Guide*.

[1]: docs.aws.amazon.com/redshift/latest/mgmt/data-api.html

The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.

Examples:

Request syntax with placeholder values


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

Response structure


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

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :cluster_identifier (String) —

    The cluster identifier. This parameter is required when connecting to a cluster and authenticating using either Secrets Manager or temporary credentials.

  • :connected_database (String) —

    A database name. The connected database is specified when you connect with your authentication credentials.

  • :database (required, String) —

    The name of the database that contains the schemas to list. If ‘ConnectedDatabase` is not specified, this is also the database to connect to with your authentication credentials.

  • :db_user (String) —

    The database user name. This parameter is required when connecting to a cluster as a database user and 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 Secrets Manager.

  • :workgroup_name (String) —

    The serverless workgroup name or Amazon Resource Name (ARN). This parameter is required when connecting to a serverless workgroup and authenticating using either Secrets Manager or temporary credentials.

Returns:

See Also:



1461
1462
1463
1464
 
# File 'lib/aws-sdk-redshiftdataapiservice/client.rb', line 1461

def list_schemas(params = {}, options = {})
  req = build_request(:list_schemas, params)
  req.send_request(options)
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.

For more information about the Amazon Redshift Data API and CLI usage examples, see [Using the Amazon Redshift Data API] in the *Amazon Redshift Management Guide*.

[1]: docs.aws.amazon.com/redshift/latest/mgmt/data-api.html

The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.

Examples:

Request syntax with placeholder values


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

Response structure


resp.next_token #=> String
resp.statements #=> Array
resp.statements[0].created_at #=> Time
resp.statements[0].id #=> String
resp.statements[0].is_batch_statement #=> Boolean
resp.statements[0].query_parameters #=> Array
resp.statements[0].query_parameters[0].name #=> String
resp.statements[0].query_parameters[0].value #=> String
resp.statements[0].query_string #=> String
resp.statements[0].query_strings #=> Array
resp.statements[0].query_strings[0] #=> String
resp.statements[0].result_format #=> String, one of "JSON", "CSV"
resp.statements[0].secret_arn #=> String
resp.statements[0].session_id #=> String
resp.statements[0].statement_name #=> String
resp.statements[0].status #=> String, one of "SUBMITTED", "PICKED", "STARTED", "FINISHED", "ABORTED", "FAILED", "ALL"
resp.statements[0].updated_at #=> Time

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :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.

  • :role_level (Boolean) —

    A value that filters which statements to return in the response. If true, all statements run by the caller’s IAM role are returned. If false, only statements run by the caller’s IAM role in the current IAM session are returned. The default is true.

  • :statement_name (String) —

    The name of the SQL statement specified as input to ‘BatchExecuteStatement` or `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:

See Also:



1565
1566
1567
1568
 
# File 'lib/aws-sdk-redshiftdataapiservice/client.rb', line 1565

def list_statements(params = {}, options = {})
  req = build_request(:list_statements, params)
  req.send_request(options)
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, provide the ‘secret-arn` of a secret stored in Secrets Manager which has `username` and `password`. The specified secret contains credentials to connect to the `database` you specify. When you are connecting to a cluster, you also supply the database name, If you provide a cluster identifier (`dbClusterIdentifier`), it must match the cluster identifier stored in the secret. When you are connecting to a serverless workgroup, you also supply the database name.

  • Temporary credentials - when connecting to your data warehouse, choose one of the following options:

    • When connecting to a serverless workgroup, specify the workgroup name and database name. The database user name is derived from the IAM identity. For example, ‘arn:iam::123456789012:user:foo` has the database user name `IAM:foo`. Also, permission to call the `redshift-serverless:GetCredentials` operation is required.

    • When connecting to a cluster as an IAM identity, specify the cluster identifier and the database name. The database user name is derived from the IAM identity. For example, ‘arn:iam::123456789012:user:foo` has the database user name `IAM:foo`. Also, permission to call the `redshift:GetClusterCredentialsWithIAM` operation is required.

    • When connecting to a cluster as a database user, specify the cluster identifier, the database name, and the database user name. Also, permission to call the ‘redshift:GetClusterCredentials` operation is required.

For more information about the Amazon Redshift Data API and CLI usage examples, see [Using the Amazon Redshift Data API] in the *Amazon Redshift Management Guide*.

[1]: docs.aws.amazon.com/redshift/latest/mgmt/data-api.html

The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.

Examples:

Request syntax with placeholder values


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

Response structure


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

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :cluster_identifier (String) —

    The cluster identifier. This parameter is required when connecting to a cluster and authenticating using either Secrets Manager or temporary credentials.

  • :connected_database (String) —

    A database name. The connected database is specified when you connect with your authentication credentials.

  • :database (required, String) —

    The name of the database that contains the tables to list. If ‘ConnectedDatabase` is not specified, this is also the database to connect to with your authentication credentials.

  • :db_user (String) —

    The database user name. This parameter is required when connecting to a cluster as a database user and 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 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 `SchemaPattern`are returned. If neither `SchemaPattern` or `TablePattern` are specified, then all tables are returned.

  • :workgroup_name (String) —

    The serverless workgroup name or Amazon Resource Name (ARN). This parameter is required when connecting to a serverless workgroup and authenticating using either Secrets Manager or temporary credentials.

Returns:

See Also:



1707
1708
1709
1710
 
# File 'lib/aws-sdk-redshiftdataapiservice/client.rb', line 1707

def list_tables(params = {}, options = {})
  req = build_request(:list_tables, params)
  req.send_request(options)
end

#waiter_names ⇒ Object

This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future.

Deprecated. 


1736
1737
1738
 
# File 'lib/aws-sdk-redshiftdataapiservice/client.rb', line 1736

def waiter_names
  []
end