ai_prompt_versions

Creates, updates, deletes, gets or lists an ai_prompt_versions resource.

Overview

Name	ai_prompt_versions
Type	Resource
Id	aws.qconnect.ai_prompt_versions

Fields

The following fields are returned by SELECT queries:

list_ai_prompt_versions

Name	Datatype	Description
ai_prompt_summary	object	The summary of the AI Prompt.
version_number	integer (int64)	The version number for this AI Prompt version.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
list_ai_prompt_versions	select	assistant_id, ai_prompt_id, region	nextToken, maxResults, origin	Lists AI Prompt versions.
create_ai_prompt_version	insert	assistant_id, ai_prompt_id, region		Creates an Amazon Q in Connect AI Prompt version.
delete_ai_prompt_version	delete	assistant_id, ai_prompt_id, version_number, region		Delete and Amazon Q in Connect AI Prompt version.

Parameters

Parameters can be passed in the WHERE clause of a query. Check the Methods section to see which parameters are required or optional for each operation.

Name	Datatype	Description
ai_prompt_id	string	The identifier of the Amazon Q in Connect AI prompt.
assistant_id	string	The identifier of the Amazon Q in Connect assistant. Can be either the ID or the ARN. URLs cannot contain the ARN.
region	string	AWS region (default: us-east-1)
version_number	integer (int64)	The version number of the AI Prompt version to be deleted.
maxResults	integer	The maximum number of results to return per page.
nextToken	string	The token for the next set of results. Use the value returned in the previous response in the next request to retrieve the next set of results.
origin	string	The origin of the AI Prompt versions to be listed. SYSTEM for a default AI Agent created by Q in Connect or CUSTOMER for an AI Agent created by calling AI Agent creation APIs.

SELECT examples

list_ai_prompt_versions

Lists AI Prompt versions.

SELECT
ai_prompt_summary,
version_number
FROM aws.qconnect.ai_prompt_versions
WHERE assistant_id = '{{ assistant_id }}' -- required
AND ai_prompt_id = '{{ ai_prompt_id }}' -- required
AND region = '{{ region }}' -- required
AND nextToken = '{{ nextToken }}'
AND maxResults = '{{ maxResults }}'
AND origin = '{{ origin }}'
;

INSERT examples

create_ai_prompt_version

Creates an Amazon Q in Connect AI Prompt version.

INSERT INTO aws.qconnect.ai_prompt_versions (
modifiedTime,
clientToken,
assistant_id,
ai_prompt_id,
region
)
SELECT 
'{{ modifiedTime }}',
'{{ clientToken }}',
'{{ assistant_id }}',
'{{ ai_prompt_id }}',
'{{ region }}'
RETURNING
ai_prompt,
version_number
;

Manifest

# Description fields are for documentation purposes
- name: ai_prompt_versions
props:
  - name: assistant_id
    value: "{{ assistant_id }}"
    description: Required parameter for the ai_prompt_versions resource.
  - name: ai_prompt_id
    value: "{{ ai_prompt_id }}"
    description: Required parameter for the ai_prompt_versions resource.
  - name: region
    value: "{{ region }}"
    description: Required parameter for the ai_prompt_versions resource.
  - name: modifiedTime
    value: "{{ modifiedTime }}"
  - name: clientToken
    value: "{{ clientToken }}"

DELETE examples

delete_ai_prompt_version

Delete and Amazon Q in Connect AI Prompt version.

DELETE FROM aws.qconnect.ai_prompt_versions
WHERE assistant_id = '{{ assistant_id }}' --required
AND ai_prompt_id = '{{ ai_prompt_id }}' --required
AND version_number = '{{ version_number }}' --required
AND region = '{{ region }}' --required
;