:doc:`ControlTower <../../controltower>` / Paginator / ListControlOperations

*********************
ListControlOperations
*********************



.. py:class:: ControlTower.Paginator.ListControlOperations

  ::

    
    paginator = client.get_paginator('list_control_operations')

  
  

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

    Creates an iterator that will paginate through responses from :py:meth:`ControlTower.Client.list_control_operations`.

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


    **Request Syntax**
    ::

      response_iterator = paginator.paginate(
          filter={
              'controlIdentifiers': [
                  'string',
              ],
              'targetIdentifiers': [
                  'string',
              ],
              'enabledControlIdentifiers': [
                  'string',
              ],
              'statuses': [
                  'SUCCEEDED'|'FAILED'|'IN_PROGRESS',
              ],
              'controlOperationTypes': [
                  'ENABLE_CONTROL'|'DISABLE_CONTROL'|'UPDATE_ENABLED_CONTROL'|'RESET_ENABLED_CONTROL',
              ]
          },
          PaginationConfig={
              'MaxItems': 123,
              'PageSize': 123,
              'StartingToken': 'string'
          }
      )
      
    :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 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**

      
      ::

        {
            '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 token to resume pagination.

          
    