Skip to content

ListRecommendationsRequest

Source code in docs_src/capo_devops_agent/types/list_recommendations_request.py
class ListRecommendationsRequest(TypedDict, closed=True):
    agent_space_id: (
        "capo_devops_agent.types.agent_space_identifier.AgentSpaceIdentifier"
    )
    """<p>The unique identifier for the agent space containing the recommendations</p>"""
    task_id: NotRequired["capo_devops_agent.types.resource_id.ResourceId"]
    """<p>Optional task ID to filter recommendations by specific task</p>"""
    goal_id: NotRequired["capo_devops_agent.types.resource_id.ResourceId"]
    """<p>Optional goal ID to filter recommendations by specific goal</p>"""
    status: NotRequired[
        "capo_devops_agent.types.recommendation_status.RecommendationStatus"
    ]
    """<p>Optional status to filter recommendations by their current status</p>"""
    priority: NotRequired[
        "capo_devops_agent.types.recommendation_priority.RecommendationPriority"
    ]
    """<p>Optional priority to filter recommendations by priority level</p>"""
    limit: "int"
    """<p>Maximum number of recommendations to return in a single response</p>"""
    next_token: NotRequired["capo_devops_agent.types.next_token.NextToken"]
    """<p>Token for retrieving the next page of results</p>"""

agent_space_id instance-attribute

agent_space_id: AgentSpaceIdentifier

The unique identifier for the agent space containing the recommendations

goal_id instance-attribute

goal_id: NotRequired[ResourceId]

Optional goal ID to filter recommendations by specific goal

limit instance-attribute

limit: int

Maximum number of recommendations to return in a single response

next_token instance-attribute

next_token: NotRequired[NextToken]

Token for retrieving the next page of results

priority instance-attribute

priority: NotRequired[RecommendationPriority]

Optional priority to filter recommendations by priority level

status instance-attribute

status: NotRequired[RecommendationStatus]

Optional status to filter recommendations by their current status

task_id instance-attribute

task_id: NotRequired[ResourceId]

Optional task ID to filter recommendations by specific task