

# 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


#### POST schema
POST

```
{
  "description": "string",
  "eventTargets": [
    {
      "arn": "string"
    }
  ],
  "eventType": enum,
  "groupIdentifier": "string",
  "name": "string"
}
```

### Response bodies


#### ListEventBridgeRuleTemplatesResponseContent schema
ListEventBridgeRuleTemplatesResponseContent

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

#### CreateEventBridgeRuleTemplateResponseContent schema
CreateEventBridgeRuleTemplateResponseContent

```
{
  "arn": "string",
  "createdAt": "string",
  "description": "string",
  "eventTargets": [
    {
      "arn": "string"
    }
  ],
  "eventType": enum,
  "groupId": "string",
  "id": "string",
  "modifiedAt": "string",
  "name": "string"
}
```

#### BadRequestExceptionResponseContent schema
BadRequestExceptionResponseContent

```
{
  "message": "string"
}
```

#### ForbiddenExceptionResponseContent schema
ForbiddenExceptionResponseContent

```
{
  "message": "string"
}
```

#### NotFoundExceptionResponseContent schema
NotFoundExceptionResponseContent

```
{
  "message": "string"
}
```

#### ConflictExceptionResponseContent schema
ConflictExceptionResponseContent

```
{
  "message": "string"
}
```

#### TooManyRequestsExceptionResponseContent schema
TooManyRequestsExceptionResponseContent

```
{
  "message": "string"
}
```

#### InternalServerErrorExceptionResponseContent schema
InternalServerErrorExceptionResponseContent

```
{
  "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 | stringMinLength: 0MaxLength: 1024 | False | A resource's optional description. | 
| eventTargets | Array of type [EventBridgeRuleTemplateTarget](#eventbridge-rule-templates-model-eventbridgeruletemplatetarget) | True | The destinations that will receive the event notifications. | 
| eventType | [EventBridgeRuleTemplateEventType](#eventbridge-rule-templates-model-eventbridgeruletemplateeventtype) | True | The type of event to match with the rule. | 
| groupIdentifier | stringPattern: `^[^\s]+$` | True | An eventbridge rule template group's identifier. Can be either be its id or current name. | 
| name | stringPattern: `^[^\s]+$`MinLength: 1MaxLength: 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 | stringPattern: `^arn:.+:medialive:.+:eventbridge-rule-template:.+$` | True | An eventbridge rule template's ARN (Amazon Resource Name) | 
| createdAt | stringFormat: date-time | True | The date and time of resource creation. | 
| description | stringMinLength: 0MaxLength: 1024 | False | A resource's optional description. | 
| eventTargets | Array of type [EventBridgeRuleTemplateTarget](#eventbridge-rule-templates-model-eventbridgeruletemplatetarget) | True | The destinations that will receive the event notifications. | 
| eventType | [EventBridgeRuleTemplateEventType](#eventbridge-rule-templates-model-eventbridgeruletemplateeventtype) | True | The type of event to match with the rule. | 
| groupId | stringPattern: `^(aws-)?[0-9]{7}$`MinLength: 7MaxLength: 11 | True | An eventbridge rule template group's id. Amazon Web Services provided template groups have ids that start with <code>`aws-`</code>. | 
| id | stringPattern: `^(aws-)?[0-9]{7}$`MinLength: 7MaxLength: 11 | True | An eventbridge rule template's id. Amazon Web Services provided templates have ids that start with <code>`aws-`</code> | 
| modifiedAt | stringFormat: date-time | False | The date and time of latest resource modification. | 
| name | stringPattern: `^[^\s]+$`MinLength: 1MaxLength: 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 | stringPattern: `^arn:.+:medialive:.+:eventbridge-rule-template:.+$` | True | An eventbridge rule template's ARN (Amazon Resource Name) | 
| createdAt | stringFormat: date-time | True | The date and time of resource creation. | 
| description | stringMinLength: 0MaxLength: 1024 | False | A resource's optional description. | 
| eventTargetCount | number | True | The number of event targets. | 
| eventType | [EventBridgeRuleTemplateEventType](#eventbridge-rule-templates-model-eventbridgeruletemplateeventtype) | True | The type of event to match with the rule. | 
| groupId | stringPattern: `^(aws-)?[0-9]{7}$`MinLength: 7MaxLength: 11 | True | An eventbridge rule template group's id. Amazon Web Services provided template groups have ids that start with <code>`aws-`</code>. | 
| id | stringPattern: `^(aws-)?[0-9]{7}$`MinLength: 7MaxLength: 11 | True | An eventbridge rule template's id. Amazon Web Services provided templates have ids that start with <code>`aws-`</code> | 
| modifiedAt | stringFormat: date-time | False | The date and time of latest resource modification. | 
| name | stringPattern: `^[^\s]+$`MinLength: 1MaxLength: 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 | 
| --- |--- |--- |--- |
| arn | stringPattern: `^arn.+$`MinLength: 1MaxLength: 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 | 
| --- |--- |--- |--- |
| eventBridgeRuleTemplates | Array of type [EventBridgeRuleTemplateSummary](#eventbridge-rule-templates-model-eventbridgeruletemplatesummary) | True | A list of the EventBridge rule templates. | 
| nextToken | stringMinLength: 1MaxLength: 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:

### ListEventBridgeRuleTemplates

+ [AWS Command Line Interface V2](/goto/cli2/medialive-2017-10-14/ListEventBridgeRuleTemplates)
+ [AWS SDK for .NET V4](/goto/DotNetSDKV4/medialive-2017-10-14/ListEventBridgeRuleTemplates)
+ [AWS SDK for C\$1\$1](/goto/SdkForCpp/medialive-2017-10-14/ListEventBridgeRuleTemplates)
+ [AWS SDK for Go v2](/goto/SdkForGoV2/medialive-2017-10-14/ListEventBridgeRuleTemplates)
+ [AWS SDK for Java V2](/goto/SdkForJavaV2/medialive-2017-10-14/ListEventBridgeRuleTemplates)
+ [AWS SDK for JavaScript V3](/goto/SdkForJavaScriptV3/medialive-2017-10-14/ListEventBridgeRuleTemplates)
+ [AWS SDK for Kotlin](/goto/SdkForKotlin/medialive-2017-10-14/ListEventBridgeRuleTemplates)
+ [AWS SDK for PHP V3](/goto/SdkForPHPV3/medialive-2017-10-14/ListEventBridgeRuleTemplates)
+ [AWS SDK for Python](/goto/boto3/medialive-2017-10-14/ListEventBridgeRuleTemplates)
+ [AWS SDK for Ruby V3](/goto/SdkForRubyV3/medialive-2017-10-14/ListEventBridgeRuleTemplates)

### CorsEventbridge\$1rule\$1templates

+ [AWS Command Line Interface V2](/goto/cli2/medialive-2017-10-14/CorsEventbridge_rule_templates)
+ [AWS SDK for .NET V4](/goto/DotNetSDKV4/medialive-2017-10-14/CorsEventbridge_rule_templates)
+ [AWS SDK for C\$1\$1](/goto/SdkForCpp/medialive-2017-10-14/CorsEventbridge_rule_templates)
+ [AWS SDK for Go v2](/goto/SdkForGoV2/medialive-2017-10-14/CorsEventbridge_rule_templates)
+ [AWS SDK for Java V2](/goto/SdkForJavaV2/medialive-2017-10-14/CorsEventbridge_rule_templates)
+ [AWS SDK for JavaScript V3](/goto/SdkForJavaScriptV3/medialive-2017-10-14/CorsEventbridge_rule_templates)
+ [AWS SDK for Kotlin](/goto/SdkForKotlin/medialive-2017-10-14/CorsEventbridge_rule_templates)
+ [AWS SDK for PHP V3](/goto/SdkForPHPV3/medialive-2017-10-14/CorsEventbridge_rule_templates)
+ [AWS SDK for Python](/goto/boto3/medialive-2017-10-14/CorsEventbridge_rule_templates)
+ [AWS SDK for Ruby V3](/goto/SdkForRubyV3/medialive-2017-10-14/CorsEventbridge_rule_templates)

### CreateEventBridgeRuleTemplate

+ [AWS Command Line Interface V2](/goto/cli2/medialive-2017-10-14/CreateEventBridgeRuleTemplate)
+ [AWS SDK for .NET V4](/goto/DotNetSDKV4/medialive-2017-10-14/CreateEventBridgeRuleTemplate)
+ [AWS SDK for C\$1\$1](/goto/SdkForCpp/medialive-2017-10-14/CreateEventBridgeRuleTemplate)
+ [AWS SDK for Go v2](/goto/SdkForGoV2/medialive-2017-10-14/CreateEventBridgeRuleTemplate)
+ [AWS SDK for Java V2](/goto/SdkForJavaV2/medialive-2017-10-14/CreateEventBridgeRuleTemplate)
+ [AWS SDK for JavaScript V3](/goto/SdkForJavaScriptV3/medialive-2017-10-14/CreateEventBridgeRuleTemplate)
+ [AWS SDK for Kotlin](/goto/SdkForKotlin/medialive-2017-10-14/CreateEventBridgeRuleTemplate)
+ [AWS SDK for PHP V3](/goto/SdkForPHPV3/medialive-2017-10-14/CreateEventBridgeRuleTemplate)
+ [AWS SDK for Python](/goto/boto3/medialive-2017-10-14/CreateEventBridgeRuleTemplate)
+ [AWS SDK for Ruby V3](/goto/SdkForRubyV3/medialive-2017-10-14/CreateEventBridgeRuleTemplate)