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 ListSignalingChannels API

The ListSignalingChannels API from AWS Kinesis — 1 operation(s) for listsignalingchannels.

AWS Kinesis ListSignalingChannels 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 ListSignalingChannels. 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 16 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 16 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 ListSignalingChannels 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.

ListSignalingChannels 1
POST
/listSignalingChannels
Returns an array of ChannelInfo objects. Each object describes a signaling channel. To retrieve only those channels that satisfy a specific condition, you can specify a ChannelNameCondition .
ListSignalingChannels 9 params body → 200480481482

Schemas 16

The contract defines 16 schemas that model the data the API accepts and returns. The most detailed are ChannelInfo (7 properties), ListSignalingChannelsOutput (2 properties), SingleMasterConfiguration (1 property). Each schema is shown below with its type and property counts.

ListSignalingChannelsOutput
object
2 properties
SingleMasterConfiguration
object
A structure that contains the configuration for the SINGLEMASTER channel type.
1 property
ResourceARN
string
NextToken
string
ComparisonOperator
string
AccessDeniedException
InvalidArgumentException
ChannelInfo
object
A structure that encapsulates a signaling channel's metadata and properties.
7 properties
ChannelType
string
ChannelInfoList
array
ChannelName
string
Version
string
ClientLimitExceededException
Timestamp
string
MessageTtlSeconds
integer
Status
string

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

kinesis-listsignalingchannels-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 DescribeNotificationConfiguration API
AWS Kinesis DescribeSignalingChannel API
AWS Kinesis DescribeStream API