Need help with your APIs? I offer API discovery, governance & evangelism services. Explore services →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

AWS Kinesis DescribeNotificationConfiguration API

The DescribeNotificationConfiguration API from AWS Kinesis — 1 operation(s) for describenotificationconfiguration.

AWS Kinesis DescribeNotificationConfiguration API is one of 100 APIs that AWS Kinesis publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

Tagged areas include DescribeNotificationConfiguration. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, pricing, and a getting-started guide.

This API exposes 1 operation across 1 path, and defines 9 schemas. It is described by OpenAPI 3.0.0, at version 2015-08-04.

Requests are made against 4 base URLs: http://firehose.{region}.amazonaws.com, https://firehose.{region}.amazonaws.com, http://firehose.{region}.amazonaws.com.cn, https://firehose.{region}.amazonaws.com.cn.

1 operations 1 paths 9 schemas 1 POST

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.0.0
API Version
2015-08-04
Base URL
https://kinesis.{region}.amazonaws.com
Authentication
API Key
Terms of Service
Resource Areas
1

Authentication & Security 1

AWS Kinesis DescribeNotificationConfiguration API declares 1 security scheme for authenticating requests. An API key is passed in the header as Authorization (hmac). By default, every request must be authenticated.

  • hmac — Amazon Signature authorization v4

Paths & Operations 1

Across 1 path, the API surfaces 1 operation — 1 POST. Each is listed below with its method, path, parameters, and response codes.

DescribeNotificationConfiguration 1
POST
/describeNotificationConfiguration
Gets the NotificationConfiguration for a given Kinesis video stream.
DescribeNotificationConfiguration 7 params body → 200480481482483

Schemas 9

The contract defines 9 schemas that model the data the API accepts and returns. The most detailed are NotificationConfiguration (2 properties), DescribeNotificationConfigurationOutput (1 property), NotificationDestinationConfig (1 property). Each schema is shown below with its type and property counts.

DescribeNotificationConfigurationOutput
object
1 property
NotificationConfiguration
object
The structure that contains the notification information for the KVS images delivery. If this parameter is null, the configuration will be deleted from the str…
2 properties 2 required
DestinationUri
string
ClientLimitExceededException
ResourceNotFoundException
AccessDeniedException
NotificationDestinationConfig
object
The structure that contains the information required to deliver a notification to a customer.
1 property 1 required
InvalidArgumentException
ConfigurationStatus
string

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

kinesis-describenotificationconfiguration-api-openapi.yml Raw ↑

Other APIs AWS Kinesis publishes across the network.

Amazon Managed Service for Apache Flink API
AWS Kinesis CreateSignalingChannel API
AWS Kinesis CreateStream API
AWS Kinesis DeleteSignalingChannel API
AWS Kinesis DeleteStream API
AWS Kinesis DescribeEdgeConfiguration API
AWS Kinesis DescribeImageGenerationConfiguration API
AWS Kinesis DescribeMappedResourceConfiguration API
AWS Kinesis DescribeMediaStorageConfiguration API
AWS Kinesis DescribeSignalingChannel API
AWS Kinesis DescribeStream API
AWS Kinesis GetDataEndpoint API