RedshiftDataAPIService / Client / list_schemas

list_schemas#

RedshiftDataAPIService.Client.list_schemas(**kwargs)#

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:

  • 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.

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.

See also: AWS API Documentation

Request Syntax

response = client.list_schemas(
    ClusterIdentifier='string',
    ConnectedDatabase='string',
    Database='string',
    DbUser='string',
    MaxResults=123,
    NextToken='string',
    SchemaPattern='string',
    SecretArn='string',
    WorkgroupName='string'
)
Parameters:

  • ClusterIdentifier (string) – The cluster identifier. This parameter is required when connecting to a cluster and authenticating using either Secrets Manager or temporary credentials.

  • ConnectedDatabase (string) – A database name. The connected database is specified when you connect with your authentication credentials.

  • Database (string) –

    [REQUIRED]

    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.

  • DbUser (string) – The database user name. This parameter is required when connecting to a cluster and authenticating using temporary credentials.

  • MaxResults (integer) – 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.

  • NextToken (string) – 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 (string) – 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.

  • SecretArn (string) – The name or ARN of the secret that enables access to the database. This parameter is required when authenticating using Secrets Manager.

  • WorkgroupName (string) – 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.

Return type:

dict

Returns:

Response Syntax

{
    'NextToken': 'string',
    'Schemas': [
        'string',
    ]
}

Response Structure

  • (dict) –

    • NextToken (string) –

      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.

    • Schemas (list) –

      The schemas that match the request pattern.

      • (string) –

Exceptions

  • RedshiftDataAPIService.Client.exceptions.ValidationException

  • RedshiftDataAPIService.Client.exceptions.InternalServerException

  • RedshiftDataAPIService.Client.exceptions.DatabaseConnectionException