:doc:`QBusiness <../../qbusiness>` / Client / get_group

*********
get_group
*********



.. py:method:: QBusiness.Client.get_group(**kwargs)

  

  Describes a group by group name.

  

  See also: `AWS API Documentation <https://docs.aws.amazon.com/goto/WebAPI/qbusiness-2023-11-27/GetGroup>`_  


  **Request Syntax**
  ::

    response = client.get_group(
        applicationId='string',
        indexId='string',
        groupName='string',
        dataSourceId='string'
    )
    
  :type applicationId: string
  :param applicationId: **[REQUIRED]** 

    The identifier of the application id the group is attached to.

    

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

    The identifier of the index the group is attached to.

    

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

    The name of the group.

    

  
  :type dataSourceId: string
  :param dataSourceId: 

    The identifier of the data source the group is attached to.

    

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

    
    ::

      {
          'status': {
              'status': 'FAILED'|'SUCCEEDED'|'PROCESSING'|'DELETING'|'DELETED',
              'lastUpdatedAt': datetime(2015, 1, 1),
              'errorDetail': {
                  'errorMessage': 'string',
                  'errorCode': 'InternalError'|'InvalidRequest'|'ResourceInactive'|'ResourceNotFound'
              }
          },
          'statusHistory': [
              {
                  'status': 'FAILED'|'SUCCEEDED'|'PROCESSING'|'DELETING'|'DELETED',
                  'lastUpdatedAt': datetime(2015, 1, 1),
                  'errorDetail': {
                      'errorMessage': 'string',
                      'errorCode': 'InternalError'|'InvalidRequest'|'ResourceInactive'|'ResourceNotFound'
                  }
              },
          ]
      }
      
    **Response Structure**

    

    - *(dict) --* 
      

      - **status** *(dict) --* 

        The current status of the group.

        
        

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

          The status of a group.

          
        

        - **lastUpdatedAt** *(datetime) --* 

          The Unix timestamp when the Amazon Q Business application was last updated.

          
        

        - **errorDetail** *(dict) --* 

          The details of an error associated a group status.

          
          

          - **errorMessage** *(string) --* 

            The message explaining the Amazon Q Business request error.

            
          

          - **errorCode** *(string) --* 

            The code associated with the Amazon Q Business request error.

            
      
    
      

      - **statusHistory** *(list) --* 

        The status history of the group.

        
        

        - *(dict) --* 

          Provides the details of a group's status.

          
          

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

            The status of a group.

            
          

          - **lastUpdatedAt** *(datetime) --* 

            The Unix timestamp when the Amazon Q Business application was last updated.

            
          

          - **errorDetail** *(dict) --* 

            The details of an error associated a group status.

            
            

            - **errorMessage** *(string) --* 

              The message explaining the Amazon Q Business request error.

              
            

            - **errorCode** *(string) --* 

              The code associated with the Amazon Q Business request error.

              
        
      
    
  
  **Exceptions**
  
  *   :py:class:`QBusiness.Client.exceptions.InternalServerException`

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

  
  *   :py:class:`QBusiness.Client.exceptions.ConflictException`

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

  
  *   :py:class:`QBusiness.Client.exceptions.ValidationException`

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

  