:doc:`SageMakergeospatialcapabilities <../../sagemaker-geospatial>` / Client / list_vector_enrichment_jobs

***************************
list_vector_enrichment_jobs
***************************



.. py:method:: SageMakergeospatialcapabilities.Client.list_vector_enrichment_jobs(**kwargs)

  

  Retrieves a list of vector enrichment jobs.

  

  See also: `AWS API Documentation <https://docs.aws.amazon.com/goto/WebAPI/sagemaker-geospatial-2020-05-27/ListVectorEnrichmentJobs>`_  


  **Request Syntax**
  ::

    response = client.list_vector_enrichment_jobs(
        MaxResults=123,
        NextToken='string',
        SortBy='string',
        SortOrder='ASCENDING'|'DESCENDING',
        StatusEquals='string'
    )
    
  :type MaxResults: integer
  :param MaxResults: 

    The maximum number of items to return.

    

  
  :type NextToken: string
  :param NextToken: 

    If the previous response was truncated, you receive this token. Use it in your next request to receive the next set of results.

    

  
  :type SortBy: string
  :param SortBy: 

    The parameter by which to sort the results.

    

  
  :type SortOrder: string
  :param SortOrder: 

    An optional value that specifies whether you want the results sorted in ``Ascending`` or ``Descending`` order.

    

  
  :type StatusEquals: string
  :param StatusEquals: 

    A filter that retrieves only jobs with a specific status.

    

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

    
    ::

      {
          'NextToken': 'string',
          'VectorEnrichmentJobSummaries': [
              {
                  'Arn': 'string',
                  'CreationTime': datetime(2015, 1, 1),
                  'DurationInSeconds': 123,
                  'Name': 'string',
                  'Status': 'INITIALIZING'|'IN_PROGRESS'|'STOPPING'|'STOPPED'|'COMPLETED'|'FAILED'|'DELETING'|'DELETED',
                  'Tags': {
                      'string': 'string'
                  },
                  'Type': 'REVERSE_GEOCODING'|'MAP_MATCHING'
              },
          ]
      }
      
    **Response Structure**

    

    - *(dict) --* 
      

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

        If the previous response was truncated, you receive this token. Use it in your next request to receive the next set of results.

        
      

      - **VectorEnrichmentJobSummaries** *(list) --* 

        Contains summary information about the Vector Enrichment jobs.

        
        

        - *(dict) --* 

          An object containing information about the output file.

          
          

          - **Arn** *(string) --* 

            The Amazon Resource Name (ARN) of the list of the Vector Enrichment jobs.

            
          

          - **CreationTime** *(datetime) --* 

            The creation time.

            
          

          - **DurationInSeconds** *(integer) --* 

            The duration of the session, in seconds.

            
          

          - **Name** *(string) --* 

            The names of the Vector Enrichment jobs in the list.

            
          

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

            The status of the Vector Enrichment jobs list.

            
          

          - **Tags** *(dict) --* 

            Each tag consists of a key and a value.

            
            

            - *(string) --* 
              

              - *(string) --* 
        
      
          

          - **Type** *(string) --* 

            The type of the list of Vector Enrichment jobs.

            
      
    
  
  **Exceptions**
  
  *   :py:class:`SageMakergeospatialcapabilities.Client.exceptions.AccessDeniedException`

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

  
  *   :py:class:`SageMakergeospatialcapabilities.Client.exceptions.ThrottlingException`

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

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

  