Class: Aws::RedshiftDataAPIService::Types::ListTablesRequest

Inherits:
Struct
  • Object
show all
Defined in:
gems/aws-sdk-redshiftdataapiservice/lib/aws-sdk-redshiftdataapiservice/types.rb

Overview

Constant Summary collapse

SENSITIVE =
[]

Instance Attribute Summary collapse

Instance Attribute Details

#cluster_identifierString

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

Returns:

  • (String)


1290
1291
1292
1293
1294
1295
1296
1297
1298
1299
1300
1301
1302
1303
# File 'gems/aws-sdk-redshiftdataapiservice/lib/aws-sdk-redshiftdataapiservice/types.rb', line 1290

class ListTablesRequest < Struct.new(
  :cluster_identifier,
  :connected_database,
  :database,
  :db_user,
  :max_results,
  :next_token,
  :schema_pattern,
  :secret_arn,
  :table_pattern,
  :workgroup_name)
  SENSITIVE = []
  include Aws::Structure
end

#connected_databaseString

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

Returns:

  • (String)


1290
1291
1292
1293
1294
1295
1296
1297
1298
1299
1300
1301
1302
1303
# File 'gems/aws-sdk-redshiftdataapiservice/lib/aws-sdk-redshiftdataapiservice/types.rb', line 1290

class ListTablesRequest < Struct.new(
  :cluster_identifier,
  :connected_database,
  :database,
  :db_user,
  :max_results,
  :next_token,
  :schema_pattern,
  :secret_arn,
  :table_pattern,
  :workgroup_name)
  SENSITIVE = []
  include Aws::Structure
end

#databaseString

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.

Returns:

  • (String)


1290
1291
1292
1293
1294
1295
1296
1297
1298
1299
1300
1301
1302
1303
# File 'gems/aws-sdk-redshiftdataapiservice/lib/aws-sdk-redshiftdataapiservice/types.rb', line 1290

class ListTablesRequest < Struct.new(
  :cluster_identifier,
  :connected_database,
  :database,
  :db_user,
  :max_results,
  :next_token,
  :schema_pattern,
  :secret_arn,
  :table_pattern,
  :workgroup_name)
  SENSITIVE = []
  include Aws::Structure
end

#db_userString

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

Returns:

  • (String)


1290
1291
1292
1293
1294
1295
1296
1297
1298
1299
1300
1301
1302
1303
# File 'gems/aws-sdk-redshiftdataapiservice/lib/aws-sdk-redshiftdataapiservice/types.rb', line 1290

class ListTablesRequest < Struct.new(
  :cluster_identifier,
  :connected_database,
  :database,
  :db_user,
  :max_results,
  :next_token,
  :schema_pattern,
  :secret_arn,
  :table_pattern,
  :workgroup_name)
  SENSITIVE = []
  include Aws::Structure
end

#max_resultsInteger

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.

Returns:

  • (Integer)


1290
1291
1292
1293
1294
1295
1296
1297
1298
1299
1300
1301
1302
1303
# File 'gems/aws-sdk-redshiftdataapiservice/lib/aws-sdk-redshiftdataapiservice/types.rb', line 1290

class ListTablesRequest < Struct.new(
  :cluster_identifier,
  :connected_database,
  :database,
  :db_user,
  :max_results,
  :next_token,
  :schema_pattern,
  :secret_arn,
  :table_pattern,
  :workgroup_name)
  SENSITIVE = []
  include Aws::Structure
end

#next_tokenString

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:

  • (String)


1290
1291
1292
1293
1294
1295
1296
1297
1298
1299
1300
1301
1302
1303
# File 'gems/aws-sdk-redshiftdataapiservice/lib/aws-sdk-redshiftdataapiservice/types.rb', line 1290

class ListTablesRequest < Struct.new(
  :cluster_identifier,
  :connected_database,
  :database,
  :db_user,
  :max_results,
  :next_token,
  :schema_pattern,
  :secret_arn,
  :table_pattern,
  :workgroup_name)
  SENSITIVE = []
  include Aws::Structure
end

#schema_patternString

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.

Returns:

  • (String)


1290
1291
1292
1293
1294
1295
1296
1297
1298
1299
1300
1301
1302
1303
# File 'gems/aws-sdk-redshiftdataapiservice/lib/aws-sdk-redshiftdataapiservice/types.rb', line 1290

class ListTablesRequest < Struct.new(
  :cluster_identifier,
  :connected_database,
  :database,
  :db_user,
  :max_results,
  :next_token,
  :schema_pattern,
  :secret_arn,
  :table_pattern,
  :workgroup_name)
  SENSITIVE = []
  include Aws::Structure
end

#secret_arnString

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

Returns:

  • (String)


1290
1291
1292
1293
1294
1295
1296
1297
1298
1299
1300
1301
1302
1303
# File 'gems/aws-sdk-redshiftdataapiservice/lib/aws-sdk-redshiftdataapiservice/types.rb', line 1290

class ListTablesRequest < Struct.new(
  :cluster_identifier,
  :connected_database,
  :database,
  :db_user,
  :max_results,
  :next_token,
  :schema_pattern,
  :secret_arn,
  :table_pattern,
  :workgroup_name)
  SENSITIVE = []
  include Aws::Structure
end

#table_patternString

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:

  • (String)


1290
1291
1292
1293
1294
1295
1296
1297
1298
1299
1300
1301
1302
1303
# File 'gems/aws-sdk-redshiftdataapiservice/lib/aws-sdk-redshiftdataapiservice/types.rb', line 1290

class ListTablesRequest < Struct.new(
  :cluster_identifier,
  :connected_database,
  :database,
  :db_user,
  :max_results,
  :next_token,
  :schema_pattern,
  :secret_arn,
  :table_pattern,
  :workgroup_name)
  SENSITIVE = []
  include Aws::Structure
end

#workgroup_nameString

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:

  • (String)


1290
1291
1292
1293
1294
1295
1296
1297
1298
1299
1300
1301
1302
1303
# File 'gems/aws-sdk-redshiftdataapiservice/lib/aws-sdk-redshiftdataapiservice/types.rb', line 1290

class ListTablesRequest < Struct.new(
  :cluster_identifier,
  :connected_database,
  :database,
  :db_user,
  :max_results,
  :next_token,
  :schema_pattern,
  :secret_arn,
  :table_pattern,
  :workgroup_name)
  SENSITIVE = []
  include Aws::Structure
end