Request Syntax URI Request Parameters Request Body Response Syntax Response Elements Errors See Also

ListAIPrompts

Lists the AI Prompts available on the Amazon Q in Connect assistant.

Request Syntax


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

URI Request Parameters

The request uses the following URI parameters.

assistantId

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

The maximum number of results to return per page.

Valid Range: Minimum value of 1. Maximum value of 100.

nextToken

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

The origin of the AI Prompts 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

{
   "aiPromptSummaries": [ 
      { 
         "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"
      }
   ],
   "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.

aiPromptSummaries

The summaries of the AI Prompts.

Type: Array of AIPromptSummary objects

nextToken

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.

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: 400

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