Network.AWS.Kinesis.ListShards

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 .

Creating a Request

listShards :: ListShards

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.

data ListShards

See: listShards smart constructor.

Instances

Eq ListShards

Methods

(==) :: ListShards -> ListShards -> Bool

(/=) :: ListShards -> ListShards -> Bool

Data ListShards

Methods

gfoldl :: (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

toConstr :: ListShards -> Constr

dataTypeOf :: ListShards -> DataType

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

Read ListShards

Methods

readsPrec :: Int -> ReadS ListShards

readList :: ReadS [ListShards]

readPrec :: ReadPrec ListShards

readListPrec :: ReadPrec [ListShards]

Show ListShards

Methods

showsPrec :: Int -> ListShards -> ShowS

show :: ListShards -> String

showList :: [ListShards] -> ShowS

Generic ListShards

Associated Types

type Rep ListShards :: * -> *

Methods

from :: ListShards -> Rep ListShards x

to :: Rep ListShards x -> ListShards

Hashable ListShards

Methods

hashWithSalt :: Int -> ListShards -> Int

hash :: ListShards -> Int

ToJSON ListShards

Methods

toJSON :: ListShards -> Value

toEncoding :: ListShards -> Encoding

toJSONList :: [ListShards] -> Value

toEncodingList :: [ListShards] -> Encoding

NFData ListShards

Methods

rnf :: ListShards -> ()

AWSRequest ListShards

Associated Types

type Rs ListShards :: *

Methods

request :: ListShards -> Request ListShards

response :: (MonadResource m, MonadThrow m) => Logger -> Service -> Proxy * ListShards -> ClientResponse -> m (Response ListShards)

ToHeaders ListShards

Methods

toHeaders :: ListShards -> [Header]

ToPath ListShards

Methods

toPath :: ListShards -> ByteString

ToQuery ListShards

Methods

toQuery :: ListShards -> QueryString

type Rep ListShards

type Rep ListShards = D1 * (MetaData "ListShards" "Network.AWS.Kinesis.ListShards" "amazonka-kinesis-1.6.0-FM91TbfEPFA6fwZObkhzFa" False) (C1 * (MetaCons "ListShards'" PrefixI True) ((:*:) * ((:*:) * (S1 * (MetaSel (Just Symbol "_lsNextToken") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * (Maybe Text))) (S1 * (MetaSel (Just Symbol "_lsExclusiveStartShardId") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * (Maybe Text)))) ((:*:) * (S1 * (MetaSel (Just Symbol "_lsStreamCreationTimestamp") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * (Maybe POSIX))) ((:*:) * (S1 * (MetaSel (Just Symbol "_lsStreamName") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * (Maybe Text))) (S1 * (MetaSel (Just Symbol "_lsMaxResults") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * (Maybe Nat)))))))

type Rs ListShards

type Rs ListShards = ListShardsResponse

Request Lenses

lsNextToken :: Lens' ListShards (Maybe Text)

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 :: Lens' ListShards (Maybe Text)

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 :: Lens' ListShards (Maybe UTCTime)

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 :: Lens' ListShards (Maybe Text)

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

lsMaxResults :: Lens' ListShards (Maybe Natural)

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

listShardsResponse

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.

data ListShardsResponse

See: listShardsResponse smart constructor.

Instances

Eq ListShardsResponse

Methods

(==) :: ListShardsResponse -> ListShardsResponse -> Bool

(/=) :: ListShardsResponse -> ListShardsResponse -> Bool

Data ListShardsResponse

Methods

gfoldl :: (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

toConstr :: ListShardsResponse -> Constr

dataTypeOf :: ListShardsResponse -> DataType

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

Read ListShardsResponse

Methods

readsPrec :: Int -> ReadS ListShardsResponse

readList :: ReadS [ListShardsResponse]

readPrec :: ReadPrec ListShardsResponse

readListPrec :: ReadPrec [ListShardsResponse]

Show ListShardsResponse

Methods

showsPrec :: Int -> ListShardsResponse -> ShowS

show :: ListShardsResponse -> String

showList :: [ListShardsResponse] -> ShowS

Generic ListShardsResponse

Associated Types

type Rep ListShardsResponse :: * -> *

Methods

from :: ListShardsResponse -> Rep ListShardsResponse x

to :: Rep ListShardsResponse x -> ListShardsResponse

NFData ListShardsResponse

Methods

rnf :: ListShardsResponse -> ()

type Rep ListShardsResponse

type Rep ListShardsResponse = D1 * (MetaData "ListShardsResponse" "Network.AWS.Kinesis.ListShards" "amazonka-kinesis-1.6.0-FM91TbfEPFA6fwZObkhzFa" False) (C1 * (MetaCons "ListShardsResponse'" PrefixI True) ((:*:) * (S1 * (MetaSel (Just Symbol "_lrsNextToken") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * (Maybe Text))) ((:*:) * (S1 * (MetaSel (Just Symbol "_lrsShards") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * (Maybe [Shard]))) (S1 * (MetaSel (Just Symbol "_lrsResponseStatus") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * Int)))))

Response Lenses

lrsNextToken :: Lens' ListShardsResponse (Maybe Text)

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 :: Lens' ListShardsResponse [Shard]

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 :: Lens' ListShardsResponse Int

• - | The response status code.