[ aws . auditmanager ]

update-assessment-control

Description

Updates a control within an assessment in Audit Manager.

See also: AWS API Documentation

See ‘aws help’ for descriptions of global parameters.

Synopsis

  update-assessment-control
--assessment-id <value>
--control-set-id <value>
--control-id <value>
[--control-status <value>]
[--comment-body <value>]
[--cli-input-json | --cli-input-yaml]
[--generate-cli-skeleton <value>]

Options

--assessment-id (string)

The unique identifier for the assessment.

--control-set-id (string)

The unique identifier for the control set.

--control-id (string)

The unique identifier for the control.

--control-status (string)

The status of the control.

Possible values:

  • UNDER_REVIEW

  • REVIEWED

  • INACTIVE

--comment-body (string)

The comment body text for the control.

--cli-input-json | --cli-input-yaml (string) Reads arguments from the JSON string provided. The JSON string follows the format provided by --generate-cli-skeleton. If other arguments are provided on the command line, those values will override the JSON-provided values. It is not possible to pass arbitrary binary values using a JSON-provided value as the string will be taken literally. This may not be specified along with --cli-input-yaml.

--generate-cli-skeleton (string) Prints a JSON skeleton to standard output without sending an API request. If provided with no value or the value input, prints a sample input JSON that can be used as an argument for --cli-input-json. Similarly, if provided yaml-input it will print a sample input YAML that can be used with --cli-input-yaml. If provided with the value output, it validates the command inputs and returns a sample output JSON for that command. The generated JSON skeleton is not stable between versions of the AWS CLI and there are no backwards compatibility guarantees in the JSON skeleton generated.

See ‘aws help’ for descriptions of global parameters.

Output

control -> (structure)

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.

(structure)

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 -> (timestamp)

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 generated for the control.

assessmentReportEvidenceCount -> (integer)

The amount of evidence in the assessment report.