PrometheusService / Client / describe_alert_manager_definition

describe_alert_manager_definition#

PrometheusService.Client.describe_alert_manager_definition(**kwargs)#

Describes an alert manager definition.

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

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 properties of the selected workspace’s alert manager definition.

      • createdAt (datetime) –

        The time when the alert manager definition was created.

      • data (bytes) –

        The alert manager definition.

      • modifiedAt (datetime) –

        The time when the alert manager definition was modified.

      • status (dict) –

        The status of alert manager definition.

        • statusCode (string) –

          Status code of this definition.

        • statusReason (string) –

          The reason for failure if any.

Exceptions

  • PrometheusService.Client.exceptions.ThrottlingException

  • PrometheusService.Client.exceptions.ValidationException

  • PrometheusService.Client.exceptions.ResourceNotFoundException

  • PrometheusService.Client.exceptions.AccessDeniedException

  • PrometheusService.Client.exceptions.InternalServerException