Skip to content

EC2  >  Operations  >  delete_local_gateway_route

delete_local_gateway_route

Operation

delete_local_gateway_route async

delete_local_gateway_route(request: DeleteLocalGatewayRouteInput | DeleteLocalGatewayRouteInputDict, /, *, plugins: list[Plugin] | None = None) -> DeleteLocalGatewayRouteOutput
delete_local_gateway_route(*, plugins: list[Plugin] | None = None, **kwargs: Unpack[DeleteLocalGatewayRouteInputDict]) -> DeleteLocalGatewayRouteOutput

Deletes the specified route from the specified local gateway route table.

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
DeleteLocalGatewayRouteOutput

An instance of DeleteLocalGatewayRouteOutput.

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

DeleteLocalGatewayRouteInput dataclass

Bases: _SerdeShape

Dataclass for DeleteLocalGatewayRouteInput structure.

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

The CIDR range for the route. This must match the CIDR for the route exactly.

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

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.

Dictionaries

DeleteLocalGatewayRouteInputDict

Bases: TypedDict

Dictionary form of DeleteLocalGatewayRouteInput.

Attributes
destination_cidr_block instance-attribute
destination_cidr_block: str | None

The CIDR range for the route. This must match the CIDR for the route exactly.

destination_prefix_list_id instance-attribute
destination_prefix_list_id: str | None

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.

Output

DeleteLocalGatewayRouteOutput dataclass

Bases: _SerdeShape

Dataclass for DeleteLocalGatewayRouteOutput 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 route.