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=Kinesis 20131202.ListShards API

The #X Amz Target=Kinesis 20131202.ListShards API from AWS Kinesis — 1 operation(s) for #x amz target=kinesis 20131202.listshards.

AWS Kinesis #X Amz Target=Kinesis 20131202.ListShards 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=Kinesis 20131202.ListShards. 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 22 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 22 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=Kinesis 20131202.ListShards 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=Kinesis 20131202.ListShards 1
POST
/#X-Amz-Target=Kinesis_20131202.ListShards
Lists the shards in a stream and provides information about each shard. This operation has a limit of 1000 transactions per second per data stream. When invoking this API, it is recommended you use t…
ListShards 8 params body → 200480481482483484485

Schemas 22

The contract defines 22 schemas that model the data the API accepts and returns. The most detailed are ListShardsInput (7 properties), Shard (5 properties), ShardFilter (3 properties), ListShardsOutput (2 properties). Each schema is shown below with its type and property counts.

ShardFilterType
string
ShardList
array
ListShardsInputLimit
integer
SequenceNumberRange
object
The range of possible sequence numbers for the shard.
2 properties 1 required
NextToken
string
SequenceNumber
string
ListShardsOutput
object
2 properties
AccessDeniedException
ShardFilter
object
The request parameter used to filter out the response of the ListShards API.
3 properties 1 required
InvalidArgumentException
HashKey
string
LimitExceededException
StreamARN
string
ResourceNotFoundException
ResourceInUseException
ListShardsInput
object
7 properties
StreamName
string
ExpiredNextTokenException
HashKeyRange
object
The range of possible hash key values for the shard, which is a set of ordered contiguous positive integers.
2 properties 2 required
Timestamp
string
ShardId
string
Shard
object
A uniquely identified group of data records in a Kinesis data stream.
5 properties 3 required

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

kinesis-x-amz-target-kinesis-20131202-listshards-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