Copyright	(c) 2013-2021 Brendan Hay
License	Mozilla Public License, v. 2.0.
Maintainer	Brendan Hay <brendan.g.hay+amazonka@gmail.com>
Stability	auto-generated
Portability	non-portable (GHC extensions)
Safe Haskell	None

Amazonka.DynamoDBStreams.DescribeStream

Contents

Creating a Request
Request Lenses
Destructuring the Response
Response Lenses

Description

Returns information about a stream, including the current status of the stream, its Amazon Resource Name (ARN), the composition of its shards, and its corresponding DynamoDB table.

You can call DescribeStream at a maximum rate of 10 times per second.

Each shard in the stream has a SequenceNumberRange associated with it. If the SequenceNumberRange has a StartingSequenceNumber but no EndingSequenceNumber, then the shard is still open (able to receive more stream records). If both StartingSequenceNumber and EndingSequenceNumber are present, then that shard is closed and can no longer receive more data.

Creating a Request

data DescribeStream Source #

Represents the input of a DescribeStream operation.

See: newDescribeStream smart constructor.

Constructors

DescribeStream'
Fields exclusiveStartShardId :: Maybe Text The shard ID of the first item that this operation will evaluate. Use the value that was returned for `LastEvaluatedShardId` in the previous operation. limit :: Maybe Natural The maximum number of shard objects to return. The upper limit is 100. streamArn :: Text The Amazon Resource Name (ARN) for the stream.

Instances

Instances details

Eq DescribeStream Source #
Instance details Defined in Amazonka.DynamoDBStreams.DescribeStream Methods (==) :: DescribeStream -> DescribeStream -> Bool # (/=) :: DescribeStream -> DescribeStream -> Bool #
Read DescribeStream Source #
Instance details Defined in Amazonka.DynamoDBStreams.DescribeStream Methods readsPrec :: Int -> ReadS DescribeStream # readList :: ReadS [DescribeStream] # readPrec :: ReadPrec DescribeStream # readListPrec :: ReadPrec [DescribeStream] #
Show DescribeStream Source #
Instance details Defined in Amazonka.DynamoDBStreams.DescribeStream Methods showsPrec :: Int -> DescribeStream -> ShowS # show :: DescribeStream -> String # showList :: [DescribeStream] -> ShowS #
Generic DescribeStream Source #
Instance details Defined in Amazonka.DynamoDBStreams.DescribeStream Associated Types type Rep DescribeStream :: Type -> Type # Methods from :: DescribeStream -> Rep DescribeStream x # to :: Rep DescribeStream x -> DescribeStream #
NFData DescribeStream Source #
Instance details Defined in Amazonka.DynamoDBStreams.DescribeStream Methods rnf :: DescribeStream -> () #
Hashable DescribeStream Source #
Instance details Defined in Amazonka.DynamoDBStreams.DescribeStream Methods hashWithSalt :: Int -> DescribeStream -> Int # hash :: DescribeStream -> Int #
ToJSON DescribeStream Source #
Instance details Defined in Amazonka.DynamoDBStreams.DescribeStream Methods toJSON :: DescribeStream -> Value # toEncoding :: DescribeStream -> Encoding # toJSONList :: [DescribeStream] -> Value # toEncodingList :: [DescribeStream] -> Encoding #
AWSRequest DescribeStream Source #
Instance details Defined in Amazonka.DynamoDBStreams.DescribeStream Associated Types type AWSResponse DescribeStream # Methods request :: DescribeStream -> Request DescribeStream # response :: MonadResource m => Logger -> Service -> Proxy DescribeStream -> ClientResponse ClientBody -> m (Either Error (ClientResponse (AWSResponse DescribeStream))) #
ToHeaders DescribeStream Source #
Instance details Defined in Amazonka.DynamoDBStreams.DescribeStream Methods toHeaders :: DescribeStream -> [Header] #
ToPath DescribeStream Source #
Instance details Defined in Amazonka.DynamoDBStreams.DescribeStream Methods toPath :: DescribeStream -> ByteString #
ToQuery DescribeStream Source #
Instance details Defined in Amazonka.DynamoDBStreams.DescribeStream Methods toQuery :: DescribeStream -> QueryString #
type Rep DescribeStream Source #
Instance details Defined in Amazonka.DynamoDBStreams.DescribeStream type Rep DescribeStream = D1 ('MetaData "DescribeStream" "Amazonka.DynamoDBStreams.DescribeStream" "libZSservicesZSamazonka-dynamodb-streamsZSamazonka-dynamodb-streams" 'False) (C1 ('MetaCons "DescribeStream'" 'PrefixI 'True) (S1 ('MetaSel ('Just "exclusiveStartShardId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: (S1 ('MetaSel ('Just "limit") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Natural)) :: S1 ('MetaSel ('Just "streamArn") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text))))
type AWSResponse DescribeStream Source #
Instance details Defined in Amazonka.DynamoDBStreams.DescribeStream type AWSResponse DescribeStream = DescribeStreamResponse

newDescribeStream Source #

Arguments

:: Text	`$sel:streamArn:DescribeStream'`
-> DescribeStream

Create a value of DescribeStream with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

$sel:exclusiveStartShardId:DescribeStream', describeStream_exclusiveStartShardId - The shard ID of the first item that this operation will evaluate. Use the value that was returned for LastEvaluatedShardId in the previous operation.

$sel:limit:DescribeStream', describeStream_limit - The maximum number of shard objects to return. The upper limit is 100.

$sel:streamArn:DescribeStream', describeStream_streamArn - The Amazon Resource Name (ARN) for the stream.

Request Lenses

describeStream_exclusiveStartShardId :: Lens' DescribeStream (Maybe Text) Source #

The shard ID of the first item that this operation will evaluate. Use the value that was returned for LastEvaluatedShardId in the previous operation.

describeStream_limit :: Lens' DescribeStream (Maybe Natural) Source #

The maximum number of shard objects to return. The upper limit is 100.

describeStream_streamArn :: Lens' DescribeStream Text Source #

The Amazon Resource Name (ARN) for the stream.

Destructuring the Response

data DescribeStreamResponse Source #

Represents the output of a DescribeStream operation.

See: newDescribeStreamResponse smart constructor.

Constructors

DescribeStreamResponse'
Fields streamDescription :: Maybe StreamDescription A complete description of the stream, including its creation date and time, the DynamoDB table associated with the stream, the shard IDs within the stream, and the beginning and ending sequence numbers of stream records within the shards. httpStatus :: Int The response's http status code.

Instances

Instances details

Eq DescribeStreamResponse Source #
Instance details Defined in Amazonka.DynamoDBStreams.DescribeStream Methods (==) :: DescribeStreamResponse -> DescribeStreamResponse -> Bool # (/=) :: DescribeStreamResponse -> DescribeStreamResponse -> Bool #
Read DescribeStreamResponse Source #
Instance details Defined in Amazonka.DynamoDBStreams.DescribeStream Methods readsPrec :: Int -> ReadS DescribeStreamResponse # readList :: ReadS [DescribeStreamResponse] # readPrec :: ReadPrec DescribeStreamResponse # readListPrec :: ReadPrec [DescribeStreamResponse] #
Show DescribeStreamResponse Source #
Instance details Defined in Amazonka.DynamoDBStreams.DescribeStream Methods showsPrec :: Int -> DescribeStreamResponse -> ShowS # show :: DescribeStreamResponse -> String # showList :: [DescribeStreamResponse] -> ShowS #
Generic DescribeStreamResponse Source #
Instance details Defined in Amazonka.DynamoDBStreams.DescribeStream Associated Types type Rep DescribeStreamResponse :: Type -> Type # Methods from :: DescribeStreamResponse -> Rep DescribeStreamResponse x # to :: Rep DescribeStreamResponse x -> DescribeStreamResponse #
NFData DescribeStreamResponse Source #
Instance details Defined in Amazonka.DynamoDBStreams.DescribeStream Methods rnf :: DescribeStreamResponse -> () #
type Rep DescribeStreamResponse Source #
Instance details Defined in Amazonka.DynamoDBStreams.DescribeStream type Rep DescribeStreamResponse = D1 ('MetaData "DescribeStreamResponse" "Amazonka.DynamoDBStreams.DescribeStream" "libZSservicesZSamazonka-dynamodb-streamsZSamazonka-dynamodb-streams" 'False) (C1 ('MetaCons "DescribeStreamResponse'" 'PrefixI 'True) (S1 ('MetaSel ('Just "streamDescription") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe StreamDescription)) :*: S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int)))

newDescribeStreamResponse Source #

Arguments

:: Int	`$sel:httpStatus:DescribeStreamResponse'`
-> DescribeStreamResponse

Create a value of DescribeStreamResponse with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

$sel:streamDescription:DescribeStreamResponse', describeStreamResponse_streamDescription - A complete description of the stream, including its creation date and time, the DynamoDB table associated with the stream, the shard IDs within the stream, and the beginning and ending sequence numbers of stream records within the shards.

$sel:httpStatus:DescribeStreamResponse', describeStreamResponse_httpStatus - The response's http status code.

Response Lenses

describeStreamResponse_streamDescription :: Lens' DescribeStreamResponse (Maybe StreamDescription) Source #

A complete description of the stream, including its creation date and time, the DynamoDB table associated with the stream, the shard IDs within the stream, and the beginning and ending sequence numbers of stream records within the shards.

describeStreamResponse_httpStatus :: Lens' DescribeStreamResponse Int Source #

The response's http status code.