Class: Aws::KMS::Client

Inherits:
Seahorse::Client::Base show all
Includes:
ClientStubs
Defined in:
gems/aws-sdk-kms/lib/aws-sdk-kms/client.rb

Overview

An API client for KMS. To construct a client, you need to configure a :region and :credentials.

client = Aws::KMS::Client.new(
  region: region_name,
  credentials: credentials,
  # ...
)

For details on configuring region and credentials see the developer guide.

See #initialize for a full list of supported configuration options.

Instance Attribute Summary

Attributes inherited from Seahorse::Client::Base

#config, #handlers

API Operations collapse

Instance Method Summary collapse

Methods included from ClientStubs

#api_requests, #stub_data, #stub_responses

Methods inherited from Seahorse::Client::Base

add_plugin, api, clear_plugins, define, new, #operation_names, plugins, remove_plugin, set_api, set_plugins

Methods included from Seahorse::Client::HandlerBuilder

#handle, #handle_request, #handle_response

Constructor Details

#initialize(options) ⇒ Client

Returns a new instance of Client.

Parameters:

  • options (Hash)

Options Hash (options):

  • :credentials (required, Aws::CredentialProvider) —

    Your AWS credentials. This can be an instance of any one of the following classes:

    • Aws::Credentials - Used for configuring static, non-refreshing credentials.

    • Aws::InstanceProfileCredentials - Used for loading credentials from an EC2 IMDS on an EC2 instance.

    • Aws::SharedCredentials - Used for loading credentials from a shared file, such as ~/.aws/config.

    • Aws::AssumeRoleCredentials - Used when you need to assume a role.

    When :credentials are not configured directly, the following locations will be searched for credentials:

    • Aws.config[:credentials]
    • The :access_key_id, :secret_access_key, and :session_token options.
    • ENV['AWS_ACCESS_KEY_ID'], ENV['AWS_SECRET_ACCESS_KEY']
    • ~/.aws/credentials
    • ~/.aws/config
    • EC2 IMDS instance profile - When used by default, the timeouts are very aggressive. Construct and pass an instance of Aws::InstanceProfileCredentails to enable retries and extended timeouts.
  • :region (required, String) —

    The AWS region to connect to. The configured :region is used to determine the service :endpoint. When not passed, a default :region is searched for in the following locations:

    • Aws.config[:region]
    • ENV['AWS_REGION']
    • ENV['AMAZON_REGION']
    • ENV['AWS_DEFAULT_REGION']
    • ~/.aws/credentials
    • ~/.aws/config
  • :access_key_id (String)
  • :active_endpoint_cache (Boolean) — default: false —

    When set to true, a thread polling for endpoints will be running in the background every 60 secs (default). Defaults to false.

  • :adaptive_retry_wait_to_fill (Boolean) — default: true —

    Used only in adaptive retry mode. When true, the request will sleep until there is sufficent client side capacity to retry the request. When false, the request will raise a RetryCapacityNotAvailableError and will not retry instead of sleeping.

  • :client_side_monitoring (Boolean) — default: false —

    When true, client-side metrics will be collected for all API requests from this client.

  • :client_side_monitoring_client_id (String) — default: "" —

    Allows you to provide an identifier for this client which will be attached to all generated client side metrics. Defaults to an empty string.

  • :client_side_monitoring_host (String) — default: "127.0.0.1" —

    Allows you to specify the DNS hostname or IPv4 or IPv6 address that the client side monitoring agent is running on, where client metrics will be published via UDP.

  • :client_side_monitoring_port (Integer) — default: 31000 —

    Required for publishing client metrics. The port that the client side monitoring agent is running on, where client metrics will be published via UDP.

  • :client_side_monitoring_publisher (Aws::ClientSideMonitoring::Publisher) — default: Aws::ClientSideMonitoring::Publisher —

    Allows you to provide a custom client-side monitoring publisher class. By default, will use the Client Side Monitoring Agent Publisher.

  • :convert_params (Boolean) — default: true —

    When true, an attempt is made to coerce request parameters into the required types.

  • :correct_clock_skew (Boolean) — default: true —

    Used only in standard and adaptive retry modes. Specifies whether to apply a clock skew correction and retry requests with skewed client clocks.

  • :disable_host_prefix_injection (Boolean) — default: false —

    Set to true to disable SDK automatically adding host prefix to default service endpoint when available.

  • :endpoint (String) —

    The client endpoint is normally constructed from the :region option. You should only configure an :endpoint when connecting to test or custom endpoints. This should be a valid HTTP(S) URI.

  • :endpoint_cache_max_entries (Integer) — default: 1000 —

    Used for the maximum size limit of the LRU cache storing endpoints data for endpoint discovery enabled operations. Defaults to 1000.

  • :endpoint_cache_max_threads (Integer) — default: 10 —

    Used for the maximum threads in use for polling endpoints to be cached, defaults to 10.

  • :endpoint_cache_poll_interval (Integer) — default: 60 —

    When :endpoint_discovery and :active_endpoint_cache is enabled, Use this option to config the time interval in seconds for making requests fetching endpoints information. Defaults to 60 sec.

  • :endpoint_discovery (Boolean) — default: false —

    When set to true, endpoint discovery will be enabled for operations when available.

  • :log_formatter (Aws::Log::Formatter) — default: Aws::Log::Formatter.default —

    The log formatter.

  • :log_level (Symbol) — default: :info —

    The log level to send messages to the :logger at.

  • :logger (Logger) —

    The Logger instance to send log messages to. If this option is not set, logging will be disabled.

  • :max_attempts (Integer) — default: 3 —

    An integer representing the maximum number attempts that will be made for a single request, including the initial attempt. For example, setting this value to 5 will result in a request being retried up to 4 times. Used in standard and adaptive retry modes.

  • :profile (String) — default: "default" —

    Used when loading credentials from the shared credentials file at HOME/.aws/credentials. When not specified, 'default' is used.

  • :retry_backoff (Proc) —

    A proc or lambda used for backoff. Defaults to 2**retries * retry_base_delay. This option is only used in the legacy retry mode.

  • :retry_base_delay (Float) — default: 0.3 —

    The base delay in seconds used by the default backoff function. This option is only used in the legacy retry mode.

  • :retry_jitter (Symbol) — default: :none —

    A delay randomiser function used by the default backoff function. Some predefined functions can be referenced by name - :none, :equal, :full, otherwise a Proc that takes and returns a number. This option is only used in the legacy retry mode.

    @see https://www.awsarchitectureblog.com/2015/03/backoff.html

  • :retry_limit (Integer) — default: 3 —

    The maximum number of times to retry failed requests. Only ~ 500 level server errors and certain ~ 400 level client errors are retried. Generally, these are throttling errors, data checksum errors, networking errors, timeout errors, auth errors, endpoint discovery, and errors from expired credentials. This option is only used in the legacy retry mode.

  • :retry_max_delay (Integer) — default: 0 —

    The maximum number of seconds to delay between retries (0 for no limit) used by the default backoff function. This option is only used in the legacy retry mode.

  • :retry_mode (String) — default: "legacy" —

    Specifies which retry algorithm to use. Values are:

    • legacy - The pre-existing retry behavior. This is default value if no retry mode is provided.

    • standard - A standardized set of retry rules across the AWS SDKs. This includes support for retry quotas, which limit the number of unsuccessful retries a client can make.

    • adaptive - An experimental retry mode that includes all the functionality of standard mode along with automatic client side throttling. This is a provisional mode that may change behavior in the future.

  • :secret_access_key (String)
  • :session_token (String)
  • :simple_json (Boolean) — default: false —

    Disables request parameter conversion, validation, and formatting. Also disable response data type conversions. This option is useful when you want to ensure the highest level of performance by avoiding overhead of walking request parameters and response data structures.

    When :simple_json is enabled, the request parameters hash must be formatted exactly as the DynamoDB API expects.

  • :stub_responses (Boolean) — default: false —

    Causes the client to return stubbed responses. By default fake responses are generated and returned. You can specify the response data to return or errors to raise by calling ClientStubs#stub_responses. See ClientStubs for more information.

    Please note When response stubbing is enabled, no HTTP requests are made, and retries are disabled.

  • :validate_params (Boolean) — default: true —

    When true, request parameters are validated before sending the request.

  • :http_proxy (URI::HTTP, String) —

    A proxy to send requests through. Formatted like 'http://proxy.com:123'.

  • :http_open_timeout (Float) — default: 15 —

    The number of seconds to wait when opening a HTTP session before raising a Timeout::Error.

  • :http_read_timeout (Integer) — default: 60 —

    The default number of seconds to wait for response data. This value can safely be set per-request on the session.

  • :http_idle_timeout (Float) — default: 5 —

    The number of seconds a connection is allowed to sit idle before it is considered stale. Stale connections are closed and removed from the pool before making a request.

  • :http_continue_timeout (Float) — default: 1 —

    The number of seconds to wait for a 100-continue response before sending the request body. This option has no effect unless the request has "Expect" header set to "100-continue". Defaults to nil which disables this behaviour. This value can safely be set per request on the session.

  • :http_wire_trace (Boolean) — default: false —

    When true, HTTP debug output will be sent to the :logger.

  • :ssl_verify_peer (Boolean) — default: true —

    When true, SSL peer certificates are verified when establishing a connection.

  • :ssl_ca_bundle (String) —

    Full path to the SSL certificate authority bundle file that should be used when verifying peer certificates. If you do not pass :ssl_ca_bundle or :ssl_ca_directory the the system default will be used if available.

  • :ssl_ca_directory (String) —

    Full path of the directory that contains the unbundled SSL certificate authority files for verifying peer certificates. If you do not pass :ssl_ca_bundle or :ssl_ca_directory the the system default will be used if available.



319
320
321
 
# File 'gems/aws-sdk-kms/lib/aws-sdk-kms/client.rb', line 319

def initialize(*args)
  super
end

Instance Method Details

#cancel_key_deletion(params = {}) ⇒ Types::CancelKeyDeletionResponse

Cancels the deletion of a customer master key (CMK). When this operation succeeds, the key state of the CMK is Disabled. To enable the CMK, use EnableKey. You cannot perform this operation on a CMK in a different AWS account.

For more information about scheduling and canceling deletion of a CMK, see Deleting Customer Master Keys in the AWS Key Management Service Developer Guide.

The CMK that you use for this operation must be in a compatible key state. For details, see How Key State Affects Use of a Customer Master Key in the AWS Key Management Service Developer Guide.

Examples:

Example: To cancel deletion of a customer master key (CMK)


# The following example cancels deletion of the specified CMK.

resp = client.cancel_key_deletion({
  key_id: "1234abcd-12ab-34cd-56ef-1234567890ab", # The identifier of the CMK whose deletion you are canceling. You can use the key ID or the Amazon Resource Name (ARN) of the CMK.
})

resp.to_h outputs the following:
{
  key_id: "arn:aws:kms:us-east-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab", # The ARN of the CMK whose deletion you canceled.
}

Request syntax with placeholder values


resp = client.cancel_key_deletion({
  key_id: "KeyIdType", # required
})

Response structure


resp.key_id #=> String

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :key_id (required, String) —

    The unique identifier for the customer master key (CMK) for which to cancel deletion.

    Specify the key ID or the Amazon Resource Name (ARN) of the CMK.

    For example:

    • Key ID: 1234abcd-12ab-34cd-56ef-1234567890ab

    • Key ARN: arn:aws:kms:us-east-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab

    To get the key ID and key ARN for a CMK, use ListKeys or DescribeKey.

Returns:

See Also:



390
391
392
393
 
# File 'gems/aws-sdk-kms/lib/aws-sdk-kms/client.rb', line 390

def cancel_key_deletion(params = {}, options = {})
  req = build_request(:cancel_key_deletion, params)
  req.send_request(options)
end

#connect_custom_key_store(params = {}) ⇒ Struct

Connects or reconnects a custom key store to its associated AWS CloudHSM cluster.

The custom key store must be connected before you can create customer master keys (CMKs) in the key store or use the CMKs it contains. You can disconnect and reconnect a custom key store at any time.

To connect a custom key store, its associated AWS CloudHSM cluster must have at least one active HSM. To get the number of active HSMs in a cluster, use the DescribeClusters operation. To add HSMs to the cluster, use the CreateHsm operation. Also, the kmsuser crypto user (CU) must not be logged into the cluster. This prevents AWS KMS from using this account to log in.

The connection process can take an extended amount of time to complete; up to 20 minutes. This operation starts the connection process, but it does not wait for it to complete. When it succeeds, this operation quickly returns an HTTP 200 response and a JSON object with no properties. However, this response does not indicate that the custom key store is connected. To get the connection state of the custom key store, use the DescribeCustomKeyStores operation.

During the connection process, AWS KMS finds the AWS CloudHSM cluster that is associated with the custom key store, creates the connection infrastructure, connects to the cluster, logs into the AWS CloudHSM client as the kmsuser CU, and rotates its password.

The ConnectCustomKeyStore operation might fail for various reasons. To find the reason, use the DescribeCustomKeyStores operation and see the ConnectionErrorCode in the response. For help interpreting the ConnectionErrorCode, see CustomKeyStoresListEntry.

To fix the failure, use the DisconnectCustomKeyStore operation to disconnect the custom key store, correct the error, use the UpdateCustomKeyStore operation if necessary, and then use ConnectCustomKeyStore again.

If you are having trouble connecting or disconnecting a custom key store, see Troubleshooting a Custom Key Store in the AWS Key Management Service Developer Guide.

Examples:

Request syntax with placeholder values


resp = client.connect_custom_key_store({
  custom_key_store_id: "CustomKeyStoreIdType", # required
})

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :custom_key_store_id (required, String) —

    Enter the key store ID of the custom key store that you want to connect. To find the ID of a custom key store, use the DescribeCustomKeyStores operation.

Returns:

  • (Struct) —

    Returns an empty response.

See Also:



461
462
463
464
 
# File 'gems/aws-sdk-kms/lib/aws-sdk-kms/client.rb', line 461

def connect_custom_key_store(params = {}, options = {})
  req = build_request(:connect_custom_key_store, params)
  req.send_request(options)
end

#create_alias(params = {}) ⇒ Struct

Creates a display name for a customer managed customer master key (CMK). You can use an alias to identify a CMK in cryptographic operations, such as Encrypt and GenerateDataKey. You can change the CMK associated with the alias at any time.

Aliases are easier to remember than key IDs. They can also help to simplify your applications. For example, if you use an alias in your code, you can change the CMK your code uses by associating a given alias with a different CMK.

To run the same code in multiple AWS regions, use an alias in your code, such as alias/ApplicationKey. Then, in each AWS Region, create an alias/ApplicationKey alias that is associated with a CMK in that Region. When you run your code, it uses the alias/ApplicationKey CMK for that AWS Region without any Region-specific code.

This operation does not return a response. To get the alias that you created, use the ListAliases operation.

To use aliases successfully, be aware of the following information.

  • Each alias points to only one CMK at a time, although a single CMK can have multiple aliases. The alias and its associated CMK must be in the same AWS account and Region.

  • You can associate an alias with any customer managed CMK in the same AWS account and Region. However, you do not have permission to associate an alias with an AWS managed CMK or an AWS owned CMK.

  • To change the CMK associated with an alias, use the UpdateAlias operation. The current CMK and the new CMK must be the same type (both symmetric or both asymmetric) and they must have the same key usage (ENCRYPT_DECRYPT or SIGN_VERIFY). This restriction prevents cryptographic errors in code that uses aliases.

  • The alias name must begin with alias/ followed by a name, such as alias/ExampleAlias. It can contain only alphanumeric characters, forward slashes (/), underscores (_), and dashes (-). The alias name cannot begin with alias/aws/. The alias/aws/ prefix is reserved for AWS managed CMKs.

  • The alias name must be unique within an AWS Region. However, you can use the same alias name in multiple Regions of the same AWS account. Each instance of the alias is associated with a CMK in its Region.

  • After you create an alias, you cannot change its alias name. However, you can use the DeleteAlias operation to delete the alias and then create a new alias with the desired name.

  • You can use an alias name or alias ARN to identify a CMK in AWS KMS cryptographic operations and in the DescribeKey operation. However, you cannot use alias names or alias ARNs in API operations that manage CMKs, such as DisableKey or GetKeyPolicy. For information about the valid CMK identifiers for each AWS KMS API operation, see the descriptions of the KeyId parameter in the API operation documentation.

Because an alias is not a property of a CMK, you can delete and change the aliases of a CMK without affecting the CMK. Also, aliases do not appear in the response from the DescribeKey operation. To get the aliases and alias ARNs of CMKs in each AWS account and Region, use the ListAliases operation.

The CMK that you use for this operation must be in a compatible key state. For details, see How Key State Affects Use of a Customer Master Key in the AWS Key Management Service Developer Guide.

Examples:

Example: To create an alias


# The following example creates an alias for the specified customer master key (CMK).

resp = client.create_alias({
  alias_name: "alias/ExampleAlias", # The alias to create. Aliases must begin with 'alias/'. Do not use aliases that begin with 'alias/aws' because they are reserved for use by AWS.
  target_key_id: "1234abcd-12ab-34cd-56ef-1234567890ab", # The identifier of the CMK whose alias you are creating. You can use the key ID or the Amazon Resource Name (ARN) of the CMK.
})

Request syntax with placeholder values


resp = client.create_alias({
  alias_name: "AliasNameType", # required
  target_key_id: "KeyIdType", # required
})

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :alias_name (required, String) —

    Specifies the alias name. This value must begin with alias/ followed by a name, such as alias/ExampleAlias. The alias name cannot begin with alias/aws/. The alias/aws/ prefix is reserved for AWS managed CMKs.

  • :target_key_id (required, String) —

    Identifies the CMK to which the alias refers. Specify the key ID or the Amazon Resource Name (ARN) of the CMK. You cannot specify another alias. For help finding the key ID and ARN, see Finding the Key ID and ARN in the AWS Key Management Service Developer Guide.

Returns:

  • (Struct) —

    Returns an empty response.

See Also:



580
581
582
583
 
# File 'gems/aws-sdk-kms/lib/aws-sdk-kms/client.rb', line 580

def create_alias(params = {}, options = {})
  req = build_request(:create_alias, params)
  req.send_request(options)
end

#create_custom_key_store(params = {}) ⇒ Types::CreateCustomKeyStoreResponse

Creates a custom key store that is associated with an AWS CloudHSM cluster that you own and manage.

This operation is part of the Custom Key Store feature feature in AWS KMS, which combines the convenience and extensive integration of AWS KMS with the isolation and control of a single-tenant key store.

Before you create the custom key store, you must assemble the required elements, including an AWS CloudHSM cluster that fulfills the requirements for a custom key store. For details about the required elements, see Assemble the Prerequisites in the AWS Key Management Service Developer Guide.

When the operation completes successfully, it returns the ID of the new custom key store. Before you can use your new custom key store, you need to use the ConnectCustomKeyStore operation to connect the new key store to its AWS CloudHSM cluster. Even if you are not going to use your custom key store immediately, you might want to connect it to verify that all settings are correct and then disconnect it until you are ready to use it.

For help with failures, see Troubleshooting a Custom Key Store in the AWS Key Management Service Developer Guide.

Examples:

Request syntax with placeholder values


resp = client.create_custom_key_store({
  custom_key_store_name: "CustomKeyStoreNameType", # required
  cloud_hsm_cluster_id: "CloudHsmClusterIdType", # required
  trust_anchor_certificate: "TrustAnchorCertificateType", # required
  key_store_password: "KeyStorePasswordType", # required
})

Response structure


resp.custom_key_store_id #=> String

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :custom_key_store_name (required, String) —

    Specifies a friendly name for the custom key store. The name must be unique in your AWS account.

  • :cloud_hsm_cluster_id (required, String) —

    Identifies the AWS CloudHSM cluster for the custom key store. Enter the cluster ID of any active AWS CloudHSM cluster that is not already associated with a custom key store. To find the cluster ID, use the DescribeClusters operation.

  • :trust_anchor_certificate (required, String) —

    Enter the content of the trust anchor certificate for the cluster. This is the content of the customerCA.crt file that you created when you initialized the cluster.

  • :key_store_password (required, String) —

    Enter the password of the kmsuser crypto user (CU) account in the specified AWS CloudHSM cluster. AWS KMS logs into the cluster as this user to manage key material on your behalf.

    The password must be a string of 7 to 32 characters. Its value is case sensitive.

    This parameter tells AWS KMS the kmsuser account password; it does not change the password in the AWS CloudHSM cluster.

Returns:

See Also:



675
676
677
678
 
# File 'gems/aws-sdk-kms/lib/aws-sdk-kms/client.rb', line 675

def create_custom_key_store(params = {}, options = {})
  req = build_request(:create_custom_key_store, params)
  req.send_request(options)
end

#create_grant(params = {}) ⇒ Types::CreateGrantResponse

Adds a grant to a customer master key (CMK). The grant allows the grantee principal to use the CMK when the conditions specified in the grant are met. When setting permissions, grants are an alternative to key policies.

To create a grant that allows a cryptographic operation only when the request includes a particular encryption context, use the Constraints parameter. For details, see GrantConstraints.

You can create grants on symmetric and asymmetric CMKs. However, if the grant allows an operation that the CMK does not support, CreateGrant fails with a ValidationException.

  • Grants for symmetric CMKs cannot allow operations that are not supported for symmetric CMKs, including Sign, Verify, and GetPublicKey. (There are limited exceptions to this rule for legacy operations, but you should not create a grant for an operation that AWS KMS does not support.)

  • Grants for asymmetric CMKs cannot allow operations that are not supported for asymmetric CMKs, including operations that generate data keys or data key pairs, or operations related to automatic key rotation, imported key material, or CMKs in custom key stores.

  • Grants for asymmetric CMKs with a KeyUsage of ENCRYPT_DECRYPT cannot allow the Sign or Verify operations. Grants for asymmetric CMKs with a KeyUsage of SIGN_VERIFY cannot allow the Encrypt or Decrypt operations.

  • Grants for asymmetric CMKs cannot include an encryption context grant constraint. An encryption context is not supported on asymmetric CMKs.

For information about symmetric and asymmetric CMKs, see Using Symmetric and Asymmetric CMKs in the AWS Key Management Service Developer Guide.

To perform this operation on a CMK in a different AWS account, specify the key ARN in the value of the KeyId parameter. For more information about grants, see Grants in the AWS Key Management Service Developer Guide .

The CMK that you use for this operation must be in a compatible key state. For details, see How Key State Affects Use of a Customer Master Key in the AWS Key Management Service Developer Guide.

Examples:

Example: To create a grant


# The following example creates a grant that allows the specified IAM role to encrypt data with the specified customer
# master key (CMK).

resp = client.create_grant({
  grantee_principal: "arn:aws:iam::111122223333:role/ExampleRole", # The identity that is given permission to perform the operations specified in the grant.
  key_id: "arn:aws:kms:us-east-2:444455556666:key/1234abcd-12ab-34cd-56ef-1234567890ab", # The identifier of the CMK to which the grant applies. You can use the key ID or the Amazon Resource Name (ARN) of the CMK.
  operations: [
    "Encrypt", 
    "Decrypt", 
  ], # A list of operations that the grant allows.
})

resp.to_h outputs the following:
{
  grant_id: "0c237476b39f8bc44e45212e08498fbe3151305030726c0590dd8d3e9f3d6a60", # The unique identifier of the grant.
  grant_token: "AQpAM2RhZTk1MGMyNTk2ZmZmMzEyYWVhOWViN2I1MWM4Mzc0MWFiYjc0ZDE1ODkyNGFlNTIzODZhMzgyZjBlNGY3NiKIAgEBAgB4Pa6VDCWW__MSrqnre1HIN0Grt00ViSSuUjhqOC8OT3YAAADfMIHcBgkqhkiG9w0BBwaggc4wgcsCAQAwgcUGCSqGSIb3DQEHATAeBglghkgBZQMEAS4wEQQMmqLyBTAegIn9XlK5AgEQgIGXZQjkBcl1dykDdqZBUQ6L1OfUivQy7JVYO2-ZJP7m6f1g8GzV47HX5phdtONAP7K_HQIflcgpkoCqd_fUnE114mSmiagWkbQ5sqAVV3ov-VeqgrvMe5ZFEWLMSluvBAqdjHEdMIkHMlhlj4ENZbzBfo9Wxk8b8SnwP4kc4gGivedzFXo-dwN8fxjjq_ZZ9JFOj2ijIbj5FyogDCN0drOfi8RORSEuCEmPvjFRMFAwcmwFkN2NPp89amA", # The grant token.
}

Request syntax with placeholder values


resp = client.create_grant({
  key_id: "KeyIdType", # required
  grantee_principal: "PrincipalIdType", # required
  retiring_principal: "PrincipalIdType",
  operations: ["Decrypt"], # required, accepts Decrypt, Encrypt, GenerateDataKey, GenerateDataKeyWithoutPlaintext, ReEncryptFrom, ReEncryptTo, Sign, Verify, GetPublicKey, CreateGrant, RetireGrant, DescribeKey, GenerateDataKeyPair, GenerateDataKeyPairWithoutPlaintext
  constraints: {
    encryption_context_subset: {
      "EncryptionContextKey" => "EncryptionContextValue",
    },
    encryption_context_equals: {
      "EncryptionContextKey" => "EncryptionContextValue",
    },
  },
  grant_tokens: ["GrantTokenType"],
  name: "GrantNameType",
})

Response structure


resp.grant_token #=> String
resp.grant_id #=> String

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :key_id (required, String) —

    The unique identifier for the customer master key (CMK) that the grant applies to.

    Specify the key ID or the Amazon Resource Name (ARN) of the CMK. To specify a CMK in a different AWS account, you must use the key 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

    To get the key ID and key ARN for a CMK, use ListKeys or DescribeKey.

  • :grantee_principal (required, String) —

    The principal that is given permission to perform the operations that the grant permits.

    To specify the principal, use the Amazon Resource Name (ARN) of an AWS principal. Valid AWS principals include AWS accounts (root), IAM users, IAM roles, federated users, and assumed role users. For examples of the ARN syntax to use for specifying a principal, see AWS Identity and Access Management (IAM) in the Example ARNs section of the AWS General Reference.

  • :retiring_principal (String) —

    The principal that is given permission to retire the grant by using RetireGrant operation.

    To specify the principal, use the Amazon Resource Name (ARN) of an AWS principal. Valid AWS principals include AWS accounts (root), IAM users, federated users, and assumed role users. For examples of the ARN syntax to use for specifying a principal, see AWS Identity and Access Management (IAM) in the Example ARNs section of the AWS General Reference.

  • :operations (required, Array<String>) —

    A list of operations that the grant permits.

  • :constraints (Types::GrantConstraints) —

    Allows a cryptographic operation only when the encryption context matches or includes the encryption context specified in this structure. For more information about encryption context, see Encryption Context in the AWS Key Management Service Developer Guide .

  • :grant_tokens (Array<String>) —

    A list of grant tokens.

    For more information, see Grant Tokens in the AWS Key Management Service Developer Guide.

  • :name (String) —

    A friendly name for identifying the grant. Use this value to prevent the unintended creation of duplicate grants when retrying this request.

    When this value is absent, all CreateGrant requests result in a new grant with a unique GrantId even if all the supplied parameters are identical. This can result in unintended duplicates when you retry the CreateGrant request.

    When this value is present, you can retry a CreateGrant request with identical parameters; if the grant already exists, the original GrantId is returned without creating a new grant. Note that the returned grant token is unique with every CreateGrant request, even when a duplicate GrantId is returned. All grant tokens obtained in this way can be used interchangeably.

Returns:

See Also:



884
885
886
887
 
# File 'gems/aws-sdk-kms/lib/aws-sdk-kms/client.rb', line 884

def create_grant(params = {}, options = {})
  req = build_request(:create_grant, params)
  req.send_request(options)
end

#create_key(params = {}) ⇒ Types::CreateKeyResponse

Creates a unique customer managed customer master key (CMK) in your AWS account and Region. You cannot use this operation to create a CMK in a different AWS account.

You can use the CreateKey operation to create symmetric or asymmetric CMKs.

  • Symmetric CMKs contain a 256-bit symmetric key that never leaves AWS KMS unencrypted. To use the CMK, you must call AWS KMS. You can use a symmetric CMK to encrypt and decrypt small amounts of data, but they are typically used to generate data keys and data keys pairs. For details, see GenerateDataKey and GenerateDataKeyPair.

  • Asymmetric CMKs can contain an RSA key pair or an Elliptic Curve (ECC) key pair. The private key in an asymmetric CMK never leaves AWS KMS unencrypted. However, you can use the GetPublicKey operation to download the public key so it can be used outside of AWS KMS. CMKs with RSA key pairs can be used to encrypt or decrypt data or sign and verify messages (but not both). CMKs with ECC key pairs can be used only to sign and verify messages.

For information about symmetric and asymmetric CMKs, see Using Symmetric and Asymmetric CMKs in the AWS Key Management Service Developer Guide.

To create different types of CMKs, use the following guidance:

Asymmetric CMKs

To create an asymmetric CMK, use the CustomerMasterKeySpec parameter to specify the type of key material in the CMK. Then, use the KeyUsage parameter to determine whether the CMK will be used to encrypt and decrypt or sign and verify. You can't change these properties after the CMK is created.

Symmetric CMKs

When creating a symmetric CMK, you don't need to specify the CustomerMasterKeySpec or KeyUsage parameters. The default value for CustomerMasterKeySpec, SYMMETRIC_DEFAULT, and the default value for KeyUsage, ENCRYPT_DECRYPT, are the only valid values for symmetric CMKs.

Imported Key Material

To import your own key material, begin by creating a symmetric CMK with no key material. To do this, use the Origin parameter of CreateKey with a value of EXTERNAL. Next, use GetParametersForImport operation to get a public key and import token, and use the public key to encrypt your key material. Then, use ImportKeyMaterial with your import token to import the key material. For step-by-step instructions, see Importing Key Material in the AWS Key Management Service Developer Guide . You cannot import the key material into an asymmetric CMK.

Custom Key Stores

To create a symmetric CMK in a custom key store, use the CustomKeyStoreId parameter to specify the custom key store. You must also use the Origin parameter with a value of AWS_CLOUDHSM. The AWS CloudHSM cluster that is associated with the custom key store must have at least two active HSMs in different Availability Zones in the AWS Region.

You cannot create an asymmetric CMK in a custom key store. For information about custom key stores in AWS KMS see Using Custom Key Stores in the AWS Key Management Service Developer Guide .

Examples:

Example: To create a customer master key (CMK)


# The following example creates a CMK.

resp = client.create_key({
  tags: [
    {
      tag_key: "CreatedBy", 
      tag_value: "ExampleUser", 
    }, 
  ], # One or more tags. Each tag consists of a tag key and a tag value.
})

resp.to_h outputs the following:
{
  key_metadata: {
    aws_account_id: "111122223333", 
    arn: "arn:aws:kms:us-east-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab", 
    creation_date: Time.parse("2017-07-05T14:04:55-07:00"), 
    description: "", 
    enabled: true, 
    key_id: "1234abcd-12ab-34cd-56ef-1234567890ab", 
    key_manager: "CUSTOMER", 
    key_state: "Enabled", 
    key_usage: "ENCRYPT_DECRYPT", 
    origin: "AWS_KMS", 
  }, # An object that contains information about the CMK created by this operation.
}

Request syntax with placeholder values


resp = client.create_key({
  policy: "PolicyType",
  description: "DescriptionType",
  key_usage: "SIGN_VERIFY", # accepts SIGN_VERIFY, ENCRYPT_DECRYPT
  customer_master_key_spec: "RSA_2048", # accepts RSA_2048, RSA_3072, RSA_4096, ECC_NIST_P256, ECC_NIST_P384, ECC_NIST_P521, ECC_SECG_P256K1, SYMMETRIC_DEFAULT
  origin: "AWS_KMS", # accepts AWS_KMS, EXTERNAL, AWS_CLOUDHSM
  custom_key_store_id: "CustomKeyStoreIdType",
  bypass_policy_lockout_safety_check: false,
  tags: [
    {
      tag_key: "TagKeyType", # required
      tag_value: "TagValueType", # required
    },
  ],
})

Response structure


resp.key_metadata. #=> String
resp.key_metadata.key_id #=> String
resp.key_metadata.arn #=> String
resp.key_metadata.creation_date #=> Time
resp.key_metadata.enabled #=> Boolean
resp.key_metadata.description #=> String
resp.key_metadata.key_usage #=> String, one of "SIGN_VERIFY", "ENCRYPT_DECRYPT"
resp.key_metadata.key_state #=> String, one of "Enabled", "Disabled", "PendingDeletion", "PendingImport", "Unavailable"
resp.key_metadata.deletion_date #=> Time
resp.key_metadata.valid_to #=> Time
resp.key_metadata.origin #=> String, one of "AWS_KMS", "EXTERNAL", "AWS_CLOUDHSM"
resp.key_metadata.custom_key_store_id #=> String
resp.key_metadata.cloud_hsm_cluster_id #=> String
resp.key_metadata.expiration_model #=> String, one of "KEY_MATERIAL_EXPIRES", "KEY_MATERIAL_DOES_NOT_EXPIRE"
resp.key_metadata.key_manager #=> String, one of "AWS", "CUSTOMER"
resp.key_metadata.customer_master_key_spec #=> String, one of "RSA_2048", "RSA_3072", "RSA_4096", "ECC_NIST_P256", "ECC_NIST_P384", "ECC_NIST_P521", "ECC_SECG_P256K1", "SYMMETRIC_DEFAULT"
resp.key_metadata.encryption_algorithms #=> Array
resp.key_metadata.encryption_algorithms[0] #=> String, one of "SYMMETRIC_DEFAULT", "RSAES_OAEP_SHA_1", "RSAES_OAEP_SHA_256"
resp.key_metadata.signing_algorithms #=> Array
resp.key_metadata.signing_algorithms[0] #=> String, one of "RSASSA_PSS_SHA_256", "RSASSA_PSS_SHA_384", "RSASSA_PSS_SHA_512", "RSASSA_PKCS1_V1_5_SHA_256", "RSASSA_PKCS1_V1_5_SHA_384", "RSASSA_PKCS1_V1_5_SHA_512", "ECDSA_SHA_256", "ECDSA_SHA_384", "ECDSA_SHA_512"

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :policy (String) —

    The key policy to attach to the CMK.

    If you provide a key policy, it must meet the following criteria:

    • If you don't set BypassPolicyLockoutSafetyCheck to true, the key policy must allow the principal that is making the CreateKey request to make a subsequent PutKeyPolicy request on the CMK. This reduces the risk that the CMK becomes unmanageable. For more information, refer to the scenario in the Default Key Policy section of the AWS Key Management Service Developer Guide .

    • Each statement in the key policy must contain one or more principals. The principals in the key policy must exist and be visible to AWS KMS. When you create a new AWS principal (for example, an IAM user or role), you might need to enforce a delay before including the new principal in a key policy because the new principal might not be immediately visible to AWS KMS. For more information, see Changes that I make are not always immediately visible in the AWS Identity and Access Management User Guide.

    If you do not provide a key policy, AWS KMS attaches a default key policy to the CMK. For more information, see Default Key Policy in the AWS Key Management Service Developer Guide.

    The key policy size quota is 32 kilobytes (32768 bytes).

  • :description (String) —

    A description of the CMK.

    Use a description that helps you decide whether the CMK is appropriate for a task.

  • :key_usage (String) —

    Determines the cryptographic operations for which you can use the CMK. The default value is ENCRYPT_DECRYPT. This parameter is required only for asymmetric CMKs. You can't change the KeyUsage value after the CMK is created.

    Select only one valid value.

    • For symmetric CMKs, omit the parameter or specify ENCRYPT_DECRYPT.

    • For asymmetric CMKs with RSA key material, specify ENCRYPT_DECRYPT or SIGN_VERIFY.

    • For asymmetric CMKs with ECC key material, specify SIGN_VERIFY.

  • :customer_master_key_spec (String) —

    Specifies the type of CMK to create. The default value, SYMMETRIC_DEFAULT, creates a CMK with a 256-bit symmetric key for encryption and decryption. For help choosing a key spec for your CMK, see How to Choose Your CMK Configuration in the AWS Key Management Service Developer Guide.

    The CustomerMasterKeySpec determines whether the CMK contains a symmetric key or an asymmetric key pair. It also determines the encryption algorithms or signing algorithms that the CMK supports. You can't change the CustomerMasterKeySpec after the CMK is created. To further restrict the algorithms that can be used with the CMK, use a condition key in its key policy or IAM policy. For more information, see kms:EncryptionAlgorithm or kms:Signing Algorithm in the AWS Key Management Service Developer Guide.

    AWS services that are integrated with AWS KMS use symmetric CMKs to protect your data. These services do not support asymmetric CMKs. For help determining whether a CMK is symmetric or asymmetric, see Identifying Symmetric and Asymmetric CMKs in the AWS Key Management Service Developer Guide.

    AWS KMS supports the following key specs for CMKs:

    • Symmetric key (default)

      • SYMMETRIC_DEFAULT (AES-256-GCM)

      ^

    • Asymmetric RSA key pairs

      • RSA_2048

      • RSA_3072

      • RSA_4096

    • Asymmetric NIST-recommended elliptic curve key pairs

      • ECC_NIST_P256 (secp256r1)

      • ECC_NIST_P384 (secp384r1)

      • ECC_NIST_P521 (secp521r1)

    • Other asymmetric elliptic curve key pairs

      • ECC_SECG_P256K1 (secp256k1), commonly used for cryptocurrencies.

      ^

  • :origin (String) —

    The source of the key material for the CMK. You cannot change the origin after you create the CMK. The default is AWS_KMS, which means AWS KMS creates the key material.

    When the parameter value is EXTERNAL, AWS KMS creates a CMK without key material so that you can import key material from your existing key management infrastructure. For more information about importing key material into AWS KMS, see Importing Key Material in the AWS Key Management Service Developer Guide. This value is valid only for symmetric CMKs.

    When the parameter value is AWS_CLOUDHSM, AWS KMS creates the CMK in an AWS KMS custom key store and creates its key material in the associated AWS CloudHSM cluster. You must also use the CustomKeyStoreId parameter to identify the custom key store. This value is valid only for symmetric CMKs.

  • :custom_key_store_id (String) —

    Creates the CMK in the specified custom key store and the key material in its associated AWS CloudHSM cluster. To create a CMK in a custom key store, you must also specify the Origin parameter with a value of AWS_CLOUDHSM. The AWS CloudHSM cluster that is associated with the custom key store must have at least two active HSMs, each in a different Availability Zone in the Region.

    This parameter is valid only for symmetric CMKs. You cannot create an asymmetric CMK in a custom key store.

    To find the ID of a custom key store, use the DescribeCustomKeyStores operation.

    The response includes the custom key store ID and the ID of the AWS CloudHSM cluster.

    This operation is part of the Custom Key Store feature feature in AWS KMS, which combines the convenience and extensive integration of AWS KMS with the isolation and control of a single-tenant key store.

  • :bypass_policy_lockout_safety_check (Boolean) —

    A flag to indicate whether to bypass the key policy lockout safety check.

    Setting this value to true increases the risk that the CMK becomes unmanageable. Do not set this value to true indiscriminately.

    For more information, refer to the scenario in the Default Key Policy section in the AWS Key Management Service Developer Guide .

    Use this parameter only when you include a policy in the request and you intend to prevent the principal that is making the request from making a subsequent PutKeyPolicy request on the CMK.

    The default value is false.

  • :tags (Array<Types::Tag>) —

    One or more tags. Each tag consists of a tag key and a tag value. Both the tag key and the tag value are required, but the tag value can be an empty (null) string.

    When you add tags to an AWS resource, AWS generates a cost allocation report with usage and costs aggregated by tags. For information about adding, changing, deleting and listing tags for CMKs, see Tagging Keys.

    Use this parameter to tag the CMK when it is created. To add tags to an existing CMK, use the TagResource operation.

Returns:

See Also:



1259
1260
1261
1262
 
# File 'gems/aws-sdk-kms/lib/aws-sdk-kms/client.rb', line 1259

def create_key(params = {}, options = {})
  req = build_request(:create_key, params)
  req.send_request(options)
end

#decrypt(params = {}) ⇒ Types::DecryptResponse

Decrypts ciphertext that was encrypted by a AWS KMS customer master key (CMK) using any of the following operations:

  • Encrypt

  • GenerateDataKey

  • GenerateDataKeyPair

  • GenerateDataKeyWithoutPlaintext

  • GenerateDataKeyPairWithoutPlaintext

You can use this operation to decrypt ciphertext that was encrypted under a symmetric or asymmetric CMK. When the CMK is asymmetric, you must specify the CMK and the encryption algorithm that was used to encrypt the ciphertext. For information about symmetric and asymmetric CMKs, see Using Symmetric and Asymmetric CMKs in the AWS Key Management Service Developer Guide.

The Decrypt operation also decrypts ciphertext that was encrypted outside of AWS KMS by the public key in an AWS KMS asymmetric CMK. However, it cannot decrypt ciphertext produced by other libraries, such as the AWS Encryption SDK or Amazon S3 client-side encryption. These libraries return a ciphertext format that is incompatible with AWS KMS.

If the ciphertext was encrypted under a symmetric CMK, you do not need to specify the CMK or the encryption algorithm. AWS KMS can get this information from metadata that it adds to the symmetric ciphertext blob. However, if you prefer, you can specify the KeyId to ensure that a particular CMK is used to decrypt the ciphertext. If you specify a different CMK than the one used to encrypt the ciphertext, the Decrypt operation fails.

Whenever possible, use key policies to give users permission to call the Decrypt operation on a particular CMK, instead of using IAM policies. Otherwise, you might create an IAM user policy that gives the user Decrypt permission on all CMKs. This user could decrypt ciphertext that was encrypted by CMKs in other accounts if the key policy for the cross-account CMK permits it. If you must use an IAM policy for Decrypt permissions, limit the user to particular CMKs or particular trusted accounts.

The CMK that you use for this operation must be in a compatible key state. For details, see How Key State Affects Use of a Customer Master Key in the AWS Key Management Service Developer Guide.

Examples:

Example: To decrypt data


# The following example decrypts data that was encrypted with a customer master key (CMK) in AWS KMS.

resp = client.decrypt({
  ciphertext_blob: "<binary data>", # The encrypted data (ciphertext).
})

resp.to_h outputs the following:
{
  key_id: "arn:aws:kms:us-west-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab", # The Amazon Resource Name (ARN) of the CMK that was used to decrypt the data.
  plaintext: "<binary data>", # The decrypted (plaintext) data.
}

Request syntax with placeholder values


resp = client.decrypt({
  ciphertext_blob: "data", # required
  encryption_context: {
    "EncryptionContextKey" => "EncryptionContextValue",
  },
  grant_tokens: ["GrantTokenType"],
  key_id: "KeyIdType",
  encryption_algorithm: "SYMMETRIC_DEFAULT", # accepts SYMMETRIC_DEFAULT, RSAES_OAEP_SHA_1, RSAES_OAEP_SHA_256
})

Response structure


resp.key_id #=> String
resp.plaintext #=> String
resp.encryption_algorithm #=> String, one of "SYMMETRIC_DEFAULT", "RSAES_OAEP_SHA_1", "RSAES_OAEP_SHA_256"

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :ciphertext_blob (required, String, IO) —

    Ciphertext to be decrypted. The blob includes metadata.

  • :encryption_context (Hash<String,String>) —

    Specifies the encryption context to use when decrypting the data. An encryption context is valid only for cryptographic operations with a symmetric CMK. The standard asymmetric encryption algorithms that AWS KMS uses do not support an encryption context.

    An encryption context is a collection of non-secret key-value pairs that represents additional authenticated data. When you use an encryption context to encrypt data, you must specify the same (an exact case-sensitive match) encryption context to decrypt the data. An encryption context is optional when encrypting with a symmetric CMK, but it is highly recommended.

    For more information, see Encryption Context in the AWS Key Management Service Developer Guide.

  • :grant_tokens (Array<String>) —

    A list of grant tokens.

    For more information, see Grant Tokens in the AWS Key Management Service Developer Guide.

  • :key_id (String) —

    Specifies the customer master key (CMK) that AWS KMS will use to decrypt the ciphertext. Enter a key ID of the CMK that was used to encrypt the ciphertext.

    If you specify a KeyId value, the Decrypt operation succeeds only if the specified CMK was used to encrypt the ciphertext.

    This parameter is required only when the ciphertext was encrypted under an asymmetric CMK. Otherwise, AWS KMS uses the metadata that it adds to the ciphertext blob to determine which CMK was used to encrypt the ciphertext. However, you can use this parameter to ensure that a particular CMK (of any kind) is used to decrypt the ciphertext.

    To specify a CMK, use its key ID, Amazon Resource Name (ARN), alias name, or alias ARN. When using an alias name, prefix it with "alias/".

    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

    To get the key ID and key ARN for a CMK, use ListKeys or DescribeKey. To get the alias name and alias ARN, use ListAliases.

  • :encryption_algorithm (String) —

    Specifies the encryption algorithm that will be used to decrypt the ciphertext. Specify the same algorithm that was used to encrypt the data. If you specify a different algorithm, the Decrypt operation fails.

    This parameter is required only when the ciphertext was encrypted under an asymmetric CMK. The default value, SYMMETRIC_DEFAULT, represents the only supported algorithm that is valid for symmetric CMKs.

Returns:

See Also:



1439
1440
1441
1442
 
# File 'gems/aws-sdk-kms/lib/aws-sdk-kms/client.rb', line 1439

def decrypt(params = {}, options = {})
  req = build_request(:decrypt, params)
  req.send_request(options)
end

#delete_alias(params = {}) ⇒ Struct

Deletes the specified alias. You cannot perform this operation on an alias in a different AWS account.

Because an alias is not a property of a CMK, you can delete and change the aliases of a CMK without affecting the CMK. Also, aliases do not appear in the response from the DescribeKey operation. To get the aliases of all CMKs, use the ListAliases operation.

Each CMK can have multiple aliases. To change the alias of a CMK, use DeleteAlias to delete the current alias and CreateAlias to create a new alias. To associate an existing alias with a different customer master key (CMK), call UpdateAlias.

Examples:

Example: To delete an alias


# The following example deletes the specified alias.

resp = client.delete_alias({
  alias_name: "alias/ExampleAlias", # The alias to delete.
})

Request syntax with placeholder values


resp = client.delete_alias({
  alias_name: "AliasNameType", # required
})

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :alias_name (required, String) —

    The alias to be deleted. The alias name must begin with alias/ followed by the alias name, such as alias/ExampleAlias.

Returns:

  • (Struct) —

    Returns an empty response.

See Also:



1482
1483
1484
1485
 
# File 'gems/aws-sdk-kms/lib/aws-sdk-kms/client.rb', line 1482

def delete_alias(params = {}, options = {})
  req = build_request(:delete_alias, params)
  req.send_request(options)
end

#delete_custom_key_store(params = {}) ⇒ Struct

Deletes a custom key store. This operation does not delete the AWS CloudHSM cluster that is associated with the custom key store, or affect any users or keys in the cluster.

The custom key store that you delete cannot contain any AWS KMS customer master keys (CMKs). Before deleting the key store, verify that you will never need to use any of the CMKs in the key store for any cryptographic operations. Then, use ScheduleKeyDeletion to delete the AWS KMS customer master keys (CMKs) from the key store. When the scheduled waiting period expires, the ScheduleKeyDeletion operation deletes the CMKs. Then it makes a best effort to delete the key material from the associated cluster. However, you might need to manually delete the orphaned key material from the cluster and its backups.

After all CMKs are deleted from AWS KMS, use DisconnectCustomKeyStore to disconnect the key store from AWS KMS. Then, you can delete the custom key store.

Instead of deleting the custom key store, consider using DisconnectCustomKeyStore to disconnect it from AWS KMS. While the key store is disconnected, you cannot create or use the CMKs in the key store. But, you do not need to delete CMKs and you can reconnect a disconnected custom key store at any time.

If the operation succeeds, it returns a JSON object with no properties.

This operation is part of the Custom Key Store feature feature in AWS KMS, which combines the convenience and extensive integration of AWS KMS with the isolation and control of a single-tenant key store.

Examples:

Request syntax with placeholder values


resp = client.delete_custom_key_store({
  custom_key_store_id: "CustomKeyStoreIdType", # required
})

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :custom_key_store_id (required, String) —

    Enter the ID of the custom key store you want to delete. To find the ID of a custom key store, use the DescribeCustomKeyStores operation.

Returns:

  • (Struct) —

    Returns an empty response.

See Also:



1542
1543
1544
1545
 
# File 'gems/aws-sdk-kms/lib/aws-sdk-kms/client.rb', line 1542

def delete_custom_key_store(params = {}, options = {})
  req = build_request(:delete_custom_key_store, params)
  req.send_request(options)
end

#delete_imported_key_material(params = {}) ⇒ Struct

Deletes key material that you previously imported. This operation makes the specified customer master key (CMK) unusable. For more information about importing key material into AWS KMS, see Importing Key Material in the AWS Key Management Service Developer Guide. You cannot perform this operation on a CMK in a different AWS account.

When the specified CMK is in the PendingDeletion state, this operation does not change the CMK's state. Otherwise, it changes the CMK's state to PendingImport.

After you delete key material, you can use ImportKeyMaterial to reimport the same key material into the CMK.

The CMK that you use for this operation must be in a compatible key state. For details, see How Key State Affects Use of a Customer Master Key in the AWS Key Management Service Developer Guide.

Examples:

Example: To delete imported key material


# The following example deletes the imported key material from the specified customer master key (CMK).

resp = client.delete_imported_key_material({
  key_id: "1234abcd-12ab-34cd-56ef-1234567890ab", # The identifier of the CMK whose imported key material you are deleting. You can use the key ID or the Amazon Resource Name (ARN) of the CMK.
})

Request syntax with placeholder values


resp = client.delete_imported_key_material({
  key_id: "KeyIdType", # required
})

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :key_id (required, String) —

    Identifies the CMK from which you are deleting imported key material. The Origin of the CMK must be EXTERNAL.

    Specify the key ID or the Amazon Resource Name (ARN) of the CMK.

    For example:

    • Key ID: 1234abcd-12ab-34cd-56ef-1234567890ab

    • Key ARN: arn:aws:kms:us-east-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab

    To get the key ID and key ARN for a CMK, use ListKeys or DescribeKey.

Returns:

  • (Struct) —

    Returns an empty response.

See Also:



1605
1606
1607
1608
 
# File 'gems/aws-sdk-kms/lib/aws-sdk-kms/client.rb', line 1605

def delete_imported_key_material(params = {}, options = {})
  req = build_request(:delete_imported_key_material, params)
  req.send_request(options)
end

#describe_custom_key_stores(params = {}) ⇒ Types::DescribeCustomKeyStoresResponse

Gets information about custom key stores in the account and region.

This operation is part of the Custom Key Store feature feature in AWS KMS, which combines the convenience and extensive integration of AWS KMS with the isolation and control of a single-tenant key store.

By default, this operation returns information about all custom key stores in the account and region. To get only information about a particular custom key store, use either the CustomKeyStoreName or CustomKeyStoreId parameter (but not both).

To determine whether the custom key store is connected to its AWS CloudHSM cluster, use the ConnectionState element in the response. If an attempt to connect the custom key store failed, the ConnectionState value is FAILED and the ConnectionErrorCode element in the response indicates the cause of the failure. For help interpreting the ConnectionErrorCode, see CustomKeyStoresListEntry.

Custom key stores have a DISCONNECTED connection state if the key store has never been connected or you use the DisconnectCustomKeyStore operation to disconnect it. If your custom key store state is CONNECTED but you are having trouble using it, make sure that its associated AWS CloudHSM cluster is active and contains the minimum number of HSMs required for the operation, if any.

For help repairing your custom key store, see the Troubleshooting Custom Key Stores topic in the AWS Key Management Service Developer Guide.

Examples:

Request syntax with placeholder values


resp = client.describe_custom_key_stores({
  custom_key_store_id: "CustomKeyStoreIdType",
  custom_key_store_name: "CustomKeyStoreNameType",
  limit: 1,
  marker: "MarkerType",
})

Response structure


resp.custom_key_stores #=> Array
resp.custom_key_stores[0].custom_key_store_id #=> String
resp.custom_key_stores[0].custom_key_store_name #=> String
resp.custom_key_stores[0].cloud_hsm_cluster_id #=> String
resp.custom_key_stores[0].trust_anchor_certificate #=> String
resp.custom_key_stores[0].connection_state #=> String, one of "CONNECTED", "CONNECTING", "FAILED", "DISCONNECTED", "DISCONNECTING"
resp.custom_key_stores[0].connection_error_code #=> String, one of "INVALID_CREDENTIALS", "CLUSTER_NOT_FOUND", "NETWORK_ERRORS", "INTERNAL_ERROR", "INSUFFICIENT_CLOUDHSM_HSMS", "USER_LOCKED_OUT", "USER_NOT_FOUND", "USER_LOGGED_IN", "SUBNET_NOT_FOUND"
resp.custom_key_stores[0].creation_date #=> Time
resp.next_marker #=> String
resp.truncated #=> Boolean

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :custom_key_store_id (String) —

    Gets only information about the specified custom key store. Enter the key store ID.

    By default, this operation gets information about all custom key stores in the account and region. To limit the output to a particular custom key store, you can use either the CustomKeyStoreId or CustomKeyStoreName parameter, but not both.

  • :custom_key_store_name (String) —

    Gets only information about the specified custom key store. Enter the friendly name of the custom key store.

    By default, this operation gets information about all custom key stores in the account and region. To limit the output to a particular custom key store, you can use either the CustomKeyStoreId or CustomKeyStoreName parameter, but not both.

  • :limit (Integer) —

    Use this parameter to specify the maximum number of items to return. When this value is present, AWS KMS does not return more than the specified number of items, but it might return fewer.

  • :marker (String) —

    Use this parameter in a subsequent request after you receive a response with truncated results. Set it to the value of NextMarker from the truncated response you just received.

Returns:

See Also:



1705
1706
1707
1708
 
# File 'gems/aws-sdk-kms/lib/aws-sdk-kms/client.rb', line 1705

def describe_custom_key_stores(params = {}, options = {})
  req = build_request(:describe_custom_key_stores, params)
  req.send_request(options)
end

#describe_key(params = {}) ⇒ Types::DescribeKeyResponse

Provides detailed information about a customer master key (CMK). You can run DescribeKey on a customer managed CMK or an AWS managed CMK.

This detailed information includes the key ARN, creation date (and deletion date, if applicable), the key state, and the origin and expiration date (if any) of the key material. For CMKs in custom key stores, it includes information about the custom key store, such as the key store ID and the AWS CloudHSM cluster ID. It includes fields, like KeySpec, that help you distinguish symmetric from asymmetric CMKs. It also provides information that is particularly important to asymmetric CMKs, such as the key usage (encryption or signing) and the encryption algorithms or signing algorithms that the CMK supports.

DescribeKey does not return the following information:

  • Aliases associated with the CMK. To get this information, use ListAliases.

  • Whether automatic key rotation is enabled on the CMK. To get this information, use GetKeyRotationStatus. Also, some key states prevent a CMK from being automatically rotated. For details, see How Automatic Key Rotation Works in AWS Key Management Service Developer Guide.

  • Tags on the CMK. To get this information, use ListResourceTags.

  • Key policies and grants on the CMK. To get this information, use GetKeyPolicy and ListGrants.

If you call the DescribeKey operation on a predefined AWS alias, that is, an AWS alias with no key ID, AWS KMS creates an AWS managed CMK. Then, it associates the alias with the new CMK, and returns the KeyId and Arn of the new CMK in the response.

To perform this operation on a CMK in a different AWS account, specify the key ARN or alias ARN in the value of the KeyId parameter.

Examples:

Example: To obtain information about a customer master key (CMK)


# The following example returns information (metadata) about the specified CMK.

resp = client.describe_key({
  key_id: "1234abcd-12ab-34cd-56ef-1234567890ab", # The identifier of the CMK that you want information about. You can use the key ID or the Amazon Resource Name (ARN) of the CMK.
})

resp.to_h outputs the following:
{
  key_metadata: {
    aws_account_id: "111122223333", 
    arn: "arn:aws:kms:us-east-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab", 
    creation_date: Time.parse("2017-07-05T14:04:55-07:00"), 
    description: "", 
    enabled: true, 
    key_id: "1234abcd-12ab-34cd-56ef-1234567890ab", 
    key_manager: "CUSTOMER", 
    key_state: "Enabled", 
    key_usage: "ENCRYPT_DECRYPT", 
    origin: "AWS_KMS", 
  }, # An object that contains information about the specified CMK.
}

Request syntax with placeholder values


resp = client.describe_key({
  key_id: "KeyIdType", # required
  grant_tokens: ["GrantTokenType"],
})

Response structure


resp.key_metadata. #=> String
resp.key_metadata.key_id #=> String
resp.key_metadata.arn #=> String
resp.key_metadata.creation_date #=> Time
resp.key_metadata.enabled #=> Boolean
resp.key_metadata.description #=> String
resp.key_metadata.key_usage #=> String, one of "SIGN_VERIFY", "ENCRYPT_DECRYPT"
resp.key_metadata.key_state #=> String, one of "Enabled", "Disabled", "PendingDeletion", "PendingImport", "Unavailable"
resp.key_metadata.deletion_date #=> Time
resp.key_metadata.valid_to #=> Time
resp.key_metadata.origin #=> String, one of "AWS_KMS", "EXTERNAL", "AWS_CLOUDHSM"
resp.key_metadata.custom_key_store_id #=> String
resp.key_metadata.cloud_hsm_cluster_id #=> String
resp.key_metadata.expiration_model #=> String, one of "KEY_MATERIAL_EXPIRES", "KEY_MATERIAL_DOES_NOT_EXPIRE"
resp.key_metadata.key_manager #=> String, one of "AWS", "CUSTOMER"
resp.key_metadata.customer_master_key_spec #=> String, one of "RSA_2048", "RSA_3072", "RSA_4096", "ECC_NIST_P256", "ECC_NIST_P384", "ECC_NIST_P521", "ECC_SECG_P256K1", "SYMMETRIC_DEFAULT"
resp.key_metadata.encryption_algorithms #=> Array
resp.key_metadata.encryption_algorithms[0] #=> String, one of "SYMMETRIC_DEFAULT", "RSAES_OAEP_SHA_1", "RSAES_OAEP_SHA_256"
resp.key_metadata.signing_algorithms #=> Array
resp.key_metadata.signing_algorithms[0] #=> String, one of "RSASSA_PSS_SHA_256", "RSASSA_PSS_SHA_384", "RSASSA_PSS_SHA_512", "RSASSA_PKCS1_V1_5_SHA_256", "RSASSA_PKCS1_V1_5_SHA_384", "RSASSA_PKCS1_V1_5_SHA_512", "ECDSA_SHA_256", "ECDSA_SHA_384", "ECDSA_SHA_512"

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :key_id (required, String) —

    Describes the specified customer master key (CMK).

    If you specify a predefined AWS alias (an AWS alias with no key ID), KMS associates the alias with an AWS managed CMK and returns its KeyId and Arn in the response.

    To specify a CMK, 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 CMK in a different AWS 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

    To get the key ID and key ARN for a CMK, use ListKeys or DescribeKey. To get the alias name and alias ARN, use ListAliases.

  • :grant_tokens (Array<String>) —

    A list of grant tokens.

    For more information, see Grant Tokens in the AWS Key Management Service Developer Guide.

Returns:

See Also:



1858
1859
1860
1861
 
# File 'gems/aws-sdk-kms/lib/aws-sdk-kms/client.rb', line 1858

def describe_key(params = {}, options = {})
  req = build_request(:describe_key, params)
  req.send_request(options)
end

#disable_key(params = {}) ⇒ Struct

Sets the state of a customer master key (CMK) to disabled, thereby preventing its use for cryptographic operations. You cannot perform this operation on a CMK in a different AWS account.

For more information about how key state affects the use of a CMK, see How Key State Affects the Use of a Customer Master Key in the AWS Key Management Service Developer Guide .

The CMK that you use for this operation must be in a compatible key state. For details, see How Key State Affects Use of a Customer Master Key in the AWS Key Management Service Developer Guide.

Examples:

Example: To disable a customer master key (CMK)


# The following example disables the specified CMK.

resp = client.disable_key({
  key_id: "1234abcd-12ab-34cd-56ef-1234567890ab", # The identifier of the CMK to disable. You can use the key ID or the Amazon Resource Name (ARN) of the CMK.
})

Request syntax with placeholder values


resp = client.disable_key({
  key_id: "KeyIdType", # required
})

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :key_id (required, String) —

    A unique identifier for the customer master key (CMK).

    Specify the key ID or the Amazon Resource Name (ARN) of the CMK.

    For example:

    • Key ID: 1234abcd-12ab-34cd-56ef-1234567890ab

    • Key ARN: arn:aws:kms:us-east-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab

    To get the key ID and key ARN for a CMK, use ListKeys or DescribeKey.

Returns:

  • (Struct) —

    Returns an empty response.

See Also:



1915
1916
1917
1918
 
# File 'gems/aws-sdk-kms/lib/aws-sdk-kms/client.rb', line 1915

def disable_key(params = {}, options = {})
  req = build_request(:disable_key, params)
  req.send_request(options)
end

#disable_key_rotation(params = {}) ⇒ Struct

Disables automatic rotation of the key material for the specified symmetric customer master key (CMK).

You cannot enable automatic rotation of asymmetric CMKs, CMKs with imported key material, or CMKs in a custom key store. You cannot perform this operation on a CMK in a different AWS account.

The CMK that you use for this operation must be in a compatible key state. For details, see How Key State Affects Use of a Customer Master Key in the AWS Key Management Service Developer Guide.

Examples:

Example: To disable automatic rotation of key material


# The following example disables automatic annual rotation of the key material for the specified CMK.

resp = client.disable_key_rotation({
  key_id: "1234abcd-12ab-34cd-56ef-1234567890ab", # The identifier of the CMK whose key material will no longer be rotated. You can use the key ID or the Amazon Resource Name (ARN) of the CMK.
})

Request syntax with placeholder values


resp = client.disable_key_rotation({
  key_id: "KeyIdType", # required
})

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :key_id (required, String) —

    Identifies a symmetric customer master key (CMK). You cannot enable automatic rotation of asymmetric CMKs, CMKs with imported key material, or CMKs in a custom key store.

    Specify the key ID or the Amazon Resource Name (ARN) of the CMK.

    For example:

    • Key ID: 1234abcd-12ab-34cd-56ef-1234567890ab

    • Key ARN: arn:aws:kms:us-east-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab

    To get the key ID and key ARN for a CMK, use ListKeys or DescribeKey.

Returns:

  • (Struct) —

    Returns an empty response.

See Also:



1980
1981
1982
1983
 
# File 'gems/aws-sdk-kms/lib/aws-sdk-kms/client.rb', line 1980

def disable_key_rotation(params = {}, options = {})
  req = build_request(:disable_key_rotation, params)
  req.send_request(options)
end

#disconnect_custom_key_store(params = {}) ⇒ Struct

Disconnects the custom key store from its associated AWS CloudHSM cluster. While a custom key store is disconnected, you can manage the custom key store and its customer master keys (CMKs), but you cannot create or use CMKs in the custom key store. You can reconnect the custom key store at any time.

While a custom key store is disconnected, all attempts to create customer master keys (CMKs) in the custom key store or to use existing CMKs in cryptographic operations will fail. This action can prevent users from storing and accessing sensitive data.

To find the connection state of a custom key store, use the DescribeCustomKeyStores operation. To reconnect a custom key store, use the ConnectCustomKeyStore operation.

If the operation succeeds, it returns a JSON object with no properties.

This operation is part of the Custom Key Store feature feature in AWS KMS, which combines the convenience and extensive integration of AWS KMS with the isolation and control of a single-tenant key store.

Examples:

Request syntax with placeholder values


resp = client.disconnect_custom_key_store({
  custom_key_store_id: "CustomKeyStoreIdType", # required
})

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :custom_key_store_id (required, String) —

    Enter the ID of the custom key store you want to disconnect. To find the ID of a custom key store, use the DescribeCustomKeyStores operation.

Returns:

  • (Struct) —

    Returns an empty response.

See Also:



2033
2034
2035
2036
 
# File 'gems/aws-sdk-kms/lib/aws-sdk-kms/client.rb', line 2033

def disconnect_custom_key_store(params = {}, options = {})
  req = build_request(:disconnect_custom_key_store, params)
  req.send_request(options)
end

#enable_key(params = {}) ⇒ Struct

Sets the key state of a customer master key (CMK) to enabled. This allows you to use the CMK for cryptographic operations. You cannot perform this operation on a CMK in a different AWS account.

The CMK that you use for this operation must be in a compatible key state. For details, see How Key State Affects Use of a Customer Master Key in the AWS Key Management Service Developer Guide.

Examples:

Example: To enable a customer master key (CMK)


# The following example enables the specified CMK.

resp = client.enable_key({
  key_id: "1234abcd-12ab-34cd-56ef-1234567890ab", # The identifier of the CMK to enable. You can use the key ID or the Amazon Resource Name (ARN) of the CMK.
})

Request syntax with placeholder values


resp = client.enable_key({
  key_id: "KeyIdType", # required
})

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :key_id (required, String) —

    A unique identifier for the customer master key (CMK).

    Specify the key ID or the Amazon Resource Name (ARN) of the CMK.

    For example:

    • Key ID: 1234abcd-12ab-34cd-56ef-1234567890ab

    • Key ARN: arn:aws:kms:us-east-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab

    To get the key ID and key ARN for a CMK, use ListKeys or DescribeKey.

Returns:

  • (Struct) —

    Returns an empty response.

See Also:



2086
2087
2088
2089
 
# File 'gems/aws-sdk-kms/lib/aws-sdk-kms/client.rb', line 2086

def enable_key(params = {}, options = {})
  req = build_request(:enable_key, params)
  req.send_request(options)
end

#enable_key_rotation(params = {}) ⇒ Struct

Enables automatic rotation of the key material for the specified symmetric customer master key (CMK). You cannot perform this operation on a CMK in a different AWS account.

You cannot enable automatic rotation of asymmetric CMKs, CMKs with imported key material, or CMKs in a custom key store.

The CMK that you use for this operation must be in a compatible key state. For details, see How Key State Affects Use of a Customer Master Key in the AWS Key Management Service Developer Guide.

Examples:

Example: To enable automatic rotation of key material


# The following example enables automatic annual rotation of the key material for the specified CMK.

resp = client.enable_key_rotation({
  key_id: "1234abcd-12ab-34cd-56ef-1234567890ab", # The identifier of the CMK whose key material will be rotated annually. You can use the key ID or the Amazon Resource Name (ARN) of the CMK.
})

Request syntax with placeholder values


resp = client.enable_key_rotation({
  key_id: "KeyIdType", # required
})

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :key_id (required, String) —

    Identifies a symmetric customer master key (CMK). You cannot enable automatic rotation of asymmetric CMKs, CMKs with imported key material, or CMKs in a custom key store.

    Specify the key ID or the Amazon Resource Name (ARN) of the CMK.

    For example:

    • Key ID: 1234abcd-12ab-34cd-56ef-1234567890ab

    • Key ARN: arn:aws:kms:us-east-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab

    To get the key ID and key ARN for a CMK, use ListKeys or DescribeKey.

Returns:

  • (Struct) —

    Returns an empty response.

See Also:



2149
2150
2151
2152
 
# File 'gems/aws-sdk-kms/lib/aws-sdk-kms/client.rb', line 2149

def enable_key_rotation(params = {}, options = {})
  req = build_request(:enable_key_rotation, params)
  req.send_request(options)
end

#encrypt(params = {}) ⇒ Types::EncryptResponse

Encrypts plaintext into ciphertext by using a customer master key (CMK). The Encrypt operation has two primary use cases:

  • You can encrypt small amounts of arbitrary data, such as a personal identifier or database password, or other sensitive information.

  • You can use the Encrypt operation to move encrypted data from one AWS Region to another. For example, in Region A, generate a data key and use the plaintext key to encrypt your data. Then, in Region A, use the Encrypt operation to encrypt the plaintext data key under a CMK in Region B. Now, you can move the encrypted data and the encrypted data key to Region B. When necessary, you can decrypt the encrypted data key and the encrypted data entirely within in Region

You don't need to use the Encrypt operation to encrypt a data key. The GenerateDataKey and GenerateDataKeyPair operations return a plaintext data key and an encrypted copy of that data key.

When you encrypt data, you must specify a symmetric or asymmetric CMK to use in the encryption operation. The CMK must have a KeyUsage value of ENCRYPT_DECRYPT. To find the KeyUsage of a CMK, use the DescribeKey operation.

If you use a symmetric CMK, you can use an encryption context to add additional security to your encryption operation. If you specify an EncryptionContext when encrypting data, you must specify the same encryption context (a case-sensitive exact match) when decrypting the data. Otherwise, the request to decrypt fails with an InvalidCiphertextException. For more information, see Encryption Context in the AWS Key Management Service Developer Guide.

If you specify an asymmetric CMK, you must also specify the encryption algorithm. The algorithm must be compatible with the CMK type.

When you use an asymmetric CMK to encrypt or reencrypt data, be sure to record the CMK and encryption algorithm that you choose. You will be required to provide the same CMK and encryption algorithm when you decrypt the data. If the CMK and algorithm do not match the values used to encrypt the data, the decrypt operation fails.

You are not required to supply the CMK ID and encryption algorithm when you decrypt with symmetric CMKs because AWS KMS stores this information in the ciphertext blob. AWS KMS cannot store metadata in ciphertext generated with asymmetric keys. The standard format for asymmetric key ciphertext does not include configurable fields.

The maximum size of the data that you can encrypt varies with the type of CMK and the encryption algorithm that you choose.

  • Symmetric CMKs

    • SYMMETRIC_DEFAULT: 4096 bytes

    ^

  • RSA_2048

    • RSAES_OAEP_SHA_1: 214 bytes

    • RSAES_OAEP_SHA_256: 190 bytes

  • RSA_3072

    • RSAES_OAEP_SHA_1: 342 bytes

    • RSAES_OAEP_SHA_256: 318 bytes

  • RSA_4096

    • RSAES_OAEP_SHA_1: 470 bytes

    • RSAES_OAEP_SHA_256: 446 bytes

The CMK that you use for this operation must be in a compatible key state. For details, see How Key State Affects Use of a Customer Master Key in the AWS Key Management Service Developer Guide.

To perform this operation on a CMK in a different AWS account, specify the key ARN or alias ARN in the value of the KeyId parameter.

Examples:

Example: To encrypt data


# The following example encrypts data with the specified customer master key (CMK).

resp = client.encrypt({
  key_id: "1234abcd-12ab-34cd-56ef-1234567890ab", # The identifier of the CMK to use for encryption. You can use the key ID or Amazon Resource Name (ARN) of the CMK, or the name or ARN of an alias that refers to the CMK.
  plaintext: "<binary data>", # The data to encrypt.
})

resp.to_h outputs the following:
{
  ciphertext_blob: "<binary data>", # The encrypted data (ciphertext).
  key_id: "arn:aws:kms:us-west-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab", # The ARN of the CMK that was used to encrypt the data.
}

Request syntax with placeholder values


resp = client.encrypt({
  key_id: "KeyIdType", # required
  plaintext: "data", # required
  encryption_context: {
    "EncryptionContextKey" => "EncryptionContextValue",
  },
  grant_tokens: ["GrantTokenType"],
  encryption_algorithm: "SYMMETRIC_DEFAULT", # accepts SYMMETRIC_DEFAULT, RSAES_OAEP_SHA_1, RSAES_OAEP_SHA_256
})

Response structure


resp.ciphertext_blob #=> String
resp.key_id #=> String
resp.encryption_algorithm #=> String, one of "SYMMETRIC_DEFAULT", "RSAES_OAEP_SHA_1", "RSAES_OAEP_SHA_256"

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :key_id (required, String) —

    A unique identifier for the customer master key (CMK).

    To specify a CMK, 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 CMK in a different AWS 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

    To get the key ID and key ARN for a CMK, use ListKeys or DescribeKey. To get the alias name and alias ARN, use ListAliases.

  • :plaintext (required, String, IO) —

    Data to be encrypted.

  • :encryption_context (Hash<String,String>) —

    Specifies the encryption context that will be used to encrypt the data. An encryption context is valid only for cryptographic operations with a symmetric CMK. The standard asymmetric encryption algorithms that AWS KMS uses do not support an encryption context.

    An encryption context is a collection of non-secret key-value pairs that represents additional authenticated data. When you use an encryption context to encrypt data, you must specify the same (an exact case-sensitive match) encryption context to decrypt the data. An encryption context is optional when encrypting with a symmetric CMK, but it is highly recommended.

    For more information, see Encryption Context in the AWS Key Management Service Developer Guide.

  • :grant_tokens (Array<String>) —

    A list of grant tokens.

    For more information, see Grant Tokens in the AWS Key Management Service Developer Guide.

  • :encryption_algorithm (String) —

    Specifies the encryption algorithm that AWS KMS will use to encrypt the plaintext message. The algorithm must be compatible with the CMK that you specify.

    This parameter is required only for asymmetric CMKs. The default value, SYMMETRIC_DEFAULT, is the algorithm used for symmetric CMKs. If you are using an asymmetric CMK, we recommend RSAES_OAEP_SHA_256.

Returns:

See Also:



2351
2352
2353
2354
 
# File 'gems/aws-sdk-kms/lib/aws-sdk-kms/client.rb', line 2351

def encrypt(params = {}, options = {})
  req = build_request(:encrypt, params)
  req.send_request(options)
end

#generate_data_key(params = {}) ⇒ Types::GenerateDataKeyResponse

Generates a unique symmetric data key for client-side encryption. This operation returns a plaintext copy of the data key and a copy that is encrypted under a customer master key (CMK) that you specify. You can use the plaintext key to encrypt your data outside of AWS KMS and store the encrypted data key with the encrypted data.

GenerateDataKey returns a unique data key for each request. The bytes in the plaintext key are not related to the caller or the CMK.

To generate a data key, specify the symmetric CMK that will be used to encrypt the data key. You cannot use an asymmetric CMK to generate data keys. To get the type of your CMK, use the DescribeKey operation. You must also specify the length of the data key. Use either the KeySpec or NumberOfBytes parameters (but not both). For 128-bit and 256-bit data keys, use the KeySpec parameter.

To get only an encrypted copy of the data key, use GenerateDataKeyWithoutPlaintext. To generate an asymmetric data key pair, use the GenerateDataKeyPair or GenerateDataKeyPairWithoutPlaintext operation. To get a cryptographically secure random byte string, use GenerateRandom.

You can use the optional encryption context to add additional security to the encryption operation. If you specify an EncryptionContext, you must specify the same encryption context (a case-sensitive exact match) when decrypting the encrypted data key. Otherwise, the request to decrypt fails with an InvalidCiphertextException. For more information, see Encryption Context in the AWS Key Management Service Developer Guide.

The CMK that you use for this operation must be in a compatible key state. For details, see How Key State Affects Use of a Customer Master Key in the AWS Key Management Service Developer Guide.

How to use your data key

We recommend that you use the following pattern to encrypt data locally in your application. You can write your own code or use a client-side encryption library, such as the AWS Encryption SDK, the Amazon DynamoDB Encryption Client, or Amazon S3 client-side encryption to do these tasks for you.

To encrypt data outside of AWS KMS:

  1. Use the GenerateDataKey operation to get a data key.

  2. Use the plaintext data key (in the Plaintext field of the response) to encrypt your data outside of AWS KMS. Then erase the plaintext data key from memory.

  3. Store the encrypted data key (in the CiphertextBlob field of the response) with the encrypted data.

To decrypt data outside of AWS KMS:

  1. Use the Decrypt operation to decrypt the encrypted data key. The operation returns a plaintext copy of the data key.

  2. Use the plaintext data key to decrypt data outside of AWS KMS, then erase the plaintext data key from memory.

Examples:

Example: To generate a data key


# The following example generates a 256-bit symmetric data encryption key (data key) in two formats. One is the
# unencrypted (plainext) data key, and the other is the data key encrypted with the specified customer master key (CMK).

resp = client.generate_data_key({
  key_id: "alias/ExampleAlias", # The identifier of the CMK to use to encrypt the data key. You can use the key ID or Amazon Resource Name (ARN) of the CMK, or the name or ARN of an alias that refers to the CMK.
  key_spec: "AES_256", # Specifies the type of data key to return.
})

resp.to_h outputs the following:
{
  ciphertext_blob: "<binary data>", # The encrypted data key.
  key_id: "arn:aws:kms:us-east-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab", # The ARN of the CMK that was used to encrypt the data key.
  plaintext: "<binary data>", # The unencrypted (plaintext) data key.
}

Request syntax with placeholder values


resp = client.generate_data_key({
  key_id: "KeyIdType", # required
  encryption_context: {
    "EncryptionContextKey" => "EncryptionContextValue",
  },
  number_of_bytes: 1,
  key_spec: "AES_256", # accepts AES_256, AES_128
  grant_tokens: ["GrantTokenType"],
})

Response structure


resp.ciphertext_blob #=> String
resp.plaintext #=> String
resp.key_id #=> String

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :key_id (required, String) —

    Identifies the symmetric CMK that encrypts the data key.

    To specify a CMK, 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 CMK in a different AWS 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

    To get the key ID and key ARN for a CMK, use ListKeys or DescribeKey. To get the alias name and alias ARN, use ListAliases.

  • :encryption_context (Hash<String,String>) —

    Specifies the encryption context that will be used when encrypting the data key.

    An encryption context is a collection of non-secret key-value pairs that represents additional authenticated data. When you use an encryption context to encrypt data, you must specify the same (an exact case-sensitive match) encryption context to decrypt the data. An encryption context is optional when encrypting with a symmetric CMK, but it is highly recommended.

    For more information, see Encryption Context in the AWS Key Management Service Developer Guide.

  • :number_of_bytes (Integer) —

    Specifies the length of the data key in bytes. For example, use the value 64 to generate a 512-bit data key (64 bytes is 512 bits). For 128-bit (16-byte) and 256-bit (32-byte) data keys, use the KeySpec parameter.

    You must specify either the KeySpec or the NumberOfBytes parameter (but not both) in every GenerateDataKey request.

  • :key_spec (String) —

    Specifies the length of the data key. Use AES_128 to generate a 128-bit symmetric key, or AES_256 to generate a 256-bit symmetric key.

    You must specify either the KeySpec or the NumberOfBytes parameter (but not both) in every GenerateDataKey request.

  • :grant_tokens (Array<String>) —

    A list of grant tokens.

    For more information, see Grant Tokens in the AWS Key Management Service Developer Guide.

Returns:

See Also:



2538
2539
2540
2541
 
# File 'gems/aws-sdk-kms/lib/aws-sdk-kms/client.rb', line 2538

def generate_data_key(params = {}, options = {})
  req = build_request(:generate_data_key, params)
  req.send_request(options)
end

#generate_data_key_pair(params = {}) ⇒ Types::GenerateDataKeyPairResponse

Generates a unique asymmetric data key pair. The GenerateDataKeyPair operation returns a plaintext public key, a plaintext private key, and a copy of the private key that is encrypted under the symmetric CMK you specify. You can use the data key pair to perform asymmetric cryptography outside of AWS KMS.

GenerateDataKeyPair returns a unique data key pair for each request. The bytes in the keys are not related to the caller or the CMK that is used to encrypt the private key.

You can use the public key that GenerateDataKeyPair returns to encrypt data or verify a signature outside of AWS KMS. Then, store the encrypted private key with the data. When you are ready to decrypt data or sign a message, you can use the Decrypt operation to decrypt the encrypted private key.

To generate a data key pair, you must specify a symmetric customer master key (CMK) to encrypt the private key in a data key pair. You cannot use an asymmetric CMK or a CMK in a custom key store. To get the type and origin of your CMK, use the DescribeKey operation.

If you are using the data key pair to encrypt data, or for any operation where you don't immediately need a private key, consider using the GenerateDataKeyPairWithoutPlaintext operation. GenerateDataKeyPairWithoutPlaintext returns a plaintext public key and an encrypted private key, but omits the plaintext private key that you need only to decrypt ciphertext or sign a message. Later, when you need to decrypt the data or sign a message, use the Decrypt operation to decrypt the encrypted private key in the data key pair.

You can use the optional encryption context to add additional security to the encryption operation. If you specify an EncryptionContext, you must specify the same encryption context (a case-sensitive exact match) when decrypting the encrypted data key. Otherwise, the request to decrypt fails with an InvalidCiphertextException. For more information, see Encryption Context in the AWS Key Management Service Developer Guide.

The CMK that you use for this operation must be in a compatible key state. For details, see How Key State Affects Use of a Customer Master Key in the AWS Key Management Service Developer Guide.

Examples:

Request syntax with placeholder values


resp = client.generate_data_key_pair({
  encryption_context: {
    "EncryptionContextKey" => "EncryptionContextValue",
  },
  key_id: "KeyIdType", # required
  key_pair_spec: "RSA_2048", # required, accepts RSA_2048, RSA_3072, RSA_4096, ECC_NIST_P256, ECC_NIST_P384, ECC_NIST_P521, ECC_SECG_P256K1
  grant_tokens: ["GrantTokenType"],
})

Response structure


resp.private_key_ciphertext_blob #=> String
resp.private_key_plaintext #=> String
resp.public_key #=> String
resp.key_id #=> String
resp.key_pair_spec #=> String, one of "RSA_2048", "RSA_3072", "RSA_4096", "ECC_NIST_P256", "ECC_NIST_P384", "ECC_NIST_P521", "ECC_SECG_P256K1"

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :encryption_context (Hash<String,String>) —

    Specifies the encryption context that will be used when encrypting the private key in the data key pair.

    An encryption context is a collection of non-secret key-value pairs that represents additional authenticated data. When you use an encryption context to encrypt data, you must specify the same (an exact case-sensitive match) encryption context to decrypt the data. An encryption context is optional when encrypting with a symmetric CMK, but it is highly recommended.

    For more information, see Encryption Context in the AWS Key Management Service Developer Guide.

  • :key_id (required, String) —

    Specifies the symmetric CMK that encrypts the private key in the data key pair. You cannot specify an asymmetric CMK or a CMK in a custom key store. To get the type and origin of your CMK, use the DescribeKey operation.

    To specify a CMK, 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 CMK in a different AWS 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

    To get the key ID and key ARN for a CMK, use ListKeys or DescribeKey. To get the alias name and alias ARN, use ListAliases.

  • :key_pair_spec (required, String) —

    Determines the type of data key pair that is generated.

    The AWS KMS rule that restricts the use of asymmetric RSA CMKs to encrypt and decrypt or to sign and verify (but not both), and the rule that permits you to use ECC CMKs only to sign and verify, are not effective outside of AWS KMS.

  • :grant_tokens (Array<String>) —

    A list of grant tokens.

    For more information, see Grant Tokens in the AWS Key Management Service Developer Guide.

Returns:

See Also:



2682
2683
2684
2685
 
# File 'gems/aws-sdk-kms/lib/aws-sdk-kms/client.rb', line 2682

def generate_data_key_pair(params = {}, options = {})
  req = build_request(:generate_data_key_pair, params)
  req.send_request(options)
end

#generate_data_key_pair_without_plaintext(params = {}) ⇒ Types::GenerateDataKeyPairWithoutPlaintextResponse

Generates a unique asymmetric data key pair. The GenerateDataKeyPairWithoutPlaintext operation returns a plaintext public key and a copy of the private key that is encrypted under the symmetric CMK you specify. Unlike GenerateDataKeyPair, this operation does not return a plaintext private key.

To generate a data key pair, you must specify a symmetric customer master key (CMK) to encrypt the private key in the data key pair. You cannot use an asymmetric CMK or a CMK in a custom key store. To get the type and origin of your CMK, use the KeySpec field in the DescribeKey response.

You can use the public key that GenerateDataKeyPairWithoutPlaintext returns to encrypt data or verify a signature outside of AWS KMS. Then, store the encrypted private key with the data. When you are ready to decrypt data or sign a message, you can use the Decrypt operation to decrypt the encrypted private key.

GenerateDataKeyPairWithoutPlaintext returns a unique data key pair for each request. The bytes in the key are not related to the caller or CMK that is used to encrypt the private key.

You can use the optional encryption context to add additional security to the encryption operation. If you specify an EncryptionContext, you must specify the same encryption context (a case-sensitive exact match) when decrypting the encrypted data key. Otherwise, the request to decrypt fails with an InvalidCiphertextException. For more information, see Encryption Context in the AWS Key Management Service Developer Guide.

The CMK that you use for this operation must be in a compatible key state. For details, see How Key State Affects Use of a Customer Master Key in the AWS Key Management Service Developer Guide.

Examples:

Request syntax with placeholder values


resp = client.generate_data_key_pair_without_plaintext({
  encryption_context: {
    "EncryptionContextKey" => "EncryptionContextValue",
  },
  key_id: "KeyIdType", # required
  key_pair_spec: "RSA_2048", # required, accepts RSA_2048, RSA_3072, RSA_4096, ECC_NIST_P256, ECC_NIST_P384, ECC_NIST_P521, ECC_SECG_P256K1
  grant_tokens: ["GrantTokenType"],
})

Response structure


resp.private_key_ciphertext_blob #=> String
resp.public_key #=> String
resp.key_id #=> String
resp.key_pair_spec #=> String, one of "RSA_2048", "RSA_3072", "RSA_4096", "ECC_NIST_P256", "ECC_NIST_P384", "ECC_NIST_P521", "ECC_SECG_P256K1"

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :encryption_context (Hash<String,String>) —

    Specifies the encryption context that will be used when encrypting the private key in the data key pair.

    An encryption context is a collection of non-secret key-value pairs that represents additional authenticated data. When you use an encryption context to encrypt data, you must specify the same (an exact case-sensitive match) encryption context to decrypt the data. An encryption context is optional when encrypting with a symmetric CMK, but it is highly recommended.

    For more information, see Encryption Context in the AWS Key Management Service Developer Guide.

  • :key_id (required, String) —

    Specifies the CMK that encrypts the private key in the data key pair. You must specify a symmetric CMK. You cannot use an asymmetric CMK or a CMK in a custom key store. To get the type and origin of your CMK, use the DescribeKey operation.

    To specify a CMK, use its key ID, Amazon Resource Name (ARN), alias name, or alias ARN. When using an alias name, prefix it with "alias/".

    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

    To get the key ID and key ARN for a CMK, use ListKeys or DescribeKey. To get the alias name and alias ARN, use ListAliases.

  • :key_pair_spec (required, String) —

    Determines the type of data key pair that is generated.

    The AWS KMS rule that restricts the use of asymmetric RSA CMKs to encrypt and decrypt or to sign and verify (but not both), and the rule that permits you to use ECC CMKs only to sign and verify, are not effective outside of AWS KMS.

  • :grant_tokens (Array<String>) —

    A list of grant tokens.

    For more information, see Grant Tokens in the AWS Key Management Service Developer Guide.

Returns:

See Also:



2815
2816
2817
2818
 
# File 'gems/aws-sdk-kms/lib/aws-sdk-kms/client.rb', line 2815

def generate_data_key_pair_without_plaintext(params = {}, options = {})
  req = build_request(:generate_data_key_pair_without_plaintext, params)
  req.send_request(options)
end

#generate_data_key_without_plaintext(params = {}) ⇒ Types::GenerateDataKeyWithoutPlaintextResponse

Generates a unique symmetric data key. This operation returns a data key that is encrypted under a customer master key (CMK) that you specify. To request an asymmetric data key pair, use the GenerateDataKeyPair or GenerateDataKeyPairWithoutPlaintext operations.

GenerateDataKeyWithoutPlaintext is identical to the GenerateDataKey operation except that returns only the encrypted copy of the data key. This operation is useful for systems that need to encrypt data at some point, but not immediately. When you need to encrypt the data, you call the Decrypt operation on the encrypted copy of the key.

It's also useful in distributed systems with different levels of trust. For example, you might store encrypted data in containers. One component of your system creates new containers and stores an encrypted data key with each container. Then, a different component puts the data into the containers. That component first decrypts the data key, uses the plaintext data key to encrypt data, puts the encrypted data into the container, and then destroys the plaintext data key. In this system, the component that creates the containers never sees the plaintext data key.

GenerateDataKeyWithoutPlaintext returns a unique data key for each request. The bytes in the keys are not related to the caller or CMK that is used to encrypt the private key.

To generate a data key, you must specify the symmetric customer master key (CMK) that is used to encrypt the data key. You cannot use an asymmetric CMK to generate a data key. To get the type of your CMK, use the DescribeKey operation.

If the operation succeeds, you will find the encrypted copy of the data key in the CiphertextBlob field.

You can use the optional encryption context to add additional security to the encryption operation. If you specify an EncryptionContext, you must specify the same encryption context (a case-sensitive exact match) when decrypting the encrypted data key. Otherwise, the request to decrypt fails with an InvalidCiphertextException. For more information, see Encryption Context in the AWS Key Management Service Developer Guide.

The CMK that you use for this operation must be in a compatible key state. For details, see How Key State Affects Use of a Customer Master Key in the AWS Key Management Service Developer Guide.

Examples:

Example: To generate an encrypted data key


# The following example generates an encrypted copy of a 256-bit symmetric data encryption key (data key). The data key is
# encrypted with the specified customer master key (CMK).

resp = client.generate_data_key_without_plaintext({
  key_id: "alias/ExampleAlias", # The identifier of the CMK to use to encrypt the data key. You can use the key ID or Amazon Resource Name (ARN) of the CMK, or the name or ARN of an alias that refers to the CMK.
  key_spec: "AES_256", # Specifies the type of data key to return.
})

resp.to_h outputs the following:
{
  ciphertext_blob: "<binary data>", # The encrypted data key.
  key_id: "arn:aws:kms:us-east-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab", # The ARN of the CMK that was used to encrypt the data key.
}

Request syntax with placeholder values


resp = client.generate_data_key_without_plaintext({
  key_id: "KeyIdType", # required
  encryption_context: {
    "EncryptionContextKey" => "EncryptionContextValue",
  },
  key_spec: "AES_256", # accepts AES_256, AES_128
  number_of_bytes: 1,
  grant_tokens: ["GrantTokenType"],
})

Response structure


resp.ciphertext_blob #=> String
resp.key_id #=> String

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :key_id (required, String) —

    The identifier of the symmetric customer master key (CMK) that encrypts the data key.

    To specify a CMK, 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 CMK in a different AWS 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

    To get the key ID and key ARN for a CMK, use ListKeys or DescribeKey. To get the alias name and alias ARN, use ListAliases.

  • :encryption_context (Hash<String,String>) —

    Specifies the encryption context that will be used when encrypting the data key.

    An encryption context is a collection of non-secret key-value pairs that represents additional authenticated data. When you use an encryption context to encrypt data, you must specify the same (an exact case-sensitive match) encryption context to decrypt the data. An encryption context is optional when encrypting with a symmetric CMK, but it is highly recommended.

    For more information, see Encryption Context in the AWS Key Management Service Developer Guide.

  • :key_spec (String) —

    The length of the data key. Use AES_128 to generate a 128-bit symmetric key, or AES_256 to generate a 256-bit symmetric key.

  • :number_of_bytes (Integer) —

    The length of the data key in bytes. For example, use the value 64 to generate a 512-bit data key (64 bytes is 512 bits). For common key lengths (128-bit and 256-bit symmetric keys), we recommend that you use the KeySpec field instead of this one.

  • :grant_tokens (Array<String>) —

    A list of grant tokens.

    For more information, see Grant Tokens in the AWS Key Management Service Developer Guide.

Returns:

See Also:



2974
2975
2976
2977
 
# File 'gems/aws-sdk-kms/lib/aws-sdk-kms/client.rb', line 2974

def generate_data_key_without_plaintext(params = {}, options = {})
  req = build_request(:generate_data_key_without_plaintext, params)
  req.send_request(options)
end

#generate_random(params = {}) ⇒ Types::GenerateRandomResponse

Returns a random byte string that is cryptographically secure.

By default, the random byte string is generated in AWS KMS. To generate the byte string in the AWS CloudHSM cluster that is associated with a custom key store, specify the custom key store ID.

For more information about entropy and random number generation, see the AWS Key Management Service Cryptographic Details whitepaper.

Examples:

Example: To generate random data


# The following example uses AWS KMS to generate 32 bytes of random data.

resp = client.generate_random({
  number_of_bytes: 32, # The length of the random data, specified in number of bytes.
})

resp.to_h outputs the following:
{
  plaintext: "<binary data>", # The random data.
}

Request syntax with placeholder values


resp = client.generate_random({
  number_of_bytes: 1,
  custom_key_store_id: "CustomKeyStoreIdType",
})

Response structure


resp.plaintext #=> String

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :number_of_bytes (Integer) —

    The length of the byte string.

  • :custom_key_store_id (String) —

    Generates the random byte string in the AWS CloudHSM cluster that is associated with the specified custom key store. To find the ID of a custom key store, use the DescribeCustomKeyStores operation.

Returns:

See Also:



3039
3040
3041
3042
 
# File 'gems/aws-sdk-kms/lib/aws-sdk-kms/client.rb', line 3039

def generate_random(params = {}, options = {})
  req = build_request(:generate_random, params)
  req.send_request(options)
end

#get_key_policy(params = {}) ⇒ Types::GetKeyPolicyResponse

Gets a key policy attached to the specified customer master key (CMK). You cannot perform this operation on a CMK in a different AWS account.

Examples:

Example: To retrieve a key policy


# The following example retrieves the key policy for the specified customer master key (CMK).

resp = client.get_key_policy({
  key_id: "1234abcd-12ab-34cd-56ef-1234567890ab", # The identifier of the CMK whose key policy you want to retrieve. You can use the key ID or the Amazon Resource Name (ARN) of the CMK.
  policy_name: "default", # The name of the key policy to retrieve.
})

resp.to_h outputs the following:
{
  policy: "{\n  \"Version\" : \"2012-10-17\",\n  \"Id\" : \"key-default-1\",\n  \"Statement\" : [ {\n    \"Sid\" : \"Enable IAM User Permissions\",\n    \"Effect\" : \"Allow\",\n    \"Principal\" : {\n      \"AWS\" : \"arn:aws:iam::111122223333:root\"\n    },\n    \"Action\" : \"kms:*\",\n    \"Resource\" : \"*\"\n  } ]\n}", # The key policy document.
}

Request syntax with placeholder values


resp = client.get_key_policy({
  key_id: "KeyIdType", # required
  policy_name: "PolicyNameType", # required
})

Response structure


resp.policy #=> String

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :key_id (required, String) —

    A unique identifier for the customer master key (CMK).

    Specify the key ID or the Amazon Resource Name (ARN) of the CMK.

    For example:

    • Key ID: 1234abcd-12ab-34cd-56ef-1234567890ab

    • Key ARN: arn:aws:kms:us-east-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab

    To get the key ID and key ARN for a CMK, use ListKeys or DescribeKey.

  • :policy_name (required, String) —

    Specifies the name of the key policy. The only valid name is default. To get the names of key policies, use ListKeyPolicies.

Returns:

See Also:



3099
3100
3101
3102
 
# File 'gems/aws-sdk-kms/lib/aws-sdk-kms/client.rb', line 3099

def get_key_policy(params = {}, options = {})
  req = build_request(:get_key_policy, params)
  req.send_request(options)
end

#get_key_rotation_status(params = {}) ⇒ Types::GetKeyRotationStatusResponse

Gets a Boolean value that indicates whether automatic rotation of the key material is enabled for the specified customer master key (CMK).

You cannot enable automatic rotation of asymmetric CMKs, CMKs with imported key material, or CMKs in a custom key store. The key rotation status for these CMKs is always false.

The CMK that you use for this operation must be in a compatible key state. For details, see How Key State Affects Use of a Customer Master Key in the AWS Key Management Service Developer Guide.

  • Disabled: The key rotation status does not change when you disable a CMK. However, while the CMK is disabled, AWS KMS does not rotate the backing key.

  • Pending deletion: While a CMK is pending deletion, its key rotation status is false and AWS KMS does not rotate the backing key. If you cancel the deletion, the original key rotation status is restored.

To perform this operation on a CMK in a different AWS account, specify the key ARN in the value of the KeyId parameter.

Examples:

Example: To retrieve the rotation status for a customer master key (CMK)


# The following example retrieves the status of automatic annual rotation of the key material for the specified CMK.

resp = client.get_key_rotation_status({
  key_id: "1234abcd-12ab-34cd-56ef-1234567890ab", # The identifier of the CMK whose key material rotation status you want to retrieve. You can use the key ID or the Amazon Resource Name (ARN) of the CMK.
})

resp.to_h outputs the following:
{
  key_rotation_enabled: true, # A boolean that indicates the key material rotation status. Returns true when automatic annual rotation of the key material is enabled, or false when it is not.
}

Request syntax with placeholder values


resp = client.get_key_rotation_status({
  key_id: "KeyIdType", # required
})

Response structure


resp.key_rotation_enabled #=> Boolean

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :key_id (required, String) —

    A unique identifier for the customer master key (CMK).

    Specify the key ID or the Amazon Resource Name (ARN) of the CMK. To specify a CMK in a different AWS account, you must use the key 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

    To get the key ID and key ARN for a CMK, use ListKeys or DescribeKey.

Returns:

See Also:



3181
3182
3183
3184
 
# File 'gems/aws-sdk-kms/lib/aws-sdk-kms/client.rb', line 3181

def get_key_rotation_status(params = {}, options = {})
  req = build_request(:get_key_rotation_status, params)
  req.send_request(options)
end

#get_parameters_for_import(params = {}) ⇒ Types::GetParametersForImportResponse

Returns the items you need to import key material into a symmetric, customer managed customer master key (CMK). For more information about importing key material into AWS KMS, see Importing Key Material in the AWS Key Management Service Developer Guide.

This operation returns a public key and an import token. Use the public key to encrypt the symmetric key material. Store the import token to send with a subsequent ImportKeyMaterial request.

You must specify the key ID of the symmetric CMK into which you will import key material. This CMK's Origin must be EXTERNAL. You must also specify the wrapping algorithm and type of wrapping key (public key) that you will use to encrypt the key material. You cannot perform this operation on an asymmetric CMK or on any CMK in a different AWS account.

To import key material, you must use the public key and import token from the same response. These items are valid for 24 hours. The expiration date and time appear in the GetParametersForImport response. You cannot use an expired token in an ImportKeyMaterial request. If your key and token expire, send another GetParametersForImport request.

The CMK that you use for this operation must be in a compatible key state. For details, see How Key State Affects Use of a Customer Master Key in the AWS Key Management Service Developer Guide.

Examples:

Example: To retrieve the public key and import token for a customer master key (CMK)


# The following example retrieves the public key and import token for the specified CMK.

resp = client.get_parameters_for_import({
  key_id: "1234abcd-12ab-34cd-56ef-1234567890ab", # The identifier of the CMK for which to retrieve the public key and import token. You can use the key ID or the Amazon Resource Name (ARN) of the CMK.
  wrapping_algorithm: "RSAES_OAEP_SHA_1", # The algorithm that you will use to encrypt the key material before importing it.
  wrapping_key_spec: "RSA_2048", # The type of wrapping key (public key) to return in the response.
})

resp.to_h outputs the following:
{
  import_token: "<binary data>", # The import token to send with a subsequent ImportKeyMaterial request.
  key_id: "arn:aws:kms:us-east-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab", # The ARN of the CMK for which you are retrieving the public key and import token. This is the same CMK specified in the request.
  parameters_valid_to: Time.parse("2016-12-01T14:52:17-08:00"), # The time at which the import token and public key are no longer valid.
  public_key: "<binary data>", # The public key to use to encrypt the key material before importing it.
}

Request syntax with placeholder values


resp = client.get_parameters_for_import({
  key_id: "KeyIdType", # required
  wrapping_algorithm: "RSAES_PKCS1_V1_5", # required, accepts RSAES_PKCS1_V1_5, RSAES_OAEP_SHA_1, RSAES_OAEP_SHA_256
  wrapping_key_spec: "RSA_2048", # required, accepts RSA_2048
})

Response structure


resp.key_id #=> String
resp.import_token #=> String
resp.public_key #=> String
resp.parameters_valid_to #=> Time

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :key_id (required, String) —

    The identifier of the symmetric CMK into which you will import key material. The Origin of the CMK must be EXTERNAL.

    Specify the key ID or the Amazon Resource Name (ARN) of the CMK.

    For example:

    • Key ID: 1234abcd-12ab-34cd-56ef-1234567890ab

    • Key ARN: arn:aws:kms:us-east-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab

    To get the key ID and key ARN for a CMK, use ListKeys or DescribeKey.

  • :wrapping_algorithm (required, String) —

    The algorithm you will use to encrypt the key material before importing it with ImportKeyMaterial. For more information, see Encrypt the Key Material in the AWS Key Management Service Developer Guide.

  • :wrapping_key_spec (required, String) —

    The type of wrapping key (public key) to return in the response. Only 2048-bit RSA public keys are supported.

Returns:

See Also:



3292
3293
3294
3295
 
# File 'gems/aws-sdk-kms/lib/aws-sdk-kms/client.rb', line 3292

def get_parameters_for_import(params = {}, options = {})
  req = build_request(:get_parameters_for_import, params)
  req.send_request(options)
end

#get_public_key(params = {}) ⇒ Types::GetPublicKeyResponse

Returns the public key of an asymmetric CMK. Unlike the private key of a asymmetric CMK, which never leaves AWS KMS unencrypted, callers with kms:GetPublicKey permission can download the public key of an asymmetric CMK. You can share the public key to allow others to encrypt messages and verify signatures outside of AWS KMS. For information about symmetric and asymmetric CMKs, see Using Symmetric and Asymmetric CMKs in the AWS Key Management Service Developer Guide.

You do not need to download the public key. Instead, you can use the public key within AWS KMS by calling the Encrypt, ReEncrypt, or Verify operations with the identifier of an asymmetric CMK. When you use the public key within AWS KMS, you benefit from the authentication, authorization, and logging that are part of every AWS KMS operation. You also reduce of risk of encrypting data that cannot be decrypted. These features are not effective outside of AWS KMS. For details, see Special Considerations for Downloading Public Keys.

To help you use the public key safely outside of AWS KMS, GetPublicKey returns important information about the public key in the response, including:

Although AWS KMS cannot enforce these restrictions on external operations, it is crucial that you use this information to prevent the public key from being used improperly. For example, you can prevent a public signing key from being used encrypt data, or prevent a public key from being used with an encryption algorithm that is not supported by AWS KMS. You can also avoid errors, such as using the wrong signing algorithm in a verification operation.

The CMK that you use for this operation must be in a compatible key state. For details, see How Key State Affects Use of a Customer Master Key in the AWS Key Management Service Developer Guide.

Examples:

Request syntax with placeholder values


resp = client.get_public_key({
  key_id: "KeyIdType", # required
  grant_tokens: ["GrantTokenType"],
})

Response structure


resp.key_id #=> String
resp.public_key #=> String
resp.customer_master_key_spec #=> String, one of "RSA_2048", "RSA_3072", "RSA_4096", "ECC_NIST_P256", "ECC_NIST_P384", "ECC_NIST_P521", "ECC_SECG_P256K1", "SYMMETRIC_DEFAULT"
resp.key_usage #=> String, one of "SIGN_VERIFY", "ENCRYPT_DECRYPT"
resp.encryption_algorithms #=> Array
resp.encryption_algorithms[0] #=> String, one of "SYMMETRIC_DEFAULT", "RSAES_OAEP_SHA_1", "RSAES_OAEP_SHA_256"
resp.signing_algorithms #=> Array
resp.signing_algorithms[0] #=> String, one of "RSASSA_PSS_SHA_256", "RSASSA_PSS_SHA_384", "RSASSA_PSS_SHA_512", "RSASSA_PKCS1_V1_5_SHA_256", "RSASSA_PKCS1_V1_5_SHA_384", "RSASSA_PKCS1_V1_5_SHA_512", "ECDSA_SHA_256", "ECDSA_SHA_384", "ECDSA_SHA_512"

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :key_id (required, String) —

    Identifies the asymmetric CMK that includes the public key.

    To specify a CMK, 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 CMK in a different AWS 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

    To get the key ID and key ARN for a CMK, use ListKeys or DescribeKey. To get the alias name and alias ARN, use ListAliases.

  • :grant_tokens (Array<String>) —

    A list of grant tokens.

    For more information, see Grant Tokens in the AWS Key Management Service Developer Guide.

Returns:

See Also:



3412
3413
3414
3415
 
# File 'gems/aws-sdk-kms/lib/aws-sdk-kms/client.rb', line 3412

def get_public_key(params = {}, options = {})
  req = build_request(:get_public_key, params)
  req.send_request(options)
end

#import_key_material(params = {}) ⇒ Struct

Imports key material into an existing symmetric AWS KMS customer master key (CMK) that was created without key material. After you successfully import key material into a CMK, you can reimport the same key material into that CMK, but you cannot import different key material.

You cannot perform this operation on an asymmetric CMK or on any CMK in a different AWS account. For more information about creating CMKs with no key material and then importing key material, see Importing Key Material in the AWS Key Management Service Developer Guide.

Before using this operation, call GetParametersForImport. Its response includes a public key and an import token. Use the public key to encrypt the key material. Then, submit the import token from the same GetParametersForImport response.

When calling this operation, you must specify the following values:

  • The key ID or key ARN of a CMK with no key material. Its Origin must be EXTERNAL.

    To create a CMK with no key material, call CreateKey and set the value of its Origin parameter to EXTERNAL. To get the Origin of a CMK, call DescribeKey.)

  • The encrypted key material. To get the public key to encrypt the key material, call GetParametersForImport.

  • The import token that GetParametersForImport returned. You must use a public key and token from the same GetParametersForImport response.

  • Whether the key material expires and if so, when. If you set an expiration date, AWS KMS deletes the key material from the CMK on the specified date, and the CMK becomes unusable. To use the CMK again, you must reimport the same key material. The only way to change an expiration date is by reimporting the same key material and specifying a new expiration date.

When this operation is successful, the key state of the CMK changes from PendingImport to Enabled, and you can use the CMK.

If this operation fails, use the exception to help determine the problem. If the error is related to the key material, the import token, or wrapping key, use GetParametersForImport to get a new public key and import token for the CMK and repeat the import procedure. For help, see How To Import Key Material in the AWS Key Management Service Developer Guide.

The CMK that you use for this operation must be in a compatible key state. For details, see How Key State Affects Use of a Customer Master Key in the AWS Key Management Service Developer Guide.

Examples:

Example: To import key material into a customer master key (CMK)


# The following example imports key material into the specified CMK.

resp = client.import_key_material({
  encrypted_key_material: "<binary data>", # The encrypted key material to import.
  expiration_model: "KEY_MATERIAL_DOES_NOT_EXPIRE", # A value that specifies whether the key material expires.
  import_token: "<binary data>", # The import token that you received in the response to a previous GetParametersForImport request.
  key_id: "1234abcd-12ab-34cd-56ef-1234567890ab", # The identifier of the CMK to import the key material into. You can use the key ID or the Amazon Resource Name (ARN) of the CMK.
})

Request syntax with placeholder values


resp = client.import_key_material({
  key_id: "KeyIdType", # required
  import_token: "data", # required
  encrypted_key_material: "data", # required
  valid_to: Time.now,
  expiration_model: "KEY_MATERIAL_EXPIRES", # accepts KEY_MATERIAL_EXPIRES, KEY_MATERIAL_DOES_NOT_EXPIRE
})

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :key_id (required, String) —

    The identifier of the symmetric CMK that receives the imported key material. The CMK's Origin must be EXTERNAL. This must be the same CMK specified in the KeyID parameter of the corresponding GetParametersForImport request.

    Specify the key ID or the Amazon Resource Name (ARN) of the CMK.

    For example:

    • Key ID: 1234abcd-12ab-34cd-56ef-1234567890ab

    • Key ARN: arn:aws:kms:us-east-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab

    To get the key ID and key ARN for a CMK, use ListKeys or DescribeKey.

  • :import_token (required, String, IO) —

    The import token that you received in the response to a previous GetParametersForImport request. It must be from the same response that contained the public key that you used to encrypt the key material.

  • :encrypted_key_material (required, String, IO) —

    The encrypted key material to import. The key material must be encrypted with the public wrapping key that GetParametersForImport returned, using the wrapping algorithm that you specified in the same GetParametersForImport request.

  • :valid_to (Time, DateTime, Date, Integer, String) —

    The time at which the imported key material expires. When the key material expires, AWS KMS deletes the key material and the CMK becomes unusable. You must omit this parameter when the ExpirationModel parameter is set to KEY_MATERIAL_DOES_NOT_EXPIRE. Otherwise it is required.

  • :expiration_model (String) —

    Specifies whether the key material expires. The default is KEY_MATERIAL_EXPIRES, in which case you must include the ValidTo parameter. When this parameter is set to KEY_MATERIAL_DOES_NOT_EXPIRE, you must omit the ValidTo parameter.

Returns:

  • (Struct) —

    Returns an empty response.

See Also:



3546
3547
3548
3549
 
# File 'gems/aws-sdk-kms/lib/aws-sdk-kms/client.rb', line 3546

def import_key_material(params = {}, options = {})
  req = build_request(:import_key_material, params)
  req.send_request(options)
end

#list_aliases(params = {}) ⇒ Types::ListAliasesResponse

Gets a list of aliases in the caller's AWS account and region. You cannot list aliases in other accounts. For more information about aliases, see CreateAlias.

By default, the ListAliases command returns all aliases in the account and region. To get only the aliases that point to a particular customer master key (CMK), use the KeyId parameter.

The ListAliases response can include aliases that you created and associated with your customer managed CMKs, and aliases that AWS created and associated with AWS managed CMKs in your account. You can recognize AWS aliases because their names have the format aws/<service-name>, such as aws/dynamodb.

The response might also include aliases that have no TargetKeyId field. These are predefined aliases that AWS has created but has not yet associated with a CMK. Aliases that AWS creates in your account, including predefined aliases, do not count against your AWS KMS aliases quota.

The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.

Examples:

Example: To list aliases


# The following example lists aliases.

resp = client.list_aliases({
})

resp.to_h outputs the following:
{
  aliases: [
    {
      alias_arn: "arn:aws:kms:us-east-2:111122223333:alias/aws/acm", 
      alias_name: "alias/aws/acm", 
      target_key_id: "da03f6f7-d279-427a-9cae-de48d07e5b66", 
    }, 
    {
      alias_arn: "arn:aws:kms:us-east-2:111122223333:alias/aws/ebs", 
      alias_name: "alias/aws/ebs", 
      target_key_id: "25a217e7-7170-4b8c-8bf6-045ea5f70e5b", 
    }, 
    {
      alias_arn: "arn:aws:kms:us-east-2:111122223333:alias/aws/rds", 
      alias_name: "alias/aws/rds", 
      target_key_id: "7ec3104e-c3f2-4b5c-bf42-bfc4772c6685", 
    }, 
    {
      alias_arn: "arn:aws:kms:us-east-2:111122223333:alias/aws/redshift", 
      alias_name: "alias/aws/redshift", 
      target_key_id: "08f7a25a-69e2-4fb5-8f10-393db27326fa", 
    }, 
    {
      alias_arn: "arn:aws:kms:us-east-2:111122223333:alias/aws/s3", 
      alias_name: "alias/aws/s3", 
      target_key_id: "d2b0f1a3-580d-4f79-b836-bc983be8cfa5", 
    }, 
    {
      alias_arn: "arn:aws:kms:us-east-2:111122223333:alias/example1", 
      alias_name: "alias/example1", 
      target_key_id: "4da1e216-62d0-46c5-a7c0-5f3a3d2f8046", 
    }, 
    {
      alias_arn: "arn:aws:kms:us-east-2:111122223333:alias/example2", 
      alias_name: "alias/example2", 
      target_key_id: "f32fef59-2cc2-445b-8573-2d73328acbee", 
    }, 
    {
      alias_arn: "arn:aws:kms:us-east-2:111122223333:alias/example3", 
      alias_name: "alias/example3", 
      target_key_id: "1374ef38-d34e-4d5f-b2c9-4e0daee38855", 
    }, 
  ], # A list of aliases, including the key ID of the customer master key (CMK) that each alias refers to.
  truncated: false, # A boolean that indicates whether there are more items in the list. Returns true when there are more items, or false when there are not.
}

Request syntax with placeholder values


resp = client.list_aliases({
  key_id: "KeyIdType",
  limit: 1,
  marker: "MarkerType",
})

Response structure


resp.aliases #=> Array
resp.aliases[0].alias_name #=> String
resp.aliases[0].alias_arn #=> String
resp.aliases[0].target_key_id #=> String
resp.next_marker #=> String
resp.truncated #=> Boolean

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :key_id (String) —

    Lists only aliases that refer to the specified CMK. The value of this parameter can be the ID or Amazon Resource Name (ARN) of a CMK in the caller's account and region. You cannot use an alias name or alias ARN in this value.

    This parameter is optional. If you omit it, ListAliases returns all aliases in the account and region.

  • :limit (Integer) —

    Use this parameter to specify the maximum number of items to return. When this value is present, AWS KMS does not return more than the specified number of items, but it might return fewer.

    This value is optional. If you include a value, it must be between 1 and 100, inclusive. If you do not include a value, it defaults to 50.

  • :marker (String) —

    Use this parameter in a subsequent request after you receive a response with truncated results. Set it to the value of NextMarker from the truncated response you just received.

Returns:

See Also:



3681
3682
3683
3684
 
# File 'gems/aws-sdk-kms/lib/aws-sdk-kms/client.rb', line 3681

def list_aliases(params = {}, options = {})
  req = build_request(:list_aliases, params)
  req.send_request(options)
end

#list_grants(params = {}) ⇒ Types::ListGrantsResponse

Gets a list of all grants for the specified customer master key (CMK).

To perform this operation on a CMK in a different AWS account, specify the key ARN in the value of the KeyId parameter.

The GranteePrincipal field in the ListGrants response usually contains the user or role designated as the grantee principal in the grant. However, when the grantee principal in the grant is an AWS service, the GranteePrincipal field contains the service principal, which might represent several different grantee principals.

The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.

Examples:

Example: To list grants for a customer master key (CMK)


# The following example lists grants for the specified CMK.

resp = client.list_grants({
  key_id: "1234abcd-12ab-34cd-56ef-1234567890ab", # The identifier of the CMK whose grants you want to list. You can use the key ID or the Amazon Resource Name (ARN) of the CMK.
})

resp.to_h outputs the following:
{
  grants: [
    {
      creation_date: Time.parse("2016-10-25T14:37:41-07:00"), 
      grant_id: "91ad875e49b04a9d1f3bdeb84d821f9db6ea95e1098813f6d47f0c65fbe2a172", 
      grantee_principal: "acm.us-east-2.amazonaws.com", 
      issuing_account: "arn:aws:iam::111122223333:root", 
      key_id: "arn:aws:kms:us-east-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab", 
      operations: [
        "Encrypt", 
        "ReEncryptFrom", 
        "ReEncryptTo", 
      ], 
      retiring_principal: "acm.us-east-2.amazonaws.com", 
    }, 
    {
      creation_date: Time.parse("2016-10-25T14:37:41-07:00"), 
      grant_id: "a5d67d3e207a8fc1f4928749ee3e52eb0440493a8b9cf05bbfad91655b056200", 
      grantee_principal: "acm.us-east-2.amazonaws.com", 
      issuing_account: "arn:aws:iam::111122223333:root", 
      key_id: "arn:aws:kms:us-east-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab", 
      operations: [
        "ReEncryptFrom", 
        "ReEncryptTo", 
      ], 
      retiring_principal: "acm.us-east-2.amazonaws.com", 
    }, 
    {
      creation_date: Time.parse("2016-10-25T14:37:41-07:00"), 
      grant_id: "c541aaf05d90cb78846a73b346fc43e65be28b7163129488c738e0c9e0628f4f", 
      grantee_principal: "acm.us-east-2.amazonaws.com", 
      issuing_account: "arn:aws:iam::111122223333:root", 
      key_id: "arn:aws:kms:us-east-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab", 
      operations: [
        "Encrypt", 
        "ReEncryptFrom", 
        "ReEncryptTo", 
      ], 
      retiring_principal: "acm.us-east-2.amazonaws.com", 
    }, 
    {
      creation_date: Time.parse("2016-10-25T14:37:41-07:00"), 
      grant_id: "dd2052c67b4c76ee45caf1dc6a1e2d24e8dc744a51b36ae2f067dc540ce0105c", 
      grantee_principal: "acm.us-east-2.amazonaws.com", 
      issuing_account: "arn:aws:iam::111122223333:root", 
      key_id: "arn:aws:kms:us-east-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab", 
      operations: [
        "Encrypt", 
        "ReEncryptFrom", 
        "ReEncryptTo", 
      ], 
      retiring_principal: "acm.us-east-2.amazonaws.com", 
    }, 
  ], # A list of grants.
  truncated: true, # A boolean that indicates whether there are more items in the list. Returns true when there are more items, or false when there are not.
}

Request syntax with placeholder values


resp = client.list_grants({
  limit: 1,
  marker: "MarkerType",
  key_id: "KeyIdType", # required
})

Response structure


resp.grants #=> Array
resp.grants[0].key_id #=> String
resp.grants[0].grant_id #=> String
resp.grants[0].name #=> String
resp.grants[0].creation_date #=> Time
resp.grants[0].grantee_principal #=> String
resp.grants[0].retiring_principal #=> String
resp.grants[0]. #=> String
resp.grants[0].operations #=> Array
resp.grants[0].operations[0] #=> String, one of "Decrypt", "Encrypt", "GenerateDataKey", "GenerateDataKeyWithoutPlaintext", "ReEncryptFrom", "ReEncryptTo", "Sign", "Verify", "GetPublicKey", "CreateGrant", "RetireGrant", "DescribeKey", "GenerateDataKeyPair", "GenerateDataKeyPairWithoutPlaintext"
resp.grants[0].constraints.encryption_context_subset #=> Hash
resp.grants[0].constraints.encryption_context_subset["EncryptionContextKey"] #=> String
resp.grants[0].constraints.encryption_context_equals #=> Hash
resp.grants[0].constraints.encryption_context_equals["EncryptionContextKey"] #=> String
resp.next_marker #=> String
resp.truncated #=> Boolean

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :limit (Integer) —

    Use this parameter to specify the maximum number of items to return. When this value is present, AWS KMS does not return more than the specified number of items, but it might return fewer.

    This value is optional. If you include a value, it must be between 1 and 100, inclusive. If you do not include a value, it defaults to 50.

  • :marker (String) —

    Use this parameter in a subsequent request after you receive a response with truncated results. Set it to the value of NextMarker from the truncated response you just received.

  • :key_id (required, String) —

    A unique identifier for the customer master key (CMK).

    Specify the key ID or the Amazon Resource Name (ARN) of the CMK. To specify a CMK in a different AWS account, you must use the key 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

    To get the key ID and key ARN for a CMK, use ListKeys or DescribeKey.

Returns:

See Also:



3838
3839
3840
3841
 
# File 'gems/aws-sdk-kms/lib/aws-sdk-kms/client.rb', line 3838

def list_grants(params = {}, options = {})
  req = build_request(:list_grants, params)
  req.send_request(options)
end

#list_key_policies(params = {}) ⇒ Types::ListKeyPoliciesResponse

Gets the names of the key policies that are attached to a customer master key (CMK). This operation is designed to get policy names that you can use in a GetKeyPolicy operation. However, the only valid policy name is default. You cannot perform this operation on a CMK in a different AWS account.

The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.

Examples:

Example: To list key policies for a customer master key (CMK)


# The following example lists key policies for the specified CMK.

resp = client.list_key_policies({
  key_id: "1234abcd-12ab-34cd-56ef-1234567890ab", # The identifier of the CMK whose key policies you want to list. You can use the key ID or the Amazon Resource Name (ARN) of the CMK.
})

resp.to_h outputs the following:
{
  policy_names: [
    "default", 
  ], # A list of key policy names.
  truncated: false, # A boolean that indicates whether there are more items in the list. Returns true when there are more items, or false when there are not.
}

Request syntax with placeholder values


resp = client.list_key_policies({
  key_id: "KeyIdType", # required
  limit: 1,
  marker: "MarkerType",
})

Response structure


resp.policy_names #=> Array
resp.policy_names[0] #=> String
resp.next_marker #=> String
resp.truncated #=> Boolean

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :key_id (required, String) —

    A unique identifier for the customer master key (CMK).

    Specify the key ID or the Amazon Resource Name (ARN) of the CMK.

    For example:

    • Key ID: 1234abcd-12ab-34cd-56ef-1234567890ab

    • Key ARN: arn:aws:kms:us-east-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab

    To get the key ID and key ARN for a CMK, use ListKeys or DescribeKey.

  • :limit (Integer) —

    Use this parameter to specify the maximum number of items to return. When this value is present, AWS KMS does not return more than the specified number of items, but it might return fewer.

    This value is optional. If you include a value, it must be between 1 and 1000, inclusive. If you do not include a value, it defaults to 100.

    Only one policy can be attached to a key.

  • :marker (String) —

    Use this parameter in a subsequent request after you receive a response with truncated results. Set it to the value of NextMarker from the truncated response you just received.

Returns:

See Also:



3923
3924
3925
3926
 
# File 'gems/aws-sdk-kms/lib/aws-sdk-kms/client.rb', line 3923

def list_key_policies(params = {}, options = {})
  req = build_request(:list_key_policies, params)
  req.send_request(options)
end

#list_keys(params = {}) ⇒ Types::ListKeysResponse

Gets a list of all customer master keys (CMKs) in the caller's AWS account and Region.

The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.

Examples:

Example: To list customer master keys (CMKs)


# The following example lists CMKs.

resp = client.list_keys({
})

resp.to_h outputs the following:
{
  keys: [
    {
      key_arn: "arn:aws:kms:us-east-2:111122223333:key/0d990263-018e-4e65-a703-eff731de951e", 
      key_id: "0d990263-018e-4e65-a703-eff731de951e", 
    }, 
    {
      key_arn: "arn:aws:kms:us-east-2:111122223333:key/144be297-0ae1-44ac-9c8f-93cd8c82f841", 
      key_id: "144be297-0ae1-44ac-9c8f-93cd8c82f841", 
    }, 
    {
      key_arn: "arn:aws:kms:us-east-2:111122223333:key/21184251-b765-428e-b852-2c7353e72571", 
      key_id: "21184251-b765-428e-b852-2c7353e72571", 
    }, 
    {
      key_arn: "arn:aws:kms:us-east-2:111122223333:key/214fe92f-5b03-4ae1-b350-db2a45dbe10c", 
      key_id: "214fe92f-5b03-4ae1-b350-db2a45dbe10c", 
    }, 
    {
      key_arn: "arn:aws:kms:us-east-2:111122223333:key/339963f2-e523-49d3-af24-a0fe752aa458", 
      key_id: "339963f2-e523-49d3-af24-a0fe752aa458", 
    }, 
    {
      key_arn: "arn:aws:kms:us-east-2:111122223333:key/b776a44b-df37-4438-9be4-a27494e4271a", 
      key_id: "b776a44b-df37-4438-9be4-a27494e4271a", 
    }, 
    {
      key_arn: "arn:aws:kms:us-east-2:111122223333:key/deaf6c9e-cf2c-46a6-bf6d-0b6d487cffbb", 
      key_id: "deaf6c9e-cf2c-46a6-bf6d-0b6d487cffbb", 
    }, 
  ], # A list of CMKs, including the key ID and Amazon Resource Name (ARN) of each one.
  truncated: false, # A boolean that indicates whether there are more items in the list. Returns true when there are more items, or false when there are not.
}

Request syntax with placeholder values


resp = client.list_keys({
  limit: 1,
  marker: "MarkerType",
})

Response structure


resp.keys #=> Array
resp.keys[0].key_id #=> String
resp.keys[0].key_arn #=> String
resp.next_marker #=> String
resp.truncated #=> Boolean

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :limit (Integer) —

    Use this parameter to specify the maximum number of items to return. When this value is present, AWS KMS does not return more than the specified number of items, but it might return fewer.

    This value is optional. If you include a value, it must be between 1 and 1000, inclusive. If you do not include a value, it defaults to 100.

  • :marker (String) —

    Use this parameter in a subsequent request after you receive a response with truncated results. Set it to the value of NextMarker from the truncated response you just received.

Returns:

See Also:



4015
4016
4017
4018
 
# File 'gems/aws-sdk-kms/lib/aws-sdk-kms/client.rb', line 4015

def list_keys(params = {}, options = {})
  req = build_request(:list_keys, params)
  req.send_request(options)
end

#list_resource_tags(params = {}) ⇒ Types::ListResourceTagsResponse

Returns a list of all tags for the specified customer master key (CMK).

You cannot perform this operation on a CMK in a different AWS account.

Examples:

Example: To list tags for a customer master key (CMK)


# The following example lists tags for a CMK.

resp = client.list_resource_tags({
  key_id: "1234abcd-12ab-34cd-56ef-1234567890ab", # The identifier of the CMK whose tags you are listing. You can use the key ID or the Amazon Resource Name (ARN) of the CMK.
})

resp.to_h outputs the following:
{
  tags: [
    {
      tag_key: "CostCenter", 
      tag_value: "87654", 
    }, 
    {
      tag_key: "CreatedBy", 
      tag_value: "ExampleUser", 
    }, 
    {
      tag_key: "Purpose", 
      tag_value: "Test", 
    }, 
  ], # A list of tags.
  truncated: false, # A boolean that indicates whether there are more items in the list. Returns true when there are more items, or false when there are not.
}

Request syntax with placeholder values


resp = client.list_resource_tags({
  key_id: "KeyIdType", # required
  limit: 1,
  marker: "MarkerType",
})

Response structure


resp.tags #=> Array
resp.tags[0].tag_key #=> String
resp.tags[0].tag_value #=> String
resp.next_marker #=> String
resp.truncated #=> Boolean

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :key_id (required, String) —

    A unique identifier for the customer master key (CMK).

    Specify the key ID or the Amazon Resource Name (ARN) of the CMK.

    For example:

    • Key ID: 1234abcd-12ab-34cd-56ef-1234567890ab

    • Key ARN: arn:aws:kms:us-east-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab

    To get the key ID and key ARN for a CMK, use ListKeys or DescribeKey.

  • :limit (Integer) —

    Use this parameter to specify the maximum number of items to return. When this value is present, AWS KMS does not return more than the specified number of items, but it might return fewer.

    This value is optional. If you include a value, it must be between 1 and 50, inclusive. If you do not include a value, it defaults to 50.

  • :marker (String) —

    Use this parameter in a subsequent request after you receive a response with truncated results. Set it to the value of NextMarker from the truncated response you just received.

    Do not attempt to construct this value. Use only the value of NextMarker from the truncated response you just received.

Returns:

See Also:



4109
4110
4111
4112
 
# File 'gems/aws-sdk-kms/lib/aws-sdk-kms/client.rb', line 4109

def list_resource_tags(params = {}, options = {})
  req = build_request(:list_resource_tags, params)
  req.send_request(options)
end

#list_retirable_grants(params = {}) ⇒ Types::ListGrantsResponse

Returns a list of all grants for which the grant's RetiringPrincipal matches the one specified.

A typical use is to list all grants that you are able to retire. To retire a grant, use RetireGrant.

Examples:

Example: To list grants that the specified principal can retire


# The following example lists the grants that the specified principal (identity) can retire.

resp = client.list_retirable_grants({
  retiring_principal: "arn:aws:iam::111122223333:role/ExampleRole", # The retiring principal whose grants you want to list. Use the Amazon Resource Name (ARN) of an AWS principal such as an AWS account (root), IAM user, federated user, or assumed role user.
})

resp.to_h outputs the following:
{
  grants: [
    {
      creation_date: Time.parse("2016-12-07T11:09:35-08:00"), 
      grant_id: "0c237476b39f8bc44e45212e08498fbe3151305030726c0590dd8d3e9f3d6a60", 
      grantee_principal: "arn:aws:iam::111122223333:role/ExampleRole", 
      issuing_account: "arn:aws:iam::444455556666:root", 
      key_id: "arn:aws:kms:us-east-2:444455556666:key/1234abcd-12ab-34cd-56ef-1234567890ab", 
      operations: [
        "Decrypt", 
        "Encrypt", 
      ], 
      retiring_principal: "arn:aws:iam::111122223333:role/ExampleRole", 
    }, 
  ], # A list of grants that the specified principal can retire.
  truncated: false, # A boolean that indicates whether there are more items in the list. Returns true when there are more items, or false when there are not.
}

Request syntax with placeholder values


resp = client.list_retirable_grants({
  limit: 1,
  marker: "MarkerType",
  retiring_principal: "PrincipalIdType", # required
})

Response structure


resp.grants #=> Array
resp.grants[0].key_id #=> String
resp.grants[0].grant_id #=> String
resp.grants[0].name #=> String
resp.grants[0].creation_date #=> Time
resp.grants[0].grantee_principal #=> String
resp.grants[0].retiring_principal #=> String
resp.grants[0]. #=> String
resp.grants[0].operations #=> Array
resp.grants[0].operations[0] #=> String, one of "Decrypt", "Encrypt", "GenerateDataKey", "GenerateDataKeyWithoutPlaintext", "ReEncryptFrom", "ReEncryptTo", "Sign", "Verify", "GetPublicKey", "CreateGrant", "RetireGrant", "DescribeKey", "GenerateDataKeyPair", "GenerateDataKeyPairWithoutPlaintext"
resp.grants[0].constraints.encryption_context_subset #=> Hash
resp.grants[0].constraints.encryption_context_subset["EncryptionContextKey"] #=> String
resp.grants[0].constraints.encryption_context_equals #=> Hash
resp.grants[0].constraints.encryption_context_equals["EncryptionContextKey"] #=> String
resp.next_marker #=> String
resp.truncated #=> Boolean

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :limit (Integer) —

    Use this parameter to specify the maximum number of items to return. When this value is present, AWS KMS does not return more than the specified number of items, but it might return fewer.

    This value is optional. If you include a value, it must be between 1 and 100, inclusive. If you do not include a value, it defaults to 50.

  • :marker (String) —

    Use this parameter in a subsequent request after you receive a response with truncated results. Set it to the value of NextMarker from the truncated response you just received.

  • :retiring_principal (required, String) —

    The retiring principal for which to list grants.

    To specify the retiring principal, use the Amazon Resource Name (ARN) of an AWS principal. Valid AWS principals include AWS accounts (root), IAM users, federated users, and assumed role users. For examples of the ARN syntax for specifying a principal, see AWS Identity and Access Management (IAM) in the Example ARNs section of the Amazon Web Services General Reference.

Returns:

See Also:



4213
4214
4215
4216
 
# File 'gems/aws-sdk-kms/lib/aws-sdk-kms/client.rb', line 4213

def list_retirable_grants(params = {}, options = {})
  req = build_request(:list_retirable_grants, params)
  req.send_request(options)
end

#put_key_policy(params = {}) ⇒ Struct

Attaches a key policy to the specified customer master key (CMK). You cannot perform this operation on a CMK in a different AWS account.

For more information about key policies, see Key Policies in the AWS Key Management Service Developer Guide.

Examples:

Example: To attach a key policy to a customer master key (CMK)


# The following example attaches a key policy to the specified CMK.

resp = client.put_key_policy({
  key_id: "1234abcd-12ab-34cd-56ef-1234567890ab", # The identifier of the CMK to attach the key policy to. You can use the key ID or the Amazon Resource Name (ARN) of the CMK.
  policy: "{\"Version\":\"2012-10-17\",\"Id\":\"custom-policy-2016-12-07\",\"Statement\":[{\"Sid\":\"EnableIAMUserPermissions\",\"Effect\":\"Allow\",\"Principal\":{\"AWS\":\"arn:aws:iam::111122223333:root\"},\"Action\":\"kms:*\",\"Resource\":\"*\"},{\"Sid\":\"AllowaccessforKeyAdministrators\",\"Effect\":\"Allow\",\"Principal\":{\"AWS\":[\"arn:aws:iam::111122223333:user/ExampleAdminUser\",\"arn:aws:iam::111122223333:role/ExampleAdminRole\"]},\"Action\":[\"kms:Create*\",\"kms:Describe*\",\"kms:Enable*\",\"kms:List*\",\"kms:Put*\",\"kms:Update*\",\"kms:Revoke*\",\"kms:Disable*\",\"kms:Get*\",\"kms:Delete*\",\"kms:ScheduleKeyDeletion\",\"kms:CancelKeyDeletion\"],\"Resource\":\"*\"},{\"Sid\":\"Allowuseofthekey\",\"Effect\":\"Allow\",\"Principal\":{\"AWS\":\"arn:aws:iam::111122223333:role/ExamplePowerUserRole\"},\"Action\":[\"kms:Encrypt\",\"kms:Decrypt\",\"kms:ReEncrypt*\",\"kms:GenerateDataKey*\",\"kms:DescribeKey\"],\"Resource\":\"*\"},{\"Sid\":\"Allowattachmentofpersistentresources\",\"Effect\":\"Allow\",\"Principal\":{\"AWS\":\"arn:aws:iam::111122223333:role/ExamplePowerUserRole\"},\"Action\":[\"kms:CreateGrant\",\"kms:ListGrants\",\"kms:RevokeGrant\"],\"Resource\":\"*\",\"Condition\":{\"Bool\":{\"kms:GrantIsForAWSResource\":\"true\"}}}]}", # The key policy document.
  policy_name: "default", # The name of the key policy.
})

Request syntax with placeholder values


resp = client.put_key_policy({
  key_id: "KeyIdType", # required
  policy_name: "PolicyNameType", # required
  policy: "PolicyType", # required
  bypass_policy_lockout_safety_check: false,
})

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :key_id (required, String) —

    A unique identifier for the customer master key (CMK).

    Specify the key ID or the Amazon Resource Name (ARN) of the CMK.

    For example:

    • Key ID: 1234abcd-12ab-34cd-56ef-1234567890ab

    • Key ARN: arn:aws:kms:us-east-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab

    To get the key ID and key ARN for a CMK, use ListKeys or DescribeKey.

  • :policy_name (required, String) —

    The name of the key policy. The only valid value is default.

  • :policy (required, String) —

    The key policy to attach to the CMK.

    The key policy must meet the following criteria:

    • If you don't set BypassPolicyLockoutSafetyCheck to true, the key policy must allow the principal that is making the PutKeyPolicy request to make a subsequent PutKeyPolicy request on the CMK. This reduces the risk that the CMK becomes unmanageable. For more information, refer to the scenario in the Default Key Policy section of the AWS Key Management Service Developer Guide.

    • Each statement in the key policy must contain one or more principals. The principals in the key policy must exist and be visible to AWS KMS. When you create a new AWS principal (for example, an IAM user or role), you might need to enforce a delay before including the new principal in a key policy because the new principal might not be immediately visible to AWS KMS. For more information, see Changes that I make are not always immediately visible in the AWS Identity and Access Management User Guide.

    The key policy cannot exceed 32 kilobytes (32768 bytes). For more information, see Resource Quotas in the AWS Key Management Service Developer Guide.

  • :bypass_policy_lockout_safety_check (Boolean) —

    A flag to indicate whether to bypass the key policy lockout safety check.

    Setting this value to true increases the risk that the CMK becomes unmanageable. Do not set this value to true indiscriminately.

    For more information, refer to the scenario in the Default Key Policy section in the AWS Key Management Service Developer Guide.

    Use this parameter only when you intend to prevent the principal that is making the request from making a subsequent PutKeyPolicy request on the CMK.

    The default value is false.

Returns:

  • (Struct) —

    Returns an empty response.

See Also:



4323
4324
4325
4326
 
# File 'gems/aws-sdk-kms/lib/aws-sdk-kms/client.rb', line 4323

def put_key_policy(params = {}, options = {})
  req = build_request(:put_key_policy, params)
  req.send_request(options)
end

#re_encrypt(params = {}) ⇒ Types::ReEncryptResponse

Decrypts ciphertext and then reencrypts it entirely within AWS KMS. You can use this operation to change the customer master key (CMK) under which data is encrypted, such as when you manually rotate a CMK or change the CMK that protects a ciphertext. You can also use it to reencrypt ciphertext under the same CMK, such as to change the encryption context of a ciphertext.

The ReEncrypt operation can decrypt ciphertext that was encrypted by using an AWS KMS CMK in an AWS KMS operation, such as Encrypt or GenerateDataKey. It can also decrypt ciphertext that was encrypted by using the public key of an asymmetric CMK outside of AWS KMS. However, it cannot decrypt ciphertext produced by other libraries, such as the AWS Encryption SDK or Amazon S3 client-side encryption. These libraries return a ciphertext format that is incompatible with AWS KMS.

When you use the ReEncrypt operation, you need to provide information for the decrypt operation and the subsequent encrypt operation.

  • If your ciphertext was encrypted under an asymmetric CMK, you must identify the source CMK, that is, the CMK that encrypted the ciphertext. You must also supply the encryption algorithm that was used. This information is required to decrypt the data.

  • It is optional, but you can specify a source CMK even when the ciphertext was encrypted under a symmetric CMK. This ensures that the ciphertext is decrypted only by using a particular CMK. If the CMK that you specify cannot decrypt the ciphertext, the ReEncrypt operation fails.

  • To reencrypt the data, you must specify the destination CMK, that is, the CMK that re-encrypts the data after it is decrypted. You can select a symmetric or asymmetric CMK. If the destination CMK is an asymmetric CMK, you must also provide the encryption algorithm. The algorithm that you choose must be compatible with the CMK.

    When you use an asymmetric CMK to encrypt or reencrypt data, be sure to record the CMK and encryption algorithm that you choose. You will be required to provide the same CMK and encryption algorithm when you decrypt the data. If the CMK and algorithm do not match the values used to encrypt the data, the decrypt operation fails.

    You are not required to supply the CMK ID and encryption algorithm when you decrypt with symmetric CMKs because AWS KMS stores this information in the ciphertext blob. AWS KMS cannot store metadata in ciphertext generated with asymmetric keys. The standard format for asymmetric key ciphertext does not include configurable fields.

Unlike other AWS KMS API operations, ReEncrypt callers must have two permissions:

  • kms:ReEncryptFrom permission on the source CMK

  • kms:ReEncryptTo permission on the destination CMK

To permit reencryption from or to a CMK, include the "kms:ReEncrypt*" permission in your key policy. This permission is automatically included in the key policy when you use the console to create a CMK. But you must include it manually when you create a CMK programmatically or when you use the PutKeyPolicy operation to set a key policy.

The CMK that you use for this operation must be in a compatible key state. For details, see How Key State Affects Use of a Customer Master Key in the AWS Key Management Service Developer Guide.

Examples:

Example: To reencrypt data


# The following example reencrypts data with the specified CMK.

resp = client.re_encrypt({
  ciphertext_blob: "<binary data>", # The data to reencrypt.
  destination_key_id: "0987dcba-09fe-87dc-65ba-ab0987654321", # The identifier of the CMK to use to reencrypt the data. You can use the key ID or Amazon Resource Name (ARN) of the CMK, or the name or ARN of an alias that refers to the CMK.
})

resp.to_h outputs the following:
{
  ciphertext_blob: "<binary data>", # The reencrypted data.
  key_id: "arn:aws:kms:us-east-2:111122223333:key/0987dcba-09fe-87dc-65ba-ab0987654321", # The ARN of the CMK that was used to reencrypt the data.
  source_key_id: "arn:aws:kms:us-east-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab", # The ARN of the CMK that was used to originally encrypt the data.
}

Request syntax with placeholder values


resp = client.re_encrypt({
  ciphertext_blob: "data", # required
  source_encryption_context: {
    "EncryptionContextKey" => "EncryptionContextValue",
  },
  source_key_id: "KeyIdType",
  destination_key_id: "KeyIdType", # required
  destination_encryption_context: {
    "EncryptionContextKey" => "EncryptionContextValue",
  },
  source_encryption_algorithm: "SYMMETRIC_DEFAULT", # accepts SYMMETRIC_DEFAULT, RSAES_OAEP_SHA_1, RSAES_OAEP_SHA_256
  destination_encryption_algorithm: "SYMMETRIC_DEFAULT", # accepts SYMMETRIC_DEFAULT, RSAES_OAEP_SHA_1, RSAES_OAEP_SHA_256
  grant_tokens: ["GrantTokenType"],
})

Response structure


resp.ciphertext_blob #=> String
resp.source_key_id #=> String
resp.key_id #=> String
resp.source_encryption_algorithm #=> String, one of "SYMMETRIC_DEFAULT", "RSAES_OAEP_SHA_1", "RSAES_OAEP_SHA_256"
resp.destination_encryption_algorithm #=> String, one of "SYMMETRIC_DEFAULT", "RSAES_OAEP_SHA_1", "RSAES_OAEP_SHA_256"

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :ciphertext_blob (required, String, IO) —

    Ciphertext of the data to reencrypt.

  • :source_encryption_context (Hash<String,String>) —

    Specifies the encryption context to use to decrypt the ciphertext. Enter the same encryption context that was used to encrypt the ciphertext.

    An encryption context is a collection of non-secret key-value pairs that represents additional authenticated data. When you use an encryption context to encrypt data, you must specify the same (an exact case-sensitive match) encryption context to decrypt the data. An encryption context is optional when encrypting with a symmetric CMK, but it is highly recommended.

    For more information, see Encryption Context in the AWS Key Management Service Developer Guide.

  • :source_key_id (String) —

    A unique identifier for the CMK that is used to decrypt the ciphertext before it reencrypts it using the destination CMK.

    This parameter is required only when the ciphertext was encrypted under an asymmetric CMK. Otherwise, AWS KMS uses the metadata that it adds to the ciphertext blob to determine which CMK was used to encrypt the ciphertext. However, you can use this parameter to ensure that a particular CMK (of any kind) is used to decrypt the ciphertext before it is reencrypted.

    If you specify a KeyId value, the decrypt part of the ReEncrypt operation succeeds only if the specified CMK was used to encrypt the ciphertext.

    To specify a CMK, use its key ID, Amazon Resource Name (ARN), alias name, or alias ARN. When using an alias name, prefix it with "alias/".

    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

    To get the key ID and key ARN for a CMK, use ListKeys or DescribeKey. To get the alias name and alias ARN, use ListAliases.

  • :destination_key_id (required, String) —

    A unique identifier for the CMK that is used to reencrypt the data. Specify a symmetric or asymmetric CMK with a KeyUsage value of ENCRYPT_DECRYPT. To find the KeyUsage value of a CMK, use the DescribeKey operation.

    To specify a CMK, 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 CMK in a different AWS 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

    To get the key ID and key ARN for a CMK, use ListKeys or DescribeKey. To get the alias name and alias ARN, use ListAliases.

  • :destination_encryption_context (Hash<String,String>) —

    Specifies that encryption context to use when the reencrypting the data.

    A destination encryption context is valid only when the destination CMK is a symmetric CMK. The standard ciphertext format for asymmetric CMKs does not include fields for metadata.

    An encryption context is a collection of non-secret key-value pairs that represents additional authenticated data. When you use an encryption context to encrypt data, you must specify the same (an exact case-sensitive match) encryption context to decrypt the data. An encryption context is optional when encrypting with a symmetric CMK, but it is highly recommended.

    For more information, see Encryption Context in the AWS Key Management Service Developer Guide.

  • :source_encryption_algorithm (String) —

    Specifies the encryption algorithm that AWS KMS will use to decrypt the ciphertext before it is reencrypted. The default value, SYMMETRIC_DEFAULT, represents the algorithm used for symmetric CMKs.

    Specify the same algorithm that was used to encrypt the ciphertext. If you specify a different algorithm, the decrypt attempt fails.

    This parameter is required only when the ciphertext was encrypted under an asymmetric CMK.

  • :destination_encryption_algorithm (String) —

    Specifies the encryption algorithm that AWS KMS will use to reecrypt the data after it has decrypted it. The default value, SYMMETRIC_DEFAULT, represents the encryption algorithm used for symmetric CMKs.

    This parameter is required only when the destination CMK is an asymmetric CMK.

  • :grant_tokens (Array<String>) —

    A list of grant tokens.

    For more information, see Grant Tokens in the AWS Key Management Service Developer Guide.

Returns:

See Also:



4591
4592
4593
4594
 
# File 'gems/aws-sdk-kms/lib/aws-sdk-kms/client.rb', line 4591

def re_encrypt(params = {}, options = {})
  req = build_request(:re_encrypt, params)
  req.send_request(options)
end

#retire_grant(params = {}) ⇒ Struct

Retires a grant. To clean up, you can retire a grant when you're done using it. You should revoke a grant when you intend to actively deny operations that depend on it. The following are permitted to call this API:

  • The AWS account (root user) under which the grant was created

  • The RetiringPrincipal, if present in the grant

  • The GranteePrincipal, if RetireGrant is an operation specified in the grant

You must identify the grant to retire by its grant token or by a combination of the grant ID and the Amazon Resource Name (ARN) of the customer master key (CMK). A grant token is a unique variable-length base64-encoded string. A grant ID is a 64 character unique identifier of a grant. The CreateGrant operation returns both.

Examples:

Example: To retire a grant


# The following example retires a grant.

resp = client.retire_grant({
  grant_id: "0c237476b39f8bc44e45212e08498fbe3151305030726c0590dd8d3e9f3d6a60", # The identifier of the grant to retire.
  key_id: "arn:aws:kms:us-east-2:444455556666:key/1234abcd-12ab-34cd-56ef-1234567890ab", # The Amazon Resource Name (ARN) of the customer master key (CMK) associated with the grant.
})

Request syntax with placeholder values


resp = client.retire_grant({
  grant_token: "GrantTokenType",
  key_id: "KeyIdType",
  grant_id: "GrantIdType",
})

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :grant_token (String) —

    Token that identifies the grant to be retired.

  • :key_id (String) —

    The Amazon Resource Name (ARN) of the CMK associated with the grant.

    For example: arn:aws:kms:us-east-2:444455556666:key/1234abcd-12ab-34cd-56ef-1234567890ab

  • :grant_id (String) —

    Unique identifier of the grant to retire. The grant ID is returned in the response to a CreateGrant operation.

    • Grant ID Example - 0123456789012345678901234567890123456789012345678901234567890123

    ^

Returns:

  • (Struct) —

    Returns an empty response.

See Also:



4656
4657
4658
4659
 
# File 'gems/aws-sdk-kms/lib/aws-sdk-kms/client.rb', line 4656

def retire_grant(params = {}, options = {})
  req = build_request(:retire_grant, params)
  req.send_request(options)
end

#revoke_grant(params = {}) ⇒ Struct

Revokes the specified grant for the specified customer master key (CMK). You can revoke a grant to actively deny operations that depend on it.

To perform this operation on a CMK in a different AWS account, specify the key ARN in the value of the KeyId parameter.

Examples:

Example: To revoke a grant


# The following example revokes a grant.

resp = client.revoke_grant({
  grant_id: "0c237476b39f8bc44e45212e08498fbe3151305030726c0590dd8d3e9f3d6a60", # The identifier of the grant to revoke.
  key_id: "1234abcd-12ab-34cd-56ef-1234567890ab", # The identifier of the customer master key (CMK) associated with the grant. You can use the key ID or the Amazon Resource Name (ARN) of the CMK.
})

Request syntax with placeholder values


resp = client.revoke_grant({
  key_id: "KeyIdType", # required
  grant_id: "GrantIdType", # required
})

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :key_id (required, String) —

    A unique identifier for the customer master key associated with the grant.

    Specify the key ID or the Amazon Resource Name (ARN) of the CMK. To specify a CMK in a different AWS account, you must use the key 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

    To get the key ID and key ARN for a CMK, use ListKeys or DescribeKey.

  • :grant_id (required, String) —

    Identifier of the grant to be revoked.

Returns:

  • (Struct) —

    Returns an empty response.

See Also:



4710
4711
4712
4713
 
# File 'gems/aws-sdk-kms/lib/aws-sdk-kms/client.rb', line 4710

def revoke_grant(params = {}, options = {})
  req = build_request(:revoke_grant, params)
  req.send_request(options)
end

#schedule_key_deletion(params = {}) ⇒ Types::ScheduleKeyDeletionResponse

Schedules the deletion of a customer master key (CMK). You may provide a waiting period, specified in days, before deletion occurs. If you do not provide a waiting period, the default period of 30 days is used. When this operation is successful, the key state of the CMK changes to PendingDeletion. Before the waiting period ends, you can use CancelKeyDeletion to cancel the deletion of the CMK. After the waiting period ends, AWS KMS deletes the CMK and all AWS KMS data associated with it, including all aliases that refer to it.

Deleting a CMK is a destructive and potentially dangerous operation. When a CMK is deleted, all data that was encrypted under the CMK is unrecoverable. To prevent the use of a CMK without deleting it, use DisableKey.

If you schedule deletion of a CMK from a custom key store, when the waiting period expires, ScheduleKeyDeletion deletes the CMK from AWS KMS. Then AWS KMS makes a best effort to delete the key material from the associated AWS CloudHSM cluster. However, you might need to manually delete the orphaned key material from the cluster and its backups.

You cannot perform this operation on a CMK in a different AWS account.

For more information about scheduling a CMK for deletion, see Deleting Customer Master Keys in the AWS Key Management Service Developer Guide.

The CMK that you use for this operation must be in a compatible key state. For details, see How Key State Affects Use of a Customer Master Key in the AWS Key Management Service Developer Guide.

Examples:

Example: To schedule a customer master key (CMK) for deletion


# The following example schedules the specified CMK for deletion.

resp = client.schedule_key_deletion({
  key_id: "1234abcd-12ab-34cd-56ef-1234567890ab", # The identifier of the CMK to schedule for deletion. You can use the key ID or the Amazon Resource Name (ARN) of the CMK.
  pending_window_in_days: 7, # The waiting period, specified in number of days. After the waiting period ends, AWS KMS deletes the CMK.
})

resp.to_h outputs the following:
{
  deletion_date: Time.parse("2016-12-17T16:00:00-08:00"), # The date and time after which AWS KMS deletes the CMK.
  key_id: "arn:aws:kms:us-east-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab", # The ARN of the CMK that is scheduled for deletion.
}

Request syntax with placeholder values


resp = client.schedule_key_deletion({
  key_id: "KeyIdType", # required
  pending_window_in_days: 1,
})

Response structure


resp.key_id #=> String
resp.deletion_date #=> Time

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :key_id (required, String) —

    The unique identifier of the customer master key (CMK) to delete.

    Specify the key ID or the Amazon Resource Name (ARN) of the CMK.

    For example:

    • Key ID: 1234abcd-12ab-34cd-56ef-1234567890ab

    • Key ARN: arn:aws:kms:us-east-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab

    To get the key ID and key ARN for a CMK, use ListKeys or DescribeKey.

  • :pending_window_in_days (Integer) —

    The waiting period, specified in number of days. After the waiting period ends, AWS KMS deletes the customer master key (CMK).

    This value is optional. If you include a value, it must be between 7 and 30, inclusive. If you do not include a value, it defaults to 30.

Returns:

See Also:



4811
4812
4813
4814
 
# File 'gems/aws-sdk-kms/lib/aws-sdk-kms/client.rb', line 4811

def schedule_key_deletion(params = {}, options = {})
  req = build_request(:schedule_key_deletion, params)
  req.send_request(options)
end

#sign(params = {}) ⇒ Types::SignResponse

Creates a digital signature for a message or message digest by using the private key in an asymmetric CMK. To verify the signature, use the Verify operation, or use the public key in the same asymmetric CMK outside of AWS KMS. For information about symmetric and asymmetric CMKs, see Using Symmetric and Asymmetric CMKs in the AWS Key Management Service Developer Guide.

Digital signatures are generated and verified by using asymmetric key pair, such as an RSA or ECC pair that is represented by an asymmetric customer master key (CMK). The key owner (or an authorized user) uses their private key to sign a message. Anyone with the public key can verify that the message was signed with that particular private key and that the message hasn't changed since it was signed.

To use the Sign operation, provide the following information:

  • Use the KeyId parameter to identify an asymmetric CMK with a KeyUsage value of SIGN_VERIFY. To get the KeyUsage value of a CMK, use the DescribeKey operation. The caller must have kms:Sign permission on the CMK.

  • Use the Message parameter to specify the message or message digest to sign. You can submit messages of up to 4096 bytes. To sign a larger message, generate a hash digest of the message, and then provide the hash digest in the Message parameter. To indicate whether the message is a full message or a digest, use the MessageType parameter.

  • Choose a signing algorithm that is compatible with the CMK.

When signing a message, be sure to record the CMK and the signing algorithm. This information is required to verify the signature.

To verify the signature that this operation generates, use the Verify operation. Or use the GetPublicKey operation to download the public key and then use the public key to verify the signature outside of AWS KMS.

The CMK that you use for this operation must be in a compatible key state. For details, see How Key State Affects Use of a Customer Master Key in the AWS Key Management Service Developer Guide.

Examples:

Request syntax with placeholder values


resp = client.sign({
  key_id: "KeyIdType", # required
  message: "data", # required
  message_type: "RAW", # accepts RAW, DIGEST
  grant_tokens: ["GrantTokenType"],
  signing_algorithm: "RSASSA_PSS_SHA_256", # required, accepts RSASSA_PSS_SHA_256, RSASSA_PSS_SHA_384, RSASSA_PSS_SHA_512, RSASSA_PKCS1_V1_5_SHA_256, RSASSA_PKCS1_V1_5_SHA_384, RSASSA_PKCS1_V1_5_SHA_512, ECDSA_SHA_256, ECDSA_SHA_384, ECDSA_SHA_512
})

Response structure


resp.key_id #=> String
resp.signature #=> String
resp.signing_algorithm #=> String, one of "RSASSA_PSS_SHA_256", "RSASSA_PSS_SHA_384", "RSASSA_PSS_SHA_512", "RSASSA_PKCS1_V1_5_SHA_256", "RSASSA_PKCS1_V1_5_SHA_384", "RSASSA_PKCS1_V1_5_SHA_512", "ECDSA_SHA_256", "ECDSA_SHA_384", "ECDSA_SHA_512"

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :key_id (required, String) —

    Identifies an asymmetric CMK. AWS KMS uses the private key in the asymmetric CMK to sign the message. The KeyUsage type of the CMK must be SIGN_VERIFY. To find the KeyUsage of a CMK, use the DescribeKey operation.

    To specify a CMK, 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 CMK in a different AWS 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

    To get the key ID and key ARN for a CMK, use ListKeys or DescribeKey. To get the alias name and alias ARN, use ListAliases.

  • :message (required, String, IO) —

    Specifies the message or message digest to sign. Messages can be 0-4096 bytes. To sign a larger message, provide the message digest.

    If you provide a message, AWS KMS generates a hash digest of the message and then signs it.

  • :message_type (String) —

    Tells AWS KMS whether the value of the Message parameter is a message or message digest. The default value, RAW, indicates a message. To indicate a message digest, enter DIGEST.

  • :grant_tokens (Array<String>) —

    A list of grant tokens.

    For more information, see Grant Tokens in the AWS Key Management Service Developer Guide.

  • :signing_algorithm (required, String) —

    Specifies the signing algorithm to use when signing the message.

    Choose an algorithm that is compatible with the type and size of the specified asymmetric CMK.

Returns:

See Also:



4943
4944
4945
4946
 
# File 'gems/aws-sdk-kms/lib/aws-sdk-kms/client.rb', line 4943

def sign(params = {}, options = {})
  req = build_request(:sign, params)
  req.send_request(options)
end

#tag_resource(params = {}) ⇒ Struct

Adds or edits tags for a customer master key (CMK). You cannot perform this operation on a CMK in a different AWS account.

Each tag consists of a tag key and a tag value. Tag keys and tag values are both required, but tag values can be empty (null) strings.

You can only use a tag key once for each CMK. If you use the tag key again, AWS KMS replaces the current tag value with the specified value.

For information about the rules that apply to tag keys and tag values, see User-Defined Tag Restrictions in the AWS Billing and Cost Management User Guide.

The CMK that you use for this operation must be in a compatible key state. For details, see How Key State Affects Use of a Customer Master Key in the AWS Key Management Service Developer Guide.

Examples:

Example: To tag a customer master key (CMK)


# The following example tags a CMK.

resp = client.tag_resource({
  key_id: "1234abcd-12ab-34cd-56ef-1234567890ab", # The identifier of the CMK you are tagging. You can use the key ID or the Amazon Resource Name (ARN) of the CMK.
  tags: [
    {
      tag_key: "Purpose", 
      tag_value: "Test", 
    }, 
  ], # A list of tags.
})

Request syntax with placeholder values


resp = client.tag_resource({
  key_id: "KeyIdType", # required
  tags: [ # required
    {
      tag_key: "TagKeyType", # required
      tag_value: "TagValueType", # required
    },
  ],
})

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :key_id (required, String) —

    A unique identifier for the CMK you are tagging.

    Specify the key ID or the Amazon Resource Name (ARN) of the CMK.

    For example:

    • Key ID: 1234abcd-12ab-34cd-56ef-1234567890ab

    • Key ARN: arn:aws:kms:us-east-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab

    To get the key ID and key ARN for a CMK, use ListKeys or DescribeKey.

  • :tags (required, Array<Types::Tag>) —

    One or more tags. Each tag consists of a tag key and a tag value.

Returns:

  • (Struct) —

    Returns an empty response.

See Also:



5021
5022
5023
5024
 
# File 'gems/aws-sdk-kms/lib/aws-sdk-kms/client.rb', line 5021

def tag_resource(params = {}, options = {})
  req = build_request(:tag_resource, params)
  req.send_request(options)
end

#untag_resource(params = {}) ⇒ Struct

Removes the specified tags from the specified customer master key (CMK). You cannot perform this operation on a CMK in a different AWS account.

To remove a tag, specify the tag key. To change the tag value of an existing tag key, use TagResource.

The CMK that you use for this operation must be in a compatible key state. For details, see How Key State Affects Use of a Customer Master Key in the AWS Key Management Service Developer Guide.

Examples:

Example: To remove tags from a customer master key (CMK)


# The following example removes tags from a CMK.

resp = client.untag_resource({
  key_id: "1234abcd-12ab-34cd-56ef-1234567890ab", # The identifier of the CMK whose tags you are removing.
  tag_keys: [
    "Purpose", 
    "CostCenter", 
  ], # A list of tag keys. Provide only the tag keys, not the tag values.
})

Request syntax with placeholder values


resp = client.untag_resource({
  key_id: "KeyIdType", # required
  tag_keys: ["TagKeyType"], # required
})

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :key_id (required, String) —

    A unique identifier for the CMK from which you are removing tags.

    Specify the key ID or the Amazon Resource Name (ARN) of the CMK.

    For example:

    • Key ID: 1234abcd-12ab-34cd-56ef-1234567890ab

    • Key ARN: arn:aws:kms:us-east-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab

    To get the key ID and key ARN for a CMK, use ListKeys or DescribeKey.

  • :tag_keys (required, Array<String>) —

    One or more tag keys. Specify only the tag keys, not the tag values.

Returns:

  • (Struct) —

    Returns an empty response.

See Also:



5084
5085
5086
5087
 
# File 'gems/aws-sdk-kms/lib/aws-sdk-kms/client.rb', line 5084

def untag_resource(params = {}, options = {})
  req = build_request(:untag_resource, params)
  req.send_request(options)
end

#update_alias(params = {}) ⇒ Struct

Associates an existing AWS KMS alias with a different customer master key (CMK). Each alias is associated with only one CMK at a time, although a CMK can have multiple aliases. The alias and the CMK must be in the same AWS account and region. You cannot perform this operation on an alias in a different AWS account.

The current and new CMK must be the same type (both symmetric or both asymmetric), and they must have the same key usage (ENCRYPT_DECRYPT or SIGN_VERIFY). This restriction prevents errors in code that uses aliases. If you must assign an alias to a different type of CMK, use DeleteAlias to delete the old alias and CreateAlias to create a new alias.

You cannot use UpdateAlias to change an alias name. To change an alias name, use DeleteAlias to delete the old alias and CreateAlias to create a new alias.

Because an alias is not a property of a CMK, you can create, update, and delete the aliases of a CMK without affecting the CMK. Also, aliases do not appear in the response from the DescribeKey operation. To get the aliases of all CMKs in the account, use the ListAliases operation.

The CMK that you use for this operation must be in a compatible key state. For details, see How Key State Affects Use of a Customer Master Key in the AWS Key Management Service Developer Guide.

Examples:

Example: To update an alias


# The following example updates the specified alias to refer to the specified customer master key (CMK).

resp = client.update_alias({
  alias_name: "alias/ExampleAlias", # The alias to update.
  target_key_id: "1234abcd-12ab-34cd-56ef-1234567890ab", # The identifier of the CMK that the alias will refer to after this operation succeeds. You can use the key ID or the Amazon Resource Name (ARN) of the CMK.
})

Request syntax with placeholder values


resp = client.update_alias({
  alias_name: "AliasNameType", # required
  target_key_id: "KeyIdType", # required
})

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :alias_name (required, String) —

    Identifies the alias that is changing its CMK. This value must begin with alias/ followed by the alias name, such as alias/ExampleAlias. You cannot use UpdateAlias to change the alias name.

  • :target_key_id (required, String) —

    Identifies the CMK to associate with the alias. When the update operation completes, the alias will point to this CMK.

    The CMK must be in the same AWS account and Region as the alias. Also, the new target CMK must be the same type as the current target CMK (both symmetric or both asymmetric) and they must have the same key usage.

    Specify the key ID or the Amazon Resource Name (ARN) of the CMK.

    For example:

    • Key ID: 1234abcd-12ab-34cd-56ef-1234567890ab

    • Key ARN: arn:aws:kms:us-east-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab

    To get the key ID and key ARN for a CMK, use ListKeys or DescribeKey.

    To verify that the alias is mapped to the correct CMK, use ListAliases.

Returns:

  • (Struct) —

    Returns an empty response.

See Also:



5172
5173
5174
5175
 
# File 'gems/aws-sdk-kms/lib/aws-sdk-kms/client.rb', line 5172

def update_alias(params = {}, options = {})
  req = build_request(:update_alias, params)
  req.send_request(options)
end

#update_custom_key_store(params = {}) ⇒ Struct

Changes the properties of a custom key store. Use the CustomKeyStoreId parameter to identify the custom key store you want to edit. Use the remaining parameters to change the properties of the custom key store.

You can only update a custom key store that is disconnected. To disconnect the custom key store, use DisconnectCustomKeyStore. To reconnect the custom key store after the update completes, use ConnectCustomKeyStore. To find the connection state of a custom key store, use the DescribeCustomKeyStores operation.

Use the parameters of UpdateCustomKeyStore to edit your keystore settings.

  • Use the NewCustomKeyStoreName parameter to change the friendly name of the custom key store to the value that you specify.

  • Use the KeyStorePassword parameter tell AWS KMS the current password of the kmsuser crypto user (CU) in the associated AWS CloudHSM cluster. You can use this parameter to fix connection failures that occur when AWS KMS cannot log into the associated cluster because the kmsuser password has changed. This value does not change the password in the AWS CloudHSM cluster.

  • Use the CloudHsmClusterId parameter to associate the custom key store with a different, but related, AWS CloudHSM cluster. You can use this parameter to repair a custom key store if its AWS CloudHSM cluster becomes corrupted or is deleted, or when you need to create or restore a cluster from a backup.

If the operation succeeds, it returns a JSON object with no properties.

This operation is part of the Custom Key Store feature feature in AWS KMS, which combines the convenience and extensive integration of AWS KMS with the isolation and control of a single-tenant key store.

Examples:

Request syntax with placeholder values


resp = client.update_custom_key_store({
  custom_key_store_id: "CustomKeyStoreIdType", # required
  new_custom_key_store_name: "CustomKeyStoreNameType",
  key_store_password: "KeyStorePasswordType",
  cloud_hsm_cluster_id: "CloudHsmClusterIdType",
})

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :custom_key_store_id (required, String) —

    Identifies the custom key store that you want to update. Enter the ID of the custom key store. To find the ID of a custom key store, use the DescribeCustomKeyStores operation.

  • :new_custom_key_store_name (String) —

    Changes the friendly name of the custom key store to the value that you specify. The custom key store name must be unique in the AWS account.

  • :key_store_password (String) —

    Enter the current password of the kmsuser crypto user (CU) in the AWS CloudHSM cluster that is associated with the custom key store.

    This parameter tells AWS KMS the current password of the kmsuser crypto user (CU). It does not set or change the password of any users in the AWS CloudHSM cluster.

  • :cloud_hsm_cluster_id (String) —

    Associates the custom key store with a related AWS CloudHSM cluster.

    Enter the cluster ID of the cluster that you used to create the custom key store or a cluster that shares a backup history and has the same cluster certificate as the original cluster. You cannot use this parameter to associate a custom key store with an unrelated cluster. In addition, the replacement cluster must fulfill the requirements for a cluster associated with a custom key store. To view the cluster certificate of a cluster, use the DescribeClusters operation.

Returns:

  • (Struct) —

    Returns an empty response.

See Also:



5274
5275
5276
5277
 
# File 'gems/aws-sdk-kms/lib/aws-sdk-kms/client.rb', line 5274

def update_custom_key_store(params = {}, options = {})
  req = build_request(:update_custom_key_store, params)
  req.send_request(options)
end

#update_key_description(params = {}) ⇒ Struct

Updates the description of a customer master key (CMK). To see the description of a CMK, use DescribeKey.

You cannot perform this operation on a CMK in a different AWS account.

The CMK that you use for this operation must be in a compatible key state. For details, see How Key State Affects Use of a Customer Master Key in the AWS Key Management Service Developer Guide.

Examples:

Example: To update the description of a customer master key (CMK)


# The following example updates the description of the specified CMK.

resp = client.update_key_description({
  description: "Example description that indicates the intended use of this CMK.", # The updated description.
  key_id: "1234abcd-12ab-34cd-56ef-1234567890ab", # The identifier of the CMK whose description you are updating. You can use the key ID or the Amazon Resource Name (ARN) of the CMK.
})

Request syntax with placeholder values


resp = client.update_key_description({
  key_id: "KeyIdType", # required
  description: "DescriptionType", # required
})

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :key_id (required, String) —

    A unique identifier for the customer master key (CMK).

    Specify the key ID or the Amazon Resource Name (ARN) of the CMK.

    For example:

    • Key ID: 1234abcd-12ab-34cd-56ef-1234567890ab

    • Key ARN: arn:aws:kms:us-east-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab

    To get the key ID and key ARN for a CMK, use ListKeys or DescribeKey.

  • :description (required, String) —

    New description for the CMK.

Returns:

  • (Struct) —

    Returns an empty response.

See Also:



5332
5333
5334
5335
 
# File 'gems/aws-sdk-kms/lib/aws-sdk-kms/client.rb', line 5332

def update_key_description(params = {}, options = {})
  req = build_request(:update_key_description, params)
  req.send_request(options)
end

#verify(params = {}) ⇒ Types::VerifyResponse

Verifies a digital signature that was generated by the Sign operation.

Verification confirms that an authorized user signed the message with the specified CMK and signing algorithm, and the message hasn't changed since it was signed. If the signature is verified, the value of the SignatureValid field in the response is True. If the signature verification fails, the Verify operation fails with an KMSInvalidSignatureException exception.

A digital signature is generated by using the private key in an asymmetric CMK. The signature is verified by using the public key in the same asymmetric CMK. For information about symmetric and asymmetric CMKs, see Using Symmetric and Asymmetric CMKs in the AWS Key Management Service Developer Guide.

To verify a digital signature, you can use the Verify operation. Specify the same asymmetric CMK, message, and signing algorithm that were used to produce the signature.

You can also verify the digital signature by using the public key of the CMK outside of AWS KMS. Use the GetPublicKey operation to download the public key in the asymmetric CMK and then use the public key to verify the signature outside of AWS KMS. The advantage of using the Verify operation is that it is performed within AWS KMS. As a result, it's easy to call, the operation is performed within the FIPS boundary, it is logged in AWS CloudTrail, and you can use key policy and IAM policy to determine who is authorized to use the CMK to verify signatures.

The CMK that you use for this operation must be in a compatible key state. For details, see How Key State Affects Use of a Customer Master Key in the AWS Key Management Service Developer Guide.

Examples:

Request syntax with placeholder values


resp = client.verify({
  key_id: "KeyIdType", # required
  message: "data", # required
  message_type: "RAW", # accepts RAW, DIGEST
  signature: "data", # required
  signing_algorithm: "RSASSA_PSS_SHA_256", # required, accepts RSASSA_PSS_SHA_256, RSASSA_PSS_SHA_384, RSASSA_PSS_SHA_512, RSASSA_PKCS1_V1_5_SHA_256, RSASSA_PKCS1_V1_5_SHA_384, RSASSA_PKCS1_V1_5_SHA_512, ECDSA_SHA_256, ECDSA_SHA_384, ECDSA_SHA_512
  grant_tokens: ["GrantTokenType"],
})

Response structure


resp.key_id #=> String
resp.signature_valid #=> Boolean
resp.signing_algorithm #=> String, one of "RSASSA_PSS_SHA_256", "RSASSA_PSS_SHA_384", "RSASSA_PSS_SHA_512", "RSASSA_PKCS1_V1_5_SHA_256", "RSASSA_PKCS1_V1_5_SHA_384", "RSASSA_PKCS1_V1_5_SHA_512", "ECDSA_SHA_256", "ECDSA_SHA_384", "ECDSA_SHA_512"

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :key_id (required, String) —

    Identifies the asymmetric CMK that will be used to verify the signature. This must be the same CMK that was used to generate the signature. If you specify a different CMK, the signature verification fails.

    To specify a CMK, 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 CMK in a different AWS 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

    To get the key ID and key ARN for a CMK, use ListKeys or DescribeKey. To get the alias name and alias ARN, use ListAliases.

  • :message (required, String, IO) —

    Specifies the message that was signed. You can submit a raw message of up to 4096 bytes, or a hash digest of the message. If you submit a digest, use the MessageType parameter with a value of DIGEST.

    If the message specified here is different from the message that was signed, the signature verification fails. A message and its hash digest are considered to be the same message.

  • :message_type (String) —

    Tells AWS KMS whether the value of the Message parameter is a message or message digest. The default value, RAW, indicates a message. To indicate a message digest, enter DIGEST.

    Use the DIGEST value only when the value of the Message parameter is a message digest. If you use the DIGEST value with a raw message, the security of the verification operation can be compromised.

  • :signature (required, String, IO) —

    The signature that the Sign operation generated.

  • :signing_algorithm (required, String) —

    The signing algorithm that was used to sign the message. If you submit a different algorithm, the signature verification fails.

  • :grant_tokens (Array<String>) —

    A list of grant tokens.

    For more information, see Grant Tokens in the AWS Key Management Service Developer Guide.

Returns:

See Also:



5464
5465
5466
5467
 
# File 'gems/aws-sdk-kms/lib/aws-sdk-kms/client.rb', line 5464

def verify(params = {}, options = {})
  req = build_request(:verify, params)
  req.send_request(options)
end