URI HTTP methods Schemas Properties See also

Workflow monitor: CloudWatch alarm template groups

URI

/prod/cloudwatch-alarm-template-groups

HTTP methods

GET

Operation ID: ListCloudWatchAlarmTemplateGroups

Query parameters
Name	Type	Required	Description
`signalMapIdentifier`	String	False
`scope`	String	False
`nextToken`	String	False
`maxResults`	String	False

Responses
Status code	Response model	Description
`200`	`ListCloudWatchAlarmTemplateGroupsResponseContent`	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_template_groups

Responses
Status code	Response model	Description
`200`	None	200 response

POST

Operation ID: CreateCloudWatchAlarmTemplateGroup

Responses
Status code	Response model	Description
`201`	`CreateCloudWatchAlarmTemplateGroupResponseContent`	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


{
  "description": "string",
  "name": "string"
}

Response bodies


{
  "cloudWatchAlarmTemplateGroups": [
    {
      "arn": "string",
      "createdAt": "string",
      "description": "string",
      "id": "string",
      "modifiedAt": "string",
      "name": "string",
      "templateCount": number
    }
  ],
  "nextToken": "string"
}


{
  "arn": "string",
  "createdAt": "string",
  "description": "string",
  "id": "string",
  "modifiedAt": "string",
  "name": "string"
}


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

CloudWatchAlarmTemplateGroupSummary

A summary of the alarm template groups.

Property	Type	Required	Description
`arn`	string Pattern: `^arn:.+:medialive:.+:cloudwatch-alarm-template-group:.+$`	True	A cloudwatch alarm template group's ARN (Amazon Resource Name)
`createdAt`	string Format: date-time	True	The date and time of resource creation.
`description`	string MinLength: 0 MaxLength: 1024	False	A resource's optional description.
`id`	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>
`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.
`templateCount`	number	True	The number of templates in the group.

ConflictExceptionResponseContent

Updating or deleting a resource can cause an inconsistent state.

Property	Type	Required	Description
`message`	string	False	Exception error message.

CreateCloudWatchAlarmTemplateGroupRequestContent

Property Type Required Description

Property	Type	Required	Description
`description`	string MinLength: 0 MaxLength: 1024	False	A resource's optional description.
`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.

description

string

MinLength: 0

MaxLength: 1024

False

A resource's optional description.

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.

CreateCloudWatchAlarmTemplateGroupResponseContent

Property	Type	Required	Description
`arn`	string Pattern: `^arn:.+:medialive:.+:cloudwatch-alarm-template-group:.+$`	True	A cloudwatch alarm template group's ARN (Amazon Resource Name)
`createdAt`	string Format: date-time	True	The date and time of resource creation.
`description`	string MinLength: 0 MaxLength: 1024	False	A resource's optional description.
`id`	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>
`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.

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.

ListCloudWatchAlarmTemplateGroupsResponseContent

Property Type Required Description

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

cloudWatchAlarmTemplateGroups

Array of type CloudWatchAlarmTemplateGroupSummary

True

A summary of the alarm template groups.

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.