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

The DescribeEdgeConfiguration API from AWS Kinesis — 1 operation(s) for describeedgeconfiguration.

AWS Kinesis DescribeEdgeConfiguration 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 DescribeEdgeConfiguration. 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 27 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 27 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 DescribeEdgeConfiguration 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.

DescribeEdgeConfiguration 1
POST
/describeEdgeConfiguration
Describes a stream’s edge configuration that was set using the StartEdgeConfigurationUpdate API. Use this API to get the status of the configuration if the configuration is in sync with the Edge Agen…
DescribeEdgeConfiguration 7 params body → 200480481482483484

Schemas 27

The contract defines 27 schemas that model the data the API accepts and returns. The most detailed are DescribeEdgeConfigurationOutput (7 properties), EdgeConfig (4 properties), DeletionConfig (3 properties), ScheduleConfig (2 properties). Each schema is shown below with its type and property counts.

MaxLocalMediaSizeInMB
integer
UploaderConfig
object
The configuration that consists of the ScheduleExpression and the DurationInMinutesdetails , that specify the scheduling to record from a camera, or local medi…
1 property 1 required
SyncStatus
string
ResourceARN
string
MediaUriType
string
LocalSizeConfig
object
The configuration details that include the maximum size of the media ( MaxLocalMediaSizeInMB ) that you want to store for a stream on the Edge Agent, as well a…
2 properties
EdgeRetentionInHours
integer
DeleteAfterUpload
boolean
AccessDeniedException
InvalidArgumentException
EdgeConfig
object
A description of the stream's edge configuration that will be used to sync with the Edge Agent IoT Greengrass component. The Edge Agent component will run on a…
4 properties 2 required
HubDeviceArn
string
FailedStatusDetails
string
ResourceNotFoundException
DescribeEdgeConfigurationOutput
object
7 properties
RecorderConfig
object
The recorder configuration consists of the local MediaSourceConfig details that are used as credentials to accesss the local media files streamed on the camera.
2 properties 1 required
StreamName
string
DeletionConfig
object
The configuration details required to delete the connection of the stream from the Edge Agent.
3 properties
StrategyOnFullSize
string
MediaSourceConfig
object
The configuration details that consist of the credentials required ( MediaUriSecretArn and MediaUriType ) to access the media files that are streamed to the ca…
2 properties 2 required
StreamEdgeConfigurationNotFoundException
ClientLimitExceededException
ScheduleConfig
object
This API enables you to specify the duration that the camera, or local media file, should record onto the Edge Agent. The ScheduleConfig consists of the Schedu…
2 properties 2 required
ScheduleExpression
string
Timestamp
string
MediaUriSecretArn
string
DurationInSeconds
integer

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

kinesis-describeedgeconfiguration-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 DescribeImageGenerationConfiguration API
AWS Kinesis DescribeMappedResourceConfiguration API
AWS Kinesis DescribeMediaStorageConfiguration API
AWS Kinesis DescribeNotificationConfiguration API
AWS Kinesis DescribeSignalingChannel API
AWS Kinesis DescribeStream API
AWS Kinesis GetDataEndpoint API