DevOpsAgentService / Client / list_recommendations

list_recommendations

DevOpsAgentService.Client.list_recommendations(**kwargs)

Lists recommendations for the specified agent space

See also: AWS API Documentation

Request Syntax

response = client.list_recommendations(
    agentSpaceId='string',
    taskId='string',
    goalId='string',
    status='PROPOSED'|'ACCEPTED'|'REJECTED'|'CLOSED'|'COMPLETED'|'UPDATE_IN_PROGRESS',
    priority='HIGH'|'MEDIUM'|'LOW',
    limit=123,
    nextToken='string'
)
Parameters:

  • agentSpaceId (string) –

    [REQUIRED]

    The unique identifier for the agent space containing the recommendations

  • taskId (string) – Optional task ID to filter recommendations by specific task

  • goalId (string) – Optional goal ID to filter recommendations by specific goal

  • status (string) – Optional status to filter recommendations by their current status

  • priority (string) – Optional priority to filter recommendations by priority level

  • limit (integer) – Maximum number of recommendations to return in a single response

  • nextToken (string) – Token for retrieving the next page of results

Return type:

dict

Returns:

Response Syntax

{
    'recommendations': [
        {
            'agentSpaceArn': 'string',
            'recommendationId': 'string',
            'taskId': 'string',
            'goalId': 'string',
            'title': 'string',
            'content': {
                'summary': 'string',
                'spec': 'string'
            },
            'status': 'PROPOSED'|'ACCEPTED'|'REJECTED'|'CLOSED'|'COMPLETED'|'UPDATE_IN_PROGRESS',
            'priority': 'HIGH'|'MEDIUM'|'LOW',
            'goalVersion': 123,
            'additionalContext': 'string',
            'createdAt': datetime(2015, 1, 1),
            'updatedAt': datetime(2015, 1, 1),
            'version': 123
        },
    ],
    'nextToken': 'string'
}

Response Structure

  • (dict) –

    Response structure containing a list of recommendations

    • recommendations (list) –

      List of recommendations matching the request criteria

      • (dict) –

        Represents a recommendation with all its properties and metadata

        • agentSpaceArn (string) –

          ARN of the agent space this recommendation belongs to

        • recommendationId (string) –

          The unique identifier for this recommendation

        • taskId (string) –

          ID of the task that generated the recommendation

        • goalId (string) –

          ID of the goal this recommendation is associated with

        • title (string) –

          The title of the recommendation

        • content (dict) –

          Content of the recommendation

          • summary (string) –

            A brief summary of the recommendation.

          • spec (string) –

            Agent-ready specification with detailed implementation steps

        • status (string) –

          Current status of the recommendation

        • priority (string) –

          Priority level of the recommendation

        • goalVersion (integer) –

          Version of the goal at the time this recommendation was generated

        • additionalContext (string) –

          Additional context for recommendation

        • createdAt (datetime) –

          Timestamp when this recommendation was created

        • updatedAt (datetime) –

          Timestamp when this recommendation was last updated

        • version (integer) –

          Version number for optimistic locking

    • nextToken (string) –

      Token for retrieving the next page of results, if more results are available

Exceptions