/AWS1/CL_KNSLISTSTREAMCONSOUT

ListStreamConsumersOutput

CONSTRUCTOR

IMPORTING

Optional arguments:

it_consumers TYPE /AWS1/CL_KNSCONSUMER=>TT_CONSUMERLIST TT_CONSUMERLIST

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

iv_nexttoken TYPE /AWS1/KNSNEXTTOKEN /AWS1/KNSNEXTTOKEN

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.

---

Queryable Attributes

Consumers

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

Accessible with the following methods

Method	Description
GET_CONSUMERS()	Getter for CONSUMERS, with configurable default
ASK_CONSUMERS()	Getter for CONSUMERS w/ exceptions if field has no value
HAS_CONSUMERS()	Determine if CONSUMERS has a value

NextToken

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.

Accessible with the following methods

Method	Description
GET_NEXTTOKEN()	Getter for NEXTTOKEN, with configurable default
ASK_NEXTTOKEN()	Getter for NEXTTOKEN w/ exceptions if field has no value
HAS_NEXTTOKEN()	Determine if NEXTTOKEN has a value