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

************
describe_faq
************



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

  

  Gets information about a FAQ.

  

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


  **Request Syntax**
  ::

    response = client.describe_faq(
        Id='string',
        IndexId='string'
    )
    
  :type Id: string
  :param Id: **[REQUIRED]** 

    The identifier of the FAQ you want to get information on.

    

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

    The identifier of the index for the FAQ.

    

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

    
    ::

      {
          'Id': 'string',
          'IndexId': 'string',
          'Name': 'string',
          'Description': 'string',
          'CreatedAt': datetime(2015, 1, 1),
          'UpdatedAt': datetime(2015, 1, 1),
          'S3Path': {
              'Bucket': 'string',
              'Key': 'string'
          },
          'Status': 'CREATING'|'UPDATING'|'ACTIVE'|'DELETING'|'FAILED',
          'RoleArn': 'string',
          'ErrorMessage': 'string',
          'FileFormat': 'CSV'|'CSV_WITH_HEADER'|'JSON',
          'LanguageCode': 'string'
      }
      
    **Response Structure**

    

    - *(dict) --* 
      

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

        The identifier of the FAQ.

        
      

      - **IndexId** *(string) --* 

        The identifier of the index for the FAQ.

        
      

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

        The name that you gave the FAQ when it was created.

        
      

      - **Description** *(string) --* 

        The description of the FAQ that you provided when it was created.

        
      

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

        The Unix timestamp when the FAQ was created.

        
      

      - **UpdatedAt** *(datetime) --* 

        The Unix timestamp when the FAQ was last updated.

        
      

      - **S3Path** *(dict) --* 

        Information required to find a specific file in an Amazon S3 bucket.

        
        

        - **Bucket** *(string) --* 

          The name of the S3 bucket that contains the file.

          
        

        - **Key** *(string) --* 

          The name of the file.

          
    
      

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

        The status of the FAQ. It is ready to use when the status is ``ACTIVE``.

        
      

      - **RoleArn** *(string) --* 

        The Amazon Resource Name (ARN) of the IAM role that provides access to the S3 bucket containing the FAQ file.

        
      

      - **ErrorMessage** *(string) --* 

        If the ``Status`` field is ``FAILED``, the ``ErrorMessage`` field contains the reason why the FAQ failed.

        
      

      - **FileFormat** *(string) --* 

        The file format used for the FAQ file.

        
      

      - **LanguageCode** *(string) --* 

        The code for a language. This shows a supported language for the FAQ document. English is supported by default. For more information on supported languages, including their codes, see `Adding documents in languages other than English <https://docs.aws.amazon.com/kendra/latest/dg/in-adding-languages.html>`__.

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

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

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

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

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

  