:doc:`CleanRoomsService <../../cleanrooms>` / Paginator / ListProtectedJobs

*****************
ListProtectedJobs
*****************



.. py:class:: CleanRoomsService.Paginator.ListProtectedJobs

  ::

    
    paginator = client.get_paginator('list_protected_jobs')

  
  

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

    Creates an iterator that will paginate through responses from :py:meth:`CleanRoomsService.Client.list_protected_jobs`.

    See also: `AWS API Documentation <https://docs.aws.amazon.com/goto/WebAPI/cleanrooms-2022-02-17/ListProtectedJobs>`_    


    **Request Syntax**
    ::

      response_iterator = paginator.paginate(
          membershipIdentifier='string',
          status='SUBMITTED'|'STARTED'|'CANCELLED'|'CANCELLING'|'FAILED'|'SUCCESS',
          PaginationConfig={
              'MaxItems': 123,
              'PageSize': 123,
              'StartingToken': 'string'
          }
      )
      
    :type membershipIdentifier: string
    :param membershipIdentifier: **[REQUIRED]** 

      The identifier for the membership in the collaboration.

      

    
    :type status: string
    :param status: 

      A filter on the status of the protected job.

      

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

      
      ::

        {
            'protectedJobs': [
                {
                    'id': 'string',
                    'membershipId': 'string',
                    'membershipArn': 'string',
                    'createTime': datetime(2015, 1, 1),
                    'status': 'SUBMITTED'|'STARTED'|'CANCELLED'|'CANCELLING'|'FAILED'|'SUCCESS',
                    'receiverConfigurations': [
                        {
                            'analysisType': 'DIRECT_ANALYSIS',
                            'configurationDetails': {
                                'directAnalysisConfigurationDetails': {
                                    'receiverAccountIds': [
                                        'string',
                                    ]
                                }
                            }
                        },
                    ]
                },
            ],
            'NextToken': 'string'
        }
        
      **Response Structure**

      

      - *(dict) --* 
        

        - **protectedJobs** *(list) --* 

          A list of protected job summaries.

          
          

          - *(dict) --* 

            The protected job summary for the objects listed by the request.

            
            

            - **id** *(string) --* 

              The ID of the protected job.

              
            

            - **membershipId** *(string) --* 

              The unique ID for the membership that initiated the protected job.

              
            

            - **membershipArn** *(string) --* 

              The unique ARN for the membership that initiated the protected job.

              
            

            - **createTime** *(datetime) --* 

              The time the protected job was created.

              
            

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

              The status of the protected job.

              
            

            - **receiverConfigurations** *(list) --* 

              The receiver configurations for the protected job.

              
              

              - *(dict) --* 

                The protected job receiver configuration.

                
                

                - **analysisType** *(string) --* 

                  The analysis type for the protected job receiver configuration.

                  
                

                - **configurationDetails** *(dict) --* 

                  The configuration details for the protected job receiver.

                  .. note::    This is a Tagged Union structure. Only one of the     following top level keys will be set: ``directAnalysisConfigurationDetails``.     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'}


                
                  

                  - **directAnalysisConfigurationDetails** *(dict) --* 

                    The details needed to configure the direct analysis.

                    
                    

                    - **receiverAccountIds** *(list) --* 

                      The receiver account IDs.

                      
                      

                      - *(string) --* 
                  
                
              
            
          
        
      
        

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

          A token to resume pagination.

          
    