Request Syntax URI Request Parameters Request Body Response Syntax Response Elements Errors See Also

ListGoals

Lists goals in the specified agent space with optional filtering

Request Syntax


POST /backlog/agent-space/agentSpaceId/goals/list HTTP/1.1
Content-type: application/json

{
   "goalType": "string",
   "limit": number,
   "nextToken": "string",
   "status": "string"
}

URI Request Parameters

The request uses the following URI parameters.

agentSpaceId

The unique identifier for the agent space

Pattern: [a-zA-Z0-9-]{1,64}

Required: Yes

Request Body

The request accepts the following data in JSON format.

goalType

Filter goals by goal type

Type: String

Valid Values: CUSTOMER_DEFINED | ONCALL_REPORT

Required: No

limit

Maximum number of goals to return

Type: Integer

Valid Range: Minimum value of 1. Maximum value of 100.

Required: No

nextToken

Pagination token for the next set of results

Type: String

Length Constraints: Minimum length of 1. Maximum length of 2048.

Required: No

status

Filter goals by goal status

Type: String

Valid Values: ACTIVE | PAUSED | COMPLETE

Required: No

Response Syntax


HTTP/1.1 200
Content-type: application/json

{
   "goals": [ 
      { 
         "agentSpaceArn": "string",
         "content": { 
            "description": "string",
            "objectives": "string"
         },
         "createdAt": "string",
         "evaluationSchedule": { 
            "expression": "string",
            "state": "string"
         },
         "goalId": "string",
         "goalType": "string",
         "lastEvaluatedAt": "string",
         "lastSuccessfulTaskId": "string",
         "lastTaskId": "string",
         "status": "string",
         "title": "string",
         "updatedAt": "string",
         "version": number
      }
   ],
   "nextToken": "string"
}

Response Elements

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

goals

List of goals matching the criteria

Type: Array of Goal objects

nextToken

Pagination token for the next set of results

Type: String

Errors

For information about the errors that are common to all actions, see Common Error Types.

AccessDeniedException

Access to the requested resource is denied due to insufficient permissions.

message: Detailed error message describing why access was denied.

HTTP Status Code: 403

ConflictException

The request conflicts with the current state of the resource.

message: Detailed error message describing the conflict.

HTTP Status Code: 409

ContentSizeExceededException

This exception is thrown when the content size exceeds the allowed limit.

HTTP Status Code: 413

InternalServerException

This exception is thrown when an unexpected error occurs in the processing of a request.

HTTP Status Code: 500

InvalidParameterException

One or more parameters provided in the request are invalid.

message: Detailed error message describing which parameter is invalid and why.

HTTP Status Code: 400

ResourceNotFoundException

The requested resource could not be found.

message: Detailed error message describing which resource was not found.

HTTP Status Code: 404

ServiceQuotaExceededException

The request would exceed the service quota limit.

message: Detailed error message describing which quota was exceeded.

HTTP Status Code: 402

ThrottlingException

The request was throttled due to too many requests. Please slow down and try again.

message: Detailed error message describing the throttling condition.

HTTP Status Code: 429

ValidationException

The input fails to satisfy the constraints specified by the service.

fieldList: A list of specific failures encountered while validating the input. A member can appear in this list more than once if it failed to satisfy multiple constraints.
message: A summary of the validation failure.

HTTP Status Code: 400