Struct aws_sdk_qldb::client::Client

pub struct Client { /* private fields */ }

Client for Amazon QLDB

Client for invoking operations on Amazon QLDB. Each operation on Amazon QLDB is a method on this this struct. .send() MUST be invoked on the generated operations to dispatch the request to the service.

Examples

Constructing a client and invoking an operation

    // create a shared configuration. This can be used & shared between multiple service clients.
    let shared_config = aws_config::load_from_env().await;
    let client = aws_sdk_qldb::Client::new(&shared_config);
    // invoke an operation
    /* let rsp = client
        .<operation_name>().
        .<param>("some value")
        .send().await; */

Constructing a client with custom configuration

use aws_config::RetryConfig;
let shared_config = aws_config::load_from_env().await;
let config = aws_sdk_qldb::config::Builder::from(&shared_config)
  .retry_config(RetryConfig::disabled())
  .build();
let client = aws_sdk_qldb::Client::from_conf(config);

Implementations

impl Client

pub fn with_config(
    client: Client<DynConnector, DynMiddleware<DynConnector>>,
    conf: Config
) -> Self

Creates a client with the given service configuration.

pub fn conf(&self) -> &Config

Returns the client’s configuration.

impl Client

pub fn cancel_journal_kinesis_stream(&self) -> CancelJournalKinesisStream

Constructs a fluent builder for the CancelJournalKinesisStream operation.

• The fluent builder is configurable:
  • ledger_name(impl Into<String>) / set_ledger_name(Option<String>):

    The name of the ledger.

  • stream_id(impl Into<String>) / set_stream_id(Option<String>):

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

• On success, responds with CancelJournalKinesisStreamOutput with field(s):
  • stream_id(Option<String>):

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

• On failure, responds with SdkError<CancelJournalKinesisStreamError>

pub fn create_ledger(&self) -> CreateLedger

Constructs a fluent builder for the CreateLedger operation.

• The fluent builder is configurable:
  • name(impl Into<String>) / set_name(Option<String>):

    The name of the ledger that you want to create. The name must be unique among all of the ledgers in your Amazon Web Services account in the current Region.

    Naming constraints for ledger names are defined in Quotas in Amazon QLDB in the Amazon QLDB Developer Guide.

  • tags(HashMap<String, Option<String>>) / set_tags(Option<HashMap<String, Option<String>>>):

    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.

  • permissions_mode(PermissionsMode) / set_permissions_mode(Option<PermissionsMode>):

    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.

  • deletion_protection(bool) / set_deletion_protection(Option<bool>):

    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.

  • kms_key(impl Into<String>) / set_kms_key(Option<String>):

    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 Amazon Web Services 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.

• On success, responds with CreateLedgerOutput with field(s):
  • name(Option<String>):

    The name of the ledger.

  • arn(Option<String>):

    The Amazon Resource Name (ARN) for the ledger.

  • state(Option<LedgerState>):

    The current status of the ledger.

  • creation_date_time(Option<DateTime>):

    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.)

  • permissions_mode(Option<PermissionsMode>):

    The permissions mode of the ledger that you created.

  • deletion_protection(Option<bool>):

    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.

  • kms_key_arn(Option<String>):

    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.

• On failure, responds with SdkError<CreateLedgerError>

pub fn delete_ledger(&self) -> DeleteLedger

Constructs a fluent builder for the DeleteLedger operation.

• The fluent builder is configurable:
  • name(impl Into<String>) / set_name(Option<String>):

    The name of the ledger that you want to delete.

• On success, responds with DeleteLedgerOutput
• On failure, responds with SdkError<DeleteLedgerError>

pub fn describe_journal_kinesis_stream(&self) -> DescribeJournalKinesisStream

Constructs a fluent builder for the DescribeJournalKinesisStream operation.

• The fluent builder is configurable:
  • ledger_name(impl Into<String>) / set_ledger_name(Option<String>):

    The name of the ledger.

  • stream_id(impl Into<String>) / set_stream_id(Option<String>):

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

• On success, responds with DescribeJournalKinesisStreamOutput with field(s):
  • stream(Option<JournalKinesisStreamDescription>):

    Information about the QLDB journal stream returned by a DescribeJournalS3Export request.

• On failure, responds with SdkError<DescribeJournalKinesisStreamError>

pub fn describe_journal_s3_export(&self) -> DescribeJournalS3Export

Constructs a fluent builder for the DescribeJournalS3Export operation.

• The fluent builder is configurable:
  • name(impl Into<String>) / set_name(Option<String>):

    The name of the ledger.

  • export_id(impl Into<String>) / set_export_id(Option<String>):

    The UUID (represented in Base62-encoded text) of the journal export job to describe.

• On success, responds with DescribeJournalS3ExportOutput with field(s):
  • export_description(Option<JournalS3ExportDescription>):

    Information about the journal export job returned by a DescribeJournalS3Export request.

• On failure, responds with SdkError<DescribeJournalS3ExportError>

pub fn describe_ledger(&self) -> DescribeLedger

Constructs a fluent builder for the DescribeLedger operation.

• The fluent builder is configurable:
  • name(impl Into<String>) / set_name(Option<String>):

    The name of the ledger that you want to describe.

• On success, responds with DescribeLedgerOutput with field(s):
  • name(Option<String>):

    The name of the ledger.

  • arn(Option<String>):

    The Amazon Resource Name (ARN) for the ledger.

  • state(Option<LedgerState>):

    The current status of the ledger.

  • creation_date_time(Option<DateTime>):

    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.)

  • permissions_mode(Option<PermissionsMode>):

    The permissions mode of the ledger.

  • deletion_protection(Option<bool>):

    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.

  • encryption_description(Option<LedgerEncryptionDescription>):

    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).

• On failure, responds with SdkError<DescribeLedgerError>

pub fn export_journal_to_s3(&self) -> ExportJournalToS3

Constructs a fluent builder for the ExportJournalToS3 operation.

• The fluent builder is configurable:
  • name(impl Into<String>) / set_name(Option<String>):

    The name of the ledger.

  • inclusive_start_time(DateTime) / set_inclusive_start_time(Option<DateTime>):

    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.

  • exclusive_end_time(DateTime) / set_exclusive_end_time(Option<DateTime>):

    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.

  • s3_export_configuration(S3ExportConfiguration) / set_s3_export_configuration(Option<S3ExportConfiguration>):

    The configuration settings of the Amazon S3 bucket destination for your export request.

  • role_arn(impl Into<String>) / set_role_arn(Option<String>):

    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 managed key in Key Management Service (KMS) for server-side encryption of your exported data.

    To pass a role to QLDB when requesting a journal export, you must have permissions to perform the iam:PassRole action on the IAM role resource. This is required for all journal export requests.

  • output_format(OutputFormat) / set_output_format(Option<OutputFormat>):

    The output format of your exported journal data. If this parameter is not specified, the exported data defaults to ION_TEXT format.

• On success, responds with ExportJournalToS3Output with field(s):
  • export_id(Option<String>):

    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.

• On failure, responds with SdkError<ExportJournalToS3Error>

pub fn get_block(&self) -> GetBlock

Constructs a fluent builder for the GetBlock operation.

• The fluent builder is configurable:
  • name(impl Into<String>) / set_name(Option<String>):

    The name of the ledger.

  • block_address(ValueHolder) / set_block_address(Option<ValueHolder>):

    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}.

  • digest_tip_address(ValueHolder) / set_digest_tip_address(Option<ValueHolder>):

    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}.

• On success, responds with GetBlockOutput with field(s):
  • block(Option<ValueHolder>):

    The block data object in Amazon Ion format.

  • proof(Option<ValueHolder>):

    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.

• On failure, responds with SdkError<GetBlockError>

pub fn get_digest(&self) -> GetDigest

Constructs a fluent builder for the GetDigest operation.

• The fluent builder is configurable:
  • name(impl Into<String>) / set_name(Option<String>):

    The name of the ledger.

• On success, responds with GetDigestOutput with field(s):
  • digest(Option<Blob>):

    The 256-bit hash value representing the digest returned by a GetDigest request.

  • digest_tip_address(Option<ValueHolder>):

    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.

• On failure, responds with SdkError<GetDigestError>

pub fn get_revision(&self) -> GetRevision

Constructs a fluent builder for the GetRevision operation.

• The fluent builder is configurable:
  • name(impl Into<String>) / set_name(Option<String>):

    The name of the ledger.

  • block_address(ValueHolder) / set_block_address(Option<ValueHolder>):

    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}.

  • document_id(impl Into<String>) / set_document_id(Option<String>):

    The UUID (represented in Base62-encoded text) of the document to be verified.

  • digest_tip_address(ValueHolder) / set_digest_tip_address(Option<ValueHolder>):

    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}.

• On success, responds with GetRevisionOutput with field(s):
  • proof(Option<ValueHolder>):

    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.

  • revision(Option<ValueHolder>):

    The document revision data object in Amazon Ion format.

• On failure, responds with SdkError<GetRevisionError>

pub fn list_journal_kinesis_streams_for_ledger(
    &self
) -> ListJournalKinesisStreamsForLedger

Constructs a fluent builder for the ListJournalKinesisStreamsForLedger operation. This operation supports pagination; See into_paginator().

• The fluent builder is configurable:
  • ledger_name(impl Into<String>) / set_ledger_name(Option<String>):

    The name of the ledger.

  • max_results(i32) / set_max_results(Option<i32>):

    The maximum number of results to return in a single ListJournalKinesisStreamsForLedger request. (The actual number of results returned might be fewer.)

  • next_token(impl Into<String>) / set_next_token(Option<String>):

    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.

• On success, responds with ListJournalKinesisStreamsForLedgerOutput with field(s):
  • streams(Option<Vec<JournalKinesisStreamDescription>>):

    The array of QLDB journal stream descriptors that are associated with the given ledger.

  • next_token(Option<String>):

    • 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.

• On failure, responds with SdkError<ListJournalKinesisStreamsForLedgerError>

pub fn list_journal_s3_exports(&self) -> ListJournalS3Exports

Constructs a fluent builder for the ListJournalS3Exports operation. This operation supports pagination; See into_paginator().

• The fluent builder is configurable:
  • max_results(i32) / set_max_results(Option<i32>):

    The maximum number of results to return in a single ListJournalS3Exports request. (The actual number of results returned might be fewer.)

  • next_token(impl Into<String>) / set_next_token(Option<String>):

    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.

• On success, responds with ListJournalS3ExportsOutput with field(s):
  • journal_s3_exports(Option<Vec<JournalS3ExportDescription>>):

    The array of journal export job descriptions for all ledgers that are associated with the current Amazon Web Services account and Region.

  • next_token(Option<String>):

    • 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.

• On failure, responds with SdkError<ListJournalS3ExportsError>

pub fn list_journal_s3_exports_for_ledger(
    &self
) -> ListJournalS3ExportsForLedger

Constructs a fluent builder for the ListJournalS3ExportsForLedger operation. This operation supports pagination; See into_paginator().

• The fluent builder is configurable:
  • name(impl Into<String>) / set_name(Option<String>):

    The name of the ledger.

  • max_results(i32) / set_max_results(Option<i32>):

    The maximum number of results to return in a single ListJournalS3ExportsForLedger request. (The actual number of results returned might be fewer.)

  • next_token(impl Into<String>) / set_next_token(Option<String>):

    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.

• On success, responds with ListJournalS3ExportsForLedgerOutput with field(s):
  • journal_s3_exports(Option<Vec<JournalS3ExportDescription>>):

    The array of journal export job descriptions that are associated with the specified ledger.

  • next_token(Option<String>):

    • 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.

• On failure, responds with SdkError<ListJournalS3ExportsForLedgerError>

pub fn list_ledgers(&self) -> ListLedgers

Constructs a fluent builder for the ListLedgers operation. This operation supports pagination; See into_paginator().

• The fluent builder is configurable:
  • max_results(i32) / set_max_results(Option<i32>):

    The maximum number of results to return in a single ListLedgers request. (The actual number of results returned might be fewer.)

  • next_token(impl Into<String>) / set_next_token(Option<String>):

    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.

• On success, responds with ListLedgersOutput with field(s):
  • ledgers(Option<Vec<LedgerSummary>>):

    The array of ledger summaries that are associated with the current Amazon Web Services account and Region.

  • next_token(Option<String>):

    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.

• On failure, responds with SdkError<ListLedgersError>

pub fn list_tags_for_resource(&self) -> ListTagsForResource

Constructs a fluent builder for the ListTagsForResource operation.

• The fluent builder is configurable:
  • resource_arn(impl Into<String>) / set_resource_arn(Option<String>):

    The Amazon Resource Name (ARN) for which to list the tags. For example:

    arn:aws:qldb:us-east-1:123456789012:ledger/exampleLedger

• On success, responds with ListTagsForResourceOutput with field(s):
  • tags(Option<HashMap<String, Option<String>>>):

    The tags that are currently associated with the specified Amazon QLDB resource.

• On failure, responds with SdkError<ListTagsForResourceError>

pub fn stream_journal_to_kinesis(&self) -> StreamJournalToKinesis

Constructs a fluent builder for the StreamJournalToKinesis operation.

• The fluent builder is configurable:
  • ledger_name(impl Into<String>) / set_ledger_name(Option<String>):

    The name of the ledger.

  • role_arn(impl Into<String>) / set_role_arn(Option<String>):

    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.

    To pass a role to QLDB when requesting a journal stream, you must have permissions to perform the iam:PassRole action on the IAM role resource. This is required for all journal stream requests.

  • tags(HashMap<String, Option<String>>) / set_tags(Option<HashMap<String, Option<String>>>):

    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.

  • inclusive_start_time(DateTime) / set_inclusive_start_time(Option<DateTime>):

    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.

  • exclusive_end_time(DateTime) / set_exclusive_end_time(Option<DateTime>):

    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.

  • kinesis_configuration(KinesisConfiguration) / set_kinesis_configuration(Option<KinesisConfiguration>):

    The configuration settings of the Kinesis Data Streams destination for your stream request.

  • stream_name(impl Into<String>) / set_stream_name(Option<String>):

    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.

• On success, responds with StreamJournalToKinesisOutput with field(s):
  • stream_id(Option<String>):

    The UUID (represented in Base62-encoded text) that QLDB assigns to each QLDB journal stream.

• On failure, responds with SdkError<StreamJournalToKinesisError>

pub fn tag_resource(&self) -> TagResource

Constructs a fluent builder for the TagResource operation.

• The fluent builder is configurable:
  • resource_arn(impl Into<String>) / set_resource_arn(Option<String>):

    The Amazon Resource Name (ARN) to which you want to add the tags. For example:

    arn:aws:qldb:us-east-1:123456789012:ledger/exampleLedger

  • tags(HashMap<String, Option<String>>) / set_tags(Option<HashMap<String, Option<String>>>):

    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.

• On success, responds with TagResourceOutput
• On failure, responds with SdkError<TagResourceError>

pub fn untag_resource(&self) -> UntagResource

Constructs a fluent builder for the UntagResource operation.

• The fluent builder is configurable:
  • resource_arn(impl Into<String>) / set_resource_arn(Option<String>):

    The Amazon Resource Name (ARN) from which to remove the tags. For example:

    arn:aws:qldb:us-east-1:123456789012:ledger/exampleLedger

  • tag_keys(Vec<String>) / set_tag_keys(Option<Vec<String>>):

    The list of tag keys to remove.

• On success, responds with UntagResourceOutput
• On failure, responds with SdkError<UntagResourceError>

pub fn update_ledger(&self) -> UpdateLedger

Constructs a fluent builder for the UpdateLedger operation.

• The fluent builder is configurable:
  • name(impl Into<String>) / set_name(Option<String>):

    The name of the ledger.

  • deletion_protection(bool) / set_deletion_protection(Option<bool>):

    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.

  • kms_key(impl Into<String>) / set_kms_key(Option<String>):

    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 Amazon Web Services 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.

• On success, responds with UpdateLedgerOutput with field(s):
  • name(Option<String>):

    The name of the ledger.

  • arn(Option<String>):

    The Amazon Resource Name (ARN) for the ledger.

  • state(Option<LedgerState>):

    The current status of the ledger.

  • creation_date_time(Option<DateTime>):

    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.)

  • deletion_protection(Option<bool>):

    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.

  • encryption_description(Option<LedgerEncryptionDescription>):

    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).

• On failure, responds with SdkError<UpdateLedgerError>

pub fn update_ledger_permissions_mode(&self) -> UpdateLedgerPermissionsMode

Constructs a fluent builder for the UpdateLedgerPermissionsMode operation.

• The fluent builder is configurable:
  • name(impl Into<String>) / set_name(Option<String>):

    The name of the ledger.

  • permissions_mode(PermissionsMode) / set_permissions_mode(Option<PermissionsMode>):

    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.

• On success, responds with UpdateLedgerPermissionsModeOutput with field(s):
  • name(Option<String>):

    The name of the ledger.

  • arn(Option<String>):

    The Amazon Resource Name (ARN) for the ledger.

  • permissions_mode(Option<PermissionsMode>):

    The current permissions mode of the ledger.

• On failure, responds with SdkError<UpdateLedgerPermissionsModeError>

impl Client

pub fn from_conf_conn<C, E>(conf: Config, conn: C) -> Self where
    C: SmithyConnector<Error = E> + Send + 'static,
    E: Into<ConnectorError>, 

Creates a client with the given service config and connector override.

pub fn new(sdk_config: &SdkConfig) -> Self

Creates a new client from a shared config.

pub fn from_conf(conf: Config) -> Self

Creates a new client from the service Config.

Trait Implementations

impl Clone for Client

fn clone(&self) -> Self

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for Client

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl From<Client<DynConnector, DynMiddleware<DynConnector>, Standard>> for Client

fn from(client: Client<DynConnector, DynMiddleware<DynConnector>>) -> Self

Converts to this type from the input type.