:doc:`RAM <../../ram>` / Paginator / GetResourceShareInvitations

***************************
GetResourceShareInvitations
***************************



.. py:class:: RAM.Paginator.GetResourceShareInvitations

  ::

    
    paginator = client.get_paginator('get_resource_share_invitations')

  
  

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

    Creates an iterator that will paginate through responses from :py:meth:`RAM.Client.get_resource_share_invitations`.

    See also: `AWS API Documentation <https://docs.aws.amazon.com/goto/WebAPI/ram-2018-01-04/GetResourceShareInvitations>`_    


    **Request Syntax**
    ::

      response_iterator = paginator.paginate(
          resourceShareInvitationArns=[
              'string',
          ],
          resourceShareArns=[
              'string',
          ],
          PaginationConfig={
              'MaxItems': 123,
              'PageSize': 123,
              'StartingToken': 'string'
          }
      )
      
    :type resourceShareInvitationArns: list
    :param resourceShareInvitationArns: 

      Specifies the `Amazon Resource Names (ARNs) <https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html>`__ of the resource share invitations you want information about.

      

    
      - *(string) --* 

      
  
    :type resourceShareArns: list
    :param resourceShareArns: 

      Specifies that you want details about invitations only for the resource shares described by this list of `Amazon Resource Names (ARNs) <https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html>`__

      

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

      
      ::

        {
            'resourceShareInvitations': [
                {
                    'resourceShareInvitationArn': 'string',
                    'resourceShareName': 'string',
                    'resourceShareArn': 'string',
                    'senderAccountId': 'string',
                    'receiverAccountId': 'string',
                    'invitationTimestamp': datetime(2015, 1, 1),
                    'status': 'PENDING'|'ACCEPTED'|'REJECTED'|'EXPIRED',
                    'resourceShareAssociations': [
                        {
                            'resourceShareArn': 'string',
                            'resourceShareName': 'string',
                            'associatedEntity': 'string',
                            'associationType': 'PRINCIPAL'|'RESOURCE'|'SOURCE',
                            'status': 'ASSOCIATING'|'ASSOCIATED'|'FAILED'|'DISASSOCIATING'|'DISASSOCIATED'|'SUSPENDED'|'SUSPENDING'|'RESTORING',
                            'statusMessage': 'string',
                            'creationTime': datetime(2015, 1, 1),
                            'lastUpdatedTime': datetime(2015, 1, 1),
                            'external': True|False
                        },
                    ],
                    'receiverArn': 'string'
                },
            ],
            'NextToken': 'string'
        }
        
      **Response Structure**

      

      - *(dict) --* 
        

        - **resourceShareInvitations** *(list) --* 

          An array of objects that contain the details about the invitations.

          
          

          - *(dict) --* 

            Describes an invitation for an Amazon Web Services account to join a resource share.

            
            

            - **resourceShareInvitationArn** *(string) --* 

              The `Amazon Resource Name (ARN) <https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html>`__ of the invitation.

              
            

            - **resourceShareName** *(string) --* 

              The name of the resource share.

              
            

            - **resourceShareArn** *(string) --* 

              The `Amazon Resource Name (ARN) <https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html>`__ of the resource share

              
            

            - **senderAccountId** *(string) --* 

              The ID of the Amazon Web Services account that sent the invitation.

              
            

            - **receiverAccountId** *(string) --* 

              The ID of the Amazon Web Services account that received the invitation.

              
            

            - **invitationTimestamp** *(datetime) --* 

              The date and time when the invitation was sent.

              
            

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

              The current status of the invitation.

              
            

            - **resourceShareAssociations** *(list) --* 

              To view the resources associated with a pending resource share invitation, use  ListPendingInvitationResources.

              
              

              - *(dict) --* 

                Describes an association between a resource share and either a principal or a resource.

                
                

                - **resourceShareArn** *(string) --* 

                  The `Amazon Resource Name (ARN) <https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html>`__ of the resource share.

                  
                

                - **resourceShareName** *(string) --* 

                  The name of the resource share.

                  
                

                - **associatedEntity** *(string) --* 

                  The associated entity. This can be either of the following:

                   

                  
                  * For a resource association, this is the `Amazon Resource Name (ARN) <https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html>`__ of the resource.
                   
                  * For principal associations, this is one of the following: 

                    
                    * The ID of an Amazon Web Services account
                     
                    * The `Amazon Resource Name (ARN) <https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html>`__ of an organization in Organizations
                     
                    * The ARN of an organizational unit (OU) in Organizations
                     
                    * The ARN of an IAM role
                     
                    * The ARN of an IAM user
                    

                  
                  

                  
                

                - **associationType** *(string) --* 

                  The type of entity included in this association.

                  
                

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

                  The current status of the association.

                  
                

                - **statusMessage** *(string) --* 

                  A message about the status of the association.

                  
                

                - **creationTime** *(datetime) --* 

                  The date and time when the association was created.

                  
                

                - **lastUpdatedTime** *(datetime) --* 

                  The date and time when the association was last updated.

                  
                

                - **external** *(boolean) --* 

                  Indicates whether the principal belongs to the same organization in Organizations as the Amazon Web Services account that owns the resource share.

                  
            
          
            

            - **receiverArn** *(string) --* 

              The `Amazon Resource Name (ARN) <https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html>`__ of the IAM user or role that received the invitation.

              
        
      
        

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

          A token to resume pagination.

          
    