BedrockAgentCoreControl / Client / list_memories

list_memories¶

BedrockAgentCoreControl.Client.list_memories(**kwargs)¶

Lists the available Amazon Bedrock AgentCore Memory resources in the current Amazon Web Services Region.

Request Syntax

response = client.list_memories(
    maxResults=123,
    nextToken='string'
)

Parameters:

maxResults (integer) – The maximum number of results to return in a single call. The default value is 10. The maximum value is 50.
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

{
    'memories': [
        {
            'arn': 'string',
            'id': 'string',
            'status': 'CREATING'|'ACTIVE'|'FAILED'|'DELETING',
            'createdAt': datetime(2015, 1, 1),
            'updatedAt': datetime(2015, 1, 1)
        },
    ],
    'nextToken': 'string'
}

Response Structure

(dict) –
- memories (list) –
  
  The list of AgentCore Memory resource summaries.
  - (dict) –
    
    Contains summary information about a memory resource.
    - arn (string) –
      
      The Amazon Resource Name (ARN) of the memory.
    - id (string) –
      
      The unique identifier of the memory.
    - status (string) –
      
      The current status of the memory.
    - createdAt (datetime) –
      
      The timestamp when the memory was created.
    - updatedAt (datetime) –
      
      The timestamp when the memory was last updated.
- nextToken (string) –
  
  A token to retrieve the next page of results.

Exceptions

BedrockAgentCoreControl.Client.exceptions.ServiceException
BedrockAgentCoreControl.Client.exceptions.AccessDeniedException
BedrockAgentCoreControl.Client.exceptions.ValidationException
BedrockAgentCoreControl.Client.exceptions.ResourceNotFoundException
BedrockAgentCoreControl.Client.exceptions.ThrottledException