:doc:`CloudFrontKeyValueStore <../../cloudfront-keyvaluestore>` / Client / describe_key_value_store

************************
describe_key_value_store
************************



.. py:method:: CloudFrontKeyValueStore.Client.describe_key_value_store(**kwargs)

  

  Returns metadata information about Key Value Store.

  

  See also: `AWS API Documentation <https://docs.aws.amazon.com/goto/WebAPI/cloudfront-keyvaluestore-2022-07-26/DescribeKeyValueStore>`_  


  **Request Syntax**
  ::

    response = client.describe_key_value_store(
        KvsARN='string'
    )
    
  :type KvsARN: string
  :param KvsARN: **[REQUIRED]** 

    The Amazon Resource Name (ARN) of the Key Value Store.

    

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

    
    ::

      {
          'ItemCount': 123,
          'TotalSizeInBytes': 123,
          'KvsARN': 'string',
          'Created': datetime(2015, 1, 1),
          'ETag': 'string',
          'LastModified': datetime(2015, 1, 1),
          'Status': 'string',
          'FailureReason': 'string'
      }
      
    **Response Structure**

    

    - *(dict) --* 

      Metadata information about a Key Value Store.

      
      

      - **ItemCount** *(integer) --* 

        Number of key value pairs in the Key Value Store.

        
      

      - **TotalSizeInBytes** *(integer) --* 

        Total size of the Key Value Store in bytes.

        
      

      - **KvsARN** *(string) --* 

        The Amazon Resource Name (ARN) of the Key Value Store.

        
      

      - **Created** *(datetime) --* 

        Date and time when the Key Value Store was created.

        
      

      - **ETag** *(string) --* 

        The version identifier for the current version of the Key Value Store.

        
      

      - **LastModified** *(datetime) --* 

        Date and time when the key value pairs in the Key Value Store was last modified.

        
      

      - **Status** *(string) --* 

        The current status of the Key Value Store.

        
      

      - **FailureReason** *(string) --* 

        The reason for Key Value Store creation failure.

        
  
  **Exceptions**
  
  *   :py:class:`CloudFrontKeyValueStore.Client.exceptions.ConflictException`

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

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

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

  