:doc:`GuardDuty <../../guardduty>` / Paginator / ListInvitations

***************
ListInvitations
***************



.. py:class:: GuardDuty.Paginator.ListInvitations

  ::

    
    paginator = client.get_paginator('list_invitations')

  
  

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

    Creates an iterator that will paginate through responses from :py:meth:`GuardDuty.Client.list_invitations`.

    See also: `AWS API Documentation <https://docs.aws.amazon.com/goto/WebAPI/guardduty-2017-11-28/ListInvitations>`_    


    **Request Syntax**
    ::

      response_iterator = paginator.paginate(
          PaginationConfig={
              'MaxItems': 123,
              'PageSize': 123,
              'StartingToken': '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**

      
      ::

        {
            'Invitations': [
                {
                    'AccountId': 'string',
                    'InvitationId': 'string',
                    'RelationshipStatus': 'string',
                    'InvitedAt': 'string'
                },
            ],
            
        }
        
      **Response Structure**

      

      - *(dict) --* 
        

        - **Invitations** *(list) --* 

          A list of invitation descriptions.

          
          

          - *(dict) --* 

            Contains information about the invitation to become a member account.

            
            

            - **AccountId** *(string) --* 

              The ID of the account that the invitation was sent from.

              
            

            - **InvitationId** *(string) --* 

              The ID of the invitation. This value is used to validate the inviter account to the member account.

              
            

            - **RelationshipStatus** *(string) --* 

              The status of the relationship between the inviter and invitee accounts.

              
            

            - **InvitedAt** *(string) --* 

              The timestamp when the invitation was sent.

              
        
      
    