DevOpsAgentService / Client / update_chat

update_chat

DevOpsAgentService.Client.update_chat(**kwargs)

Updates a chat execution. You can use this operation to change the chat execution’s summary or to archive or unarchive it.

Archiving a chat execution hides it from the default chat list. Unarchiving a chat execution restores it to the default chat list.

See also: AWS API Documentation

Request Syntax

response = client.update_chat(
    agentSpaceId='string',
    executionId='string',
    summary='string',
    archiveStatus='ACTIVE'|'ARCHIVED',
    clientToken='string'
)
Parameters:
  • agentSpaceId (string) –

    [REQUIRED]

    The unique identifier of the agent space that contains the chat execution to update.

  • executionId (string) –

    [REQUIRED]

    The unique identifier of the chat execution to update.

  • summary (string) – The new summary to set for the chat execution.

  • archiveStatus (string) – The archive status to set for the chat execution. Use this parameter to archive the chat execution, hiding it from the default chat list, or to unarchive it, restoring it to the default chat list.

  • clientToken (string) –

    A unique, case-sensitive identifier to ensure that the operation completes no more than one time. If this token matches a previous request, the service ignores the request, but does not return an error.

    This field is autopopulated if not provided.

Return type:

dict

Returns:

Response Syntax

{
    'executionId': 'string',
    'summary': 'string',
    'updatedAt': datetime(2015, 1, 1),
    'archiveStatus': 'ACTIVE'|'ARCHIVED'
}

Response Structure

  • (dict) –

    • executionId (string) –

      The unique identifier of the updated chat execution.

    • summary (string) –

      The summary of the chat execution after the update.

    • updatedAt (datetime) –

      The date and time at which the chat execution was last updated.

    • archiveStatus (string) –

      The archive status of the chat execution after the update.

Exceptions