DescribeTableRequest

AnalyticsBig DataCloudData LakeData WarehouseETLMachine LearningServerlessSQL

Properties

Name	Type	Description
ClusterIdentifier	string	The cluster identifier
Database	string	The name of the database
DbUser	string	The database user for temporary credentials
SecretArn	string	ARN of the secret in Secrets Manager
WorkgroupName	string	The serverless workgroup name
Table	string	The table name. Can be qualified with schema name as schema_name.table_name.
Schema	string	The schema that contains the table. Default is public.
MaxResults	integer	Maximum number of columns to return
NextToken	string	Pagination token for the next page

View JSON Schema on GitHub

JSON Schema

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "title": "DescribeTableRequest",
  "type": "object",
  "properties": {
    "ClusterIdentifier": {
      "type": "string",
      "description": "The cluster identifier"
    },
    "Database": {
      "type": "string",
      "description": "The name of the database"
    },
    "DbUser": {
      "type": "string",
      "description": "The database user for temporary credentials"
    },
    "SecretArn": {
      "type": "string",
      "description": "ARN of the secret in Secrets Manager"
    },
    "WorkgroupName": {
      "type": "string",
      "description": "The serverless workgroup name"
    },
    "Table": {
      "type": "string",
      "description": "The table name. Can be qualified with schema name as schema_name.table_name."
    },
    "Schema": {
      "type": "string",
      "description": "The schema that contains the table. Default is public."
    },
    "MaxResults": {
      "type": "integer",
      "description": "Maximum number of columns to return"
    },
    "NextToken": {
      "type": "string",
      "description": "Pagination token for the next page"
    }
  }
}