QConnect / Client / update_session_data

update_session_data#

QConnect.Client.update_session_data(**kwargs)#

Updates the data stored on an Amazon Q in Connect Session.

See also: AWS API Documentation

Request Syntax

response = client.update_session_data(
    assistantId='string',
    data=[
        {
            'key': 'string',
            'value': {
                'stringValue': 'string'
            }
        },
    ],
    namespace='Custom',
    sessionId='string'
)
Parameters:

  • assistantId (string) –

    [REQUIRED]

    The identifier of the Amazon Q in Connect assistant. Can be either the ID or the ARN. URLs cannot contain the ARN.

  • data (list) –

    [REQUIRED]

    The data stored on the Amazon Q in Connect Session.

    • (dict) –

      The list of key-value pairs that are stored on the session.

      • key (string) – [REQUIRED]

        The key of the data stored on the session.

      • value (dict) – [REQUIRED]

        The value of the data stored on the session.

        Note

        This is a Tagged Union structure. Only one of the following top level keys can be set: stringValue.

        • stringValue (string) –

          The string value of the data stored on the session.

  • namespace (string) – The namespace into which the session data is stored. Supported namespaces are: Custom

  • sessionId (string) –

    [REQUIRED]

    The identifier of the session. Can be either the ID or the ARN. URLs cannot contain the ARN.

Return type:

dict

Returns:

Response Syntax

{
    'data': [
        {
            'key': 'string',
            'value': {
                'stringValue': 'string'
            }
        },
    ],
    'namespace': 'Custom',
    'sessionArn': 'string',
    'sessionId': 'string'
}

Response Structure

  • (dict) –

    • data (list) –

      Data stored in the session.

      • (dict) –

        The list of key-value pairs that are stored on the session.

        • key (string) –

          The key of the data stored on the session.

        • value (dict) –

          The value of the data stored on the session.

          Note

          This is a Tagged Union structure. Only one of the following top level keys will be set: stringValue. If a client receives an unknown member it will set SDK_UNKNOWN_MEMBER as the top level key, which maps to the name or tag of the unknown member. The structure of SDK_UNKNOWN_MEMBER is as follows:

          'SDK_UNKNOWN_MEMBER': {'name': 'UnknownMemberName'}

          • stringValue (string) –

            The string value of the data stored on the session.

    • namespace (string) –

      The namespace into which the session data is stored. Supported namespaces are: Custom

    • sessionArn (string) –

      The Amazon Resource Name (ARN) of the session.

    • sessionId (string) –

      The identifier of the session.

Exceptions