Skip to content

Commit d4bec46

Browse files
committed
docs: update docs on encrypt/decrypt helper functions to match underlying docs
1 parent d3fcab7 commit d4bec46

File tree

1 file changed

+16
-12
lines changed

1 file changed

+16
-12
lines changed

src/aws_encryption_sdk/__init__.py

Lines changed: 16 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -52,12 +52,14 @@ def encrypt(**kwargs):
5252
:type config: aws_encryption_sdk.streaming_client.EncryptorConfig
5353
:param source: Source data to encrypt or decrypt
5454
:type source: str, bytes, io.IOBase, or file
55-
:param materials_manager: `CryptoMaterialsManager` from which to obtain cryptographic materials
56-
(either `materials_manager` or `key_provider` required)
57-
:type materials_manager: aws_encryption_sdk.materials_managers.base.CryptoMaterialsManager
58-
:param key_provider: `MasterKeyProvider` from which to obtain data keys for encryption
59-
(either `materials_manager` or `key_provider` required)
60-
:type key_provider: aws_encryption_sdk.key_providers.base.MasterKeyProvider
55+
:param CryptoMaterialsManager materials_manager:
56+
Cryptographic materials manager to use for encryption
57+
(either ``materials_manager``, ``keyring``, ``key_provider`` required)
58+
:param Keyring keyring: Keyring to use for encryption
59+
(either ``materials_manager``, ``keyring``, ``key_provider`` required)
60+
:param MasterKeyProvider key_provider:
61+
Master key provider to use for encryption
62+
(either ``materials_manager``, ``keyring``, ``key_provider`` required)
6163
:param int source_length: Length of source data (optional)
6264
6365
.. note::
@@ -109,12 +111,14 @@ def decrypt(**kwargs):
109111
:type config: aws_encryption_sdk.streaming_client.DecryptorConfig
110112
:param source: Source data to encrypt or decrypt
111113
:type source: str, bytes, io.IOBase, or file
112-
:param materials_manager: `CryptoMaterialsManager` from which to obtain cryptographic materials
113-
(either `materials_manager` or `key_provider` required)
114-
:type materials_manager: aws_encryption_sdk.materials_managers.base.CryptoMaterialsManager
115-
:param key_provider: `MasterKeyProvider` from which to obtain data keys for decryption
116-
(either `materials_manager` or `key_provider` required)
117-
:type key_provider: aws_encryption_sdk.key_providers.base.MasterKeyProvider
114+
:param CryptoMaterialsManager materials_manager:
115+
Cryptographic materials manager to use for encryption
116+
(either ``materials_manager``, ``keyring``, ``key_provider`` required)
117+
:param Keyring keyring: Keyring to use for encryption
118+
(either ``materials_manager``, ``keyring``, ``key_provider`` required)
119+
:param MasterKeyProvider key_provider:
120+
Master key provider to use for encryption
121+
(either ``materials_manager``, ``keyring``, ``key_provider`` required)
118122
:param int source_length: Length of source data (optional)
119123
120124
.. note::

0 commit comments

Comments
 (0)