Workflow monitor: CloudWatch alarm templates

URI

/prod/cloudwatch-alarm-templates

HTTP methods

GET

Operation ID: ListCloudWatchAlarmTemplates

Query parameters

Name	Type	Required	Description
groupIdentifier	String	False
signalMapIdentifier	String	False
scope	String	False
nextToken	String	False
maxResults	String	False

Responses

Status code	Response model	Description
200	ListCloudWatchAlarmTemplatesResponseContent	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_templates

Responses

Status code	Response model	Description
200	None	200 response

POST

Operation ID: CreateCloudWatchAlarmTemplate

Responses

Status code	Response model	Description
201	CreateCloudWatchAlarmTemplateResponseContent	201 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

POST schema

{
  "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

ListCloudWatchAlarmTemplatesResponseContent schema

{
  "cloudWatchAlarmTemplates": [
    {
      "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
    }
  ],
  "nextToken": "string"
}

CreateCloudWatchAlarmTemplateResponseContent schema

{
  "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
}

BadRequestExceptionResponseContent schema

{
  "message": "string"
}

ForbiddenExceptionResponseContent schema

{
  "message": "string"
}

NotFoundExceptionResponseContent schema

{
  "message": "string"
}

ConflictExceptionResponseContent schema

{
  "message": "string"
}

TooManyRequestsExceptionResponseContent schema

{
  "message": "string"
}

InternalServerErrorExceptionResponseContent schema

{
  "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

CloudWatchAlarmTemplateSummary

A summary of the alarm templates.

Property	Type	Required	Description
arn	string Pattern: ^arn:.+:medialive:.+:cloudwatch-alarm-template:.+$	True	A cloudwatch alarm template's ARN (Amazon Resource Name)
comparisonOperator	CloudWatchAlarmTemplateComparisonOperator	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: ^(aws-)?[0-9]{7}$ 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: ^(aws-)?[0-9]{7}$ 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: ^[^\s]+$ 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	CloudWatchAlarmTemplateStatistic	True	The statistic to apply to the alarm's metric data.
targetResourceType	CloudWatchAlarmTemplateTargetResourceType	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	CloudWatchAlarmTemplateTreatMissingData	True	Specifies how missing data points are treated when evaluating the alarm's condition.

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.

CreateCloudWatchAlarmTemplateRequestContent

Property	Type	Required	Description
comparisonOperator	CloudWatchAlarmTemplateComparisonOperator	True	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	True	The number of periods over which data is compared to the specified threshold.
groupIdentifier	string Pattern: ^[^\s]+$	True	A cloudwatch alarm template group's identifier. Can be either be its id or current name.
metricName	string MaxLength: 64	True	The name of the metric associated with the alarm. Must be compatible with targetResourceType.
name	string Pattern: ^[^\s]+$ 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	CloudWatchAlarmTemplateStatistic	True	The statistic to apply to the alarm's metric data.
targetResourceType	CloudWatchAlarmTemplateTargetResourceType	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	CloudWatchAlarmTemplateTreatMissingData	True	Specifies how missing data points are treated when evaluating the alarm's condition.

CreateCloudWatchAlarmTemplateResponseContent

Property	Type	Required	Description
arn	string Pattern: ^arn:.+:medialive:.+:cloudwatch-alarm-template:.+$	True	A cloudwatch alarm template's ARN (Amazon Resource Name)
comparisonOperator	CloudWatchAlarmTemplateComparisonOperator	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: ^(aws-)?[0-9]{7}$ 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: ^(aws-)?[0-9]{7}$ 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: ^[^\s]+$ 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	CloudWatchAlarmTemplateStatistic	True	The statistic to apply to the alarm's metric data.
targetResourceType	CloudWatchAlarmTemplateTargetResourceType	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	CloudWatchAlarmTemplateTreatMissingData	True	Specifies how missing data points are treated when evaluating the alarm's condition.

ForbiddenExceptionResponseContent

User does not have sufficient access to perform this action.

Property	Type	Required	Description
message	string	False	Exception error message.

InternalServerErrorExceptionResponseContent

Unexpected error during processing of request.

Property	Type	Required	Description
message	string	False	Exception error message.

ListCloudWatchAlarmTemplatesResponseContent

Property	Type	Required	Description
cloudWatchAlarmTemplates	Array of type CloudWatchAlarmTemplateSummary	True	A summary of the alarm templates.
nextToken	string MinLength: 1 MaxLength: 2048	False	A token used to retrieve the next set of results in paginated list responses.

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.

See also

For more information about using this API in one of the language-specific AWS SDKs and references, see the following:

ListCloudWatchAlarmTemplates

• AWS Command Line Interface

• AWS SDK for .NET

• AWS SDK for C++

• AWS SDK for Go v2

• AWS SDK for Java V2

• AWS SDK for JavaScript V3

• AWS SDK for PHP V3

• AWS SDK for Python

• AWS SDK for Ruby V3

CorsCloudwatch_alarm_templates

• AWS Command Line Interface

• AWS SDK for .NET

• AWS SDK for C++

• AWS SDK for Go v2

• AWS SDK for Java V2

• AWS SDK for JavaScript V3

• AWS SDK for PHP V3

• AWS SDK for Python

• AWS SDK for Ruby V3

CreateCloudWatchAlarmTemplate

• AWS Command Line Interface

• AWS SDK for .NET

• AWS SDK for C++

• AWS SDK for Go v2

• AWS SDK for Java V2

• AWS SDK for JavaScript V3

• AWS SDK for PHP V3

• AWS SDK for Python

• AWS SDK for Ruby V3