PrometheusService / Client / describe_alert_manager_definition

describe_alert_manager_definition¶

PrometheusService.Client.describe_alert_manager_definition(**kwargs)¶

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

Request Syntax

response = client.describe_alert_manager_definition(
    workspaceId='string'
)

Parameters:

workspaceId (string) –

[REQUIRED]

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

Return type:

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.
  - 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

PrometheusService.Client.exceptions.ThrottlingException
PrometheusService.Client.exceptions.ValidationException
PrometheusService.Client.exceptions.ResourceNotFoundException
PrometheusService.Client.exceptions.AccessDeniedException
PrometheusService.Client.exceptions.InternalServerException