View Source ExAws.KMS (ex_aws_kms v2.4.2)
Operations on AWS KMS
Summary
Functions
Cancel a key deletion
Create a alias
Adds a grant to a key
Creates a customer master key (CMK)
Decrypts ciphertext
Delete a alias
Delete a imported key material
Describe a key
Disable a key
Disable a key rotation
Enable a key
Enable a key rotation
Encrypt a data by a key
Generate a data key
Generate a data key pair
Generate a data key pair without plaintext
Generate a data key without plaintext
Generates an unpredictable byte string
Retrieves a policy attached to the specified key
Indicates whether key rotation is enabled for the specified key
Import key matrial
Returns the public key of an asymmetric CMK
Imports key material into an AWS KMS customer master key (CMK)
Lists all of the key aliases
List the grants for a specified key
Retrieves a list of policies attached to a key
Lists the customer master keys
A list of all grants for which the grant's RetiringPrincipal matches the one specified
Attaches a key policy to the specified customer master key (CMK)
Encrypts data with a new CMK without exposing the plaintext of the data
Retires a grant
Retires a grant
Revokes a grant
Schedules the deletion of CMK
Create a signature for a message or digest
Updates an alias to map it to a different key
Updates the description of a key
Verify a signature generated by the sign
operation
Types
@type describe_key_opts() :: [{:grant_tokens, [binary()]}]
@type disable_key_opts() :: [{:grant_tokens, [binary()]}]
@type generate_data_key_opts() :: [ encryption_context: map(), grant_tokens: [binary()], key_spec: binary(), number_of_bytes: pos_integer() ]
@type generate_data_key_without_plaintext_opts() :: [ encryption_context: map(), grant_tokens: [binary()], key_spec: binary(), number_of_bytes: pos_integer() ]
@type get_public_key_opts() :: [{:grant_tokens, [binary()]}]
Functions
@spec cancel_key_deletion(key_id :: binary()) :: ExAws.Operation.JSON.t()
Cancel a key deletion
@spec create_alias(alias_name :: binary(), target_key_id :: binary()) :: ExAws.Operation.JSON.t()
Create a alias
@spec create_grant( grantee_principal :: binary(), key_id :: binary(), opts :: Keyword.t() ) :: ExAws.Operation.JSON.t()
Adds a grant to a key
@spec create_key(opts :: Keyword.t()) :: ExAws.Operation.JSON.t()
Creates a customer master key (CMK)
@spec decrypt(ciphertext :: binary(), opts :: Keyword.t()) :: ExAws.Operation.JSON.t()
Decrypts ciphertext
@spec delete_alias(alias_name :: binary()) :: ExAws.Operation.JSON.t()
Delete a alias
@spec delete_imported_key_material(key_id :: binary()) :: ExAws.Operation.JSON.t()
Delete a imported key material
@spec describe_key(key_id :: binary(), opts :: describe_key_opts()) :: ExAws.Operation.JSON.t()
Describe a key
@spec disable_key(key_id :: binary(), opts :: disable_key_opts()) :: ExAws.Operation.JSON.t()
Disable a key
@spec disable_key_rotation(key_id :: binary()) :: ExAws.Operation.JSON.t()
Disable a key rotation
@spec enable_key(key_id :: binary()) :: ExAws.Operation.JSON.t()
Enable a key
@spec enable_key_rotation(key_id :: binary()) :: ExAws.Operation.JSON.t()
Enable a key rotation
@spec encrypt(key_id :: binary(), plaintext :: binary(), opts :: encrypt_opts()) :: ExAws.Operation.JSON.t()
Encrypt a data by a key
@spec generate_data_key(key_id :: binary(), opts :: generate_data_key_opts()) :: ExAws.Operation.JSON.t()
Generate a data key
@spec generate_data_key_pair( key_id :: binary(), opts :: generate_data_key_pair_opts() ) :: ExAws.Operation.JSON.t()
Generate a data key pair
@spec generate_data_key_pair_without_plaintext( key_id :: binary(), opts :: generate_data_key_pair_without_plaintext_opts() ) :: ExAws.Operation.JSON.t()
Generate a data key pair without plaintext
@spec generate_data_key_without_plaintext( key_id :: binary(), opts :: generate_data_key_without_plaintext_opts() ) :: ExAws.Operation.JSON.t()
Generate a data key without plaintext
@spec generate_random(number_of_bytes :: pos_integer()) :: ExAws.Operation.JSON.t()
Generates an unpredictable byte string
@spec get_key_policy(key_id :: binary(), policy_name :: binary()) :: ExAws.Operation.JSON.t()
Retrieves a policy attached to the specified key
@spec get_key_rotation_status(key_id :: binary()) :: ExAws.Operation.JSON.t()
Indicates whether key rotation is enabled for the specified key
get_parameters_for_import(key_id, wrapping_algorithm \\ "RSAES_PKCS1_V1_5", wrapping_key_spec \\ "RSA_2048")
View Source@spec get_parameters_for_import( key_id :: binary(), wrapping_algorithm :: binary(), wrapping_key_spec :: binary() ) :: ExAws.Operation.JSON.t()
Import key matrial
@spec get_public_key(key_id :: binary(), opts :: get_public_key_opts()) :: ExAws.Operation.JSON.t()
Returns the public key of an asymmetric CMK
import_key_material(encrypted_key_material, import_token, key_id, opts \\ [])
View Source@spec import_key_material( encrypted_key_material :: binary(), import_token :: binary(), key_id :: binary(), opts :: import_key_material_opts() ) :: ExAws.Operation.JSON.t()
Imports key material into an AWS KMS customer master key (CMK)
@spec list_aliases(opts :: list_aliases_opts()) :: ExAws.Operation.JSON.t()
Lists all of the key aliases
@spec list_grants(key_id :: binary(), opts :: list_grants_opts()) :: ExAws.Operation.JSON.t()
List the grants for a specified key
@spec list_key_policies(key_id :: binary(), opts :: list_key_policies_opts()) :: ExAws.Operation.JSON.t()
Retrieves a list of policies attached to a key
@spec list_keys(opts :: list_keys_opts()) :: ExAws.Operation.JSON.t()
Lists the customer master keys
@spec list_retirable_grants( retiring_principal :: binary(), opts :: list_retirable_grants_opts() ) :: ExAws.Operation.JSON.t()
A list of all grants for which the grant's RetiringPrincipal matches the one specified
put_key_policy(key_id, policy, policy_name, bypass_policy_lockout_safety_check \\ false)
View Source@spec put_key_policy( key_id :: binary(), policy :: binary(), policy_name :: binary(), bypass_policy_lockout_safety_check :: boolean() ) :: ExAws.Operation.JSON.t()
Attaches a key policy to the specified customer master key (CMK)
@spec re_encrypt( ciphertext :: binary(), describe_key :: binary(), opts :: re_encrypt_opts() ) :: ExAws.Operation.JSON.t()
Encrypts data with a new CMK without exposing the plaintext of the data
@spec retire_grant(opts :: retire_grant_opts()) :: ExAws.Operation.JSON.t()
@spec retire_grant(grant_token :: binary()) :: ExAws.Operation.JSON.t()
Retires a grant
@spec retire_grant(grant_id :: binary(), key_id :: binary()) :: ExAws.Operation.JSON.t()
Retires a grant
@spec revoke_grant(grant_id :: binary(), key_id :: binary()) :: ExAws.Operation.JSON.t()
Revokes a grant
@spec schedule_key_deletion(key_id :: binary(), pending_windows_in_days :: integer()) :: ExAws.Operation.JSON.t()
Schedules the deletion of CMK
@spec sign( message :: binary(), key_id :: binary(), signing_algorithm :: binary(), opts :: sign_opts() ) :: ExAws.Operation.JSON.t()
Create a signature for a message or digest
@spec update_alias(alias_name :: binary(), target_key_id :: binary()) :: ExAws.Operation.JSON.t()
Updates an alias to map it to a different key
@spec update_key_description(description :: binary(), key_id :: binary()) :: ExAws.Operation.JSON.t()
Updates the description of a key
@spec verify( message :: binary(), signature :: binary(), key_id :: binary(), signing_algorithm :: binary(), opts :: verify_opts() ) :: ExAws.Operation.JSON.t()
Verify a signature generated by the sign
operation