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

******************************
describe_logging_configuration
******************************



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

  

  Returns complete information about the current rules and alerting logging configuration of the workspace.

   

  .. note::

    

    These logging configurations are only for rules and alerting logs.

    

  

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


  **Request Syntax**
  ::

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

    The ID of the workspace to describe the logging configuration for.

    

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

    
    ::

      {
          'loggingConfiguration': {
              'status': {
                  'statusCode': 'CREATING'|'ACTIVE'|'UPDATING'|'DELETING'|'CREATION_FAILED'|'UPDATE_FAILED',
                  'statusReason': 'string'
              },
              'workspace': 'string',
              'logGroupArn': 'string',
              'createdAt': datetime(2015, 1, 1),
              'modifiedAt': datetime(2015, 1, 1)
          }
      }
      
    **Response Structure**

    

    - *(dict) --* 

      Represents the output of a ``DescribeLoggingConfiguration`` operation.

      
      

      - **loggingConfiguration** *(dict) --* 

        A structure that displays the information about the logging configuration.

        
        

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

          The current status of the logging configuration.

          
          

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

            The current status of the current rules and alerting logging configuration.

             

            .. note::

              

              These logging configurations are only for rules and alerting logs.

              

            
          

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

            If failed, the reason for the failure.

            
      
        

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

          The ID of the workspace the logging configuration is for.

          
        

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

          The ARN of the CloudWatch log group to which the vended log data will be published.

          
        

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

          The date and time that the logging configuration was created.

          
        

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

          The date and time that the logging configuration was most recently changed.

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

  