BedrockAgentCore / Client / list_sessions

list_sessions¶

BedrockAgentCore.Client.list_sessions(**kwargs)¶

Lists sessions in an AgentCore Memory resource based on specified criteria. We recommend using pagination to ensure that the operation returns quickly and successfully.

To use this operation, you must have the bedrock-agentcore:ListSessions permission.

Request Syntax

response = client.list_sessions(
    memoryId='string',
    actorId='string',
    maxResults=123,
    nextToken='string'
)

Parameters:

memoryId (string) –
[REQUIRED]

The identifier of the AgentCore Memory resource for which to list sessions.
actorId (string) –
[REQUIRED]

The identifier of the actor for which to list sessions.
maxResults (integer) – The maximum number of results to return in a single call. The default value is 20.
nextToken (string) – The token for the next set of results. Use the value returned in the previous response in the next request to retrieve the next set of results.

Return type:

dict

Returns:

Response Syntax

{
    'sessionSummaries': [
        {
            'sessionId': 'string',
            'actorId': 'string',
            'createdAt': datetime(2015, 1, 1)
        },
    ],
    'nextToken': 'string'
}

Response Structure

(dict) –
- sessionSummaries (list) –
  
  The list of session summaries that match the specified criteria.
  - (dict) –
    
    Contains summary information about a session in an AgentCore Memory resource.
    - sessionId (string) –
      
      The unique identifier of the session.
    - actorId (string) –
      
      The identifier of the actor associated with the session.
    - createdAt (datetime) –
      
      The timestamp when the session was created.
- nextToken (string) –
  
  The token to use in a subsequent request to get the next set of results. This value is null when there are no more results to return.

Exceptions

BedrockAgentCore.Client.exceptions.ServiceQuotaExceededException
BedrockAgentCore.Client.exceptions.ThrottledException
BedrockAgentCore.Client.exceptions.ServiceException
BedrockAgentCore.Client.exceptions.AccessDeniedException
BedrockAgentCore.Client.exceptions.ValidationException
BedrockAgentCore.Client.exceptions.InvalidInputException
BedrockAgentCore.Client.exceptions.ResourceNotFoundException