Struct aws_sdk_kinesis::input::ListShardsInput [−][src]
#[non_exhaustive]pub struct ListShardsInput {
pub stream_name: Option<String>,
pub next_token: Option<String>,
pub exclusive_start_shard_id: Option<String>,
pub max_results: Option<i32>,
pub stream_creation_timestamp: Option<Instant>,
pub shard_filter: Option<ShardFilter>,
}
Fields (Non-exhaustive)
This struct is marked as non-exhaustive
Struct { .. }
syntax; cannot be matched against without a wildcard ..
; and struct update syntax will not work.stream_name: Option<String>
The name of the data stream whose shards you want to list.
You cannot specify this parameter if you specify the NextToken
parameter.
next_token: Option<String>
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
.
exclusive_start_shard_id: Option<String>
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
.
max_results: Option<i32>
The maximum number of shards to return in a single call to ListShards
.
The minimum value you can specify for this parameter is 1, and the maximum is 10,000,
which is also the default.
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.
stream_creation_timestamp: Option<Instant>
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.
shard_filter: Option<ShardFilter>
Implementations
pub async fn make_operation(
&self,
_config: &Config
) -> Result<Operation<ListShards, AwsErrorRetryPolicy>, BuildError>
pub async fn make_operation(
&self,
_config: &Config
) -> Result<Operation<ListShards, AwsErrorRetryPolicy>, BuildError>
Consumes the builder and constructs an Operation<ListShards
>
Creates a new builder-style object to manufacture ListShardsInput
The name of the data stream whose shards you want to list.
You cannot specify this parameter if you specify the NextToken
parameter.
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
.
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
.
The maximum number of shards to return in a single call to ListShards
.
The minimum value you can specify for this parameter is 1, and the maximum is 10,000,
which is also the default.
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.
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.
Trait Implementations
This method tests for self
and other
values to be equal, and is used
by ==
. Read more
This method tests for !=
.
Auto Trait Implementations
impl RefUnwindSafe for ListShardsInput
impl Send for ListShardsInput
impl Sync for ListShardsInput
impl Unpin for ListShardsInput
impl UnwindSafe for ListShardsInput
Blanket Implementations
Mutably borrows from an owned value. Read more
Attaches the provided Subscriber
to this type, returning a
WithDispatch
wrapper. Read more
Attaches the current default Subscriber
to this type, returning a
WithDispatch
wrapper. Read more