:doc:`signer <../../signer>` / Client / list_signing_jobs

*****************
list_signing_jobs
*****************



.. py:method:: signer.Client.list_signing_jobs(**kwargs)

  

  Lists all your signing jobs. You can use the ``maxResults`` parameter to limit the number of signing jobs that are returned in the response. If additional jobs remain to be listed, AWS Signer returns a ``nextToken`` value. Use this value in subsequent calls to ``ListSigningJobs`` to fetch the remaining values. You can continue calling ``ListSigningJobs`` with your ``maxResults`` parameter and with new values that Signer returns in the ``nextToken`` parameter until all of your signing jobs have been returned.

  

  See also: `AWS API Documentation <https://docs.aws.amazon.com/goto/WebAPI/signer-2017-08-25/ListSigningJobs>`_  


  **Request Syntax**
  ::

    response = client.list_signing_jobs(
        status='InProgress'|'Failed'|'Succeeded',
        platformId='string',
        requestedBy='string',
        maxResults=123,
        nextToken='string',
        isRevoked=True|False,
        signatureExpiresBefore=datetime(2015, 1, 1),
        signatureExpiresAfter=datetime(2015, 1, 1),
        jobInvoker='string'
    )
    
  :type status: string
  :param status: 

    A status value with which to filter your results.

    

  
  :type platformId: string
  :param platformId: 

    The ID of microcontroller platform that you specified for the distribution of your code image.

    

  
  :type requestedBy: string
  :param requestedBy: 

    The IAM principal that requested the signing job.

    

  
  :type maxResults: integer
  :param maxResults: 

    Specifies the maximum number of items to return in the response. Use this parameter when paginating results. If additional items exist beyond the number you specify, the ``nextToken`` element is set in the response. Use the ``nextToken`` value in a subsequent request to retrieve additional items.

    

  
  :type nextToken: string
  :param nextToken: 

    String for specifying the next set of paginated results to return. After you receive a response with truncated results, use this parameter in a subsequent request. Set it to the value of ``nextToken`` from the response that you just received.

    

  
  :type isRevoked: boolean
  :param isRevoked: 

    Filters results to return only signing jobs with revoked signatures.

    

  
  :type signatureExpiresBefore: datetime
  :param signatureExpiresBefore: 

    Filters results to return only signing jobs with signatures expiring before a specified timestamp.

    

  
  :type signatureExpiresAfter: datetime
  :param signatureExpiresAfter: 

    Filters results to return only signing jobs with signatures expiring after a specified timestamp.

    

  
  :type jobInvoker: string
  :param jobInvoker: 

    Filters results to return only signing jobs initiated by a specified IAM entity.

    

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

    
    ::

      {
          'jobs': [
              {
                  'jobId': 'string',
                  'source': {
                      's3': {
                          'bucketName': 'string',
                          'key': 'string',
                          'version': 'string'
                      }
                  },
                  'signedObject': {
                      's3': {
                          'bucketName': 'string',
                          'key': 'string'
                      }
                  },
                  'signingMaterial': {
                      'certificateArn': 'string'
                  },
                  'createdAt': datetime(2015, 1, 1),
                  'status': 'InProgress'|'Failed'|'Succeeded',
                  'isRevoked': True|False,
                  'profileName': 'string',
                  'profileVersion': 'string',
                  'platformId': 'string',
                  'platformDisplayName': 'string',
                  'signatureExpiresAt': datetime(2015, 1, 1),
                  'jobOwner': 'string',
                  'jobInvoker': 'string'
              },
          ],
          'nextToken': 'string'
      }
      
    **Response Structure**

    

    - *(dict) --* 
      

      - **jobs** *(list) --* 

        A list of your signing jobs.

        
        

        - *(dict) --* 

          Contains information about a signing job.

          
          

          - **jobId** *(string) --* 

            The ID of the signing job.

            
          

          - **source** *(dict) --* 

            A ``Source`` that contains information about a signing job's code image source.

            
            

            - **s3** *(dict) --* 

              The ``S3Source`` object.

              
              

              - **bucketName** *(string) --* 

                Name of the S3 bucket.

                
              

              - **key** *(string) --* 

                Key name of the bucket object that contains your unsigned code.

                
              

              - **version** *(string) --* 

                Version of your source image in your version enabled S3 bucket.

                
          
        
          

          - **signedObject** *(dict) --* 

            A ``SignedObject`` structure that contains information about a signing job's signed code image.

            
            

            - **s3** *(dict) --* 

              The ``S3SignedObject``.

              
              

              - **bucketName** *(string) --* 

                Name of the S3 bucket.

                
              

              - **key** *(string) --* 

                Key name that uniquely identifies a signed code image in your bucket.

                
          
        
          

          - **signingMaterial** *(dict) --* 

            A ``SigningMaterial`` object that contains the Amazon Resource Name (ARN) of the certificate used for the signing job.

            
            

            - **certificateArn** *(string) --* 

              The Amazon Resource Name (ARN) of the certificates that is used to sign your code.

              
        
          

          - **createdAt** *(datetime) --* 

            The date and time that the signing job was created.

            
          

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

            The status of the signing job.

            
          

          - **isRevoked** *(boolean) --* 

            Indicates whether the signing job is revoked.

            
          

          - **profileName** *(string) --* 

            The name of the signing profile that created a signing job.

            
          

          - **profileVersion** *(string) --* 

            The version of the signing profile that created a signing job.

            
          

          - **platformId** *(string) --* 

            The unique identifier for a signing platform.

            
          

          - **platformDisplayName** *(string) --* 

            The name of a signing platform.

            
          

          - **signatureExpiresAt** *(datetime) --* 

            The time when the signature of a signing job expires.

            
          

          - **jobOwner** *(string) --* 

            The AWS account ID of the job owner.

            
          

          - **jobInvoker** *(string) --* 

            The AWS account ID of the job invoker.

            
      
    
      

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

        String for specifying the next set of paginated results.

        
  
  **Exceptions**
  
  *   :py:class:`signer.Client.exceptions.ValidationException`

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

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

  
  *   :py:class:`signer.Client.exceptions.InternalServiceErrorException`

  