ListSchemas

class RedshiftDataAPIService.Paginator.ListSchemas

paginator = client.get_paginator('list_schemas')

paginate(**kwargs)

Creates an iterator that will paginate through responses from RedshiftDataAPIService.Client.list_schemas().

See also: AWS API Documentation

Request Syntax

response_iterator = paginator.paginate(
    ClusterIdentifier='string',
    ConnectedDatabase='string',
    Database='string',
    DbUser='string',
    SchemaPattern='string',
    SecretArn='string',
    WorkgroupName='string',
    PaginationConfig={
        'MaxItems': 123,
        'PageSize': 123,
        'StartingToken': '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.
• 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.
• PaginationConfig (dict) --

  A dictionary that provides parameters to control pagination.

  • MaxItems (integer) --

    The total number of items to return. If the total number of items available is more than the value specified in max-items then a NextToken will be provided in the output that you can use to resume pagination.

  • PageSize (integer) --

    The size of each page.

  • StartingToken (string) --

    A token to specify where to start paginating. This is the NextToken from a previous response.

Return type

dict

Returns

Response Syntax

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

Response Structure

• (dict) --

  • Schemas (list) --

    The schemas that match the request pattern.

    • (string) --