# ListAIPromptVersions


Lists AI Prompt versions.

## Request Syntax


```
GET /assistants/assistantId/aiprompts/aiPromptId/versions?maxResults=maxResults&nextToken=nextToken&origin=origin HTTP/1.1
```

## URI Request Parameters


The request uses the following URI parameters.

 ** [aiPromptId](#API_amazon-q-connect_ListAIPromptVersions_RequestSyntax) **   <a name="connect-amazon-q-connect_ListAIPromptVersions-request-uri-aiPromptId"></a>
The identifier of the Amazon Q in Connect AI prompt for which versions are to be listed.  
Pattern: `[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}(:[A-Z0-9_$]+){0,1}$|^arn:[a-z-]*?:wisdom:[a-z0-9-]*?:[0-9]{12}:[a-z-]*?/[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}(?:/[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}){0,2}(:[A-Z0-9_$]+){0,1}`   
Required: Yes

 ** [assistantId](#API_amazon-q-connect_ListAIPromptVersions_RequestSyntax) **   <a name="connect-amazon-q-connect_ListAIPromptVersions-request-uri-assistantId"></a>
The identifier of the Amazon Q in Connect assistant. Can be either the ID or the ARN. URLs cannot contain the ARN.  
Pattern: `[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}$|^arn:[a-z-]*?:wisdom:[a-z0-9-]*?:[0-9]{12}:[a-z-]*?/[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}(?:/[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}){0,2}`   
Required: Yes

 ** [maxResults](#API_amazon-q-connect_ListAIPromptVersions_RequestSyntax) **   <a name="connect-amazon-q-connect_ListAIPromptVersions-request-uri-maxResults"></a>
The maximum number of results to return per page.  
Valid Range: Minimum value of 1. Maximum value of 100.

 ** [nextToken](#API_amazon-q-connect_ListAIPromptVersions_RequestSyntax) **   <a name="connect-amazon-q-connect_ListAIPromptVersions-request-uri-nextToken"></a>
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.  
Length Constraints: Minimum length of 1. Maximum length of 2048.

 ** [origin](#API_amazon-q-connect_ListAIPromptVersions_RequestSyntax) **   <a name="connect-amazon-q-connect_ListAIPromptVersions-request-uri-origin"></a>
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.   
Valid Values: `SYSTEM | CUSTOMER` 

## Request Body


The request does not have a request body.

## Response Syntax


```
HTTP/1.1 200
Content-type: application/json

{
   "aiPromptVersionSummaries": [ 
      { 
         "aiPromptSummary": { 
            "aiPromptArn": "string",
            "aiPromptId": "string",
            "apiFormat": "string",
            "assistantArn": "string",
            "assistantId": "string",
            "description": "string",
            "modelId": "string",
            "modifiedTime": number,
            "name": "string",
            "origin": "string",
            "status": "string",
            "tags": { 
               "string" : "string" 
            },
            "templateType": "string",
            "type": "string",
            "visibilityStatus": "string"
         },
         "versionNumber": number
      }
   ],
   "nextToken": "string"
}
```

## Response Elements


If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

 ** [aiPromptVersionSummaries](#API_amazon-q-connect_ListAIPromptVersions_ResponseSyntax) **   <a name="connect-amazon-q-connect_ListAIPromptVersions-response-aiPromptVersionSummaries"></a>
The summaries of the AI Prompt versions.  
Type: Array of [AIPromptVersionSummary](API_amazon-q-connect_AIPromptVersionSummary.md) objects

 ** [nextToken](#API_amazon-q-connect_ListAIPromptVersions_ResponseSyntax) **   <a name="connect-amazon-q-connect_ListAIPromptVersions-response-nextToken"></a>
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.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 2048.

## Errors


For information about the errors that are common to all actions, see [Common Errors](CommonErrors.md).

 ** AccessDeniedException **   
You do not have sufficient access to perform this action.  
HTTP Status Code: 403

 ** ResourceNotFoundException **   
The specified resource does not exist.    
 ** resourceName **   
The specified resource name.
HTTP Status Code: 404

 ** ThrottlingException **   
The throttling limit has been exceeded.  
HTTP Status Code: 429

 ** UnauthorizedException **   
You do not have permission to perform this action.  
HTTP Status Code: 401

 ** ValidationException **   
The input fails to satisfy the constraints specified by a service.  
HTTP Status Code: 400

## See Also


For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/qconnect-2020-10-19/ListAIPromptVersions) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/qconnect-2020-10-19/ListAIPromptVersions) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/qconnect-2020-10-19/ListAIPromptVersions) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/qconnect-2020-10-19/ListAIPromptVersions) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/qconnect-2020-10-19/ListAIPromptVersions) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/qconnect-2020-10-19/ListAIPromptVersions) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/qconnect-2020-10-19/ListAIPromptVersions) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/qconnect-2020-10-19/ListAIPromptVersions) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/qconnect-2020-10-19/ListAIPromptVersions) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/qconnect-2020-10-19/ListAIPromptVersions)