Table Of Contents

Feedback

User Guide

First time using the AWS CLI? See the User Guide for help getting started.

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 ]

create-assessment-framework

Description

Creates a custom framework in Audit Manager.

See also: AWS API Documentation

See 'aws help' for descriptions of global parameters.

Synopsis

  create-assessment-framework
--name <value>
[--description <value>]
[--compliance-type <value>]
--control-sets <value>
[--tags <value>]
[--cli-input-json <value>]
[--generate-cli-skeleton <value>]

Options

--name (string)

The name of the new custom framework.

--description (string)

An optional description for the new custom framework.

--compliance-type (string)

The compliance type that the new custom framework supports, such as CIS or HIPAA.

--control-sets (list)

The control sets to be associated with the framework.

(structure)

A controlSet entity that represents a collection of controls in Audit Manager. This does not contain the control set ID.

name -> (string)

The name of the specified control set.

controls -> (list)

The list of controls within the control set. This does not contain the control set ID.

(structure)

Control entity attributes that uniquely identify an existing control to be added to a framework in Audit Manager.

id -> (string)

The unique identifier of the control.

Shorthand Syntax:

name=string,controls=[{id=string},{id=string}] ...

JSON Syntax:

[
  {
    "name": "string",
    "controls": [
      {
        "id": "string"
      }
      ...
    ]
  }
  ...
]

--tags (map)

The tags associated with the framework.

key -> (string)

value -> (string)

Shorthand Syntax:

KeyName1=string,KeyName2=string

JSON Syntax:

{"string": "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

framework -> (structure)

The name of the new framework returned by the CreateAssessmentFramework API.

arn -> (string)

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

id -> (string)

The unique identifier for the specified framework.

name -> (string)

The name of the specified framework.

type -> (string)

The framework type, such as custom or standard.

complianceType -> (string)

The compliance type that the new custom framework supports, such as CIS or HIPAA.

description -> (string)

The description of the specified framework.

logo -> (string)

The logo associated with the framework.

controlSources -> (string)

The sources from which Audit Manager collects evidence for the control.

controlSets -> (list)

The control sets associated with the framework.

(structure)

A set of controls in Audit Manager.

id -> (string)

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

name -> (string)

The name of the control set.

controls -> (list)

The list of controls within the control set.

(structure)

A control in Audit Manager.

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 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 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 CloudTrail logs, Config rules, Security Hub checks, and Amazon Web Services API names.

keywordInputType -> (string)

The method of input for the specified keyword.

keywordValue -> (string)

The value of the keyword used to search CloudTrail logs, Config rules, Security Hub checks, and Amazon Web Services 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)

createdAt -> (timestamp)

Specifies when the framework was created.

lastUpdatedAt -> (timestamp)

Specifies when the framework was most recently updated.

createdBy -> (string)

The IAM user or role that created the framework.

lastUpdatedBy -> (string)

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

tags -> (map)

The tags associated with the framework.

key -> (string)

value -> (string)