notification_configurations
Creates, updates, deletes, gets or lists a notification_configurations resource.
Overview
| Name | notification_configurations |
| Type | Resource |
| Id | aws.kinesisvideo.notification_configurations |
Fields
The following fields are returned by SELECT queries:
- describe_notification_configuration
| Name | Datatype | Description |
|---|---|---|
destination_config | object | The destination information required to deliver a notification to a customer. |
status | string | Indicates if a notification configuration is enabled or disabled. (ENABLED, DISABLED) |
Methods
The following methods are available for this resource:
| Name | Accessible by | Required Params | Optional Params | Description |
|---|---|---|---|---|
describe_notification_configuration | select | region | Gets the NotificationConfiguration for a given Kinesis video stream. | |
update_notification_configuration | update | region | Updates the notification information for a stream. |
Parameters
Parameters can be passed in the WHERE clause of a query. Check the Methods section to see which parameters are required or optional for each operation.
| Name | Datatype | Description |
|---|---|---|
region | string | AWS region (default: us-east-1) |
SELECT examples
- describe_notification_configuration
Gets the NotificationConfiguration for a given Kinesis video stream.
SELECT
destination_config,
status
FROM aws.kinesisvideo.notification_configurations
WHERE region = '{{ region }}' -- required
;
UPDATE examples
- update_notification_configuration
Updates the notification information for a stream.
UPDATE aws.kinesisvideo.notification_configurations
SET
StreamName = '{{ StreamName }}',
StreamARN = '{{ StreamARN }}',
NotificationConfiguration = '{{ NotificationConfiguration }}'
WHERE
region = '{{ region }}' --required;