:doc:`PartnerCentralSellingAPI <../../partnercentral-selling>` / Paginator / ListEngagementByAcceptingInvitationTasks

****************************************
ListEngagementByAcceptingInvitationTasks
****************************************



.. py:class:: PartnerCentralSellingAPI.Paginator.ListEngagementByAcceptingInvitationTasks

  ::

    
    paginator = client.get_paginator('list_engagement_by_accepting_invitation_tasks')

  
  

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

    Creates an iterator that will paginate through responses from :py:meth:`PartnerCentralSellingAPI.Client.list_engagement_by_accepting_invitation_tasks`.

    See also: `AWS API Documentation <https://docs.aws.amazon.com/goto/WebAPI/partnercentral-selling-2022-07-26/ListEngagementByAcceptingInvitationTasks>`_    


    **Request Syntax**
    ::

      response_iterator = paginator.paginate(
          Sort={
              'SortOrder': 'ASCENDING'|'DESCENDING',
              'SortBy': 'StartTime'
          },
          Catalog='string',
          TaskStatus=[
              'IN_PROGRESS'|'COMPLETE'|'FAILED',
          ],
          OpportunityIdentifier=[
              'string',
          ],
          EngagementInvitationIdentifier=[
              'string',
          ],
          TaskIdentifier=[
              'string',
          ],
          PaginationConfig={
              'MaxItems': 123,
              'PageSize': 123,
              'StartingToken': 'string'
          }
      )
      
    :type Sort: dict
    :param Sort: 

      Specifies the sorting criteria for the returned results. This allows you to order the tasks based on specific attributes.

      

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

        Determines the order in which the sorted results are presented.

        

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

        Specifies the field by which the task list should be sorted.

        

      
    
    :type Catalog: string
    :param Catalog: **[REQUIRED]** 

      Specifies the catalog related to the request. Valid values are:

       

      
      * AWS: Retrieves the request from the production AWS environment.
       
      * Sandbox: Retrieves the request from a sandbox environment used for testing or development purposes.
      

      

    
    :type TaskStatus: list
    :param TaskStatus: 

      Filters the tasks based on their current status. This allows you to focus on tasks in specific states.

      

    
      - *(string) --* 

      
  
    :type OpportunityIdentifier: list
    :param OpportunityIdentifier: 

      Filters tasks by the identifiers of the opportunities they created or are associated with.

      

    
      - *(string) --* 

      
  
    :type EngagementInvitationIdentifier: list
    :param EngagementInvitationIdentifier: 

      Filters tasks by the identifiers of the engagement invitations they are processing.

      

    
      - *(string) --* 

      
  
    :type TaskIdentifier: list
    :param TaskIdentifier: 

      Filters tasks by their unique identifiers. Use this when you want to retrieve information about specific tasks.

      

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

      
      ::

        {
            'TaskSummaries': [
                {
                    'TaskId': 'string',
                    'TaskArn': 'string',
                    'StartTime': datetime(2015, 1, 1),
                    'TaskStatus': 'IN_PROGRESS'|'COMPLETE'|'FAILED',
                    'Message': 'string',
                    'ReasonCode': 'InvitationAccessDenied'|'InvitationValidationFailed'|'EngagementAccessDenied'|'OpportunityAccessDenied'|'ResourceSnapshotJobAccessDenied'|'ResourceSnapshotJobValidationFailed'|'ResourceSnapshotJobConflict'|'EngagementValidationFailed'|'EngagementConflict'|'OpportunitySubmissionFailed'|'EngagementInvitationConflict'|'InternalError'|'OpportunityValidationFailed'|'OpportunityConflict'|'ResourceSnapshotAccessDenied'|'ResourceSnapshotValidationFailed'|'ResourceSnapshotConflict'|'ServiceQuotaExceeded'|'RequestThrottled'|'ContextNotFound'|'CustomerProjectContextNotPermitted'|'DisqualifiedLeadNotPermitted',
                    'OpportunityId': 'string',
                    'ResourceSnapshotJobId': 'string',
                    'EngagementInvitationId': 'string'
                },
            ],
            
        }
        
      **Response Structure**

      

      - *(dict) --* 
        

        - **TaskSummaries** *(list) --* 

          An array of ``EngagementByAcceptingInvitationTaskSummary`` objects, each representing a task that matches the specified filters. The array may be empty if no tasks match the criteria.

          
          

          - *(dict) --* 

            Specifies a subset of fields associated with tasks related to accepting an engagement invitation.

            
            

            - **TaskId** *(string) --* 

              Unique identifier of the task.

              
            

            - **TaskArn** *(string) --* 

              The Amazon Resource Name (ARN) that uniquely identifies the task.

              
            

            - **StartTime** *(datetime) --* 

              Task start timestamp.

              
            

            - **TaskStatus** *(string) --* 

              Status of the task.

              
            

            - **Message** *(string) --* 

              Detailed message describing the failure and possible recovery steps.

              
            

            - **ReasonCode** *(string) --* 

              A code pointing to the specific reason for the failure.

              
            

            - **OpportunityId** *(string) --* 

              Unique identifier of opportunity that was created.

              
            

            - **ResourceSnapshotJobId** *(string) --* 

              Unique identifier of the resource snapshot job that was created.

              
            

            - **EngagementInvitationId** *(string) --* 

              The unique identifier of the engagement invitation that was accepted.

              
        
      
    