libZSservicesZSamazonka-qldbZSamazonka-qldb
Copyright(c) 2013-2021 Brendan Hay
LicenseMozilla Public License, v. 2.0.
MaintainerBrendan Hay <brendan.g.hay+amazonka@gmail.com>
Stabilityauto-generated
Portabilitynon-portable (GHC extensions)
Safe HaskellNone

Amazonka.QLDB.CancelJournalKinesisStream

Description

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.

Synopsis

Creating a Request

data CancelJournalKinesisStream Source #

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

Instances details
Eq CancelJournalKinesisStream Source # 
Instance details

Defined in Amazonka.QLDB.CancelJournalKinesisStream

Read CancelJournalKinesisStream Source # 
Instance details

Defined in Amazonka.QLDB.CancelJournalKinesisStream

Show CancelJournalKinesisStream Source # 
Instance details

Defined in Amazonka.QLDB.CancelJournalKinesisStream

Generic CancelJournalKinesisStream Source # 
Instance details

Defined in Amazonka.QLDB.CancelJournalKinesisStream

Associated Types

type Rep CancelJournalKinesisStream :: Type -> Type #

NFData CancelJournalKinesisStream Source # 
Instance details

Defined in Amazonka.QLDB.CancelJournalKinesisStream

Hashable CancelJournalKinesisStream Source # 
Instance details

Defined in Amazonka.QLDB.CancelJournalKinesisStream

AWSRequest CancelJournalKinesisStream Source # 
Instance details

Defined in Amazonka.QLDB.CancelJournalKinesisStream

ToHeaders CancelJournalKinesisStream Source # 
Instance details

Defined in Amazonka.QLDB.CancelJournalKinesisStream

ToPath CancelJournalKinesisStream Source # 
Instance details

Defined in Amazonka.QLDB.CancelJournalKinesisStream

ToQuery CancelJournalKinesisStream Source # 
Instance details

Defined in Amazonka.QLDB.CancelJournalKinesisStream

type Rep CancelJournalKinesisStream Source # 
Instance details

Defined in Amazonka.QLDB.CancelJournalKinesisStream

type Rep CancelJournalKinesisStream = D1 ('MetaData "CancelJournalKinesisStream" "Amazonka.QLDB.CancelJournalKinesisStream" "libZSservicesZSamazonka-qldbZSamazonka-qldb" 'False) (C1 ('MetaCons "CancelJournalKinesisStream'" 'PrefixI 'True) (S1 ('MetaSel ('Just "ledgerName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text) :*: S1 ('MetaSel ('Just "streamId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text)))
type AWSResponse CancelJournalKinesisStream Source # 
Instance details

Defined in Amazonka.QLDB.CancelJournalKinesisStream

newCancelJournalKinesisStream Source #

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:

$sel:ledgerName:CancelJournalKinesisStream', cancelJournalKinesisStream_ledgerName - The name of the ledger.

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

Request Lenses

cancelJournalKinesisStream_streamId :: Lens' CancelJournalKinesisStream Text Source #

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

Destructuring the Response

data CancelJournalKinesisStreamResponse Source #

Constructors

CancelJournalKinesisStreamResponse' 

Fields

Instances

Instances details
Eq CancelJournalKinesisStreamResponse Source # 
Instance details

Defined in Amazonka.QLDB.CancelJournalKinesisStream

Read CancelJournalKinesisStreamResponse Source # 
Instance details

Defined in Amazonka.QLDB.CancelJournalKinesisStream

Show CancelJournalKinesisStreamResponse Source # 
Instance details

Defined in Amazonka.QLDB.CancelJournalKinesisStream

Generic CancelJournalKinesisStreamResponse Source # 
Instance details

Defined in Amazonka.QLDB.CancelJournalKinesisStream

Associated Types

type Rep CancelJournalKinesisStreamResponse :: Type -> Type #

NFData CancelJournalKinesisStreamResponse Source # 
Instance details

Defined in Amazonka.QLDB.CancelJournalKinesisStream

type Rep CancelJournalKinesisStreamResponse Source # 
Instance details

Defined in Amazonka.QLDB.CancelJournalKinesisStream

type Rep CancelJournalKinesisStreamResponse = D1 ('MetaData "CancelJournalKinesisStreamResponse" "Amazonka.QLDB.CancelJournalKinesisStream" "libZSservicesZSamazonka-qldbZSamazonka-qldb" '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 Source #

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:

$sel:streamId: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) Source #

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