Skip to content

Bedrock Agent Runtime  >  Structures  >  SessionState

SessionState

Structure Class

SessionState dataclass

Contains parameters that specify various attributes that persist across a session or prompt. You can define session state attributes as key-value pairs when writing a Lambda function for an action group or pass them when making an InvokeAgent request. Use session state attributes to control and provide conversational context for your agent and to help customize your agent's behavior. For more information, see Control session context.

Attributes

conversation_history class-attribute instance-attribute 
conversation_history: ConversationHistory | None = None

The state's conversation history.

files class-attribute instance-attribute 
files: list[InputFile] | None = None

Contains information about the files used by code interpreter.

invocation_id class-attribute instance-attribute 
invocation_id: str | None = None

The identifier of the invocation of an action. This value must match the invocationId returned in the InvokeAgent response for the action whose results are provided in the returnControlInvocationResults field. For more information, see Return control to the agent developer and Control session context.

knowledge_base_configurations class-attribute instance-attribute 
knowledge_base_configurations: list[KnowledgeBaseConfiguration] | None = None

An array of configurations, each of which applies to a knowledge base attached to the agent.

prompt_session_attributes class-attribute instance-attribute 
prompt_session_attributes: dict[str, str] | None = None

Contains attributes that persist across a prompt and the values of those attributes.

  • In orchestration prompt template, these attributes replace the $prompt_session_attributes$ placeholder variable. For more information, see Prompt template placeholder variables.

  • In multi-agent collaboration, the promptSessionAttributes will only be used by supervisor agent when $prompt_session_attributes$ is present in prompt template.

return_control_invocation_results class-attribute instance-attribute 
return_control_invocation_results: list[InvocationResultMember] | None = None

Contains information about the results from the action group invocation. For more information, see Return control to the agent developer and Control session context.

Note

If you include this field, the inputText field will be ignored.

session_attributes class-attribute instance-attribute 
session_attributes: dict[str, str] | None = None

Contains attributes that persist across a session and the values of those attributes. If sessionAttributes are passed to a supervisor agent in multi-agent collaboration, it will be forwarded to all agent collaborators.