Deletes an optimization goal from a profile.
Parameters:
-
profile_arn
(AgentProfileArn)
–
The Amazon Resource Name (ARN) of the profile containing the goal.
-
id
(UUID)
–
The unique identifier of the goal to delete.
Raises:
Source code in docs_src/capo_wellarchitected/_services/well_architected.py
| def delete_agent_goal(
self,
profile_arn: "capo_wellarchitected.types.agent_profile_arn.AgentProfileArn",
id: "capo_wellarchitected.types.uuid.UUID",
*,
config_overrides: Optional[WellArchitectedClientConfig] = None,
) -> (
"capo_wellarchitected.types.delete_agent_goal_response.DeleteAgentGoalResponse"
):
"""<p>Deletes an optimization goal from a profile.</p>
Args:
profile_arn: <p>The Amazon Resource Name (ARN) of the profile containing the goal.</p>
id: <p>The unique identifier of the goal to delete.</p>
Raises:
capo_wellarchitected.errors.access_denied_exception.AccessDeniedException: <p>User does not have sufficient access to perform this action.</p>
capo_wellarchitected.errors.internal_server_exception.InternalServerException: <p>There is a problem with the Well-Architected Tool API service.</p>
capo_wellarchitected.errors.resource_not_found_exception.ResourceNotFoundException: <p>The requested resource was not found.</p>
capo_wellarchitected.errors.throttling_exception.ThrottlingException: <p>Request was denied due to request throttling.</p>
capo_wellarchitected.errors.validation_exception.ValidationException: <p>The user input is not valid.</p>
capo_wellarchitected.errors.UnknownServiceError: The service returned an error code this client does not model.
"""
def _handler(
req: "OperationRequest[capo_wellarchitected.types.delete_agent_goal_request.DeleteAgentGoalRequest]",
) -> OperationResponse[
"capo_wellarchitected.types.delete_agent_goal_response.DeleteAgentGoalResponse"
]:
import capo_wellarchitected._operations.well_architected_api_service_lambda.delete_agent_goal
output, http_response = (
capo_wellarchitected._operations.well_architected_api_service_lambda.delete_agent_goal.delete_agent_goal(
req.options, req.input
)
)
return OperationResponse(output=output, response=http_response)
interceptors_, options_ = self.operation_options(
config_overrides, OperationLogging("DeleteAgentGoal")
)
input_: capo_wellarchitected.types.delete_agent_goal_request.DeleteAgentGoalRequest = {
"profile_arn": profile_arn,
"id": id,
}
response = execute_pipeline(
OperationRequest(input=input_, options=options_),
handler=_handler,
interceptors=list(interceptors_),
)
response.response.close()
return response.output
|