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

***********
reset_graph
***********



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

  

  Empties the data from a specified Neptune Analytics graph.

  

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


  **Request Syntax**
  ::

    response = client.reset_graph(
        graphIdentifier='string',
        skipSnapshot=True|False
    )
    
  :type graphIdentifier: string
  :param graphIdentifier: **[REQUIRED]** 

    ID of the graph to reset.

    

  
  :type skipSnapshot: boolean
  :param skipSnapshot: **[REQUIRED]** 

    Determines whether a final graph snapshot is created before the graph data is deleted. If set to ``true``, no graph snapshot is created. If set to ``false``, a graph snapshot is created before the data is deleted.

    

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

    
    ::

      {
          'id': 'string',
          'name': 'string',
          'arn': 'string',
          'status': 'CREATING'|'AVAILABLE'|'DELETING'|'RESETTING'|'UPDATING'|'SNAPSHOTTING'|'FAILED'|'IMPORTING'|'STARTING'|'STOPPING'|'STOPPED',
          'statusReason': 'string',
          'createTime': datetime(2015, 1, 1),
          'provisionedMemory': 123,
          'endpoint': 'string',
          'publicConnectivity': True|False,
          'vectorSearchConfiguration': {
              'dimension': 123
          },
          'replicaCount': 123,
          'kmsKeyIdentifier': 'string',
          'sourceSnapshotId': 'string',
          'deletionProtection': True|False,
          'buildNumber': 'string'
      }
      
    **Response Structure**

    

    - *(dict) --* 
      

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

        The unique identifier of the graph.

        
      

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

        The name of the graph.

        
      

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

        The ARN associated with the graph.

        
      

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

        The status of the graph.

        
      

      - **statusReason** *(string) --* 

        The reason that the graph has this status.

        
      

      - **createTime** *(datetime) --* 

        The time at which the graph was created.

        
      

      - **provisionedMemory** *(integer) --* 

        The number of memory-optimized Neptune Capacity Units (m-NCUs) allocated to the graph.

        
      

      - **endpoint** *(string) --* 

        The graph endpoint.

        
      

      - **publicConnectivity** *(boolean) --* 

        If ``true``, the graph has a public endpoint, otherwise not.

        
      

      - **vectorSearchConfiguration** *(dict) --* 

        Specifies the number of dimensions for vector embeddings loaded into the graph. Max = 65535

        
        

        - **dimension** *(integer) --* 

          The number of dimensions.

          
    
      

      - **replicaCount** *(integer) --* 

        The number of replicas for the graph.

        
      

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

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

        
      

      - **sourceSnapshotId** *(string) --* 

        The ID of the snapshot from which the graph was created, if any.

        
      

      - **deletionProtection** *(boolean) --* 

        If ``true``, deletion protection is enabled for the graph.

        
      

      - **buildNumber** *(string) --* 

        The build number of the graph.

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

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

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

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

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

  