AWS SDK for C++  1.8.74
AWS SDK for C++
Public Member Functions | List of all members
Aws::Kinesis::Model::ListShardsRequest Class Reference

#include <ListShardsRequest.h>

+ Inheritance diagram for Aws::Kinesis::Model::ListShardsRequest:

Public Member Functions

 ListShardsRequest ()
 
virtual const char * GetServiceRequestName () const override
 
Aws::String SerializePayload () const override
 
Aws::Http::HeaderValueCollection GetRequestSpecificHeaders () const override
 
const Aws::StringGetStreamName () const
 
bool StreamNameHasBeenSet () const
 
void SetStreamName (const Aws::String &value)
 
void SetStreamName (Aws::String &&value)
 
void SetStreamName (const char *value)
 
ListShardsRequestWithStreamName (const Aws::String &value)
 
ListShardsRequestWithStreamName (Aws::String &&value)
 
ListShardsRequestWithStreamName (const char *value)
 
const Aws::StringGetNextToken () const
 
bool NextTokenHasBeenSet () const
 
void SetNextToken (const Aws::String &value)
 
void SetNextToken (Aws::String &&value)
 
void SetNextToken (const char *value)
 
ListShardsRequestWithNextToken (const Aws::String &value)
 
ListShardsRequestWithNextToken (Aws::String &&value)
 
ListShardsRequestWithNextToken (const char *value)
 
const Aws::StringGetExclusiveStartShardId () const
 
bool ExclusiveStartShardIdHasBeenSet () const
 
void SetExclusiveStartShardId (const Aws::String &value)
 
void SetExclusiveStartShardId (Aws::String &&value)
 
void SetExclusiveStartShardId (const char *value)
 
ListShardsRequestWithExclusiveStartShardId (const Aws::String &value)
 
ListShardsRequestWithExclusiveStartShardId (Aws::String &&value)
 
ListShardsRequestWithExclusiveStartShardId (const char *value)
 
int GetMaxResults () const
 
bool MaxResultsHasBeenSet () const
 
void SetMaxResults (int value)
 
ListShardsRequestWithMaxResults (int value)
 
const Aws::Utils::DateTimeGetStreamCreationTimestamp () const
 
bool StreamCreationTimestampHasBeenSet () const
 
void SetStreamCreationTimestamp (const Aws::Utils::DateTime &value)
 
void SetStreamCreationTimestamp (Aws::Utils::DateTime &&value)
 
ListShardsRequestWithStreamCreationTimestamp (const Aws::Utils::DateTime &value)
 
ListShardsRequestWithStreamCreationTimestamp (Aws::Utils::DateTime &&value)
 
const ShardFilterGetShardFilter () const
 
bool ShardFilterHasBeenSet () const
 
void SetShardFilter (const ShardFilter &value)
 
void SetShardFilter (ShardFilter &&value)
 
ListShardsRequestWithShardFilter (const ShardFilter &value)
 
ListShardsRequestWithShardFilter (ShardFilter &&value)
 
- Public Member Functions inherited from Aws::Kinesis::KinesisRequest
virtual ~KinesisRequest ()
 
void AddParametersToRequest (Aws::Http::HttpRequest &httpRequest) const
 
Aws::Http::HeaderValueCollection GetHeaders () const override
 
- Public Member Functions inherited from Aws::AmazonSerializableWebServiceRequest
 AmazonSerializableWebServiceRequest ()
 
virtual ~AmazonSerializableWebServiceRequest ()
 
std::shared_ptr< Aws::IOStreamGetBody () const override
 
- Public Member Functions inherited from Aws::AmazonWebServiceRequest
 AmazonWebServiceRequest ()
 
virtual ~AmazonWebServiceRequest ()=default
 
virtual void AddQueryStringParameters (Aws::Http::URI &uri) const
 
virtual void PutToPresignedUrl (Aws::Http::URI &uri) const
 
virtual bool IsStreaming () const
 
virtual bool IsEventStreamRequest () const
 
virtual bool SignBody () const
 
virtual bool IsChunked () const
 
virtual void SetRequestSignedHandler (const RequestSignedHandler &handler)
 
virtual const RequestSignedHandlerGetRequestSignedHandler () const
 
const Aws::IOStreamFactoryGetResponseStreamFactory () const
 
void SetResponseStreamFactory (const Aws::IOStreamFactory &factory)
 
virtual void SetDataReceivedEventHandler (const Aws::Http::DataReceivedEventHandler &dataReceivedEventHandler)
 
virtual void SetDataSentEventHandler (const Aws::Http::DataSentEventHandler &dataSentEventHandler)
 
virtual void SetContinueRequestHandler (const Aws::Http::ContinueRequestHandler &continueRequestHandler)
 
virtual void SetDataReceivedEventHandler (Aws::Http::DataReceivedEventHandler &&dataReceivedEventHandler)
 
virtual void SetDataSentEventHandler (Aws::Http::DataSentEventHandler &&dataSentEventHandler)
 
virtual void SetContinueRequestHandler (Aws::Http::ContinueRequestHandler &&continueRequestHandler)
 
virtual void SetRequestRetryHandler (const RequestRetryHandler &handler)
 
virtual void SetRequestRetryHandler (RequestRetryHandler &&handler)
 
virtual const Aws::Http::DataReceivedEventHandlerGetDataReceivedEventHandler () const
 
virtual const Aws::Http::DataSentEventHandlerGetDataSentEventHandler () const
 
virtual const Aws::Http::ContinueRequestHandlerGetContinueRequestHandler () const
 
virtual const RequestRetryHandlerGetRequestRetryHandler () const
 
virtual bool ShouldComputeContentMd5 () const
 

Additional Inherited Members

- Protected Member Functions inherited from Aws::AmazonWebServiceRequest
virtual void DumpBodyToUrl (Aws::Http::URI &uri) const
 

Detailed Description

Definition at line 23 of file ListShardsRequest.h.

Constructor & Destructor Documentation

◆ ListShardsRequest()

Aws::Kinesis::Model::ListShardsRequest::ListShardsRequest ( )

Member Function Documentation

◆ ExclusiveStartShardIdHasBeenSet()

bool Aws::Kinesis::Model::ListShardsRequest::ExclusiveStartShardIdHasBeenSet ( ) const
inline

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.

Definition at line 291 of file ListShardsRequest.h.

◆ GetExclusiveStartShardId()

const Aws::String& Aws::Kinesis::Model::ListShardsRequest::GetExclusiveStartShardId ( ) const
inline

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.

Definition at line 281 of file ListShardsRequest.h.

◆ GetMaxResults()

int Aws::Kinesis::Model::ListShardsRequest::GetMaxResults ( ) const
inline

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.

Definition at line 362 of file ListShardsRequest.h.

◆ GetNextToken()

const Aws::String& Aws::Kinesis::Model::ListShardsRequest::GetNextToken ( ) const
inline

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.

Definition at line 109 of file ListShardsRequest.h.

◆ GetRequestSpecificHeaders()

Aws::Http::HeaderValueCollection Aws::Kinesis::Model::ListShardsRequest::GetRequestSpecificHeaders ( ) const
overridevirtual

Reimplemented from Aws::Kinesis::KinesisRequest.

◆ GetServiceRequestName()

virtual const char* Aws::Kinesis::Model::ListShardsRequest::GetServiceRequestName ( ) const
inlineoverridevirtual

Implements Aws::AmazonWebServiceRequest.

Definition at line 32 of file ListShardsRequest.h.

◆ GetShardFilter()

const ShardFilter& Aws::Kinesis::Model::ListShardsRequest::GetShardFilter ( ) const
inline

Definition at line 457 of file ListShardsRequest.h.

◆ GetStreamCreationTimestamp()

const Aws::Utils::DateTime& Aws::Kinesis::Model::ListShardsRequest::GetStreamCreationTimestamp ( ) const
inline

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.

Definition at line 403 of file ListShardsRequest.h.

◆ GetStreamName()

const Aws::String& Aws::Kinesis::Model::ListShardsRequest::GetStreamName ( ) const
inline

The name of the data stream whose shards you want to list.

You cannot specify this parameter if you specify the NextToken parameter.

Definition at line 43 of file ListShardsRequest.h.

◆ MaxResultsHasBeenSet()

bool Aws::Kinesis::Model::ListShardsRequest::MaxResultsHasBeenSet ( ) const
inline

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.

Definition at line 372 of file ListShardsRequest.h.

◆ NextTokenHasBeenSet()

bool Aws::Kinesis::Model::ListShardsRequest::NextTokenHasBeenSet ( ) const
inline

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.

Definition at line 132 of file ListShardsRequest.h.

◆ SerializePayload()

Aws::String Aws::Kinesis::Model::ListShardsRequest::SerializePayload ( ) const
overridevirtual

Convert payload into String.

Implements Aws::AmazonSerializableWebServiceRequest.

◆ SetExclusiveStartShardId() [1/3]

void Aws::Kinesis::Model::ListShardsRequest::SetExclusiveStartShardId ( const Aws::String value)
inline

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.

Definition at line 301 of file ListShardsRequest.h.

◆ SetExclusiveStartShardId() [2/3]

void Aws::Kinesis::Model::ListShardsRequest::SetExclusiveStartShardId ( Aws::String &&  value)
inline

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.

Definition at line 311 of file ListShardsRequest.h.

◆ SetExclusiveStartShardId() [3/3]

void Aws::Kinesis::Model::ListShardsRequest::SetExclusiveStartShardId ( const char *  value)
inline

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.

Definition at line 321 of file ListShardsRequest.h.

◆ SetMaxResults()

void Aws::Kinesis::Model::ListShardsRequest::SetMaxResults ( int  value)
inline

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.

Definition at line 382 of file ListShardsRequest.h.

◆ SetNextToken() [1/3]

void Aws::Kinesis::Model::ListShardsRequest::SetNextToken ( const Aws::String value)
inline

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.

Definition at line 155 of file ListShardsRequest.h.

◆ SetNextToken() [2/3]

void Aws::Kinesis::Model::ListShardsRequest::SetNextToken ( Aws::String &&  value)
inline

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.

Definition at line 178 of file ListShardsRequest.h.

◆ SetNextToken() [3/3]

void Aws::Kinesis::Model::ListShardsRequest::SetNextToken ( const char *  value)
inline

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.

Definition at line 201 of file ListShardsRequest.h.

◆ SetShardFilter() [1/2]

void Aws::Kinesis::Model::ListShardsRequest::SetShardFilter ( const ShardFilter value)
inline

Definition at line 463 of file ListShardsRequest.h.

◆ SetShardFilter() [2/2]

void Aws::Kinesis::Model::ListShardsRequest::SetShardFilter ( ShardFilter &&  value)
inline

Definition at line 466 of file ListShardsRequest.h.

◆ SetStreamCreationTimestamp() [1/2]

void Aws::Kinesis::Model::ListShardsRequest::SetStreamCreationTimestamp ( const Aws::Utils::DateTime value)
inline

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.

Definition at line 423 of file ListShardsRequest.h.

◆ SetStreamCreationTimestamp() [2/2]

void Aws::Kinesis::Model::ListShardsRequest::SetStreamCreationTimestamp ( Aws::Utils::DateTime &&  value)
inline

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.

Definition at line 433 of file ListShardsRequest.h.

◆ SetStreamName() [1/3]

void Aws::Kinesis::Model::ListShardsRequest::SetStreamName ( const Aws::String value)
inline

The name of the data stream whose shards you want to list.

You cannot specify this parameter if you specify the NextToken parameter.

Definition at line 55 of file ListShardsRequest.h.

◆ SetStreamName() [2/3]

void Aws::Kinesis::Model::ListShardsRequest::SetStreamName ( Aws::String &&  value)
inline

The name of the data stream whose shards you want to list.

You cannot specify this parameter if you specify the NextToken parameter.

Definition at line 61 of file ListShardsRequest.h.

◆ SetStreamName() [3/3]

void Aws::Kinesis::Model::ListShardsRequest::SetStreamName ( const char *  value)
inline

The name of the data stream whose shards you want to list.

You cannot specify this parameter if you specify the NextToken parameter.

Definition at line 67 of file ListShardsRequest.h.

◆ ShardFilterHasBeenSet()

bool Aws::Kinesis::Model::ListShardsRequest::ShardFilterHasBeenSet ( ) const
inline

Definition at line 460 of file ListShardsRequest.h.

◆ StreamCreationTimestampHasBeenSet()

bool Aws::Kinesis::Model::ListShardsRequest::StreamCreationTimestampHasBeenSet ( ) const
inline

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.

Definition at line 413 of file ListShardsRequest.h.

◆ StreamNameHasBeenSet()

bool Aws::Kinesis::Model::ListShardsRequest::StreamNameHasBeenSet ( ) const
inline

The name of the data stream whose shards you want to list.

You cannot specify this parameter if you specify the NextToken parameter.

Definition at line 49 of file ListShardsRequest.h.

◆ WithExclusiveStartShardId() [1/3]

ListShardsRequest& Aws::Kinesis::Model::ListShardsRequest::WithExclusiveStartShardId ( const Aws::String value)
inline

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.

Definition at line 331 of file ListShardsRequest.h.

◆ WithExclusiveStartShardId() [2/3]

ListShardsRequest& Aws::Kinesis::Model::ListShardsRequest::WithExclusiveStartShardId ( Aws::String &&  value)
inline

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.

Definition at line 341 of file ListShardsRequest.h.

◆ WithExclusiveStartShardId() [3/3]

ListShardsRequest& Aws::Kinesis::Model::ListShardsRequest::WithExclusiveStartShardId ( const char *  value)
inline

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.

Definition at line 351 of file ListShardsRequest.h.

◆ WithMaxResults()

ListShardsRequest& Aws::Kinesis::Model::ListShardsRequest::WithMaxResults ( int  value)
inline

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.

Definition at line 392 of file ListShardsRequest.h.

◆ WithNextToken() [1/3]

ListShardsRequest& Aws::Kinesis::Model::ListShardsRequest::WithNextToken ( const Aws::String value)
inline

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.

Definition at line 224 of file ListShardsRequest.h.

◆ WithNextToken() [2/3]

ListShardsRequest& Aws::Kinesis::Model::ListShardsRequest::WithNextToken ( Aws::String &&  value)
inline

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.

Definition at line 247 of file ListShardsRequest.h.

◆ WithNextToken() [3/3]

ListShardsRequest& Aws::Kinesis::Model::ListShardsRequest::WithNextToken ( const char *  value)
inline

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.

Definition at line 270 of file ListShardsRequest.h.

◆ WithShardFilter() [1/2]

ListShardsRequest& Aws::Kinesis::Model::ListShardsRequest::WithShardFilter ( const ShardFilter value)
inline

Definition at line 469 of file ListShardsRequest.h.

◆ WithShardFilter() [2/2]

ListShardsRequest& Aws::Kinesis::Model::ListShardsRequest::WithShardFilter ( ShardFilter &&  value)
inline

Definition at line 472 of file ListShardsRequest.h.

◆ WithStreamCreationTimestamp() [1/2]

ListShardsRequest& Aws::Kinesis::Model::ListShardsRequest::WithStreamCreationTimestamp ( const Aws::Utils::DateTime value)
inline

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.

Definition at line 443 of file ListShardsRequest.h.

◆ WithStreamCreationTimestamp() [2/2]

ListShardsRequest& Aws::Kinesis::Model::ListShardsRequest::WithStreamCreationTimestamp ( Aws::Utils::DateTime &&  value)
inline

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.

Definition at line 453 of file ListShardsRequest.h.

◆ WithStreamName() [1/3]

ListShardsRequest& Aws::Kinesis::Model::ListShardsRequest::WithStreamName ( const Aws::String value)
inline

The name of the data stream whose shards you want to list.

You cannot specify this parameter if you specify the NextToken parameter.

Definition at line 73 of file ListShardsRequest.h.

◆ WithStreamName() [2/3]

ListShardsRequest& Aws::Kinesis::Model::ListShardsRequest::WithStreamName ( Aws::String &&  value)
inline

The name of the data stream whose shards you want to list.

You cannot specify this parameter if you specify the NextToken parameter.

Definition at line 79 of file ListShardsRequest.h.

◆ WithStreamName() [3/3]

ListShardsRequest& Aws::Kinesis::Model::ListShardsRequest::WithStreamName ( const char *  value)
inline

The name of the data stream whose shards you want to list.

You cannot specify this parameter if you specify the NextToken parameter.

Definition at line 85 of file ListShardsRequest.h.


The documentation for this class was generated from the following file: