:doc:`ControlCatalog <../../controlcatalog>` / Client / list_common_controls

********************
list_common_controls
********************



.. py:method:: ControlCatalog.Client.list_common_controls(**kwargs)

  

  Returns a paginated list of common controls from the Amazon Web Services Control Catalog.

   

  You can apply an optional filter to see common controls that have a specific objective. If you don’t provide a filter, the operation returns all common controls.

  

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


  **Request Syntax**
  ::

    response = client.list_common_controls(
        MaxResults=123,
        NextToken='string',
        CommonControlFilter={
            'Objectives': [
                {
                    'Arn': 'string'
                },
            ]
        }
    )
    
  :type MaxResults: integer
  :param MaxResults: 

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

    

  
  :type NextToken: string
  :param NextToken: 

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

    

  
  :type CommonControlFilter: dict
  :param CommonControlFilter: 

    An optional filter that narrows the results to a specific objective.

     

    This filter allows you to specify one objective ARN at a time. Passing multiple ARNs in the ``CommonControlFilter`` isn’t supported.

    

  
    - **Objectives** *(list) --* 

      The objective that's used as filter criteria.

       

      You can use this parameter to specify one objective ARN at a time. Passing multiple ARNs in the ``CommonControlFilter`` isn’t supported.

      

    
      - *(dict) --* 

        The objective resource that's being used as a filter.

        

      
        - **Arn** *(string) --* 

          The Amazon Resource Name (ARN) of the objective.

          

        
      
  
  
  
  :rtype: dict
  :returns: 
    
    **Response Syntax**

    
    ::

      {
          'CommonControls': [
              {
                  'Arn': 'string',
                  'Name': 'string',
                  'Description': 'string',
                  'Domain': {
                      'Arn': 'string',
                      'Name': 'string'
                  },
                  'Objective': {
                      'Arn': 'string',
                      'Name': 'string'
                  },
                  'CreateTime': datetime(2015, 1, 1),
                  'LastUpdateTime': datetime(2015, 1, 1)
              },
          ],
          'NextToken': 'string'
      }
      
    **Response Structure**

    

    - *(dict) --* 
      

      - **CommonControls** *(list) --* 

        The list of common controls that the ``ListCommonControls`` API returns.

        
        

        - *(dict) --* 

          A summary of metadata for a common control.

          
          

          - **Arn** *(string) --* 

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

            
          

          - **Name** *(string) --* 

            The name of the common control.

            
          

          - **Description** *(string) --* 

            The description of the common control.

            
          

          - **Domain** *(dict) --* 

            The domain that the common control belongs to.

            
            

            - **Arn** *(string) --* 

              The Amazon Resource Name (ARN) of the related domain.

              
            

            - **Name** *(string) --* 

              The name of the related domain.

              
        
          

          - **Objective** *(dict) --* 

            The objective that the common control belongs to.

            
            

            - **Arn** *(string) --* 

              The Amazon Resource Name (ARN) of the related objective.

              
            

            - **Name** *(string) --* 

              The name of the related objective.

              
        
          

          - **CreateTime** *(datetime) --* 

            The time when the common control was created.

            
          

          - **LastUpdateTime** *(datetime) --* 

            The time when the common control was most recently updated.

            
      
    
      

      - **NextToken** *(string) --* 

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

        
  
  **Exceptions**
  
  *   :py:class:`ControlCatalog.Client.exceptions.AccessDeniedException`

  
  *   :py:class:`ControlCatalog.Client.exceptions.InternalServerException`

  
  *   :py:class:`ControlCatalog.Client.exceptions.ValidationException`

  
  *   :py:class:`ControlCatalog.Client.exceptions.ThrottlingException`

  