:doc:`AmplifyBackend <../../amplifybackend>` / Client / list_backend_jobs

*****************
list_backend_jobs
*****************



.. py:method:: AmplifyBackend.Client.list_backend_jobs(**kwargs)

  

  Lists the jobs for the backend of an Amplify app.

  

  See also: `AWS API Documentation <https://docs.aws.amazon.com/goto/WebAPI/amplifybackend-2020-08-11/ListBackendJobs>`_  


  **Request Syntax**
  ::

    response = client.list_backend_jobs(
        AppId='string',
        BackendEnvironmentName='string',
        JobId='string',
        MaxResults=123,
        NextToken='string',
        Operation='string',
        Status='string'
    )
    
  :type AppId: string
  :param AppId: **[REQUIRED]** 

    The app ID.

    

  
  :type BackendEnvironmentName: string
  :param BackendEnvironmentName: **[REQUIRED]** 

    The name of the backend environment.

    

  
  :type JobId: string
  :param JobId: 

    The ID for the job.

    

  
  :type MaxResults: integer
  :param MaxResults: 

    The maximum number of results that you want in the response.

    

  
  :type NextToken: string
  :param NextToken: 

    The token for the next set of results.

    

  
  :type Operation: string
  :param Operation: 

    Filters the list of response objects to include only those with the specified operation name.

    

  
  :type Status: string
  :param Status: 

    Filters the list of response objects to include only those with the specified status.

    

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

    
    ::

      {
          'Jobs': [
              {
                  'AppId': 'string',
                  'BackendEnvironmentName': 'string',
                  'CreateTime': 'string',
                  'Error': 'string',
                  'JobId': 'string',
                  'Operation': 'string',
                  'Status': 'string',
                  'UpdateTime': 'string'
              },
          ],
          'NextToken': 'string'
      }
      
    **Response Structure**

    

    - *(dict) --* 

      200 response

      
      

      - **Jobs** *(list) --* 

        An array of jobs and their properties.

        
        

        - *(dict) --* 

          The response object for this operation.

          
          

          - **AppId** *(string) --* 

            The app ID.

            
          

          - **BackendEnvironmentName** *(string) --* 

            The name of the backend environment.

            
          

          - **CreateTime** *(string) --* 

            The time when the job was created.

            
          

          - **Error** *(string) --* 

            If the request fails, this error is returned.

            
          

          - **JobId** *(string) --* 

            The ID for the job.

            
          

          - **Operation** *(string) --* 

            The name of the operation.

            
          

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

            The current status of the request.

            
          

          - **UpdateTime** *(string) --* 

            The time when the job was last updated.

            
      
    
      

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

        The token for the next set of results.

        
  
  **Exceptions**
  
  *   :py:class:`AmplifyBackend.Client.exceptions.NotFoundException`

  
  *   :py:class:`AmplifyBackend.Client.exceptions.GatewayTimeoutException`

  
  *   :py:class:`AmplifyBackend.Client.exceptions.TooManyRequestsException`

  
  *   :py:class:`AmplifyBackend.Client.exceptions.BadRequestException`

  