AWS SDK Version 3 for .NET
API Reference

AWS services or capabilities described in AWS Documentation may vary by region/location. Click Getting Started with Amazon AWS to see specific differences applicable to the China (Beijing) Region.

Container for the parameters to the ListTables operation. 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:

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.

Inheritance Hierarchy

System.Object
  Amazon.Runtime.AmazonWebServiceRequest
    Amazon.RedshiftDataAPIService.AmazonRedshiftDataAPIServiceRequest
      Amazon.RedshiftDataAPIService.Model.ListTablesRequest

Namespace: Amazon.RedshiftDataAPIService.Model
Assembly: AWSSDK.RedshiftDataAPIService.dll
Version: 3.x.y.z

Syntax

C#
public class ListTablesRequest : AmazonRedshiftDataAPIServiceRequest
         IAmazonWebServiceRequest

The ListTablesRequest type exposes the following members

Constructors

NameDescription
Public Method ListTablesRequest()

Properties

NameTypeDescription
Public Property ClusterIdentifier System.String

Gets and sets the property ClusterIdentifier.

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

Public Property ConnectedDatabase System.String

Gets and sets the property ConnectedDatabase.

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

Public Property Database System.String

Gets and sets the property Database.

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.

Public Property DbUser System.String

Gets and sets the property DbUser.

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

Public Property MaxResults System.Int32

Gets and sets the property MaxResults.

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.

Public Property NextToken System.String

Gets and sets the property NextToken.

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.

Public Property SchemaPattern System.String

Gets and sets the property SchemaPattern.

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.

Public Property SecretArn System.String

Gets and sets the property SecretArn.

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

Public Property TablePattern System.String

Gets and sets the property TablePattern.

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.

Public Property WorkgroupName System.String

Gets and sets the property WorkgroupName.

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.

Version Information

.NET:
Supported in: 8.0 and newer, Core 3.1

.NET Standard:
Supported in: 2.0

.NET Framework:
Supported in: 4.5 and newer, 3.5