AWS Control Catalog

{'Filter': {'MappingTypes': {'RELATED_CONTROL'}}}

{'ControlMappings': {'Mapping': {'RelatedControl': {'ControlArn': 'string',
                                                    'RelationType': 'COMPLEMENTARY '
                                                                    '| '
                                                                    'ALTERNATIVE '
                                                                    '| '
                                                                    'MUTUALLY_EXCLUSIVE'}},
                     'MappingType': {'RELATED_CONTROL'}}}

Returns a paginated list of control mappings from the Control Catalog. Control mappings show relationships between controls and other entities, such as common controls or compliance frameworks.

See also: AWS API Documentation

Request Syntax

client.list_control_mappings(
    NextToken='string',
    MaxResults=123,
    Filter={
        'ControlArns': [
            'string',
        ],
        'CommonControlArns': [
            'string',
        ],
        'MappingTypes': [
            'FRAMEWORK'|'COMMON_CONTROL'|'RELATED_CONTROL',
        ]
    }
)

type NextToken:

string

param NextToken:

The pagination token that's used to fetch the next set of results.

type MaxResults:

integer

param MaxResults:

The maximum number of results on a page or for an API request call.

type Filter:

dict

param Filter:

An optional filter that narrows the results to specific control mappings based on control ARNs, common control ARNs, or mapping types.

• ControlArns (list) --

  A list of control ARNs to filter the mappings. When specified, only mappings associated with these controls are returned.

  • (string) --

• CommonControlArns (list) --

  A list of common control ARNs to filter the mappings. When specified, only mappings associated with these common controls are returned.

  • (string) --

• MappingTypes (list) --

  A list of mapping types to filter the mappings. When specified, only mappings of these types are returned.

  • (string) --

rtype:

dict

returns:

Response Syntax

{
    'ControlMappings': [
        {
            'ControlArn': 'string',
            'MappingType': 'FRAMEWORK'|'COMMON_CONTROL'|'RELATED_CONTROL',
            'Mapping': {
                'Framework': {
                    'Name': 'string',
                    'Item': 'string'
                },
                'CommonControl': {
                    'CommonControlArn': 'string'
                },
                'RelatedControl': {
                    'ControlArn': 'string',
                    'RelationType': 'COMPLEMENTARY'|'ALTERNATIVE'|'MUTUALLY_EXCLUSIVE'
                }
            }
        },
    ],
    'NextToken': 'string'
}

Response Structure

• (dict) --

  • ControlMappings (list) --

    The list of control mappings that the ListControlMappings API returns.

    • (dict) --

      A structure that contains information about a control mapping, including the control ARN, mapping type, and mapping details.

      • ControlArn (string) --

        The Amazon Resource Name (ARN) that identifies the control in the mapping.

      • MappingType (string) --

        The type of mapping relationship between the control and other entities.

      • Mapping (dict) --

        The details of the mapping relationship, for example, containing framework, common control, or related control information.

        • Framework (dict) --

          The framework mapping details when the mapping type relates to a compliance framework.

          • Name (string) --

            The name of the compliance framework that the control maps to.

          • Item (string) --

            The specific item or requirement within the framework that the control maps to.

        • CommonControl (dict) --

          The common control mapping details when the mapping type relates to a common control.

          • CommonControlArn (string) --

            The Amazon Resource Name (ARN) that identifies the common control in the mapping.

        • RelatedControl (dict) --

          Returns information about controls that are related to the specified control.

          • ControlArn (string) --

            The unique identifier of a control.

          • RelationType (string) --

            Returns an enumerated value that represents the relationship between two or more controls.

  • NextToken (string) --

    The pagination token that's used to fetch the next set of results.