Struct aws_sdk_kinesis::client::fluent_builders::ListShards
source · pub struct ListShards { /* private fields */ }
Expand description
Fluent builder constructing a request to 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 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.
Implementations§
source§impl ListShards
impl ListShards
sourcepub async fn customize(
self
) -> Result<CustomizableOperation<ListShards, AwsResponseRetryClassifier>, SdkError<ListShardsError>>
pub async fn customize(
self
) -> Result<CustomizableOperation<ListShards, AwsResponseRetryClassifier>, SdkError<ListShardsError>>
Consume this builder, creating a customizable operation that can be modified before being sent. The operation’s inner http::Request can be modified as well.
sourcepub async fn send(self) -> Result<ListShardsOutput, SdkError<ListShardsError>>
pub async fn send(self) -> Result<ListShardsOutput, SdkError<ListShardsError>>
Sends the request and returns the response.
If an error occurs, an SdkError
will be returned with additional details that
can be matched against.
By default, any retryable failures will be retried twice. Retry behavior is configurable with the RetryConfig, which can be set when configuring the client.
sourcepub fn stream_name(self, input: impl Into<String>) -> Self
pub fn stream_name(self, input: impl Into<String>) -> Self
The name of the data stream whose shards you want to list.
You cannot specify this parameter if you specify the NextToken
parameter.
sourcepub fn set_stream_name(self, input: Option<String>) -> Self
pub fn set_stream_name(self, input: Option<String>) -> Self
The name of the data stream whose shards you want to list.
You cannot specify this parameter if you specify the NextToken
parameter.
sourcepub fn next_token(self, input: impl Into<String>) -> Self
pub fn next_token(self, input: impl Into<String>) -> Self
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
.
sourcepub fn set_next_token(self, input: Option<String>) -> Self
pub fn set_next_token(self, input: Option<String>) -> Self
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
.
sourcepub fn exclusive_start_shard_id(self, input: impl Into<String>) -> Self
pub fn exclusive_start_shard_id(self, input: impl Into<String>) -> Self
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
.
sourcepub fn set_exclusive_start_shard_id(self, input: Option<String>) -> Self
pub fn set_exclusive_start_shard_id(self, input: Option<String>) -> Self
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
.
sourcepub fn max_results(self, input: i32) -> Self
pub fn max_results(self, input: i32) -> Self
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.
sourcepub fn set_max_results(self, input: Option<i32>) -> Self
pub fn set_max_results(self, input: Option<i32>) -> Self
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.
sourcepub fn stream_creation_timestamp(self, input: DateTime) -> Self
pub fn stream_creation_timestamp(self, input: DateTime) -> Self
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.
sourcepub fn set_stream_creation_timestamp(self, input: Option<DateTime>) -> Self
pub fn set_stream_creation_timestamp(self, input: Option<DateTime>) -> Self
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.
sourcepub fn shard_filter(self, input: ShardFilter) -> Self
pub fn shard_filter(self, input: ShardFilter) -> Self
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.
sourcepub fn set_shard_filter(self, input: Option<ShardFilter>) -> Self
pub fn set_shard_filter(self, input: Option<ShardFilter>) -> Self
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.
sourcepub fn stream_arn(self, input: impl Into<String>) -> Self
pub fn stream_arn(self, input: impl Into<String>) -> Self
The ARN of the stream.
sourcepub fn set_stream_arn(self, input: Option<String>) -> Self
pub fn set_stream_arn(self, input: Option<String>) -> Self
The ARN of the stream.
Trait Implementations§
source§impl Clone for ListShards
impl Clone for ListShards
source§fn clone(&self) -> ListShards
fn clone(&self) -> ListShards
1.0.0 · source§fn clone_from(&mut self, source: &Self)
fn clone_from(&mut self, source: &Self)
source
. Read more