# Workflow monitor: EventBridge rule templates
<a name="eventbridge-rule-templates"></a>

## URI
<a name="eventbridge-rule-templates-url"></a>

`/prod/eventbridge-rule-templates`

## HTTP methods
<a name="eventbridge-rule-templates-http-methods"></a>

### GET
<a name="eventbridge-rule-templatesget"></a>

**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
<a name="eventbridge-rule-templatesoptions"></a>

**Operation ID:** `CorsEventbridge_rule_templates`


**Responses**  

| Status code | Response model | Description | 
| --- |--- |--- |
| 200 | None | 200 response | 

### POST
<a name="eventbridge-rule-templatespost"></a>

**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
<a name="eventbridge-rule-templates-schemas"></a>

### Request bodies
<a name="eventbridge-rule-templates-request-examples"></a>

#### POST schema
<a name="eventbridge-rule-templates-request-body-post-example"></a>

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

### Response bodies
<a name="eventbridge-rule-templates-response-examples"></a>

#### ListEventBridgeRuleTemplatesResponseContent schema
<a name="eventbridge-rule-templates-response-body-listeventbridgeruletemplatesresponsecontent-example"></a>

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

#### CreateEventBridgeRuleTemplateResponseContent schema
<a name="eventbridge-rule-templates-response-body-createeventbridgeruletemplateresponsecontent-example"></a>

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

#### BadRequestExceptionResponseContent schema
<a name="eventbridge-rule-templates-response-body-badrequestexceptionresponsecontent-example"></a>

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

#### ForbiddenExceptionResponseContent schema
<a name="eventbridge-rule-templates-response-body-forbiddenexceptionresponsecontent-example"></a>

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

#### NotFoundExceptionResponseContent schema
<a name="eventbridge-rule-templates-response-body-notfoundexceptionresponsecontent-example"></a>

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

#### ConflictExceptionResponseContent schema
<a name="eventbridge-rule-templates-response-body-conflictexceptionresponsecontent-example"></a>

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

#### TooManyRequestsExceptionResponseContent schema
<a name="eventbridge-rule-templates-response-body-toomanyrequestsexceptionresponsecontent-example"></a>

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

#### InternalServerErrorExceptionResponseContent schema
<a name="eventbridge-rule-templates-response-body-internalservererrorexceptionresponsecontent-example"></a>

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

## Properties
<a name="eventbridge-rule-templates-properties"></a>

### BadRequestExceptionResponseContent
<a name="eventbridge-rule-templates-model-badrequestexceptionresponsecontent"></a>

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
<a name="eventbridge-rule-templates-model-conflictexceptionresponsecontent"></a>

Updating or deleting a resource can cause an inconsistent state.


| Property | Type | Required | Description | 
| --- |--- |--- |--- |
| message | string | False | Exception error message. | 

### CreateEventBridgeRuleTemplateRequestContent
<a name="eventbridge-rule-templates-model-createeventbridgeruletemplaterequestcontent"></a>


| 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
<a name="eventbridge-rule-templates-model-createeventbridgeruletemplateresponsecontent"></a>


| 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
<a name="eventbridge-rule-templates-model-eventbridgeruletemplateeventtype"></a>

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
<a name="eventbridge-rule-templates-model-eventbridgeruletemplatesummary"></a>


| 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
<a name="eventbridge-rule-templates-model-eventbridgeruletemplatetarget"></a>

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
<a name="eventbridge-rule-templates-model-forbiddenexceptionresponsecontent"></a>

User does not have sufficient access to perform this action.


| Property | Type | Required | Description | 
| --- |--- |--- |--- |
| message | string | False | Exception error message. | 

### InternalServerErrorExceptionResponseContent
<a name="eventbridge-rule-templates-model-internalservererrorexceptionresponsecontent"></a>

Unexpected error during processing of request.


| Property | Type | Required | Description | 
| --- |--- |--- |--- |
| message | string | False | Exception error message. | 

### ListEventBridgeRuleTemplatesResponseContent
<a name="eventbridge-rule-templates-model-listeventbridgeruletemplatesresponsecontent"></a>


| 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
<a name="eventbridge-rule-templates-model-notfoundexceptionresponsecontent"></a>

Request references a resource which does not exist.


| Property | Type | Required | Description | 
| --- |--- |--- |--- |
| message | string | False | Exception error message. | 

### TooManyRequestsExceptionResponseContent
<a name="eventbridge-rule-templates-model-toomanyrequestsexceptionresponsecontent"></a>

Request was denied due to request throttling.


| Property | Type | Required | Description | 
| --- |--- |--- |--- |
| message | string | False | Exception error message. | 

## See also
<a name="eventbridge-rule-templates-see-also"></a>

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

### ListEventBridgeRuleTemplates
<a name="ListEventBridgeRuleTemplates-see-also"></a>
+ [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
<a name="CorsEventbridge_rule_templates-see-also"></a>
+ [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
<a name="CreateEventBridgeRuleTemplate-see-also"></a>
+ [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)