aws_dbesdk_dynamodb.smithygenerated.aws_cryptography_dbencryptionsdk_dynamodb.models

Classes

`AsSet`()	Attribute must be a Set.
`BeaconKeySourceMulti`(value)	The configuration for using multiple Beacon Keys.
`BeaconKeySourceSingle`(value)	The configuration for using a single Beacon Key.
`BeaconKeySourceUnknown`(tag)	Represents an unknown variant.
`BeaconStyleAsSet`(value)	Attribute must be a Set.
`BeaconStylePartOnly`(value)	Attribute must be used as part of a Compound Beacon, never alone.
`BeaconStyleShared`(value)	This beacon should calculate values like another beacon, so they can be compared.
`BeaconStyleSharedSet`(value)	Both Shared and AsSet.
`BeaconStyleUnknown`(tag)	Represents an unknown variant.
`BeaconVersion`(*, key_store, key_source, ...)	The configuration for a particular version of searchable encryption.
`CompoundBeacon`(*, name, split[, encrypted, ...])	The configuration for a Compound Beacon.
`Constructor`(*, parts)	The configuration for a particular Compound Beacon construction.
`ConstructorPart`(*, name, required)	A part of a Compound Becaon Construction.
`CreateDynamoDbEncryptionBranchKeyIdSupplierInput`(*, ...)	Inputs for creating a Branch Key Supplier from a DynamoDB Key Branch Key Id Supplier.
`CreateDynamoDbEncryptionBranchKeyIdSupplierOutput`(*, ...)	Outputs for creating a Branch Key Supplier from a DynamoDB Key Branch Key Id Supplier.
`DynamoDbTableEncryptionConfig`(*, ...[, ...])	The configuration for client-side encryption for a particular DynamoDB table.
`DynamoDbTablesEncryptionConfig`(*, ...)	The configuration for client-side encryption with multiple DynamoDB table.
`EncryptedDataKeyDescription`(*, key_provider_id)
`EncryptedPart`(*, name, prefix)	A part of a Compound Beacon that contains a beacon over encrypted data.
`GetBranchKeyIdFromDdbKeyInput`(*, ddb_key)	Inputs for getting the Branch Key that should be used for wrapping and unwrapping data keys.
`GetBranchKeyIdFromDdbKeyOutput`(*, branch_key_id)	Outputs for getting the Branch Key that should be used for wrapping and unwrapping data keys.
`GetEncryptedDataKeyDescriptionInput`(*, input)	Input for getting encrypted data key description.
`GetEncryptedDataKeyDescriptionOutput`(*, ...)	Output for getting encrypted data key description.
`GetEncryptedDataKeyDescriptionUnionHeader`(value)	A binary header value.
`GetEncryptedDataKeyDescriptionUnionItem`(value)	A DynamoDB item.
`GetEncryptedDataKeyDescriptionUnionUnknown`(tag)	Represents an unknown variant.
`GetPrefix`(*, length)	The Virtual Part Transformation that gets the prefix of a string.
`GetSegment`(*, split, index)	The Virtual Part Transformation that splits a string and gets a particular segment of that split.
`GetSegments`(*, split, low, high)	The Virtual Part Transformation that splits a string and gets a range of segments of that split.
`GetSubstring`(*, low, high)	The Virtual Part Transformation that gets a substring from a string.
`GetSuffix`(*, length)	The Virtual Part Transformation that gets the suffix of a string.
`Insert`(*, literal)	The Virtual Part Transformation that appends a literal string.
`LegacyOverride`(*, policy, encryptor, ...[, ...])	A configuration for overriding encryption and/or decryption to instead perform legacy encryption and decryption.
`LegacyPolicy`()
`Lower`()	The Virtual Part Transformation that converts ASCII characters to lower case.
`MultiKeyStore`(*, key_field_name, cache_ttl)	The configuration for using multiple Beacon Keys.
`PartOnly`()	Attribute must be used as part of a Compound Beacon, never alone.
`PlaintextOverride`()
`SearchConfig`(*, versions[, write_version])	The configuration for searchable encryption.
`Shared`(*, other)	This beacon should calculate values like another beacon, so they can be compared.
`SharedSet`(*, other)	Both Shared and AsSet.
`SignedPart`(*, name, prefix[, loc])	A part of a Compound Beacon that contains signed plaintext data.
`SingleKeyStore`(*, key_id, cache_ttl[, ...])	The configuration for using a single Beacon Key.
`StandardBeacon`(*, name[, length, loc, style])	The configuration for a Standard Beacon.
`Unit`()
`Upper`()	The Virtual Part Transformation that converts ASCII characters to upper case.
`VirtualField`(*, name, parts)	The configuration for a Virtual Field.
`VirtualPart`(*, loc[, trans])	A Virtual Part is the configuration of a transformation on an existing field in an item.
`VirtualTransformInsert`(value)	The Virtual Part Transformation that appends a literal string.
`VirtualTransformLower`(value)	The Virtual Part Transformation that converts ASCII characters to lower case.
`VirtualTransformPrefix`(value)	The Virtual Part Transformation that gets the prefix of a string.
`VirtualTransformSegment`(value)	The Virtual Part Transformation that splits a string and gets a particular segment of that split.
`VirtualTransformSegments`(value)	The Virtual Part Transformation that splits a string and gets a range of segments of that split.
`VirtualTransformSubstring`(value)	The Virtual Part Transformation that gets a substring from a string.
`VirtualTransformSuffix`(value)	The Virtual Part Transformation that gets the suffix of a string.
`VirtualTransformUnknown`(tag)	Represents an unknown variant.
`VirtualTransformUpper`(value)	The Virtual Part Transformation that converts ASCII characters to upper case.

class aws_dbesdk_dynamodb.smithygenerated.aws_cryptography_dbencryptionsdk_dynamodb.models.CreateDynamoDbEncryptionBranchKeyIdSupplierInput(*, ddb_key_branch_key_id_supplier: DynamoDbKeyBranchKeyIdSupplier)

Bases: object

Inputs for creating a Branch Key Supplier from a DynamoDB Key Branch Key Id Supplier.

Parameters:: ddb_key_branch_key_id_supplier – An implementation of the DynamoDbKeyBranchKeyIdSupplier interface, which determines what Branch Key to use for data key wrapping/unwrapping based on the DynamoDB item being written/read.

__init__(*, ddb_key_branch_key_id_supplier: DynamoDbKeyBranchKeyIdSupplier)

Inputs for creating a Branch Key Supplier from a DynamoDB Key Branch Key Id Supplier.

Parameters:: ddb_key_branch_key_id_supplier – An implementation of the DynamoDbKeyBranchKeyIdSupplier interface, which determines what Branch Key to use for data key wrapping/unwrapping based on the DynamoDB item being written/read.

ddb_key_branch_key_id_supplier: DynamoDbKeyBranchKeyIdSupplier

as_dict() → Dict[str, Any]: Converts the CreateDynamoDbEncryptionBranchKeyIdSupplierInput to a dictionary.

static from_dict(d: Dict[str, Any]) → CreateDynamoDbEncryptionBranchKeyIdSupplierInput: Creates a CreateDynamoDbEncryptionBranchKeyIdSupplierInput from a dictionary.

class aws_dbesdk_dynamodb.smithygenerated.aws_cryptography_dbencryptionsdk_dynamodb.models.CreateDynamoDbEncryptionBranchKeyIdSupplierOutput(*, branch_key_id_supplier: BranchKeyIdSupplier)

Bases: object

Outputs for creating a Branch Key Supplier from a DynamoDB Key Branch Key Id Supplier.

Parameters:: branch_key_id_supplier – The Branch Key Supplier for use with the Hierarchical Keyring.

__init__(*, branch_key_id_supplier: BranchKeyIdSupplier)

Outputs for creating a Branch Key Supplier from a DynamoDB Key Branch Key Id Supplier.

Parameters:: branch_key_id_supplier – The Branch Key Supplier for use with the Hierarchical Keyring.

branch_key_id_supplier: BranchKeyIdSupplier

as_dict() → Dict[str, Any]: Converts the CreateDynamoDbEncryptionBranchKeyIdSupplierOutput to a dictionary.

static from_dict(d: Dict[str, Any]) → CreateDynamoDbEncryptionBranchKeyIdSupplierOutput: Creates a CreateDynamoDbEncryptionBranchKeyIdSupplierOutput from a dictionary.

class aws_dbesdk_dynamodb.smithygenerated.aws_cryptography_dbencryptionsdk_dynamodb.models.GetBranchKeyIdFromDdbKeyOutput(*, branch_key_id: str)

Bases: object

Outputs for getting the Branch Key that should be used for wrapping and unwrapping data keys.

Parameters:: branch_key_id – The ID of the Branch Key that should be used to wrap and unwrap data keys for this item.

__init__(*, branch_key_id: str)

Outputs for getting the Branch Key that should be used for wrapping and unwrapping data keys.

Parameters:: branch_key_id – The ID of the Branch Key that should be used to wrap and unwrap data keys for this item.

branch_key_id: str

as_dict() → Dict[str, Any]: Converts the GetBranchKeyIdFromDdbKeyOutput to a dictionary.

static from_dict(d: Dict[str, Any]) → GetBranchKeyIdFromDdbKeyOutput: Creates a GetBranchKeyIdFromDdbKeyOutput from a dictionary.

class aws_dbesdk_dynamodb.smithygenerated.aws_cryptography_dbencryptionsdk_dynamodb.models.EncryptedDataKeyDescription(*, key_provider_id: str, key_provider_info: str | None = None, branch_key_id: str | None = None, branch_key_version: str | None = None)

Bases: object

Parameters:

key_provider_id – Key provider id of the encrypted data key.
key_provider_info – Key provider information of the encrypted data key.
branch_key_id – Branch key id of the encrypted data key.
branch_key_version – Branch key version of the encrypted data key.

__init__(*, key_provider_id: str, key_provider_info: str | None = None, branch_key_id: str | None = None, branch_key_version: str | None = None)

Parameters:

key_provider_id – Key provider id of the encrypted data key.
key_provider_info – Key provider information of the encrypted data key.
branch_key_id – Branch key id of the encrypted data key.
branch_key_version – Branch key version of the encrypted data key.

key_provider_id: str

key_provider_info: str | None

branch_key_id: str | None

branch_key_version: str | None

as_dict() → Dict[str, Any]: Converts the EncryptedDataKeyDescription to a dictionary.

static from_dict(d: Dict[str, Any]) → EncryptedDataKeyDescription: Creates a EncryptedDataKeyDescription from a dictionary.

class aws_dbesdk_dynamodb.smithygenerated.aws_cryptography_dbencryptionsdk_dynamodb.models.GetEncryptedDataKeyDescriptionOutput(*, encrypted_data_key_description_output: list[EncryptedDataKeyDescription])

Bases: object

Output for getting encrypted data key description.

Parameters:: encrypted_data_key_description_output – A list of encrypted data key description.

__init__(*, encrypted_data_key_description_output: list[EncryptedDataKeyDescription])

Output for getting encrypted data key description.

Parameters:: encrypted_data_key_description_output – A list of encrypted data key description.

encrypted_data_key_description_output: list[EncryptedDataKeyDescription]

as_dict() → Dict[str, Any]: Converts the GetEncryptedDataKeyDescriptionOutput to a dictionary.

static from_dict(d: Dict[str, Any]) → GetEncryptedDataKeyDescriptionOutput: Creates a GetEncryptedDataKeyDescriptionOutput from a dictionary.

class aws_dbesdk_dynamodb.smithygenerated.aws_cryptography_dbencryptionsdk_dynamodb.models.GetBranchKeyIdFromDdbKeyInput(*, ddb_key: dict[str, dict[str, Any]])

Bases: object

Inputs for getting the Branch Key that should be used for wrapping and unwrapping data keys.

Parameters:: ddb_key – The partition and sort (if it exists) attributes on the item being read or written, along with the values of any attributes configured as SIGN_AND_INCLUDE_IN_ENCRYPTION_CONTEXT.

__init__(*, ddb_key: dict[str, dict[str, Any]])

Inputs for getting the Branch Key that should be used for wrapping and unwrapping data keys.

Parameters:: ddb_key – The partition and sort (if it exists) attributes on the item being read or written, along with the values of any attributes configured as SIGN_AND_INCLUDE_IN_ENCRYPTION_CONTEXT.

ddb_key: dict[str, dict[str, Any]]

as_dict() → Dict[str, Any]: Converts the GetBranchKeyIdFromDdbKeyInput to a dictionary.

static from_dict(d: Dict[str, Any]) → GetBranchKeyIdFromDdbKeyInput: Creates a GetBranchKeyIdFromDdbKeyInput from a dictionary.

class aws_dbesdk_dynamodb.smithygenerated.aws_cryptography_dbencryptionsdk_dynamodb.models.GetEncryptedDataKeyDescriptionUnionHeader(value: bytes | bytearray)

Bases: object

A binary header value.

__init__(value: bytes | bytearray)

as_dict() → Dict[str, Any]

static from_dict(d: Dict[str, Any]) → GetEncryptedDataKeyDescriptionUnionHeader

class aws_dbesdk_dynamodb.smithygenerated.aws_cryptography_dbencryptionsdk_dynamodb.models.GetEncryptedDataKeyDescriptionUnionItem(value: dict[str, dict[str, Any]])

Bases: object

A DynamoDB item.

__init__(value: dict[str, dict[str, Any]])

as_dict() → Dict[str, Any]

static from_dict(d: Dict[str, Any]) → GetEncryptedDataKeyDescriptionUnionItem

class aws_dbesdk_dynamodb.smithygenerated.aws_cryptography_dbencryptionsdk_dynamodb.models.GetEncryptedDataKeyDescriptionUnionUnknown(tag: str)

Bases: object

Represents an unknown variant.

If you receive this value, you will need to update your library to receive the parsed value.

This value may not be deliberately sent.

__init__(tag: str)

as_dict() → Dict[str, Any]

static from_dict(d: Dict[str, Any]) → GetEncryptedDataKeyDescriptionUnionUnknown

class aws_dbesdk_dynamodb.smithygenerated.aws_cryptography_dbencryptionsdk_dynamodb.models.GetEncryptedDataKeyDescriptionInput(*, input: GetEncryptedDataKeyDescriptionUnionHeader | GetEncryptedDataKeyDescriptionUnionItem | GetEncryptedDataKeyDescriptionUnionUnknown)

Bases: object

Input for getting encrypted data key description.

__init__(*, input: GetEncryptedDataKeyDescriptionUnionHeader | GetEncryptedDataKeyDescriptionUnionItem | GetEncryptedDataKeyDescriptionUnionUnknown): Input for getting encrypted data key description.

input: GetEncryptedDataKeyDescriptionUnionHeader | GetEncryptedDataKeyDescriptionUnionItem | GetEncryptedDataKeyDescriptionUnionUnknown

as_dict() → Dict[str, Any]: Converts the GetEncryptedDataKeyDescriptionInput to a dictionary.

static from_dict(d: Dict[str, Any]) → GetEncryptedDataKeyDescriptionInput: Creates a GetEncryptedDataKeyDescriptionInput from a dictionary.

class aws_dbesdk_dynamodb.smithygenerated.aws_cryptography_dbencryptionsdk_dynamodb.models.AsSet

Bases: object

Attribute must be a Set.

Beacon value will also be a Set.

as_dict() → Dict[str, Any]: Converts the AsSet to a dictionary.

static from_dict(d: Dict[str, Any]) → AsSet: Creates a AsSet from a dictionary.

Bases: object

The configuration for using multiple Beacon Keys.

Parameters:

key_field_name – The name of the field that stores the Beacon Key. This may be a Virtual Field.
cache_ttl – How long (in seconds) the beacon key material is cached locally before it is re-retrieved from DynamoDB and re-authed with AWS KMS.
cache – Which type of local cache to use.
partition_id – Partition ID to distinguish Beacon Key Sources writing to a Shared cache. If the Partition ID is the same for two Beacon Key Sources, they can share the same cache entries in the Shared cache.

The configuration for using multiple Beacon Keys.

Parameters:

key_field_name – The name of the field that stores the Beacon Key. This may be a Virtual Field.
cache_ttl – How long (in seconds) the beacon key material is cached locally before it is re-retrieved from DynamoDB and re-authed with AWS KMS.
cache – Which type of local cache to use.
partition_id – Partition ID to distinguish Beacon Key Sources writing to a Shared cache. If the Partition ID is the same for two Beacon Key Sources, they can share the same cache entries in the Shared cache.

key_field_name: str

cache_ttl: int

cache: CacheTypeDefault | CacheTypeNo | CacheTypeSingleThreaded | CacheTypeMultiThreaded | CacheTypeStormTracking | CacheTypeShared | CacheTypeUnknown | None

partition_id: str | None

as_dict() → Dict[str, Any]: Converts the MultiKeyStore to a dictionary.

static from_dict(d: Dict[str, Any]) → MultiKeyStore: Creates a MultiKeyStore from a dictionary.

Bases: object

The configuration for using a single Beacon Key.

Parameters:

key_id – The Beacon Key ID.
cache_ttl – How long (in seconds) the beacon key material is cached

locally before it is re-retrieved from DynamoDB and re-authed with AWS KMS. :param cache: Which type of local cache to use. Please see the [spec](https://github.com/aws/aws-database-encryption-sdk-dynamodb/blob/main/specification/searchable-encryption/search-config.md#key-store-cache) on how to provide a cache for a SingleKeyStore. :param partition_id: Partition ID to distinguish Beacon Key Sources writing to a Shared cache. If the Partition ID is the same for two Beacon Key Sources, they can share the same cache entries in the Shared cache.

The configuration for using a single Beacon Key.

Parameters:

key_id – The Beacon Key ID.
cache_ttl – How long (in seconds) the beacon key material is cached

locally before it is re-retrieved from DynamoDB and re-authed with AWS KMS. :param cache: Which type of local cache to use. Please see the [spec](https://github.com/aws/aws-database-encryption-sdk-dynamodb/blob/main/specification/searchable-encryption/search-config.md#key-store-cache) on how to provide a cache for a SingleKeyStore. :param partition_id: Partition ID to distinguish Beacon Key Sources writing to a Shared cache. If the Partition ID is the same for two Beacon Key Sources, they can share the same cache entries in the Shared cache.

key_id: str

cache_ttl: int

cache: CacheTypeDefault | CacheTypeNo | CacheTypeSingleThreaded | CacheTypeMultiThreaded | CacheTypeStormTracking | CacheTypeShared | CacheTypeUnknown | None

partition_id: str | None

as_dict() → Dict[str, Any]: Converts the SingleKeyStore to a dictionary.

static from_dict(d: Dict[str, Any]) → SingleKeyStore: Creates a SingleKeyStore from a dictionary.

class aws_dbesdk_dynamodb.smithygenerated.aws_cryptography_dbencryptionsdk_dynamodb.models.BeaconKeySourceSingle(value: SingleKeyStore)

Bases: object

The configuration for using a single Beacon Key.

__init__(value: SingleKeyStore)

as_dict() → Dict[str, Any]

static from_dict(d: Dict[str, Any]) → BeaconKeySourceSingle

class aws_dbesdk_dynamodb.smithygenerated.aws_cryptography_dbencryptionsdk_dynamodb.models.BeaconKeySourceMulti(value: MultiKeyStore)

Bases: object

The configuration for using multiple Beacon Keys.

__init__(value: MultiKeyStore)

as_dict() → Dict[str, Any]

static from_dict(d: Dict[str, Any]) → BeaconKeySourceMulti

class aws_dbesdk_dynamodb.smithygenerated.aws_cryptography_dbencryptionsdk_dynamodb.models.BeaconKeySourceUnknown(tag: str)

Bases: object

Represents an unknown variant.

If you receive this value, you will need to update your library to receive the parsed value.

This value may not be deliberately sent.

__init__(tag: str)

as_dict() → Dict[str, Any]

static from_dict(d: Dict[str, Any]) → BeaconKeySourceUnknown

class aws_dbesdk_dynamodb.smithygenerated.aws_cryptography_dbencryptionsdk_dynamodb.models.PartOnly

Bases: object

Attribute must be used as part of a Compound Beacon, never alone.

as_dict() → Dict[str, Any]: Converts the PartOnly to a dictionary.

static from_dict(d: Dict[str, Any]) → PartOnly: Creates a PartOnly from a dictionary.

class aws_dbesdk_dynamodb.smithygenerated.aws_cryptography_dbencryptionsdk_dynamodb.models.Shared(*, other: str)

Bases: object

This beacon should calculate values like another beacon, so they can be compared.

Parameters:: other – Calculate beacon values as for this beacon.

__init__(*, other: str)

This beacon should calculate values like another beacon, so they can be compared.

Parameters:: other – Calculate beacon values as for this beacon.

other: str

as_dict() → Dict[str, Any]: Converts the Shared to a dictionary.

static from_dict(d: Dict[str, Any]) → Shared: Creates a Shared from a dictionary.

class aws_dbesdk_dynamodb.smithygenerated.aws_cryptography_dbencryptionsdk_dynamodb.models.SharedSet(*, other: str)

Bases: object

Both Shared and AsSet.

Parameters:: other – Calculate beacon values as for this beacon.

__init__(*, other: str)

Both Shared and AsSet.

Parameters:: other – Calculate beacon values as for this beacon.

other: str

as_dict() → Dict[str, Any]: Converts the SharedSet to a dictionary.

static from_dict(d: Dict[str, Any]) → SharedSet: Creates a SharedSet from a dictionary.

class aws_dbesdk_dynamodb.smithygenerated.aws_cryptography_dbencryptionsdk_dynamodb.models.BeaconStylePartOnly(value: PartOnly)

Bases: object

Attribute must be used as part of a Compound Beacon, never alone.

__init__(value: PartOnly)

as_dict() → Dict[str, Any]

static from_dict(d: Dict[str, Any]) → BeaconStylePartOnly

class aws_dbesdk_dynamodb.smithygenerated.aws_cryptography_dbencryptionsdk_dynamodb.models.BeaconStyleShared(value: Shared)

Bases: object

This beacon should calculate values like another beacon, so they can be compared.

__init__(value: Shared)

as_dict() → Dict[str, Any]

static from_dict(d: Dict[str, Any]) → BeaconStyleShared

class aws_dbesdk_dynamodb.smithygenerated.aws_cryptography_dbencryptionsdk_dynamodb.models.BeaconStyleAsSet(value: AsSet)

Bases: object

Attribute must be a Set.

Beacon value will also be a Set.

__init__(value: AsSet)

as_dict() → Dict[str, Any]

static from_dict(d: Dict[str, Any]) → BeaconStyleAsSet

class aws_dbesdk_dynamodb.smithygenerated.aws_cryptography_dbencryptionsdk_dynamodb.models.BeaconStyleSharedSet(value: SharedSet)

Bases: object

Both Shared and AsSet.

__init__(value: SharedSet)

as_dict() → Dict[str, Any]

static from_dict(d: Dict[str, Any]) → BeaconStyleSharedSet

class aws_dbesdk_dynamodb.smithygenerated.aws_cryptography_dbencryptionsdk_dynamodb.models.BeaconStyleUnknown(tag: str)

Bases: object

Represents an unknown variant.

If you receive this value, you will need to update your library to receive the parsed value.

This value may not be deliberately sent.

__init__(tag: str)

as_dict() → Dict[str, Any]

static from_dict(d: Dict[str, Any]) → BeaconStyleUnknown

class aws_dbesdk_dynamodb.smithygenerated.aws_cryptography_dbencryptionsdk_dynamodb.models.ConstructorPart(*, name: str, required: bool)

Bases: object

A part of a Compound Becaon Construction.

Parameters:

name – The name of the Encrypted Part or Signed Part for which this constructor part gets a value.
required – Whether this Encrypted Part or Signed Part is required for this construction to succeed.

__init__(*, name: str, required: bool)

A part of a Compound Becaon Construction.

Parameters:

name – The name of the Encrypted Part or Signed Part for which this constructor part gets a value.
required – Whether this Encrypted Part or Signed Part is required for this construction to succeed.

name: str

required: bool

as_dict() → Dict[str, Any]: Converts the ConstructorPart to a dictionary.

static from_dict(d: Dict[str, Any]) → ConstructorPart: Creates a ConstructorPart from a dictionary.

class aws_dbesdk_dynamodb.smithygenerated.aws_cryptography_dbencryptionsdk_dynamodb.models.Constructor(*, parts: list[ConstructorPart])

Bases: object

The configuration for a particular Compound Beacon construction.

Parameters:: parts – The ordered list of parts for a particular Compound Beacon construction. If the item contains all required Parts, a Compound beacon will be written using each Part that exists on the item, in the order specified.

__init__(*, parts: list[ConstructorPart])

The configuration for a particular Compound Beacon construction.

Parameters:: parts – The ordered list of parts for a particular Compound Beacon construction. If the item contains all required Parts, a Compound beacon will be written using each Part that exists on the item, in the order specified.

parts: list[ConstructorPart]

as_dict() → Dict[str, Any]: Converts the Constructor to a dictionary.

static from_dict(d: Dict[str, Any]) → Constructor: Creates a Constructor from a dictionary.

class aws_dbesdk_dynamodb.smithygenerated.aws_cryptography_dbencryptionsdk_dynamodb.models.EncryptedPart(*, name: str, prefix: str)

Bases: object

A part of a Compound Beacon that contains a beacon over encrypted data.

Parameters:

name – The name of the Standard Beacon, whose value this Part will hold.
prefix – The prefix that is written with this Encrypted Part.

__init__(*, name: str, prefix: str)

A part of a Compound Beacon that contains a beacon over encrypted data.

Parameters:

name – The name of the Standard Beacon, whose value this Part will hold.
prefix – The prefix that is written with this Encrypted Part.

name: str

prefix: str

as_dict() → Dict[str, Any]: Converts the EncryptedPart to a dictionary.

static from_dict(d: Dict[str, Any]) → EncryptedPart: Creates a EncryptedPart from a dictionary.

class aws_dbesdk_dynamodb.smithygenerated.aws_cryptography_dbencryptionsdk_dynamodb.models.SignedPart(*, name: str, prefix: str, loc: str | None = None)

Bases: object

A part of a Compound Beacon that contains signed plaintext data.

Parameters:

name – The name for this Signed Part.
prefix – The prefix that is written with this Signed Part.
loc – The DynamoDB document path to the value for this Signed Part. If not provided, the ‘name’ is used for the location.

__init__(*, name: str, prefix: str, loc: str | None = None)

A part of a Compound Beacon that contains signed plaintext data.

Parameters:

name – The name for this Signed Part.
prefix – The prefix that is written with this Signed Part.
loc – The DynamoDB document path to the value for this Signed Part. If not provided, the ‘name’ is used for the location.

name: str

prefix: str

loc: str | None

as_dict() → Dict[str, Any]: Converts the SignedPart to a dictionary.

static from_dict(d: Dict[str, Any]) → SignedPart: Creates a SignedPart from a dictionary.

class aws_dbesdk_dynamodb.smithygenerated.aws_cryptography_dbencryptionsdk_dynamodb.models.CompoundBeacon(*, name: str, split: str, encrypted: list[EncryptedPart] | None = None, signed: list[SignedPart] | None = None, constructors: list[Constructor] | None = None)

Bases: object

The configuration for a Compound Beacon.

Parameters:

name – The name of the Compound Beacon.
split – The characters used to split parts of a compound beacon. The split character should be a character that does not appear in any Signed Part or Prefix used by the Compound Beacon.
encrypted – The list of Encrypted Parts that may be included in the compound beacon.
signed – The list of Signed Parts that may be included in the compound beacon.
constructors – The ordered list of constructors that may be used to create the Compound Beacon. Each constructor is checked, in order, to see if it can construct the beacon. The first constructor that can construct the beacon is used. If no constructor can construct the beacon, the Compound Beacon is not written to the item.

__init__(*, name: str, split: str, encrypted: list[EncryptedPart] | None = None, signed: list[SignedPart] | None = None, constructors: list[Constructor] | None = None)

The configuration for a Compound Beacon.

Parameters:

name – The name of the Compound Beacon.
split – The characters used to split parts of a compound beacon. The split character should be a character that does not appear in any Signed Part or Prefix used by the Compound Beacon.
encrypted – The list of Encrypted Parts that may be included in the compound beacon.
signed – The list of Signed Parts that may be included in the compound beacon.
constructors – The ordered list of constructors that may be used to create the Compound Beacon. Each constructor is checked, in order, to see if it can construct the beacon. The first constructor that can construct the beacon is used. If no constructor can construct the beacon, the Compound Beacon is not written to the item.

name: str

split: str

encrypted: list[EncryptedPart] | None

signed: list[SignedPart] | None

constructors: list[Constructor] | None

as_dict() → Dict[str, Any]: Converts the CompoundBeacon to a dictionary.

static from_dict(d: Dict[str, Any]) → CompoundBeacon: Creates a CompoundBeacon from a dictionary.

Bases: object

The configuration for a Standard Beacon.

Parameters:

name – The name for this Standard Beacon.
length – The length of the calculated beacon.
loc – The DynamoDB document path to the value this beacon will calculate over. If not specified, the beacon will calculate values for the attribute with the name specified in ‘name’.
style – Optional augmented behavior.

The configuration for a Standard Beacon.

Parameters:

name – The name for this Standard Beacon.
length – The length of the calculated beacon.
loc – The DynamoDB document path to the value this beacon will calculate over. If not specified, the beacon will calculate values for the attribute with the name specified in ‘name’.
style – Optional augmented behavior.

name: str

length: int

loc: str | None

style: BeaconStylePartOnly | BeaconStyleShared | BeaconStyleAsSet | BeaconStyleSharedSet | BeaconStyleUnknown | None

as_dict() → Dict[str, Any]: Converts the StandardBeacon to a dictionary.

static from_dict(d: Dict[str, Any]) → StandardBeacon: Creates a StandardBeacon from a dictionary.

class aws_dbesdk_dynamodb.smithygenerated.aws_cryptography_dbencryptionsdk_dynamodb.models.Insert(*, literal: str)

Bases: object

The Virtual Part Transformation that appends a literal string.

Parameters:: literal – The literal string to append.

__init__(*, literal: str)

The Virtual Part Transformation that appends a literal string.

Parameters:: literal – The literal string to append.

literal: str

as_dict() → Dict[str, Any]: Converts the Insert to a dictionary.

static from_dict(d: Dict[str, Any]) → Insert: Creates a Insert from a dictionary.

class aws_dbesdk_dynamodb.smithygenerated.aws_cryptography_dbencryptionsdk_dynamodb.models.Lower

Bases: object

The Virtual Part Transformation that converts ASCII characters to lower case.

as_dict() → Dict[str, Any]: Converts the Lower to a dictionary.

static from_dict(d: Dict[str, Any]) → Lower: Creates a Lower from a dictionary.

class aws_dbesdk_dynamodb.smithygenerated.aws_cryptography_dbencryptionsdk_dynamodb.models.GetPrefix(*, length: int)

Bases: object

The Virtual Part Transformation that gets the prefix of a string.

Parameters:: length – If positive, the number of characters to return from the front. If negative, the absolute number of characters to exclude from the end. e.g. GetPrefix(-1) returns all but the last character.

__init__(*, length: int)

The Virtual Part Transformation that gets the prefix of a string.

Parameters:: length – If positive, the number of characters to return from the front. If negative, the absolute number of characters to exclude from the end. e.g. GetPrefix(-1) returns all but the last character.

length: int

as_dict() → Dict[str, Any]: Converts the GetPrefix to a dictionary.

static from_dict(d: Dict[str, Any]) → GetPrefix: Creates a GetPrefix from a dictionary.

class aws_dbesdk_dynamodb.smithygenerated.aws_cryptography_dbencryptionsdk_dynamodb.models.GetSegment(*, split: str, index: int)

Bases: object

The Virtual Part Transformation that splits a string and gets a particular segment of that split.

Parameters:

split – The characters to split on.
index – The index of the split string result to return. 0 represents the segment before the first split character. -1 respresents the segment after the last split character.

__init__(*, split: str, index: int)

The Virtual Part Transformation that splits a string and gets a particular segment of that split.

Parameters:

split – The characters to split on.
index – The index of the split string result to return. 0 represents the segment before the first split character. -1 respresents the segment after the last split character.

split: str

index: int

as_dict() → Dict[str, Any]: Converts the GetSegment to a dictionary.

static from_dict(d: Dict[str, Any]) → GetSegment: Creates a GetSegment from a dictionary.

class aws_dbesdk_dynamodb.smithygenerated.aws_cryptography_dbencryptionsdk_dynamodb.models.GetSegments(*, split: str, low: int, high: int)

Bases: object

The Virtual Part Transformation that splits a string and gets a range of segments of that split.

Parameters:

split – The characters to split on.
low – The index to start the segments from, inclusive. Negative numbers count from the end. -1 is the last segment.
high – The index to stop the segments at, exclusive. Negative numbers count from the end. -1 is the last segment.

__init__(*, split: str, low: int, high: int)

The Virtual Part Transformation that splits a string and gets a range of segments of that split.

Parameters:

split – The characters to split on.
low – The index to start the segments from, inclusive. Negative numbers count from the end. -1 is the last segment.
high – The index to stop the segments at, exclusive. Negative numbers count from the end. -1 is the last segment.

split: str

low: int

high: int

as_dict() → Dict[str, Any]: Converts the GetSegments to a dictionary.

static from_dict(d: Dict[str, Any]) → GetSegments: Creates a GetSegments from a dictionary.

class aws_dbesdk_dynamodb.smithygenerated.aws_cryptography_dbencryptionsdk_dynamodb.models.GetSubstring(*, low: int, high: int)

Bases: object

The Virtual Part Transformation that gets a substring from a string.

Parameters:

low – The index to start the substring from, inclusive. Negative numbers count from the end. -1 is the last character of a string.
high – The index to stop the substring at, exclusive. Negative numbers count from the end. -1 is the last character of a string.

__init__(*, low: int, high: int)

The Virtual Part Transformation that gets a substring from a string.

Parameters:

low – The index to start the substring from, inclusive. Negative numbers count from the end. -1 is the last character of a string.
high – The index to stop the substring at, exclusive. Negative numbers count from the end. -1 is the last character of a string.

low: int

high: int

as_dict() → Dict[str, Any]: Converts the GetSubstring to a dictionary.

static from_dict(d: Dict[str, Any]) → GetSubstring: Creates a GetSubstring from a dictionary.

class aws_dbesdk_dynamodb.smithygenerated.aws_cryptography_dbencryptionsdk_dynamodb.models.GetSuffix(*, length: int)

Bases: object

The Virtual Part Transformation that gets the suffix of a string.

Parameters:: length – If positive, the number of characters to return from the end. If negative, the absolute number of characters to exclude from the front. e.g. GetSuffix(-1) returns all but the first character.

__init__(*, length: int)

The Virtual Part Transformation that gets the suffix of a string.

Parameters:: length – If positive, the number of characters to return from the end. If negative, the absolute number of characters to exclude from the front. e.g. GetSuffix(-1) returns all but the first character.

length: int

as_dict() → Dict[str, Any]: Converts the GetSuffix to a dictionary.

static from_dict(d: Dict[str, Any]) → GetSuffix: Creates a GetSuffix from a dictionary.

class aws_dbesdk_dynamodb.smithygenerated.aws_cryptography_dbencryptionsdk_dynamodb.models.Upper

Bases: object

The Virtual Part Transformation that converts ASCII characters to upper case.

as_dict() → Dict[str, Any]: Converts the Upper to a dictionary.

static from_dict(d: Dict[str, Any]) → Upper: Creates a Upper from a dictionary.

class aws_dbesdk_dynamodb.smithygenerated.aws_cryptography_dbencryptionsdk_dynamodb.models.VirtualTransformUpper(value: Upper)

Bases: object

The Virtual Part Transformation that converts ASCII characters to upper case.

__init__(value: Upper)

as_dict() → Dict[str, Any]

static from_dict(d: Dict[str, Any]) → VirtualTransformUpper

class aws_dbesdk_dynamodb.smithygenerated.aws_cryptography_dbencryptionsdk_dynamodb.models.VirtualTransformLower(value: Lower)

Bases: object

The Virtual Part Transformation that converts ASCII characters to lower case.

__init__(value: Lower)

as_dict() → Dict[str, Any]

static from_dict(d: Dict[str, Any]) → VirtualTransformLower

class aws_dbesdk_dynamodb.smithygenerated.aws_cryptography_dbencryptionsdk_dynamodb.models.VirtualTransformInsert(value: Insert)

Bases: object

The Virtual Part Transformation that appends a literal string.

__init__(value: Insert)

as_dict() → Dict[str, Any]

static from_dict(d: Dict[str, Any]) → VirtualTransformInsert

class aws_dbesdk_dynamodb.smithygenerated.aws_cryptography_dbencryptionsdk_dynamodb.models.VirtualTransformPrefix(value: GetPrefix)

Bases: object

The Virtual Part Transformation that gets the prefix of a string.

__init__(value: GetPrefix)

as_dict() → Dict[str, Any]

static from_dict(d: Dict[str, Any]) → VirtualTransformPrefix

class aws_dbesdk_dynamodb.smithygenerated.aws_cryptography_dbencryptionsdk_dynamodb.models.VirtualTransformSuffix(value: GetSuffix)

Bases: object

The Virtual Part Transformation that gets the suffix of a string.

__init__(value: GetSuffix)

as_dict() → Dict[str, Any]

static from_dict(d: Dict[str, Any]) → VirtualTransformSuffix

class aws_dbesdk_dynamodb.smithygenerated.aws_cryptography_dbencryptionsdk_dynamodb.models.VirtualTransformSubstring(value: GetSubstring)

Bases: object

The Virtual Part Transformation that gets a substring from a string.

__init__(value: GetSubstring)

as_dict() → Dict[str, Any]

static from_dict(d: Dict[str, Any]) → VirtualTransformSubstring

class aws_dbesdk_dynamodb.smithygenerated.aws_cryptography_dbencryptionsdk_dynamodb.models.VirtualTransformSegment(value: GetSegment)

Bases: object

The Virtual Part Transformation that splits a string and gets a particular segment of that split.

__init__(value: GetSegment)

as_dict() → Dict[str, Any]

static from_dict(d: Dict[str, Any]) → VirtualTransformSegment

class aws_dbesdk_dynamodb.smithygenerated.aws_cryptography_dbencryptionsdk_dynamodb.models.VirtualTransformSegments(value: GetSegments)

Bases: object

The Virtual Part Transformation that splits a string and gets a range of segments of that split.

__init__(value: GetSegments)

as_dict() → Dict[str, Any]

static from_dict(d: Dict[str, Any]) → VirtualTransformSegments

class aws_dbesdk_dynamodb.smithygenerated.aws_cryptography_dbencryptionsdk_dynamodb.models.VirtualTransformUnknown(tag: str)

Bases: object

Represents an unknown variant.

If you receive this value, you will need to update your library to receive the parsed value.

This value may not be deliberately sent.

__init__(tag: str)

as_dict() → Dict[str, Any]

static from_dict(d: Dict[str, Any]) → VirtualTransformUnknown

Bases: object

A Virtual Part is the configuration of a transformation on an existing field in an item.

Parameters:

loc – The DynamoDB document path to the value for this part.
trans – A list of transformations performed on the value for this part.

A Virtual Part is the configuration of a transformation on an existing field in an item.

Parameters:

loc – The DynamoDB document path to the value for this part.
trans – A list of transformations performed on the value for this part.

loc: str

trans: list[VirtualTransformUpper | VirtualTransformLower | VirtualTransformInsert | VirtualTransformPrefix | VirtualTransformSuffix | VirtualTransformSubstring | VirtualTransformSegment | VirtualTransformSegments | VirtualTransformUnknown] | None

as_dict() → Dict[str, Any]: Converts the VirtualPart to a dictionary.

static from_dict(d: Dict[str, Any]) → VirtualPart: Creates a VirtualPart from a dictionary.

class aws_dbesdk_dynamodb.smithygenerated.aws_cryptography_dbencryptionsdk_dynamodb.models.VirtualField(*, name: str, parts: list[VirtualPart])

Bases: object

The configuration for a Virtual Field. A Virtual Field is a field constructed from parts of other fields for use with beacons, but never itself stored on items.

Parameters:

name – The name of the Virtual Field.
parts – The list of ordered parts that make up a Virtual Field.

__init__(*, name: str, parts: list[VirtualPart])

The configuration for a Virtual Field. A Virtual Field is a field constructed from parts of other fields for use with beacons, but never itself stored on items.

Parameters:

name – The name of the Virtual Field.
parts – The list of ordered parts that make up a Virtual Field.

name: str

parts: list[VirtualPart]

as_dict() → Dict[str, Any]: Converts the VirtualField to a dictionary.

static from_dict(d: Dict[str, Any]) → VirtualField: Creates a VirtualField from a dictionary.

class aws_dbesdk_dynamodb.smithygenerated.aws_cryptography_dbencryptionsdk_dynamodb.models.BeaconVersion(*, key_store: KeyStore, key_source: BeaconKeySourceSingle | BeaconKeySourceMulti | BeaconKeySourceUnknown, standard_beacons: list[StandardBeacon], version: int = 0, compound_beacons: list[CompoundBeacon] | None = None, virtual_fields: list[VirtualField] | None = None, encrypted_parts: list[EncryptedPart] | None = None, signed_parts: list[SignedPart] | None = None)

Bases: object

The configuration for a particular version of searchable encryption. Currently the only supported version is ‘1’.

Parameters:

key_store – The Key Store that contains the Beacon Keys to use with searchable encryption.
key_source – The configuration for what beacon key(s) to use.
standard_beacons – The Standard Beacons to be written with items.
version – The version of searchable encryption configured. This must be ‘1’.
compound_beacons – The Compound Beacons to be written with items.
virtual_fields – The Virtual Fields to be calculated, supporting other searchable enryption configurations.
encrypted_parts – The list of Encrypted Parts that may be included in any compound beacon.
signed_parts – The list of Signed Parts that may be included in any compound beacon.

__init__(*, key_store: KeyStore, key_source: BeaconKeySourceSingle | BeaconKeySourceMulti | BeaconKeySourceUnknown, standard_beacons: list[StandardBeacon], version: int = 0, compound_beacons: list[CompoundBeacon] | None = None, virtual_fields: list[VirtualField] | None = None, encrypted_parts: list[EncryptedPart] | None = None, signed_parts: list[SignedPart] | None = None)

The configuration for a particular version of searchable encryption. Currently the only supported version is ‘1’.

Parameters:

key_store – The Key Store that contains the Beacon Keys to use with searchable encryption.
key_source – The configuration for what beacon key(s) to use.
standard_beacons – The Standard Beacons to be written with items.
version – The version of searchable encryption configured. This must be ‘1’.
compound_beacons – The Compound Beacons to be written with items.
virtual_fields – The Virtual Fields to be calculated, supporting other searchable enryption configurations.
encrypted_parts – The list of Encrypted Parts that may be included in any compound beacon.
signed_parts – The list of Signed Parts that may be included in any compound beacon.

key_store: KeyStore

key_source: BeaconKeySourceSingle | BeaconKeySourceMulti | BeaconKeySourceUnknown

standard_beacons: list[StandardBeacon]

version: int

compound_beacons: list[CompoundBeacon] | None

virtual_fields: list[VirtualField] | None

encrypted_parts: list[EncryptedPart] | None

signed_parts: list[SignedPart] | None

as_dict() → Dict[str, Any]: Converts the BeaconVersion to a dictionary.

static from_dict(d: Dict[str, Any]) → BeaconVersion: Creates a BeaconVersion from a dictionary.

class aws_dbesdk_dynamodb.smithygenerated.aws_cryptography_dbencryptionsdk_dynamodb.models.LegacyPolicy

Bases: object

FORCE_LEGACY_ENCRYPT_ALLOW_LEGACY_DECRYPT = 'FORCE_LEGACY_ENCRYPT_ALLOW_LEGACY_DECRYPT'

FORBID_LEGACY_ENCRYPT_ALLOW_LEGACY_DECRYPT = 'FORBID_LEGACY_ENCRYPT_ALLOW_LEGACY_DECRYPT'

FORBID_LEGACY_ENCRYPT_FORBID_LEGACY_DECRYPT = 'FORBID_LEGACY_ENCRYPT_FORBID_LEGACY_DECRYPT'

values = frozenset({'FORBID_LEGACY_ENCRYPT_ALLOW_LEGACY_DECRYPT', 'FORBID_LEGACY_ENCRYPT_FORBID_LEGACY_DECRYPT', 'FORCE_LEGACY_ENCRYPT_ALLOW_LEGACY_DECRYPT'})

class aws_dbesdk_dynamodb.smithygenerated.aws_cryptography_dbencryptionsdk_dynamodb.models.LegacyOverride(*, policy: str, encryptor: LegacyDynamoDbEncryptor, attribute_actions_on_encrypt: dict[str, str], default_attribute_flag: str | None = None)

Bases: object

A configuration for overriding encryption and/or decryption to instead perform legacy encryption and decryption.

Parameters:

policy – A policy which configurates whether legacy behavior overrides encryption and/or decryption.
encryptor – A configuration for the legacy DynamoDB Encryption Client’s Encryptor.
attribute_actions_on_encrypt – Overrides which attributes are encrypted and/or signed for any items read or written with legacy behavior.
default_attribute_flag – This input is not used in the Java Client and should not be specified.

__init__(*, policy: str, encryptor: LegacyDynamoDbEncryptor, attribute_actions_on_encrypt: dict[str, str], default_attribute_flag: str | None = None)

A configuration for overriding encryption and/or decryption to instead perform legacy encryption and decryption.

Parameters:

policy – A policy which configurates whether legacy behavior overrides encryption and/or decryption.
encryptor – A configuration for the legacy DynamoDB Encryption Client’s Encryptor.
attribute_actions_on_encrypt – Overrides which attributes are encrypted and/or signed for any items read or written with legacy behavior.
default_attribute_flag – This input is not used in the Java Client and should not be specified.

policy: str

encryptor: LegacyDynamoDbEncryptor

attribute_actions_on_encrypt: dict[str, str]

default_attribute_flag: str | None

as_dict() → Dict[str, Any]: Converts the LegacyOverride to a dictionary.

static from_dict(d: Dict[str, Any]) → LegacyOverride: Creates a LegacyOverride from a dictionary.

class aws_dbesdk_dynamodb.smithygenerated.aws_cryptography_dbencryptionsdk_dynamodb.models.PlaintextOverride

Bases: object

FORCE_PLAINTEXT_WRITE_ALLOW_PLAINTEXT_READ = 'FORCE_PLAINTEXT_WRITE_ALLOW_PLAINTEXT_READ'

FORBID_PLAINTEXT_WRITE_ALLOW_PLAINTEXT_READ = 'FORBID_PLAINTEXT_WRITE_ALLOW_PLAINTEXT_READ'

FORBID_PLAINTEXT_WRITE_FORBID_PLAINTEXT_READ = 'FORBID_PLAINTEXT_WRITE_FORBID_PLAINTEXT_READ'

values = frozenset({'FORBID_PLAINTEXT_WRITE_ALLOW_PLAINTEXT_READ', 'FORBID_PLAINTEXT_WRITE_FORBID_PLAINTEXT_READ', 'FORCE_PLAINTEXT_WRITE_ALLOW_PLAINTEXT_READ'})

class aws_dbesdk_dynamodb.smithygenerated.aws_cryptography_dbencryptionsdk_dynamodb.models.SearchConfig(*, versions: list[BeaconVersion], write_version: int = 0)

Bases: object

The configuration for searchable encryption.

Parameters:

versions – The versions of searchable encryption to support reading. Currently must contain a single configuration with version ‘1’.
write_version – The searchable encryption version to use when writing new items. Must be ‘1’.

__init__(*, versions: list[BeaconVersion], write_version: int = 0)

The configuration for searchable encryption.

Parameters:

versions – The versions of searchable encryption to support reading. Currently must contain a single configuration with version ‘1’.
write_version – The searchable encryption version to use when writing new items. Must be ‘1’.

versions: list[BeaconVersion]

write_version: int

as_dict() → Dict[str, Any]: Converts the SearchConfig to a dictionary.

static from_dict(d: Dict[str, Any]) → SearchConfig: Creates a SearchConfig from a dictionary.

class aws_dbesdk_dynamodb.smithygenerated.aws_cryptography_dbencryptionsdk_dynamodb.models.DynamoDbTableEncryptionConfig(*, logical_table_name: str, partition_key_name: str, attribute_actions_on_encrypt: dict[str, str], sort_key_name: str | None = None, search: SearchConfig | None = None, allowed_unsigned_attributes: list[str] | None = None, allowed_unsigned_attribute_prefix: str | None = None, algorithm_suite_id: str | None = None, keyring: Keyring | None = None, cmm: CryptographicMaterialsManager | None = None, legacy_override: LegacyOverride | None = None, plaintext_override: str | None = None)

Bases: object

The configuration for client-side encryption for a particular DynamoDB table.

Parameters:

logical_table_name – The logical table name for this table. This is the name that is cryptographically bound with your data. This can be the same as the actual DynamoDB table name. It’s purpose is to be distinct from the DynamoDB table name so that the data may still be authenticated if being read from different (but logically similar) tables, such as a backup table.
partition_key_name – The name of the partition key on this table.
attribute_actions_on_encrypt – A map that describes what attributes should be encrypted and/or signed on encrypt. This map must contain all attributes that might be encountered during encryption.
sort_key_name – If this table contains a sort key, the name of the sort key on this table.
search – The configuration for searchable encryption.
allowed_unsigned_attributes – A list of attribute names such that, if encountered during decryption, those attributes are treated as unsigned.
allowed_unsigned_attribute_prefix – A prefix such that, if during decryption any attribute has a name with this prefix, it is treated as unsigned.
algorithm_suite_id – An ID for the algorithm suite to use during encryption and decryption.
keyring – The Keyring that should be used to wrap and unwrap data keys. If specified a Default Cryptographic Materials Manager with this Keyring is used to obtain materials for encryption and decryption. Either a Keyring or a Cryptographic Materials Manager must be specified.
cmm – The Cryptographic Materials Manager that is used to obtain materials for encryption and decryption. Either a Keyring or a Cryptographic Materials Manager must be specified.
legacy_override – A configuration that override encryption and/or decryption to instead perform legacy encryption and/or decryption. Used as part of migration from version 2.x to version 3.x.
plaintext_override – A configuration that override encryption and/or decryption to instead passthrough and write and/or read plaintext. Used to update plaintext tables to fully use client-side encryption.

__init__(*, logical_table_name: str, partition_key_name: str, attribute_actions_on_encrypt: dict[str, str], sort_key_name: str | None = None, search: SearchConfig | None = None, allowed_unsigned_attributes: list[str] | None = None, allowed_unsigned_attribute_prefix: str | None = None, algorithm_suite_id: str | None = None, keyring: Keyring | None = None, cmm: CryptographicMaterialsManager | None = None, legacy_override: LegacyOverride | None = None, plaintext_override: str | None = None)

The configuration for client-side encryption for a particular DynamoDB table.

Parameters:

logical_table_name – The logical table name for this table. This is the name that is cryptographically bound with your data. This can be the same as the actual DynamoDB table name. It’s purpose is to be distinct from the DynamoDB table name so that the data may still be authenticated if being read from different (but logically similar) tables, such as a backup table.
partition_key_name – The name of the partition key on this table.
attribute_actions_on_encrypt – A map that describes what attributes should be encrypted and/or signed on encrypt. This map must contain all attributes that might be encountered during encryption.
sort_key_name – If this table contains a sort key, the name of the sort key on this table.
search – The configuration for searchable encryption.
allowed_unsigned_attributes – A list of attribute names such that, if encountered during decryption, those attributes are treated as unsigned.
allowed_unsigned_attribute_prefix – A prefix such that, if during decryption any attribute has a name with this prefix, it is treated as unsigned.
algorithm_suite_id – An ID for the algorithm suite to use during encryption and decryption.
keyring – The Keyring that should be used to wrap and unwrap data keys. If specified a Default Cryptographic Materials Manager with this Keyring is used to obtain materials for encryption and decryption. Either a Keyring or a Cryptographic Materials Manager must be specified.
cmm – The Cryptographic Materials Manager that is used to obtain materials for encryption and decryption. Either a Keyring or a Cryptographic Materials Manager must be specified.
legacy_override – A configuration that override encryption and/or decryption to instead perform legacy encryption and/or decryption. Used as part of migration from version 2.x to version 3.x.
plaintext_override – A configuration that override encryption and/or decryption to instead passthrough and write and/or read plaintext. Used to update plaintext tables to fully use client-side encryption.

logical_table_name: str

partition_key_name: str

attribute_actions_on_encrypt: dict[str, str]

sort_key_name: str | None

search: SearchConfig | None

allowed_unsigned_attributes: list[str] | None

allowed_unsigned_attribute_prefix: str | None

algorithm_suite_id: str | None

keyring: Keyring | None

cmm: CryptographicMaterialsManager | None

legacy_override: LegacyOverride | None

plaintext_override: str | None

as_dict() → Dict[str, Any]: Converts the DynamoDbTableEncryptionConfig to a dictionary.

static from_dict(d: Dict[str, Any]) → DynamoDbTableEncryptionConfig: Creates a DynamoDbTableEncryptionConfig from a dictionary.

class aws_dbesdk_dynamodb.smithygenerated.aws_cryptography_dbencryptionsdk_dynamodb.models.DynamoDbTablesEncryptionConfig(*, table_encryption_configs: dict[str, DynamoDbTableEncryptionConfig])

Bases: object

The configuration for client-side encryption with multiple DynamoDB table.

Parameters:: table_encryption_configs – A map of DynamoDB table name to its configuration for client-side encryption.

__init__(*, table_encryption_configs: dict[str, DynamoDbTableEncryptionConfig])

The configuration for client-side encryption with multiple DynamoDB table.

Parameters:: table_encryption_configs – A map of DynamoDB table name to its configuration for client-side encryption.

table_encryption_configs: dict[str, DynamoDbTableEncryptionConfig]

as_dict() → Dict[str, Any]: Converts the DynamoDbTablesEncryptionConfig to a dictionary.

static from_dict(d: Dict[str, Any]) → DynamoDbTablesEncryptionConfig: Creates a DynamoDbTablesEncryptionConfig from a dictionary.

class aws_dbesdk_dynamodb.smithygenerated.aws_cryptography_dbencryptionsdk_dynamodb.models.Unit: Bases: object