ListSchemas - Amazon Redshift Data API
Services or capabilities described in Amazon Web Services documentation might vary by Region. To see the differences applicable to the China Regions, see Getting Started with Amazon Web Services in China.

ListSchemas

Lists the schemas in a database. A token is returned to page through the schema list. Depending on the authorization method, use one of the following combinations of request parameters:

  • Amazon Secrets Manager - when connecting to a cluster, specify the Amazon Resource Name (ARN) of the secret, the database name, and the cluster identifier that matches the cluster in the secret. When connecting to a serverless workgroup, specify the Amazon Resource Name (ARN) of the secret and the database name.

  • Temporary credentials - when connecting to a cluster, specify the cluster identifier, the database name, and the database user name. Also, permission to call the redshift:GetClusterCredentials operation is required. When connecting to a serverless workgroup, specify the workgroup name and database name. Also, permission to call the redshift-serverless:GetCredentials operation is required.

Request Syntax

{ "ClusterIdentifier": "string", "ConnectedDatabase": "string", "Database": "string", "DbUser": "string", "MaxResults": number, "NextToken": "string", "SchemaPattern": "string", "SecretArn": "string", "WorkgroupName": "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.

Database

The name of the database that contains the schemas to list. If ConnectedDatabase is not specified, this is also the database to connect to with your authentication credentials.

Type: String

Required: Yes

ClusterIdentifier

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

Type: String

Required: No

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 connecting to a cluster and authenticating using temporary credentials.

Type: String

Required: No

MaxResults

The maximum number of schemas to return in the response. If more schemas 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

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.

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 Amazon Secrets Manager.

Type: String

Required: No

WorkgroupName

The serverless workgroup name. This parameter is required when connecting to a serverless workgroup and authenticating using either Amazon Secrets Manager or temporary credentials.

Type: String

Length Constraints: Minimum length of 3. Maximum length of 64.

Pattern: ^[a-z0-9-]+$

Required: No

Response Syntax

{ "NextToken": "string", "Schemas": [ "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.

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

Schemas

The schemas that match the request pattern.

Type: Array of strings

Errors

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

DatabaseConnectionException

Connection to a database failed.

HTTP Status Code: 500

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 Amazon SDKs, see the following: