:doc:`Keyspaces <../../keyspaces>` / Client / list_keyspaces

**************
list_keyspaces
**************



.. py:method:: Keyspaces.Client.list_keyspaces(**kwargs)

  

  The ``ListKeyspaces`` operation returns a list of keyspaces.

  

  See also: `AWS API Documentation <https://docs.aws.amazon.com/goto/WebAPI/keyspaces-2022-02-10/ListKeyspaces>`_  


  **Request Syntax**
  ::

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

    The pagination token. To resume pagination, provide the ``NextToken`` value as argument of a subsequent API invocation.

    

  
  :type maxResults: integer
  :param maxResults: 

    The total number of keyspaces to return in the output. If the total number of keyspaces available is more than the value specified, a ``NextToken`` is provided in the output. To resume pagination, provide the ``NextToken`` value as an argument of a subsequent API invocation.

    

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

    
    ::

      {
          'nextToken': 'string',
          'keyspaces': [
              {
                  'keyspaceName': 'string',
                  'resourceArn': 'string',
                  'replicationStrategy': 'SINGLE_REGION'|'MULTI_REGION',
                  'replicationRegions': [
                      'string',
                  ]
              },
          ]
      }
      
    **Response Structure**

    

    - *(dict) --* 
      

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

        A token to specify where to start paginating. This is the ``NextToken`` from a previously truncated response.

        
      

      - **keyspaces** *(list) --* 

        A list of keyspaces.

        
        

        - *(dict) --* 

          Represents the properties of a keyspace.

          
          

          - **keyspaceName** *(string) --* 

            The name of the keyspace.

            
          

          - **resourceArn** *(string) --* 

            The unique identifier of the keyspace in the format of an Amazon Resource Name (ARN).

            
          

          - **replicationStrategy** *(string) --* 

            This property specifies if a keyspace is a single Region keyspace or a multi-Region keyspace. The available values are ``SINGLE_REGION`` or ``MULTI_REGION``.

            
          

          - **replicationRegions** *(list) --* 

            If the ``replicationStrategy`` of the keyspace is ``MULTI_REGION``, a list of replication Regions is returned.

            
            

            - *(string) --* 
        
      
    
  
  **Exceptions**
  
  *   :py:class:`Keyspaces.Client.exceptions.ValidationException`

  
  *   :py:class:`Keyspaces.Client.exceptions.ServiceQuotaExceededException`

  
  *   :py:class:`Keyspaces.Client.exceptions.InternalServerException`

  
  *   :py:class:`Keyspaces.Client.exceptions.AccessDeniedException`

  
  *   :py:class:`Keyspaces.Client.exceptions.ResourceNotFoundException`

  