Amazonka.QLDB.CancelJournalKinesisStream

Ends a given Amazon QLDB journal stream. Before a stream can be canceled, its current status must be ACTIVE.

You can't restart a stream after you cancel it. Canceled QLDB stream resources are subject to a 7-day retention period, so they are automatically deleted after this limit expires.

Creating a Request

data CancelJournalKinesisStream

See: newCancelJournalKinesisStream smart constructor.

Constructors

CancelJournalKinesisStream'

Fields

• ledgerName :: Text

  The name of the ledger.

• streamId :: Text

  The UUID (represented in Base62-encoded text) of the QLDB journal stream to be canceled.

Instances

ToHeaders CancelJournalKinesisStream

Defined in Amazonka.QLDB.CancelJournalKinesisStream

Methods

toHeaders :: CancelJournalKinesisStream -> [Header]

ToPath CancelJournalKinesisStream

Defined in Amazonka.QLDB.CancelJournalKinesisStream

Methods

toPath :: CancelJournalKinesisStream -> ByteString

ToQuery CancelJournalKinesisStream

Defined in Amazonka.QLDB.CancelJournalKinesisStream

Methods

toQuery :: CancelJournalKinesisStream -> QueryString

AWSRequest CancelJournalKinesisStream

Defined in Amazonka.QLDB.CancelJournalKinesisStream

Associated Types

type AWSResponse CancelJournalKinesisStream

Methods

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

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

Generic CancelJournalKinesisStream

Defined in Amazonka.QLDB.CancelJournalKinesisStream

Associated Types

type Rep CancelJournalKinesisStream :: Type -> Type

Methods

from :: CancelJournalKinesisStream -> Rep CancelJournalKinesisStream x

to :: Rep CancelJournalKinesisStream x -> CancelJournalKinesisStream

Read CancelJournalKinesisStream

Defined in Amazonka.QLDB.CancelJournalKinesisStream

Methods

readsPrec :: Int -> ReadS CancelJournalKinesisStream

readList :: ReadS [CancelJournalKinesisStream]

readPrec :: ReadPrec CancelJournalKinesisStream

readListPrec :: ReadPrec [CancelJournalKinesisStream]

Show CancelJournalKinesisStream

Defined in Amazonka.QLDB.CancelJournalKinesisStream

Methods

showsPrec :: Int -> CancelJournalKinesisStream -> ShowS

show :: CancelJournalKinesisStream -> String

showList :: [CancelJournalKinesisStream] -> ShowS

NFData CancelJournalKinesisStream

Defined in Amazonka.QLDB.CancelJournalKinesisStream

Methods

rnf :: CancelJournalKinesisStream -> ()

Eq CancelJournalKinesisStream

Defined in Amazonka.QLDB.CancelJournalKinesisStream

Methods

(==) :: CancelJournalKinesisStream -> CancelJournalKinesisStream -> Bool

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

Hashable CancelJournalKinesisStream

Defined in Amazonka.QLDB.CancelJournalKinesisStream

Methods

hashWithSalt :: Int -> CancelJournalKinesisStream -> Int

hash :: CancelJournalKinesisStream -> Int

type AWSResponse CancelJournalKinesisStream

Defined in Amazonka.QLDB.CancelJournalKinesisStream

type AWSResponse CancelJournalKinesisStream = CancelJournalKinesisStreamResponse

type Rep CancelJournalKinesisStream

Defined in Amazonka.QLDB.CancelJournalKinesisStream

type Rep CancelJournalKinesisStream = D1 ('MetaData "CancelJournalKinesisStream" "Amazonka.QLDB.CancelJournalKinesisStream" "amazonka-qldb-2.0-GHDpAUfL5Gp5EFIat3BpxK" 'False) (C1 ('MetaCons "CancelJournalKinesisStream'" 'PrefixI 'True) (S1 ('MetaSel ('Just "ledgerName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text) :*: S1 ('MetaSel ('Just "streamId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text)))

newCancelJournalKinesisStream

Arguments

:: Text

CancelJournalKinesisStream

-> Text

CancelJournalKinesisStream

-> CancelJournalKinesisStream

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

CancelJournalKinesisStream, cancelJournalKinesisStream_ledgerName - The name of the ledger.

CancelJournalKinesisStream, cancelJournalKinesisStream_streamId - The UUID (represented in Base62-encoded text) of the QLDB journal stream to be canceled.

Request Lenses

cancelJournalKinesisStream_ledgerName :: Lens' CancelJournalKinesisStream Text

The name of the ledger.

cancelJournalKinesisStream_streamId :: Lens' CancelJournalKinesisStream Text

The UUID (represented in Base62-encoded text) of the QLDB journal stream to be canceled.

Destructuring the Response

data CancelJournalKinesisStreamResponse

See: newCancelJournalKinesisStreamResponse smart constructor.

Constructors

CancelJournalKinesisStreamResponse'

Fields

• streamId :: Maybe Text

  The UUID (Base62-encoded text) of the canceled QLDB journal stream.

• httpStatus :: Int

  The response's http status code.

Instances

Generic CancelJournalKinesisStreamResponse

Defined in Amazonka.QLDB.CancelJournalKinesisStream

Associated Types

type Rep CancelJournalKinesisStreamResponse :: Type -> Type

Methods

from :: CancelJournalKinesisStreamResponse -> Rep CancelJournalKinesisStreamResponse x

to :: Rep CancelJournalKinesisStreamResponse x -> CancelJournalKinesisStreamResponse

Read CancelJournalKinesisStreamResponse

Defined in Amazonka.QLDB.CancelJournalKinesisStream

Methods

readsPrec :: Int -> ReadS CancelJournalKinesisStreamResponse

readList :: ReadS [CancelJournalKinesisStreamResponse]

readPrec :: ReadPrec CancelJournalKinesisStreamResponse

readListPrec :: ReadPrec [CancelJournalKinesisStreamResponse]

Show CancelJournalKinesisStreamResponse

Defined in Amazonka.QLDB.CancelJournalKinesisStream

Methods

showsPrec :: Int -> CancelJournalKinesisStreamResponse -> ShowS

show :: CancelJournalKinesisStreamResponse -> String

showList :: [CancelJournalKinesisStreamResponse] -> ShowS

NFData CancelJournalKinesisStreamResponse

Defined in Amazonka.QLDB.CancelJournalKinesisStream

Methods

rnf :: CancelJournalKinesisStreamResponse -> ()

Eq CancelJournalKinesisStreamResponse

Defined in Amazonka.QLDB.CancelJournalKinesisStream

Methods

(==) :: CancelJournalKinesisStreamResponse -> CancelJournalKinesisStreamResponse -> Bool

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

type Rep CancelJournalKinesisStreamResponse

Defined in Amazonka.QLDB.CancelJournalKinesisStream

type Rep CancelJournalKinesisStreamResponse = D1 ('MetaData "CancelJournalKinesisStreamResponse" "Amazonka.QLDB.CancelJournalKinesisStream" "amazonka-qldb-2.0-GHDpAUfL5Gp5EFIat3BpxK" 'False) (C1 ('MetaCons "CancelJournalKinesisStreamResponse'" 'PrefixI 'True) (S1 ('MetaSel ('Just "streamId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int)))

newCancelJournalKinesisStreamResponse

Arguments

:: Int

$sel:httpStatus:CancelJournalKinesisStreamResponse'

-> CancelJournalKinesisStreamResponse

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

CancelJournalKinesisStream, cancelJournalKinesisStreamResponse_streamId - The UUID (Base62-encoded text) of the canceled QLDB journal stream.

$sel:httpStatus:CancelJournalKinesisStreamResponse', cancelJournalKinesisStreamResponse_httpStatus - The response's http status code.

Response Lenses

cancelJournalKinesisStreamResponse_streamId :: Lens' CancelJournalKinesisStreamResponse (Maybe Text)

The UUID (Base62-encoded text) of the canceled QLDB journal stream.

cancelJournalKinesisStreamResponse_httpStatus :: Lens' CancelJournalKinesisStreamResponse Int

The response's http status code.