:doc:`SsmSap <../../ssm-sap>` / Paginator / ListOperationEvents

*******************
ListOperationEvents
*******************



.. py:class:: SsmSap.Paginator.ListOperationEvents

  ::

    
    paginator = client.get_paginator('list_operation_events')

  
  

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

    Creates an iterator that will paginate through responses from :py:meth:`SsmSap.Client.list_operation_events`.

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


    **Request Syntax**
    ::

      response_iterator = paginator.paginate(
          OperationId='string',
          Filters=[
              {
                  'Name': 'string',
                  'Value': 'string',
                  'Operator': 'Equals'|'GreaterThanOrEquals'|'LessThanOrEquals'
              },
          ],
          PaginationConfig={
              'MaxItems': 123,
              'PageSize': 123,
              'StartingToken': 'string'
          }
      )
      
    :type OperationId: string
    :param OperationId: **[REQUIRED]** 

      The ID of the operation.

      

    
    :type Filters: list
    :param Filters: 

      Optionally specify filters to narrow the returned operation event items.

       

      Valid filter names include ``status``, ``resourceID``, and ``resourceType``. The valid operator for all three filters is ``Equals``.

      

    
      - *(dict) --* 

        A specific result obtained by specifying the name, value, and operator.

        

      
        - **Name** *(string) --* **[REQUIRED]** 

          The name of the filter. Filter names are case-sensitive.

          

        
        - **Value** *(string) --* **[REQUIRED]** 

          The filter values. Filter values are case-sensitive. If you specify multiple values for a filter, the values are joined with an OR, and the request returns all results that match any of the specified values

          

        
        - **Operator** *(string) --* **[REQUIRED]** 

          The operator for the filter.

          

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

      
      ::

        {
            'OperationEvents': [
                {
                    'Description': 'string',
                    'Resource': {
                        'ResourceArn': 'string',
                        'ResourceType': 'string'
                    },
                    'Status': 'IN_PROGRESS'|'COMPLETED'|'FAILED',
                    'StatusMessage': 'string',
                    'Timestamp': datetime(2015, 1, 1)
                },
            ],
            
        }
        
      **Response Structure**

      

      - *(dict) --* 
        

        - **OperationEvents** *(list) --* 

          A returned list of operation events that meet the filter criteria.

          
          

          - *(dict) --* 

            An operation event returns details for an operation, including key milestones which can be used to monitor and track operations in progress.

             

            Operation events contain:

             

            
            * Description string
             
            * Resource, including its ARN and type
             
            * Status
             
            * StatusMessage string
             
            * TimeStamp
            

             

            Operation event examples include StartApplication or StopApplication.

            
            

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

              A description of the operation event. For example, "Stop the EC2 instance i-abcdefgh987654321".

              
            

            - **Resource** *(dict) --* 

              The resource involved in the operations event.

               

              Contains ``ResourceArn`` ARN and ``ResourceType``.

              
              

              - **ResourceArn** *(string) --* 

                The Amazon Resource Name (ARN) of the source resource.

                 

                Example of ``ResourceArn``: " ``arn:aws:ec2:us-east-1:111111111111:instance/i-abcdefgh987654321``"

                
              

              - **ResourceType** *(string) --* 

                The resource type.

                 

                Example of ``ResourceType``: " ``AWS::SystemsManagerSAP::Component``" or " ``AWS::EC2::Instance``".

                
          
            

            - **Status** *(string) --* 

              The status of the operation event. The possible statuses are: ``IN_PROGRESS``, ``COMPLETED``, and ``FAILED``.

              
            

            - **StatusMessage** *(string) --* 

              The status message relating to a specific operation event.

              
            

            - **Timestamp** *(datetime) --* 

              The timestamp of the specified operation event.

              
        
      
    