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

*********************
list_signing_profiles
*********************



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

  

  Lists all available signing profiles in your AWS account. Returns only profiles with an ``ACTIVE`` status unless the ``includeCanceled`` request field is set to ``true``. 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/ListSigningProfiles>`_  


  **Request Syntax**
  ::

    response = client.list_signing_profiles(
        includeCanceled=True|False,
        maxResults=123,
        nextToken='string',
        platformId='string',
        statuses=[
            'Active'|'Canceled'|'Revoked',
        ]
    )
    
  :type includeCanceled: boolean
  :param includeCanceled: 

    Designates whether to include profiles with the status of ``CANCELED``.

    

  
  :type maxResults: integer
  :param maxResults: 

    The maximum number of profiles to be returned.

    

  
  :type nextToken: string
  :param nextToken: 

    Value 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 platformId: string
  :param platformId: 

    Filters results to return only signing jobs initiated for a specified signing platform.

    

  
  :type statuses: list
  :param statuses: 

    Filters results to return only signing jobs with statuses in the specified list.

    

  
    - *(string) --* 

    

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

    
    ::

      {
          'profiles': [
              {
                  'profileName': 'string',
                  'profileVersion': 'string',
                  'profileVersionArn': 'string',
                  'signingMaterial': {
                      'certificateArn': 'string'
                  },
                  'signatureValidityPeriod': {
                      'value': 123,
                      'type': 'DAYS'|'MONTHS'|'YEARS'
                  },
                  'platformId': 'string',
                  'platformDisplayName': 'string',
                  'signingParameters': {
                      'string': 'string'
                  },
                  'status': 'Active'|'Canceled'|'Revoked',
                  'arn': 'string',
                  'tags': {
                      'string': 'string'
                  }
              },
          ],
          'nextToken': 'string'
      }
      
    **Response Structure**

    

    - *(dict) --* 
      

      - **profiles** *(list) --* 

        A list of profiles that are available in the AWS account. This includes profiles with the status of ``CANCELED`` if the ``includeCanceled`` parameter is set to ``true``.

        
        

        - *(dict) --* 

          Contains information about the ACM certificates and signing configuration parameters that can be used by a given code signing user.

          
          

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

            The name of the signing profile.

            
          

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

            The version of a signing profile.

            
          

          - **profileVersionArn** *(string) --* 

            The ARN of a signing profile, including the profile version.

            
          

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

            The ACM certificate that is available for use by a signing profile.

            
            

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

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

              
        
          

          - **signatureValidityPeriod** *(dict) --* 

            The validity period for a signing job created using this signing profile.

            
            

            - **value** *(integer) --* 

              The numerical value of the time unit for signature validity.

              
            

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

              The time unit for signature validity.

              
        
          

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

            The ID of a platform that is available for use by a signing profile.

            
          

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

            The name of the signing platform.

            
          

          - **signingParameters** *(dict) --* 

            The parameters that are available for use by a Signer user.

            
            

            - *(string) --* 
              

              - *(string) --* 
        
      
          

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

            The status of a signing profile.

            
          

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

            The Amazon Resource Name (ARN) for the signing profile.

            
          

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

            A list of tags associated with the signing profile.

            
            

            - *(string) --* 
              

              - *(string) --* 
        
      
      
    
      

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

        Value for specifying the next set of paginated results to return.

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

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

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

  