Copyright | (c) 2013-2023 Brendan Hay |
---|---|
License | Mozilla Public License, v. 2.0. |
Maintainer | Brendan Hay |
Stability | auto-generated |
Portability | non-portable (GHC extensions) |
Safe Haskell | Safe-Inferred |
Language | Haskell2010 |
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 the StreamARN
input
parameter rather than the StreamName
input parameter.
This action does not list expired shards. For information about expired shards, see Data Routing, Data Persistence, and Shard State after a Reshard.
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.
This operation returns paginated results.
Synopsis
- data ListShards = ListShards' {}
- newListShards :: ListShards
- listShards_exclusiveStartShardId :: Lens' ListShards (Maybe Text)
- listShards_maxResults :: Lens' ListShards (Maybe Natural)
- listShards_nextToken :: Lens' ListShards (Maybe Text)
- listShards_shardFilter :: Lens' ListShards (Maybe ShardFilter)
- listShards_streamARN :: Lens' ListShards (Maybe Text)
- listShards_streamCreationTimestamp :: Lens' ListShards (Maybe UTCTime)
- listShards_streamName :: Lens' ListShards (Maybe Text)
- data ListShardsResponse = ListShardsResponse' {}
- newListShardsResponse :: Int -> ListShardsResponse
- listShardsResponse_nextToken :: Lens' ListShardsResponse (Maybe Text)
- listShardsResponse_shards :: Lens' ListShardsResponse (Maybe [Shard])
- listShardsResponse_httpStatus :: Lens' ListShardsResponse Int
Creating a Request
data ListShards Source #
See: newListShards
smart constructor.
ListShards' | |
|
Instances
newListShards :: ListShards Source #
Create a value of ListShards
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:exclusiveStartShardId:ListShards'
, listShards_exclusiveStartShardId
- Specify this parameter to indicate that you want to list the shards
starting with the shard whose ID immediately follows
ExclusiveStartShardId
.
If you don't specify this parameter, the default behavior is for
ListShards
to list the shards starting with the first one in the
stream.
You cannot specify this parameter if you specify NextToken
.
$sel:maxResults:ListShards'
, listShards_maxResults
- The maximum number of shards to return in a single call to ListShards
.
The maximum number of shards to return in a single call. The default
value is 1000. If you specify a value greater than 1000, at most 1000
results are returned.
When the number of shards to be listed is greater than the value of
MaxResults
, the response contains a NextToken
value that you can use
in a subsequent call to ListShards
to list the next set of shards.
ListShards
, listShards_nextToken
- When the number of shards in the data stream is greater than the default
value for the MaxResults
parameter, or if you explicitly specify a
value for MaxResults
that is less than the number of shards in the
data stream, the response includes a pagination token named NextToken
.
You can specify this NextToken
value in a subsequent call to
ListShards
to list the next set of shards.
Don't specify StreamName
or StreamCreationTimestamp
if you specify
NextToken
because the latter unambiguously identifies the stream.
You can optionally specify a value for the MaxResults
parameter when
you specify NextToken
. If you specify a MaxResults
value that is
less than the number of shards that the operation returns if you don't
specify MaxResults
, the response will contain a new NextToken
value.
You can use the new NextToken
value in a subsequent call to the
ListShards
operation.
Tokens expire after 300 seconds. When you obtain a value for NextToken
in the response to a call to ListShards
, you have 300 seconds to use
that value. If you specify an expired token in a call to ListShards
,
you get ExpiredNextTokenException
.
$sel:shardFilter:ListShards'
, listShards_shardFilter
- Enables you to filter out the response of the ListShards
API. You can
only specify one filter at a time.
If you use the ShardFilter
parameter when invoking the ListShards API,
the Type
is the required property and must be specified. If you
specify the AT_TRIM_HORIZON
, FROM_TRIM_HORIZON
, or AT_LATEST
types, you do not need to specify either the ShardId
or the
Timestamp
optional properties.
If you specify the AFTER_SHARD_ID
type, you must also provide the
value for the optional ShardId
property. The ShardId
property is
identical in fuctionality to the ExclusiveStartShardId
parameter of
the ListShards
API. When ShardId
property is specified, the response
includes the shards starting with the shard whose ID immediately follows
the ShardId
that you provided.
If you specify the AT_TIMESTAMP
or FROM_TIMESTAMP_ID
type, you must
also provide the value for the optional Timestamp
property. If you
specify the AT_TIMESTAMP type, then all shards that were open at the
provided timestamp are returned. If you specify the FROM_TIMESTAMP type,
then all shards starting from the provided timestamp to TIP are
returned.
ListShards
, listShards_streamARN
- The ARN of the stream.
ListShards
, listShards_streamCreationTimestamp
- Specify this input parameter to distinguish data streams that have the
same name. For example, if you create a data stream and then delete it,
and you later create another data stream with the same name, you can use
this input parameter to specify which of the two streams you want to
list the shards for.
You cannot specify this parameter if you specify the NextToken
parameter.
ListShards
, listShards_streamName
- The name of the data stream whose shards you want to list.
You cannot specify this parameter if you specify the NextToken
parameter.
Request Lenses
listShards_exclusiveStartShardId :: Lens' ListShards (Maybe Text) Source #
Specify this parameter to indicate that you want to list the shards
starting with the shard whose ID immediately follows
ExclusiveStartShardId
.
If you don't specify this parameter, the default behavior is for
ListShards
to list the shards starting with the first one in the
stream.
You cannot specify this parameter if you specify NextToken
.
listShards_maxResults :: Lens' ListShards (Maybe Natural) Source #
The maximum number of shards to return in a single call to ListShards
.
The maximum number of shards to return in a single call. The default
value is 1000. If you specify a value greater than 1000, at most 1000
results are returned.
When the number of shards to be listed is greater than the value of
MaxResults
, the response contains a NextToken
value that you can use
in a subsequent call to ListShards
to list the next set of shards.
listShards_nextToken :: Lens' ListShards (Maybe Text) Source #
When the number of shards in the data stream is greater than the default
value for the MaxResults
parameter, or if you explicitly specify a
value for MaxResults
that is less than the number of shards in the
data stream, the response includes a pagination token named NextToken
.
You can specify this NextToken
value in a subsequent call to
ListShards
to list the next set of shards.
Don't specify StreamName
or StreamCreationTimestamp
if you specify
NextToken
because the latter unambiguously identifies the stream.
You can optionally specify a value for the MaxResults
parameter when
you specify NextToken
. If you specify a MaxResults
value that is
less than the number of shards that the operation returns if you don't
specify MaxResults
, the response will contain a new NextToken
value.
You can use the new NextToken
value in a subsequent call to the
ListShards
operation.
Tokens expire after 300 seconds. When you obtain a value for NextToken
in the response to a call to ListShards
, you have 300 seconds to use
that value. If you specify an expired token in a call to ListShards
,
you get ExpiredNextTokenException
.
listShards_shardFilter :: Lens' ListShards (Maybe ShardFilter) Source #
Enables you to filter out the response of the ListShards
API. You can
only specify one filter at a time.
If you use the ShardFilter
parameter when invoking the ListShards API,
the Type
is the required property and must be specified. If you
specify the AT_TRIM_HORIZON
, FROM_TRIM_HORIZON
, or AT_LATEST
types, you do not need to specify either the ShardId
or the
Timestamp
optional properties.
If you specify the AFTER_SHARD_ID
type, you must also provide the
value for the optional ShardId
property. The ShardId
property is
identical in fuctionality to the ExclusiveStartShardId
parameter of
the ListShards
API. When ShardId
property is specified, the response
includes the shards starting with the shard whose ID immediately follows
the ShardId
that you provided.
If you specify the AT_TIMESTAMP
or FROM_TIMESTAMP_ID
type, you must
also provide the value for the optional Timestamp
property. If you
specify the AT_TIMESTAMP type, then all shards that were open at the
provided timestamp are returned. If you specify the FROM_TIMESTAMP type,
then all shards starting from the provided timestamp to TIP are
returned.
listShards_streamARN :: Lens' ListShards (Maybe Text) Source #
The ARN of the stream.
listShards_streamCreationTimestamp :: Lens' ListShards (Maybe UTCTime) Source #
Specify this input parameter to distinguish data streams that have the same name. For example, if you create a data stream and then delete it, and you later create another data stream with the same name, you can use this input parameter to specify which of the two streams you want to list the shards for.
You cannot specify this parameter if you specify the NextToken
parameter.
listShards_streamName :: Lens' ListShards (Maybe Text) Source #
The name of the data stream whose shards you want to list.
You cannot specify this parameter if you specify the NextToken
parameter.
Destructuring the Response
data ListShardsResponse Source #
See: newListShardsResponse
smart constructor.
ListShardsResponse' | |
|
Instances
newListShardsResponse Source #
Create a value of ListShardsResponse
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
ListShards
, listShardsResponse_nextToken
- When the number of shards in the data stream is greater than the default
value for the MaxResults
parameter, or if you explicitly specify a
value for MaxResults
that is less than the number of shards in the
data stream, the response includes a pagination token named NextToken
.
You can specify this NextToken
value in a subsequent call to
ListShards
to list the next set of shards. For more information about
the use of this pagination token when calling the ListShards
operation, see ListShardsInput$NextToken.
Tokens expire after 300 seconds. When you obtain a value for NextToken
in the response to a call to ListShards
, you have 300 seconds to use
that value. If you specify an expired token in a call to ListShards
,
you get ExpiredNextTokenException
.
ListShardsResponse
, listShardsResponse_shards
- An array of JSON objects. Each object represents one shard and specifies
the IDs of the shard, the shard's parent, and the shard that's
adjacent to the shard's parent. Each object also contains the starting
and ending hash keys and the starting and ending sequence numbers for
the shard.
$sel:httpStatus:ListShardsResponse'
, listShardsResponse_httpStatus
- The response's http status code.
Response Lenses
listShardsResponse_nextToken :: Lens' ListShardsResponse (Maybe Text) Source #
When the number of shards in the data stream is greater than the default
value for the MaxResults
parameter, or if you explicitly specify a
value for MaxResults
that is less than the number of shards in the
data stream, the response includes a pagination token named NextToken
.
You can specify this NextToken
value in a subsequent call to
ListShards
to list the next set of shards. For more information about
the use of this pagination token when calling the ListShards
operation, see ListShardsInput$NextToken.
Tokens expire after 300 seconds. When you obtain a value for NextToken
in the response to a call to ListShards
, you have 300 seconds to use
that value. If you specify an expired token in a call to ListShards
,
you get ExpiredNextTokenException
.
listShardsResponse_shards :: Lens' ListShardsResponse (Maybe [Shard]) Source #
An array of JSON objects. Each object represents one shard and specifies the IDs of the shard, the shard's parent, and the shard that's adjacent to the shard's parent. Each object also contains the starting and ending hash keys and the starting and ending sequence numbers for the shard.
listShardsResponse_httpStatus :: Lens' ListShardsResponse Int Source #
The response's http status code.