redshiftdataapiservice_describe_table: Describes the detailed information about a table from...
In paws.database: 'Amazon Web Services' Database Services

View source: R/redshiftdataapiservice_operations.R

redshiftdataapiservice_describe_table

R Documentation

Describes the detailed information about a table from metadata in the cluster

Description

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:

See https://www.paws-r-sdk.com/docs/redshiftdataapiservice_describe_table/ for full documentation.

Usage

redshiftdataapiservice_describe_table(
  ClusterIdentifier = NULL,
  ConnectedDatabase = NULL,
  Database,
  DbUser = NULL,
  MaxResults = NULL,
  NextToken = NULL,
  Schema = NULL,
  SecretArn = NULL,
  Table = NULL,
  WorkgroupName = NULL
)

Arguments

`ClusterIdentifier`	The cluster identifier. This parameter is required when connecting to a cluster and authenticating using either Secrets Manager or temporary credentials.
`ConnectedDatabase`	A database name. The connected database is specified when you connect with your authentication credentials.
`Database`	[required] 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.
`DbUser`	The database user name. This parameter is required when connecting to a cluster as a database user and authenticating using temporary credentials.
`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.
`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.
`Schema`	The schema that contains the table. If no schema is specified, then matching tables for all schemas are returned.
`SecretArn`	The name or ARN of the secret that enables access to the database. This parameter is required when authenticating using Secrets Manager.
`Table`	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
`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.