:doc:`ControlTower <../../controltower>` / Client / list_control_operations

***********************
list_control_operations
***********************



.. py:method:: ControlTower.Client.list_control_operations(**kwargs)

  

  Provides a list of operations in progress or queued. For usage examples, see `ListControlOperation examples <https://docs.aws.amazon.com/controltower/latest/controlreference/control-api-examples-short.html#list-control-operations-api-examples>`__.

  

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


  **Request Syntax**
  ::

    response = client.list_control_operations(
        filter={
            'controlIdentifiers': [
                'string',
            ],
            'targetIdentifiers': [
                'string',
            ],
            'enabledControlIdentifiers': [
                'string',
            ],
            'statuses': [
                'SUCCEEDED'|'FAILED'|'IN_PROGRESS',
            ],
            'controlOperationTypes': [
                'ENABLE_CONTROL'|'DISABLE_CONTROL'|'UPDATE_ENABLED_CONTROL'|'RESET_ENABLED_CONTROL',
            ]
        },
        nextToken='string',
        maxResults=123
    )
    
  :type filter: dict
  :param filter: 

    An input filter for the ``ListControlOperations`` API that lets you select the types of control operations to view.

    

  
    - **controlIdentifiers** *(list) --* 

      The set of ``controlIdentifier`` returned by the filter.

      

    
      - *(string) --* 

      
  
    - **targetIdentifiers** *(list) --* 

      The set of ``targetIdentifier`` objects returned by the filter.

      

    
      - *(string) --* 

      
  
    - **enabledControlIdentifiers** *(list) --* 

      The set ``controlIdentifier`` of enabled controls selected by the filter.

      

    
      - *(string) --* 

      
  
    - **statuses** *(list) --* 

      Lists the status of control operations.

      

    
      - *(string) --* 

      
  
    - **controlOperationTypes** *(list) --* 

      The set of ``ControlOperation`` objects returned by the filter.

      

    
      - *(string) --* 

      
  
  
  :type nextToken: string
  :param nextToken: 

    A pagination token.

    

  
  :type maxResults: integer
  :param maxResults: 

    The maximum number of results to be shown.

    

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

    
    ::

      {
          'controlOperations': [
              {
                  'operationType': 'ENABLE_CONTROL'|'DISABLE_CONTROL'|'UPDATE_ENABLED_CONTROL'|'RESET_ENABLED_CONTROL',
                  'startTime': datetime(2015, 1, 1),
                  'endTime': datetime(2015, 1, 1),
                  'status': 'SUCCEEDED'|'FAILED'|'IN_PROGRESS',
                  'statusMessage': 'string',
                  'operationIdentifier': 'string',
                  'controlIdentifier': 'string',
                  'targetIdentifier': 'string',
                  'enabledControlIdentifier': 'string'
              },
          ],
          'nextToken': 'string'
      }
      
    **Response Structure**

    

    - *(dict) --* 
      

      - **controlOperations** *(list) --* 

        Returns a list of output from control operations.

        
        

        - *(dict) --* 

          A summary of information about the specified control operation.

          
          

          - **operationType** *(string) --* 

            The type of operation.

            
          

          - **startTime** *(datetime) --* 

            The time at which a control operation began.

            
          

          - **endTime** *(datetime) --* 

            The time at which the control operation was completed.

            
          

          - **status** *(string) --* 

            The status of the specified control operation.

            
          

          - **statusMessage** *(string) --* 

            A speficic message displayed as part of the control status.

            
          

          - **operationIdentifier** *(string) --* 

            The unique identifier of a control operation.

            
          

          - **controlIdentifier** *(string) --* 

            The ``controlIdentifier`` of a control.

            
          

          - **targetIdentifier** *(string) --* 

            The unique identifier of the target of a control operation.

            
          

          - **enabledControlIdentifier** *(string) --* 

            The ``controlIdentifier`` of an enabled control.

            
      
    
      

      - **nextToken** *(string) --* 

        A pagination token.

        
  
  **Exceptions**
  
  *   :py:class:`ControlTower.Client.exceptions.ValidationException`

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

  
  *   :py:class:`ControlTower.Client.exceptions.AccessDeniedException`

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

  