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

*******************
get_signing_profile
*******************



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

  

  Returns information on a specific signing profile.

  

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


  **Request Syntax**
  ::

    response = client.get_signing_profile(
        profileName='string',
        profileOwner='string'
    )
    
  :type profileName: string
  :param profileName: **[REQUIRED]** 

    The name of the target signing profile.

    

  
  :type profileOwner: string
  :param profileOwner: 

    The AWS account ID of the profile owner.

    

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

    
    ::

      {
          'profileName': 'string',
          'profileVersion': 'string',
          'profileVersionArn': 'string',
          'revocationRecord': {
              'revocationEffectiveFrom': datetime(2015, 1, 1),
              'revokedAt': datetime(2015, 1, 1),
              'revokedBy': 'string'
          },
          'signingMaterial': {
              'certificateArn': 'string'
          },
          'platformId': 'string',
          'platformDisplayName': 'string',
          'signatureValidityPeriod': {
              'value': 123,
              'type': 'DAYS'|'MONTHS'|'YEARS'
          },
          'overrides': {
              'signingConfiguration': {
                  'encryptionAlgorithm': 'RSA'|'ECDSA',
                  'hashAlgorithm': 'SHA1'|'SHA256'
              },
              'signingImageFormat': 'JSON'|'JSONEmbedded'|'JSONDetached'
          },
          'signingParameters': {
              'string': 'string'
          },
          'status': 'Active'|'Canceled'|'Revoked',
          'statusReason': 'string',
          'arn': 'string',
          'tags': {
              'string': 'string'
          }
      }
      
    **Response Structure**

    

    - *(dict) --* 
      

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

        The name of the target signing profile.

        
      

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

        The current version of the signing profile.

        
      

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

        The signing profile ARN, including the profile version.

        
      

      - **revocationRecord** *(dict) --* 

        Revocation information for a signing profile.

        
        

        - **revocationEffectiveFrom** *(datetime) --* 

          The time when revocation becomes effective.

          
        

        - **revokedAt** *(datetime) --* 

          The time when the signing profile was revoked.

          
        

        - **revokedBy** *(string) --* 

          The identity of the revoker.

          
    
      

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

        The ARN of the certificate that the target profile uses for signing operations.

        
        

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

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

          
    
      

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

        The ID of the platform that is used by the target signing profile.

        
      

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

        A human-readable name for the signing platform associated with the signing profile.

        
      

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

        The validity period for a signing job.

        
        

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

          The numerical value of the time unit for signature validity.

          
        

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

          The time unit for signature validity.

          
    
      

      - **overrides** *(dict) --* 

        A list of overrides applied by the target signing profile for signing operations.

        
        

        - **signingConfiguration** *(dict) --* 

          A signing configuration that overrides the default encryption or hash algorithm of a signing job.

          
          

          - **encryptionAlgorithm** *(string) --* 

            A specified override of the default encryption algorithm that is used in a code-signing job.

            
          

          - **hashAlgorithm** *(string) --* 

            A specified override of the default hash algorithm that is used in a code-signing job.

            
      
        

        - **signingImageFormat** *(string) --* 

          A signed image is a JSON object. When overriding the default signing platform configuration, a customer can select either of two signing formats, ``JSONEmbedded`` or ``JSONDetached``. (A third format value, ``JSON``, is reserved for future use.) With ``JSONEmbedded``, the signing image has the payload embedded in it. With ``JSONDetached``, the payload is not be embedded in the signing image.

          
    
      

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

        A map of key-value pairs for signing operations that is attached to the target signing profile.

        
        

        - *(string) --* 
          

          - *(string) --* 
    
  
      

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

        The status of the target signing profile.

        
      

      - **statusReason** *(string) --* 

        Reason for the status of the target 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) --* 
    
  
  
  **Exceptions**
  
  *   :py:class:`signer.Client.exceptions.ResourceNotFoundException`

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

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

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

  