Struct ListStreamConsumersOutput 

#[non_exhaustive]
pub struct ListStreamConsumersOutput {
    pub consumers: Option<Vec<Consumer>>,
    pub next_token: Option<String>,
    /* private fields */
}

Fields (Non-exhaustive)

Non-exhaustive structs could have additional fields added in future. Therefore, non-exhaustive structs cannot be constructed in external crates using the traditional Struct { .. } syntax; cannot be matched against without a wildcard ..; and struct update syntax will not work.

consumers: Option<Vec<Consumer>>

An array of JSON objects. Each object represents one registered consumer.

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 registered consumers, 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. For more information about the use of this pagination token when calling the ListStreamConsumers operation, see ListStreamConsumersInput$NextToken.

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.

Implementations

impl ListStreamConsumersOutput

pub fn consumers(&self) -> &[Consumer]

An array of JSON objects. Each object represents one registered consumer.

If no value was sent for this field, a default will be set. If you want to determine if no value was sent, use .consumers.is_none().

pub fn next_token(&self) -> Option<&str>

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 registered consumers, 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. For more information about the use of this pagination token when calling the ListStreamConsumers operation, see ListStreamConsumersInput$NextToken.

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.

impl ListStreamConsumersOutput

pub fn builder() -> ListStreamConsumersOutputBuilder

Creates a new builder-style object to manufacture ListStreamConsumersOutput.

Trait Implementations

impl Clone for ListStreamConsumersOutput

fn clone(&self) -> ListStreamConsumersOutput

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for ListStreamConsumersOutput

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

Formats the value using the given formatter.

impl PartialEq for ListStreamConsumersOutput

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

Tests for self and other values to be equal, and is used by ==.

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

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl RequestId for ListStreamConsumersOutput

fn request_id(&self) -> Option<&str>

Returns the request ID, or None if the service could not be reached.

impl StructuralPartialEq for ListStreamConsumersOutput