:doc:`EC2 <../../ec2>` / Paginator / DescribeRouteTables

*******************
DescribeRouteTables
*******************



.. py:class:: EC2.Paginator.DescribeRouteTables

  ::

    
    paginator = client.get_paginator('describe_route_tables')

  
  

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

    Creates an iterator that will paginate through responses from :py:meth:`EC2.Client.describe_route_tables`.

    See also: `AWS API Documentation <https://docs.aws.amazon.com/goto/WebAPI/ec2-2016-11-15/DescribeRouteTables>`_    


    **Request Syntax**
    ::

      response_iterator = paginator.paginate(
          DryRun=True|False,
          RouteTableIds=[
              'string',
          ],
          Filters=[
              {
                  'Name': 'string',
                  'Values': [
                      'string',
                  ]
              },
          ],
          PaginationConfig={
              'MaxItems': 123,
              'PageSize': 123,
              'StartingToken': 'string'
          }
      )
      
    :type DryRun: boolean
    :param DryRun: 

      Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is ``DryRunOperation``. Otherwise, it is ``UnauthorizedOperation``.

      

    
    :type RouteTableIds: list
    :param RouteTableIds: 

      The IDs of the route tables.

      

    
      - *(string) --* 

      
  
    :type Filters: list
    :param Filters: 

      The filters.

       

      
      * ``association.gateway-id`` - The ID of the gateway involved in the association.
       
      * ``association.route-table-association-id`` - The ID of an association ID for the route table.
       
      * ``association.route-table-id`` - The ID of the route table involved in the association.
       
      * ``association.subnet-id`` - The ID of the subnet involved in the association.
       
      * ``association.main`` - Indicates whether the route table is the main route table for the VPC ( ``true`` | ``false``). Route tables that do not have an association ID are not returned in the response.
       
      * ``owner-id`` - The ID of the Amazon Web Services account that owns the route table.
       
      * ``route-table-id`` - The ID of the route table.
       
      * ``route.destination-cidr-block`` - The IPv4 CIDR range specified in a route in the table.
       
      * ``route.destination-ipv6-cidr-block`` - The IPv6 CIDR range specified in a route in the route table.
       
      * ``route.destination-prefix-list-id`` - The ID (prefix) of the Amazon Web Services service specified in a route in the table.
       
      * ``route.egress-only-internet-gateway-id`` - The ID of an egress-only Internet gateway specified in a route in the route table.
       
      * ``route.gateway-id`` - The ID of a gateway specified in a route in the table.
       
      * ``route.instance-id`` - The ID of an instance specified in a route in the table.
       
      * ``route.nat-gateway-id`` - The ID of a NAT gateway.
       
      * ``route.transit-gateway-id`` - The ID of a transit gateway.
       
      * ``route.origin`` - Describes how the route was created. ``CreateRouteTable`` indicates that the route was automatically created when the route table was created; ``CreateRoute`` indicates that the route was manually added to the route table; ``EnableVgwRoutePropagation`` indicates that the route was propagated by route propagation.
       
      * ``route.state`` - The state of a route in the route table ( ``active`` | ``blackhole``). The blackhole state indicates that the route's target isn't available (for example, the specified gateway isn't attached to the VPC, the specified NAT instance has been terminated, and so on).
       
      * ``route.vpc-peering-connection-id`` - The ID of a VPC peering connection specified in a route in the table.
       
      * ``tag`` - The key/value combination of a tag assigned to the resource. Use the tag key in the filter name and the tag value as the filter value. For example, to find all resources that have a tag with the key ``Owner`` and the value ``TeamA``, specify ``tag:Owner`` for the filter name and ``TeamA`` for the filter value.
       
      * ``tag-key`` - The key of a tag assigned to the resource. Use this filter to find all resources assigned a tag with a specific key, regardless of the tag value.
       
      * ``vpc-id`` - The ID of the VPC for the route table.
      

      

    
      - *(dict) --* 

        A filter name and value pair that is used to return a more specific list of results from a describe operation. Filters can be used to match a set of resources by specific criteria, such as tags, attributes, or IDs.

         

        If you specify multiple filters, the filters are joined with an ``AND``, and the request returns only results that match all of the specified filters.

         

        For more information, see `List and filter using the CLI and API <https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/Using_Filtering.html#Filtering_Resources_CLI>`__ in the *Amazon EC2 User Guide*.

        

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

          The name of the filter. Filter names are case-sensitive.

          

        
        - **Values** *(list) --* 

          The filter values. Filter values are case-sensitive. If you specify multiple values for a filter, the values are joined with an ``OR``, and the request returns all results that match any of the specified values.

          

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

      
      ::

        {
            'RouteTables': [
                {
                    'Associations': [
                        {
                            'Main': True|False,
                            'RouteTableAssociationId': 'string',
                            'RouteTableId': 'string',
                            'SubnetId': 'string',
                            'GatewayId': 'string',
                            'PublicIpv4Pool': 'string',
                            'AssociationState': {
                                'State': 'associating'|'associated'|'disassociating'|'disassociated'|'failed',
                                'StatusMessage': 'string'
                            }
                        },
                    ],
                    'PropagatingVgws': [
                        {
                            'GatewayId': 'string'
                        },
                    ],
                    'RouteTableId': 'string',
                    'Routes': [
                        {
                            'DestinationCidrBlock': 'string',
                            'DestinationIpv6CidrBlock': 'string',
                            'DestinationPrefixListId': 'string',
                            'EgressOnlyInternetGatewayId': 'string',
                            'GatewayId': 'string',
                            'InstanceId': 'string',
                            'InstanceOwnerId': 'string',
                            'NatGatewayId': 'string',
                            'TransitGatewayId': 'string',
                            'LocalGatewayId': 'string',
                            'CarrierGatewayId': 'string',
                            'NetworkInterfaceId': 'string',
                            'Origin': 'CreateRouteTable'|'CreateRoute'|'EnableVgwRoutePropagation'|'Advertisement',
                            'State': 'active'|'blackhole'|'filtered',
                            'VpcPeeringConnectionId': 'string',
                            'CoreNetworkArn': 'string',
                            'OdbNetworkArn': 'string',
                            'IpAddress': 'string'
                        },
                    ],
                    'Tags': [
                        {
                            'Key': 'string',
                            'Value': 'string'
                        },
                    ],
                    'VpcId': 'string',
                    'OwnerId': 'string'
                },
            ],
            
        }
        
      **Response Structure**

      

      - *(dict) --* 

        Contains the output of DescribeRouteTables.

        
        

        - **RouteTables** *(list) --* 

          Information about the route tables.

          
          

          - *(dict) --* 

            Describes a route table.

            
            

            - **Associations** *(list) --* 

              The associations between the route table and your subnets or gateways.

              
              

              - *(dict) --* 

                Describes an association between a route table and a subnet or gateway.

                
                

                - **Main** *(boolean) --* 

                  Indicates whether this is the main route table.

                  
                

                - **RouteTableAssociationId** *(string) --* 

                  The ID of the association.

                  
                

                - **RouteTableId** *(string) --* 

                  The ID of the route table.

                  
                

                - **SubnetId** *(string) --* 

                  The ID of the subnet. A subnet ID is not returned for an implicit association.

                  
                

                - **GatewayId** *(string) --* 

                  The ID of the internet gateway or virtual private gateway.

                  
                

                - **PublicIpv4Pool** *(string) --* 

                  The ID of a public IPv4 pool. A public IPv4 pool is a pool of IPv4 addresses that you've brought to Amazon Web Services with BYOIP.

                  
                

                - **AssociationState** *(dict) --* 

                  The state of the association.

                  
                  

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

                    The state of the association.

                    
                  

                  - **StatusMessage** *(string) --* 

                    The status message, if applicable.

                    
              
            
          
            

            - **PropagatingVgws** *(list) --* 

              Any virtual private gateway (VGW) propagating routes.

              
              

              - *(dict) --* 

                Describes a virtual private gateway propagating route.

                
                

                - **GatewayId** *(string) --* 

                  The ID of the virtual private gateway.

                  
            
          
            

            - **RouteTableId** *(string) --* 

              The ID of the route table.

              
            

            - **Routes** *(list) --* 

              The routes in the route table.

              
              

              - *(dict) --* 

                Describes a route in a route table.

                
                

                - **DestinationCidrBlock** *(string) --* 

                  The IPv4 CIDR block used for the destination match.

                  
                

                - **DestinationIpv6CidrBlock** *(string) --* 

                  The IPv6 CIDR block used for the destination match.

                  
                

                - **DestinationPrefixListId** *(string) --* 

                  The prefix of the Amazon Web Services service.

                  
                

                - **EgressOnlyInternetGatewayId** *(string) --* 

                  The ID of the egress-only internet gateway.

                  
                

                - **GatewayId** *(string) --* 

                  The ID of a gateway attached to your VPC.

                  
                

                - **InstanceId** *(string) --* 

                  The ID of a NAT instance in your VPC.

                  
                

                - **InstanceOwnerId** *(string) --* 

                  The ID of Amazon Web Services account that owns the instance.

                  
                

                - **NatGatewayId** *(string) --* 

                  The ID of a NAT gateway.

                  
                

                - **TransitGatewayId** *(string) --* 

                  The ID of a transit gateway.

                  
                

                - **LocalGatewayId** *(string) --* 

                  The ID of the local gateway.

                  
                

                - **CarrierGatewayId** *(string) --* 

                  The ID of the carrier gateway.

                  
                

                - **NetworkInterfaceId** *(string) --* 

                  The ID of the network interface.

                  
                

                - **Origin** *(string) --* 

                  Describes how the route was created.

                   

                  
                  * ``CreateRouteTable`` - The route was automatically created when the route table was created.
                   
                  * ``CreateRoute`` - The route was manually added to the route table.
                   
                  * ``EnableVgwRoutePropagation`` - The route was propagated by route propagation.
                   
                  * ``Advertisement`` - The route was created dynamically by Amazon VPC Route Server.
                  

                  
                

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

                  The state of the route. The ``blackhole`` state indicates that the route's target isn't available (for example, the specified gateway isn't attached to the VPC, or the specified NAT instance has been terminated).

                  
                

                - **VpcPeeringConnectionId** *(string) --* 

                  The ID of a VPC peering connection.

                  
                

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

                  The Amazon Resource Name (ARN) of the core network.

                  
                

                - **OdbNetworkArn** *(string) --* 

                  The Amazon Resource Name (ARN) of the ODB network.

                  
                

                - **IpAddress** *(string) --* 

                  The next hop IP address for routes propagated by VPC Route Server into VPC route tables.

                  
            
          
            

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

              Any tags assigned to the route table.

              
              

              - *(dict) --* 

                Describes a tag.

                
                

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

                  The key of the tag.

                   

                  Constraints: Tag keys are case-sensitive and accept a maximum of 127 Unicode characters. May not begin with ``aws:``.

                  
                

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

                  The value of the tag.

                   

                  Constraints: Tag values are case-sensitive and accept a maximum of 256 Unicode characters.

                  
            
          
            

            - **VpcId** *(string) --* 

              The ID of the VPC.

              
            

            - **OwnerId** *(string) --* 

              The ID of the Amazon Web Services account that owns the route table.

              
        
      
    