:doc:`FraudDetector <../../frauddetector>` / Client / describe_detector

*****************
describe_detector
*****************



.. py:method:: FraudDetector.Client.describe_detector(**kwargs)

  

  Gets all versions for a specified detector.

  

  See also: `AWS API Documentation <https://docs.aws.amazon.com/goto/WebAPI/frauddetector-2019-11-15/DescribeDetector>`_  


  **Request Syntax**
  ::

    response = client.describe_detector(
        detectorId='string',
        nextToken='string',
        maxResults=123
    )
    
  :type detectorId: string
  :param detectorId: **[REQUIRED]** 

    The detector ID.

    

  
  :type nextToken: string
  :param nextToken: 

    The next token from the previous response.

    

  
  :type maxResults: integer
  :param maxResults: 

    The maximum number of results to return for the request.

    

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

    
    ::

      {
          'detectorId': 'string',
          'detectorVersionSummaries': [
              {
                  'detectorVersionId': 'string',
                  'status': 'DRAFT'|'ACTIVE'|'INACTIVE',
                  'description': 'string',
                  'lastUpdatedTime': 'string'
              },
          ],
          'nextToken': 'string',
          'arn': 'string'
      }
      
    **Response Structure**

    

    - *(dict) --* 
      

      - **detectorId** *(string) --* 

        The detector ID.

        
      

      - **detectorVersionSummaries** *(list) --* 

        The status and description for each detector version.

        
        

        - *(dict) --* 

          The summary of the detector version.

          
          

          - **detectorVersionId** *(string) --* 

            The detector version ID.

            
          

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

            The detector version status.

            
          

          - **description** *(string) --* 

            The detector version description.

            
          

          - **lastUpdatedTime** *(string) --* 

            Timestamp of when the detector version was last updated.

            
      
    
      

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

        The next token to be used for subsequent requests.

        
      

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

        The detector ARN.

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

  
  *   :py:class:`FraudDetector.Client.exceptions.ResourceNotFoundException`

  
  *   :py:class:`FraudDetector.Client.exceptions.InternalServerException`

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

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

  