AWS CLI Command Reference

[ aws . qconnect ]

list-spans

Description

Retrieves AI agent execution traces for a session, providing granular visibility into agent orchestration flows, LLM interactions, and tool invocations.

See also: AWS API Documentation

list-spans uses document type values. Document types follow the JSON data model where valid values are: strings, numbers, booleans, null, arrays, and objects. For command input, options and nested parameters that are labeled with the type document must be provided as JSON. Shorthand syntax does not support document types.

list-spans is a paginated operation. Multiple API calls may be issued in order to retrieve the entire data set of results. You can disable pagination by providing the --no-paginate argument. When using --output text and the --query argument on a paginated response, the --query argument must extract data from the results of the following query expressions: spans

Synopsis

  list-spans
--assistant-id <value>
--session-id <value>
[--cli-input-json | --cli-input-yaml]
[--starting-token <value>]
[--page-size <value>]
[--max-items <value>]
[--generate-cli-skeleton <value>]
[--debug]
[--endpoint-url <value>]
[--no-verify-ssl]
[--no-paginate]
[--output <value>]
[--query <value>]
[--profile <value>]
[--region <value>]
[--version <value>]
[--color <value>]
[--no-sign-request]
[--ca-bundle <value>]
[--cli-read-timeout <value>]
[--cli-connect-timeout <value>]
[--cli-binary-format <value>]
[--no-cli-pager]
[--cli-auto-prompt]
[--no-cli-auto-prompt]

Options

--assistant-id (string) [required]

UUID or ARN of the Connect AI Assistant resource

Constraints:

  • 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}

--session-id (string) [required]

UUID or ARN of the Connect AI Session resource

Constraints:

  • 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}

--cli-input-json | --cli-input-yaml (string) Reads arguments from the JSON string provided. The JSON string follows the format provided by --generate-cli-skeleton. If other arguments are provided on the command line, those values will override the JSON-provided values. It is not possible to pass arbitrary binary values using a JSON-provided value as the string will be taken literally. This may not be specified along with --cli-input-yaml.

--starting-token (string)

A token to specify where to start paginating. This is the NextToken from a previously truncated response.

For usage examples, see Pagination in the AWS Command Line Interface User Guide .

--page-size (integer)

The size of each page to get in the AWS service call. This does not affect the number of items returned in the command’s output. Setting a smaller page size results in more calls to the AWS service, retrieving fewer items in each call. This can help prevent the AWS service calls from timing out.

For usage examples, see Pagination in the AWS Command Line Interface User Guide .

--max-items (integer)

The total number of items to return in the command’s output. If the total number of items available is more than the value specified, a NextToken is provided in the command’s output. To resume pagination, provide the NextToken value in the starting-token argument of a subsequent command. Do not use the NextToken response element directly outside of the AWS CLI.

For usage examples, see Pagination in the AWS Command Line Interface User Guide .

--generate-cli-skeleton (string) Prints a JSON skeleton to standard output without sending an API request. If provided with no value or the value input, prints a sample input JSON that can be used as an argument for --cli-input-json. Similarly, if provided yaml-input it will print a sample input YAML that can be used with --cli-input-yaml. If provided with the value output, it validates the command inputs and returns a sample output JSON for that command. The generated JSON skeleton is not stable between versions of the AWS CLI and there are no backwards compatibility guarantees in the JSON skeleton generated.

Global Options

--debug (boolean)

Turn on debug logging.

--endpoint-url (string)

Override command’s default URL with the given URL.

--no-verify-ssl (boolean)

By default, the AWS CLI uses SSL when communicating with AWS services. For each SSL connection, the AWS CLI will verify SSL certificates. This option overrides the default behavior of verifying SSL certificates.

--no-paginate (boolean)

Disable automatic pagination. If automatic pagination is disabled, the AWS CLI will only make one call, for the first page of results.

--output (string)

The formatting style for command output.

  • json
  • text
  • table
  • yaml
  • yaml-stream

--query (string)

A JMESPath query to use in filtering the response data.

--profile (string)

Use a specific profile from your credential file.

--region (string)

The region to use. Overrides config/env settings.

--version (string)

Display the version of this tool.

--color (string)

Turn on/off color output.

  • on
  • off
  • auto

--no-sign-request (boolean)

Do not sign requests. Credentials will not be loaded if this argument is provided.

--ca-bundle (string)

The CA certificate bundle to use when verifying SSL certificates. Overrides config/env settings.

--cli-read-timeout (int)

The maximum socket read time in seconds. If the value is set to 0, the socket read will be blocking and not timeout. The default value is 60 seconds.

--cli-connect-timeout (int)

The maximum socket connect time in seconds. If the value is set to 0, the socket connect will be blocking and not timeout. The default value is 60 seconds.

--cli-binary-format (string)

The formatting style to be used for binary blobs. The default format is base64. The base64 format expects binary blobs to be provided as a base64 encoded string. The raw-in-base64-out format preserves compatibility with AWS CLI V1 behavior and binary values must be passed literally. When providing contents from a file that map to a binary blob fileb:// will always be treated as binary and use the file contents directly regardless of the cli-binary-format setting. When using file:// the file contents will need to properly formatted for the configured cli-binary-format.

  • base64
  • raw-in-base64-out

--no-cli-pager (boolean)

Disable cli pager for output.

--cli-auto-prompt (boolean)

Automatically prompt for CLI input parameters.

--no-cli-auto-prompt (boolean)

Disable automatically prompt for CLI input parameters.

Output

spans -> (list)

Array of span objects for the session

Constraints:

  • min: 0
  • max: 100

(structure)

A span represents a unit of work during AI agent execution, capturing timing, status, and contextual attributes.

spanId -> (string) [required]

Unique span identifier

Constraints:

  • pattern: [a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}

assistantId -> (string) [required]

UUID of the Connect AI Assistant resource

Constraints:

  • pattern: [a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}

sessionId -> (string) [required]

UUID of the Connect AI Session resource

Constraints:

  • pattern: [a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}

parentSpanId -> (string)

Parent span identifier for hierarchy. Null for root spans.

Constraints:

  • pattern: [a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}

spanName -> (string) [required]

Service-defined operation name

Constraints:

  • min: 1
  • max: 255
  • pattern: [a-zA-Z0-9\s_.,-]+.*

spanType -> (string) [required]

Operation relationship type

Possible values:

  • CLIENT
  • SERVER
  • INTERNAL

startTimestamp -> (timestamp) [required]

Operation start time in milliseconds since epoch

endTimestamp -> (timestamp) [required]

Operation end time in milliseconds since epoch

status -> (string) [required]

Span completion status

Possible values:

  • OK
  • ERROR
  • TIMEOUT

requestId -> (string) [required]

The service request ID that initiated the operation

Constraints:

  • pattern: [a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}

attributes -> (structure) [required]

Span-specific contextual attributes

operationName -> (string)

Action being performed

Constraints:

  • min: 1
  • max: 4096

providerName -> (string)

Model provider identifier (e.g., aws.bedrock)

Constraints:

  • min: 1
  • max: 4096

errorType -> (string)

Error classification if span failed (e.g., throttle, timeout)

Constraints:

  • min: 1
  • max: 4096

agentId -> (string)

Amazon Connect agent ID

Constraints:

  • pattern: [a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}

instanceArn -> (string)

Amazon Connect instance ARN

Constraints:

  • min: 1
  • max: 2048
  • pattern: arn:[a-z-]+?:[a-z-]+?:[a-z0-9-]*?:([0-9]{12})?:[a-zA-Z0-9-:/]+

contactId -> (string)

Amazon Connect contact identifier

Constraints:

  • pattern: [a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}

initialContactId -> (string)

Amazon Connect contact identifier

Constraints:

  • pattern: [a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}

sessionName -> (string)

Session name

Constraints:

  • min: 1
  • max: 4096

aiAgentArn -> (string)

AI agent ARN

Constraints:

  • pattern: 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}(:[A-Z0-9_$]+){0,1}

aiAgentType -> (string)

AI agent type

Possible values:

  • MANUAL_SEARCH
  • ANSWER_RECOMMENDATION
  • SELF_SERVICE
  • EMAIL_RESPONSE
  • EMAIL_OVERVIEW
  • EMAIL_GENERATIVE_ANSWER
  • ORCHESTRATION
  • NOTE_TAKING
  • CASE_SUMMARIZATION

aiAgentName -> (string)

AI agent name

Constraints:

  • min: 1
  • max: 255
  • pattern: [a-zA-Z0-9\s_.,-]+.*

aiAgentId -> (string)

AI agent identifier

Constraints:

  • pattern: [a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}

aiAgentVersion -> (integer)

AI agent version number

aiAgentInvoker -> (string)

Entity that invoked the AI agent

Constraints:

  • min: 1
  • max: 4096

aiAgentOrchestratorUseCase -> (string)

AI agent orchestrator use case

Constraints:

  • min: 1
  • max: 4096

requestModel -> (string)

LLM model ID for request (e.g., anthropic.claude-3-sonnet)

Constraints:

  • min: 1
  • max: 4096

requestMaxTokens -> (integer)

Maximum tokens configured for generation

temperature -> (float)

Sampling temperature for generation

Constraints:

  • min: 0.0
  • max: 1.0

topP -> (float)

Top-p sampling parameter for generation

Constraints:

  • min: 0.0
  • max: 1.0

responseModel -> (string)

Actual model used for response (usually matches requestModel)

Constraints:

  • min: 1
  • max: 4096

responseFinishReasons -> (list)

Generation termination reasons (e.g., stop, max_tokens)

Constraints:

  • min: 0
  • max: 10

(string)

Constraints:

  • min: 1
  • max: 4096

usageInputTokens -> (integer)

Number of input tokens in prompt

usageOutputTokens -> (integer)

Number of output tokens in response

usageTotalTokens -> (integer)

Total tokens consumed (input + output)

cacheReadInputTokens -> (integer)

Number of input tokens that were retrieved from cache

cacheWriteInputTokens -> (integer)

Number of input tokens that were written to cache in this request

inputMessages -> (list)

Input message collection sent to LLM

Constraints:

  • min: 0
  • max: 50

(structure)

A message in the conversation history with participant role and content values

messageId -> (string) [required]

Unique message identifier

Constraints:

  • pattern: [a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}

participant -> (string) [required]

Message source role

Possible values:

  • CUSTOMER
  • AGENT
  • BOT

timestamp -> (timestamp) [required]

Message timestamp

values -> (list) [required]

Message content values (text, tool use, tool result)

Constraints:

  • min: 1
  • max: 10

(tagged union structure)

Message content value - can be text, tool invocation, or tool result

Note

This is a Tagged Union structure. Only one of the following top level keys can be set: text, toolUse, toolResult.

text -> (structure)

Text message content

value -> (string) [required]

String content of the message text

Constraints:

  • min: 1
  • max: 4096

citations -> (list)

The citations associated with the span text.

(structure)

A citation that spans a specific range of text.

contentId -> (string)

The identifier of the content being cited in the span.

Constraints:

  • pattern: [a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}

title -> (string)

The title of the content being cited in the span.

knowledgeBaseId -> (string)

The identifier of the knowledge base containing the cited content.

Constraints:

  • pattern: [a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}

knowledgeBaseArn -> (string)

The Amazon Resource Name (ARN) of the knowledge base containing the cited content.

Constraints:

  • pattern: 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}

aiGuardrailAssessment -> (structure)

The AI Guardrail assessment for the span text.

blocked -> (boolean) [required]

Indicates whether the AI Guardrail blocked the content.

toolUse -> (structure)

Tool invocation message content

toolUseId -> (string) [required]

Unique ID for this tool invocation

Constraints:

  • pattern: [a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}

name -> (string) [required]

The tool name

Constraints:

  • min: 1
  • max: 255
  • pattern: [a-zA-Z0-9\s_.,-]+.*

arguments -> (document) [required]

The tool input arguments

toolResult -> (structure)

Tool result message content

toolUseId -> (string) [required]

Relates this result back to the tool invocation

Constraints:

  • pattern: [a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}

values -> (list) [required]

The tool results

Constraints:

  • min: 1
  • max: 10

(tagged union structure)

Message content value - can be text, tool invocation, or tool result

Note

This is a Tagged Union structure. Only one of the following top level keys can be set: text, toolUse, toolResult.

text -> (structure)

Text message content

value -> (string) [required]

String content of the message text

Constraints:

  • min: 1
  • max: 4096

citations -> (list)

The citations associated with the span text.

(structure)

A citation that spans a specific range of text.

contentId -> (string)

The identifier of the content being cited in the span.

Constraints:

  • pattern: [a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}

title -> (string)

The title of the content being cited in the span.

knowledgeBaseId -> (string)

The identifier of the knowledge base containing the cited content.

Constraints:

  • pattern: [a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}

knowledgeBaseArn -> (string)

The Amazon Resource Name (ARN) of the knowledge base containing the cited content.

Constraints:

  • pattern: 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}

aiGuardrailAssessment -> (structure)

The AI Guardrail assessment for the span text.

blocked -> (boolean) [required]

Indicates whether the AI Guardrail blocked the content.

toolUse -> (structure)

Tool invocation message content

toolUseId -> (string) [required]

Unique ID for this tool invocation

Constraints:

  • pattern: [a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}

name -> (string) [required]

The tool name

Constraints:

  • min: 1
  • max: 255
  • pattern: [a-zA-Z0-9\s_.,-]+.*

arguments -> (document) [required]

The tool input arguments

toolResult -> (structure)

Tool result message content

toolUseId -> (string) [required]

Relates this result back to the tool invocation

Constraints:

  • pattern: [a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}

error -> (string)

The tool invocation error if failed

Constraints:

  • min: 1
  • max: 4096

error -> (string)

The tool invocation error if failed

Constraints:

  • min: 1
  • max: 4096

outputMessages -> (list)

Output message collection received from LLM

Constraints:

  • min: 0
  • max: 50

(structure)

A message in the conversation history with participant role and content values

messageId -> (string) [required]

Unique message identifier

Constraints:

  • pattern: [a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}

participant -> (string) [required]

Message source role

Possible values:

  • CUSTOMER
  • AGENT
  • BOT

timestamp -> (timestamp) [required]

Message timestamp

values -> (list) [required]

Message content values (text, tool use, tool result)

Constraints:

  • min: 1
  • max: 10

(tagged union structure)

Message content value - can be text, tool invocation, or tool result

Note

This is a Tagged Union structure. Only one of the following top level keys can be set: text, toolUse, toolResult.

text -> (structure)

Text message content

value -> (string) [required]

String content of the message text

Constraints:

  • min: 1
  • max: 4096

citations -> (list)

The citations associated with the span text.

(structure)

A citation that spans a specific range of text.

contentId -> (string)

The identifier of the content being cited in the span.

Constraints:

  • pattern: [a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}

title -> (string)

The title of the content being cited in the span.

knowledgeBaseId -> (string)

The identifier of the knowledge base containing the cited content.

Constraints:

  • pattern: [a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}

knowledgeBaseArn -> (string)

The Amazon Resource Name (ARN) of the knowledge base containing the cited content.

Constraints:

  • pattern: 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}

aiGuardrailAssessment -> (structure)

The AI Guardrail assessment for the span text.

blocked -> (boolean) [required]

Indicates whether the AI Guardrail blocked the content.

toolUse -> (structure)

Tool invocation message content

toolUseId -> (string) [required]

Unique ID for this tool invocation

Constraints:

  • pattern: [a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}

name -> (string) [required]

The tool name

Constraints:

  • min: 1
  • max: 255
  • pattern: [a-zA-Z0-9\s_.,-]+.*

arguments -> (document) [required]

The tool input arguments

toolResult -> (structure)

Tool result message content

toolUseId -> (string) [required]

Relates this result back to the tool invocation

Constraints:

  • pattern: [a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}

values -> (list) [required]

The tool results

Constraints:

  • min: 1
  • max: 10

(tagged union structure)

Message content value - can be text, tool invocation, or tool result

Note

This is a Tagged Union structure. Only one of the following top level keys can be set: text, toolUse, toolResult.

text -> (structure)

Text message content

value -> (string) [required]

String content of the message text

Constraints:

  • min: 1
  • max: 4096

citations -> (list)

The citations associated with the span text.

(structure)

A citation that spans a specific range of text.

contentId -> (string)

The identifier of the content being cited in the span.

Constraints:

  • pattern: [a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}

title -> (string)

The title of the content being cited in the span.

knowledgeBaseId -> (string)

The identifier of the knowledge base containing the cited content.

Constraints:

  • pattern: [a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}

knowledgeBaseArn -> (string)

The Amazon Resource Name (ARN) of the knowledge base containing the cited content.

Constraints:

  • pattern: 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}

aiGuardrailAssessment -> (structure)

The AI Guardrail assessment for the span text.

blocked -> (boolean) [required]

Indicates whether the AI Guardrail blocked the content.

toolUse -> (structure)

Tool invocation message content

toolUseId -> (string) [required]

Unique ID for this tool invocation

Constraints:

  • pattern: [a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}

name -> (string) [required]

The tool name

Constraints:

  • min: 1
  • max: 255
  • pattern: [a-zA-Z0-9\s_.,-]+.*

arguments -> (document) [required]

The tool input arguments

toolResult -> (structure)

Tool result message content

toolUseId -> (string) [required]

Relates this result back to the tool invocation

Constraints:

  • pattern: [a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}

error -> (string)

The tool invocation error if failed

Constraints:

  • min: 1
  • max: 4096

error -> (string)

The tool invocation error if failed

Constraints:

  • min: 1
  • max: 4096

systemInstructions -> (list)

System prompt instructions

Constraints:

  • min: 1
  • max: 10

(tagged union structure)

Message content value - can be text, tool invocation, or tool result

Note

This is a Tagged Union structure. Only one of the following top level keys can be set: text, toolUse, toolResult.

text -> (structure)

Text message content

value -> (string) [required]

String content of the message text

Constraints:

  • min: 1
  • max: 4096

citations -> (list)

The citations associated with the span text.

(structure)

A citation that spans a specific range of text.

contentId -> (string)

The identifier of the content being cited in the span.

Constraints:

  • pattern: [a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}

title -> (string)

The title of the content being cited in the span.

knowledgeBaseId -> (string)

The identifier of the knowledge base containing the cited content.

Constraints:

  • pattern: [a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}

knowledgeBaseArn -> (string)

The Amazon Resource Name (ARN) of the knowledge base containing the cited content.

Constraints:

  • pattern: 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}

aiGuardrailAssessment -> (structure)

The AI Guardrail assessment for the span text.

blocked -> (boolean) [required]

Indicates whether the AI Guardrail blocked the content.

toolUse -> (structure)

Tool invocation message content

toolUseId -> (string) [required]

Unique ID for this tool invocation

Constraints:

  • pattern: [a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}

name -> (string) [required]

The tool name

Constraints:

  • min: 1
  • max: 255
  • pattern: [a-zA-Z0-9\s_.,-]+.*

arguments -> (document) [required]

The tool input arguments

toolResult -> (structure)

Tool result message content

toolUseId -> (string) [required]

Relates this result back to the tool invocation

Constraints:

  • pattern: [a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}

values -> (list) [required]

The tool results

Constraints:

  • min: 1
  • max: 10

(tagged union structure)

Message content value - can be text, tool invocation, or tool result

Note

This is a Tagged Union structure. Only one of the following top level keys can be set: text, toolUse, toolResult.

text -> (structure)

Text message content

value -> (string) [required]

String content of the message text

Constraints:

  • min: 1
  • max: 4096

citations -> (list)

The citations associated with the span text.

(structure)

A citation that spans a specific range of text.

contentId -> (string)

The identifier of the content being cited in the span.

Constraints:

  • pattern: [a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}

title -> (string)

The title of the content being cited in the span.

knowledgeBaseId -> (string)

The identifier of the knowledge base containing the cited content.

Constraints:

  • pattern: [a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}

knowledgeBaseArn -> (string)

The Amazon Resource Name (ARN) of the knowledge base containing the cited content.

Constraints:

  • pattern: 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}

aiGuardrailAssessment -> (structure)

The AI Guardrail assessment for the span text.

blocked -> (boolean) [required]

Indicates whether the AI Guardrail blocked the content.

toolUse -> (structure)

Tool invocation message content

toolUseId -> (string) [required]

Unique ID for this tool invocation

Constraints:

  • pattern: [a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}

name -> (string) [required]

The tool name

Constraints:

  • min: 1
  • max: 255
  • pattern: [a-zA-Z0-9\s_.,-]+.*

arguments -> (document) [required]

The tool input arguments

toolResult -> (structure)

Tool result message content

toolUseId -> (string) [required]

Relates this result back to the tool invocation

Constraints:

  • pattern: [a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}

error -> (string)

The tool invocation error if failed

Constraints:

  • min: 1
  • max: 4096

error -> (string)

The tool invocation error if failed

Constraints:

  • min: 1
  • max: 4096

promptArn -> (string)

AI prompt ARN

Constraints:

  • pattern: 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}(:[A-Z0-9_$]+){0,1}

promptId -> (string)

AI prompt identifier

Constraints:

  • pattern: [a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}

promptType -> (string)

AI prompt type

Possible values:

  • ANSWER_GENERATION
  • INTENT_LABELING_GENERATION
  • QUERY_REFORMULATION
  • SELF_SERVICE_PRE_PROCESSING
  • SELF_SERVICE_ANSWER_GENERATION
  • EMAIL_RESPONSE
  • EMAIL_OVERVIEW
  • EMAIL_GENERATIVE_ANSWER
  • EMAIL_QUERY_REFORMULATION
  • ORCHESTRATION
  • NOTE_TAKING
  • CASE_SUMMARIZATION

promptName -> (string)

AI prompt name

Constraints:

  • min: 1
  • max: 255
  • pattern: [a-zA-Z0-9\s_.,-]+.*

promptVersion -> (integer)

AI prompt version number

nextToken -> (string)

Pagination token for retrieving additional results

Constraints:

  • min: 1
  • max: 2048
© Copyright 2025, Amazon Web Services. Created using Sphinx.