Workflow monitor: CloudWatch alarm templates ID
URI
/prod/cloudwatch-alarm-templates/
identifier
HTTP methods
DELETE
Operation ID: DeleteCloudWatchAlarmTemplate
Path parameters | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
Name | Type | Required | Description | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
identifier | String | True |
Responses | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
Status code | Response model | Description | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
204 | None | 204 response | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
400 | BadRequestExceptionResponseContent | 400 response | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
403 | ForbiddenExceptionResponseContent | 403 response | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
404 | NotFoundExceptionResponseContent | 404 response | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
409 | ConflictExceptionResponseContent | 409 response | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
429 | TooManyRequestsExceptionResponseContent | 429 response | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
500 | InternalServerErrorExceptionResponseContent | 500 response |
GET
Operation ID: GetCloudWatchAlarmTemplate
Path parameters | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
Name | Type | Required | Description | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
identifier | String | True |
Responses | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
Status code | Response model | Description | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
200 | GetCloudWatchAlarmTemplateResponseContent | 200 response | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
400 | BadRequestExceptionResponseContent | 400 response | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
403 | ForbiddenExceptionResponseContent | 403 response | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
404 | NotFoundExceptionResponseContent | 404 response | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
429 | TooManyRequestsExceptionResponseContent | 429 response | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
500 | InternalServerErrorExceptionResponseContent | 500 response |
OPTIONS
Operation ID: CorsCloudwatch_alarm_templatesIdentifier
Path parameters | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
Name | Type | Required | Description | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
identifier | String | True |
Responses | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
Status code | Response model | Description | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
200 | None | 200 response |
PATCH
Operation ID: UpdateCloudWatchAlarmTemplate
Path parameters | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
Name | Type | Required | Description | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
identifier | String | True |
Responses | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
Status code | Response model | Description | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
200 | UpdateCloudWatchAlarmTemplateResponseContent | 200 response | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
400 | BadRequestExceptionResponseContent | 400 response | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
403 | ForbiddenExceptionResponseContent | 403 response | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
404 | NotFoundExceptionResponseContent | 404 response | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
409 | ConflictExceptionResponseContent | 409 response | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
429 | TooManyRequestsExceptionResponseContent | 429 response | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
500 | InternalServerErrorExceptionResponseContent | 500 response |
Schemas
Request bodies
{ "comparisonOperator": enum, "datapointsToAlarm": number, "description": "string", "evaluationPeriods": number, "groupIdentifier": "string", "metricName": "string", "name": "string", "period": number, "standardDeviationThreshold": number, "statistic": enum, "targetResourceType": enum, "threshold": number, "treatMissingData": enum }
Response bodies
{ "arn": "string", "comparisonOperator": enum, "createdAt": "string", "datapointsToAlarm": number, "description": "string", "evaluationPeriods": number, "groupId": "string", "id": "string", "metricName": "string", "modifiedAt": "string", "name": "string", "period": number, "standardDeviationThreshold": number, "statistic": enum, "targetResourceType": enum, "threshold": number, "treatMissingData": enum }
{ "arn": "string", "comparisonOperator": enum, "createdAt": "string", "datapointsToAlarm": number, "description": "string", "evaluationPeriods": number, "groupId": "string", "id": "string", "metricName": "string", "modifiedAt": "string", "name": "string", "period": number, "standardDeviationThreshold": number, "statistic": enum, "targetResourceType": enum, "threshold": number, "treatMissingData": enum }
{ "message": "string" }
{ "message": "string" }
{ "message": "string" }
{ "message": "string" }
{ "message": "string" }
{ "message": "string" }
Properties
BadRequestExceptionResponseContent
The input fails to satisfy the constraints specified by an Amazon Web Services service.
Property | Type | Required | Description |
---|---|---|---|
message | string | False | Exception error message. |
CloudWatchAlarmTemplateComparisonOperator
The comparison operator used to compare the specified statistic and the threshold.
GreaterThanOrEqualToThreshold
GreaterThanThreshold
LessThanThreshold
LessThanOrEqualToThreshold
LessThanLowerOrGreaterThanUpperThreshold
LessThanLowerThreshold
GreaterThanUpperThreshold
CloudWatchAlarmTemplateStatistic
The statistic to apply to the alarm's metric data.
SampleCount
Average
Sum
Minimum
Maximum
CloudWatchAlarmTemplateTargetResourceType
The resource type this template should dynamically generate cloudwatch metric alarms for.
CLOUDFRONT_DISTRIBUTION
MEDIALIVE_MULTIPLEX
MEDIALIVE_CHANNEL
MEDIALIVE_INPUT_DEVICE
MEDIAPACKAGE_CHANNEL
MEDIAPACKAGE_ORIGIN_ENDPOINT
MEDIACONNECT_FLOW
S3_BUCKET
CloudWatchAlarmTemplateTreatMissingData
Specifies how missing data points are treated when evaluating the alarm's condition.
notBreaching
breaching
ignore
missing
ConflictExceptionResponseContent
Updating or deleting a resource can cause an inconsistent state.
Property | Type | Required | Description |
---|---|---|---|
message | string | False | Exception error message. |
ForbiddenExceptionResponseContent
User does not have sufficient access to perform this action.
Property | Type | Required | Description |
---|---|---|---|
message | string | False | Exception error message. |
GetCloudWatchAlarmTemplateResponseContent
Property | Type | Required | Description |
---|---|---|---|
arn | string Pattern: | True | A cloudwatch alarm template's ARN (Amazon Resource Name) |
comparisonOperator | True | The comparison operator used to compare the specified statistic and the threshold. | |
createdAt | string Format: date-time | True | The date and time of resource creation. |
datapointsToAlarm | number Minimum: 1 | False | The number of datapoints within the evaluation period that must be breaching to trigger the alarm. |
description | string MinLength: 0 MaxLength: 1024 | False | A resource's optional description. |
evaluationPeriods | number Minimum: 1 | True | The number of periods over which data is compared to the specified threshold. |
groupId | string Pattern: MinLength: 7 MaxLength: 11 | True | A CloudWatch alarm template group's id. Amazon Web Services provided template groups have ids that start with <code>`aws-`</code> |
id | string Pattern: MinLength: 7 MaxLength: 11 | True | A cloudwatch alarm template's id. Amazon Web Services provided templates have ids that start with <code>`aws-`</code>. |
metricName | string MaxLength: 64 | True | The name of the metric associated with the alarm. Must be compatible with targetResourceType. |
modifiedAt | string Format: date-time | False | The date and time of latest resource modification. |
name | string Pattern: MinLength: 1 MaxLength: 255 | True | A resource's name. Names must be unique within the scope of a resource type in a specific region. |
period | number Minimum: 10 Maximum: 86400 | True | The period, in seconds, over which the specified statistic is applied. |
standardDeviationThreshold | number Minimum: 1 | False | The number of standard deviations by which the metric value can deviate from the expected value before the alarm is triggered. |
statistic | True | The statistic to apply to the alarm's metric data. | |
targetResourceType | True | The resource type this template should dynamically generate CloudWatch metric alarms for. | |
threshold | number Format: double | False | The threshold value to compare with the specified statistic. |
treatMissingData | True | Specifies how missing data points are treated when evaluating the alarm's condition. |
InternalServerErrorExceptionResponseContent
Unexpected error during processing of request.
Property | Type | Required | Description |
---|---|---|---|
message | string | False | Exception error message. |
NotFoundExceptionResponseContent
Request references a resource which does not exist.
Property | Type | Required | Description |
---|---|---|---|
message | string | False | Exception error message. |
TooManyRequestsExceptionResponseContent
Request was denied due to request throttling.
Property | Type | Required | Description |
---|---|---|---|
message | string | False | Exception error message. |
UpdateCloudWatchAlarmTemplateRequestContent
Property | Type | Required | Description |
---|---|---|---|
comparisonOperator | False | The comparison operator used to compare the specified statistic and the threshold. | |
datapointsToAlarm | number Minimum: 1 | False | The number of datapoints within the evaluation period that must be breaching to trigger the alarm. |
description | string MinLength: 0 MaxLength: 1024 | False | A resource's optional description. |
evaluationPeriods | number Minimum: 1 | False | The number of periods over which data is compared to the specified threshold. |
groupIdentifier | string Pattern: | False | A cloudwatch alarm template group's identifier. Can be either be its id or current name. |
metricName | string MaxLength: 64 | False | The name of the metric associated with the alarm. Must be compatible with targetResourceType. |
name | string Pattern: MinLength: 1 MaxLength: 255 | False | A resource's name. Names must be unique within the scope of a resource type in a specific region. |
period | number Minimum: 10 Maximum: 86400 | False | The period, in seconds, over which the specified statistic is applied. |
standardDeviationThreshold | number Minimum: 1 | False | The number of standard deviations by which the metric value can deviate from the expected value before the alarm is triggered. |
statistic | False | The statistic to apply to the alarm's metric data. | |
targetResourceType | False | The resource type this template should dynamically generate CloudWatch metric alarms for. | |
threshold | number Format: double | False | The threshold value to compare with the specified statistic. |
treatMissingData | False | Specifies how missing data points are treated when evaluating the alarm's condition. |
UpdateCloudWatchAlarmTemplateResponseContent
Property | Type | Required | Description |
---|---|---|---|
arn | string Pattern: | True | A cloudwatch alarm template's ARN (Amazon Resource Name) |
comparisonOperator | True | The comparison operator used to compare the specified statistic and the threshold. | |
createdAt | string Format: date-time | True | The date and time of resource creation. |
datapointsToAlarm | number Minimum: 1 | False | The number of datapoints within the evaluation period that must be breaching to trigger the alarm. |
description | string MinLength: 0 MaxLength: 1024 | False | A resource's optional description. |
evaluationPeriods | number Minimum: 1 | True | The number of periods over which data is compared to the specified threshold. |
groupId | string Pattern: MinLength: 7 MaxLength: 11 | True | A CloudWatch alarm template group's id. Amazon Web Services provided template groups have ids that start with <code>`aws-`</code> |
id | string Pattern: MinLength: 7 MaxLength: 11 | True | A cloudwatch alarm template's id. Amazon Web Services provided templates have ids that start with <code>`aws-`</code>. |
metricName | string MaxLength: 64 | True | The name of the metric associated with the alarm. Must be compatible with targetResourceType. |
modifiedAt | string Format: date-time | False | The date and time of latest resource modification. |
name | string Pattern: MinLength: 1 MaxLength: 255 | True | A resource's name. Names must be unique within the scope of a resource type in a specific region. |
period | number Minimum: 10 Maximum: 86400 | True | The period, in seconds, over which the specified statistic is applied. |
standardDeviationThreshold | number Minimum: 1 | False | The number of standard deviations by which the metric value can deviate from the expected value before the alarm is triggered. |
statistic | True | The statistic to apply to the alarm's metric data. | |
targetResourceType | True | The resource type this template should dynamically generate CloudWatch metric alarms for. | |
threshold | number Format: double | False | The threshold value to compare with the specified statistic. |
treatMissingData | True | Specifies how missing data points are treated when evaluating the alarm's condition. |
See also
For more information about using this API in one of the language-specific AWS SDKs and references, see the following: