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

************
get_keyspace
************



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

  

  Returns the name of the specified keyspace, the Amazon Resource Name (ARN), the replication strategy, the Amazon Web Services Regions of a multi-Region keyspace, and the status of newly added Regions after an ``UpdateKeyspace`` operation.

  

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


  **Request Syntax**
  ::

    response = client.get_keyspace(
        keyspaceName='string'
    )
    
  :type keyspaceName: string
  :param keyspaceName: **[REQUIRED]** 

    The name of the keyspace.

    

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

    
    ::

      {
          'keyspaceName': 'string',
          'resourceArn': 'string',
          'replicationStrategy': 'SINGLE_REGION'|'MULTI_REGION',
          'replicationRegions': [
              'string',
          ],
          'replicationGroupStatuses': [
              {
                  'region': 'string',
                  'keyspaceStatus': 'ACTIVE'|'CREATING'|'UPDATING'|'DELETING',
                  'tablesReplicationProgress': 'string'
              },
          ]
      }
      
    **Response Structure**

    

    - *(dict) --* 
      

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

        The name of the keyspace.

        
      

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

        Returns the ARN of the keyspace.

        
      

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

        Returns the replication strategy of the keyspace. The options 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) --* 
    
      

      - **replicationGroupStatuses** *(list) --* 

        A list of all Regions the keyspace is replicated in after the update keyspace operation and their status.

        
        

        - *(dict) --* 

          This shows the summary status of the keyspace after a new Amazon Web Services Region was added.

          
          

          - **region** *(string) --* 

            The name of the Region that was added to the keyspace.

            
          

          - **keyspaceStatus** *(string) --* 

            The status of the keyspace.

            
          

          - **tablesReplicationProgress** *(string) --* 

            This shows the replication progress of tables in the keyspace. The value is expressed as a percentage of the newly replicated tables with status ``Active`` compared to the total number of tables in the keyspace.

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

  