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

*********************************
describe_alert_manager_definition
*********************************



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

  

  Retrieves the full information about the alert manager definition for a workspace.

  

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


  **Request Syntax**
  ::

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

    The ID of the workspace to retrieve the alert manager definition from.

    

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

    
    ::

      {
          'alertManagerDefinition': {
              'status': {
                  'statusCode': 'CREATING'|'ACTIVE'|'UPDATING'|'DELETING'|'CREATION_FAILED'|'UPDATE_FAILED',
                  'statusReason': 'string'
              },
              'data': b'bytes',
              'createdAt': datetime(2015, 1, 1),
              'modifiedAt': datetime(2015, 1, 1)
          }
      }
      
    **Response Structure**

    

    - *(dict) --* 

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

      
      

      - **alertManagerDefinition** *(dict) --* 

        The alert manager definition.

        
        

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

          A structure that displays the current status of the alert manager definition..

          
          

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

            The current status of the alert manager.

            
          

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

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

            
      
        

        - **data** *(bytes) --* 

          The actual alert manager definition.

           

          For details about the alert manager definition, see `AlertManagedDefinitionData <https://docs.aws.amazon.com/prometheus/latest/APIReference/yaml-AlertManagerDefinitionData.html>`__.

          
        

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

          The date and time that the alert manager definition was created.

          
        

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

          The date and time that the alert manager definition was most recently changed.

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

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

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

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

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

  