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.

See also: AWS API Documentation

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': {
        'createdAt': datetime(2015, 1, 1),
        'data': b'bytes',
        'modifiedAt': datetime(2015, 1, 1),
        'status': {
            'statusCode': 'CREATING'|'ACTIVE'|'UPDATING'|'DELETING'|'CREATION_FAILED'|'UPDATE_FAILED',
            'statusReason': 'string'
        }
    }
}

Response Structure

  • (dict) –

    Represents the output of a DescribeAlertManagerDefinition operation.

    • alertManagerDefinition (dict) –

      The alert manager definition.

      • createdAt (datetime) –

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

      • data (bytes) –

        The actual alert manager definition.

        For details about the alert manager definition, see AlertManagedDefinitionData.

      • modifiedAt (datetime) –

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

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

Exceptions

  • PrometheusService.Client.exceptions.ThrottlingException

  • PrometheusService.Client.exceptions.ValidationException

  • PrometheusService.Client.exceptions.ResourceNotFoundException

  • PrometheusService.Client.exceptions.AccessDeniedException

  • PrometheusService.Client.exceptions.InternalServerException