modify_local_gateway_route

modify_local_gateway_route(**kwargs)

Modifies the specified local gateway route.

See also: AWS API Documentation

Request Syntax

response = client.modify_local_gateway_route(
    DestinationCidrBlock='string',
    LocalGatewayRouteTableId='string',
    LocalGatewayVirtualInterfaceGroupId='string',
    NetworkInterfaceId='string',
    DryRun=True|False,
    DestinationPrefixListId='string'
)
Parameters
  • DestinationCidrBlock (string) -- The CIDR block used for destination matches. The value that you provide must match the CIDR of an existing route in the table.
  • LocalGatewayRouteTableId (string) --

    [REQUIRED]

    The ID of the local gateway route table.

  • LocalGatewayVirtualInterfaceGroupId (string) -- The ID of the virtual interface group.
  • NetworkInterfaceId (string) -- The ID of the network interface.
  • 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 .
  • DestinationPrefixListId (string) -- The ID of the prefix list. Use a prefix list in place of DestinationCidrBlock . You cannot use DestinationPrefixListId and DestinationCidrBlock in the same request.
Return type

dict

Returns

Response Syntax

{
    'Route': {
        'DestinationCidrBlock': 'string',
        'LocalGatewayVirtualInterfaceGroupId': 'string',
        'Type': 'static'|'propagated',
        'State': 'pending'|'active'|'blackhole'|'deleting'|'deleted',
        'LocalGatewayRouteTableId': 'string',
        'LocalGatewayRouteTableArn': 'string',
        'OwnerId': 'string',
        'SubnetId': 'string',
        'CoipPoolId': 'string',
        'NetworkInterfaceId': 'string',
        'DestinationPrefixListId': 'string'
    }
}

Response Structure

  • (dict) --

    • Route (dict) --

      Information about the local gateway route table.

      • DestinationCidrBlock (string) --

        The CIDR block used for destination matches.

      • LocalGatewayVirtualInterfaceGroupId (string) --

        The ID of the virtual interface group.

      • Type (string) --

        The route type.

      • State (string) --

        The state of the route.

      • LocalGatewayRouteTableId (string) --

        The ID of the local gateway route table.

      • LocalGatewayRouteTableArn (string) --

        The Amazon Resource Name (ARN) of the local gateway route table.

      • OwnerId (string) --

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

      • SubnetId (string) --

        The ID of the subnet.

      • CoipPoolId (string) --

        The ID of the customer-owned address pool.

      • NetworkInterfaceId (string) --

        The ID of the network interface.

      • DestinationPrefixListId (string) --

        The ID of the prefix list.