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

****************
ListAIGuardrails
****************



.. py:class:: QConnect.Paginator.ListAIGuardrails

  ::

    
    paginator = client.get_paginator('list_ai_guardrails')

  
  

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

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

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


    **Request Syntax**
    ::

      response_iterator = paginator.paginate(
          assistantId='string',
          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 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**

      
      ::

        {
            'aiGuardrailSummaries': [
                {
                    'name': 'string',
                    'assistantId': 'string',
                    'assistantArn': 'string',
                    'aiGuardrailId': 'string',
                    'aiGuardrailArn': 'string',
                    'modifiedTime': datetime(2015, 1, 1),
                    'visibilityStatus': 'SAVED'|'PUBLISHED',
                    'description': 'string',
                    'status': 'CREATE_IN_PROGRESS'|'CREATE_FAILED'|'ACTIVE'|'DELETE_IN_PROGRESS'|'DELETE_FAILED'|'DELETED',
                    'tags': {
                        'string': 'string'
                    }
                },
            ],
            'NextToken': 'string'
        }
        
      **Response Structure**

      

      - *(dict) --* 
        

        - **aiGuardrailSummaries** *(list) --* 

          The summaries of the AI Guardrails.

          
          

          - *(dict) --* 

            The summary of the AI Guardrail.

            
            

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

              The name of the AI Guardrail.

              
            

            - **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.

              
            

            - **aiGuardrailId** *(string) --* 

              The identifier of the Amazon Q in Connect AI Guardrail.

              
            

            - **aiGuardrailArn** *(string) --* 

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

              
            

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

              The time the AI Guardrail was last modified.

              
            

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

              The visibility status of the AI Guardrail.

              
            

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

              A description of the AI Guardrail.

              
            

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

              The status of the AI Guardrail.

              
            

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

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

              
              

              - *(string) --* 
                

                - *(string) --* 
          
        
        
      
        

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

          A token to resume pagination.

          
    