This operation is no longer current and may be deprecated in the future. We recommend you upgrade to the Routes API V2 unless you require Grab data.
-
DeleteRouteCalculator is part of a previous Amazon Location Service Routes API (version 1) which has been superseded by a more intuitive, powerful, and complete API (version 2).
-
The Routes API version 2 has a simplified interface that can be used without creating or managing route calculator resources.
-
If you are using an Amazon Web Services SDK or the Amazon Web Services CLI, note that the Routes API version 2 is found under geo-routes or geo_routes, not under location.
-
Since Grab is not yet fully supported in Routes API version 2, we recommend you continue using API version 1 when using Grab.
-
Start your version 2 API journey with the Routes V2 API Reference or the Developer Guide.
Deletes a route calculator resource from your Amazon Web Services account.
This operation deletes the resource permanently.
Parameters:
-
calculator_name
(ResourceName)
–
The name of the route calculator resource to be deleted.
Raises:
Source code in docs_src/capo_location/_services/location.py
| def delete_route_calculator(
self,
calculator_name: "capo_location.types.resource_name.ResourceName",
*,
config_overrides: Optional[LocationClientConfig] = None,
) -> "capo_location.types.delete_route_calculator_response.DeleteRouteCalculatorResponse":
"""<important> <p>This operation is no longer current and may be deprecated in the future. We recommend you upgrade to the Routes API V2 unless you require Grab data.</p> <ul> <li> <p> <code>DeleteRouteCalculator</code> is part of a previous Amazon Location Service Routes API (version 1) which has been superseded by a more intuitive, powerful, and complete API (version 2).</p> </li> <li> <p>The Routes API version 2 has a simplified interface that can be used without creating or managing route calculator resources.</p> </li> <li> <p>If you are using an Amazon Web Services SDK or the Amazon Web Services CLI, note that the Routes API version 2 is found under <code>geo-routes</code> or <code>geo_routes</code>, not under <code>location</code>.</p> </li> <li> <p>Since Grab is not yet fully supported in Routes API version 2, we recommend you continue using API version 1 when using Grab.</p> </li> <li> <p>Start your version 2 API journey with the Routes V2 <a href="/location/latest/APIReference/API_Operations_Amazon_Location_Service_Routes_V2.html">API Reference</a> or the <a href="/location/latest/developerguide/routes.html">Developer Guide</a>.</p> </li> </ul> </important> <p>Deletes a route calculator resource from your Amazon Web Services account.</p> <note> <p>This operation deletes the resource permanently.</p> </note>
Args:
calculator_name: <p>The name of the route calculator resource to be deleted.</p>
Raises:
capo_location.errors.access_denied_exception.AccessDeniedException: <p>The request was denied because of insufficient access or permissions. Check with an administrator to verify your permissions.</p>
capo_location.errors.internal_server_exception.InternalServerException: <p>The request has failed to process because of an unknown server error, exception, or failure.</p>
capo_location.errors.resource_not_found_exception.ResourceNotFoundException: <p>The resource that you've entered was not found in your AWS account.</p>
capo_location.errors.throttling_exception.ThrottlingException: <p>The request was denied because of request throttling.</p>
capo_location.errors.validation_exception.ValidationException: <p>The input failed to meet the constraints specified by the AWS service. </p>
capo_location.errors.UnknownServiceError: The service returned an error code this client does not model.
"""
def _handler(
req: "OperationRequest[capo_location.types.delete_route_calculator_request.DeleteRouteCalculatorRequest]",
) -> OperationResponse[
"capo_location.types.delete_route_calculator_response.DeleteRouteCalculatorResponse"
]:
import capo_location._operations.location_service.delete_route_calculator
output, http_response = (
capo_location._operations.location_service.delete_route_calculator.delete_route_calculator(
req.options, req.input
)
)
return OperationResponse(output=output, response=http_response)
interceptors_, options_ = self.operation_options(
config_overrides, OperationLogging("DeleteRouteCalculator")
)
input_: capo_location.types.delete_route_calculator_request.DeleteRouteCalculatorRequest = {
"calculator_name": calculator_name
}
response = execute_pipeline(
OperationRequest(input=input_, options=options_),
handler=_handler,
interceptors=list(interceptors_),
)
response.response.close()
return response.output
|