HealthLake / Client / update_profile_with_agent

update_profile_with_agent

HealthLake.Client.update_profile_with_agent(**kwargs)

Updates a data transformation profile using chat-based interaction with an agent. Supports multi-turn conversations for iteratively customizing profiles.

See also: AWS API Documentation

Request Syntax

response = client.update_profile_with_agent(
    ProfileId='string',
    SourceFormat='CCDA'|'CSV',
    InputMessage={
        'Body': 'string',
        'Type': 'normal'|'confirmation_response'
    },
    ConversationId='string'
)
Parameters:

  • ProfileId (string) –

    [REQUIRED]

    The unique identifier of the profile to update via the agent.

  • SourceFormat (string) –

    [REQUIRED]

    The source data format for the transformation.

  • InputMessage (dict) –

    [REQUIRED]

    The message to send to the agent.

    • Body (string) – [REQUIRED]

      The text of your message to the agent.

    • Type (string) – [REQUIRED]

      The type of input message, which determines how the agent processes your request. Valid values:

      • normal: A regular message to the agent.

      • confirmation_response: A response to a confirmation request from the agent.

  • ConversationId (string) – The conversation identifier for multi-turn interactions. Omit to start a new conversation.

Return type:

dict

Returns:

Response Syntax

{
    'AgentResponse': {
        'Body': 'string',
        'Type': 'INITIAL_GREETING'|'normal'|'confirmation'|'complete'|'error'|'options'|'choices',
        'OptionsList': [
            'string',
        ]
    },
    'ConversationId': 'string'
}

Response Structure

  • (dict) –

    The response from the UpdateProfileWithAgent operation.

    • AgentResponse (dict) –

      The response message from the agent.

      • Body (string) –

        The text of the agent’s response.

      • Type (string) –

        The type of output message, which indicates how to interpret the agent’s response.

      • OptionsList (list) –

        A list of selectable options presented when the response type is options.

        • (string) –

    • ConversationId (string) –

      The conversation identifier to use for follow-up messages in this conversation.

Exceptions