:doc:`mgn <../../mgn>` / Client / describe_jobs

*************
describe_jobs
*************



.. py:method:: mgn.Client.describe_jobs(**kwargs)

  

  Returns a list of Jobs. Use the JobsID and fromDate and toData filters to limit which jobs are returned. The response is sorted by creationDataTime - latest date first. Jobs are normally created by the StartTest, StartCutover, and TerminateTargetInstances APIs. Jobs are also created by DiagnosticLaunch and TerminateDiagnosticInstances, which are APIs available only to *Support* and only used in response to relevant support tickets.

  

  See also: `AWS API Documentation <https://docs.aws.amazon.com/goto/WebAPI/mgn-2020-02-26/DescribeJobs>`_  


  **Request Syntax**
  ::

    response = client.describe_jobs(
        filters={
            'jobIDs': [
                'string',
            ],
            'fromDate': 'string',
            'toDate': 'string'
        },
        maxResults=123,
        nextToken='string',
        accountID='string'
    )
    
  :type filters: dict
  :param filters: 

    Request to describe Job log filters.

    

  
    - **jobIDs** *(list) --* 

      Request to describe Job log filters by job ID.

      

    
      - *(string) --* 

      
  
    - **fromDate** *(string) --* 

      Request to describe Job log filters by date.

      

    
    - **toDate** *(string) --* 

      Request to describe job log items by last date.

      

    
  
  :type maxResults: integer
  :param maxResults: 

    Request to describe job log items by max results.

    

  
  :type nextToken: string
  :param nextToken: 

    Request to describe job log items by next token.

    

  
  :type accountID: string
  :param accountID: 

    Request to describe job log items by Account ID.

    

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

    
    ::

      {
          'items': [
              {
                  'jobID': 'string',
                  'arn': 'string',
                  'type': 'LAUNCH'|'TERMINATE',
                  'initiatedBy': 'START_TEST'|'START_CUTOVER'|'DIAGNOSTIC'|'TERMINATE',
                  'creationDateTime': 'string',
                  'endDateTime': 'string',
                  'status': 'PENDING'|'STARTED'|'COMPLETED',
                  'participatingServers': [
                      {
                          'sourceServerID': 'string',
                          'launchStatus': 'PENDING'|'IN_PROGRESS'|'LAUNCHED'|'FAILED'|'TERMINATED',
                          'launchedEc2InstanceID': 'string',
                          'postLaunchActionsStatus': {
                              'ssmAgentDiscoveryDatetime': 'string',
                              'postLaunchActionsLaunchStatusList': [
                                  {
                                      'ssmDocument': {
                                          'actionName': 'string',
                                          'ssmDocumentName': 'string',
                                          'timeoutSeconds': 123,
                                          'mustSucceedForCutover': True|False,
                                          'parameters': {
                                              'string': [
                                                  {
                                                      'parameterType': 'STRING'|'SECURE_STRING',
                                                      'parameterName': 'string'
                                                  },
                                              ]
                                          },
                                          'externalParameters': {
                                              'string': {
                                                  'dynamicPath': 'string'
                                              }
                                          }
                                      },
                                      'ssmDocumentType': 'AUTOMATION'|'COMMAND',
                                      'executionID': 'string',
                                      'executionStatus': 'IN_PROGRESS'|'SUCCESS'|'FAILED',
                                      'failureReason': 'string'
                                  },
                              ]
                          }
                      },
                  ],
                  'tags': {
                      'string': 'string'
                  }
              },
          ],
          'nextToken': 'string'
      }
      
    **Response Structure**

    

    - *(dict) --* 
      

      - **items** *(list) --* 

        Request to describe Job log items.

        
        

        - *(dict) --* 

          Job.

          
          

          - **jobID** *(string) --* 

            Job ID.

            
          

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

            the ARN of the specific Job.

            
          

          - **type** *(string) --* 

            Job type.

            
          

          - **initiatedBy** *(string) --* 

            Job initiated by field.

            
          

          - **creationDateTime** *(string) --* 

            Job creation time.

            
          

          - **endDateTime** *(string) --* 

            Job end time.

            
          

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

            Job status.

            
          

          - **participatingServers** *(list) --* 

            Servers participating in a specific Job.

            
            

            - *(dict) --* 

              Server participating in Job.

              
              

              - **sourceServerID** *(string) --* 

                Participating server Source Server ID.

                
              

              - **launchStatus** *(string) --* 

                Participating server launch status.

                
              

              - **launchedEc2InstanceID** *(string) --* 

                Participating server's launched ec2 instance ID.

                
              

              - **postLaunchActionsStatus** *(dict) --* 

                Participating server's Post Launch Actions Status.

                
                

                - **ssmAgentDiscoveryDatetime** *(string) --* 

                  Time where the AWS Systems Manager was detected as running on the Test or Cutover instance.

                  
                

                - **postLaunchActionsLaunchStatusList** *(list) --* 

                  List of Post Launch Action status.

                  
                  

                  - *(dict) --* 

                    Launch Status of the Job Post Launch Actions.

                    
                    

                    - **ssmDocument** *(dict) --* 

                      AWS Systems Manager's Document of the of the Job Post Launch Actions.

                      
                      

                      - **actionName** *(string) --* 

                        User-friendly name for the AWS Systems Manager Document.

                        
                      

                      - **ssmDocumentName** *(string) --* 

                        AWS Systems Manager Document name or full ARN.

                        
                      

                      - **timeoutSeconds** *(integer) --* 

                        AWS Systems Manager Document timeout seconds.

                        
                      

                      - **mustSucceedForCutover** *(boolean) --* 

                        If true, Cutover will not be enabled if the document has failed.

                        
                      

                      - **parameters** *(dict) --* 

                        AWS Systems Manager Document parameters.

                        
                        

                        - *(string) --* 
                          

                          - *(list) --* 
                            

                            - *(dict) --* 

                              AWS Systems Manager Parameter Store parameter.

                              
                              

                              - **parameterType** *(string) --* 

                                AWS Systems Manager Parameter Store parameter type.

                                
                              

                              - **parameterName** *(string) --* 

                                AWS Systems Manager Parameter Store parameter name.

                                
                          
                        
                    
                  
                      

                      - **externalParameters** *(dict) --* 

                        AWS Systems Manager Document external parameters.

                        
                        

                        - *(string) --* 
                          

                          - *(dict) --* 

                            AWS Systems Manager Document external parameter.

                            .. note::    This is a Tagged Union structure. Only one of the     following top level keys will be set: ``dynamicPath``.     If a client receives an unknown member it will     set ``SDK_UNKNOWN_MEMBER`` as the top level key,     which maps to the name or tag of the unknown     member. The structure of ``SDK_UNKNOWN_MEMBER`` is     as follows::

                                                        'SDK_UNKNOWN_MEMBER': {'name': 'UnknownMemberName'}


                          
                            

                            - **dynamicPath** *(string) --* 

                              AWS Systems Manager Document external parameters dynamic path.

                              
                        
                    
                  
                  
                    

                    - **ssmDocumentType** *(string) --* 

                      AWS Systems Manager Document type.

                      
                    

                    - **executionID** *(string) --* 

                      AWS Systems Manager Document's execution ID of the of the Job Post Launch Actions.

                      
                    

                    - **executionStatus** *(string) --* 

                      AWS Systems Manager Document's execution status.

                      
                    

                    - **failureReason** *(string) --* 

                      AWS Systems Manager Document's failure reason.

                      
                
              
            
          
        
          

          - **tags** *(dict) --* 

            Tags associated with specific Job.

            
            

            - *(string) --* 
              

              - *(string) --* 
        
      
      
    
      

      - **nextToken** *(string) --* 

        Request to describe Job response by next token.

        
  
  **Exceptions**
  
  *   :py:class:`mgn.Client.exceptions.UninitializedAccountException`

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

  