RedshiftServerless / Paginator / ListNamespaces

ListNamespaces#

class RedshiftServerless.Paginator.ListNamespaces#
paginator = client.get_paginator('list_namespaces')
paginate(**kwargs)#

Creates an iterator that will paginate through responses from RedshiftServerless.Client.list_namespaces().

See also: AWS API Documentation

Request Syntax

response_iterator = paginator.paginate(
    PaginationConfig={
        'MaxItems': 123,
        'PageSize': 123,
        'StartingToken': 'string'
    }
)
Parameters:

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

{
    'namespaces': [
        {
            'adminPasswordSecretArn': 'string',
            'adminPasswordSecretKmsKeyId': 'string',
            'adminUsername': 'string',
            'creationDate': datetime(2015, 1, 1),
            'dbName': 'string',
            'defaultIamRoleArn': 'string',
            'iamRoles': [
                'string',
            ],
            'kmsKeyId': 'string',
            'logExports': [
                'useractivitylog'|'userlog'|'connectionlog',
            ],
            'namespaceArn': 'string',
            'namespaceId': 'string',
            'namespaceName': 'string',
            'status': 'AVAILABLE'|'MODIFYING'|'DELETING'
        },
    ],
    'NextToken': 'string'
}

Response Structure

  • (dict) –

    • namespaces (list) –

      The list of returned namespaces.

      • (dict) –

        A collection of database objects and users.

        • adminPasswordSecretArn (string) –

          The Amazon Resource Name (ARN) for the namespace’s admin user credentials secret.

        • adminPasswordSecretKmsKeyId (string) –

          The ID of the Key Management Service (KMS) key used to encrypt and store the namespace’s admin credentials secret.

        • adminUsername (string) –

          The username of the administrator for the first database created in the namespace.

        • creationDate (datetime) –

          The date of when the namespace was created.

        • dbName (string) –

          The name of the first database created in the namespace.

        • defaultIamRoleArn (string) –

          The Amazon Resource Name (ARN) of the IAM role to set as a default in the namespace.

        • iamRoles (list) –

          A list of IAM roles to associate with the namespace.

          • (string) –

        • kmsKeyId (string) –

          The ID of the Amazon Web Services Key Management Service key used to encrypt your data.

        • logExports (list) –

          The types of logs the namespace can export. Available export types are User log, Connection log, and User activity log.

          • (string) –

        • namespaceArn (string) –

          The Amazon Resource Name (ARN) associated with a namespace.

        • namespaceId (string) –

          The unique identifier of a namespace.

        • namespaceName (string) –

          The name of the namespace. Must be between 3-64 alphanumeric characters in lowercase, and it cannot be a reserved word. A list of reserved words can be found in Reserved Words in the Amazon Redshift Database Developer Guide.

        • status (string) –

          The status of the namespace.

    • NextToken (string) –

      A token to resume pagination.