:doc:`NeptuneGraph <../../neptune-graph>` / Client / list_graph_snapshots

********************
list_graph_snapshots
********************



.. py:method:: NeptuneGraph.Client.list_graph_snapshots(**kwargs)

  

  Lists available snapshots of a specified Neptune Analytics graph.

  

  See also: `AWS API Documentation <https://docs.aws.amazon.com/goto/WebAPI/neptune-graph-2023-11-29/ListGraphSnapshots>`_  


  **Request Syntax**
  ::

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

    The unique identifier of the Neptune Analytics graph.

    

  
  :type nextToken: string
  :param nextToken: 

    Pagination token used to paginate output.

     

    When this value is provided as input, the service returns results from where the previous response left off. When this value is present in output, it indicates that there are more results to retrieve.

    

  
  :type maxResults: integer
  :param maxResults: 

    The total number of records to return in the command's output.

     

    If the total number of records available is more than the value specified, ``nextToken`` is provided in the command's output. To resume pagination, provide the ``nextToken`` output value in the ``nextToken`` argument of a subsequent command. Do not use the ``nextToken`` response element directly outside of the Amazon CLI.

    

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

    
    ::

      {
          'graphSnapshots': [
              {
                  'id': 'string',
                  'name': 'string',
                  'arn': 'string',
                  'sourceGraphId': 'string',
                  'snapshotCreateTime': datetime(2015, 1, 1),
                  'status': 'CREATING'|'AVAILABLE'|'DELETING'|'FAILED',
                  'kmsKeyIdentifier': 'string'
              },
          ],
          'nextToken': 'string'
      }
      
    **Response Structure**

    

    - *(dict) --* 
      

      - **graphSnapshots** *(list) --* 

        The requested list of snapshots.

        
        

        - *(dict) --* 

          Details about a graph snapshot.

          
          

          - **id** *(string) --* 

            The unique identifier of the graph snapshot.

            
          

          - **name** *(string) --* 

            The snapshot name. For example: ``my-snapshot-1``.

             

            The name must contain from 1 to 63 letters, numbers, or hyphens, and its first character must be a letter. It cannot end with a hyphen or contain two consecutive hyphens. Only lowercase letters are allowed.

            
          

          - **arn** *(string) --* 

            The ARN of the graph snapshot.

            
          

          - **sourceGraphId** *(string) --* 

            The graph identifier for the graph for which a snapshot is to be created.

            
          

          - **snapshotCreateTime** *(datetime) --* 

            The time when the snapshot was created.

            
          

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

            The status of the graph snapshot.

            
          

          - **kmsKeyIdentifier** *(string) --* 

            The ID of the KMS key used to encrypt and decrypt the snapshot.

            
      
    
      

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

        Pagination token used to paginate output.

         

        When this value is provided as input, the service returns results from where the previous response left off. When this value is present in output, it indicates that there are more results to retrieve.

        
  
  **Exceptions**
  
  *   :py:class:`NeptuneGraph.Client.exceptions.ThrottlingException`

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

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

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

  