Struct rusoto_kinesis::ListShardsInput [−][src]
pub struct ListShardsInput { pub exclusive_start_shard_id: Option<String>, pub max_results: Option<i64>, pub next_token: Option<String>, pub stream_creation_timestamp: Option<f64>, pub stream_name: Option<String>, }
Fields
exclusive_start_shard_id: Option<String>
The ID of the shard to start the list with.
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<i64>
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 1,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.
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
.
stream_creation_timestamp: Option<f64>
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.
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.
Trait Implementations
impl Default for ListShardsInput
[src]
impl Default for ListShardsInput
fn default() -> ListShardsInput
[src]
fn default() -> ListShardsInput
Returns the "default value" for a type. Read more
impl Debug for ListShardsInput
[src]
impl Debug for ListShardsInput
fn fmt(&self, f: &mut Formatter) -> Result
[src]
fn fmt(&self, f: &mut Formatter) -> Result
Formats the value using the given formatter. Read more
impl Clone for ListShardsInput
[src]
impl Clone for ListShardsInput
fn clone(&self) -> ListShardsInput
[src]
fn clone(&self) -> ListShardsInput
Returns a copy of the value. Read more
fn clone_from(&mut self, source: &Self)
1.0.0[src]
fn clone_from(&mut self, source: &Self)
Performs copy-assignment from source
. Read more
impl PartialEq for ListShardsInput
[src]
impl PartialEq for ListShardsInput
fn eq(&self, other: &ListShardsInput) -> bool
[src]
fn eq(&self, other: &ListShardsInput) -> bool
This method tests for self
and other
values to be equal, and is used by ==
. Read more
fn ne(&self, other: &ListShardsInput) -> bool
[src]
fn ne(&self, other: &ListShardsInput) -> bool
This method tests for !=
.
Auto Trait Implementations
impl Send for ListShardsInput
impl Send for ListShardsInput
impl Sync for ListShardsInput
impl Sync for ListShardsInput