:doc:`PartnerCentralSellingAPI <../../partnercentral-selling>` / Client / list_resource_snapshot_jobs

***************************
list_resource_snapshot_jobs
***************************



.. py:method:: PartnerCentralSellingAPI.Client.list_resource_snapshot_jobs(**kwargs)

  

  Lists resource snapshot jobs owned by the customer. This operation supports various filtering scenarios, including listing all jobs owned by the caller, jobs for a specific engagement, jobs with a specific status, or any combination of these filters.

  

  See also: `AWS API Documentation <https://docs.aws.amazon.com/goto/WebAPI/partnercentral-selling-2022-07-26/ListResourceSnapshotJobs>`_  


  **Request Syntax**
  ::

    response = client.list_resource_snapshot_jobs(
        Catalog='string',
        MaxResults=123,
        NextToken='string',
        EngagementIdentifier='string',
        Status='Running'|'Stopped',
        Sort={
            'SortBy': 'CreatedDate',
            'SortOrder': 'ASCENDING'|'DESCENDING'
        }
    )
    
  :type Catalog: string
  :param Catalog: **[REQUIRED]** 

    Specifies the catalog related to the request.

    

  
  :type MaxResults: integer
  :param MaxResults: 

    The maximum number of results to return in a single call. If omitted, defaults to 50.

    

  
  :type NextToken: string
  :param NextToken: 

    The token for the next set of results.

    

  
  :type EngagementIdentifier: string
  :param EngagementIdentifier: 

    The identifier of the engagement to filter the response.

    

  
  :type Status: string
  :param Status: 

    The status of the jobs to filter the response.

    

  
  :type Sort: dict
  :param Sort: 

    Configures the sorting of the response. If omitted, results are sorted by ``CreatedDate`` in descending order.

    

  
    - **SortBy** *(string) --* 

      Specifies the field by which to sort the resource snapshot jobs.

      

    
    - **SortOrder** *(string) --* 

      Determines the order in which the sorted results are presented.

      

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

    
    ::

      {
          'ResourceSnapshotJobSummaries': [
              {
                  'Id': 'string',
                  'Arn': 'string',
                  'EngagementId': 'string',
                  'Status': 'Running'|'Stopped'
              },
          ],
          'NextToken': 'string'
      }
      
    **Response Structure**

    

    - *(dict) --* 
      

      - **ResourceSnapshotJobSummaries** *(list) --* 

        An array of resource snapshot job summary objects.

        
        

        - *(dict) --* 

          An object that contains a ``Resource Snapshot Job``'s subset of fields.

          
          

          - **Id** *(string) --* 

            The unique identifier for the resource snapshot job within the AWS Partner Central system. This ID is used for direct references to the job within the service.

            
          

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

            The Amazon Resource Name (ARN) for the resource snapshot job.

            
          

          - **EngagementId** *(string) --* 

            The unique identifier of the Engagement.

            
          

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

            The current status of the snapshot job.

             

            Valid values:

             

            
            * STOPPED: The job is not currently running.
             
            * RUNNING: The job is actively executing.
            

            
      
    
      

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

        The token to retrieve the next set of results. If there are no additional results, this value is null.

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

  
  *   :py:class:`PartnerCentralSellingAPI.Client.exceptions.AccessDeniedException`

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

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

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

  