Copyright	(c) 2013-2023 Brendan Hay
License	Mozilla Public License, v. 2.0.
Maintainer	Brendan Hay
Stability	auto-generated
Portability	non-portable (GHC extensions)
Safe Haskell	Safe-Inferred
Language	Haskell2010

Amazonka.DynamoDB.EnableKinesisStreamingDestination

Contents

Description

Starts table data replication to the specified Kinesis data stream at a timestamp chosen during the enable workflow. If this operation doesn't return results immediately, use DescribeKinesisStreamingDestination to check if streaming to the Kinesis data stream is ACTIVE.

Synopsis

Creating a Request

data EnableKinesisStreamingDestination Source #

See: newEnableKinesisStreamingDestination smart constructor.

Constructors

EnableKinesisStreamingDestination'
Fields tableName :: Text The name of the DynamoDB table. streamArn :: Text The ARN for a Kinesis data stream.

Instances

Instances details

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

newEnableKinesisStreamingDestination Source #

Arguments

:: Text	`EnableKinesisStreamingDestination`
-> Text	`EnableKinesisStreamingDestination`
-> EnableKinesisStreamingDestination

Create a value of EnableKinesisStreamingDestination 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:

EnableKinesisStreamingDestination, enableKinesisStreamingDestination_tableName - The name of the DynamoDB table.

EnableKinesisStreamingDestination, enableKinesisStreamingDestination_streamArn - The ARN for a Kinesis data stream.

Request Lenses

enableKinesisStreamingDestination_tableName :: Lens' EnableKinesisStreamingDestination Text Source #

The name of the DynamoDB table.

enableKinesisStreamingDestination_streamArn :: Lens' EnableKinesisStreamingDestination Text Source #

The ARN for a Kinesis data stream.

Destructuring the Response

data KinesisStreamingDestinationOutput Source #

See: newKinesisStreamingDestinationOutput smart constructor.

Constructors

KinesisStreamingDestinationOutput'
Fields destinationStatus :: Maybe DestinationStatus The current status of the replication. streamArn :: Maybe Text The ARN for the specific Kinesis data stream. tableName :: Maybe Text The name of the table being modified.

Instances

Instances details

FromJSON KinesisStreamingDestinationOutput Source #
Instance details Defined in Amazonka.DynamoDB.Types.KinesisStreamingDestinationOutput Methods parseJSON :: Value -> Parser KinesisStreamingDestinationOutput # parseJSONList :: Value -> Parser [KinesisStreamingDestinationOutput] #
Generic KinesisStreamingDestinationOutput Source #
Instance details Defined in Amazonka.DynamoDB.Types.KinesisStreamingDestinationOutput Associated Types type Rep KinesisStreamingDestinationOutput :: Type -> Type # Methods from :: KinesisStreamingDestinationOutput -> Rep KinesisStreamingDestinationOutput x # to :: Rep KinesisStreamingDestinationOutput x -> KinesisStreamingDestinationOutput #
Read KinesisStreamingDestinationOutput Source #
Instance details Defined in Amazonka.DynamoDB.Types.KinesisStreamingDestinationOutput Methods readsPrec :: Int -> ReadS KinesisStreamingDestinationOutput # readList :: ReadS [KinesisStreamingDestinationOutput] # readPrec :: ReadPrec KinesisStreamingDestinationOutput # readListPrec :: ReadPrec [KinesisStreamingDestinationOutput] #
Show KinesisStreamingDestinationOutput Source #
Instance details Defined in Amazonka.DynamoDB.Types.KinesisStreamingDestinationOutput Methods showsPrec :: Int -> KinesisStreamingDestinationOutput -> ShowS # show :: KinesisStreamingDestinationOutput -> String # showList :: [KinesisStreamingDestinationOutput] -> ShowS #
NFData KinesisStreamingDestinationOutput Source #
Instance details Defined in Amazonka.DynamoDB.Types.KinesisStreamingDestinationOutput Methods rnf :: KinesisStreamingDestinationOutput -> () #
Eq KinesisStreamingDestinationOutput Source #
Instance details Defined in Amazonka.DynamoDB.Types.KinesisStreamingDestinationOutput Methods (==) :: KinesisStreamingDestinationOutput -> KinesisStreamingDestinationOutput -> Bool # (/=) :: KinesisStreamingDestinationOutput -> KinesisStreamingDestinationOutput -> Bool #
Hashable KinesisStreamingDestinationOutput Source #
Instance details Defined in Amazonka.DynamoDB.Types.KinesisStreamingDestinationOutput Methods hashWithSalt :: Int -> KinesisStreamingDestinationOutput -> Int # hash :: KinesisStreamingDestinationOutput -> Int #
type Rep KinesisStreamingDestinationOutput Source #
Instance details Defined in Amazonka.DynamoDB.Types.KinesisStreamingDestinationOutput type Rep KinesisStreamingDestinationOutput = D1 ('MetaData "KinesisStreamingDestinationOutput" "Amazonka.DynamoDB.Types.KinesisStreamingDestinationOutput" "amazonka-dynamodb-2.0-GNxlseyeFiu302JKQwQrUS" 'False) (C1 ('MetaCons "KinesisStreamingDestinationOutput'" 'PrefixI 'True) (S1 ('MetaSel ('Just "destinationStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe DestinationStatus)) :: (S1 ('MetaSel ('Just "streamArn") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: S1 ('MetaSel ('Just "tableName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)))))

newKinesisStreamingDestinationOutput :: KinesisStreamingDestinationOutput Source #

Create a value of KinesisStreamingDestinationOutput 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:destinationStatus:KinesisStreamingDestinationOutput', kinesisStreamingDestinationOutput_destinationStatus - The current status of the replication.

$sel:streamArn:KinesisStreamingDestinationOutput', kinesisStreamingDestinationOutput_streamArn - The ARN for the specific Kinesis data stream.

$sel:tableName:KinesisStreamingDestinationOutput', kinesisStreamingDestinationOutput_tableName - The name of the table being modified.

Response Lenses

kinesisStreamingDestinationOutput_destinationStatus :: Lens' KinesisStreamingDestinationOutput (Maybe DestinationStatus) Source #

The current status of the replication.

kinesisStreamingDestinationOutput_streamArn :: Lens' KinesisStreamingDestinationOutput (Maybe Text) Source #

The ARN for the specific Kinesis data stream.

kinesisStreamingDestinationOutput_tableName :: Lens' KinesisStreamingDestinationOutput (Maybe Text) Source #

The name of the table being modified.