:doc:`ElastiCache <../../elasticache>` / Client / describe_serverless_cache_snapshots

***********************************
describe_serverless_cache_snapshots
***********************************



.. py:method:: ElastiCache.Client.describe_serverless_cache_snapshots(**kwargs)

  

  Returns information about serverless cache snapshots. By default, this API lists all of the customer’s serverless cache snapshots. It can also describe a single serverless cache snapshot, or the snapshots associated with a particular serverless cache. Available for Valkey, Redis OSS and Serverless Memcached only.

  

  See also: `AWS API Documentation <https://docs.aws.amazon.com/goto/WebAPI/elasticache-2015-02-02/DescribeServerlessCacheSnapshots>`_  


  **Request Syntax**
  ::

    response = client.describe_serverless_cache_snapshots(
        ServerlessCacheName='string',
        ServerlessCacheSnapshotName='string',
        SnapshotType='string',
        NextToken='string',
        MaxResults=123
    )
    
  :type ServerlessCacheName: string
  :param ServerlessCacheName: 

    The identifier of serverless cache. If this parameter is specified, only snapshots associated with that specific serverless cache are described. Available for Valkey, Redis OSS and Serverless Memcached only.

    

  
  :type ServerlessCacheSnapshotName: string
  :param ServerlessCacheSnapshotName: 

    The identifier of the serverless cache’s snapshot. If this parameter is specified, only this snapshot is described. Available for Valkey, Redis OSS and Serverless Memcached only.

    

  
  :type SnapshotType: string
  :param SnapshotType: 

    The type of snapshot that is being described. Available for Valkey, Redis OSS and Serverless Memcached only.

    

  
  :type NextToken: string
  :param NextToken: 

    An optional marker returned from a prior request to support pagination of results from this operation. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by max-results. Available for Valkey, Redis OSS and Serverless Memcached only.

    

  
  :type MaxResults: integer
  :param MaxResults: 

    The maximum number of records to include in the response. If more records exist than the specified max-results value, a market is included in the response so that remaining results can be retrieved. Available for Valkey, Redis OSS and Serverless Memcached only.The default is 50. The Validation Constraints are a maximum of 50.

    

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

    
    ::

      {
          'NextToken': 'string',
          'ServerlessCacheSnapshots': [
              {
                  'ServerlessCacheSnapshotName': 'string',
                  'ARN': 'string',
                  'KmsKeyId': 'string',
                  'SnapshotType': 'string',
                  'Status': 'string',
                  'CreateTime': datetime(2015, 1, 1),
                  'ExpiryTime': datetime(2015, 1, 1),
                  'BytesUsedForCache': 'string',
                  'ServerlessCacheConfiguration': {
                      'ServerlessCacheName': 'string',
                      'Engine': 'string',
                      'MajorEngineVersion': 'string'
                  }
              },
          ]
      }
      
    **Response Structure**

    

    - *(dict) --* 
      

      - **NextToken** *(string) --* 

        An optional marker returned from a prior request to support pagination of results from this operation. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by max-results. Available for Valkey, Redis OSS and Serverless Memcached only.

        
      

      - **ServerlessCacheSnapshots** *(list) --* 

        The serverless caches snapshots associated with a given description request. Available for Valkey, Redis OSS and Serverless Memcached only.

        
        

        - *(dict) --* 

          The resource representing a serverless cache snapshot. Available for Valkey, Redis OSS and Serverless Memcached only.

          
          

          - **ServerlessCacheSnapshotName** *(string) --* 

            The identifier of a serverless cache snapshot. Available for Valkey, Redis OSS and Serverless Memcached only.

            
          

          - **ARN** *(string) --* 

            The Amazon Resource Name (ARN) of a serverless cache snapshot. Available for Valkey, Redis OSS and Serverless Memcached only.

            
          

          - **KmsKeyId** *(string) --* 

            The ID of the Amazon Web Services Key Management Service (KMS) key of a serverless cache snapshot. Available for Valkey, Redis OSS and Serverless Memcached only.

            
          

          - **SnapshotType** *(string) --* 

            The type of snapshot of serverless cache. Available for Valkey, Redis OSS and Serverless Memcached only.

            
          

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

            The current status of the serverless cache. Available for Valkey, Redis OSS and Serverless Memcached only.

            
          

          - **CreateTime** *(datetime) --* 

            The date and time that the source serverless cache's metadata and cache data set was obtained for the snapshot. Available for Valkey, Redis OSS and Serverless Memcached only.

            
          

          - **ExpiryTime** *(datetime) --* 

            The time that the serverless cache snapshot will expire. Available for Valkey, Redis OSS and Serverless Memcached only.

            
          

          - **BytesUsedForCache** *(string) --* 

            The total size of a serverless cache snapshot, in bytes. Available for Valkey, Redis OSS and Serverless Memcached only.

            
          

          - **ServerlessCacheConfiguration** *(dict) --* 

            The configuration of the serverless cache, at the time the snapshot was taken. Available for Valkey, Redis OSS and Serverless Memcached only.

            
            

            - **ServerlessCacheName** *(string) --* 

              The identifier of a serverless cache.

              
            

            - **Engine** *(string) --* 

              The engine that the serverless cache is configured with.

              
            

            - **MajorEngineVersion** *(string) --* 

              The engine version number that the serverless cache is configured with.

              
        
      
    
  
  **Exceptions**
  
  *   :py:class:`ElastiCache.Client.exceptions.ServerlessCacheNotFoundFault`

  
  *   :py:class:`ElastiCache.Client.exceptions.ServerlessCacheSnapshotNotFoundFault`

  
  *   :py:class:`ElastiCache.Client.exceptions.InvalidParameterValueException`

  
  *   :py:class:`ElastiCache.Client.exceptions.InvalidParameterCombinationException`

  