:doc:`kendra <../../kendra>` / Client / list_experiences

****************
list_experiences
****************



.. py:method:: kendra.Client.list_experiences(**kwargs)

  

  Lists one or more Amazon Kendra experiences. You can create an Amazon Kendra experience such as a search application. For more information on creating a search application experience, see `Building a search experience with no code <https://docs.aws.amazon.com/kendra/latest/dg/deploying-search-experience-no-code.html>`__.

  

  See also: `AWS API Documentation <https://docs.aws.amazon.com/goto/WebAPI/kendra-2019-02-03/ListExperiences>`_  


  **Request Syntax**
  ::

    response = client.list_experiences(
        IndexId='string',
        NextToken='string',
        MaxResults=123
    )
    
  :type IndexId: string
  :param IndexId: **[REQUIRED]** 

    The identifier of the index for your Amazon Kendra experience.

    

  
  :type NextToken: string
  :param NextToken: 

    If the previous response was incomplete (because there is more data to retrieve), Amazon Kendra returns a pagination token in the response. You can use this pagination token to retrieve the next set of Amazon Kendra experiences.

    

  
  :type MaxResults: integer
  :param MaxResults: 

    The maximum number of returned Amazon Kendra experiences.

    

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

    
    ::

      {
          'SummaryItems': [
              {
                  'Name': 'string',
                  'Id': 'string',
                  'CreatedAt': datetime(2015, 1, 1),
                  'Status': 'CREATING'|'ACTIVE'|'DELETING'|'FAILED',
                  'Endpoints': [
                      {
                          'EndpointType': 'HOME',
                          'Endpoint': 'string'
                      },
                  ]
              },
          ],
          'NextToken': 'string'
      }
      
    **Response Structure**

    

    - *(dict) --* 
      

      - **SummaryItems** *(list) --* 

        An array of summary information for one or more Amazon Kendra experiences.

        
        

        - *(dict) --* 

          Summary information for your Amazon Kendra experience. You can create an Amazon Kendra experience such as a search application. For more information on creating a search application experience, see `Building a search experience with no code <https://docs.aws.amazon.com/kendra/latest/dg/deploying-search-experience-no-code.html>`__.

          
          

          - **Name** *(string) --* 

            The name of your Amazon Kendra experience.

            
          

          - **Id** *(string) --* 

            The identifier of your Amazon Kendra experience.

            
          

          - **CreatedAt** *(datetime) --* 

            The Unix timestamp when your Amazon Kendra experience was created.

            
          

          - **Status** *(string) --* 

            The processing status of your Amazon Kendra experience.

            
          

          - **Endpoints** *(list) --* 

            The endpoint URLs for your Amazon Kendra experiences. The URLs are unique and fully hosted by Amazon Web Services.

            
            

            - *(dict) --* 

              Provides the configuration information for the endpoint for your Amazon Kendra experience.

              
              

              - **EndpointType** *(string) --* 

                The type of endpoint for your Amazon Kendra experience. The type currently available is ``HOME``, which is a unique and fully hosted URL to the home page of your Amazon Kendra experience.

                
              

              - **Endpoint** *(string) --* 

                The endpoint of your Amazon Kendra experience.

                
          
        
      
    
      

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

        If the response is truncated, Amazon Kendra returns this token, which you can use in a later request to retrieve the next set of Amazon Kendra experiences.

        
  
  **Exceptions**
  
  *   :py:class:`kendra.Client.exceptions.ValidationException`

  
  *   :py:class:`kendra.Client.exceptions.ResourceNotFoundException`

  
  *   :py:class:`kendra.Client.exceptions.AccessDeniedException`

  
  *   :py:class:`kendra.Client.exceptions.ThrottlingException`

  
  *   :py:class:`kendra.Client.exceptions.InternalServerException`

  