KinesisVideo / Client / update_notification_configuration

update_notification_configuration#

KinesisVideo.Client.update_notification_configuration(**kwargs)#

Updates the notification information for a stream.

See also: AWS API Documentation

Request Syntax

response = client.update_notification_configuration(
    StreamName='string',
    StreamARN='string',
    NotificationConfiguration={
        'Status': 'ENABLED'|'DISABLED',
        'DestinationConfig': {
            'Uri': 'string'
        }
    }
)
Parameters:

  • StreamName (string) – The name of the stream from which to update the notification configuration. You must specify either the StreamName or the StreamARN.

  • StreamARN (string) – 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 the StreamARN.

  • NotificationConfiguration (dict) –

    The structure containing the information required for notifications. If the structure is null, the configuration will be deleted from the stream.

    • Status (string) – [REQUIRED]

      Indicates if a notification configuration is enabled or disabled.

    • DestinationConfig (dict) – [REQUIRED]

      The destination information required to deliver a notification to a customer.

      • Uri (string) – [REQUIRED]

        The Uniform Resource Identifier (URI) that identifies where the images will be delivered.

Return type:

dict

Returns:

Response Syntax

{}

Response Structure

  • (dict) –

Exceptions

  • KinesisVideo.Client.exceptions.InvalidArgumentException

  • KinesisVideo.Client.exceptions.ClientLimitExceededException

  • KinesisVideo.Client.exceptions.ResourceNotFoundException

  • KinesisVideo.Client.exceptions.AccessDeniedException

  • KinesisVideo.Client.exceptions.ResourceInUseException

  • KinesisVideo.Client.exceptions.NoDataRetentionException