Struct aws_sdk_kms::Client

source · 
pub struct Client { /* private fields */ }
Expand description

Client for AWS Key Management Service

Client for invoking operations on AWS Key Management Service. Each operation on AWS Key Management Service is a method on this this struct. .send() MUST be invoked on the generated operations to dispatch the request to the service.

Examples

Constructing a client and invoking an operation

    // create a shared configuration. This can be used & shared between multiple service clients.
    let shared_config = aws_config::load_from_env().await;
    let client = aws_sdk_kms::Client::new(&shared_config);
    // invoke an operation
    /* let rsp = client
        .<operation_name>().
        .<param>("some value")
        .send().await; */

Constructing a client with custom configuration

use aws_config::retry::RetryConfig;
let shared_config = aws_config::load_from_env().await;
let config = aws_sdk_kms::config::Builder::from(&shared_config)
  .retry_config(RetryConfig::disabled())
  .build();
let client = aws_sdk_kms::Client::from_conf(config);

Implementations§

Creates a client with the given service configuration.

Examples found in repository?
src/client.rs (line 70)
64
65
66
67
68
69
70
71

    fn from(
        client: aws_smithy_client::Client<
            aws_smithy_client::erase::DynConnector,
            aws_smithy_client::erase::DynMiddleware<aws_smithy_client::erase::DynConnector>,
        >,
    ) -> Self {
        Self::with_config(client, crate::Config::builder().build())
    }

Returns the client’s configuration.

Constructs a fluent builder for the CancelKeyDeletion operation.

Constructs a fluent builder for the ConnectCustomKeyStore operation.

Constructs a fluent builder for the CreateAlias operation.

  • The fluent builder is configurable:
    • alias_name(impl Into<String>) / set_alias_name(Option<String>):

      Specifies the alias name. This value must begin with alias/ followed by a name, such as alias/ExampleAlias.

      The AliasName value must be string of 1-256 characters. 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 Amazon Web Services managed keys.

    • target_key_id(impl Into<String>) / set_target_key_id(Option<String>):

      Associates the alias with the specified customer managed key. The KMS key must be in the same Amazon Web Services Region.

      A valid key ID is required. If you supply a null or empty string value, this operation returns an error.

      For help finding the key ID and ARN, see Finding the Key ID and ARN in the Key Management Service Developer Guide .

      Specify the key ID or key ARN of the KMS key.

      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 KMS key, use ListKeys or DescribeKey.

  • On success, responds with CreateAliasOutput
  • On failure, responds with SdkError<CreateAliasError>

Constructs a fluent builder for the CreateCustomKeyStore operation.

Constructs a fluent builder for the CreateGrant operation.

  • The fluent builder is configurable:
    • key_id(impl Into<String>) / set_key_id(Option<String>):

      Identifies the KMS key for the grant. The grant gives principals permission to use this KMS key.

      Specify the key ID or key ARN of the KMS key. To specify a KMS key in a different Amazon Web Services 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 KMS key, use ListKeys or DescribeKey.

    • grantee_principal(impl Into<String>) / set_grantee_principal(Option<String>):

      The identity that gets the permissions specified in the grant.

      To specify the principal, use the Amazon Resource Name (ARN) of an Amazon Web Services principal. Valid Amazon Web Services principals include Amazon Web Services 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 Amazon Web Services Identity and Access Management (IAM) in the Example ARNs section of the Amazon Web Services General Reference.

    • retiring_principal(impl Into<String>) / set_retiring_principal(Option<String>):

      The principal that has permission to use the RetireGrant operation to retire the grant.

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

      The grant determines the retiring principal. Other principals might have permission to retire the grant or revoke the grant. For details, see RevokeGrant and Retiring and revoking grants in the Key Management Service Developer Guide.

    • operations(Vec<GrantOperation>) / set_operations(Option<Vec<GrantOperation>>):

      A list of operations that the grant permits.

      This list must include only operations that are permitted in a grant. Also, the operation must be supported on the KMS key. For example, you cannot create a grant for a symmetric encryption KMS key that allows the Sign operation, or a grant for an asymmetric KMS key that allows the GenerateDataKey operation. If you try, KMS returns a ValidationError exception. For details, see Grant operations in the Key Management Service Developer Guide.

    • constraints(GrantConstraints) / set_constraints(Option<GrantConstraints>):

      Specifies a grant constraint.

      KMS supports the EncryptionContextEquals and EncryptionContextSubset grant constraints. Each constraint value can include up to 8 encryption context pairs. The encryption context value in each constraint cannot exceed 384 characters. For information about grant constraints, see Using grant constraints in the Key Management Service Developer Guide. For more information about encryption context, see Encryption context in the Key Management Service Developer Guide .

      The encryption context grant constraints allow the permissions in the grant only when the encryption context in the request matches (EncryptionContextEquals) or includes (EncryptionContextSubset) the encryption context specified in this structure.

      The encryption context grant constraints are supported only on grant operations that include an EncryptionContext parameter, such as cryptographic operations on symmetric encryption KMS keys. Grants with grant constraints can include the DescribeKey and RetireGrant operations, but the constraint doesn’t apply to these operations. If a grant with a grant constraint includes the CreateGrant operation, the constraint requires that any grants created with the CreateGrant permission have an equally strict or stricter encryption context constraint.

      You cannot use an encryption context grant constraint for cryptographic operations with asymmetric KMS keys or HMAC KMS keys. These keys don’t support an encryption context.

    • grant_tokens(Vec<String>) / set_grant_tokens(Option<Vec<String>>):

      A list of grant tokens.

      Use a grant token when your permission to call this operation comes from a new grant that has not yet achieved eventual consistency. For more information, see Grant token and Using a grant token in the Key Management Service Developer Guide.

    • name(impl Into<String>) / set_name(Option<String>):

      A friendly name for 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 for the same grant ID can be used interchangeably.

  • On success, responds with CreateGrantOutput with field(s):
    • grant_token(Option<String>):

      The grant token.

      Use a grant token when your permission to call this operation comes from a new grant that has not yet achieved eventual consistency. For more information, see Grant token and Using a grant token in the Key Management Service Developer Guide.

    • grant_id(Option<String>):

      The unique identifier for the grant.

      You can use the GrantId in a ListGrants, RetireGrant, or RevokeGrant operation.

  • On failure, responds with SdkError<CreateGrantError>

Constructs a fluent builder for the CreateKey operation.

  • The fluent builder is configurable:
    • policy(impl Into<String>) / set_policy(Option<String>):

      The key policy to attach to the KMS key. If you do not specify a key policy, KMS attaches a default key policy to the KMS key. For more information, see Default key policy in the Key Management Service Developer Guide.

      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 KMS key. This reduces the risk that the KMS key becomes unmanageable. For more information, refer to the scenario in the Default Key Policy section of the 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 KMS. When you create a new Amazon Web Services 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 KMS. For more information, see Changes that I make are not always immediately visible in the Amazon Web Services Identity and Access Management User Guide.

      A key policy document can include only the following characters:

      • Printable ASCII characters from the space character (\u0020) through the end of the ASCII character range.

      • Printable characters in the Basic Latin and Latin-1 Supplement character set (through \u00FF).

      • The tab (\u0009), line feed (\u000A), and carriage return (\u000D) special characters

      For information about key policies, see Key policies in KMS in the Key Management Service Developer Guide. For help writing and formatting a JSON policy document, see the IAM JSON Policy Reference in the Identity and Access Management User Guide .

    • description(impl Into<String>) / set_description(Option<String>):

      A description of the KMS key.

      Use a description that helps you decide whether the KMS key is appropriate for a task. The default value is an empty string (no description).

      To set or change the description after the key is created, use UpdateKeyDescription.

    • key_usage(KeyUsageType) / set_key_usage(Option<KeyUsageType>):

      Determines the cryptographic operations for which you can use the KMS key. The default value is ENCRYPT_DECRYPT. This parameter is optional when you are creating a symmetric encryption KMS key; otherwise, it is required. You can’t change the KeyUsage value after the KMS key is created.

      Select only one valid value.

      • For symmetric encryption KMS keys, omit the parameter or specify ENCRYPT_DECRYPT.

      • For HMAC KMS keys (symmetric), specify GENERATE_VERIFY_MAC.

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

      • For asymmetric KMS keys with ECC key material, specify SIGN_VERIFY.

      • For asymmetric KMS keys with SM2 key material (China Regions only), specify ENCRYPT_DECRYPT or SIGN_VERIFY.

    • customer_master_key_spec(CustomerMasterKeySpec) / set_customer_master_key_spec(Option<CustomerMasterKeySpec>):

      Instead, use the KeySpec parameter.

      The KeySpec and CustomerMasterKeySpec parameters work the same way. Only the names differ. We recommend that you use KeySpec parameter in your code. However, to avoid breaking changes, KMS will support both parameters.

    • key_spec(KeySpec) / set_key_spec(Option<KeySpec>):

      Specifies the type of KMS key to create. The default value, SYMMETRIC_DEFAULT, creates a KMS key with a 256-bit AES-GCM key that is used for encryption and decryption, except in China Regions, where it creates a 128-bit symmetric key that uses SM4 encryption. For help choosing a key spec for your KMS key, see Choosing a KMS key type in the Key Management Service Developer Guide .

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

      Amazon Web Services services that are integrated with KMS use symmetric encryption KMS keys to protect your data. These services do not support asymmetric KMS keys or HMAC KMS keys.

      KMS supports the following key specs for KMS keys:

      • Symmetric encryption key (default)

        • SYMMETRIC_DEFAULT

      • HMAC keys (symmetric)

        • HMAC_224

        • HMAC_256

        • HMAC_384

        • HMAC_512

      • 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.

      • SM2 key pairs (China Regions only)

        • SM2

    • origin(OriginType) / set_origin(Option<OriginType>):

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

      To create a KMS key with no key material (for imported key material), set the value to EXTERNAL. For more information about importing key material into KMS, see Importing Key Material in the Key Management Service Developer Guide. This value is valid only for symmetric encryption KMS keys.

      To create a KMS key in an KMS custom key store and create its key material in the associated CloudHSM cluster, set this value to AWS_CLOUDHSM. You must also use the CustomKeyStoreId parameter to identify the custom key store. This value is valid only for symmetric encryption KMS keys.

    • custom_key_store_id(impl Into<String>) / set_custom_key_store_id(Option<String>):

      Creates the KMS key in the specified custom key store and the key material in its associated CloudHSM cluster. To create a KMS key in a custom key store, you must also specify the Origin parameter with a value of AWS_CLOUDHSM. The 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 encryption KMS keys in a single Region. You cannot create any other type of KMS key 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 CloudHSM cluster.

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

    • bypass_policy_lockout_safety_check(bool) / set_bypass_policy_lockout_safety_check(bool):

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

      Setting this value to true increases the risk that the KMS key 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 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 KMS key.

      The default value is false.

    • tags(Vec<Tag>) / set_tags(Option<Vec<Tag>>):

      Assigns one or more tags to the KMS key. Use this parameter to tag the KMS key when it is created. To tag an existing KMS key, use the TagResource operation.

      Tagging or untagging a KMS key can allow or deny permission to the KMS key. For details, see ABAC in KMS in the Key Management Service Developer Guide.

      To use this parameter, you must have kms:TagResource permission in an IAM policy.

      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. You cannot have more than one tag on a KMS key with the same tag key. If you specify an existing tag key with a different tag value, KMS replaces the current tag value with the specified one.

      When you add tags to an Amazon Web Services resource, Amazon Web Services generates a cost allocation report with usage and costs aggregated by tags. Tags can also be used to control access to a KMS key. For details, see Tagging Keys.

    • multi_region(bool) / set_multi_region(Option<bool>):

      Creates a multi-Region primary key that you can replicate into other Amazon Web Services Regions. You cannot change this value after you create the KMS key.

      For a multi-Region key, set this parameter to True. For a single-Region KMS key, omit this parameter or set it to False. The default value is False.

      This operation supports multi-Region keys, an KMS feature that lets you create multiple interoperable KMS keys in different Amazon Web Services Regions. Because these KMS keys have the same key ID, key material, and other metadata, you can use them interchangeably to encrypt data in one Amazon Web Services Region and decrypt it in a different Amazon Web Services Region without re-encrypting the data or making a cross-Region call. For more information about multi-Region keys, see Multi-Region keys in KMS in the Key Management Service Developer Guide.

      This value creates a primary key, not a replica. To create a replica key, use the ReplicateKey operation.

      You can create a multi-Region version of a symmetric encryption KMS key, an HMAC KMS key, an asymmetric KMS key, or a KMS key with imported key material. However, you cannot create a multi-Region key in a custom key store.

  • On success, responds with CreateKeyOutput with field(s):
  • On failure, responds with SdkError<CreateKeyError>

Constructs a fluent builder for the Decrypt operation.

  • The fluent builder is configurable:
    • ciphertext_blob(Blob) / set_ciphertext_blob(Option<Blob>):

      Ciphertext to be decrypted. The blob includes metadata.

    • encryption_context(HashMap<String, String>) / set_encryption_context(Option<HashMap<String, String>>):

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

      An encryption context is a collection of non-secret key-value pairs that represent 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 supported only on operations with symmetric encryption KMS keys. On operations with symmetric encryption KMS keys, an encryption context is optional, but it is strongly recommended.

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

    • grant_tokens(Vec<String>) / set_grant_tokens(Option<Vec<String>>):

      A list of grant tokens.

      Use a grant token when your permission to call this operation comes from a new grant that has not yet achieved eventual consistency. For more information, see Grant token and Using a grant token in the Key Management Service Developer Guide.

    • key_id(impl Into<String>) / set_key_id(Option<String>):

      Specifies the KMS key that KMS uses to decrypt the ciphertext.

      Enter a key ID of the KMS key that was used to encrypt the ciphertext. If you identify a different KMS key, the Decrypt operation throws an IncorrectKeyException.

      This parameter is required only when the ciphertext was encrypted under an asymmetric KMS key. If you used a symmetric encryption KMS key, KMS can get the KMS key from metadata that it adds to the symmetric ciphertext blob. However, it is always recommended as a best practice. This practice ensures that you use the KMS key that you intend.

      To specify a KMS key, use its key ID, key ARN, alias name, or alias ARN. When using an alias name, prefix it with “alias/”. To specify a KMS key in a different Amazon Web Services 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 KMS key, use ListKeys or DescribeKey. To get the alias name and alias ARN, use ListAliases.

    • encryption_algorithm(EncryptionAlgorithmSpec) / set_encryption_algorithm(Option<EncryptionAlgorithmSpec>):

      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 KMS key. The default value, SYMMETRIC_DEFAULT, represents the only supported algorithm that is valid for symmetric encryption KMS keys.

  • On success, responds with DecryptOutput with field(s):
  • On failure, responds with SdkError<DecryptError>

Constructs a fluent builder for the DeleteAlias operation.

Constructs a fluent builder for the DeleteCustomKeyStore operation.

Constructs a fluent builder for the DeleteImportedKeyMaterial operation.

Constructs a fluent builder for the DescribeCustomKeyStores operation. This operation supports pagination; See into_paginator().

Constructs a fluent builder for the DescribeKey operation.

  • The fluent builder is configurable:
    • key_id(impl Into<String>) / set_key_id(Option<String>):

      Describes the specified KMS key.

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

      To specify a KMS key, use its key ID, key ARN, alias name, or alias ARN. When using an alias name, prefix it with “alias/”. To specify a KMS key in a different Amazon Web Services 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 KMS key, use ListKeys or DescribeKey. To get the alias name and alias ARN, use ListAliases.

    • grant_tokens(Vec<String>) / set_grant_tokens(Option<Vec<String>>):

      A list of grant tokens.

      Use a grant token when your permission to call this operation comes from a new grant that has not yet achieved eventual consistency. For more information, see Grant token and Using a grant token in the Key Management Service Developer Guide.

  • On success, responds with DescribeKeyOutput with field(s):
  • On failure, responds with SdkError<DescribeKeyError>

Constructs a fluent builder for the DisableKey operation.

  • The fluent builder is configurable:
    • key_id(impl Into<String>) / set_key_id(Option<String>):

      Identifies the KMS key to disable.

      Specify the key ID or key ARN of the KMS key.

      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 KMS key, use ListKeys or DescribeKey.

  • On success, responds with DisableKeyOutput
  • On failure, responds with SdkError<DisableKeyError>

Constructs a fluent builder for the DisableKeyRotation operation.

Constructs a fluent builder for the DisconnectCustomKeyStore operation.

Constructs a fluent builder for the EnableKey operation.

  • The fluent builder is configurable:
    • key_id(impl Into<String>) / set_key_id(Option<String>):

      Identifies the KMS key to enable.

      Specify the key ID or key ARN of the KMS key.

      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 KMS key, use ListKeys or DescribeKey.

  • On success, responds with EnableKeyOutput
  • On failure, responds with SdkError<EnableKeyError>

Constructs a fluent builder for the EnableKeyRotation operation.

Constructs a fluent builder for the Encrypt operation.

  • The fluent builder is configurable:
    • key_id(impl Into<String>) / set_key_id(Option<String>):

      Identifies the KMS key to use in the encryption operation. The KMS key must have a KeyUsage of ENCRYPT_DECRYPT. To find the KeyUsage of a KMS key, use the DescribeKey operation.

      To specify a KMS key, use its key ID, key ARN, alias name, or alias ARN. When using an alias name, prefix it with “alias/”. To specify a KMS key in a different Amazon Web Services 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 KMS key, use ListKeys or DescribeKey. To get the alias name and alias ARN, use ListAliases.

    • plaintext(Blob) / set_plaintext(Option<Blob>):

      Data to be encrypted.

    • encryption_context(HashMap<String, String>) / set_encryption_context(Option<HashMap<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 encryption KMS key. The standard asymmetric encryption algorithms and HMAC algorithms that KMS uses do not support an encryption context.

      An encryption context is a collection of non-secret key-value pairs that represent 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 supported only on operations with symmetric encryption KMS keys. On operations with symmetric encryption KMS keys, an encryption context is optional, but it is strongly recommended.

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

    • grant_tokens(Vec<String>) / set_grant_tokens(Option<Vec<String>>):

      A list of grant tokens.

      Use a grant token when your permission to call this operation comes from a new grant that has not yet achieved eventual consistency. For more information, see Grant token and Using a grant token in the Key Management Service Developer Guide.

    • encryption_algorithm(EncryptionAlgorithmSpec) / set_encryption_algorithm(Option<EncryptionAlgorithmSpec>):

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

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

  • On success, responds with EncryptOutput with field(s):
  • On failure, responds with SdkError<EncryptError>

Constructs a fluent builder for the GenerateDataKey operation.

  • The fluent builder is configurable:
    • key_id(impl Into<String>) / set_key_id(Option<String>):

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

      To specify a KMS key, use its key ID, key ARN, alias name, or alias ARN. When using an alias name, prefix it with “alias/”. To specify a KMS key in a different Amazon Web Services 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 KMS key, use ListKeys or DescribeKey. To get the alias name and alias ARN, use ListAliases.

    • encryption_context(HashMap<String, String>) / set_encryption_context(Option<HashMap<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 represent 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 supported only on operations with symmetric encryption KMS keys. On operations with symmetric encryption KMS keys, an encryption context is optional, but it is strongly recommended.

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

    • number_of_bytes(i32) / set_number_of_bytes(Option<i32>):

      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(DataKeySpec) / set_key_spec(Option<DataKeySpec>):

      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(Vec<String>) / set_grant_tokens(Option<Vec<String>>):

      A list of grant tokens.

      Use a grant token when your permission to call this operation comes from a new grant that has not yet achieved eventual consistency. For more information, see Grant token and Using a grant token in the Key Management Service Developer Guide.

  • On success, responds with GenerateDataKeyOutput with field(s):
    • ciphertext_blob(Option<Blob>):

      The encrypted copy of the data key. When you use the HTTP API or the Amazon Web Services CLI, the value is Base64-encoded. Otherwise, it is not Base64-encoded.

    • plaintext(Option<Blob>):

      The plaintext data key. When you use the HTTP API or the Amazon Web Services CLI, the value is Base64-encoded. Otherwise, it is not Base64-encoded. Use this data key to encrypt your data outside of KMS. Then, remove it from memory as soon as possible.

    • key_id(Option<String>):

      The Amazon Resource Name (key ARN) of the KMS key that encrypted the data key.

  • On failure, responds with SdkError<GenerateDataKeyError>

Constructs a fluent builder for the GenerateDataKeyPair operation.

  • The fluent builder is configurable:
    • encryption_context(HashMap<String, String>) / set_encryption_context(Option<HashMap<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 represent 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 supported only on operations with symmetric encryption KMS keys. On operations with symmetric encryption KMS keys, an encryption context is optional, but it is strongly recommended.

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

    • key_id(impl Into<String>) / set_key_id(Option<String>):

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

      To specify a KMS key, use its key ID, key ARN, alias name, or alias ARN. When using an alias name, prefix it with “alias/”. To specify a KMS key in a different Amazon Web Services 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 KMS key, use ListKeys or DescribeKey. To get the alias name and alias ARN, use ListAliases.

    • key_pair_spec(DataKeyPairSpec) / set_key_pair_spec(Option<DataKeyPairSpec>):

      Determines the type of data key pair that is generated.

      The KMS rule that restricts the use of asymmetric RSA and SM2 KMS keys to encrypt and decrypt or to sign and verify (but not both), and the rule that permits you to use ECC KMS keys only to sign and verify, are not effective on data key pairs, which are used outside of KMS. The SM2 key spec is only available in China Regions. RSA and ECC asymmetric key pairs are also available in China Regions.

    • grant_tokens(Vec<String>) / set_grant_tokens(Option<Vec<String>>):

      A list of grant tokens.

      Use a grant token when your permission to call this operation comes from a new grant that has not yet achieved eventual consistency. For more information, see Grant token and Using a grant token in the Key Management Service Developer Guide.

  • On success, responds with GenerateDataKeyPairOutput with field(s):
  • On failure, responds with SdkError<GenerateDataKeyPairError>

Constructs a fluent builder for the GenerateDataKeyPairWithoutPlaintext operation.

  • The fluent builder is configurable:
    • encryption_context(HashMap<String, String>) / set_encryption_context(Option<HashMap<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 represent 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 supported only on operations with symmetric encryption KMS keys. On operations with symmetric encryption KMS keys, an encryption context is optional, but it is strongly recommended.

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

    • key_id(impl Into<String>) / set_key_id(Option<String>):

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

      To specify a KMS key, use its key ID, key ARN, alias name, or alias ARN. When using an alias name, prefix it with “alias/”. To specify a KMS key in a different Amazon Web Services 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 KMS key, use ListKeys or DescribeKey. To get the alias name and alias ARN, use ListAliases.

    • key_pair_spec(DataKeyPairSpec) / set_key_pair_spec(Option<DataKeyPairSpec>):

      Determines the type of data key pair that is generated.

      The KMS rule that restricts the use of asymmetric RSA and SM2 KMS keys to encrypt and decrypt or to sign and verify (but not both), and the rule that permits you to use ECC KMS keys only to sign and verify, are not effective on data key pairs, which are used outside of KMS. The SM2 key spec is only available in China Regions. RSA and ECC asymmetric key pairs are also available in China Regions.

    • grant_tokens(Vec<String>) / set_grant_tokens(Option<Vec<String>>):

      A list of grant tokens.

      Use a grant token when your permission to call this operation comes from a new grant that has not yet achieved eventual consistency. For more information, see Grant token and Using a grant token in the Key Management Service Developer Guide.

  • On success, responds with GenerateDataKeyPairWithoutPlaintextOutput with field(s):
  • On failure, responds with SdkError<GenerateDataKeyPairWithoutPlaintextError>

Constructs a fluent builder for the GenerateDataKeyWithoutPlaintext operation.

  • The fluent builder is configurable:
    • key_id(impl Into<String>) / set_key_id(Option<String>):

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

      To specify a KMS key, use its key ID, key ARN, alias name, or alias ARN. When using an alias name, prefix it with “alias/”. To specify a KMS key in a different Amazon Web Services 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 KMS key, use ListKeys or DescribeKey. To get the alias name and alias ARN, use ListAliases.

    • encryption_context(HashMap<String, String>) / set_encryption_context(Option<HashMap<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 represent 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 supported only on operations with symmetric encryption KMS keys. On operations with symmetric encryption KMS keys, an encryption context is optional, but it is strongly recommended.

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

    • key_spec(DataKeySpec) / set_key_spec(Option<DataKeySpec>):

      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(i32) / set_number_of_bytes(Option<i32>):

      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(Vec<String>) / set_grant_tokens(Option<Vec<String>>):

      A list of grant tokens.

      Use a grant token when your permission to call this operation comes from a new grant that has not yet achieved eventual consistency. For more information, see Grant token and Using a grant token in the Key Management Service Developer Guide.

  • On success, responds with GenerateDataKeyWithoutPlaintextOutput with field(s):
  • On failure, responds with SdkError<GenerateDataKeyWithoutPlaintextError>

Constructs a fluent builder for the GenerateMac operation.

Constructs a fluent builder for the GenerateRandom operation.

Constructs a fluent builder for the GetKeyPolicy operation.

Constructs a fluent builder for the GetKeyRotationStatus operation.

  • The fluent builder is configurable:
    • key_id(impl Into<String>) / set_key_id(Option<String>):

      Gets the rotation status for the specified KMS key.

      Specify the key ID or key ARN of the KMS key. To specify a KMS key in a different Amazon Web Services 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 KMS key, use ListKeys or DescribeKey.

  • On success, responds with GetKeyRotationStatusOutput with field(s):
  • On failure, responds with SdkError<GetKeyRotationStatusError>

Constructs a fluent builder for the GetParametersForImport operation.

Constructs a fluent builder for the GetPublicKey operation.

  • The fluent builder is configurable:
    • key_id(impl Into<String>) / set_key_id(Option<String>):

      Identifies the asymmetric KMS key that includes the public key.

      To specify a KMS key, use its key ID, key ARN, alias name, or alias ARN. When using an alias name, prefix it with “alias/”. To specify a KMS key in a different Amazon Web Services 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 KMS key, use ListKeys or DescribeKey. To get the alias name and alias ARN, use ListAliases.

    • grant_tokens(Vec<String>) / set_grant_tokens(Option<Vec<String>>):

      A list of grant tokens.

      Use a grant token when your permission to call this operation comes from a new grant that has not yet achieved eventual consistency. For more information, see Grant token and Using a grant token in the Key Management Service Developer Guide.

  • On success, responds with GetPublicKeyOutput with field(s):
    • key_id(Option<String>):

      The Amazon Resource Name (key ARN) of the asymmetric KMS key from which the public key was downloaded.

    • public_key(Option<Blob>):

      The exported public key.

      The value is a DER-encoded X.509 public key, also known as SubjectPublicKeyInfo (SPKI), as defined in RFC 5280. When you use the HTTP API or the Amazon Web Services CLI, the value is Base64-encoded. Otherwise, it is not Base64-encoded.

    • customer_master_key_spec(Option<CustomerMasterKeySpec>):

      Instead, use the KeySpec field in the GetPublicKey response.

      The KeySpec and CustomerMasterKeySpec fields have the same value. We recommend that you use the KeySpec field in your code. However, to avoid breaking changes, KMS will support both fields.

    • key_spec(Option<KeySpec>):

      The type of the of the public key that was downloaded.

    • key_usage(Option<KeyUsageType>):

      The permitted use of the public key. Valid values are ENCRYPT_DECRYPT or SIGN_VERIFY.

      This information is critical. If a public key with SIGN_VERIFY key usage encrypts data outside of KMS, the ciphertext cannot be decrypted.

    • encryption_algorithms(Option<Vec<EncryptionAlgorithmSpec>>):

      The encryption algorithms that KMS supports for this key.

      This information is critical. If a public key encrypts data outside of KMS by using an unsupported encryption algorithm, the ciphertext cannot be decrypted.

      This field appears in the response only when the KeyUsage of the public key is ENCRYPT_DECRYPT.

    • signing_algorithms(Option<Vec<SigningAlgorithmSpec>>):

      The signing algorithms that KMS supports for this key.

      This field appears in the response only when the KeyUsage of the public key is SIGN_VERIFY.

  • On failure, responds with SdkError<GetPublicKeyError>

Constructs a fluent builder for the ImportKeyMaterial operation.

  • The fluent builder is configurable:
    • key_id(impl Into<String>) / set_key_id(Option<String>):

      The identifier of the symmetric encryption KMS key that receives the imported key material. This must be the same KMS key specified in the KeyID parameter of the corresponding GetParametersForImport request. The Origin of the KMS key must be EXTERNAL. You cannot perform this operation on an asymmetric KMS key, an HMAC KMS key, a KMS key in a custom key store, or on a KMS key in a different Amazon Web Services account

      Specify the key ID or key ARN of the KMS key.

      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 KMS key, use ListKeys or DescribeKey.

    • import_token(Blob) / set_import_token(Option<Blob>):

      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(Blob) / set_encrypted_key_material(Option<Blob>):

      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(DateTime) / set_valid_to(Option<DateTime>):

      The time at which the imported key material expires. When the key material expires, KMS deletes the key material and the KMS key 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(ExpirationModelType) / set_expiration_model(Option<ExpirationModelType>):

      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.

  • On success, responds with ImportKeyMaterialOutput
  • On failure, responds with SdkError<ImportKeyMaterialError>

Constructs a fluent builder for the ListAliases operation. This operation supports pagination; See into_paginator().

  • The fluent builder is configurable:
    • key_id(impl Into<String>) / set_key_id(Option<String>):

      Lists only aliases that are associated with the specified KMS key. Enter a KMS key in your Amazon Web Services account.

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

      Specify the key ID or key ARN of the KMS key.

      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 KMS key, use ListKeys or DescribeKey.

    • limit(i32) / set_limit(Option<i32>):

      Use this parameter to specify the maximum number of items to return. When this value is present, 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(impl Into<String>) / set_marker(Option<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.

  • On success, responds with ListAliasesOutput with field(s):
    • aliases(Option<Vec<AliasListEntry>>):

      A list of aliases.

    • next_marker(Option<String>):

      When Truncated is true, this element is present and contains the value to use for the Marker parameter in a subsequent request.

    • truncated(bool):

      A flag that indicates whether there are more items in the list. When this value is true, the list in this response is truncated. To get more items, pass the value of the NextMarker element in thisresponse to the Marker parameter in a subsequent request.

  • On failure, responds with SdkError<ListAliasesError>

Constructs a fluent builder for the ListGrants operation. This operation supports pagination; See into_paginator().

  • The fluent builder is configurable:
    • limit(i32) / set_limit(Option<i32>):

      Use this parameter to specify the maximum number of items to return. When this value is present, 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(impl Into<String>) / set_marker(Option<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(impl Into<String>) / set_key_id(Option<String>):

      Returns only grants for the specified KMS key. This parameter is required.

      Specify the key ID or key ARN of the KMS key. To specify a KMS key in a different Amazon Web Services 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 KMS key, use ListKeys or DescribeKey.

    • grant_id(impl Into<String>) / set_grant_id(Option<String>):

      Returns only the grant with the specified grant ID. The grant ID uniquely identifies the grant.

    • grantee_principal(impl Into<String>) / set_grantee_principal(Option<String>):

      Returns only grants where the specified principal is the grantee principal for the grant.

  • On success, responds with ListGrantsOutput with field(s):
    • grants(Option<Vec<GrantListEntry>>):

      A list of grants.

    • next_marker(Option<String>):

      When Truncated is true, this element is present and contains the value to use for the Marker parameter in a subsequent request.

    • truncated(bool):

      A flag that indicates whether there are more items in the list. When this value is true, the list in this response is truncated. To get more items, pass the value of the NextMarker element in thisresponse to the Marker parameter in a subsequent request.

  • On failure, responds with SdkError<ListGrantsError>

Constructs a fluent builder for the ListKeyPolicies operation. This operation supports pagination; See into_paginator().

  • The fluent builder is configurable:
    • key_id(impl Into<String>) / set_key_id(Option<String>):

      Gets the names of key policies for the specified KMS key.

      Specify the key ID or key ARN of the KMS key.

      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 KMS key, use ListKeys or DescribeKey.

    • limit(i32) / set_limit(Option<i32>):

      Use this parameter to specify the maximum number of items to return. When this value is present, 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(impl Into<String>) / set_marker(Option<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.

  • On success, responds with ListKeyPoliciesOutput with field(s):
    • policy_names(Option<Vec<String>>):

      A list of key policy names. The only valid value is default.

    • next_marker(Option<String>):

      When Truncated is true, this element is present and contains the value to use for the Marker parameter in a subsequent request.

    • truncated(bool):

      A flag that indicates whether there are more items in the list. When this value is true, the list in this response is truncated. To get more items, pass the value of the NextMarker element in thisresponse to the Marker parameter in a subsequent request.

  • On failure, responds with SdkError<ListKeyPoliciesError>

Constructs a fluent builder for the ListKeys operation. This operation supports pagination; See into_paginator().

  • The fluent builder is configurable:
    • limit(i32) / set_limit(Option<i32>):

      Use this parameter to specify the maximum number of items to return. When this value is present, 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(impl Into<String>) / set_marker(Option<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.

  • On success, responds with ListKeysOutput with field(s):
    • keys(Option<Vec<KeyListEntry>>):

      A list of KMS keys.

    • next_marker(Option<String>):

      When Truncated is true, this element is present and contains the value to use for the Marker parameter in a subsequent request.

    • truncated(bool):

      A flag that indicates whether there are more items in the list. When this value is true, the list in this response is truncated. To get more items, pass the value of the NextMarker element in thisresponse to the Marker parameter in a subsequent request.

  • On failure, responds with SdkError<ListKeysError>

Constructs a fluent builder for the ListResourceTags operation. This operation supports pagination; See into_paginator().

  • The fluent builder is configurable:
    • key_id(impl Into<String>) / set_key_id(Option<String>):

      Gets tags on the specified KMS key.

      Specify the key ID or key ARN of the KMS key.

      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 KMS key, use ListKeys or DescribeKey.

    • limit(i32) / set_limit(Option<i32>):

      Use this parameter to specify the maximum number of items to return. When this value is present, 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(impl Into<String>) / set_marker(Option<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.

  • On success, responds with ListResourceTagsOutput with field(s):
    • tags(Option<Vec<Tag>>):

      A list of tags. Each tag consists of a tag key and a tag value.

      Tagging or untagging a KMS key can allow or deny permission to the KMS key. For details, see ABAC in KMS in the Key Management Service Developer Guide.

    • next_marker(Option<String>):

      When Truncated is true, this element is present and contains the value to use for the Marker parameter in a subsequent request.

      Do not assume or infer any information from this value.

    • truncated(bool):

      A flag that indicates whether there are more items in the list. When this value is true, the list in this response is truncated. To get more items, pass the value of the NextMarker element in thisresponse to the Marker parameter in a subsequent request.

  • On failure, responds with SdkError<ListResourceTagsError>

Constructs a fluent builder for the ListRetirableGrants operation. This operation supports pagination; See into_paginator().

Constructs a fluent builder for the PutKeyPolicy operation.

  • The fluent builder is configurable:
    • key_id(impl Into<String>) / set_key_id(Option<String>):

      Sets the key policy on the specified KMS key.

      Specify the key ID or key ARN of the KMS key.

      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 KMS key, use ListKeys or DescribeKey.

    • policy_name(impl Into<String>) / set_policy_name(Option<String>):

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

    • policy(impl Into<String>) / set_policy(Option<String>):

      The key policy to attach to the KMS key.

      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 KMS key. This reduces the risk that the KMS key becomes unmanageable. For more information, refer to the scenario in the Default Key Policy section of the 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 KMS. When you create a new Amazon Web Services 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 KMS. For more information, see Changes that I make are not always immediately visible in the Amazon Web Services Identity and Access Management User Guide.

      A key policy document can include only the following characters:

      • Printable ASCII characters from the space character (\u0020) through the end of the ASCII character range.

      • Printable characters in the Basic Latin and Latin-1 Supplement character set (through \u00FF).

      • The tab (\u0009), line feed (\u000A), and carriage return (\u000D) special characters

      For information about key policies, see Key policies in KMS in the Key Management Service Developer Guide. For help writing and formatting a JSON policy document, see the IAM JSON Policy Reference in the Identity and Access Management User Guide .

    • bypass_policy_lockout_safety_check(bool) / set_bypass_policy_lockout_safety_check(bool):

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

      Setting this value to true increases the risk that the KMS key 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 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 KMS key.

      The default value is false.

  • On success, responds with PutKeyPolicyOutput
  • On failure, responds with SdkError<PutKeyPolicyError>

Constructs a fluent builder for the ReEncrypt operation.

  • The fluent builder is configurable:
    • ciphertext_blob(Blob) / set_ciphertext_blob(Option<Blob>):

      Ciphertext of the data to reencrypt.

    • source_encryption_context(HashMap<String, String>) / set_source_encryption_context(Option<HashMap<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 represent 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 supported only on operations with symmetric encryption KMS keys. On operations with symmetric encryption KMS keys, an encryption context is optional, but it is strongly recommended.

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

    • source_key_id(impl Into<String>) / set_source_key_id(Option<String>):

      Specifies the KMS key that KMS will use to decrypt the ciphertext before it is re-encrypted.

      Enter a key ID of the KMS key that was used to encrypt the ciphertext. If you identify a different KMS key, the ReEncrypt operation throws an IncorrectKeyException.

      This parameter is required only when the ciphertext was encrypted under an asymmetric KMS key. If you used a symmetric encryption KMS key, KMS can get the KMS key from metadata that it adds to the symmetric ciphertext blob. However, it is always recommended as a best practice. This practice ensures that you use the KMS key that you intend.

      To specify a KMS key, use its key ID, key ARN, alias name, or alias ARN. When using an alias name, prefix it with “alias/”. To specify a KMS key in a different Amazon Web Services 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 KMS key, use ListKeys or DescribeKey. To get the alias name and alias ARN, use ListAliases.

    • destination_key_id(impl Into<String>) / set_destination_key_id(Option<String>):

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

      To specify a KMS key, use its key ID, key ARN, alias name, or alias ARN. When using an alias name, prefix it with “alias/”. To specify a KMS key in a different Amazon Web Services 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 KMS key, use ListKeys or DescribeKey. To get the alias name and alias ARN, use ListAliases.

    • destination_encryption_context(HashMap<String, String>) / set_destination_encryption_context(Option<HashMap<String, String>>):

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

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

      An encryption context is a collection of non-secret key-value pairs that represent 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 supported only on operations with symmetric encryption KMS keys. On operations with symmetric encryption KMS keys, an encryption context is optional, but it is strongly recommended.

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

    • source_encryption_algorithm(EncryptionAlgorithmSpec) / set_source_encryption_algorithm(Option<EncryptionAlgorithmSpec>):

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

      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 KMS key.

    • destination_encryption_algorithm(EncryptionAlgorithmSpec) / set_destination_encryption_algorithm(Option<EncryptionAlgorithmSpec>):

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

      This parameter is required only when the destination KMS key is an asymmetric KMS key.

    • grant_tokens(Vec<String>) / set_grant_tokens(Option<Vec<String>>):

      A list of grant tokens.

      Use a grant token when your permission to call this operation comes from a new grant that has not yet achieved eventual consistency. For more information, see Grant token and Using a grant token in the Key Management Service Developer Guide.

  • On success, responds with ReEncryptOutput with field(s):
  • On failure, responds with SdkError<ReEncryptError>

Constructs a fluent builder for the ReplicateKey operation.

  • The fluent builder is configurable:
    • key_id(impl Into<String>) / set_key_id(Option<String>):

      Identifies the multi-Region primary key that is being replicated. To determine whether a KMS key is a multi-Region primary key, use the DescribeKey operation to check the value of the MultiRegionKeyType property.

      Specify the key ID or key ARN of a multi-Region primary key.

      For example:

      • Key ID: mrk-1234abcd12ab34cd56ef1234567890ab

      • Key ARN: arn:aws:kms:us-east-2:111122223333:key/mrk-1234abcd12ab34cd56ef1234567890ab

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

    • replica_region(impl Into<String>) / set_replica_region(Option<String>):

      The Region ID of the Amazon Web Services Region for this replica key.

      Enter the Region ID, such as us-east-1 or ap-southeast-2. For a list of Amazon Web Services Regions in which KMS is supported, see KMS service endpoints in the Amazon Web Services General Reference.

      HMAC KMS keys are not supported in all Amazon Web Services Regions. If you try to replicate an HMAC KMS key in an Amazon Web Services Region in which HMAC keys are not supported, the ReplicateKey operation returns an UnsupportedOperationException. For a list of Regions in which HMAC KMS keys are supported, see HMAC keys in KMS in the Key Management Service Developer Guide.

      The replica must be in a different Amazon Web Services Region than its primary key and other replicas of that primary key, but in the same Amazon Web Services partition. KMS must be available in the replica Region. If the Region is not enabled by default, the Amazon Web Services account must be enabled in the Region. For information about Amazon Web Services partitions, see Amazon Resource Names (ARNs) in the Amazon Web Services General Reference. For information about enabling and disabling Regions, see Enabling a Region and Disabling a Region in the Amazon Web Services General Reference.

    • policy(impl Into<String>) / set_policy(Option<String>):

      The key policy to attach to the KMS key. This parameter is optional. If you do not provide a key policy, KMS attaches the default key policy to the KMS key.

      The key policy is not a shared property of multi-Region keys. You can specify the same key policy or a different key policy for each key in a set of related multi-Region keys. KMS does not synchronize this property.

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

      • If you don’t set BypassPolicyLockoutSafetyCheck to true, the key policy must give the caller kms:PutKeyPolicy permission on the replica key. This reduces the risk that the KMS key becomes unmanageable. For more information, refer to the scenario in the Default Key Policy section of the 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 KMS. When you create a new Amazon Web Services 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 KMS. For more information, see Changes that I make are not always immediately visible in the Identity and Access Management User Guide .

      A key policy document can include only the following characters:

      • Printable ASCII characters from the space character (\u0020) through the end of the ASCII character range.

      • Printable characters in the Basic Latin and Latin-1 Supplement character set (through \u00FF).

      • The tab (\u0009), line feed (\u000A), and carriage return (\u000D) special characters

      For information about key policies, see Key policies in KMS in the Key Management Service Developer Guide. For help writing and formatting a JSON policy document, see the IAM JSON Policy Reference in the Identity and Access Management User Guide .

    • bypass_policy_lockout_safety_check(bool) / set_bypass_policy_lockout_safety_check(bool):

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

      Setting this value to true increases the risk that the KMS key 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 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 KMS key.

      The default value is false.

    • description(impl Into<String>) / set_description(Option<String>):

      A description of the KMS key. The default value is an empty string (no description).

      The description is not a shared property of multi-Region keys. You can specify the same description or a different description for each key in a set of related multi-Region keys. KMS does not synchronize this property.

    • tags(Vec<Tag>) / set_tags(Option<Vec<Tag>>):

      Assigns one or more tags to the replica key. Use this parameter to tag the KMS key when it is created. To tag an existing KMS key, use the TagResource operation.

      Tagging or untagging a KMS key can allow or deny permission to the KMS key. For details, see ABAC in KMS in the Key Management Service Developer Guide.

      To use this parameter, you must have kms:TagResource permission in an IAM policy.

      Tags are not a shared property of multi-Region keys. You can specify the same tags or different tags for each key in a set of related multi-Region keys. KMS does not synchronize this property.

      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. You cannot have more than one tag on a KMS key with the same tag key. If you specify an existing tag key with a different tag value, KMS replaces the current tag value with the specified one.

      When you add tags to an Amazon Web Services resource, Amazon Web Services generates a cost allocation report with usage and costs aggregated by tags. Tags can also be used to control access to a KMS key. For details, see Tagging Keys.

  • On success, responds with ReplicateKeyOutput with field(s):
  • On failure, responds with SdkError<ReplicateKeyError>

Constructs a fluent builder for the RetireGrant operation.

Constructs a fluent builder for the RevokeGrant operation.

  • The fluent builder is configurable:
    • key_id(impl Into<String>) / set_key_id(Option<String>):

      A unique identifier for the KMS key associated with the grant. To get the key ID and key ARN for a KMS key, use ListKeys or DescribeKey.

      Specify the key ID or key ARN of the KMS key. To specify a KMS key in a different Amazon Web Services 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 KMS key, use ListKeys or DescribeKey.

    • grant_id(impl Into<String>) / set_grant_id(Option<String>):

      Identifies the grant to revoke. To get the grant ID, use CreateGrant, ListGrants, or ListRetirableGrants.

  • On success, responds with RevokeGrantOutput
  • On failure, responds with SdkError<RevokeGrantError>

Constructs a fluent builder for the ScheduleKeyDeletion operation.

  • The fluent builder is configurable:
    • key_id(impl Into<String>) / set_key_id(Option<String>):

      The unique identifier of the KMS key to delete.

      Specify the key ID or key ARN of the KMS key.

      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 KMS key, use ListKeys or DescribeKey.

    • pending_window_in_days(i32) / set_pending_window_in_days(Option<i32>):

      The waiting period, specified in number of days. After the waiting period ends, KMS deletes the KMS key.

      If the KMS key is a multi-Region primary key with replica keys, the waiting period begins when the last of its replica keys is deleted. Otherwise, the waiting period begins immediately.

      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.

  • On success, responds with ScheduleKeyDeletionOutput with field(s):
    • key_id(Option<String>):

      The Amazon Resource Name (key ARN) of the KMS key whose deletion is scheduled.

    • deletion_date(Option<DateTime>):

      The date and time after which KMS deletes the KMS key.

      If the KMS key is a multi-Region primary key with replica keys, this field does not appear. The deletion date for the primary key isn’t known until its last replica key is deleted.

    • key_state(Option<KeyState>):

      The current status of the KMS key.

      For more information about how key state affects the use of a KMS key, see Key states of KMS keys in the Key Management Service Developer Guide.

    • pending_window_in_days(Option<i32>):

      The waiting period before the KMS key is deleted.

      If the KMS key is a multi-Region primary key with replicas, the waiting period begins when the last of its replica keys is deleted. Otherwise, the waiting period begins immediately.

  • On failure, responds with SdkError<ScheduleKeyDeletionError>

Constructs a fluent builder for the Sign operation.

  • The fluent builder is configurable:
    • key_id(impl Into<String>) / set_key_id(Option<String>):

      Identifies an asymmetric KMS key. KMS uses the private key in the asymmetric KMS key to sign the message. The KeyUsage type of the KMS key must be SIGN_VERIFY. To find the KeyUsage of a KMS key, use the DescribeKey operation.

      To specify a KMS key, use its key ID, key ARN, alias name, or alias ARN. When using an alias name, prefix it with “alias/”. To specify a KMS key in a different Amazon Web Services 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 KMS key, use ListKeys or DescribeKey. To get the alias name and alias ARN, use ListAliases.

    • message(Blob) / set_message(Option<Blob>):

      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, KMS generates a hash digest of the message and then signs it.

    • message_type(MessageType) / set_message_type(Option<MessageType>):

      Tells 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(Vec<String>) / set_grant_tokens(Option<Vec<String>>):

      A list of grant tokens.

      Use a grant token when your permission to call this operation comes from a new grant that has not yet achieved eventual consistency. For more information, see Grant token and Using a grant token in the Key Management Service Developer Guide.

    • signing_algorithm(SigningAlgorithmSpec) / set_signing_algorithm(Option<SigningAlgorithmSpec>):

      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 KMS key.

  • On success, responds with SignOutput with field(s):
    • key_id(Option<String>):

      The Amazon Resource Name (key ARN) of the asymmetric KMS key that was used to sign the message.

    • signature(Option<Blob>):

      The cryptographic signature that was generated for the message.

      • When used with the supported RSA signing algorithms, the encoding of this value is defined by PKCS #1 in RFC 8017.

      • When used with the ECDSA_SHA_256, ECDSA_SHA_384, or ECDSA_SHA_512 signing algorithms, this value is a DER-encoded object as defined by ANS X9.62–2005 and RFC 3279 Section 2.2.3. This is the most commonly used signature format and is appropriate for most uses.

      When you use the HTTP API or the Amazon Web Services CLI, the value is Base64-encoded. Otherwise, it is not Base64-encoded.

    • signing_algorithm(Option<SigningAlgorithmSpec>):

      The signing algorithm that was used to sign the message.

  • On failure, responds with SdkError<SignError>

Constructs a fluent builder for the TagResource operation.

  • The fluent builder is configurable:
    • key_id(impl Into<String>) / set_key_id(Option<String>):

      Identifies a customer managed key in the account and Region.

      Specify the key ID or key ARN of the KMS key.

      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 KMS key, use ListKeys or DescribeKey.

    • tags(Vec<Tag>) / set_tags(Option<Vec<Tag>>):

      One or more tags.

      Each tag consists of a tag key and a tag value. The tag value can be an empty (null) string.

      You cannot have more than one tag on a KMS key with the same tag key. If you specify an existing tag key with a different tag value, KMS replaces the current tag value with the specified one.

  • On success, responds with TagResourceOutput
  • On failure, responds with SdkError<TagResourceError>

Constructs a fluent builder for the UntagResource operation.

Constructs a fluent builder for the UpdateAlias operation.

  • The fluent builder is configurable:
    • alias_name(impl Into<String>) / set_alias_name(Option<String>):

      Identifies the alias that is changing its KMS key. 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(impl Into<String>) / set_target_key_id(Option<String>):

      Identifies the customer managed key to associate with the alias. You don’t have permission to associate an alias with an Amazon Web Services managed key.

      The KMS key must be in the same Amazon Web Services account and Region as the alias. Also, the new target KMS key must be the same type as the current target KMS key (both symmetric or both asymmetric) and they must have the same key usage.

      Specify the key ID or key ARN of the KMS key.

      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 KMS key, use ListKeys or DescribeKey.

      To verify that the alias is mapped to the correct KMS key, use ListAliases.

  • On success, responds with UpdateAliasOutput
  • On failure, responds with SdkError<UpdateAliasError>

Constructs a fluent builder for the UpdateCustomKeyStore operation.

Constructs a fluent builder for the UpdateKeyDescription operation.

Constructs a fluent builder for the UpdatePrimaryRegion operation.

  • The fluent builder is configurable:
    • key_id(impl Into<String>) / set_key_id(Option<String>):

      Identifies the current primary key. When the operation completes, this KMS key will be a replica key.

      Specify the key ID or key ARN of a multi-Region primary key.

      For example:

      • Key ID: mrk-1234abcd12ab34cd56ef1234567890ab

      • Key ARN: arn:aws:kms:us-east-2:111122223333:key/mrk-1234abcd12ab34cd56ef1234567890ab

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

    • primary_region(impl Into<String>) / set_primary_region(Option<String>):

      The Amazon Web Services Region of the new primary key. Enter the Region ID, such as us-east-1 or ap-southeast-2. There must be an existing replica key in this Region.

      When the operation completes, the multi-Region key in this Region will be the primary key.

  • On success, responds with UpdatePrimaryRegionOutput
  • On failure, responds with SdkError<UpdatePrimaryRegionError>

Constructs a fluent builder for the Verify operation.

  • The fluent builder is configurable:
    • key_id(impl Into<String>) / set_key_id(Option<String>):

      Identifies the asymmetric KMS key that will be used to verify the signature. This must be the same KMS key that was used to generate the signature. If you specify a different KMS key, the signature verification fails.

      To specify a KMS key, use its key ID, key ARN, alias name, or alias ARN. When using an alias name, prefix it with “alias/”. To specify a KMS key in a different Amazon Web Services 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 KMS key, use ListKeys or DescribeKey. To get the alias name and alias ARN, use ListAliases.

    • message(Blob) / set_message(Option<Blob>):

      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(MessageType) / set_message_type(Option<MessageType>):

      Tells 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(Blob) / set_signature(Option<Blob>):

      The signature that the Sign operation generated.

    • signing_algorithm(SigningAlgorithmSpec) / set_signing_algorithm(Option<SigningAlgorithmSpec>):

      The signing algorithm that was used to sign the message. If you submit a different algorithm, the signature verification fails.

    • grant_tokens(Vec<String>) / set_grant_tokens(Option<Vec<String>>):

      A list of grant tokens.

      Use a grant token when your permission to call this operation comes from a new grant that has not yet achieved eventual consistency. For more information, see Grant token and Using a grant token in the Key Management Service Developer Guide.

  • On success, responds with VerifyOutput with field(s):
    • key_id(Option<String>):

      The Amazon Resource Name (key ARN) of the asymmetric KMS key that was used to verify the signature.

    • signature_valid(bool):

      A Boolean value that indicates whether the signature was verified. A value of True indicates that the Signature was produced by signing the Message with the specified KeyID and SigningAlgorithm. If the signature is not verified, the Verify operation fails with a KMSInvalidSignatureException exception.

    • signing_algorithm(Option<SigningAlgorithmSpec>):

      The signing algorithm that was used to verify the signature.

  • On failure, responds with SdkError<VerifyError>

Constructs a fluent builder for the VerifyMac operation.

  • The fluent builder is configurable:
    • message(Blob) / set_message(Option<Blob>):

      The message that will be used in the verification. Enter the same message that was used to generate the HMAC.

      GenerateMac and VerifyMac do not provide special handling for message digests. If you generated an HMAC for a hash digest of a message, you must verify the HMAC for the same hash digest.

    • key_id(impl Into<String>) / set_key_id(Option<String>):

      The KMS key that will be used in the verification.

      Enter a key ID of the KMS key that was used to generate the HMAC. If you identify a different KMS key, the VerifyMac operation fails.

    • mac_algorithm(MacAlgorithmSpec) / set_mac_algorithm(Option<MacAlgorithmSpec>):

      The MAC algorithm that will be used in the verification. Enter the same MAC algorithm that was used to compute the HMAC. This algorithm must be supported by the HMAC KMS key identified by the KeyId parameter.

    • mac(Blob) / set_mac(Option<Blob>):

      The HMAC to verify. Enter the HMAC that was generated by the GenerateMac operation when you specified the same message, HMAC KMS key, and MAC algorithm as the values specified in this request.

    • grant_tokens(Vec<String>) / set_grant_tokens(Option<Vec<String>>):

      A list of grant tokens.

      Use a grant token when your permission to call this operation comes from a new grant that has not yet achieved eventual consistency. For more information, see Grant token and Using a grant token in the Key Management Service Developer Guide.

  • On success, responds with VerifyMacOutput with field(s):
    • key_id(Option<String>):

      The HMAC KMS key used in the verification.

    • mac_valid(bool):

      A Boolean value that indicates whether the HMAC was verified. A value of True indicates that the HMAC (Mac) was generated with the specified Message, HMAC KMS key (KeyID) and MacAlgorithm..

      If the HMAC is not verified, the VerifyMac operation fails with a KMSInvalidMacException exception. This exception indicates that one or more of the inputs changed since the HMAC was computed.

    • mac_algorithm(Option<MacAlgorithmSpec>):

      The MAC algorithm used in the verification.

  • On failure, responds with SdkError<VerifyMacError>

Creates a new client from an SDK Config.

Panics
  • This method will panic if the sdk_config is missing an async sleep implementation. If you experience this panic, set the sleep_impl on the Config passed into this function to fix it.
  • This method will panic if the sdk_config is missing an HTTP connector. If you experience this panic, set the http_connector on the Config passed into this function to fix it.

Creates a new client from the service Config.

Panics
  • This method will panic if the conf is missing an async sleep implementation. If you experience this panic, set the sleep_impl on the Config passed into this function to fix it.
  • This method will panic if the conf is missing an HTTP connector. If you experience this panic, set the http_connector on the Config passed into this function to fix it.
Examples found in repository?
src/client.rs (line 7775)
7774
7775
7776

    pub fn new(sdk_config: &aws_types::sdk_config::SdkConfig) -> Self {
        Self::from_conf(sdk_config.into())
    }

Trait Implementations§

Returns a copy of the value. Read more
Performs copy-assignment from source. Read more
Formats the value using the given formatter. Read more
Converts to this type from the input type.

Auto Trait Implementations§

Blanket Implementations§

Gets the TypeId of self. Read more
Immutably borrows from an owned value. Read more
Mutably borrows from an owned value. Read more

Returns the argument unchanged.

Instruments this type with the provided Span, returning an Instrumented wrapper. Read more
Instruments this type with the current Span, returning an Instrumented wrapper. Read more

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Should always be Self
The resulting type after obtaining ownership.
Creates owned data from borrowed data, usually by cloning. Read more
Uses borrowed data to replace owned data, usually by cloning. Read more
The type returned in the event of a conversion error.
Performs the conversion.
The type returned in the event of a conversion error.
Performs the conversion.
Attaches the provided Subscriber to this type, returning a WithDispatch wrapper. Read more
Attaches the current default Subscriber to this type, returning a WithDispatch wrapper. Read more