Amazonka.DynamoDBStreams.DescribeStream

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

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

ToJSON DescribeStream

Defined in Amazonka.DynamoDBStreams.DescribeStream

Methods

toJSON :: DescribeStream -> Value

toEncoding :: DescribeStream -> Encoding

toJSONList :: [DescribeStream] -> Value

toEncodingList :: [DescribeStream] -> Encoding

ToHeaders DescribeStream

Defined in Amazonka.DynamoDBStreams.DescribeStream

Methods

toHeaders :: DescribeStream -> [Header]

ToPath DescribeStream

Defined in Amazonka.DynamoDBStreams.DescribeStream

Methods

toPath :: DescribeStream -> ByteString

ToQuery DescribeStream

Defined in Amazonka.DynamoDBStreams.DescribeStream

Methods

toQuery :: DescribeStream -> QueryString

AWSRequest DescribeStream

Defined in Amazonka.DynamoDBStreams.DescribeStream

Associated Types

type AWSResponse DescribeStream

Methods

request :: (Service -> Service) -> DescribeStream -> Request DescribeStream

response :: MonadResource m => (ByteStringLazy -> IO ByteStringLazy) -> Service -> Proxy DescribeStream -> ClientResponse ClientBody -> m (Either Error (ClientResponse (AWSResponse DescribeStream)))

Generic DescribeStream

Defined in Amazonka.DynamoDBStreams.DescribeStream

Associated Types

type Rep DescribeStream :: Type -> Type

Methods

from :: DescribeStream -> Rep DescribeStream x

to :: Rep DescribeStream x -> DescribeStream

Read DescribeStream

Defined in Amazonka.DynamoDBStreams.DescribeStream

Methods

readsPrec :: Int -> ReadS DescribeStream

readList :: ReadS [DescribeStream]

readPrec :: ReadPrec DescribeStream

readListPrec :: ReadPrec [DescribeStream]

Show DescribeStream

Defined in Amazonka.DynamoDBStreams.DescribeStream

Methods

showsPrec :: Int -> DescribeStream -> ShowS

show :: DescribeStream -> String

showList :: [DescribeStream] -> ShowS

NFData DescribeStream

Defined in Amazonka.DynamoDBStreams.DescribeStream

Methods

rnf :: DescribeStream -> ()

Eq DescribeStream

Defined in Amazonka.DynamoDBStreams.DescribeStream

Methods

(==) :: DescribeStream -> DescribeStream -> Bool

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

Hashable DescribeStream

Defined in Amazonka.DynamoDBStreams.DescribeStream

Methods

hashWithSalt :: Int -> DescribeStream -> Int

hash :: DescribeStream -> Int

type AWSResponse DescribeStream

Defined in Amazonka.DynamoDBStreams.DescribeStream

type AWSResponse DescribeStream = DescribeStreamResponse

type Rep DescribeStream

Defined in Amazonka.DynamoDBStreams.DescribeStream

type Rep DescribeStream = D1 ('MetaData "DescribeStream" "Amazonka.DynamoDBStreams.DescribeStream" "amazonka-dynamodb-streams-2.0-3efN0DbUklbJSr9bxtKOG6" '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))))

newDescribeStream

Arguments

:: Text

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.

DescribeStream, describeStream_streamArn - The Amazon Resource Name (ARN) for the stream.

Request Lenses

describeStream_exclusiveStartShardId :: Lens' DescribeStream (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.

describeStream_limit :: Lens' DescribeStream (Maybe Natural)

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

describeStream_streamArn :: Lens' DescribeStream Text

The Amazon Resource Name (ARN) for the stream.

Destructuring the Response

data DescribeStreamResponse

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

Generic DescribeStreamResponse

Defined in Amazonka.DynamoDBStreams.DescribeStream

Associated Types

type Rep DescribeStreamResponse :: Type -> Type

Methods

from :: DescribeStreamResponse -> Rep DescribeStreamResponse x

to :: Rep DescribeStreamResponse x -> DescribeStreamResponse

Read DescribeStreamResponse

Defined in Amazonka.DynamoDBStreams.DescribeStream

Methods

readsPrec :: Int -> ReadS DescribeStreamResponse

readList :: ReadS [DescribeStreamResponse]

readPrec :: ReadPrec DescribeStreamResponse

readListPrec :: ReadPrec [DescribeStreamResponse]

Show DescribeStreamResponse

Defined in Amazonka.DynamoDBStreams.DescribeStream

Methods

showsPrec :: Int -> DescribeStreamResponse -> ShowS

show :: DescribeStreamResponse -> String

showList :: [DescribeStreamResponse] -> ShowS

NFData DescribeStreamResponse

Defined in Amazonka.DynamoDBStreams.DescribeStream

Methods

rnf :: DescribeStreamResponse -> ()

Eq DescribeStreamResponse

Defined in Amazonka.DynamoDBStreams.DescribeStream

Methods

(==) :: DescribeStreamResponse -> DescribeStreamResponse -> Bool

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

type Rep DescribeStreamResponse

Defined in Amazonka.DynamoDBStreams.DescribeStream

type Rep DescribeStreamResponse = D1 ('MetaData "DescribeStreamResponse" "Amazonka.DynamoDBStreams.DescribeStream" "amazonka-dynamodb-streams-2.0-3efN0DbUklbJSr9bxtKOG6" '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

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)

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

The response's http status code.