URI HTTP methods Schemas Properties See also

Workflow monitor: EventBridge rule templates

URI

/prod/eventbridge-rule-templates

HTTP methods

GET

Operation ID: ListEventBridgeRuleTemplates

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

Responses
Status code	Response model	Description
`200`	`ListEventBridgeRuleTemplatesResponseContent`	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: CorsEventbridge_rule_templates

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

POST

Operation ID: CreateEventBridgeRuleTemplate

Responses
Status code	Response model	Description
`201`	`CreateEventBridgeRuleTemplateResponseContent`	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",
  "eventTargets": [
    {
      "arn": "string"
    }
  ],
  "eventType": enum,
  "groupIdentifier": "string",
  "name": "string"
}

Response bodies


{
  "eventBridgeRuleTemplates": [
    {
      "arn": "string",
      "createdAt": "string",
      "description": "string",
      "eventTargetCount": number,
      "eventType": enum,
      "groupId": "string",
      "id": "string",
      "modifiedAt": "string",
      "name": "string"
    }
  ],
  "nextToken": "string"
}


{
  "arn": "string",
  "createdAt": "string",
  "description": "string",
  "eventTargets": [
    {
      "arn": "string"
    }
  ],
  "eventType": enum,
  "groupId": "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.

ConflictExceptionResponseContent

Updating or deleting a resource can cause an inconsistent state.

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

CreateEventBridgeRuleTemplateRequestContent

Property	Type	Required	Description
`description`	string MinLength: 0 MaxLength: 1024	False	A resource's optional description.
`eventTargets`	Array of type EventBridgeRuleTemplateTarget	True	The destinations that will receive the event notifications.
`eventType`	EventBridgeRuleTemplateEventType	True	The type of event to match with the rule.
`groupIdentifier`	string Pattern: `^[^\s]+$`	True	An eventbridge rule template group's identifier. Can be either be its id or current name.
`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.

CreateEventBridgeRuleTemplateResponseContent

Property	Type	Required	Description
`arn`	string Pattern: `^arn:.+:medialive:.+:eventbridge-rule-template:.+$`	True	An eventbridge rule template'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.
`eventTargets`	Array of type EventBridgeRuleTemplateTarget	True	The destinations that will receive the event notifications.
`eventType`	EventBridgeRuleTemplateEventType	True	The type of event to match with the rule.
`groupId`	string Pattern: `^(aws-)?[0-9]{7}$` MinLength: 7 MaxLength: 11	True	An eventbridge rule 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	An eventbridge rule template's id. Amazon Web Services provided templates 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.

EventBridgeRuleTemplateEventType

The type of event to match with the rule.

MEDIALIVE_MULTIPLEX_ALERT
MEDIALIVE_MULTIPLEX_STATE_CHANGE
MEDIALIVE_CHANNEL_ALERT
MEDIALIVE_CHANNEL_INPUT_CHANGE
MEDIALIVE_CHANNEL_STATE_CHANGE
MEDIAPACKAGE_INPUT_NOTIFICATION
MEDIAPACKAGE_KEY_PROVIDER_NOTIFICATION
MEDIAPACKAGE_HARVEST_JOB_NOTIFICATION
SIGNAL_MAP_ACTIVE_ALARM
MEDIACONNECT_ALERT
MEDIACONNECT_SOURCE_HEALTH
MEDIACONNECT_OUTPUT_HEALTH
MEDIACONNECT_FLOW_STATUS_CHANGE

EventBridgeRuleTemplateSummary

Property	Type	Required	Description
`arn`	string Pattern: `^arn:.+:medialive:.+:eventbridge-rule-template:.+$`	True	An eventbridge rule template'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.
`eventTargetCount`	number	True	The number of event targets.
`eventType`	EventBridgeRuleTemplateEventType	True	The type of event to match with the rule.
`groupId`	string Pattern: `^(aws-)?[0-9]{7}$` MinLength: 7 MaxLength: 11	True	An eventbridge rule 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	An eventbridge rule template's id. Amazon Web Services provided templates 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.

EventBridgeRuleTemplateTarget

The target to which to send matching events.

Property Type Required Description

Property	Type	Required	Description
`arn`	string Pattern: `^arn.+$` MinLength: 1 MaxLength: 2048	True	Target ARNs must be either an SNS topic or CloudWatch log group.

arn

string

Pattern: ^arn.+$

MinLength: 1

MaxLength: 2048

True

Target ARNs must be either an SNS topic or CloudWatch log group.

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.

ListEventBridgeRuleTemplatesResponseContent

Property Type Required Description

Property	Type	Required	Description
`eventBridgeRuleTemplates`	Array of type EventBridgeRuleTemplateSummary	True	A list of the EventBridge rule templates.
`nextToken`	string MinLength: 1 MaxLength: 2048	False	A token used to retrieve the next set of results in paginated list responses.

eventBridgeRuleTemplates

Array of type EventBridgeRuleTemplateSummary

True

A list of the EventBridge rule 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.