Workflow monitor: EventBridge rule templates ID

URI

/prod/eventbridge-rule-templates/identifier

HTTP methods

DELETE

Operation ID: DeleteEventBridgeRuleTemplate

Path parameters

Name	Type	Required	Description
identifier	String	True

Responses

Status code	Response model	Description
204	None	204 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

GET

Operation ID: GetEventBridgeRuleTemplate

Path parameters

Name	Type	Required	Description
identifier	String	True

Responses

Status code	Response model	Description
200	GetEventBridgeRuleTemplateResponseContent	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_templatesIdentifier

Path parameters

Name	Type	Required	Description
identifier	String	True

Responses

Status code	Response model	Description
200	None	200 response

PATCH

Operation ID: UpdateEventBridgeRuleTemplate

Path parameters

Name	Type	Required	Description
identifier	String	True

Responses

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

PATCH schema

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

Response bodies

GetEventBridgeRuleTemplateResponseContent schema

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

UpdateEventBridgeRuleTemplateResponseContent schema

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

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.

ConflictExceptionResponseContent

Updating or deleting a resource can cause an inconsistent state.

Property	Type	Required	Description
message	string	False	Exception error message.

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

EventBridgeRuleTemplateTarget

The target to which to send matching events.

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.

ForbiddenExceptionResponseContent

User does not have sufficient access to perform this action.

Property	Type	Required	Description
message	string	False	Exception error message.

GetEventBridgeRuleTemplateResponseContent

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.

InternalServerErrorExceptionResponseContent

Unexpected error during processing of request.

Property	Type	Required	Description
message	string	False	Exception error message.

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.

UpdateEventBridgeRuleTemplateRequestContent

Property	Type	Required	Description
description	string MinLength: 0 MaxLength: 1024	False	A resource's optional description.
eventTargets	Array of type EventBridgeRuleTemplateTarget	False	The destinations that will receive the event notifications.
eventType	EventBridgeRuleTemplateEventType	False	The type of event to match with the rule.
groupIdentifier	string Pattern: ^[^\s]+$	False	An eventbridge rule template group's identifier. Can be either be its id or current name.
name	string Pattern: ^[^\s]+$ MinLength: 1 MaxLength: 255	False	A resource's name. Names must be unique within the scope of a resource type in a specific region.

UpdateEventBridgeRuleTemplateResponseContent

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.

See also

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

DeleteEventBridgeRuleTemplate

• 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

GetEventBridgeRuleTemplate

• 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

CorsEventbridge_rule_templatesIdentifier

• 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

UpdateEventBridgeRuleTemplate

• 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