AgentsforBedrockRuntime / Client / get_session

get_session¶

AgentsforBedrockRuntime.Client.get_session(**kwargs)¶

Retrieves details about a specific session. For more information about sessions, see Store and retrieve conversation history and context with Amazon Bedrock sessions.

Request Syntax

response = client.get_session(
    sessionIdentifier='string'
)

Parameters:

sessionIdentifier (string) –

[REQUIRED]

A unique identifier for the session to retrieve. You can specify either the session’s sessionId or its Amazon Resource Name (ARN).

Return type:

dict

Returns:

Response Syntax

{
    'sessionId': 'string',
    'sessionArn': 'string',
    'sessionStatus': 'ACTIVE'|'EXPIRED'|'ENDED',
    'createdAt': datetime(2015, 1, 1),
    'lastUpdatedAt': datetime(2015, 1, 1),
    'sessionMetadata': {
        'string': 'string'
    },
    'encryptionKeyArn': 'string'
}

Response Structure

(dict) –
- sessionId (string) –
  
  The unique identifier for the session in UUID format.
- sessionArn (string) –
  
  The Amazon Resource Name (ARN) of the session.
- sessionStatus (string) –
  
  The current status of the session.
- createdAt (datetime) –
  
  The timestamp for when the session was created.
- lastUpdatedAt (datetime) –
  
  The timestamp for when the session was last modified.
- sessionMetadata (dict) –
  
  A map of key-value pairs containing attributes persisted across the session.
  - (string) –
    - (string) –
- encryptionKeyArn (string) –
  
  The Amazon Resource Name (ARN) of the Key Management Service key used to encrypt the session data. For more information, see Amazon Bedrock session encryption.

Exceptions

AgentsforBedrockRuntime.Client.exceptions.ResourceNotFoundException
AgentsforBedrockRuntime.Client.exceptions.ValidationException
AgentsforBedrockRuntime.Client.exceptions.InternalServerException
AgentsforBedrockRuntime.Client.exceptions.ThrottlingException
AgentsforBedrockRuntime.Client.exceptions.AccessDeniedException