Note: You are viewing the documentation for an older major version of the AWS CLI (version 1).

AWS CLI version 2, the latest major version of AWS CLI, is now stable and recommended for general use. To view this page for the AWS CLI version 2, click here. For more information see the AWS CLI version 2 installation instructions and migration guide.

[ aws . auditmanager ]

update-control

Description

Updates a custom control in AWS Audit Manager.

See also: AWS API Documentation

See 'aws help' for descriptions of global parameters.

Synopsis

  update-control
--control-id <value>
--name <value>
[--description <value>]
[--testing-information <value>]
[--action-plan-title <value>]
[--action-plan-instructions <value>]
--control-mapping-sources <value>
[--cli-input-json <value>]
[--generate-cli-skeleton <value>]

Options

--control-id (string)

The identifier for the specified control.

--name (string)

The name of the control to be updated.

--description (string)

The optional description of the control.

--testing-information (string)

The steps that to follow to determine if the control has been satisfied.

--action-plan-title (string)

The title of the action plan for remediating the control.

--action-plan-instructions (string)

The recommended actions to carry out if the control is not fulfilled.

--control-mapping-sources (list)

The data mapping sources for the specified control.

(structure)

The data source that determines from where AWS Audit Manager collects evidence for the control.

sourceId -> (string)

The unique identifier for the specified source.

sourceName -> (string)

The name of the specified source.

sourceDescription -> (string)

The description of the specified source.

sourceSetUpOption -> (string)

The setup option for the data source, which reflects if the evidence collection is automated or manual.

sourceType -> (string)

Specifies one of the five types of data sources for evidence collection.

sourceKeyword -> (structure)

The keyword to search for in AWS CloudTrail logs, AWS Config rules, AWS Security Hub checks, and AWS API names.

keywordInputType -> (string)

The method of input for the specified keyword.

keywordValue -> (string)

The value of the keyword used to search AWS CloudTrail logs, AWS Config rules, AWS Security Hub checks, and AWS API names when mapping a control data source.

sourceFrequency -> (string)

The frequency of evidence collection for the specified control mapping source.

troubleshootingText -> (string)

The instructions for troubleshooting the specified control.

Shorthand Syntax:

sourceId=string,sourceName=string,sourceDescription=string,sourceSetUpOption=string,sourceType=string,sourceKeyword={keywordInputType=string,keywordValue=string},sourceFrequency=string,troubleshootingText=string ...

JSON Syntax:

[
  {
    "sourceId": "string",
    "sourceName": "string",
    "sourceDescription": "string",
    "sourceSetUpOption": "System_Controls_Mapping"|"Procedural_Controls_Mapping",
    "sourceType": "AWS_Cloudtrail"|"AWS_Config"|"AWS_Security_Hub"|"AWS_API_Call"|"MANUAL",
    "sourceKeyword": {
      "keywordInputType": "SELECT_FROM_LIST",
      "keywordValue": "string"
    },
    "sourceFrequency": "DAILY"|"WEEKLY"|"MONTHLY",
    "troubleshootingText": "string"
  }
  ...
]

--cli-input-json (string) Performs service operation based on the JSON string provided. The JSON string follows the format provided by --generate-cli-skeleton. If other arguments are provided on the command line, the CLI 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.

--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. If provided with the value output, it validates the command inputs and returns a sample output JSON for that command.

See 'aws help' for descriptions of global parameters.

Output

control -> (structure)

The name of the updated control set returned by the UpdateControl API.

arn -> (string)

The Amazon Resource Name (ARN) of the specified control.

id -> (string)

The unique identifier for the control.

type -> (string)

The type of control, such as custom or standard.

name -> (string)

The name of the specified control.

description -> (string)

The description of the specified control.

testingInformation -> (string)

The steps to follow to determine if the control has been satisfied.

actionPlanTitle -> (string)

The title of the action plan for remediating the control.

actionPlanInstructions -> (string)

The recommended actions to carry out if the control is not fulfilled.

controlSources -> (string)

The data source that determines from where AWS Audit Manager collects evidence for the control.

controlMappingSources -> (list)

The data mapping sources for the specified control.

(structure)

The data source that determines from where AWS Audit Manager collects evidence for the control.

sourceId -> (string)

The unique identifier for the specified source.

sourceName -> (string)

The name of the specified source.

sourceDescription -> (string)

The description of the specified source.

sourceSetUpOption -> (string)

The setup option for the data source, which reflects if the evidence collection is automated or manual.

sourceType -> (string)

Specifies one of the five types of data sources for evidence collection.

sourceKeyword -> (structure)

The keyword to search for in AWS CloudTrail logs, AWS Config rules, AWS Security Hub checks, and AWS API names.

keywordInputType -> (string)

The method of input for the specified keyword.

keywordValue -> (string)

The value of the keyword used to search AWS CloudTrail logs, AWS Config rules, AWS Security Hub checks, and AWS API names when mapping a control data source.

sourceFrequency -> (string)

The frequency of evidence collection for the specified control mapping source.

troubleshootingText -> (string)

The instructions for troubleshooting the specified control.

createdAt -> (timestamp)

Specifies when the control was created.

lastUpdatedAt -> (timestamp)

Specifies when the control was most recently updated.

createdBy -> (string)

The IAM user or role that created the control.

lastUpdatedBy -> (string)

The IAM user or role that most recently updated the control.

tags -> (map)

The tags associated with the control.

key -> (string)

value -> (string)