Skip to content

EC2  >  Operations  >  modify_local_gateway_route

modify_local_gateway_route

Operation

modify_local_gateway_route async

modify_local_gateway_route(request: ModifyLocalGatewayRouteInput | ModifyLocalGatewayRouteInputDict, /, *, plugins: list[Plugin] | None = None) -> ModifyLocalGatewayRouteOutput
modify_local_gateway_route(*, plugins: list[Plugin] | None = None, **kwargs: Unpack[ModifyLocalGatewayRouteInputDict]) -> ModifyLocalGatewayRouteOutput

Modifies the specified local gateway route.

Parameters:

Name Type Description Default
plugins list[Plugin] | None

A list of callables that modify the configuration dynamically. Changes made by these plugins only apply for the duration of the operation execution and will not affect any other operation invocations.

None

Returns:

Type Description
ModifyLocalGatewayRouteOutput

An instance of ModifyLocalGatewayRouteOutput.

Input

Pass the input fields as keyword arguments, or pass a model or dictionary as the first positional argument. Pass plugins separately as a keyword argument.

Model

ModifyLocalGatewayRouteInput dataclass

Bases: _SerdeShape

Dataclass for ModifyLocalGatewayRouteInput structure.

Attributes
destination_cidr_block class-attribute instance-attribute
destination_cidr_block: str | None = ...

The CIDR block used for destination matches. The value that you provide must match the CIDR of an existing route in the table.

destination_prefix_list_id class-attribute instance-attribute
destination_prefix_list_id: str | None = ...

The ID of the prefix list. Use a prefix list in place of DestinationCidrBlock. You cannot use DestinationPrefixListId and DestinationCidrBlock in the same request.

dry_run class-attribute instance-attribute
dry_run: bool | None = ...

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.

local_gateway_route_table_id class-attribute instance-attribute
local_gateway_route_table_id: str | None = ...

The ID of the local gateway route table.

local_gateway_virtual_interface_group_id class-attribute instance-attribute
local_gateway_virtual_interface_group_id: str | None = ...

The ID of the virtual interface group.

network_interface_id class-attribute instance-attribute
network_interface_id: str | None = ...

The ID of the network interface.

Dictionaries

ModifyLocalGatewayRouteInputDict

Bases: TypedDict

Dictionary form of ModifyLocalGatewayRouteInput.

Attributes
destination_cidr_block instance-attribute
destination_cidr_block: str | None

The CIDR block used for destination matches. The value that you provide must match the CIDR of an existing route in the table.

destination_prefix_list_id instance-attribute
destination_prefix_list_id: str | None

The ID of the prefix list. Use a prefix list in place of DestinationCidrBlock. You cannot use DestinationPrefixListId and DestinationCidrBlock in the same request.

dry_run instance-attribute
dry_run: bool | None

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.

local_gateway_route_table_id instance-attribute
local_gateway_route_table_id: Required[str]

The ID of the local gateway route table.

local_gateway_virtual_interface_group_id instance-attribute
local_gateway_virtual_interface_group_id: str | None

The ID of the virtual interface group.

network_interface_id instance-attribute
network_interface_id: str | None

The ID of the network interface.

Output

ModifyLocalGatewayRouteOutput dataclass

Bases: _SerdeShape

Dataclass for ModifyLocalGatewayRouteOutput structure.

Attributes

response_metadata class-attribute instance-attribute
response_metadata: ResponseMetadata = ...

Metadata about the response that produced this output. Use this to recover the request identifiers a service's support team needs in order to investigate a call. Members of the metadata are individually optional.

route class-attribute instance-attribute
route: LocalGatewayRoute | None = ...

Information about the local gateway route table.