:doc:`signer <../../signer>` / Paginator / ListSigningJobs

***************
ListSigningJobs
***************



.. py:class:: signer.Paginator.ListSigningJobs

  ::

    
    paginator = client.get_paginator('list_signing_jobs')

  
  

  .. py:method:: paginate(**kwargs)

    Creates an iterator that will paginate through responses from :py:meth:`signer.Client.list_signing_jobs`.

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


    **Request Syntax**
    ::

      response_iterator = paginator.paginate(
          status='InProgress'|'Failed'|'Succeeded',
          platformId='string',
          requestedBy='string',
          isRevoked=True|False,
          signatureExpiresBefore=datetime(2015, 1, 1),
          signatureExpiresAfter=datetime(2015, 1, 1),
          jobInvoker='string',
          PaginationConfig={
              'MaxItems': 123,
              'PageSize': 123,
              'StartingToken': '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 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.

      

    
    :type PaginationConfig: dict
    :param PaginationConfig: 

      A dictionary that provides parameters to control pagination.

      

    
      - **MaxItems** *(integer) --* 

        The total number of items to return. If the total number of items available is more than the value specified in max-items then a ``NextToken`` will be provided in the output that you can use to resume pagination.

        

      
      - **PageSize** *(integer) --* 

        The size of each page.

        

      
      - **StartingToken** *(string) --* 

        A token to specify where to start paginating. This is the ``NextToken`` from a previous response.

        

      
    
    
    :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) --* 

          A token to resume pagination.

          
    