AuditManager / Client / update_assessment_control

update_assessment_control#

AuditManager.Client.update_assessment_control(**kwargs)#

Updates a control within an assessment in Audit Manager.

See also: AWS API Documentation

Request Syntax

response = client.update_assessment_control(
    assessmentId='string',
    controlSetId='string',
    controlId='string',
    controlStatus='UNDER_REVIEW'|'REVIEWED'|'INACTIVE',
    commentBody='string'
)
Parameters:

  • assessmentId (string) –

    [REQUIRED]

    The unique identifier for the assessment.

  • controlSetId (string) –

    [REQUIRED]

    The unique identifier for the control set.

  • controlId (string) –

    [REQUIRED]

    The unique identifier for the control.

  • controlStatus (string) – The status of the control.

  • commentBody (string) – The comment body text for the control.

Return type:

dict

Returns:

Response Syntax

{
    'control': {
        '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
    }
}

Response Structure

  • (dict) –

    • control (dict) –

      The name of the updated control set that the UpdateAssessmentControl API returned.

      • 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.

Exceptions