You are viewing documentation for version 2 of the AWS SDK for Ruby. Version 3 documentation can be found here.
Class: Aws::RedshiftDataAPIService::Types::ListTablesRequest
- Inherits:
-
Struct
- Object
- Struct
- Aws::RedshiftDataAPIService::Types::ListTablesRequest
- Defined in:
- (unknown)
Overview
When passing ListTablesRequest as input to an Aws::Client method, you can use a vanilla Hash:
{
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",
}
Instance Attribute Summary collapse
-
#cluster_identifier ⇒ String
The cluster identifier.
-
#database ⇒ String
The name of the database.
-
#db_user ⇒ String
The database user name.
-
#max_results ⇒ Integer
The maximum number of tables to return in the response.
-
#next_token ⇒ String
A value that indicates the starting point for the next set of response records in a subsequent request.
-
#schema_pattern ⇒ String
A pattern to filter results by schema name.
-
#secret_arn ⇒ String
The name or ARN of the secret that enables access to the database.
-
#table_pattern ⇒ String
A pattern to filter results by table name.
Instance Attribute Details
#cluster_identifier ⇒ 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_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 SchemaPattern
are returned. If neither SchemaPattern
or
TablePattern
are specified, then all tables are returned.