PrometheusService / Client / put_alert_manager_definition

put_alert_manager_definition#

PrometheusService.Client.put_alert_manager_definition(**kwargs)#

Updates an existing alert manager definition in a workspace. If the workspace does not already have an alert manager definition, don’t use this operation to create it. Instead, use CreateAlertManagerDefinition.

See also: AWS API Documentation

Request Syntax

response = client.put_alert_manager_definition(
    clientToken='string',
    data=b'bytes',
    workspaceId='string'
)
Parameters:

  • clientToken (string) –

    A unique identifier that you can provide to ensure the idempotency of the request. Case-sensitive.

    This field is autopopulated if not provided.

  • data (bytes) –

    [REQUIRED]

    The alert manager definition to use. A base64-encoded version of the YAML alert manager definition file.

    For details about the alert manager definition, see AlertManagedDefinitionData.

  • workspaceId (string) –

    [REQUIRED]

    The ID of the workspace to update the alert manager definition in.

Return type:

dict

Returns:

Response Syntax

{
    'status': {
        'statusCode': 'CREATING'|'ACTIVE'|'UPDATING'|'DELETING'|'CREATION_FAILED'|'UPDATE_FAILED',
        'statusReason': 'string'
    }
}

Response Structure

  • (dict) –

    Represents the output of a PutAlertManagerDefinition operation.

    • status (dict) –

      A structure that returns 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