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

The DescribeImageGenerationConfiguration API from AWS Kinesis — 1 operation(s) for describeimagegenerationconfiguration.

AWS Kinesis DescribeImageGenerationConfiguration 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 DescribeImageGenerationConfiguration. 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 17 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 17 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 DescribeImageGenerationConfiguration 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.

DescribeImageGenerationConfiguration 1
POST
/describeImageGenerationConfiguration
Gets the ImageGenerationConfiguration for a given Kinesis video stream.
DescribeImageGenerationConfiguration 7 params body → 200480481482483

Schemas 17

The contract defines 17 schemas that model the data the API accepts and returns. The most detailed are ImageGenerationConfiguration (8 properties), ImageGenerationDestinationConfig (2 properties), DescribeImageGenerationConfigurationOutput (1 property). Each schema is shown below with its type and property counts.

DestinationUri
string
SamplingInterval
integer
DescribeImageGenerationConfigurationOutput
object
1 property
DestinationRegion
string
AccessDeniedException
FormatConfigValue
string
FormatConfig
object
InvalidArgumentException
ImageGenerationConfiguration
object
The structure that contains the information required for the KVS images delivery. If null, the configuration will be deleted from the stream.
8 properties 5 required
ResourceNotFoundException
ImageGenerationDestinationConfig
object
The structure that contains the information required to deliver images to a customer.
2 properties 2 required
WidthPixels
integer
Format
string
HeightPixels
integer
ClientLimitExceededException
ImageSelectorType
string
ConfigurationStatus
string

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

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