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:
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.
Namespace: Amazon.RedshiftDataAPIService.Model
Assembly: AWSSDK.RedshiftDataAPIService.dll
Version: 3.x.y.z
public class ListTablesRequest : AmazonRedshiftDataAPIServiceRequest IAmazonWebServiceRequest
The ListTablesRequest type exposes the following members
Name | Description | |
---|---|---|
ListTablesRequest() |
Name | Type | Description | |
---|---|---|---|
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. |
|
ConnectedDatabase | System.String |
Gets and sets the property ConnectedDatabase. A database name. The connected database is specified when you connect with your authentication credentials. |
|
Database | System.String |
Gets and sets the property Database.
The name of the database that contains the tables to list. If |
|
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. |
|
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 | 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. |
|
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 |
|
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. |
|
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 |
|
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. |
.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