Skip to content
AWS for Query.Farm

aws.auditmanager.get_assessment_framework

Example SQL Queries

SELECT * FROM
aws.auditmanager.get_assessment_framework
WHERE
"framework_id" = 'VALUE';

Description

Gets information about a specified framework.

Table Definition

Column NameColumn Data Type
framework_id Required Input Column

The identifier for the framework. 

VARCHAR
_aws_profile Input Column

The AWS profile defines the AWS identity used. It can be defined via credentials or by assuming a IAM role.

STRUCT(
    "type" VARCHAR,
    "name" VARCHAR,
    "account_id" VARCHAR,
    "via_profile_name" VARCHAR,
    "assumed_role_arn" VARCHAR,
    "organization" STRUCT(
        "account_name" VARCHAR,
        "id" VARCHAR,
        "tags" STRUCT(
            "key" VARCHAR,
            "value" VARCHAR
        )[],
        "master_account" STRUCT(
            "id" VARCHAR,
            "email" VARCHAR
        ),
        "parents" STRUCT(
            "type" VARCHAR,
            "id" VARCHAR,
            "name" VARCHAR,
            "tags" STRUCT(
                "key" VARCHAR,
                "value" VARCHAR
            )[]
        )[]
    )
)
Show child fields
_aws_profile.account_id

The AWS account id

_aws_profile.assumed_role_arn

The ARN of the assumed role

_aws_profile.name

The unique name of the profile.

_aws_profile.organization

Information about this profile's membership in the AWS organization.

Show child fields
_aws_profile.organization.account_name

The name of account speciifed by the organization

_aws_profile.organization.id

The organization id

_aws_profile.organization.master_account
Show child fields
_aws_profile.organization.master_account.email

The organization master account email address

_aws_profile.organization.master_account.id

The organization master account id

_aws_profile.organization.parents[]
Show child fields
_aws_profile.organization.parents[].id

The id of the parent

_aws_profile.organization.parents[].name

The name of the parent

_aws_profile.organization.parents[].tags[]
Show child fields
_aws_profile.organization.parents[].tags[].key
_aws_profile.organization.parents[].tags[].value
_aws_profile.organization.parents[].type

The type of parent can be an organization unit or a root

_aws_profile.organization.tags[]
Show child fields
_aws_profile.organization.tags[].key
_aws_profile.organization.tags[].value
_aws_profile.type

The type of profile, either 'credentials' or 'assumed_role'

_aws_profile.via_profile_name

This IAM role for this profile is assumed by first utilizing another profile with this name to obtain credentials.

_aws_region Input Column

The AWS region to use.

VARCHAR
framework

The framework that the GetAssessmentFramework API returned. 

STRUCT(
    "arn" VARCHAR,
    "id" VARCHAR,
    "name" VARCHAR,
    "type" VARCHAR,
    "compliance_type" VARCHAR,
    "description" VARCHAR,
    "logo" VARCHAR,
    "control_sources" VARCHAR,
    "control_sets" STRUCT(
        "id" VARCHAR,
        "name" VARCHAR,
        "controls" STRUCT(
            "arn" VARCHAR,
            "id" VARCHAR,
            "type" VARCHAR,
            "name" VARCHAR,
            "description" VARCHAR,
            "testing_information" VARCHAR,
            "action_plan_title" VARCHAR,
            "action_plan_instructions" VARCHAR,
            "control_sources" VARCHAR,
            "control_mapping_sources" STRUCT(
                "source_id" VARCHAR,
                "source_name" VARCHAR,
                "source_description" VARCHAR,
                "source_set_up_option" VARCHAR,
                "source_type" VARCHAR,
                "source_keyword" STRUCT(
                    "keyword_input_type" VARCHAR,
                    "keyword_value" VARCHAR
                ),
                "source_frequency" VARCHAR,
                "troubleshooting_text" VARCHAR
            )[],
            "created_at" TIMESTAMP_S,
            "last_updated_at" TIMESTAMP_S,
            "created_by" VARCHAR,
            "last_updated_by" VARCHAR,
            "tags" MAP(VARCHAR, VARCHAR),
            "state" VARCHAR
        )[]
    )[],
    "created_at" TIMESTAMP_S,
    "last_updated_at" TIMESTAMP_S,
    "created_by" VARCHAR,
    "last_updated_by" VARCHAR,
    "tags" MAP(VARCHAR, VARCHAR)
)
Show child fields
framework.arn

The Amazon Resource Name (ARN) of the framework.

framework.compliance_type

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

framework.control_sets[]
Show child fields
framework.control_sets[].controls[]
Show child fields
framework.control_sets[].controls[].action_plan_instructions

The recommended actions to carry out if the control isn't fulfilled.

framework.control_sets[].controls[].action_plan_title

The title of the action plan for remediating the control.

framework.control_sets[].controls[].arn

The Amazon Resource Name (ARN) of the control.

framework.control_sets[].controls[].control_mapping_sources[]
Show child fields
framework.control_sets[].controls[].control_mapping_sources[].source_description

The description of the source.

framework.control_sets[].controls[].control_mapping_sources[].source_frequency

Specifies how often evidence is collected from the control mapping source.

framework.control_sets[].controls[].control_mapping_sources[].source_id

The unique identifier for the source.

framework.control_sets[].controls[].control_mapping_sources[].source_keyword

A keyword that relates to the control data source.

For manual evidence, this keyword indicates if the manual evidence is a file or text.

For automated evidence, this keyword identifies a specific CloudTrail event, Config rule, Security Hub control, or Amazon Web Services API name.

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:

Show child fields
framework.control_sets[].controls[].control_mapping_sources[].source_keyword.keyword_input_type

The input method for the keyword.

  • SELECT_FROM_LIST is used when mapping a data source for automated evidence.

    • When keywordInputType is SELECT_FROM_LIST, a keyword must be selected to collect automated evidence. For example, this keyword 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.

  • UPLOAD_FILE and INPUT_TEXT are only used when mapping a data source for manual evidence.

    • When keywordInputType is UPLOAD_FILE, a file must be uploaded as manual evidence.

    • When keywordInputType is INPUT_TEXT, text must be entered as manual evidence.

framework.control_sets[].controls[].control_mapping_sources[].source_keyword.keyword_value

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. For some rules, the rule identifier is different from the rule name. For example, the rule name restricted-ssh has the following rule identifier: INCOMING_SSH_DISABLED. Make sure to use the rule identifier, not the rule name.

    Keyword example for managed rules:

  • For custom rules, you form the keywordValue by adding the Custom_ prefix to the rule name. This prefix distinguishes the custom rule from a managed rule.

    Keyword example for custom rules:

    • 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.

    Keyword examples for service-linked rules:

    • 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

The keywordValue is case sensitive. If you enter a value incorrectly, Audit Manager might not recognize the data source mapping. As a result, you might not successfully collect evidence from that data source as intended.

Keep in mind the following requirements, depending on the data source type that you're using.

  1. For Config:

    • For managed rules, make sure that the keywordValue is the rule identifier in ALL_CAPS_WITH_UNDERSCORES. For example, CLOUDWATCH_LOG_GROUP_ENCRYPTED. For accuracy, we recommend that you reference the list of supported Config managed rules.

    • For custom rules, make sure that the keywordValue has the Custom_ prefix followed by the custom rule name. The format of the custom rule name itself may vary. For accuracy, we recommend that you visit the Config console to verify your custom rule name.

  2. For Security Hub: The format varies for Security Hub control names. For accuracy, we recommend that you reference the list of supported Security Hub controls.

  3. For Amazon Web Services API calls: Make sure that the keywordValue is written as serviceprefix_ActionName. For example, iam_ListGroups. For accuracy, we recommend that you reference the list of supported API calls.

  4. For CloudTrail: Make sure that the keywordValue is written as serviceprefix_ActionName. For example, cloudtrail_StartLogging. For accuracy, we recommend that you review the Amazon Web Service prefix and action names in the Service Authorization Reference.

framework.control_sets[].controls[].control_mapping_sources[].source_name

The name of the source.

framework.control_sets[].controls[].control_mapping_sources[].source_set_up_option

The setup option for the data source. This option reflects if the evidence collection method is automated or manual. If you don’t provide a value for sourceSetUpOption, Audit Manager automatically infers and populates the correct value based on the sourceType that you specify.

framework.control_sets[].controls[].control_mapping_sources[].source_type

Specifies which type of data source is used to collect evidence.

  • The source can be an individual data source type, such as AWS_Cloudtrail, AWS_Config, AWS_Security_Hub, AWS_API_Call, or MANUAL.

  • The source can also be a managed grouping of data sources, such as a Core_Control or a Common_Control.

framework.control_sets[].controls[].control_mapping_sources[].troubleshooting_text

The instructions for troubleshooting the control.

framework.control_sets[].controls[].control_sources

The data source types that determine where Audit Manager collects evidence from for the control.

framework.control_sets[].controls[].created_at

The time when the control was created.

framework.control_sets[].controls[].created_by

The user or role that created the control.

framework.control_sets[].controls[].description

The description of the control.

framework.control_sets[].controls[].id

The unique identifier for the control.

framework.control_sets[].controls[].last_updated_at

The time when the control was most recently updated.

framework.control_sets[].controls[].last_updated_by

The user or role that most recently updated the control.

framework.control_sets[].controls[].name

The name of the control.

framework.control_sets[].controls[].state

The state of the control. The END_OF_SUPPORT state is applicable to standard controls only. This state indicates that the standard control can still be used to collect evidence, but Audit Manager is no longer updating or maintaining that control.

framework.control_sets[].controls[].tags

The tags associated with the control.

framework.control_sets[].controls[].testing_information

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

framework.control_sets[].controls[].type

Specifies whether the control is a standard control or a custom control.

framework.control_sets[].id

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

framework.control_sets[].name

The name of the control set.

framework.control_sources

The control data sources where Audit Manager collects evidence from.

framework.created_at

The time when the framework was created.

framework.created_by

The user or role that created the framework.

framework.description

The description of the framework.

framework.id

The unique identifier for the framework.

framework.last_updated_at

The time when the framework was most recently updated.

framework.last_updated_by

The user or role that most recently updated the framework.

framework.logo

The logo that's associated with the framework.

framework.name

The name of the framework.

framework.tags

The tags that are associated with the framework.

framework.type

Specifies whether the framework is a standard framework or a custom framework.