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

***************
get_export_task
***************



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

  

  Retrieves a specified export task.

  

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


  **Request Syntax**
  ::

    response = client.get_export_task(
        taskIdentifier='string'
    )
    
  :type taskIdentifier: string
  :param taskIdentifier: **[REQUIRED]** 

    The unique identifier of the export task.

    

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

    
    ::

      {
          'graphId': 'string',
          'roleArn': 'string',
          'taskId': 'string',
          'status': 'INITIALIZING'|'EXPORTING'|'SUCCEEDED'|'FAILED'|'CANCELLING'|'CANCELLED'|'DELETED',
          'format': 'PARQUET'|'CSV',
          'destination': 'string',
          'kmsKeyIdentifier': 'string',
          'parquetType': 'COLUMNAR',
          'statusReason': 'string',
          'exportTaskDetails': {
              'startTime': datetime(2015, 1, 1),
              'timeElapsedSeconds': 123,
              'progressPercentage': 123,
              'numVerticesWritten': 123,
              'numEdgesWritten': 123
          },
          'exportFilter': {
              'vertexFilter': {
                  'string': {
                      'properties': {
                          'string': {
                              'outputType': 'string',
                              'sourcePropertyName': 'string',
                              'multiValueHandling': 'TO_LIST'|'PICK_FIRST'
                          }
                      }
                  }
              },
              'edgeFilter': {
                  'string': {
                      'properties': {
                          'string': {
                              'outputType': 'string',
                              'sourcePropertyName': 'string',
                              'multiValueHandling': 'TO_LIST'|'PICK_FIRST'
                          }
                      }
                  }
              }
          }
      }
      
    **Response Structure**

    

    - *(dict) --* 
      

      - **graphId** *(string) --* 

        The source graph identifier of the export task.

        
      

      - **roleArn** *(string) --* 

        The ARN of the IAM role that will allow data to be exported to the destination.

        
      

      - **taskId** *(string) --* 

        The unique identifier of the export task.

        
      

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

        The current status of the export task.

        
      

      - **format** *(string) --* 

        The format of the export task.

        
      

      - **destination** *(string) --* 

        The Amazon S3 URI of the export task where data will be exported.

        
      

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

        The KMS key identifier of the export task.

        
      

      - **parquetType** *(string) --* 

        The parquet type of the export task.

        
      

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

        The reason that the export task has this status value.

        
      

      - **exportTaskDetails** *(dict) --* 

        The details of the export task.

        
        

        - **startTime** *(datetime) --* 

          The start time of the export task.

          
        

        - **timeElapsedSeconds** *(integer) --* 

          The time elapsed, in seconds, since the start time of the export task.

          
        

        - **progressPercentage** *(integer) --* 

          The number of progress percentage of the export task.

          
        

        - **numVerticesWritten** *(integer) --* 

          The number of exported vertices.

          
        

        - **numEdgesWritten** *(integer) --* 

          The number of exported edges.

          
    
      

      - **exportFilter** *(dict) --* 

        The export filter of the export task.

        
        

        - **vertexFilter** *(dict) --* 

          Used to specify filters on a per-label basis for vertices. This allows you to control which vertex labels and properties are included in the export.

          
          

          - *(string) --* 
            

            - *(dict) --* 

              Specifies which properties of that label should be included in the export.

              
              

              - **properties** *(dict) --* 

                Each property is defined by a key-value pair, where the key is the desired output property name (e.g. "name"), and the value is an object.

                
                

                - *(string) --* 
                  

                  - *(dict) --* 

                    A structure representing a property's attributes. It is a map object of outputType, sourcePropertyName and multiValueHandling.

                    
                    

                    - **outputType** *(string) --* 

                      Specifies the data type to use for the property in the exported data (e.g. "String", "Int", "Float"). If a type is not provided, the export process will determine the type. If a given property is present as multiple types (e.g. one vertex has "height" stored as a double, and another edge has it stored as a string), the type will be of Any type, otherwise, it will be the type of the property as present in vertices.

                      
                    

                    - **sourcePropertyName** *(string) --* 

                      The name of the property as it exists in the original graph data. If not provided, it is assumed that the key matches the desired sourcePropertyName.

                      
                    

                    - **multiValueHandling** *(string) --* 

                      Specifies how to handle properties that have multiple values. Can be either ``TO_LIST`` to export all values as a list, or ``PICK_FIRST`` to export the first value encountered. If not specified, the default value is ``PICK_FIRST``.

                      
                
            
          
          
      
    
        

        - **edgeFilter** *(dict) --* 

          Used to specify filters on a per-label basis for edges. This allows you to control which edge labels and properties are included in the export.

          
          

          - *(string) --* 
            

            - *(dict) --* 

              Specifies which properties of that label should be included in the export.

              
              

              - **properties** *(dict) --* 

                Each property is defined by a key-value pair, where the key is the desired output property name (e.g. "name"), and the value is an object.

                
                

                - *(string) --* 
                  

                  - *(dict) --* 

                    A structure representing a property's attributes. It is a map object of outputType, sourcePropertyName and multiValueHandling.

                    
                    

                    - **outputType** *(string) --* 

                      Specifies the data type to use for the property in the exported data (e.g. "String", "Int", "Float"). If a type is not provided, the export process will determine the type. If a given property is present as multiple types (e.g. one vertex has "height" stored as a double, and another edge has it stored as a string), the type will be of Any type, otherwise, it will be the type of the property as present in vertices.

                      
                    

                    - **sourcePropertyName** *(string) --* 

                      The name of the property as it exists in the original graph data. If not provided, it is assumed that the key matches the desired sourcePropertyName.

                      
                    

                    - **multiValueHandling** *(string) --* 

                      Specifies how to handle properties that have multiple values. Can be either ``TO_LIST`` to export all values as a list, or ``PICK_FIRST`` to export the first value encountered. If not specified, the default value is ``PICK_FIRST``.

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

  