:doc:`RedshiftServerless <../../redshift-serverless>` / Client / list_namespaces

***************
list_namespaces
***************



.. py:method:: RedshiftServerless.Client.list_namespaces(**kwargs)

  

  Returns information about a list of specified namespaces.

  

  See also: `AWS API Documentation <https://docs.aws.amazon.com/goto/WebAPI/redshift-serverless-2021-04-21/ListNamespaces>`_  


  **Request Syntax**
  ::

    response = client.list_namespaces(
        maxResults=123,
        nextToken='string'
    )
    
  :type maxResults: integer
  :param maxResults: 

    An optional parameter that specifies the maximum number of results to return. You can use ``nextToken`` to display the next page of results.

    

  
  :type nextToken: string
  :param nextToken: 

    If your initial ``ListNamespaces`` operation returns a ``nextToken``, you can include the returned ``nextToken`` in following ``ListNamespaces`` operations, which returns results in the next page.

    

  
  
  :rtype: dict
  :returns: 
    
    **Response Syntax**

    
    ::

      {
          'namespaces': [
              {
                  'adminPasswordSecretArn': 'string',
                  'adminPasswordSecretKmsKeyId': 'string',
                  'adminUsername': 'string',
                  'catalogArn': 'string',
                  'creationDate': datetime(2015, 1, 1),
                  'dbName': 'string',
                  'defaultIamRoleArn': 'string',
                  'iamRoles': [
                      'string',
                  ],
                  'kmsKeyId': 'string',
                  'lakehouseRegistrationStatus': '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.

            
          

          - **catalogArn** *(string) --* 

            The Amazon Resource Name (ARN) of the Glue Data Catalog associated with the namespace enabled with Amazon Redshift federated permissions.

            
          

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

            
          

          - **lakehouseRegistrationStatus** *(string) --* 

            The status of the lakehouse registration for the namespace. Indicates whether the namespace is successfully registered with Amazon Redshift federated permissions.

            
          

          - **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 <https://docs.aws.amazon.com/redshift/latest/dg/r_pg_keywords.html>`__ in the Amazon Redshift Database Developer Guide.

            
          

          - **status** *(string) --* 

            The status of the namespace.

            
      
    
      

      - **nextToken** *(string) --* 

        When ``nextToken`` is returned, there are more results available. The value of ``nextToken`` is a unique pagination token for each page. Make the call again using the returned token to retrieve the next page.

        
  
  **Exceptions**
  
  *   :py:class:`RedshiftServerless.Client.exceptions.InternalServerException`

  
  *   :py:class:`RedshiftServerless.Client.exceptions.ValidationException`

  