create_control¶

create_control(**kwargs)¶

Creates a new custom control in Audit Manager.

Request Syntax

response = client.create_control(
    name='string',
    description='string',
    testingInformation='string',
    actionPlanTitle='string',
    actionPlanInstructions='string',
    controlMappingSources=[
        {
            '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'
        },
    ],
    tags={
        'string': 'string'
    }
)

Parameters

name (string) --
[REQUIRED]

The name of the control.
description (string) -- The description of the control.
testingInformation (string) -- The steps to follow to determine if the control is satisfied.
actionPlanTitle (string) -- The title of the action plan for remediating the control.
actionPlanInstructions (string) -- The recommended actions to carry out if the control isn't fulfilled.
controlMappingSources (list) --
[REQUIRED]

The data mapping sources for the control.
- (dict) --
  The control mapping fields that represent the source for evidence collection, along with related parameters and metadata. This doesn't contain mappingID .
  - sourceName (string) --
    The name of the control mapping data source.
  - sourceDescription (string) --
    The description of the data source that determines where Audit Manager collects evidence from for the control.
  - 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 (dict) --
    The keyword to search for in CloudTrail logs, Config rules, Security Hub checks, and Amazon Web Services API names.
    
    To learn more about the supported keywords that you can use when mapping a control data source, see the following pages in the Audit Manager User Guide :
    - keywordInputType (string) --
      The input method for the keyword.
    - keywordValue (string) --
      The value of the keyword that's used when mapping a control data source. For example, this can be a CloudTrail event name, a rule name for Config, a Security Hub control, or the name of an Amazon Web Services API call.
      
      If you’re mapping a data source to a rule in Config, the keywordValue that you specify depends on the type of rule:
      - For managed rules, you can use the rule identifier as the keywordValue . You can find the rule identifier from the list of Config managed rules.
        
        Managed rule name: s3-bucket-acl-prohibited keywordValue : S3_BUCKET_ACL_PROHIBITED
      - For custom rules, you form the keywordValue by adding the Custom_ prefix to the rule name. This prefix distinguishes the rule from a managed rule.
        
        Custom rule name: my-custom-config-rule keywordValue : Custom_my-custom-config-rule
      - For service-linked rules, you form the keywordValue by adding the Custom_ prefix to the rule name. In addition, you remove the suffix ID that appears at the end of the rule name.
        
        Service-linked rule name: CustomRuleForAccount-conformance-pack-szsm1uv0w keywordValue : Custom_CustomRuleForAccount-conformance-pack
        
        Service-linked rule name: OrgConfigRule-s3-bucket-versioning-enabled-dbgzf8ba keywordValue : Custom_OrgConfigRule-s3-bucket-versioning-enabled
  - sourceFrequency (string) --
    The frequency of evidence collection for the control mapping source.
  - troubleshootingText (string) --
    The instructions for troubleshooting the control.
tags (dict) --
The tags that are associated with the control.
- (string) --
  - (string) --

Return type

dict

Returns

Response Syntax

{
    'control': {
        'arn': 'string',
        'id': 'string',
        'type': 'Standard'|'Custom',
        'name': 'string',
        'description': 'string',
        'testingInformation': 'string',
        'actionPlanTitle': 'string',
        'actionPlanInstructions': 'string',
        'controlSources': 'string',
        'controlMappingSources': [
            {
                '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'
            },
        ],
        'createdAt': datetime(2015, 1, 1),
        'lastUpdatedAt': datetime(2015, 1, 1),
        'createdBy': 'string',
        'lastUpdatedBy': 'string',
        'tags': {
            'string': 'string'
        }
    }
}

Response Structure

(dict) --
- control (dict) --
  
  The new control that the CreateControl API returned.
  - arn (string) --
    
    The Amazon Resource Name (ARN) of the control.
  - id (string) --
    
    The unique identifier for the control.
  - type (string) --
    
    The type of control, such as a custom control or a standard control.
  - name (string) --
    
    The name of the control.
  - description (string) --
    
    The description of the control.
  - testingInformation (string) --
    
    The steps that you should 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 isn't fulfilled.
  - controlSources (string) --
    
    The data source types that determine where Audit Manager collects evidence from for the control.
  - controlMappingSources (list) --
    
    The data mapping sources for the control.
    - (dict) --
      
      The data source that determines where Audit Manager collects evidence from for the control.
      - sourceId (string) --
        
        The unique identifier for the source.
      - sourceName (string) --
        
        The name of the source.
      - sourceDescription (string) --
        
        The description of the source.
      - sourceSetUpOption (string) --
        
        The setup option for the data source. This option reflects if the evidence collection is automated or manual.
      - sourceType (string) --
        
        Specifies one of the five data source types for evidence collection.
      - sourceKeyword (dict) --
        
        The keyword to search for in CloudTrail logs, Config rules, Security Hub checks, and Amazon Web Services API names.
        
        To learn more about the supported keywords that you can use when mapping a control data source, see the following pages in the Audit Manager User Guide :
        
        Config rules supported by Audit Manager
        
        Security Hub controls supported by Audit Manager
        
        API calls supported by Audit Manager
        
        CloudTrail event names supported by Audit Manager
        
        keywordInputType (string) --
        
        The input method for the keyword.
        
        keywordValue (string) --
        
        The value of the keyword that's used when mapping a control data source. For example, this can be a CloudTrail event name, a rule name for Config, a Security Hub control, or the name of an Amazon Web Services API call.
        
        If you’re mapping a data source to a rule in Config, the keywordValue that you specify depends on the type of rule:
        
        For managed rules, you can use the rule identifier as the keywordValue . You can find the rule identifier from the list of Config managed rules.
        
        Managed rule name: s3-bucket-acl-prohibited keywordValue : S3_BUCKET_ACL_PROHIBITED
        
        For custom rules, you form the keywordValue by adding the Custom_ prefix to the rule name. This prefix distinguishes the rule from a managed rule.
        
        Custom rule name: my-custom-config-rule keywordValue : Custom_my-custom-config-rule
        
        For service-linked rules, you form the keywordValue by adding the Custom_ prefix to the rule name. In addition, you remove the suffix ID that appears at the end of the rule name.
        
        Service-linked rule name: CustomRuleForAccount-conformance-pack-szsm1uv0w keywordValue : Custom_CustomRuleForAccount-conformance-pack
        
        Service-linked rule name: OrgConfigRule-s3-bucket-versioning-enabled-dbgzf8ba keywordValue : Custom_OrgConfigRule-s3-bucket-versioning-enabled
      - sourceFrequency (string) --
        
        The frequency of evidence collection for the control mapping source.
      - troubleshootingText (string) --
        
        The instructions for troubleshooting the control.
  - createdAt (datetime) --
    
    The time when the control was created.
  - lastUpdatedAt (datetime) --
    
    The time when the control was most recently updated.
  - createdBy (string) --
    
    The user or role that created the control.
  - lastUpdatedBy (string) --
    
    The user or role that most recently updated the control.
  - tags (dict) --
    
    The tags associated with the control.
    - (string) --
      - (string) --

Exceptions

AuditManager.Client.exceptions.ResourceNotFoundException
AuditManager.Client.exceptions.ValidationException
AuditManager.Client.exceptions.AccessDeniedException
AuditManager.Client.exceptions.InternalServerException
AuditManager.Client.exceptions.ServiceQuotaExceededException

Table Of Contents

create_control¶