ListSpans
Retrieves AI agent execution traces for a session, providing granular visibility into agent orchestration flows, LLM interactions, and tool invocations.
Request Syntax
GET /assistants/assistantId/sessions/sessionId/spans?maxResults=maxResults&nextToken=nextToken HTTP/1.1
URI Request Parameters
The request uses the following URI parameters.
- assistantId
-
UUID or ARN of the Connect AI Assistant resource
Pattern:
[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}$|^arn:[a-z-]*?:wisdom:[a-z0-9-]*?:[0-9]{12}:[a-z-]*?/[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}(?:/[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}){0,2}Required: Yes
- maxResults
-
Maximum number of spans to return per page
Valid Range: Minimum value of 1. Maximum value of 100.
- nextToken
-
Pagination token for retrieving the next page of results
Length Constraints: Minimum length of 1. Maximum length of 2048.
- sessionId
-
UUID or ARN of the Connect AI Session resource
Pattern:
[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}$|^arn:[a-z-]*?:wisdom:[a-z0-9-]*?:[0-9]{12}:[a-z-]*?/[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}(?:/[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}){0,2}Required: Yes
Request Body
The request does not have a request body.
Response Syntax
HTTP/1.1 200
Content-type: application/json
{
"nextToken": "string",
"spans": [
{
"assistantId": "string",
"attributes": {
"agentId": "string",
"aiAgentArn": "string",
"aiAgentId": "string",
"aiAgentInvoker": "string",
"aiAgentName": "string",
"aiAgentOrchestratorUseCase": "string",
"aiAgentType": "string",
"aiAgentVersion": number,
"cacheReadInputTokens": number,
"cacheWriteInputTokens": number,
"contactId": "string",
"errorType": "string",
"initialContactId": "string",
"inputMessages": [
{
"messageId": "string",
"participant": "string",
"timestamp": number,
"values": [
{ ... }
]
}
],
"instanceArn": "string",
"operationName": "string",
"outputMessages": [
{
"messageId": "string",
"participant": "string",
"timestamp": number,
"values": [
{ ... }
]
}
],
"promptArn": "string",
"promptId": "string",
"promptName": "string",
"promptType": "string",
"promptVersion": number,
"providerName": "string",
"requestMaxTokens": number,
"requestModel": "string",
"responseFinishReasons": [ "string" ],
"responseModel": "string",
"sessionName": "string",
"systemInstructions": [
{ ... }
],
"temperature": number,
"topP": number,
"usageInputTokens": number,
"usageOutputTokens": number,
"usageTotalTokens": number
},
"endTimestamp": number,
"parentSpanId": "string",
"requestId": "string",
"sessionId": "string",
"spanId": "string",
"spanName": "string",
"spanType": "string",
"startTimestamp": number,
"status": "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.
Errors
For information about the errors that are common to all actions, see Common Errors.
- AccessDeniedException
-
You do not have sufficient access to perform this action.
HTTP Status Code: 403
- ResourceNotFoundException
-
The specified resource does not exist.
- resourceName
-
The specified resource name.
HTTP Status Code: 404
- ValidationException
-
The input fails to satisfy the constraints specified by a service.
HTTP Status Code: 400
See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following: