qldb.d.ts
1 import {Request} from '../lib/request'; 2 import {Response} from '../lib/response'; 3 import {AWSError} from '../lib/error'; 4 import {Service} from '../lib/service'; 5 import {ServiceConfigurationOptions} from '../lib/service'; 6 import {ConfigBase as Config} from '../lib/config-base'; 7 interface Blob {} 8 declare class QLDB extends Service { 9 /** 10 * Constructs a service object. This object has one method for each API operation. 11 */ 12 constructor(options?: QLDB.Types.ClientConfiguration) 13 config: Config & QLDB.Types.ClientConfiguration; 14 /** 15 * 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. 16 */ 17 cancelJournalKinesisStream(params: QLDB.Types.CancelJournalKinesisStreamRequest, callback?: (err: AWSError, data: QLDB.Types.CancelJournalKinesisStreamResponse) => void): Request<QLDB.Types.CancelJournalKinesisStreamResponse, AWSError>; 18 /** 19 * 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. 20 */ 21 cancelJournalKinesisStream(callback?: (err: AWSError, data: QLDB.Types.CancelJournalKinesisStreamResponse) => void): Request<QLDB.Types.CancelJournalKinesisStreamResponse, AWSError>; 22 /** 23 * Creates a new ledger in your account in the current Region. 24 */ 25 createLedger(params: QLDB.Types.CreateLedgerRequest, callback?: (err: AWSError, data: QLDB.Types.CreateLedgerResponse) => void): Request<QLDB.Types.CreateLedgerResponse, AWSError>; 26 /** 27 * Creates a new ledger in your account in the current Region. 28 */ 29 createLedger(callback?: (err: AWSError, data: QLDB.Types.CreateLedgerResponse) => void): Request<QLDB.Types.CreateLedgerResponse, AWSError>; 30 /** 31 * Deletes a ledger and all of its contents. This action is irreversible. If deletion protection is enabled, you must first disable it before you can delete the ledger. You can disable it by calling the UpdateLedger operation to set the flag to false. 32 */ 33 deleteLedger(params: QLDB.Types.DeleteLedgerRequest, callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>; 34 /** 35 * Deletes a ledger and all of its contents. This action is irreversible. If deletion protection is enabled, you must first disable it before you can delete the ledger. You can disable it by calling the UpdateLedger operation to set the flag to false. 36 */ 37 deleteLedger(callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>; 38 /** 39 * Returns detailed information about a given Amazon QLDB journal stream. The output includes the Amazon Resource Name (ARN), stream name, current status, creation time, and the parameters of the original stream creation request. This action does not return any expired journal streams. For more information, see Expiration for terminal streams in the Amazon QLDB Developer Guide. 40 */ 41 describeJournalKinesisStream(params: QLDB.Types.DescribeJournalKinesisStreamRequest, callback?: (err: AWSError, data: QLDB.Types.DescribeJournalKinesisStreamResponse) => void): Request<QLDB.Types.DescribeJournalKinesisStreamResponse, AWSError>; 42 /** 43 * Returns detailed information about a given Amazon QLDB journal stream. The output includes the Amazon Resource Name (ARN), stream name, current status, creation time, and the parameters of the original stream creation request. This action does not return any expired journal streams. For more information, see Expiration for terminal streams in the Amazon QLDB Developer Guide. 44 */ 45 describeJournalKinesisStream(callback?: (err: AWSError, data: QLDB.Types.DescribeJournalKinesisStreamResponse) => void): Request<QLDB.Types.DescribeJournalKinesisStreamResponse, AWSError>; 46 /** 47 * Returns information about a journal export job, including the ledger name, export ID, creation time, current status, and the parameters of the original export creation request. This action does not return any expired export jobs. For more information, see Export job expiration in the Amazon QLDB Developer Guide. If the export job with the given ExportId doesn't exist, then throws ResourceNotFoundException. If the ledger with the given Name doesn't exist, then throws ResourceNotFoundException. 48 */ 49 describeJournalS3Export(params: QLDB.Types.DescribeJournalS3ExportRequest, callback?: (err: AWSError, data: QLDB.Types.DescribeJournalS3ExportResponse) => void): Request<QLDB.Types.DescribeJournalS3ExportResponse, AWSError>; 50 /** 51 * Returns information about a journal export job, including the ledger name, export ID, creation time, current status, and the parameters of the original export creation request. This action does not return any expired export jobs. For more information, see Export job expiration in the Amazon QLDB Developer Guide. If the export job with the given ExportId doesn't exist, then throws ResourceNotFoundException. If the ledger with the given Name doesn't exist, then throws ResourceNotFoundException. 52 */ 53 describeJournalS3Export(callback?: (err: AWSError, data: QLDB.Types.DescribeJournalS3ExportResponse) => void): Request<QLDB.Types.DescribeJournalS3ExportResponse, AWSError>; 54 /** 55 * Returns information about a ledger, including its state, permissions mode, encryption at rest settings, and when it was created. 56 */ 57 describeLedger(params: QLDB.Types.DescribeLedgerRequest, callback?: (err: AWSError, data: QLDB.Types.DescribeLedgerResponse) => void): Request<QLDB.Types.DescribeLedgerResponse, AWSError>; 58 /** 59 * Returns information about a ledger, including its state, permissions mode, encryption at rest settings, and when it was created. 60 */ 61 describeLedger(callback?: (err: AWSError, data: QLDB.Types.DescribeLedgerResponse) => void): Request<QLDB.Types.DescribeLedgerResponse, AWSError>; 62 /** 63 * Exports journal contents within a date and time range from a ledger into a specified Amazon Simple Storage Service (Amazon S3) bucket. The data is written as files in Amazon Ion format. If the ledger with the given Name doesn't exist, then throws ResourceNotFoundException. If the ledger with the given Name is in CREATING status, then throws ResourcePreconditionNotMetException. You can initiate up to two concurrent journal export requests for each ledger. Beyond this limit, journal export requests throw LimitExceededException. 64 */ 65 exportJournalToS3(params: QLDB.Types.ExportJournalToS3Request, callback?: (err: AWSError, data: QLDB.Types.ExportJournalToS3Response) => void): Request<QLDB.Types.ExportJournalToS3Response, AWSError>; 66 /** 67 * Exports journal contents within a date and time range from a ledger into a specified Amazon Simple Storage Service (Amazon S3) bucket. The data is written as files in Amazon Ion format. If the ledger with the given Name doesn't exist, then throws ResourceNotFoundException. If the ledger with the given Name is in CREATING status, then throws ResourcePreconditionNotMetException. You can initiate up to two concurrent journal export requests for each ledger. Beyond this limit, journal export requests throw LimitExceededException. 68 */ 69 exportJournalToS3(callback?: (err: AWSError, data: QLDB.Types.ExportJournalToS3Response) => void): Request<QLDB.Types.ExportJournalToS3Response, AWSError>; 70 /** 71 * Returns a block object at a specified address in a journal. Also returns a proof of the specified block for verification if DigestTipAddress is provided. For information about the data contents in a block, see Journal contents in the Amazon QLDB Developer Guide. If the specified ledger doesn't exist or is in DELETING status, then throws ResourceNotFoundException. If the specified ledger is in CREATING status, then throws ResourcePreconditionNotMetException. If no block exists with the specified address, then throws InvalidParameterException. 72 */ 73 getBlock(params: QLDB.Types.GetBlockRequest, callback?: (err: AWSError, data: QLDB.Types.GetBlockResponse) => void): Request<QLDB.Types.GetBlockResponse, AWSError>; 74 /** 75 * Returns a block object at a specified address in a journal. Also returns a proof of the specified block for verification if DigestTipAddress is provided. For information about the data contents in a block, see Journal contents in the Amazon QLDB Developer Guide. If the specified ledger doesn't exist or is in DELETING status, then throws ResourceNotFoundException. If the specified ledger is in CREATING status, then throws ResourcePreconditionNotMetException. If no block exists with the specified address, then throws InvalidParameterException. 76 */ 77 getBlock(callback?: (err: AWSError, data: QLDB.Types.GetBlockResponse) => void): Request<QLDB.Types.GetBlockResponse, AWSError>; 78 /** 79 * Returns the digest of a ledger at the latest committed block in the journal. The response includes a 256-bit hash value and a block address. 80 */ 81 getDigest(params: QLDB.Types.GetDigestRequest, callback?: (err: AWSError, data: QLDB.Types.GetDigestResponse) => void): Request<QLDB.Types.GetDigestResponse, AWSError>; 82 /** 83 * Returns the digest of a ledger at the latest committed block in the journal. The response includes a 256-bit hash value and a block address. 84 */ 85 getDigest(callback?: (err: AWSError, data: QLDB.Types.GetDigestResponse) => void): Request<QLDB.Types.GetDigestResponse, AWSError>; 86 /** 87 * Returns a revision data object for a specified document ID and block address. Also returns a proof of the specified revision for verification if DigestTipAddress is provided. 88 */ 89 getRevision(params: QLDB.Types.GetRevisionRequest, callback?: (err: AWSError, data: QLDB.Types.GetRevisionResponse) => void): Request<QLDB.Types.GetRevisionResponse, AWSError>; 90 /** 91 * Returns a revision data object for a specified document ID and block address. Also returns a proof of the specified revision for verification if DigestTipAddress is provided. 92 */ 93 getRevision(callback?: (err: AWSError, data: QLDB.Types.GetRevisionResponse) => void): Request<QLDB.Types.GetRevisionResponse, AWSError>; 94 /** 95 * Returns an array of all Amazon QLDB journal stream descriptors for a given ledger. The output of each stream descriptor includes the same details that are returned by DescribeJournalKinesisStream. This action does not return any expired journal streams. For more information, see Expiration for terminal streams in the Amazon QLDB Developer Guide. This action returns a maximum of MaxResults items. It is paginated so that you can retrieve all the items by calling ListJournalKinesisStreamsForLedger multiple times. 96 */ 97 listJournalKinesisStreamsForLedger(params: QLDB.Types.ListJournalKinesisStreamsForLedgerRequest, callback?: (err: AWSError, data: QLDB.Types.ListJournalKinesisStreamsForLedgerResponse) => void): Request<QLDB.Types.ListJournalKinesisStreamsForLedgerResponse, AWSError>; 98 /** 99 * Returns an array of all Amazon QLDB journal stream descriptors for a given ledger. The output of each stream descriptor includes the same details that are returned by DescribeJournalKinesisStream. This action does not return any expired journal streams. For more information, see Expiration for terminal streams in the Amazon QLDB Developer Guide. This action returns a maximum of MaxResults items. It is paginated so that you can retrieve all the items by calling ListJournalKinesisStreamsForLedger multiple times. 100 */ 101 listJournalKinesisStreamsForLedger(callback?: (err: AWSError, data: QLDB.Types.ListJournalKinesisStreamsForLedgerResponse) => void): Request<QLDB.Types.ListJournalKinesisStreamsForLedgerResponse, AWSError>; 102 /** 103 * Returns an array of journal export job descriptions for all ledgers that are associated with the current account and Region. This action returns a maximum of MaxResults items, and is paginated so that you can retrieve all the items by calling ListJournalS3Exports multiple times. This action does not return any expired export jobs. For more information, see Export job expiration in the Amazon QLDB Developer Guide. 104 */ 105 listJournalS3Exports(params: QLDB.Types.ListJournalS3ExportsRequest, callback?: (err: AWSError, data: QLDB.Types.ListJournalS3ExportsResponse) => void): Request<QLDB.Types.ListJournalS3ExportsResponse, AWSError>; 106 /** 107 * Returns an array of journal export job descriptions for all ledgers that are associated with the current account and Region. This action returns a maximum of MaxResults items, and is paginated so that you can retrieve all the items by calling ListJournalS3Exports multiple times. This action does not return any expired export jobs. For more information, see Export job expiration in the Amazon QLDB Developer Guide. 108 */ 109 listJournalS3Exports(callback?: (err: AWSError, data: QLDB.Types.ListJournalS3ExportsResponse) => void): Request<QLDB.Types.ListJournalS3ExportsResponse, AWSError>; 110 /** 111 * Returns an array of journal export job descriptions for a specified ledger. This action returns a maximum of MaxResults items, and is paginated so that you can retrieve all the items by calling ListJournalS3ExportsForLedger multiple times. This action does not return any expired export jobs. For more information, see Export job expiration in the Amazon QLDB Developer Guide. 112 */ 113 listJournalS3ExportsForLedger(params: QLDB.Types.ListJournalS3ExportsForLedgerRequest, callback?: (err: AWSError, data: QLDB.Types.ListJournalS3ExportsForLedgerResponse) => void): Request<QLDB.Types.ListJournalS3ExportsForLedgerResponse, AWSError>; 114 /** 115 * Returns an array of journal export job descriptions for a specified ledger. This action returns a maximum of MaxResults items, and is paginated so that you can retrieve all the items by calling ListJournalS3ExportsForLedger multiple times. This action does not return any expired export jobs. For more information, see Export job expiration in the Amazon QLDB Developer Guide. 116 */ 117 listJournalS3ExportsForLedger(callback?: (err: AWSError, data: QLDB.Types.ListJournalS3ExportsForLedgerResponse) => void): Request<QLDB.Types.ListJournalS3ExportsForLedgerResponse, AWSError>; 118 /** 119 * Returns an array of ledger summaries that are associated with the current account and Region. This action returns a maximum of 100 items and is paginated so that you can retrieve all the items by calling ListLedgers multiple times. 120 */ 121 listLedgers(params: QLDB.Types.ListLedgersRequest, callback?: (err: AWSError, data: QLDB.Types.ListLedgersResponse) => void): Request<QLDB.Types.ListLedgersResponse, AWSError>; 122 /** 123 * Returns an array of ledger summaries that are associated with the current account and Region. This action returns a maximum of 100 items and is paginated so that you can retrieve all the items by calling ListLedgers multiple times. 124 */ 125 listLedgers(callback?: (err: AWSError, data: QLDB.Types.ListLedgersResponse) => void): Request<QLDB.Types.ListLedgersResponse, AWSError>; 126 /** 127 * Returns all tags for a specified Amazon QLDB resource. 128 */ 129 listTagsForResource(params: QLDB.Types.ListTagsForResourceRequest, callback?: (err: AWSError, data: QLDB.Types.ListTagsForResourceResponse) => void): Request<QLDB.Types.ListTagsForResourceResponse, AWSError>; 130 /** 131 * Returns all tags for a specified Amazon QLDB resource. 132 */ 133 listTagsForResource(callback?: (err: AWSError, data: QLDB.Types.ListTagsForResourceResponse) => void): Request<QLDB.Types.ListTagsForResourceResponse, AWSError>; 134 /** 135 * Creates a journal stream for a given Amazon QLDB ledger. The stream captures every document revision that is committed to the ledger's journal and delivers the data to a specified Amazon Kinesis Data Streams resource. 136 */ 137 streamJournalToKinesis(params: QLDB.Types.StreamJournalToKinesisRequest, callback?: (err: AWSError, data: QLDB.Types.StreamJournalToKinesisResponse) => void): Request<QLDB.Types.StreamJournalToKinesisResponse, AWSError>; 138 /** 139 * Creates a journal stream for a given Amazon QLDB ledger. The stream captures every document revision that is committed to the ledger's journal and delivers the data to a specified Amazon Kinesis Data Streams resource. 140 */ 141 streamJournalToKinesis(callback?: (err: AWSError, data: QLDB.Types.StreamJournalToKinesisResponse) => void): Request<QLDB.Types.StreamJournalToKinesisResponse, AWSError>; 142 /** 143 * Adds one or more tags to a specified Amazon QLDB resource. A resource can have up to 50 tags. If you try to create more than 50 tags for a resource, your request fails and returns an error. 144 */ 145 tagResource(params: QLDB.Types.TagResourceRequest, callback?: (err: AWSError, data: QLDB.Types.TagResourceResponse) => void): Request<QLDB.Types.TagResourceResponse, AWSError>; 146 /** 147 * Adds one or more tags to a specified Amazon QLDB resource. A resource can have up to 50 tags. If you try to create more than 50 tags for a resource, your request fails and returns an error. 148 */ 149 tagResource(callback?: (err: AWSError, data: QLDB.Types.TagResourceResponse) => void): Request<QLDB.Types.TagResourceResponse, AWSError>; 150 /** 151 * Removes one or more tags from a specified Amazon QLDB resource. You can specify up to 50 tag keys to remove. 152 */ 153 untagResource(params: QLDB.Types.UntagResourceRequest, callback?: (err: AWSError, data: QLDB.Types.UntagResourceResponse) => void): Request<QLDB.Types.UntagResourceResponse, AWSError>; 154 /** 155 * Removes one or more tags from a specified Amazon QLDB resource. You can specify up to 50 tag keys to remove. 156 */ 157 untagResource(callback?: (err: AWSError, data: QLDB.Types.UntagResourceResponse) => void): Request<QLDB.Types.UntagResourceResponse, AWSError>; 158 /** 159 * Updates properties on a ledger. 160 */ 161 updateLedger(params: QLDB.Types.UpdateLedgerRequest, callback?: (err: AWSError, data: QLDB.Types.UpdateLedgerResponse) => void): Request<QLDB.Types.UpdateLedgerResponse, AWSError>; 162 /** 163 * Updates properties on a ledger. 164 */ 165 updateLedger(callback?: (err: AWSError, data: QLDB.Types.UpdateLedgerResponse) => void): Request<QLDB.Types.UpdateLedgerResponse, AWSError>; 166 /** 167 * Updates the permissions mode of a ledger. Before you switch to the STANDARD permissions mode, you must first create all required IAM policies and table tags to avoid disruption to your users. To learn more, see Migrating to the standard permissions mode in the Amazon QLDB Developer Guide. 168 */ 169 updateLedgerPermissionsMode(params: QLDB.Types.UpdateLedgerPermissionsModeRequest, callback?: (err: AWSError, data: QLDB.Types.UpdateLedgerPermissionsModeResponse) => void): Request<QLDB.Types.UpdateLedgerPermissionsModeResponse, AWSError>; 170 /** 171 * Updates the permissions mode of a ledger. Before you switch to the STANDARD permissions mode, you must first create all required IAM policies and table tags to avoid disruption to your users. To learn more, see Migrating to the standard permissions mode in the Amazon QLDB Developer Guide. 172 */ 173 updateLedgerPermissionsMode(callback?: (err: AWSError, data: QLDB.Types.UpdateLedgerPermissionsModeResponse) => void): Request<QLDB.Types.UpdateLedgerPermissionsModeResponse, AWSError>; 174 } 175 declare namespace QLDB { 176 export type Arn = string; 177 export type Boolean = boolean; 178 export interface CancelJournalKinesisStreamRequest { 179 /** 180 * The name of the ledger. 181 */ 182 LedgerName: LedgerName; 183 /** 184 * The UUID (represented in Base62-encoded text) of the QLDB journal stream to be canceled. 185 */ 186 StreamId: UniqueId; 187 } 188 export interface CancelJournalKinesisStreamResponse { 189 /** 190 * The UUID (Base62-encoded text) of the canceled QLDB journal stream. 191 */ 192 StreamId?: UniqueId; 193 } 194 export interface CreateLedgerRequest { 195 /** 196 * The name of the ledger that you want to create. The name must be unique among all of the ledgers in your account in the current Region. Naming constraints for ledger names are defined in Quotas in Amazon QLDB in the Amazon QLDB Developer Guide. 197 */ 198 Name: LedgerName; 199 /** 200 * The key-value pairs to add as tags to the ledger that you want to create. Tag keys are case sensitive. Tag values are case sensitive and can be null. 201 */ 202 Tags?: Tags; 203 /** 204 * The permissions mode to assign to the ledger that you want to create. This parameter can have one of the following values: ALLOW_ALL: A legacy permissions mode that enables access control with API-level granularity for ledgers. This mode allows users who have the SendCommand API permission for this ledger to run all PartiQL commands (hence, ALLOW_ALL) on any tables in the specified ledger. This mode disregards any table-level or command-level IAM permissions policies that you create for the ledger. STANDARD: (Recommended) A permissions mode that enables access control with finer granularity for ledgers, tables, and PartiQL commands. By default, this mode denies all user requests to run any PartiQL commands on any tables in this ledger. To allow PartiQL commands to run, you must create IAM permissions policies for specific table resources and PartiQL actions, in addition to the SendCommand API permission for the ledger. For information, see Getting started with the standard permissions mode in the Amazon QLDB Developer Guide. We strongly recommend using the STANDARD permissions mode to maximize the security of your ledger data. 205 */ 206 PermissionsMode: PermissionsMode; 207 /** 208 * The flag that prevents a ledger from being deleted by any user. If not provided on ledger creation, this feature is enabled (true) by default. If deletion protection is enabled, you must first disable it before you can delete the ledger. You can disable it by calling the UpdateLedger operation to set the flag to false. 209 */ 210 DeletionProtection?: DeletionProtection; 211 /** 212 * The key in Key Management Service (KMS) to use for encryption of data at rest in the ledger. For more information, see Encryption at rest in the Amazon QLDB Developer Guide. Use one of the following options to specify this parameter: AWS_OWNED_KMS_KEY: Use an KMS key that is owned and managed by Amazon Web Services on your behalf. Undefined: By default, use an Amazon Web Services owned KMS key. A valid symmetric customer managed KMS key: Use the specified KMS key in your account that you create, own, and manage. Amazon QLDB does not support asymmetric keys. For more information, see Using symmetric and asymmetric keys in the Key Management Service Developer Guide. To specify a customer managed KMS key, you can use its key ID, Amazon Resource Name (ARN), alias name, or alias ARN. When using an alias name, prefix it with "alias/". To specify a key in a different account, you must use the key ARN or alias ARN. For example: Key ID: 1234abcd-12ab-34cd-56ef-1234567890ab Key ARN: arn:aws:kms:us-east-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab Alias name: alias/ExampleAlias Alias ARN: arn:aws:kms:us-east-2:111122223333:alias/ExampleAlias For more information, see Key identifiers (KeyId) in the Key Management Service Developer Guide. 213 */ 214 KmsKey?: KmsKey; 215 } 216 export interface CreateLedgerResponse { 217 /** 218 * The name of the ledger. 219 */ 220 Name?: LedgerName; 221 /** 222 * The Amazon Resource Name (ARN) for the ledger. 223 */ 224 Arn?: Arn; 225 /** 226 * The current status of the ledger. 227 */ 228 State?: LedgerState; 229 /** 230 * The date and time, in epoch time format, when the ledger was created. (Epoch time format is the number of seconds elapsed since 12:00:00 AM January 1, 1970 UTC.) 231 */ 232 CreationDateTime?: Timestamp; 233 /** 234 * The permissions mode of the ledger that you created. 235 */ 236 PermissionsMode?: PermissionsMode; 237 /** 238 * The flag that prevents a ledger from being deleted by any user. If not provided on ledger creation, this feature is enabled (true) by default. If deletion protection is enabled, you must first disable it before you can delete the ledger. You can disable it by calling the UpdateLedger operation to set the flag to false. 239 */ 240 DeletionProtection?: DeletionProtection; 241 /** 242 * The ARN of the customer managed KMS key that the ledger uses for encryption at rest. If this parameter is undefined, the ledger uses an Amazon Web Services owned KMS key for encryption. 243 */ 244 KmsKeyArn?: Arn; 245 } 246 export interface DeleteLedgerRequest { 247 /** 248 * The name of the ledger that you want to delete. 249 */ 250 Name: LedgerName; 251 } 252 export type DeletionProtection = boolean; 253 export interface DescribeJournalKinesisStreamRequest { 254 /** 255 * The name of the ledger. 256 */ 257 LedgerName: LedgerName; 258 /** 259 * The UUID (represented in Base62-encoded text) of the QLDB journal stream to describe. 260 */ 261 StreamId: UniqueId; 262 } 263 export interface DescribeJournalKinesisStreamResponse { 264 /** 265 * Information about the QLDB journal stream returned by a DescribeJournalS3Export request. 266 */ 267 Stream?: JournalKinesisStreamDescription; 268 } 269 export interface DescribeJournalS3ExportRequest { 270 /** 271 * The name of the ledger. 272 */ 273 Name: LedgerName; 274 /** 275 * The UUID (represented in Base62-encoded text) of the journal export job to describe. 276 */ 277 ExportId: UniqueId; 278 } 279 export interface DescribeJournalS3ExportResponse { 280 /** 281 * Information about the journal export job returned by a DescribeJournalS3Export request. 282 */ 283 ExportDescription: JournalS3ExportDescription; 284 } 285 export interface DescribeLedgerRequest { 286 /** 287 * The name of the ledger that you want to describe. 288 */ 289 Name: LedgerName; 290 } 291 export interface DescribeLedgerResponse { 292 /** 293 * The name of the ledger. 294 */ 295 Name?: LedgerName; 296 /** 297 * The Amazon Resource Name (ARN) for the ledger. 298 */ 299 Arn?: Arn; 300 /** 301 * The current status of the ledger. 302 */ 303 State?: LedgerState; 304 /** 305 * The date and time, in epoch time format, when the ledger was created. (Epoch time format is the number of seconds elapsed since 12:00:00 AM January 1, 1970 UTC.) 306 */ 307 CreationDateTime?: Timestamp; 308 /** 309 * The permissions mode of the ledger. 310 */ 311 PermissionsMode?: PermissionsMode; 312 /** 313 * The flag that prevents a ledger from being deleted by any user. If not provided on ledger creation, this feature is enabled (true) by default. If deletion protection is enabled, you must first disable it before you can delete the ledger. You can disable it by calling the UpdateLedger operation to set the flag to false. 314 */ 315 DeletionProtection?: DeletionProtection; 316 /** 317 * Information about the encryption of data at rest in the ledger. This includes the current status, the KMS key, and when the key became inaccessible (in the case of an error). 318 */ 319 EncryptionDescription?: LedgerEncryptionDescription; 320 } 321 export type Digest = Buffer|Uint8Array|Blob|string; 322 export type EncryptionStatus = "ENABLED"|"UPDATING"|"KMS_KEY_INACCESSIBLE"|string; 323 export type ErrorCause = "KINESIS_STREAM_NOT_FOUND"|"IAM_PERMISSION_REVOKED"|string; 324 export interface ExportJournalToS3Request { 325 /** 326 * The name of the ledger. 327 */ 328 Name: LedgerName; 329 /** 330 * The inclusive start date and time for the range of journal contents to export. The InclusiveStartTime must be in ISO 8601 date and time format and in Universal Coordinated Time (UTC). For example: 2019-06-13T21:36:34Z. The InclusiveStartTime must be before ExclusiveEndTime. If you provide an InclusiveStartTime that is before the ledger's CreationDateTime, Amazon QLDB defaults it to the ledger's CreationDateTime. 331 */ 332 InclusiveStartTime: Timestamp; 333 /** 334 * The exclusive end date and time for the range of journal contents to export. The ExclusiveEndTime must be in ISO 8601 date and time format and in Universal Coordinated Time (UTC). For example: 2019-06-13T21:36:34Z. The ExclusiveEndTime must be less than or equal to the current UTC date and time. 335 */ 336 ExclusiveEndTime: Timestamp; 337 /** 338 * The configuration settings of the Amazon S3 bucket destination for your export request. 339 */ 340 S3ExportConfiguration: S3ExportConfiguration; 341 /** 342 * The Amazon Resource Name (ARN) of the IAM role that grants QLDB permissions for a journal export job to do the following: Write objects into your Amazon Simple Storage Service (Amazon S3) bucket. (Optional) Use your customer master key (CMK) in Key Management Service (KMS) for server-side encryption of your exported data. 343 */ 344 RoleArn: Arn; 345 } 346 export interface ExportJournalToS3Response { 347 /** 348 * The UUID (represented in Base62-encoded text) that QLDB assigns to each journal export job. To describe your export request and check the status of the job, you can use ExportId to call DescribeJournalS3Export. 349 */ 350 ExportId: UniqueId; 351 } 352 export type ExportStatus = "IN_PROGRESS"|"COMPLETED"|"CANCELLED"|string; 353 export interface GetBlockRequest { 354 /** 355 * The name of the ledger. 356 */ 357 Name: LedgerName; 358 /** 359 * The location of the block that you want to request. An address is an Amazon Ion structure that has two fields: strandId and sequenceNo. For example: {strandId:"BlFTjlSXze9BIh1KOszcE3",sequenceNo:14}. 360 */ 361 BlockAddress: ValueHolder; 362 /** 363 * The latest block location covered by the digest for which to request a proof. An address is an Amazon Ion structure that has two fields: strandId and sequenceNo. For example: {strandId:"BlFTjlSXze9BIh1KOszcE3",sequenceNo:49}. 364 */ 365 DigestTipAddress?: ValueHolder; 366 } 367 export interface GetBlockResponse { 368 /** 369 * The block data object in Amazon Ion format. 370 */ 371 Block: ValueHolder; 372 /** 373 * The proof object in Amazon Ion format returned by a GetBlock request. A proof contains the list of hash values required to recalculate the specified digest using a Merkle tree, starting with the specified block. 374 */ 375 Proof?: ValueHolder; 376 } 377 export interface GetDigestRequest { 378 /** 379 * The name of the ledger. 380 */ 381 Name: LedgerName; 382 } 383 export interface GetDigestResponse { 384 /** 385 * The 256-bit hash value representing the digest returned by a GetDigest request. 386 */ 387 Digest: Digest; 388 /** 389 * The latest block location covered by the digest that you requested. An address is an Amazon Ion structure that has two fields: strandId and sequenceNo. 390 */ 391 DigestTipAddress: ValueHolder; 392 } 393 export interface GetRevisionRequest { 394 /** 395 * The name of the ledger. 396 */ 397 Name: LedgerName; 398 /** 399 * The block location of the document revision to be verified. An address is an Amazon Ion structure that has two fields: strandId and sequenceNo. For example: {strandId:"BlFTjlSXze9BIh1KOszcE3",sequenceNo:14}. 400 */ 401 BlockAddress: ValueHolder; 402 /** 403 * The UUID (represented in Base62-encoded text) of the document to be verified. 404 */ 405 DocumentId: UniqueId; 406 /** 407 * The latest block location covered by the digest for which to request a proof. An address is an Amazon Ion structure that has two fields: strandId and sequenceNo. For example: {strandId:"BlFTjlSXze9BIh1KOszcE3",sequenceNo:49}. 408 */ 409 DigestTipAddress?: ValueHolder; 410 } 411 export interface GetRevisionResponse { 412 /** 413 * The proof object in Amazon Ion format returned by a GetRevision request. A proof contains the list of hash values that are required to recalculate the specified digest using a Merkle tree, starting with the specified document revision. 414 */ 415 Proof?: ValueHolder; 416 /** 417 * The document revision data object in Amazon Ion format. 418 */ 419 Revision: ValueHolder; 420 } 421 export type IonText = string; 422 export interface JournalKinesisStreamDescription { 423 /** 424 * The name of the ledger. 425 */ 426 LedgerName: LedgerName; 427 /** 428 * The date and time, in epoch time format, when the QLDB journal stream was created. (Epoch time format is the number of seconds elapsed since 12:00:00 AM January 1, 1970 UTC.) 429 */ 430 CreationTime?: Timestamp; 431 /** 432 * The inclusive start date and time from which to start streaming journal data. 433 */ 434 InclusiveStartTime?: Timestamp; 435 /** 436 * The exclusive date and time that specifies when the stream ends. If this parameter is undefined, the stream runs indefinitely until you cancel it. 437 */ 438 ExclusiveEndTime?: Timestamp; 439 /** 440 * The Amazon Resource Name (ARN) of the IAM role that grants QLDB permissions for a journal stream to write data records to a Kinesis Data Streams resource. 441 */ 442 RoleArn: Arn; 443 /** 444 * The UUID (represented in Base62-encoded text) of the QLDB journal stream. 445 */ 446 StreamId: UniqueId; 447 /** 448 * The Amazon Resource Name (ARN) of the QLDB journal stream. 449 */ 450 Arn?: Arn; 451 /** 452 * The current state of the QLDB journal stream. 453 */ 454 Status: StreamStatus; 455 /** 456 * The configuration settings of the Amazon Kinesis Data Streams destination for a QLDB journal stream. 457 */ 458 KinesisConfiguration: KinesisConfiguration; 459 /** 460 * The error message that describes the reason that a stream has a status of IMPAIRED or FAILED. This is not applicable to streams that have other status values. 461 */ 462 ErrorCause?: ErrorCause; 463 /** 464 * The user-defined name of the QLDB journal stream. 465 */ 466 StreamName: StreamName; 467 } 468 export type JournalKinesisStreamDescriptionList = JournalKinesisStreamDescription[]; 469 export interface JournalS3ExportDescription { 470 /** 471 * The name of the ledger. 472 */ 473 LedgerName: LedgerName; 474 /** 475 * The UUID (represented in Base62-encoded text) of the journal export job. 476 */ 477 ExportId: UniqueId; 478 /** 479 * The date and time, in epoch time format, when the export job was created. (Epoch time format is the number of seconds elapsed since 12:00:00 AM January 1, 1970 UTC.) 480 */ 481 ExportCreationTime: Timestamp; 482 /** 483 * The current state of the journal export job. 484 */ 485 Status: ExportStatus; 486 /** 487 * The inclusive start date and time for the range of journal contents that are specified in the original export request. 488 */ 489 InclusiveStartTime: Timestamp; 490 /** 491 * The exclusive end date and time for the range of journal contents that are specified in the original export request. 492 */ 493 ExclusiveEndTime: Timestamp; 494 S3ExportConfiguration: S3ExportConfiguration; 495 /** 496 * The Amazon Resource Name (ARN) of the IAM role that grants QLDB permissions for a journal export job to do the following: Write objects into your Amazon Simple Storage Service (Amazon S3) bucket. (Optional) Use your customer master key (CMK) in Key Management Service (KMS) for server-side encryption of your exported data. 497 */ 498 RoleArn: Arn; 499 } 500 export type JournalS3ExportList = JournalS3ExportDescription[]; 501 export interface KinesisConfiguration { 502 /** 503 * The Amazon Resource Name (ARN) of the Kinesis Data Streams resource. 504 */ 505 StreamArn: Arn; 506 /** 507 * Enables QLDB to publish multiple data records in a single Kinesis Data Streams record, increasing the number of records sent per API call. This option is enabled by default. Record aggregation has important implications for processing records and requires de-aggregation in your stream consumer. To learn more, see KPL Key Concepts and Consumer De-aggregation in the Amazon Kinesis Data Streams Developer Guide. 508 */ 509 AggregationEnabled?: Boolean; 510 } 511 export type KmsKey = string; 512 export interface LedgerEncryptionDescription { 513 /** 514 * The Amazon Resource Name (ARN) of the customer managed KMS key that the ledger uses for encryption at rest. If this parameter is undefined, the ledger uses an Amazon Web Services owned KMS key for encryption. 515 */ 516 KmsKeyArn: Arn; 517 /** 518 * The current state of encryption at rest for the ledger. This can be one of the following values: ENABLED: Encryption is fully enabled using the specified key. UPDATING: The ledger is actively processing the specified key change. Key changes in QLDB are asynchronous. The ledger is fully accessible without any performance impact while the key change is being processed. The amount of time it takes to update a key varies depending on the ledger size. KMS_KEY_INACCESSIBLE: The specified customer managed KMS key is not accessible, and the ledger is impaired. Either the key was disabled or deleted, or the grants on the key were revoked. When a ledger is impaired, it is not accessible and does not accept any read or write requests. An impaired ledger automatically returns to an active state after you restore the grants on the key, or re-enable the key that was disabled. However, deleting a customer managed KMS key is irreversible. After a key is deleted, you can no longer access the ledgers that are protected with that key, and the data becomes unrecoverable permanently. 519 */ 520 EncryptionStatus: EncryptionStatus; 521 /** 522 * The date and time, in epoch time format, when the KMS key first became inaccessible, in the case of an error. (Epoch time format is the number of seconds that have elapsed since 12:00:00 AM January 1, 1970 UTC.) This parameter is undefined if the KMS key is accessible. 523 */ 524 InaccessibleKmsKeyDateTime?: Timestamp; 525 } 526 export type LedgerList = LedgerSummary[]; 527 export type LedgerName = string; 528 export type LedgerState = "CREATING"|"ACTIVE"|"DELETING"|"DELETED"|string; 529 export interface LedgerSummary { 530 /** 531 * The name of the ledger. 532 */ 533 Name?: LedgerName; 534 /** 535 * The current status of the ledger. 536 */ 537 State?: LedgerState; 538 /** 539 * The date and time, in epoch time format, when the ledger was created. (Epoch time format is the number of seconds elapsed since 12:00:00 AM January 1, 1970 UTC.) 540 */ 541 CreationDateTime?: Timestamp; 542 } 543 export interface ListJournalKinesisStreamsForLedgerRequest { 544 /** 545 * The name of the ledger. 546 */ 547 LedgerName: LedgerName; 548 /** 549 * The maximum number of results to return in a single ListJournalKinesisStreamsForLedger request. (The actual number of results returned might be fewer.) 550 */ 551 MaxResults?: MaxResults; 552 /** 553 * A pagination token, indicating that you want to retrieve the next page of results. If you received a value for NextToken in the response from a previous ListJournalKinesisStreamsForLedger call, you should use that value as input here. 554 */ 555 NextToken?: NextToken; 556 } 557 export interface ListJournalKinesisStreamsForLedgerResponse { 558 /** 559 * The array of QLDB journal stream descriptors that are associated with the given ledger. 560 */ 561 Streams?: JournalKinesisStreamDescriptionList; 562 /** 563 * If NextToken is empty, the last page of results has been processed and there are no more results to be retrieved. If NextToken is not empty, more results are available. To retrieve the next page of results, use the value of NextToken in a subsequent ListJournalKinesisStreamsForLedger call. 564 */ 565 NextToken?: NextToken; 566 } 567 export interface ListJournalS3ExportsForLedgerRequest { 568 /** 569 * The name of the ledger. 570 */ 571 Name: LedgerName; 572 /** 573 * The maximum number of results to return in a single ListJournalS3ExportsForLedger request. (The actual number of results returned might be fewer.) 574 */ 575 MaxResults?: MaxResults; 576 /** 577 * A pagination token, indicating that you want to retrieve the next page of results. If you received a value for NextToken in the response from a previous ListJournalS3ExportsForLedger call, then you should use that value as input here. 578 */ 579 NextToken?: NextToken; 580 } 581 export interface ListJournalS3ExportsForLedgerResponse { 582 /** 583 * The array of journal export job descriptions that are associated with the specified ledger. 584 */ 585 JournalS3Exports?: JournalS3ExportList; 586 /** 587 * If NextToken is empty, then the last page of results has been processed and there are no more results to be retrieved. If NextToken is not empty, then there are more results available. To retrieve the next page of results, use the value of NextToken in a subsequent ListJournalS3ExportsForLedger call. 588 */ 589 NextToken?: NextToken; 590 } 591 export interface ListJournalS3ExportsRequest { 592 /** 593 * The maximum number of results to return in a single ListJournalS3Exports request. (The actual number of results returned might be fewer.) 594 */ 595 MaxResults?: MaxResults; 596 /** 597 * A pagination token, indicating that you want to retrieve the next page of results. If you received a value for NextToken in the response from a previous ListJournalS3Exports call, then you should use that value as input here. 598 */ 599 NextToken?: NextToken; 600 } 601 export interface ListJournalS3ExportsResponse { 602 /** 603 * The array of journal export job descriptions for all ledgers that are associated with the current account and Region. 604 */ 605 JournalS3Exports?: JournalS3ExportList; 606 /** 607 * If NextToken is empty, then the last page of results has been processed and there are no more results to be retrieved. If NextToken is not empty, then there are more results available. To retrieve the next page of results, use the value of NextToken in a subsequent ListJournalS3Exports call. 608 */ 609 NextToken?: NextToken; 610 } 611 export interface ListLedgersRequest { 612 /** 613 * The maximum number of results to return in a single ListLedgers request. (The actual number of results returned might be fewer.) 614 */ 615 MaxResults?: MaxResults; 616 /** 617 * A pagination token, indicating that you want to retrieve the next page of results. If you received a value for NextToken in the response from a previous ListLedgers call, then you should use that value as input here. 618 */ 619 NextToken?: NextToken; 620 } 621 export interface ListLedgersResponse { 622 /** 623 * The array of ledger summaries that are associated with the current account and Region. 624 */ 625 Ledgers?: LedgerList; 626 /** 627 * A pagination token, indicating whether there are more results available: If NextToken is empty, then the last page of results has been processed and there are no more results to be retrieved. If NextToken is not empty, then there are more results available. To retrieve the next page of results, use the value of NextToken in a subsequent ListLedgers call. 628 */ 629 NextToken?: NextToken; 630 } 631 export interface ListTagsForResourceRequest { 632 /** 633 * The Amazon Resource Name (ARN) for which to list the tags. For example: arn:aws:qldb:us-east-1:123456789012:ledger/exampleLedger 634 */ 635 ResourceArn: Arn; 636 } 637 export interface ListTagsForResourceResponse { 638 /** 639 * The tags that are currently associated with the specified Amazon QLDB resource. 640 */ 641 Tags?: Tags; 642 } 643 export type MaxResults = number; 644 export type NextToken = string; 645 export type PermissionsMode = "ALLOW_ALL"|"STANDARD"|string; 646 export type S3Bucket = string; 647 export interface S3EncryptionConfiguration { 648 /** 649 * The Amazon S3 object encryption type. To learn more about server-side encryption options in Amazon S3, see Protecting Data Using Server-Side Encryption in the Amazon S3 Developer Guide. 650 */ 651 ObjectEncryptionType: S3ObjectEncryptionType; 652 /** 653 * The Amazon Resource Name (ARN) of a symmetric customer master key (CMK) in Key Management Service (KMS). Amazon S3 does not support asymmetric CMKs. You must provide a KmsKeyArn if you specify SSE_KMS as the ObjectEncryptionType. KmsKeyArn is not required if you specify SSE_S3 as the ObjectEncryptionType. 654 */ 655 KmsKeyArn?: Arn; 656 } 657 export interface S3ExportConfiguration { 658 /** 659 * The Amazon S3 bucket name in which a journal export job writes the journal contents. The bucket name must comply with the Amazon S3 bucket naming conventions. For more information, see Bucket Restrictions and Limitations in the Amazon S3 Developer Guide. 660 */ 661 Bucket: S3Bucket; 662 /** 663 * The prefix for the Amazon S3 bucket in which a journal export job writes the journal contents. The prefix must comply with Amazon S3 key naming rules and restrictions. For more information, see Object Key and Metadata in the Amazon S3 Developer Guide. The following are examples of valid Prefix values: JournalExports-ForMyLedger/Testing/ JournalExports My:Tests/ 664 */ 665 Prefix: S3Prefix; 666 /** 667 * The encryption settings that are used by a journal export job to write data in an Amazon S3 bucket. 668 */ 669 EncryptionConfiguration: S3EncryptionConfiguration; 670 } 671 export type S3ObjectEncryptionType = "SSE_KMS"|"SSE_S3"|"NO_ENCRYPTION"|string; 672 export type S3Prefix = string; 673 export interface StreamJournalToKinesisRequest { 674 /** 675 * The name of the ledger. 676 */ 677 LedgerName: LedgerName; 678 /** 679 * The Amazon Resource Name (ARN) of the IAM role that grants QLDB permissions for a journal stream to write data records to a Kinesis Data Streams resource. 680 */ 681 RoleArn: Arn; 682 /** 683 * The key-value pairs to add as tags to the stream that you want to create. Tag keys are case sensitive. Tag values are case sensitive and can be null. 684 */ 685 Tags?: Tags; 686 /** 687 * The inclusive start date and time from which to start streaming journal data. This parameter must be in ISO 8601 date and time format and in Universal Coordinated Time (UTC). For example: 2019-06-13T21:36:34Z. The InclusiveStartTime cannot be in the future and must be before ExclusiveEndTime. If you provide an InclusiveStartTime that is before the ledger's CreationDateTime, QLDB effectively defaults it to the ledger's CreationDateTime. 688 */ 689 InclusiveStartTime: Timestamp; 690 /** 691 * The exclusive date and time that specifies when the stream ends. If you don't define this parameter, the stream runs indefinitely until you cancel it. The ExclusiveEndTime must be in ISO 8601 date and time format and in Universal Coordinated Time (UTC). For example: 2019-06-13T21:36:34Z. 692 */ 693 ExclusiveEndTime?: Timestamp; 694 /** 695 * The configuration settings of the Kinesis Data Streams destination for your stream request. 696 */ 697 KinesisConfiguration: KinesisConfiguration; 698 /** 699 * The name that you want to assign to the QLDB journal stream. User-defined names can help identify and indicate the purpose of a stream. Your stream name must be unique among other active streams for a given ledger. Stream names have the same naming constraints as ledger names, as defined in Quotas in Amazon QLDB in the Amazon QLDB Developer Guide. 700 */ 701 StreamName: StreamName; 702 } 703 export interface StreamJournalToKinesisResponse { 704 /** 705 * The UUID (represented in Base62-encoded text) that QLDB assigns to each QLDB journal stream. 706 */ 707 StreamId?: UniqueId; 708 } 709 export type StreamName = string; 710 export type StreamStatus = "ACTIVE"|"COMPLETED"|"CANCELED"|"FAILED"|"IMPAIRED"|string; 711 export type TagKey = string; 712 export type TagKeyList = TagKey[]; 713 export interface TagResourceRequest { 714 /** 715 * The Amazon Resource Name (ARN) to which you want to add the tags. For example: arn:aws:qldb:us-east-1:123456789012:ledger/exampleLedger 716 */ 717 ResourceArn: Arn; 718 /** 719 * The key-value pairs to add as tags to the specified QLDB resource. Tag keys are case sensitive. If you specify a key that already exists for the resource, your request fails and returns an error. Tag values are case sensitive and can be null. 720 */ 721 Tags: Tags; 722 } 723 export interface TagResourceResponse { 724 } 725 export type TagValue = string; 726 export type Tags = {[key: string]: TagValue}; 727 export type Timestamp = Date; 728 export type UniqueId = string; 729 export interface UntagResourceRequest { 730 /** 731 * The Amazon Resource Name (ARN) from which to remove the tags. For example: arn:aws:qldb:us-east-1:123456789012:ledger/exampleLedger 732 */ 733 ResourceArn: Arn; 734 /** 735 * The list of tag keys to remove. 736 */ 737 TagKeys: TagKeyList; 738 } 739 export interface UntagResourceResponse { 740 } 741 export interface UpdateLedgerPermissionsModeRequest { 742 /** 743 * The name of the ledger. 744 */ 745 Name: LedgerName; 746 /** 747 * The permissions mode to assign to the ledger. This parameter can have one of the following values: ALLOW_ALL: A legacy permissions mode that enables access control with API-level granularity for ledgers. This mode allows users who have the SendCommand API permission for this ledger to run all PartiQL commands (hence, ALLOW_ALL) on any tables in the specified ledger. This mode disregards any table-level or command-level IAM permissions policies that you create for the ledger. STANDARD: (Recommended) A permissions mode that enables access control with finer granularity for ledgers, tables, and PartiQL commands. By default, this mode denies all user requests to run any PartiQL commands on any tables in this ledger. To allow PartiQL commands to run, you must create IAM permissions policies for specific table resources and PartiQL actions, in addition to the SendCommand API permission for the ledger. For information, see Getting started with the standard permissions mode in the Amazon QLDB Developer Guide. We strongly recommend using the STANDARD permissions mode to maximize the security of your ledger data. 748 */ 749 PermissionsMode: PermissionsMode; 750 } 751 export interface UpdateLedgerPermissionsModeResponse { 752 /** 753 * The name of the ledger. 754 */ 755 Name?: LedgerName; 756 /** 757 * The Amazon Resource Name (ARN) for the ledger. 758 */ 759 Arn?: Arn; 760 /** 761 * The current permissions mode of the ledger. 762 */ 763 PermissionsMode?: PermissionsMode; 764 } 765 export interface UpdateLedgerRequest { 766 /** 767 * The name of the ledger. 768 */ 769 Name: LedgerName; 770 /** 771 * The flag that prevents a ledger from being deleted by any user. If not provided on ledger creation, this feature is enabled (true) by default. If deletion protection is enabled, you must first disable it before you can delete the ledger. You can disable it by calling the UpdateLedger operation to set the flag to false. 772 */ 773 DeletionProtection?: DeletionProtection; 774 /** 775 * The key in Key Management Service (KMS) to use for encryption of data at rest in the ledger. For more information, see Encryption at rest in the Amazon QLDB Developer Guide. Use one of the following options to specify this parameter: AWS_OWNED_KMS_KEY: Use an KMS key that is owned and managed by Amazon Web Services on your behalf. Undefined: Make no changes to the KMS key of the ledger. A valid symmetric customer managed KMS key: Use the specified KMS key in your account that you create, own, and manage. Amazon QLDB does not support asymmetric keys. For more information, see Using symmetric and asymmetric keys in the Key Management Service Developer Guide. To specify a customer managed KMS key, you can use its key ID, Amazon Resource Name (ARN), alias name, or alias ARN. When using an alias name, prefix it with "alias/". To specify a key in a different account, you must use the key ARN or alias ARN. For example: Key ID: 1234abcd-12ab-34cd-56ef-1234567890ab Key ARN: arn:aws:kms:us-east-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab Alias name: alias/ExampleAlias Alias ARN: arn:aws:kms:us-east-2:111122223333:alias/ExampleAlias For more information, see Key identifiers (KeyId) in the Key Management Service Developer Guide. 776 */ 777 KmsKey?: KmsKey; 778 } 779 export interface UpdateLedgerResponse { 780 /** 781 * The name of the ledger. 782 */ 783 Name?: LedgerName; 784 /** 785 * The Amazon Resource Name (ARN) for the ledger. 786 */ 787 Arn?: Arn; 788 /** 789 * The current status of the ledger. 790 */ 791 State?: LedgerState; 792 /** 793 * The date and time, in epoch time format, when the ledger was created. (Epoch time format is the number of seconds elapsed since 12:00:00 AM January 1, 1970 UTC.) 794 */ 795 CreationDateTime?: Timestamp; 796 /** 797 * The flag that prevents a ledger from being deleted by any user. If not provided on ledger creation, this feature is enabled (true) by default. If deletion protection is enabled, you must first disable it before you can delete the ledger. You can disable it by calling the UpdateLedger operation to set the flag to false. 798 */ 799 DeletionProtection?: DeletionProtection; 800 /** 801 * Information about the encryption of data at rest in the ledger. This includes the current status, the KMS key, and when the key became inaccessible (in the case of an error). 802 */ 803 EncryptionDescription?: LedgerEncryptionDescription; 804 } 805 export interface ValueHolder { 806 /** 807 * An Amazon Ion plaintext value contained in a ValueHolder structure. 808 */ 809 IonText?: IonText; 810 } 811 /** 812 * A string in YYYY-MM-DD format that represents the latest possible API version that can be used in this service. Specify 'latest' to use the latest possible version. 813 */ 814 export type apiVersion = "2019-01-02"|"latest"|string; 815 export interface ClientApiVersions { 816 /** 817 * A string in YYYY-MM-DD format that represents the latest possible API version that can be used in this service. Specify 'latest' to use the latest possible version. 818 */ 819 apiVersion?: apiVersion; 820 } 821 export type ClientConfiguration = ServiceConfigurationOptions & ClientApiVersions; 822 /** 823 * Contains interfaces for use with the QLDB client. 824 */ 825 export import Types = QLDB; 826 } 827 export = QLDB;