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

************************************
update_assessment_control_set_status
************************************



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

  

  Updates the status of a control set in an Audit Manager assessment.

  

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


  **Request Syntax**
  ::

    response = client.update_assessment_control_set_status(
        assessmentId='string',
        controlSetId='string',
        status='ACTIVE'|'UNDER_REVIEW'|'REVIEWED',
        comment='string'
    )
    
  :type assessmentId: string
  :param assessmentId: **[REQUIRED]** 

    The unique identifier for the assessment.

    

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

    The unique identifier for the control set.

    

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

    The status of the control set that's being updated.

    

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

    The comment that's related to the status update.

    

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

    
    ::

      {
          'controlSet': {
              'id': 'string',
              'description': 'string',
              'status': 'ACTIVE'|'UNDER_REVIEW'|'REVIEWED',
              'roles': [
                  {
                      'roleType': 'PROCESS_OWNER'|'RESOURCE_OWNER',
                      'roleArn': 'string'
                  },
              ],
              'controls': [
                  {
                      'id': 'string',
                      'name': 'string',
                      'description': 'string',
                      'status': 'UNDER_REVIEW'|'REVIEWED'|'INACTIVE',
                      'response': 'MANUAL'|'AUTOMATE'|'DEFER'|'IGNORE',
                      'comments': [
                          {
                              'authorName': 'string',
                              'commentBody': 'string',
                              'postedDate': datetime(2015, 1, 1)
                          },
                      ],
                      'evidenceSources': [
                          'string',
                      ],
                      'evidenceCount': 123,
                      'assessmentReportEvidenceCount': 123
                  },
              ],
              'delegations': [
                  {
                      'id': 'string',
                      'assessmentName': 'string',
                      'assessmentId': 'string',
                      'status': 'IN_PROGRESS'|'UNDER_REVIEW'|'COMPLETE',
                      'roleArn': 'string',
                      'roleType': 'PROCESS_OWNER'|'RESOURCE_OWNER',
                      'creationTime': datetime(2015, 1, 1),
                      'lastUpdated': datetime(2015, 1, 1),
                      'controlSetId': 'string',
                      'comment': 'string',
                      'createdBy': 'string'
                  },
              ],
              'systemEvidenceCount': 123,
              'manualEvidenceCount': 123
          }
      }
      
    **Response Structure**

    

    - *(dict) --* 
      

      - **controlSet** *(dict) --* 

        The name of the updated control set that the ``UpdateAssessmentControlSetStatus`` API returned.

        
        

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

          The identifier of the control set in the assessment. This is the control set name in a plain string format.

          
        

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

          The description for the control set.

          
        

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

          The current status of the control set.

          
        

        - **roles** *(list) --* 

          The roles that are associated with the control set.

          
          

          - *(dict) --* 

            The wrapper that contains the Audit Manager role information of the current user. This includes the role type and IAM Amazon Resource Name (ARN).

            
            

            - **roleType** *(string) --* 

              The type of customer persona.

               

              .. note::

                

                In ``CreateAssessment``, ``roleType`` can only be ``PROCESS_OWNER``.

                 

                In ``UpdateSettings``, ``roleType`` can only be ``PROCESS_OWNER``.

                 

                In ``BatchCreateDelegationByAssessment``, ``roleType`` can only be ``RESOURCE_OWNER``.

                

              
            

            - **roleArn** *(string) --* 

              The Amazon Resource Name (ARN) of the IAM role.

              
        
      
        

        - **controls** *(list) --* 

          The list of controls that's contained with the control set.

          
          

          - *(dict) --* 

            The control entity that represents a standard control or a custom control in an Audit Manager assessment.

            
            

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

              The identifier for the control.

              
            

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

              The name of the control.

              
            

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

              The description of the control.

              
            

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

              The status of the control.

              
            

            - **response** *(string) --* 

              The response of the control.

              
            

            - **comments** *(list) --* 

              The list of comments that's attached to the control.

              
              

              - *(dict) --* 

                A comment that's posted by a user on a control. This includes the author's name, the comment text, and a timestamp.

                
                

                - **authorName** *(string) --* 

                  The name of the user who authored the comment.

                  
                

                - **commentBody** *(string) --* 

                  The body text of a control comment.

                  
                

                - **postedDate** *(datetime) --* 

                  The time when the comment was posted.

                  
            
          
            

            - **evidenceSources** *(list) --* 

              The list of data sources for the evidence.

              
              

              - *(string) --* 
          
            

            - **evidenceCount** *(integer) --* 

              The amount of evidence that's collected for the control.

              
            

            - **assessmentReportEvidenceCount** *(integer) --* 

              The amount of evidence in the assessment report.

              
        
      
        

        - **delegations** *(list) --* 

          The delegations that are associated with the control set.

          
          

          - *(dict) --* 

            The assignment of a control set to a delegate for review.

            
            

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

              The unique identifier for the delegation.

              
            

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

              The name of the assessment that's associated with the delegation.

              
            

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

              The identifier for the assessment that's associated with the delegation.

              
            

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

              The status of the delegation.

              
            

            - **roleArn** *(string) --* 

              The Amazon Resource Name (ARN) of the IAM role.

              
            

            - **roleType** *(string) --* 

              The type of customer persona.

               

              .. note::

                

                In ``CreateAssessment``, ``roleType`` can only be ``PROCESS_OWNER``.

                 

                In ``UpdateSettings``, ``roleType`` can only be ``PROCESS_OWNER``.

                 

                In ``BatchCreateDelegationByAssessment``, ``roleType`` can only be ``RESOURCE_OWNER``.

                

              
            

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

              Specifies when the delegation was created.

              
            

            - **lastUpdated** *(datetime) --* 

              Specifies when the delegation was last updated.

              
            

            - **controlSetId** *(string) --* 

              The identifier for the control set that's associated with the delegation.

              
            

            - **comment** *(string) --* 

              The comment that's related to the delegation.

              
            

            - **createdBy** *(string) --* 

              The user or role that created the delegation.

              
        
      
        

        - **systemEvidenceCount** *(integer) --* 

          The total number of evidence objects that are retrieved automatically for the control set.

          
        

        - **manualEvidenceCount** *(integer) --* 

          The total number of evidence objects that are uploaded manually to the control set.

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

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

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

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

  