:doc:`IAM <../../iam>` / Client / generate_credential_report

**************************
generate_credential_report
**************************



.. py:method:: IAM.Client.generate_credential_report()

  

  Generates a credential report for the Amazon Web Services account. For more information about the credential report, see `Getting credential reports <https://docs.aws.amazon.com/IAM/latest/UserGuide/credential-reports.html>`__ in the *IAM User Guide*.

  

  See also: `AWS API Documentation <https://docs.aws.amazon.com/goto/WebAPI/iam-2010-05-08/GenerateCredentialReport>`_  


  **Request Syntax**

  ::

    response = client.generate_credential_report()
  :rtype: dict
  :returns: 
    
    **Response Syntax**

    
    ::

      {
          'State': 'STARTED'|'INPROGRESS'|'COMPLETE',
          'Description': 'string'
      }
      
    **Response Structure**

    

    - *(dict) --* 

      Contains the response to a successful `GenerateCredentialReport <https://docs.aws.amazon.com/IAM/latest/APIReference/API_GenerateCredentialReport.html>`__ request.

      
      

      - **State** *(string) --* 

        Information about the state of the credential report.

        
      

      - **Description** *(string) --* 

        Information about the credential report.

        
  
  **Exceptions**
  
  *   :py:class:`IAM.Client.exceptions.LimitExceededException`

  
  *   :py:class:`IAM.Client.exceptions.ServiceFailureException`

  