:doc:`NetworkManager <../../networkmanager>` / Paginator / ListPeerings

************
ListPeerings
************



.. py:class:: NetworkManager.Paginator.ListPeerings

  ::

    
    paginator = client.get_paginator('list_peerings')

  
  

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

    Creates an iterator that will paginate through responses from :py:meth:`NetworkManager.Client.list_peerings`.

    See also: `AWS API Documentation <https://docs.aws.amazon.com/goto/WebAPI/networkmanager-2019-07-05/ListPeerings>`_    


    **Request Syntax**
    ::

      response_iterator = paginator.paginate(
          CoreNetworkId='string',
          PeeringType='TRANSIT_GATEWAY',
          EdgeLocation='string',
          State='CREATING'|'FAILED'|'AVAILABLE'|'DELETING',
          PaginationConfig={
              'MaxItems': 123,
              'PageSize': 123,
              'StartingToken': 'string'
          }
      )
      
    :type CoreNetworkId: string
    :param CoreNetworkId: 

      The ID of a core network.

      

    
    :type PeeringType: string
    :param PeeringType: 

      Returns a list of a peering requests.

      

    
    :type EdgeLocation: string
    :param EdgeLocation: 

      Returns a list edge locations for the

      

    
    :type State: string
    :param State: 

      Returns a list of the peering request states.

      

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

      
      ::

        {
            'Peerings': [
                {
                    'CoreNetworkId': 'string',
                    'CoreNetworkArn': 'string',
                    'PeeringId': 'string',
                    'OwnerAccountId': 'string',
                    'PeeringType': 'TRANSIT_GATEWAY',
                    'State': 'CREATING'|'FAILED'|'AVAILABLE'|'DELETING',
                    'EdgeLocation': 'string',
                    'ResourceArn': 'string',
                    'Tags': [
                        {
                            'Key': 'string',
                            'Value': 'string'
                        },
                    ],
                    'CreatedAt': datetime(2015, 1, 1),
                    'LastModificationErrors': [
                        {
                            'Code': 'TRANSIT_GATEWAY_NOT_FOUND'|'TRANSIT_GATEWAY_PEERS_LIMIT_EXCEEDED'|'MISSING_PERMISSIONS'|'INTERNAL_ERROR'|'EDGE_LOCATION_PEER_DUPLICATE'|'INVALID_TRANSIT_GATEWAY_STATE',
                            'Message': 'string',
                            'ResourceArn': 'string',
                            'RequestId': 'string',
                            'MissingPermissionsContext': {
                                'MissingPermission': 'string'
                            }
                        },
                    ]
                },
            ],
            
        }
        
      **Response Structure**

      

      - *(dict) --* 
        

        - **Peerings** *(list) --* 

          Lists the transit gateway peerings for the ``ListPeerings`` request.

          
          

          - *(dict) --* 

            Describes a peering connection.

            
            

            - **CoreNetworkId** *(string) --* 

              The ID of the core network for the peering request.

              
            

            - **CoreNetworkArn** *(string) --* 

              The ARN of a core network.

              
            

            - **PeeringId** *(string) --* 

              The ID of the peering attachment.

              
            

            - **OwnerAccountId** *(string) --* 

              The ID of the account owner.

              
            

            - **PeeringType** *(string) --* 

              The type of peering. This will be ``TRANSIT_GATEWAY``.

              
            

            - **State** *(string) --* 

              The current state of the peering connection.

              
            

            - **EdgeLocation** *(string) --* 

              The edge location for the peer.

              
            

            - **ResourceArn** *(string) --* 

              The resource ARN of the peer.

              
            

            - **Tags** *(list) --* 

              The list of key-value tags associated with the peering.

              
              

              - *(dict) --* 

                Describes a tag.

                
                

                - **Key** *(string) --* 

                  The tag key.

                   

                  Constraints: Maximum length of 128 characters.

                  
                

                - **Value** *(string) --* 

                  The tag value.

                   

                  Constraints: Maximum length of 256 characters.

                  
            
          
            

            - **CreatedAt** *(datetime) --* 

              The timestamp when the attachment peer was created.

              
            

            - **LastModificationErrors** *(list) --* 

              Describes the error associated with the Connect peer request.

              
              

              - *(dict) --* 

                Describes an error associated with a peering request.

                
                

                - **Code** *(string) --* 

                  The error code for the peering request.

                  
                

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

                  The message associated with the error ``code``.

                  
                

                - **ResourceArn** *(string) --* 

                  The ARN of the requested peering resource.

                  
                

                - **RequestId** *(string) --* 

                  The ID of the Peering request.

                  
                

                - **MissingPermissionsContext** *(dict) --* 

                  Provides additional information about missing permissions for the peering error.

                  
                  

                  - **MissingPermission** *(string) --* 

                    The missing permissions.

                    
              
            
          
        
      
    