delete_transit_gateway_route `async` ¶

delete_transit_gateway_route(
    *,
    config_overrides: Optional[AsyncEC2ClientConfig] = None,
    transit_gateway_route_table_id: Optional[TransitGatewayRouteTableId] = None,
    destination_cidr_block: Optional[String] = None,
    dry_run: Optional[Boolean] = None,
) -> DeleteTransitGatewayRouteResult

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

Parameters:

transit_gateway_route_table_id (Optional[TransitGatewayRouteTableId], default: None ) –

The ID of the transit gateway route table.
destination_cidr_block (Optional[String], default: None ) –

The CIDR range for the route. This must match the CIDR for the route exactly.
dry_run (Optional[Boolean], default: 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.

Raises:

UnknownServiceError –

The service returned an error code this client does not model.

Source code in docs_src/capo_ec2/_services/async_ec2.py

async def delete_transit_gateway_route(
    self,
    *,
    config_overrides: Optional[AsyncEC2ClientConfig] = None,
    transit_gateway_route_table_id: Optional[
        "capo_ec2.types.transit_gateway_route_table_id.TransitGatewayRouteTableId"
    ] = None,
    destination_cidr_block: Optional["capo_ec2.types.string.String"] = None,
    dry_run: Optional["capo_ec2.types.boolean.Boolean"] = None,
) -> "capo_ec2.types.delete_transit_gateway_route_result.DeleteTransitGatewayRouteResult":
    """<p>Deletes the specified route from the specified transit gateway route table.</p>

    Args:
        transit_gateway_route_table_id: <p>The ID of the transit gateway route table.</p>
        destination_cidr_block: <p>The CIDR range for the route. This must match the CIDR for the route exactly.</p>
        dry_run: <p>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 <code>DryRunOperation</code>. Otherwise, it is <code>UnauthorizedOperation</code>.</p>

    Raises:
        capo_ec2.errors.UnknownServiceError: The service returned an error code this client does not model.
    """

    async def _handler(
        req: "AsyncOperationRequest[capo_ec2.types.delete_transit_gateway_route_request.DeleteTransitGatewayRouteRequest]",
    ) -> AsyncOperationResponse[
        "capo_ec2.types.delete_transit_gateway_route_result.DeleteTransitGatewayRouteResult"
    ]:
        import capo_ec2._operations.amazon_ec2.delete_transit_gateway_route

        (
            output,
            http_response,
        ) = await capo_ec2._operations.amazon_ec2.delete_transit_gateway_route.async_delete_transit_gateway_route(
            req.options, req.input
        )
        return AsyncOperationResponse(output=output, response=http_response)

    interceptors_, options_ = self.operation_options(
        config_overrides, OperationLogging("DeleteTransitGatewayRoute")
    )
    input_: capo_ec2.types.delete_transit_gateway_route_request.DeleteTransitGatewayRouteRequest = {}
    if transit_gateway_route_table_id is not None:
        input_["transit_gateway_route_table_id"] = transit_gateway_route_table_id
    if destination_cidr_block is not None:
        input_["destination_cidr_block"] = destination_cidr_block
    if dry_run is not None:
        input_["dry_run"] = dry_run

    response = await aexecute_pipeline(
        AsyncOperationRequest(input=input_, options=options_),
        handler=_handler,
        interceptors=list(interceptors_),
    )
    await response.response.aclose()
    return response.output

delete_transit_gateway_route async ¶

delete_transit_gateway_route `async` ¶