amazonka-dynamodb-streams-2.0: Amazon DynamoDB Streams SDK.
Copyright(c) 2013-2023 Brendan Hay
LicenseMozilla Public License, v. 2.0.
MaintainerBrendan Hay
Stabilityauto-generated
Portabilitynon-portable (GHC extensions)
Safe HaskellSafe-Inferred
LanguageHaskell2010

Amazonka.DynamoDBStreams.Types.Record

Description

 
Synopsis

Documentation

data Record Source #

A description of a unique event within a stream.

See: newRecord smart constructor.

Constructors

Record' 

Fields

  • awsRegion :: Maybe Text

    The region in which the GetRecords request was received.

  • dynamodb :: Maybe StreamRecord

    The main body of the stream record, containing all of the DynamoDB-specific fields.

  • eventID :: Maybe Text

    A globally unique identifier for the event that was recorded in this stream record.

  • eventName :: Maybe OperationType

    The type of data modification that was performed on the DynamoDB table:

    • INSERT - a new item was added to the table.
    • MODIFY - one or more of an existing item's attributes were modified.
    • REMOVE - the item was deleted from the table
  • eventSource :: Maybe Text

    The AWS service from which the stream record originated. For DynamoDB Streams, this is aws:dynamodb.

  • eventVersion :: Maybe Text

    The version number of the stream record format. This number is updated whenever the structure of Record is modified.

    Client applications must not assume that eventVersion will remain at a particular value, as this number is subject to change at any time. In general, eventVersion will only increase as the low-level DynamoDB Streams API evolves.

  • userIdentity :: Maybe Identity

    Items that are deleted by the Time to Live process after expiration have the following fields:

    • Records[].userIdentity.type

      "Service"

    • Records[].userIdentity.principalId

      "dynamodb.amazonaws.com"

Instances

Instances details
FromJSON Record Source # 
Instance details

Defined in Amazonka.DynamoDBStreams.Types.Record

Methods

parseJSON :: Value -> Parser Record #

parseJSONList :: Value -> Parser [Record] #

Generic Record Source # 
Instance details

Defined in Amazonka.DynamoDBStreams.Types.Record

Associated Types

type Rep Record :: Type -> Type #

Methods

from :: Record -> Rep Record x #

to :: Rep Record x -> Record #

Read Record Source # 
Instance details

Defined in Amazonka.DynamoDBStreams.Types.Record

Methods

readsPrec :: Int -> ReadS Record #

readList :: ReadS [Record] #

readPrec :: ReadPrec Record #

readListPrec :: ReadPrec [Record] #

Show Record Source # 
Instance details

Defined in Amazonka.DynamoDBStreams.Types.Record

Methods

showsPrec :: Int -> Record -> ShowS #

show :: Record -> String #

showList :: [Record] -> ShowS #

NFData Record Source # 
Instance details

Defined in Amazonka.DynamoDBStreams.Types.Record

Methods

rnf :: Record -> () #

Eq Record Source # 
Instance details

Defined in Amazonka.DynamoDBStreams.Types.Record

Methods

(==) :: Record -> Record -> Bool #

(/=) :: Record -> Record -> Bool #

Hashable Record Source # 
Instance details

Defined in Amazonka.DynamoDBStreams.Types.Record

Methods

hashWithSalt :: Int -> Record -> Int #

hash :: Record -> Int #

type Rep Record Source # 
Instance details

Defined in Amazonka.DynamoDBStreams.Types.Record

type Rep Record = D1 ('MetaData "Record" "Amazonka.DynamoDBStreams.Types.Record" "amazonka-dynamodb-streams-2.0-3efN0DbUklbJSr9bxtKOG6" 'False) (C1 ('MetaCons "Record'" 'PrefixI 'True) ((S1 ('MetaSel ('Just "awsRegion") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: (S1 ('MetaSel ('Just "dynamodb") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe StreamRecord)) :*: S1 ('MetaSel ('Just "eventID") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)))) :*: ((S1 ('MetaSel ('Just "eventName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe OperationType)) :*: S1 ('MetaSel ('Just "eventSource") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))) :*: (S1 ('MetaSel ('Just "eventVersion") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "userIdentity") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Identity))))))

newRecord :: Record Source #

Create a value of Record 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:awsRegion:Record', record_awsRegion - The region in which the GetRecords request was received.

$sel:dynamodb:Record', record_dynamodb - The main body of the stream record, containing all of the DynamoDB-specific fields.

$sel:eventID:Record', record_eventID - A globally unique identifier for the event that was recorded in this stream record.

$sel:eventName:Record', record_eventName - The type of data modification that was performed on the DynamoDB table:

  • INSERT - a new item was added to the table.
  • MODIFY - one or more of an existing item's attributes were modified.
  • REMOVE - the item was deleted from the table

$sel:eventSource:Record', record_eventSource - The AWS service from which the stream record originated. For DynamoDB Streams, this is aws:dynamodb.

$sel:eventVersion:Record', record_eventVersion - The version number of the stream record format. This number is updated whenever the structure of Record is modified.

Client applications must not assume that eventVersion will remain at a particular value, as this number is subject to change at any time. In general, eventVersion will only increase as the low-level DynamoDB Streams API evolves.

$sel:userIdentity:Record', record_userIdentity - Items that are deleted by the Time to Live process after expiration have the following fields:

  • Records[].userIdentity.type

    "Service"

  • Records[].userIdentity.principalId

    "dynamodb.amazonaws.com"

record_awsRegion :: Lens' Record (Maybe Text) Source #

The region in which the GetRecords request was received.

record_dynamodb :: Lens' Record (Maybe StreamRecord) Source #

The main body of the stream record, containing all of the DynamoDB-specific fields.

record_eventID :: Lens' Record (Maybe Text) Source #

A globally unique identifier for the event that was recorded in this stream record.

record_eventName :: Lens' Record (Maybe OperationType) Source #

The type of data modification that was performed on the DynamoDB table:

  • INSERT - a new item was added to the table.
  • MODIFY - one or more of an existing item's attributes were modified.
  • REMOVE - the item was deleted from the table

record_eventSource :: Lens' Record (Maybe Text) Source #

The AWS service from which the stream record originated. For DynamoDB Streams, this is aws:dynamodb.

record_eventVersion :: Lens' Record (Maybe Text) Source #

The version number of the stream record format. This number is updated whenever the structure of Record is modified.

Client applications must not assume that eventVersion will remain at a particular value, as this number is subject to change at any time. In general, eventVersion will only increase as the low-level DynamoDB Streams API evolves.

record_userIdentity :: Lens' Record (Maybe Identity) Source #

Items that are deleted by the Time to Live process after expiration have the following fields:

  • Records[].userIdentity.type

    "Service"

  • Records[].userIdentity.principalId

    "dynamodb.amazonaws.com"