AWS SDK Version 3 for .NET
API Reference

AWS services or capabilities described in AWS Documentation may vary by region/location. Click Getting Started with Amazon AWS to see specific differences applicable to the China (Beijing) Region.

Lists the shards in a stream and provides information about each shard. This operation has a limit of 100 transactions per second per data stream.

This API is a new operation that is used by the Amazon Kinesis Client Library (KCL). If you have a fine-grained IAM policy that only allows specific operations, you must update your policy to allow calls to this API. For more information, see Controlling Access to Amazon Kinesis Data Streams Resources Using IAM.

Note:

For .NET Core, PCL and Unity this operation is only available in asynchronous form. Please refer to ListShardsAsync.

Namespace: Amazon.Kinesis
Assembly: AWSSDK.Kinesis.dll
Version: 3.x.y.z

Syntax

C#
public virtual ListShardsResponse ListShards(
         ListShardsRequest request
)
Parameters
request
Type: Amazon.Kinesis.Model.ListShardsRequest

Container for the necessary parameters to execute the ListShards service method.

Return Value
The response from the ListShards service method, as returned by Kinesis.

Exceptions

ExceptionCondition
ExpiredNextTokenException The pagination token passed to the operation is expired.
InvalidArgumentException A specified parameter exceeds its restrictions, is not supported, or can't be used. For more information, see the returned message.
LimitExceededException The requested resource exceeds the maximum number allowed, or the number of concurrent stream requests exceeds the maximum number allowed.
ResourceInUseException The resource is not available for this operation. For successful operation, the resource must be in the ACTIVE state.
ResourceNotFoundException The requested resource could not be found. The stream might not be specified correctly.

Version Information

.NET Framework:
Supported in: 4.5, 4.0, 3.5

Portable Class Library:
Supported in: Windows Store Apps
Supported in: Windows Phone 8.1
Supported in: Xamarin Android
Supported in: Xamarin iOS (Unified)
Supported in: Xamarin.Forms

Unity:
Supported Versions: 4.6 and above
Supported Platforms: Android, iOS, Standalone

See Also