DescribeLocalGatewayRouteTables¶

class EC2.Paginator.DescribeLocalGatewayRouteTables¶

paginator = client.get_paginator('describe_local_gateway_route_tables')

paginate(**kwargs)¶

Creates an iterator that will paginate through responses from EC2.Client.describe_local_gateway_route_tables().

See also: AWS API Documentation

Request Syntax

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

Parameters

LocalGatewayRouteTableIds (list) --
The IDs of the local gateway route tables.
- (string) --
Filters (list) --
One or more filters.
- local-gateway-id - The ID of a local gateway.
- local-gateway-route-table-arn - The Amazon Resource Name (ARN) of the local gateway route table.
- local-gateway-route-table-id - The ID of a local gateway route table.
- outpost-arn - The Amazon Resource Name (ARN) of the Outpost.
- owner-id - The ID of the Amazon Web Services account that owns the local gateway route table.
- state - The state of the local gateway 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.
  - 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) --
DryRun (boolean) -- 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 .
PaginationConfig (dict) --
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.

Return type

dict

Returns

Response Syntax

{
    'LocalGatewayRouteTables': [
        {
            'LocalGatewayRouteTableId': 'string',
            'LocalGatewayRouteTableArn': 'string',
            'LocalGatewayId': 'string',
            'OutpostArn': 'string',
            'OwnerId': 'string',
            'State': 'string',
            'Tags': [
                {
                    'Key': 'string',
                    'Value': 'string'
                },
            ],
            'Mode': 'direct-vpc-routing'|'coip',
            'StateReason': {
                'Code': 'string',
                'Message': 'string'
            }
        },
    ],

}

Response Structure

(dict) --
- LocalGatewayRouteTables (list) --
  
  Information about the local gateway route tables.
  - (dict) --
    
    Describes a local gateway route table.
    - LocalGatewayRouteTableId (string) --
      
      The ID of the local gateway route table.
    - LocalGatewayRouteTableArn (string) --
      
      The Amazon Resource Name (ARN) of the local gateway route table.
    - LocalGatewayId (string) --
      
      The ID of the local gateway.
    - OutpostArn (string) --
      
      The Amazon Resource Name (ARN) of the Outpost.
    - OwnerId (string) --
      
      The ID of the Amazon Web Services account that owns the local gateway route table.
    - State (string) --
      
      The state of the local gateway route table.
    - Tags (list) --
      
      The tags assigned to the local gateway 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.
    - Mode (string) --
      
      The mode of the local gateway route table.
    - StateReason (dict) --
      
      Information about the state change.
      - Code (string) --
        
        The reason code for the state change.
      - Message (string) --
        
        The message for the state change.
        
        Server.InsufficientInstanceCapacity : There was insufficient capacity available to satisfy the launch request.
        
        Server.InternalError : An internal error caused the instance to terminate during launch.
        
        Server.ScheduledStop : The instance was stopped due to a scheduled retirement.
        
        Server.SpotInstanceShutdown : The instance was stopped because the number of Spot requests with a maximum price equal to or higher than the Spot price exceeded available capacity or because of an increase in the Spot price.
        
        Server.SpotInstanceTermination : The instance was terminated because the number of Spot requests with a maximum price equal to or higher than the Spot price exceeded available capacity or because of an increase in the Spot price.
        
        Client.InstanceInitiatedShutdown : The instance was shut down using the shutdown -h command from the instance.
        
        Client.InstanceTerminated : The instance was terminated or rebooted during AMI creation.
        
        Client.InternalError : A client error caused the instance to terminate during launch.
        
        Client.InvalidSnapshot.NotFound : The specified snapshot was not found.
        
        Client.UserInitiatedHibernate : Hibernation was initiated on the instance.
        
        Client.UserInitiatedShutdown : The instance was shut down using the Amazon EC2 API.
        
        Client.VolumeLimitExceeded : The limit on the number of EBS volumes or total storage was exceeded. Decrease usage or request an increase in your account limits.

Table Of Contents

DescribeLocalGatewayRouteTables¶