:doc:`ManagedBlockchain <../../managedblockchain>` / Client / list_invitations

****************
list_invitations
****************



.. py:method:: ManagedBlockchain.Client.list_invitations(**kwargs)

  

  Returns a list of all invitations for the current Amazon Web Services account.

   

  Applies only to Hyperledger Fabric.

  

  See also: `AWS API Documentation <https://docs.aws.amazon.com/goto/WebAPI/managedblockchain-2018-09-24/ListInvitations>`_  


  **Request Syntax**
  ::

    response = client.list_invitations(
        MaxResults=123,
        NextToken='string'
    )
    
  :type MaxResults: integer
  :param MaxResults: 

    The maximum number of invitations to return.

    

  
  :type NextToken: string
  :param NextToken: 

    The pagination token that indicates the next set of results to retrieve.

    

  
  
  :rtype: dict
  :returns: 
    
    **Response Syntax**

    
    ::

      {
          'Invitations': [
              {
                  'InvitationId': 'string',
                  'CreationDate': datetime(2015, 1, 1),
                  'ExpirationDate': datetime(2015, 1, 1),
                  'Status': 'PENDING'|'ACCEPTED'|'ACCEPTING'|'REJECTED'|'EXPIRED',
                  'NetworkSummary': {
                      'Id': 'string',
                      'Name': 'string',
                      'Description': 'string',
                      'Framework': 'HYPERLEDGER_FABRIC'|'ETHEREUM',
                      'FrameworkVersion': 'string',
                      'Status': 'CREATING'|'AVAILABLE'|'CREATE_FAILED'|'DELETING'|'DELETED',
                      'CreationDate': datetime(2015, 1, 1),
                      'Arn': 'string'
                  },
                  'Arn': 'string'
              },
          ],
          'NextToken': 'string'
      }
      
    **Response Structure**

    

    - *(dict) --* 
      

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

        The invitations for the network.

        
        

        - *(dict) --* 

          An invitation to an Amazon Web Services account to create a member and join the network.

           

          Applies only to Hyperledger Fabric.

          
          

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

            The unique identifier for the invitation.

            
          

          - **CreationDate** *(datetime) --* 

            The date and time that the invitation was created.

            
          

          - **ExpirationDate** *(datetime) --* 

            The date and time that the invitation expires. This is the ``CreationDate`` plus the ``ProposalDurationInHours`` that is specified in the ``ProposalThresholdPolicy``. After this date and time, the invitee can no longer create a member and join the network using this ``InvitationId``.

            
          

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

            The status of the invitation:

             

            
            * ``PENDING`` - The invitee hasn't created a member to join the network, and the invitation hasn't yet expired.
             
            * ``ACCEPTING`` - The invitee has begun creating a member, and creation hasn't yet completed.
             
            * ``ACCEPTED`` - The invitee created a member and joined the network using the ``InvitationID``.
             
            * ``REJECTED`` - The invitee rejected the invitation.
             
            * ``EXPIRED`` - The invitee neither created a member nor rejected the invitation before the ``ExpirationDate``.
            

            
          

          - **NetworkSummary** *(dict) --* 

            A summary of network configuration properties.

            
            

            - **Id** *(string) --* 

              The unique identifier of the network.

              
            

            - **Name** *(string) --* 

              The name of the network.

              
            

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

              An optional description of the network.

              
            

            - **Framework** *(string) --* 

              The blockchain framework that the network uses.

              
            

            - **FrameworkVersion** *(string) --* 

              The version of the blockchain framework that the network uses.

              
            

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

              The current status of the network.

              
            

            - **CreationDate** *(datetime) --* 

              The date and time that the network was created.

              
            

            - **Arn** *(string) --* 

              The Amazon Resource Name (ARN) of the network. For more information about ARNs and their format, see `Amazon Resource Names (ARNs) <https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html>`__ in the *Amazon Web Services General Reference*.

              
        
          

          - **Arn** *(string) --* 

            The Amazon Resource Name (ARN) of the invitation. For more information about ARNs and their format, see `Amazon Resource Names (ARNs) <https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html>`__ in the *Amazon Web Services General Reference*.

            
      
    
      

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

        The pagination token that indicates the next set of results to retrieve.

        
  
  **Exceptions**
  
  *   :py:class:`ManagedBlockchain.Client.exceptions.InvalidRequestException`

  
  *   :py:class:`ManagedBlockchain.Client.exceptions.AccessDeniedException`

  
  *   :py:class:`ManagedBlockchain.Client.exceptions.ResourceNotFoundException`

  
  *   :py:class:`ManagedBlockchain.Client.exceptions.ThrottlingException`

  
  *   :py:class:`ManagedBlockchain.Client.exceptions.ResourceLimitExceededException`

  
  *   :py:class:`ManagedBlockchain.Client.exceptions.InternalServiceErrorException`

  