RedshiftDataAPIService / Paginator / ListDatabases
ListDatabases#
- class RedshiftDataAPIService.Paginator.ListDatabases#
paginator = client.get_paginator('list_databases')
- paginate(**kwargs)#
Creates an iterator that will paginate through responses from
RedshiftDataAPIService.Client.list_databases()
.See also: AWS API Documentation
Request Syntax
response_iterator = paginator.paginate( ClusterIdentifier='string', Database='string', DbUser='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.
Database (string) –
[REQUIRED]
The name of the database. This parameter is required when authenticating using either Secrets Manager or temporary credentials.
DbUser (string) – The database user name. This parameter is required when connecting to a cluster as a database user and authenticating using temporary credentials.
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
{ 'Databases': [ 'string', ], }
Response Structure
(dict) –
Databases (list) –
The names of databases.
(string) –