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 #X Amz Target=Firehose 20150804.StartDeliveryStreamEncryption API

The #X Amz Target=Firehose 20150804.StartDeliveryStreamEncryption API from AWS Kinesis — 1 operation(s) for #x amz target=firehose 20150804.startdeliverystreamencryption.

AWS Kinesis #X Amz Target=Firehose 20150804.StartDeliveryStreamEncryption 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 #X Amz Target=Firehose 20150804.StartDeliveryStreamEncryption. 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 11 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 11 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 #X Amz Target=Firehose 20150804.StartDeliveryStreamEncryption 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.

#X Amz Target=Firehose 20150804.StartDeliveryStreamEncryption 1
POST
/#X-Amz-Target=Firehose_20150804.StartDeliveryStreamEncryption
Enables server-side encryption (SSE) for the delivery stream. This operation is asynchronous. It returns immediately. When you invoke it, Kinesis Data Firehose first sets the encryption status of the…
StartDeliveryStreamEncryption 8 params body → 200480481482483484

Schemas 11

The contract defines 11 schemas that model the data the API accepts and returns. The most detailed are DeliveryStreamEncryptionConfigurationInput (2 properties), StartDeliveryStreamEncryptionInput (2 properties). Each schema is shown below with its type and property counts.

LimitExceededException
KeyType
string
ResourceNotFoundException
StartDeliveryStreamEncryptionOutput
object
StartDeliveryStreamEncryptionInput
object
2 properties 1 required
ResourceInUseException
InvalidKMSResourceException
AWSKMSKeyARN
string
DeliveryStreamName
string
InvalidArgumentException
DeliveryStreamEncryptionConfigurationInput
object
Specifies the type and Amazon Resource Name (ARN) of the CMK to use for Server-Side Encryption (SSE).
2 properties 1 required

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

kinesis-x-amz-target-firehose-20150804-startdeliverystreamencryption-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