KinesisVideo / Client / describe_notification_configuration

describe_notification_configuration#

KinesisVideo.Client.describe_notification_configuration(**kwargs)#

Gets the NotificationConfiguration for a given Kinesis video stream.

See also: AWS API Documentation

Request Syntax

response = client.describe_notification_configuration(
    StreamName='string',
    StreamARN='string'
)
Parameters:

  • StreamName (string) – The name of the stream from which to retrieve 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 retrieve the notification configuration. You must specify either the StreamName or the StreamARN.

Return type:

dict

Returns:

Response Syntax

{
    'NotificationConfiguration': {
        'Status': 'ENABLED'|'DISABLED',
        'DestinationConfig': {
            'Uri': 'string'
        }
    }
}

Response Structure

  • (dict) –

    • NotificationConfiguration (dict) –

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

      • Status (string) –

        Indicates if a notification configuration is enabled or disabled.

      • DestinationConfig (dict) –

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

        • Uri (string) –

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

Exceptions

  • KinesisVideo.Client.exceptions.InvalidArgumentException

  • KinesisVideo.Client.exceptions.ClientLimitExceededException

  • KinesisVideo.Client.exceptions.ResourceNotFoundException

  • KinesisVideo.Client.exceptions.AccessDeniedException