Request Syntax URI Request Parameters Request Body Response Syntax Response Elements Errors See Also

PutAlertManagerDefinition

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.

Request Syntax


PUT /workspaces/workspaceId/alertmanager/definition HTTP/1.1
Content-type: application/json

{
   "clientToken": "string",
   "data": blob
}

URI Request Parameters

The request uses the following URI parameters.

workspaceId

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

Length Constraints: Minimum length of 1. Maximum length of 64.

Pattern: [0-9A-Za-z][-.0-9A-Z_a-z]*

Required: Yes

Request Body

The request accepts the following data in JSON format.

clientToken

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

Type: String

Length Constraints: Minimum length of 1. Maximum length of 64.

Pattern: ^[!-~]+$

Required: No

data

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.

Type: Base64-encoded binary data object

Required: Yes

Response Syntax


HTTP/1.1 202
Content-type: application/json

{
   "status": { 
      "statusCode": "string",
      "statusReason": "string"
   }
}

Response Elements

If the action is successful, the service sends back an HTTP 202 response.

The following data is returned in JSON format by the service.

status

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

Type: AlertManagerDefinitionStatus object

Errors

For information about the errors that are common to all actions, see Common Errors.

AccessDeniedException

You do not have sufficient access to perform this action.

HTTP Status Code: 403

ConflictException

The request would cause an inconsistent state.

HTTP Status Code: 409

InternalServerException

An unexpected error occurred during the processing of the request.

HTTP Status Code: 500

ResourceNotFoundException

The request references a resources that doesn't exist.

HTTP Status Code: 404

ServiceQuotaExceededException

Completing the request would cause a service quota to be exceeded.

HTTP Status Code: 402

ThrottlingException

The request was denied due to request throttling.

HTTP Status Code: 429

ValidationException

The input fails to satisfy the constraints specified by an AWS service.

HTTP Status Code: 400