:doc:`ControlCatalog <../../controlcatalog>` / Paginator / ListControlMappings

*******************
ListControlMappings
*******************



.. py:class:: ControlCatalog.Paginator.ListControlMappings

  ::

    
    paginator = client.get_paginator('list_control_mappings')

  
  

  .. py:method:: paginate(**kwargs)

    Creates an iterator that will paginate through responses from :py:meth:`ControlCatalog.Client.list_control_mappings`.

    See also: `AWS API Documentation <https://docs.aws.amazon.com/goto/WebAPI/controlcatalog-2018-05-10/ListControlMappings>`_    


    **Request Syntax**
    ::

      response_iterator = paginator.paginate(
          Filter={
              'ControlArns': [
                  'string',
              ],
              'CommonControlArns': [
                  'string',
              ],
              'MappingTypes': [
                  'FRAMEWORK'|'COMMON_CONTROL'|'RELATED_CONTROL',
              ]
          },
          PaginationConfig={
              'MaxItems': 123,
              'PageSize': 123,
              'StartingToken': 'string'
          }
      )
      
    :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) --* 

        
    
    
    :type PaginationConfig: dict
    :param PaginationConfig: 

      A dictionary that provides parameters to control pagination.

      

    
      - **MaxItems** *(integer) --* 

        The total number of items to return. If the total number of items available is more than the value specified in max-items then a ``NextToken`` will be provided in the output that you can use to resume pagination.

        

      
      - **PageSize** *(integer) --* 

        The size of each page.

        

      
      - **StartingToken** *(string) --* 

        A token to specify where to start paginating. This is the ``NextToken`` from a previous response.

        

      
    
    
    :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'
                        }
                    }
                },
            ],
            
        }
        
      **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.

              .. note::    This is a Tagged Union structure. Only one of the     following top level keys will be set: ``Framework``, ``CommonControl``, ``RelatedControl``.     If a client receives an unknown member it will     set ``SDK_UNKNOWN_MEMBER`` as the top level key,     which maps to the name or tag of the unknown     member. The structure of ``SDK_UNKNOWN_MEMBER`` is     as follows::

                            'SDK_UNKNOWN_MEMBER': {'name': 'UnknownMemberName'}


            
              

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

                  
            
          
        
      
    