AuditManager / Client / create_assessment_framework

create_assessment_framework

AuditManager.Client.create_assessment_framework(**kwargs)

Creates a custom framework in Audit Manager.

See also: AWS API Documentation

Request Syntax

response = client.create_assessment_framework(
    name='string',
    description='string',
    complianceType='string',
    controlSets=[
        {
            'name': 'string',
            'controls': [
                {
                    'id': 'string'
                },
            ]
        },
    ],
    tags={
        'string': 'string'
    }
)

Parameters:

• name (string) –

  [REQUIRED]

  The name of the new custom framework.

• description (string) – An optional description for the new custom framework.

• complianceType (string) – The compliance type that the new custom framework supports, such as CIS or HIPAA.

• controlSets (list) –

  [REQUIRED]

  The control sets that are associated with the framework.

  • (dict) –

    A controlSet entity that represents a collection of controls in Audit Manager. This doesn’t contain the control set ID.

    • name (string) – [REQUIRED]

      The name of the control set.

    • controls (list) –

      The list of controls within the control set. This doesn’t contain the control set ID.

      • (dict) –

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

        • id (string) – [REQUIRED]

          The unique identifier of the control.

• tags (dict) –

  The tags that are associated with the framework.

  • (string) –

    • (string) –

Return type:

dict

Returns:

Response Syntax

{
    'framework': {
        'arn': 'string',
        'id': 'string',
        'name': 'string',
        'type': 'Standard'|'Custom',
        'complianceType': 'string',
        'description': 'string',
        'logo': 'string',
        'controlSources': 'string',
        'controlSets': [
            {
                'id': 'string',
                'name': 'string',
                'controls': [
                    {
                        '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'
                        }
                    },
                ]
            },
        ],
        'createdAt': datetime(2015, 1, 1),
        'lastUpdatedAt': datetime(2015, 1, 1),
        'createdBy': 'string',
        'lastUpdatedBy': 'string',
        'tags': {
            'string': 'string'
        }
    }
}

Response Structure

• (dict) –

  • framework (dict) –

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

    • arn (string) –

      The Amazon Resource Name (ARN) of the framework.

    • id (string) –

      The unique identifier for the framework.

    • name (string) –

      The name of the framework.

    • type (string) –

      The framework type, such as a custom framework or a standard framework.

    • complianceType (string) –

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

    • description (string) –

      The description of the framework.

    • logo (string) –

      The logo that’s associated with the framework.

    • controlSources (string) –

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

    • controlSets (list) –

      The control sets that are associated with the framework.

      • (dict) –

        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.

          • (dict) –

            A control in Audit Manager.

            • 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) –

    • createdAt (datetime) –

      The time when the framework was created.

    • lastUpdatedAt (datetime) –

      The time when the framework was most recently updated.

    • createdBy (string) –

      The user or role that created the framework.

    • lastUpdatedBy (string) –

      The user or role that most recently updated the framework.

    • tags (dict) –

      The tags that are associated with the framework.

      • (string) –

        • (string) –

Exceptions

• AuditManager.Client.exceptions.ResourceNotFoundException

• AuditManager.Client.exceptions.ValidationException

• AuditManager.Client.exceptions.AccessDeniedException

• AuditManager.Client.exceptions.InternalServerException

• AuditManager.Client.exceptions.ServiceQuotaExceededException