DescribeTable - Redshift Data API Service

DescribeTable

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:

  • AWS Secrets Manager - specify the Amazon Resource Name (ARN) of the secret and the cluster identifier that matches the cluster in the secret.

  • Temporary credentials - specify the cluster identifier, the database name, and the database user name. Permission to call the redshift:GetClusterCredentials operation is required to use this method.

Request Syntax

{ "ClusterIdentifier": "string", "ConnectedDatabase": "string", "Database": "string", "DbUser": "string", "MaxResults": number, "NextToken": "string", "Schema": "string", "SecretArn": "string", "Table": "string" }

Request Parameters

For information about the parameters that are common to all actions, see Common Parameters.

The request accepts the following data in JSON format.

Note

In the following list, the required parameters are described first.

ClusterIdentifier

The cluster identifier. This parameter is required when authenticating using either AWS Secrets Manager or temporary credentials.

Type: String

Required: Yes

Database

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.

Type: String

Required: Yes

ConnectedDatabase

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

Type: String

Required: No

DbUser

The database user name. This parameter is required when authenticating using temporary credentials.

Type: String

Required: No

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.

Type: Integer

Valid Range: Minimum value of 0. Maximum value of 1000.

Required: No

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.

Type: String

Required: No

Schema

The schema that contains the table. If no schema is specified, then matching tables for all schemas are returned.

Type: String

Required: No

SecretArn

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

Type: String

Required: No

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

Type: String

Required: No

Response Syntax

{ "ColumnList": [ { "columnDefault": "string", "isCaseSensitive": boolean, "isCurrency": boolean, "isSigned": boolean, "label": "string", "length": number, "name": "string", "nullable": number, "precision": number, "scale": number, "schemaName": "string", "tableName": "string", "typeName": "string" } ], "NextToken": "string", "TableName": "string" }

Response Elements

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

ColumnList

A list of columns in the table.

Type: Array of ColumnMetadata objects

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.

Type: String

TableName

The table name.

Type: String

Errors

For information about the errors that are common to all actions, see Common Errors.

InternalServerException

The Amazon Redshift Data API operation failed due to invalid input.

HTTP Status Code: 500

ValidationException

The Amazon Redshift Data API operation failed due to invalid input.

HTTP Status Code: 400

See Also

For more information about using this API in one of the language-specific AWS SDKs, see the following: