UpdateNotificationConfiguration
Updates the notification information for a stream.
Request Syntax
POST /updateNotificationConfiguration HTTP/1.1
Content-type: application/json
{
"NotificationConfiguration": {
"DestinationConfig": {
"Uri": "string
"
},
"Status": "string
"
},
"StreamARN": "string
",
"StreamName": "string
"
}
URI Request Parameters
The request does not use any URI parameters.
Request Body
The request accepts the following data in JSON format.
- NotificationConfiguration
-
The structure containing the information required for notifications. If the structure is null, the configuration will be deleted from the stream.
Type: NotificationConfiguration object
Required: No
- StreamARN
-
The Amazon Resource Name (ARN) of the Kinesis video stream from where you want to update the notification configuration. You must specify either the
StreamName
or theStreamARN
.Type: String
Length Constraints: Minimum length of 1. Maximum length of 1024.
Pattern:
arn:[a-z\d-]+:kinesisvideo:[a-z0-9-]+:[0-9]+:[a-z]+/[a-zA-Z0-9_.-]+/[0-9]+
Required: No
- StreamName
-
The name of the stream from which to update the notification configuration. You must specify either the
StreamName
or theStreamARN
.Type: String
Length Constraints: Minimum length of 1. Maximum length of 256.
Pattern:
[a-zA-Z0-9_.-]+
Required: No
Response Syntax
HTTP/1.1 200
Response Elements
If the action is successful, the service sends back an HTTP 200 response with an empty HTTP body.
Errors
For information about the errors that are common to all actions, see Common Errors.
- AccessDeniedException
-
You do not have required permissions to perform this operation.
HTTP Status Code: 401
- ClientLimitExceededException
-
Kinesis Video Streams has throttled the request because you have exceeded the limit of allowed client calls. Try making the call later.
HTTP Status Code: 400
- InvalidArgumentException
-
The value for this input parameter is invalid.
HTTP Status Code: 400
- NoDataRetentionException
-
The Stream data retention in hours is equal to zero.
HTTP Status Code: 400
- ResourceInUseException
-
The resource is currently not available for this operation. New resources cannot be created with the same name as existing resources. Also, resources cannot be updated or deleted unless they are in an
ACTIVE
state.If this exception is returned, do not use it to determine whether the requested resource already exists. Instead, it is recommended you use the resource-specific describe API, for example,
DescribeStream
for video streams.HTTP Status Code: 400
- ResourceNotFoundException
-
Amazon Kinesis Video Streams can't find the stream that you specified.
HTTP Status Code: 404
See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following: