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

*******************
GetNetworkResources
*******************



.. py:class:: NetworkManager.Paginator.GetNetworkResources

  ::

    
    paginator = client.get_paginator('get_network_resources')

  
  

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

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

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


    **Request Syntax**
    ::

      response_iterator = paginator.paginate(
          GlobalNetworkId='string',
          CoreNetworkId='string',
          RegisteredGatewayArn='string',
          AwsRegion='string',
          AccountId='string',
          ResourceType='string',
          ResourceArn='string',
          PaginationConfig={
              'MaxItems': 123,
              'PageSize': 123,
              'StartingToken': 'string'
          }
      )
      
    :type GlobalNetworkId: string
    :param GlobalNetworkId: **[REQUIRED]** 

      The ID of the global network.

      

    
    :type CoreNetworkId: string
    :param CoreNetworkId: 

      The ID of a core network.

      

    
    :type RegisteredGatewayArn: string
    :param RegisteredGatewayArn: 

      The ARN of the gateway.

      

    
    :type AwsRegion: string
    :param AwsRegion: 

      The Amazon Web Services Region.

      

    
    :type AccountId: string
    :param AccountId: 

      The Amazon Web Services account ID.

      

    
    :type ResourceType: string
    :param ResourceType: 

      The resource type.

       

      The following are the supported resource types for Direct Connect:

       

      
      * ``dxcon``
       
      * ``dx-gateway``
       
      * ``dx-vif``
      

       

      The following are the supported resource types for Network Manager:

       

      
      * ``attachment``
       
      * ``connect-peer``
       
      * ``connection``
       
      * ``core-network``
       
      * ``device``
       
      * ``link``
       
      * ``peering``
       
      * ``site``
      

       

      The following are the supported resource types for Amazon VPC:

       

      
      * ``customer-gateway``
       
      * ``transit-gateway``
       
      * ``transit-gateway-attachment``
       
      * ``transit-gateway-connect-peer``
       
      * ``transit-gateway-route-table``
       
      * ``vpn-connection``
      

      

    
    :type ResourceArn: string
    :param ResourceArn: 

      The ARN of the resource.

      

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

      
      ::

        {
            'NetworkResources': [
                {
                    'RegisteredGatewayArn': 'string',
                    'CoreNetworkId': 'string',
                    'AwsRegion': 'string',
                    'AccountId': 'string',
                    'ResourceType': 'string',
                    'ResourceId': 'string',
                    'ResourceArn': 'string',
                    'Definition': 'string',
                    'DefinitionTimestamp': datetime(2015, 1, 1),
                    'Tags': [
                        {
                            'Key': 'string',
                            'Value': 'string'
                        },
                    ],
                    'Metadata': {
                        'string': 'string'
                    }
                },
            ],
            
        }
        
      **Response Structure**

      

      - *(dict) --* 
        

        - **NetworkResources** *(list) --* 

          The network resources.

          
          

          - *(dict) --* 

            Describes a network resource.

            
            

            - **RegisteredGatewayArn** *(string) --* 

              The ARN of the gateway.

              
            

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

              The ID of a core network.

              
            

            - **AwsRegion** *(string) --* 

              The Amazon Web Services Region.

              
            

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

              The Amazon Web Services account ID.

              
            

            - **ResourceType** *(string) --* 

              The resource type.

               

              The following are the supported resource types for Direct Connect:

               

              
              * ``dxcon``
               
              * ``dx-gateway``
               
              * ``dx-vif``
              

               

              The following are the supported resource types for Network Manager:

               

              
              * ``attachment``
               
              * ``connect-peer``
               
              * ``connection``
               
              * ``core-network``
               
              * ``device``
               
              * ``link``
               
              * ``peering``
               
              * ``site``
              

               

              The following are the supported resource types for Amazon VPC:

               

              
              * ``customer-gateway``
               
              * ``transit-gateway``
               
              * ``transit-gateway-attachment``
               
              * ``transit-gateway-connect-peer``
               
              * ``transit-gateway-route-table``
               
              * ``vpn-connection``
              

              
            

            - **ResourceId** *(string) --* 

              The ID of the resource.

              
            

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

              The ARN of the resource.

              
            

            - **Definition** *(string) --* 

              Information about the resource, in JSON format. Network Manager gets this information by describing the resource using its Describe API call.

              
            

            - **DefinitionTimestamp** *(datetime) --* 

              The time that the resource definition was retrieved.

              
            

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

              The tags.

              
              

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

                  
            
          
            

            - **Metadata** *(dict) --* 

              The resource metadata.

              
              

              - *(string) --* 
                

                - *(string) --* 
          
        
        
      
    