:doc:`QConnect <../../qconnect>` / Paginator / ListAIPromptVersions

********************
ListAIPromptVersions
********************



.. py:class:: QConnect.Paginator.ListAIPromptVersions

  ::

    
    paginator = client.get_paginator('list_ai_prompt_versions')

  
  

  .. py:method:: paginate(**kwargs)

    Creates an iterator that will paginate through responses from :py:meth:`QConnect.Client.list_ai_prompt_versions`.

    See also: `AWS API Documentation <https://docs.aws.amazon.com/goto/WebAPI/qconnect-2020-10-19/ListAIPromptVersions>`_    


    **Request Syntax**
    ::

      response_iterator = paginator.paginate(
          assistantId='string',
          aiPromptId='string',
          origin='SYSTEM'|'CUSTOMER',
          PaginationConfig={
              'MaxItems': 123,
              'PageSize': 123,
              'StartingToken': 'string'
          }
      )
      
    :type assistantId: string
    :param assistantId: **[REQUIRED]** 

      The identifier of the Amazon Q in Connect assistant. Can be either the ID or the ARN. URLs cannot contain the ARN.

      

    
    :type aiPromptId: string
    :param aiPromptId: **[REQUIRED]** 

      The identifier of the Amazon Q in Connect AI prompt for which versions are to be listed.

      

    
    :type origin: string
    :param origin: 

      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.

      

    
    :type PaginationConfig: dict
    :param PaginationConfig: 

      A dictionary that provides parameters to control pagination.

      

    
      - **MaxItems** *(integer) --* 

        The total number of items to return. If the total number of items available is more than the value specified in max-items then a ``NextToken`` will be provided in the output that you can use to resume pagination.

        

      
      - **PageSize** *(integer) --* 

        The size of each page.

        

      
      - **StartingToken** *(string) --* 

        A token to specify where to start paginating. This is the ``NextToken`` from a previous response.

        

      
    
    
    :rtype: dict
    :returns: 
      
      **Response Syntax**

      
      ::

        {
            'aiPromptVersionSummaries': [
                {
                    'aiPromptSummary': {
                        'name': 'string',
                        'assistantId': 'string',
                        'assistantArn': 'string',
                        'aiPromptId': 'string',
                        'type': 'ANSWER_GENERATION'|'INTENT_LABELING_GENERATION'|'QUERY_REFORMULATION'|'SELF_SERVICE_PRE_PROCESSING'|'SELF_SERVICE_ANSWER_GENERATION'|'EMAIL_RESPONSE'|'EMAIL_OVERVIEW'|'EMAIL_GENERATIVE_ANSWER'|'EMAIL_QUERY_REFORMULATION'|'ORCHESTRATION'|'NOTE_TAKING'|'CASE_SUMMARIZATION',
                        'aiPromptArn': 'string',
                        'modifiedTime': datetime(2015, 1, 1),
                        'templateType': 'TEXT',
                        'modelId': 'string',
                        'apiFormat': 'ANTHROPIC_CLAUDE_MESSAGES'|'ANTHROPIC_CLAUDE_TEXT_COMPLETIONS'|'MESSAGES'|'TEXT_COMPLETIONS',
                        'visibilityStatus': 'SAVED'|'PUBLISHED',
                        'origin': 'SYSTEM'|'CUSTOMER',
                        'description': 'string',
                        'status': 'CREATE_IN_PROGRESS'|'CREATE_FAILED'|'ACTIVE'|'DELETE_IN_PROGRESS'|'DELETE_FAILED'|'DELETED',
                        'tags': {
                            'string': 'string'
                        }
                    },
                    'versionNumber': 123
                },
            ],
            'NextToken': 'string'
        }
        
      **Response Structure**

      

      - *(dict) --* 
        

        - **aiPromptVersionSummaries** *(list) --* 

          The summaries of the AI Prompt versions.

          
          

          - *(dict) --* 

            The summary of the AI Prompt version.

            
            

            - **aiPromptSummary** *(dict) --* 

              The date for the summary of the AI Prompt version.

              
              

              - **name** *(string) --* 

                The name of the AI Prompt.

                
              

              - **assistantId** *(string) --* 

                The identifier of the Amazon Q in Connect assistant. Can be either the ID or the ARN. URLs cannot contain the ARN.

                
              

              - **assistantArn** *(string) --* 

                The Amazon Resource Name (ARN) of the Amazon Q in Connect assistant.

                
              

              - **aiPromptId** *(string) --* 

                The identifier of the Amazon Q in Connect AI prompt.

                
              

              - **type** *(string) --* 

                The type of this AI Prompt.

                
              

              - **aiPromptArn** *(string) --* 

                The Amazon Resource Name (ARN) of the AI Prompt.

                
              

              - **modifiedTime** *(datetime) --* 

                The time the AI Prompt was last modified.

                
              

              - **templateType** *(string) --* 

                The type of the prompt template for this AI Prompt.

                
              

              - **modelId** *(string) --* 

                The identifier of the model used for this AI Prompt. Model Ids supported are: ``anthropic.claude-3-haiku-20240307-v1:0``.

                
              

              - **apiFormat** *(string) --* 

                The API format used for this AI Prompt.

                
              

              - **visibilityStatus** *(string) --* 

                The visibility status of the AI Prompt.

                
              

              - **origin** *(string) --* 

                The origin of the AI Prompt. ``SYSTEM`` for a default AI Prompt created by Q in Connect or ``CUSTOMER`` for an AI Prompt created by calling AI Prompt creation APIs.

                
              

              - **description** *(string) --* 

                The description of the AI Prompt.

                
              

              - **status** *(string) --* 

                The status of the AI Prompt.

                
              

              - **tags** *(dict) --* 

                The tags used to organize, track, or control access for this resource.

                
                

                - *(string) --* 
                  

                  - *(string) --* 
            
          
          
            

            - **versionNumber** *(integer) --* 

              The version number for this AI Prompt version.

              
        
      
        

        - **NextToken** *(string) --* 

          A token to resume pagination.

          
    