Struct rusoto_kinesis::ListStreamConsumersInput

pub struct ListStreamConsumersInput {
    pub max_results: Option<i64>,
    pub next_token: Option<String>,
    pub stream_arn: String,
    pub stream_creation_timestamp: Option<f64>,
}

Fields

max_results: Option<i64>

The maximum number of consumers that you want a single call of ListStreamConsumers to return.

next_token: Option<String>

When the number of consumers that are registered with 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 consumers that are registered with the data stream, the response includes a pagination token named NextToken. You can specify this NextToken value in a subsequent call to ListStreamConsumers to list the next set of registered consumers.

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 consumers 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 ListStreamConsumers operation to list the next set of consumers.

Tokens expire after 300 seconds. When you obtain a value for NextToken in the response to a call to ListStreamConsumers, you have 300 seconds to use that value. If you specify an expired token in a call to ListStreamConsumers, you get ExpiredNextTokenException.

stream_arn: String

The ARN of the Kinesis data stream for which you want to list the registered consumers. For more information, see Amazon Resource Names (ARNs) and AWS Service Namespaces.

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 consumers for.

You can't specify this parameter if you specify the NextToken parameter.

Trait Implementations

impl Clone for ListStreamConsumersInput

pub fn clone(&self) -> ListStreamConsumersInput

Returns a copy of the value.

pub fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for ListStreamConsumersInput

pub fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl Default for ListStreamConsumersInput

pub fn default() -> ListStreamConsumersInput

Returns the "default value" for a type.

impl PartialEq<ListStreamConsumersInput> for ListStreamConsumersInput

pub fn eq(&self, other: &ListStreamConsumersInput) -> bool

This method tests for self and other values to be equal, and is used by ==.

pub fn ne(&self, other: &ListStreamConsumersInput) -> bool

This method tests for !=.

impl Serialize for ListStreamConsumersInput

pub fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error> where
    __S: Serializer, 

Serialize this value into the given Serde serializer.

impl StructuralPartialEq for ListStreamConsumersInput