list_agent_goals ¶

def list_agent_goals(
    self,
    profile_arn: "capo_wellarchitected.types.agent_profile_arn.AgentProfileArn",
    *,
    config_overrides: Optional[WellArchitectedClientConfig] = None,
    max_results: Optional[
        "capo_wellarchitected.types.max_results.MaxResults"
    ] = None,
    next_token: Optional["capo_wellarchitected.types.next_token.NextToken"] = None,
) -> "capo_wellarchitected.types.list_agent_goals_response.ListAgentGoalsResponse":
    """<p>Lists optimization goals associated with a specified profile. Goals define specific targets and objectives for the optimization process.</p>

    Args:
        profile_arn: <p>The Amazon Resource Name (ARN) of the optimization profile to list goals for.</p>
        max_results: <p>The maximum number of goals to return in a single response.</p>
        next_token: <p>A pagination token returned from a previous call to continue retrieving results.</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.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.list_agent_goals_request.ListAgentGoalsRequest]",
    ) -> OperationResponse[
        "capo_wellarchitected.types.list_agent_goals_response.ListAgentGoalsResponse"
    ]:
        import capo_wellarchitected._operations.well_architected_api_service_lambda.list_agent_goals

        output, http_response = (
            capo_wellarchitected._operations.well_architected_api_service_lambda.list_agent_goals.list_agent_goals(
                req.options, req.input
            )
        )
        return OperationResponse(output=output, response=http_response)

    def _redact_output(
        output: "capo_wellarchitected.types.list_agent_goals_response.ListAgentGoalsResponse",
    ) -> dict[str, Any]:
        import capo_wellarchitected.types.list_agent_goals_response

        return (
            capo_wellarchitected.types.list_agent_goals_response.redact_sensitive(
                output
            )
        )

    interceptors_, options_ = self.operation_options(
        config_overrides,
        OperationLogging("ListAgentGoals", redact_output=_redact_output),
    )
    input_: capo_wellarchitected.types.list_agent_goals_request.ListAgentGoalsRequest = {
        "profile_arn": profile_arn
    }
    if max_results is not None:
        input_["max_results"] = max_results
    if next_token is not None:
        input_["next_token"] = next_token

    response = execute_pipeline(
        OperationRequest(input=input_, options=options_),
        handler=_handler,
        interceptors=list(interceptors_),
    )
    response.response.close()
    return response.output