:doc:`IoT <../../iot>` / Client / describe_authorizer

*******************
describe_authorizer
*******************



.. py:method:: IoT.Client.describe_authorizer(**kwargs)

  

  Describes an authorizer.

   

  Requires permission to access the `DescribeAuthorizer <https://docs.aws.amazon.com/service-authorization/latest/reference/list_awsiot.html#awsiot-actions-as-permissions>`__ action.

  

  See also: `AWS API Documentation <https://docs.aws.amazon.com/goto/WebAPI/iot-2015-05-28/DescribeAuthorizer>`_  


  **Request Syntax**
  ::

    response = client.describe_authorizer(
        authorizerName='string'
    )
    
  :type authorizerName: string
  :param authorizerName: **[REQUIRED]** 

    The name of the authorizer to describe.

    

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

    
    ::

      {
          'authorizerDescription': {
              'authorizerName': 'string',
              'authorizerArn': 'string',
              'authorizerFunctionArn': 'string',
              'tokenKeyName': 'string',
              'tokenSigningPublicKeys': {
                  'string': 'string'
              },
              'status': 'ACTIVE'|'INACTIVE',
              'creationDate': datetime(2015, 1, 1),
              'lastModifiedDate': datetime(2015, 1, 1),
              'signingDisabled': True|False,
              'enableCachingForHttp': True|False
          }
      }
      
    **Response Structure**

    

    - *(dict) --* 
      

      - **authorizerDescription** *(dict) --* 

        The authorizer description.

        
        

        - **authorizerName** *(string) --* 

          The authorizer name.

          
        

        - **authorizerArn** *(string) --* 

          The authorizer ARN.

          
        

        - **authorizerFunctionArn** *(string) --* 

          The authorizer's Lambda function ARN.

          
        

        - **tokenKeyName** *(string) --* 

          The key used to extract the token from the HTTP headers.

          
        

        - **tokenSigningPublicKeys** *(dict) --* 

          The public keys used to validate the token signature returned by your custom authentication service.

          
          

          - *(string) --* 
            

            - *(string) --* 
      
    
        

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

          The status of the authorizer.

          
        

        - **creationDate** *(datetime) --* 

          The UNIX timestamp of when the authorizer was created.

          
        

        - **lastModifiedDate** *(datetime) --* 

          The UNIX timestamp of when the authorizer was last updated.

          
        

        - **signingDisabled** *(boolean) --* 

          Specifies whether IoT validates the token signature in an authorization request.

          
        

        - **enableCachingForHttp** *(boolean) --* 

          When ``true``, the result from the authorizer’s Lambda function is cached for the time specified in ``refreshAfterInSeconds``. The cached result is used while the device reuses the same HTTP connection.

          
    
  
  **Exceptions**
  
  *   :py:class:`IoT.Client.exceptions.ResourceNotFoundException`

  
  *   :py:class:`IoT.Client.exceptions.InvalidRequestException`

  
  *   :py:class:`IoT.Client.exceptions.ThrottlingException`

  
  *   :py:class:`IoT.Client.exceptions.UnauthorizedException`

  
  *   :py:class:`IoT.Client.exceptions.ServiceUnavailableException`

  
  *   :py:class:`IoT.Client.exceptions.InternalFailureException`

  