aws_cryptographic_material_providers.smithygenerated.aws_cryptography_keystore.models

Classes

`BeaconKeyMaterials`(*, beacon_key_identifier, ...)
`BranchKeyMaterials`(*, branch_key_identifier, ...)
`CreateKeyInput`(*[, branch_key_identifier, ...])
`CreateKeyOutput`(*, branch_key_identifier)	Outputs for Branch Key creation.
`CreateKeyStoreInput`()
`CreateKeyStoreOutput`(*, table_arn)	Outputs for Key Store DynamoDB table creation.
`Discovery`()
`GetActiveBranchKeyInput`(*, branch_key_identifier)	Inputs for getting a Branch Key's ACTIVE version.
`GetActiveBranchKeyOutput`(*, branch_key_materials)	Outputs for getting a Branch Key's ACTIVE version.
`GetBeaconKeyInput`(*, branch_key_identifier)	Inputs for getting a Beacon Key.
`GetBeaconKeyOutput`(*, beacon_key_materials)	Outputs for getting a Beacon Key.
`GetBranchKeyVersionInput`(*, ...)	Inputs for getting a version of a Branch Key.
`GetBranchKeyVersionOutput`(*, ...)	Outputs for getting a version of a Branch Key.
`GetKeyStoreInfoOutput`(*, key_store_id, ...)	The configuration information for a Key Store.
`KMSConfigurationDiscovery`(value)	The Key Store can use the KMS Key ARNs already persisted in the Backing Table.
`KMSConfigurationKmsKeyArn`(value)	Key Store is restricted to only this KMS Key ARN.
`KMSConfigurationKmsMRKeyArn`(value)	If an MRK ARN is provided, and the Key Store table holds an MRK ARN, then those two ARNs may differ in region, although they must be otherwise equal.
`KMSConfigurationMrDiscovery`(value)	The Key Store can use the KMS Key ARNs already persisted in the Backing Table.
`KMSConfigurationUnknown`(tag)	Represents an unknown variant.
`MRDiscovery`(*, region)
`Unit`()
`VersionKeyInput`(*, branch_key_identifier)	Inputs for versioning a Branch Key.
`VersionKeyOutput`()	Outputs for versioning a Branch Key.

class aws_cryptographic_material_providers.smithygenerated.aws_cryptography_keystore.models.BeaconKeyMaterials(*, beacon_key_identifier: str, encryption_context: dict[str, str], beacon_key: bytes | bytearray | None = None, hmac_keys: dict[str, bytes | bytearray] | None = None)

Bases: object

__init__(*, beacon_key_identifier: str, encryption_context: dict[str, str], beacon_key: bytes | bytearray | None = None, hmac_keys: dict[str, bytes | bytearray] | None = None)

beacon_key_identifier: str

encryption_context: dict[str, str]

beacon_key: bytes | bytearray | None

hmac_keys: dict[str, bytes | bytearray] | None

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

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

class aws_cryptographic_material_providers.smithygenerated.aws_cryptography_keystore.models.BranchKeyMaterials(*, branch_key_identifier: str, branch_key_version: str, encryption_context: dict[str, str], branch_key: bytes | bytearray)

Bases: object

__init__(*, branch_key_identifier: str, branch_key_version: str, encryption_context: dict[str, str], branch_key: bytes | bytearray)

branch_key_identifier: str

branch_key_version: str

encryption_context: dict[str, str]

branch_key: bytes | bytearray

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

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

class aws_cryptographic_material_providers.smithygenerated.aws_cryptography_keystore.models.CreateKeyInput(*, branch_key_identifier: str | None = None, encryption_context: dict[str, str] | None = None)

Bases: object

Parameters:

branch_key_identifier – The identifier for the created Branch Key.
encryption_context – Custom encryption context for the Branch Key.

Required if branchKeyIdentifier is set.

__init__(*, branch_key_identifier: str | None = None, encryption_context: dict[str, str] | None = None)

Parameters:

branch_key_identifier – The identifier for the created Branch Key.
encryption_context – Custom encryption context for the Branch Key.

Required if branchKeyIdentifier is set.

branch_key_identifier: str | None

encryption_context: dict[str, str] | None

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

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

class aws_cryptographic_material_providers.smithygenerated.aws_cryptography_keystore.models.CreateKeyOutput(*, branch_key_identifier: str)

Bases: object

Outputs for Branch Key creation.

Parameters:: branch_key_identifier – A identifier for the created Branch Key.

__init__(*, branch_key_identifier: str)

Outputs for Branch Key creation.

Parameters:: branch_key_identifier – A identifier for the created Branch Key.

branch_key_identifier: str

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

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

class aws_cryptographic_material_providers.smithygenerated.aws_cryptography_keystore.models.CreateKeyStoreInput

Bases: object

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

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

class aws_cryptographic_material_providers.smithygenerated.aws_cryptography_keystore.models.CreateKeyStoreOutput(*, table_arn: str)

Bases: object

Outputs for Key Store DynamoDB table creation.

Parameters:: table_arn – The ARN of the DynamoDB table that backs this Key Store.

__init__(*, table_arn: str)

Outputs for Key Store DynamoDB table creation.

Parameters:: table_arn – The ARN of the DynamoDB table that backs this Key Store.

table_arn: str

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

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

class aws_cryptographic_material_providers.smithygenerated.aws_cryptography_keystore.models.Discovery

Bases: object

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

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

class aws_cryptographic_material_providers.smithygenerated.aws_cryptography_keystore.models.GetActiveBranchKeyInput(*, branch_key_identifier: str)

Bases: object

Inputs for getting a Branch Key’s ACTIVE version.

Parameters:: branch_key_identifier – The identifier for the Branch Key to get the ACTIVE version for.

__init__(*, branch_key_identifier: str)

Inputs for getting a Branch Key’s ACTIVE version.

Parameters:: branch_key_identifier – The identifier for the Branch Key to get the ACTIVE version for.

branch_key_identifier: str

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

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

class aws_cryptographic_material_providers.smithygenerated.aws_cryptography_keystore.models.GetActiveBranchKeyOutput(*, branch_key_materials: BranchKeyMaterials)

Bases: object

Outputs for getting a Branch Key’s ACTIVE version.

Parameters:: branch_key_materials – The materials for the Branch Key.

__init__(*, branch_key_materials: BranchKeyMaterials)

Outputs for getting a Branch Key’s ACTIVE version.

Parameters:: branch_key_materials – The materials for the Branch Key.

branch_key_materials: BranchKeyMaterials

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

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

class aws_cryptographic_material_providers.smithygenerated.aws_cryptography_keystore.models.GetBeaconKeyInput(*, branch_key_identifier: str)

Bases: object

Inputs for getting a Beacon Key.

Parameters:: branch_key_identifier – The identifier of the Branch Key the Beacon Key is associated with.

__init__(*, branch_key_identifier: str)

Inputs for getting a Beacon Key.

Parameters:: branch_key_identifier – The identifier of the Branch Key the Beacon Key is associated with.

branch_key_identifier: str

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

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

class aws_cryptographic_material_providers.smithygenerated.aws_cryptography_keystore.models.GetBeaconKeyOutput(*, beacon_key_materials: BeaconKeyMaterials)

Bases: object

Outputs for getting a Beacon Key.

Parameters:: beacon_key_materials – The materials for the Beacon Key.

__init__(*, beacon_key_materials: BeaconKeyMaterials)

Outputs for getting a Beacon Key.

Parameters:: beacon_key_materials – The materials for the Beacon Key.

beacon_key_materials: BeaconKeyMaterials

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

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

class aws_cryptographic_material_providers.smithygenerated.aws_cryptography_keystore.models.GetBranchKeyVersionInput(*, branch_key_identifier: str, branch_key_version: str)

Bases: object

Inputs for getting a version of a Branch Key.

Parameters:

branch_key_identifier – The identifier for the Branch Key to get a particular version for.
branch_key_version – The version to get.

__init__(*, branch_key_identifier: str, branch_key_version: str)

Inputs for getting a version of a Branch Key.

Parameters:

branch_key_identifier – The identifier for the Branch Key to get a particular version for.
branch_key_version – The version to get.

branch_key_identifier: str

branch_key_version: str

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

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

class aws_cryptographic_material_providers.smithygenerated.aws_cryptography_keystore.models.GetBranchKeyVersionOutput(*, branch_key_materials: BranchKeyMaterials)

Bases: object

Outputs for getting a version of a Branch Key.

Parameters:: branch_key_materials – The materials for the Branch Key.

__init__(*, branch_key_materials: BranchKeyMaterials)

Outputs for getting a version of a Branch Key.

Parameters:: branch_key_materials – The materials for the Branch Key.

branch_key_materials: BranchKeyMaterials

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

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

class aws_cryptographic_material_providers.smithygenerated.aws_cryptography_keystore.models.MRDiscovery(*, region: str)

Bases: object

Parameters:: region – Any MRK ARN discovered will have its region replaced with this.

__init__(*, region: str)

Parameters:: region – Any MRK ARN discovered will have its region replaced with this.

region: str

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

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

class aws_cryptographic_material_providers.smithygenerated.aws_cryptography_keystore.models.KMSConfigurationKmsKeyArn(value: str)

Bases: object

Key Store is restricted to only this KMS Key ARN.

If a different KMS Key ARN is encountered when creating, versioning, or getting a Branch Key or Beacon Key, KMS is never called and an exception is thrown. While a Multi-Region Key (MKR) may be provided, the whole ARN, including the Region, is persisted in Branch Keys and MUST strictly equal this value to be considered valid.

__init__(value: str)

as_dict() → Dict[str, Any]

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

class aws_cryptographic_material_providers.smithygenerated.aws_cryptography_keystore.models.KMSConfigurationKmsMRKeyArn(value: str)

Bases: object

If an MRK ARN is provided, and the Key Store table holds an MRK ARN, then those two ARNs may differ in region, although they must be otherwise equal.

If either ARN is not an MRK ARN, then mrkKmsKeyArn behaves exactly as kmsKeyArn.

__init__(value: str)

as_dict() → Dict[str, Any]

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

class aws_cryptographic_material_providers.smithygenerated.aws_cryptography_keystore.models.KMSConfigurationDiscovery(value: Discovery)

Bases: object

The Key Store can use the KMS Key ARNs already persisted in the Backing Table.

The VersionKey and CreateKey Operations are NOT supported and will fail with a runtime exception. There is no Multi-Region logic with this configuration; if a Multi-Region Key is encountered, and the region in the ARN is not the region of the KMS Client, requests will Fail with KMS Exceptions.

__init__(value: Discovery)

as_dict() → Dict[str, Any]

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

class aws_cryptographic_material_providers.smithygenerated.aws_cryptography_keystore.models.KMSConfigurationMrDiscovery(value: MRDiscovery)

Bases: object

The Key Store can use the KMS Key ARNs already persisted in the Backing Table.

The VersionKey and CreateKey Operations are NOT supported and will fail with a runtime exception. If a Multi-Region Key is encountered, the region in the ARN is changed to the configured region.

__init__(value: MRDiscovery)

as_dict() → Dict[str, Any]

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

class aws_cryptographic_material_providers.smithygenerated.aws_cryptography_keystore.models.KMSConfigurationUnknown(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]) → KMSConfigurationUnknown

class aws_cryptographic_material_providers.smithygenerated.aws_cryptography_keystore.models.GetKeyStoreInfoOutput(*, key_store_id: str, key_store_name: str, logical_key_store_name: str, grant_tokens: list[str], kms_configuration: KMSConfigurationKmsKeyArn | KMSConfigurationKmsMRKeyArn | KMSConfigurationDiscovery | KMSConfigurationMrDiscovery | KMSConfigurationUnknown)

Bases: object

The configuration information for a Key Store.

Parameters:

key_store_id – An identifier for this Key Store.
key_store_name – The DynamoDB table name that backs this Key Store.
logical_key_store_name – The logical name for this Key Store, which is cryptographically bound to the keys it holds.
grant_tokens – The AWS KMS grant tokens that are used when this Key Store calls to AWS KMS.
kms_configuration – Configures Key Store’s KMS Key ARN restrictions.

__init__(*, key_store_id: str, key_store_name: str, logical_key_store_name: str, grant_tokens: list[str], kms_configuration: KMSConfigurationKmsKeyArn | KMSConfigurationKmsMRKeyArn | KMSConfigurationDiscovery | KMSConfigurationMrDiscovery | KMSConfigurationUnknown)

The configuration information for a Key Store.

Parameters:

key_store_id – An identifier for this Key Store.
key_store_name – The DynamoDB table name that backs this Key Store.
logical_key_store_name – The logical name for this Key Store, which is cryptographically bound to the keys it holds.
grant_tokens – The AWS KMS grant tokens that are used when this Key Store calls to AWS KMS.
kms_configuration – Configures Key Store’s KMS Key ARN restrictions.

key_store_id: str

key_store_name: str

logical_key_store_name: str

grant_tokens: list[str]

kms_configuration: KMSConfigurationKmsKeyArn | KMSConfigurationKmsMRKeyArn | KMSConfigurationDiscovery | KMSConfigurationMrDiscovery | KMSConfigurationUnknown

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

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

class aws_cryptographic_material_providers.smithygenerated.aws_cryptography_keystore.models.VersionKeyInput(*, branch_key_identifier: str)

Bases: object

Inputs for versioning a Branch Key.

Parameters:: branch_key_identifier – The identifier for the Branch Key to be versioned.

__init__(*, branch_key_identifier: str)

Inputs for versioning a Branch Key.

Parameters:: branch_key_identifier – The identifier for the Branch Key to be versioned.

branch_key_identifier: str

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

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

class aws_cryptographic_material_providers.smithygenerated.aws_cryptography_keystore.models.VersionKeyOutput

Bases: object

Outputs for versioning a Branch Key.

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

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

class aws_cryptographic_material_providers.smithygenerated.aws_cryptography_keystore.models.Unit: Bases: object