amazonka-kinesis-1.6.1: Amazon Kinesis SDK.

Copyright (c) 2013-2018 Brendan Hay Mozilla Public License, v. 2.0. Brendan Hay auto-generated non-portable (GHC extensions) None Haskell2010

Network.AWS.Kinesis.ListShards

Description

Lists the shards in a stream and provides information about each shard.

Important: This API is a new operation that is used by the Amazon Kinesis Client Library (KCL). If you have a fine-grained IAM policy that only allows specific operations, you must update your policy to allow calls to this API. For more information, see Controlling Access to Amazon Kinesis Data Streams Resources Using IAM .

Synopsis

# Creating a Request

Creates a value of ListShards with the minimum fields required to make a request.

Use one of the following lenses to modify other fields as desired:

• lsNextToken - 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. Important: 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 .
• lsExclusiveStartShardId - 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 .
• lsStreamCreationTimestamp - 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.
• lsStreamName - The name of the data stream whose shards you want to list. You cannot specify this parameter if you specify the NextToken parameter.
• lsMaxResults - 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.

See: listShards smart constructor.

Instances
 Source # Instance detailsDefined in Network.AWS.Kinesis.ListShards Methods Source # Instance detailsDefined in Network.AWS.Kinesis.ListShards Methodsgfoldl :: (forall d b. Data d => c (d -> b) -> d -> c b) -> (forall g. g -> c g) -> ListShards -> c ListShards #gunfold :: (forall b r. Data b => c (b -> r) -> c r) -> (forall r. r -> c r) -> Constr -> c ListShards #dataCast1 :: Typeable t => (forall d. Data d => c (t d)) -> Maybe (c ListShards) #dataCast2 :: Typeable t => (forall d e. (Data d, Data e) => c (t d e)) -> Maybe (c ListShards) #gmapT :: (forall b. Data b => b -> b) -> ListShards -> ListShards #gmapQl :: (r -> r' -> r) -> r -> (forall d. Data d => d -> r') -> ListShards -> r #gmapQr :: (r' -> r -> r) -> r -> (forall d. Data d => d -> r') -> ListShards -> r #gmapQ :: (forall d. Data d => d -> u) -> ListShards -> [u] #gmapQi :: Int -> (forall d. Data d => d -> u) -> ListShards -> u #gmapM :: Monad m => (forall d. Data d => d -> m d) -> ListShards -> m ListShards #gmapMp :: MonadPlus m => (forall d. Data d => d -> m d) -> ListShards -> m ListShards #gmapMo :: MonadPlus m => (forall d. Data d => d -> m d) -> ListShards -> m ListShards # Source # Instance detailsDefined in Network.AWS.Kinesis.ListShards Methods Source # Instance detailsDefined in Network.AWS.Kinesis.ListShards MethodsshowList :: [ListShards] -> ShowS # Source # Instance detailsDefined in Network.AWS.Kinesis.ListShards Associated Typestype Rep ListShards :: Type -> Type # Methods Source # Instance detailsDefined in Network.AWS.Kinesis.ListShards Methods Source # Instance detailsDefined in Network.AWS.Kinesis.ListShards MethodstoJSONList :: [ListShards] -> Value # Source # Instance detailsDefined in Network.AWS.Kinesis.ListShards Associated Typestype Rs ListShards :: Type # Methodsresponse :: (MonadResource m, MonadThrow m) => Logger -> Service -> Proxy ListShards -> ClientResponse -> m (Response ListShards) # Source # Instance detailsDefined in Network.AWS.Kinesis.ListShards MethodstoHeaders :: ListShards -> [Header] # Source # Instance detailsDefined in Network.AWS.Kinesis.ListShards Methods Source # Instance detailsDefined in Network.AWS.Kinesis.ListShards Methods Source # Instance detailsDefined in Network.AWS.Kinesis.ListShards Methodsrnf :: ListShards -> () # type Rep ListShards Source # Instance detailsDefined in Network.AWS.Kinesis.ListShards type Rep ListShards = D1 (MetaData "ListShards" "Network.AWS.Kinesis.ListShards" "amazonka-kinesis-1.6.1-DicNGWPqg566LpzNlyqosm" False) (C1 (MetaCons "ListShards'" PrefixI True) ((S1 (MetaSel (Just "_lsNextToken") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text)) :*: S1 (MetaSel (Just "_lsExclusiveStartShardId") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text))) :*: (S1 (MetaSel (Just "_lsStreamCreationTimestamp") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe POSIX)) :*: (S1 (MetaSel (Just "_lsStreamName") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text)) :*: S1 (MetaSel (Just "_lsMaxResults") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Nat)))))) type Rs ListShards Source # Instance detailsDefined in Network.AWS.Kinesis.ListShards

# Request Lenses

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. Important: 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 .

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 .

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.

The name of the data stream whose shards you want to list. You cannot specify this parameter if you specify the NextToken parameter.

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.

# Destructuring the Response

Arguments

 :: Int lrsResponseStatus -> ListShardsResponse

Creates a value of ListShardsResponse with the minimum fields required to make a request.

Use one of the following lenses to modify other fields as desired:

• lrsNextToken - 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. For more information about the use of this pagination token when calling the ListShards operation, see 'ListShardsInput$NextToken' . Important: 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 . • lrsShards - An array of JSON objects. Each object represents one shard and specifies the IDs of the shard, the shard's parent, and the shard that's adjacent to the shard's parent. Each object also contains the starting and ending hash keys and the starting and ending sequence numbers for the shard. • lrsResponseStatus - -- | The response status code. See: listShardsResponse smart constructor. Instances  Source # Instance detailsDefined in Network.AWS.Kinesis.ListShards Methods Source # Instance detailsDefined in Network.AWS.Kinesis.ListShards Methodsgfoldl :: (forall d b. Data d => c (d -> b) -> d -> c b) -> (forall g. g -> c g) -> ListShardsResponse -> c ListShardsResponse #gunfold :: (forall b r. Data b => c (b -> r) -> c r) -> (forall r. r -> c r) -> Constr -> c ListShardsResponse #dataCast1 :: Typeable t => (forall d. Data d => c (t d)) -> Maybe (c ListShardsResponse) #dataCast2 :: Typeable t => (forall d e. (Data d, Data e) => c (t d e)) -> Maybe (c ListShardsResponse) #gmapT :: (forall b. Data b => b -> b) -> ListShardsResponse -> ListShardsResponse #gmapQl :: (r -> r' -> r) -> r -> (forall d. Data d => d -> r') -> ListShardsResponse -> r #gmapQr :: (r' -> r -> r) -> r -> (forall d. Data d => d -> r') -> ListShardsResponse -> r #gmapQ :: (forall d. Data d => d -> u) -> ListShardsResponse -> [u] #gmapQi :: Int -> (forall d. Data d => d -> u) -> ListShardsResponse -> u #gmapM :: Monad m => (forall d. Data d => d -> m d) -> ListShardsResponse -> m ListShardsResponse #gmapMp :: MonadPlus m => (forall d. Data d => d -> m d) -> ListShardsResponse -> m ListShardsResponse #gmapMo :: MonadPlus m => (forall d. Data d => d -> m d) -> ListShardsResponse -> m ListShardsResponse # Source # Instance detailsDefined in Network.AWS.Kinesis.ListShards Methods Source # Instance detailsDefined in Network.AWS.Kinesis.ListShards MethodsshowList :: [ListShardsResponse] -> ShowS # Source # Instance detailsDefined in Network.AWS.Kinesis.ListShards Associated Typestype Rep ListShardsResponse :: Type -> Type # Methods Source # Instance detailsDefined in Network.AWS.Kinesis.ListShards Methodsrnf :: ListShardsResponse -> () # Source # Instance detailsDefined in Network.AWS.Kinesis.ListShards type Rep ListShardsResponse = D1 (MetaData "ListShardsResponse" "Network.AWS.Kinesis.ListShards" "amazonka-kinesis-1.6.1-DicNGWPqg566LpzNlyqosm" False) (C1 (MetaCons "ListShardsResponse'" PrefixI True) (S1 (MetaSel (Just "_lrsNextToken") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text)) :*: (S1 (MetaSel (Just "_lrsShards") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe [Shard])) :*: S1 (MetaSel (Just "_lrsResponseStatus") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 Int)))) # Response Lenses 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. For more information about the use of this pagination token when calling the ListShards operation, see 'ListShardsInput$NextToken' . Important: 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 .

An array of JSON objects. Each object represents one shard and specifies the IDs of the shard, the shard's parent, and the shard that's adjacent to the shard's parent. Each object also contains the starting and ending hash keys and the starting and ending sequence numbers for the shard.

• - | The response status code.