:doc:`PrometheusService <../../amp>` / Client / describe_query_logging_configuration

************************************
describe_query_logging_configuration
************************************



.. py:method:: PrometheusService.Client.describe_query_logging_configuration(**kwargs)

  

  Retrieves the details of the query logging configuration for the specified workspace.

  

  See also: `AWS API Documentation <https://docs.aws.amazon.com/goto/WebAPI/amp-2020-08-01/DescribeQueryLoggingConfiguration>`_  


  **Request Syntax**
  ::

    response = client.describe_query_logging_configuration(
        workspaceId='string'
    )
    
  :type workspaceId: string
  :param workspaceId: **[REQUIRED]** 

    The ID of the workspace for which to retrieve the query logging configuration.

    

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

    
    ::

      {
          'queryLoggingConfiguration': {
              'status': {
                  'statusCode': 'CREATING'|'ACTIVE'|'UPDATING'|'DELETING'|'CREATION_FAILED'|'UPDATE_FAILED',
                  'statusReason': 'string'
              },
              'workspace': 'string',
              'destinations': [
                  {
                      'cloudWatchLogs': {
                          'logGroupArn': 'string'
                      },
                      'filters': {
                          'qspThreshold': 123
                      }
                  },
              ],
              'createdAt': datetime(2015, 1, 1),
              'modifiedAt': datetime(2015, 1, 1)
          }
      }
      
    **Response Structure**

    

    - *(dict) --* 
      

      - **queryLoggingConfiguration** *(dict) --* 

        The detailed information about the query logging configuration for the specified workspace.

        
        

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

          The current status of the query logging configuration.

          
          

          - **statusCode** *(string) --* 

            The current status of the query logging configuration.

            
          

          - **statusReason** *(string) --* 

            If there is a failure, the reason for the failure.

            
      
        

        - **workspace** *(string) --* 

          The ID of the workspace associated with this query logging configuration.

          
        

        - **destinations** *(list) --* 

          The configured destinations for the query logging configuration.

          
          

          - *(dict) --* 

            Defines a destination and its associated filtering criteria for query logging.

            
            

            - **cloudWatchLogs** *(dict) --* 

              Configuration details for logging to CloudWatch Logs.

              
              

              - **logGroupArn** *(string) --* 

                The ARN of the CloudWatch log group to which the vended log data will be published. This log group must exist prior to calling this operation.

                
          
            

            - **filters** *(dict) --* 

              Filtering criteria that determine which queries are logged.

              
              

              - **qspThreshold** *(integer) --* 

                The Query Samples Processed (QSP) threshold above which queries will be logged. Queries processing more samples than this threshold will be captured in logs.

                
          
        
      
        

        - **createdAt** *(datetime) --* 

          The date and time when the query logging configuration was created.

          
        

        - **modifiedAt** *(datetime) --* 

          The date and time when the query logging configuration was last modified.

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

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

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

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

  