---
title: "GET /assessmentFrameworks/{frameworkId}"
method: GET
path: "/assessmentFrameworks/{frameworkId}"
---

# GET /assessmentFrameworks/{frameworkId}

`GET /assessmentFrameworks/{frameworkId}`

Returns a framework from Audit Manager.

## Path parameters

- `frameworkId` string, required

## Response `200`

Success

- GetAssessmentFrameworkResponse
  - `framework` object — The framework that the <code>GetAssessmentFramework</code> 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` 'Standard' | 'Custom' — 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` ControlSet[] — The control sets that are associated with the framework.
      - `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` Control[] — The list of controls within the control set.
        - `arn` string — The Amazon Resource Name (ARN) of the control.
        - `id` string — The unique identifier for the control.
        - `type` 'Standard' | 'Custom' — 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` ControlMappingSource[] — The data mapping sources 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` 'System_Controls_Mapping' | 'Procedural_Controls_Mapping' — The setup option for the data source. This option reflects if the evidence collection is automated or manual.
          - `sourceType` 'AWS_Cloudtrail' | 'AWS_Config' | 'AWS_Security_Hub' | 'AWS_API_Call' | 'MANUAL' — Specifies one of the five data source types for evidence collection.
          - `sourceKeyword` SourceKeyword — <p> The keyword to search for in CloudTrail logs, Config rules, Security Hub checks, and Amazon Web Services API names. </p> <p> To learn more about the supported keywords that you can use when mapping a control data source, see the following pages in the <i>Audit Manager User Guide</i>:</p> <ul> <li> <p> <a href="https://docs.aws.amazon.com/audit-manager/latest/userguide/control-data-sources-ash.html">Config rules supported by Audit Manager</a> </p> </li> <li> <p> <a href="https://docs.aws.amazon.com/audit-manager/latest/userguide/control-data-sources-config.html">Security Hub controls supported by Audit Manager</a> </p> </li> <li> <p> <a href="https://docs.aws.amazon.com/audit-manager/latest/userguide/control-data-sources-api.html">API calls supported by Audit Manager</a> </p> </li> <li> <p> <a href="https://docs.aws.amazon.com/audit-manager/latest/userguide/control-data-sources-cloudtrail.html">CloudTrail event names supported by Audit Manager</a> </p> </li> </ul>
            - `keywordInputType` 'SELECT_FROM_LIST' — The input method for the keyword.
            - `keywordValue` string — <p> 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. </p> <p>If you’re mapping a data source to a rule in Config, the <code>keywordValue</code> that you specify depends on the type of rule:</p> <ul> <li> <p>For <a href="https://docs.aws.amazon.com/config/latest/developerguide/evaluate-config_use-managed-rules.html">managed rules</a>, you can use the rule identifier as the <code>keywordValue</code>. You can find the rule identifier from the <a href="https://docs.aws.amazon.com/config/latest/developerguide/managed-rules-by-aws-config.html">list of Config managed rules</a>.</p> <ul> <li> <p>Managed rule name: <a href="https://docs.aws.amazon.com/config/latest/developerguide/s3-bucket-acl-prohibited.html">s3-bucket-acl-prohibited</a> </p> <p> <code>keywordValue</code>: <code>S3_BUCKET_ACL_PROHIBITED</code> </p> </li> </ul> </li> <li> <p>For <a href="https://docs.aws.amazon.com/config/latest/developerguide/evaluate-config_develop-rules.html">custom rules</a>, you form the <code>keywordValue</code> by adding the <code>Custom_</code> prefix to the rule name. This prefix distinguishes the rule from a managed rule.</p> <ul> <li> <p>Custom rule name: my-custom-config-rule</p> <p> <code>keywordValue</code>: <code>Custom_my-custom-config-rule</code> </p> </li> </ul> </li> <li> <p>For <a href="https://docs.aws.amazon.com/config/latest/developerguide/service-linked-awsconfig-rules.html">service-linked rules</a>, you form the <code>keywordValue</code> by adding the <code>Custom_</code> prefix to the rule name. In addition, you remove the suffix ID that appears at the end of the rule name.</p> <ul> <li> <p>Service-linked rule name: CustomRuleForAccount-conformance-pack-szsm1uv0w</p> <p> <code>keywordValue</code>: <code>Custom_CustomRuleForAccount-conformance-pack</code> </p> </li> <li> <p>Service-linked rule name: OrgConfigRule-s3-bucket-versioning-enabled-dbgzf8ba</p> <p> <code>keywordValue</code>: <code>Custom_OrgConfigRule-s3-bucket-versioning-enabled</code> </p> </li> </ul> </li> </ul>
          - `sourceFrequency` 'DAILY' | 'WEEKLY' | 'MONTHLY' — The frequency of evidence collection for the control mapping source.
          - `troubleshootingText` string — The instructions for troubleshooting the control.
        - `createdAt` string, date-time — The time when the control was created.
        - `lastUpdatedAt` string, date-time — 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` object — The tags associated with the control.
    - `createdAt` string, date-time — The time when the framework was created.
    - `lastUpdatedAt` string, date-time — 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` object — The tags that are associated with the framework.

## Other responses

- `480` — ResourceNotFoundException
- `481` — ValidationException
- `482` — AccessDeniedException
- `483` — InternalServerException

---

[API](https://skmtc.net/aws/apis/auditmanager.md) · [All operations](https://skmtc.net/aws/apis/auditmanager/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/aws/auditmanager/versions/27a1388d0f2a/schema)