Skip to content

CreateSessionRequest

Source code in docs_src/capo_bedrock_agent_runtime/types/create_session_request.py
class CreateSessionRequest(TypedDict, closed=True):
    session_metadata: NotRequired[
        "capo_bedrock_agent_runtime.types.session_metadata_map.SessionMetadataMap"
    ]
    """<p>A map of key-value pairs containing attributes to be persisted across the session. For example, the user's ID, their language preference, and the type of device they are using.</p>"""
    encryption_key_arn: NotRequired[
        "capo_bedrock_agent_runtime.types.kms_key_arn.KmsKeyArn"
    ]
    """<p>The Amazon Resource Name (ARN) of the KMS key to use to encrypt the session data. The user or role creating the session must have permission to use the key. For more information, see <a href="https://docs.aws.amazon.com/bedrock/latest/userguide/session-encryption.html">Amazon Bedrock session encryption</a>. </p>"""
    tags: NotRequired["capo_bedrock_agent_runtime.types.tags_map.TagsMap"]
    """<p>Specify the key-value pairs for the tags that you want to attach to the session.</p>"""

encryption_key_arn instance-attribute

encryption_key_arn: NotRequired[KmsKeyArn]

The Amazon Resource Name (ARN) of the KMS key to use to encrypt the session data. The user or role creating the session must have permission to use the key. For more information, see Amazon Bedrock session encryption.

session_metadata instance-attribute

session_metadata: NotRequired[SessionMetadataMap]

A map of key-value pairs containing attributes to be persisted across the session. For example, the user's ID, their language preference, and the type of device they are using.

tags instance-attribute

tags: NotRequired[TagsMap]

Specify the key-value pairs for the tags that you want to attach to the session.