:doc:`AuditManager <../../auditmanager>` / Client / create_assessment_report

************************
create_assessment_report
************************



.. py:method:: AuditManager.Client.create_assessment_report(**kwargs)

  

  Creates an assessment report for the specified assessment.

  

  See also: `AWS API Documentation <https://docs.aws.amazon.com/goto/WebAPI/auditmanager-2017-07-25/CreateAssessmentReport>`_  


  **Request Syntax**
  ::

    response = client.create_assessment_report(
        name='string',
        description='string',
        assessmentId='string',
        queryStatement='string'
    )
    
  :type name: string
  :param name: **[REQUIRED]** 

    The name of the new assessment report.

    

  
  :type description: string
  :param description: 

    The description of the assessment report.

    

  
  :type assessmentId: string
  :param assessmentId: **[REQUIRED]** 

    The identifier for the assessment.

    

  
  :type queryStatement: string
  :param queryStatement: 

    A SQL statement that represents an evidence finder query.

     

    Provide this parameter when you want to generate an assessment report from the results of an evidence finder search query. When you use this parameter, Audit Manager generates a one-time report using only the evidence from the query output. This report does not include any assessment evidence that was manually `added to a report using the console <https://docs.aws.amazon.com/audit-manager/latest/userguide/generate-assessment-report.html#generate-assessment-report-include-evidence>`__, or `associated with a report using the API <https://docs.aws.amazon.com/audit-manager/latest/APIReference/API_BatchAssociateAssessmentReportEvidence.html>`__.

     

    To use this parameter, the `enablementStatus <https://docs.aws.amazon.com/audit-manager/latest/APIReference/API_EvidenceFinderEnablement.html#auditmanager-Type-EvidenceFinderEnablement-enablementStatus>`__ of evidence finder must be ``ENABLED``.

     

    For examples and help resolving ``queryStatement`` validation exceptions, see `Troubleshooting evidence finder issues <https://docs.aws.amazon.com/audit-manager/latest/userguide/evidence-finder-issues.html#querystatement-exceptions>`__ in the *Audit Manager User Guide.*

    

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

    
    ::

      {
          'assessmentReport': {
              'id': 'string',
              'name': 'string',
              'description': 'string',
              'awsAccountId': 'string',
              'assessmentId': 'string',
              'assessmentName': 'string',
              'author': 'string',
              'status': 'COMPLETE'|'IN_PROGRESS'|'FAILED',
              'creationTime': datetime(2015, 1, 1)
          }
      }
      
    **Response Structure**

    

    - *(dict) --* 
      

      - **assessmentReport** *(dict) --* 

        The new assessment report that the ``CreateAssessmentReport`` API returned.

        
        

        - **id** *(string) --* 

          The unique identifier for the assessment report.

          
        

        - **name** *(string) --* 

          The name that's given to the assessment report.

          
        

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

          The description of the specified assessment report.

          
        

        - **awsAccountId** *(string) --* 

          The identifier for the specified Amazon Web Services account.

          
        

        - **assessmentId** *(string) --* 

          The identifier for the specified assessment.

          
        

        - **assessmentName** *(string) --* 

          The name of the associated assessment.

          
        

        - **author** *(string) --* 

          The name of the user who created the assessment report.

          
        

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

          The current status of the specified assessment report.

          
        

        - **creationTime** *(datetime) --* 

          Specifies when the assessment report was created.

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

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

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

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

  