String aliasName
String that contains the alias. This value begins with alias/.
String aliasArn
String that contains the key ARN.
String targetKeyId
String that contains the key identifier of the KMS key associated with the alias.
Date creationDate
Date and time that the alias was most recently created in the account and Region. Formatted as Unix time.
Date lastUpdatedDate
Date and time that the alias was most recently associated with a KMS key in the account and Region. Formatted as Unix time.
String keyId
Identifies the KMS key whose deletion is being canceled.
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.
String customKeyStoreId
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.
String aliasName
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.
String targetKeyId
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.
String customKeyStoreName
Specifies a friendly name for the custom key store. The name must be unique in your Amazon Web Services account and Region. This parameter is required for all custom key stores.
String cloudHsmClusterId
Identifies the CloudHSM cluster for an CloudHSM key store. This parameter is required for custom key stores with
CustomKeyStoreType of AWS_CLOUDHSM.
Enter the cluster ID of any active CloudHSM cluster that is not already associated with a custom key store. To find the cluster ID, use the DescribeClusters operation.
String trustAnchorCertificate
Specifies the certificate for an CloudHSM key store. This parameter is required for custom key stores with a
CustomKeyStoreType of AWS_CLOUDHSM.
Enter the content of the trust anchor certificate for the CloudHSM cluster. This is the content of the
customerCA.crt file that you created when you initialized the cluster.
String keyStorePassword
Specifies the kmsuser password for an CloudHSM key store. This parameter is required for custom key
stores with a CustomKeyStoreType of AWS_CLOUDHSM.
Enter the password of the
kmsuser crypto user (CU) account in the specified CloudHSM cluster. 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 KMS the kmsuser account password; it does not change the password in the
CloudHSM cluster.
String customKeyStoreType
Specifies the type of custom key store. The default value is AWS_CLOUDHSM.
For a custom key store backed by an CloudHSM cluster, omit the parameter or enter AWS_CLOUDHSM. For
a custom key store backed by an external key manager outside of Amazon Web Services, enter
EXTERNAL_KEY_STORE. You cannot change this property after the key store is created.
String xksProxyUriEndpoint
Specifies the endpoint that KMS uses to send requests to the external key store proxy (XKS proxy). This parameter
is required for custom key stores with a CustomKeyStoreType of EXTERNAL_KEY_STORE.
The protocol must be HTTPS. KMS communicates on port 443. Do not specify the port in the
XksProxyUriEndpoint value.
For external key stores with XksProxyConnectivity value of VPC_ENDPOINT_SERVICE,
specify https:// followed by the private DNS name of the VPC endpoint service.
For external key stores with PUBLIC_ENDPOINT connectivity, this endpoint must be reachable before
you create the custom key store. KMS connects to the external key store proxy while creating the custom key
store. For external key stores with VPC_ENDPOINT_SERVICE connectivity, KMS connects when you call
the ConnectCustomKeyStore operation.
The value of this parameter must begin with https://. The remainder can contain upper and lower case
letters (A-Z and a-z), numbers (0-9), dots (.), and hyphens (-). Additional slashes (
/ and \) are not permitted.
Uniqueness requirements:
The combined XksProxyUriEndpoint and XksProxyUriPath values must be unique in the
Amazon Web Services account and Region.
An external key store with PUBLIC_ENDPOINT connectivity cannot use the same
XksProxyUriEndpoint value as an external key store with VPC_ENDPOINT_SERVICE
connectivity in the same Amazon Web Services Region.
Each external key store with VPC_ENDPOINT_SERVICE connectivity must have its own private DNS name.
The XksProxyUriEndpoint value for external key stores with VPC_ENDPOINT_SERVICE
connectivity (private DNS name) must be unique in the Amazon Web Services account and Region.
String xksProxyUriPath
Specifies the base path to the proxy APIs for this external key store. To find this value, see the documentation
for your external key store proxy. This parameter is required for all custom key stores with a
CustomKeyStoreType of EXTERNAL_KEY_STORE.
The value must start with / and must end with /kms/xks/v1 where v1
represents the version of the KMS external key store proxy API. This path can include an optional prefix between
the required elements such as /prefix/kms/xks/v1.
Uniqueness requirements:
The combined XksProxyUriEndpoint and XksProxyUriPath values must be unique in the
Amazon Web Services account and Region.
String xksProxyVpcEndpointServiceName
Specifies the name of the Amazon VPC endpoint service for interface endpoints that is used to communicate with
your external key store proxy (XKS proxy). This parameter is required when the value of
CustomKeyStoreType is EXTERNAL_KEY_STORE and the value of
XksProxyConnectivity is VPC_ENDPOINT_SERVICE.
The Amazon VPC endpoint service must fulfill all requirements for use with an external key store.
Uniqueness requirements:
External key stores with VPC_ENDPOINT_SERVICE connectivity can share an Amazon VPC, but each
external key store must have its own VPC endpoint service and private DNS name.
XksProxyAuthenticationCredentialType xksProxyAuthenticationCredential
Specifies an authentication credential for the external key store proxy (XKS proxy). This parameter is required
for all custom key stores with a CustomKeyStoreType of EXTERNAL_KEY_STORE.
The XksProxyAuthenticationCredential has two required elements: RawSecretAccessKey, a
secret key, and AccessKeyId, a unique identifier for the RawSecretAccessKey. For
character requirements, see
XksProxyAuthenticationCredentialType.
KMS uses this authentication credential to sign requests to the external key store proxy on your behalf. This credential is unrelated to Identity and Access Management (IAM) and Amazon Web Services credentials.
This parameter doesn't set or change the authentication credentials on the XKS proxy. It just tells KMS the credential that you established on your external key store proxy. If you rotate your proxy authentication credential, use the UpdateCustomKeyStore operation to provide the new credential to KMS.
String xksProxyConnectivity
Indicates how KMS communicates with the external key store proxy. This parameter is required for custom key
stores with a CustomKeyStoreType of EXTERNAL_KEY_STORE.
If the external key store proxy uses a public endpoint, specify PUBLIC_ENDPOINT. If the external key
store proxy uses a Amazon VPC endpoint service for communication with KMS, specify
VPC_ENDPOINT_SERVICE. For help making this choice, see Choosing a connectivity option in the Key Management Service Developer Guide.
An Amazon VPC endpoint service keeps your communication with KMS in a private address space entirely within Amazon Web Services, but it requires more configuration, including establishing a Amazon VPC with multiple subnets, a VPC endpoint service, a network load balancer, and a verified private DNS name. A public endpoint is simpler to set up, but it might be slower and might not fulfill your security requirements. You might consider testing with a public endpoint, and then establishing a VPC endpoint service for production tasks. Note that this choice does not determine the location of the external key store proxy. Even if you choose a VPC endpoint service, the proxy can be hosted within the VPC or outside of Amazon Web Services such as in your corporate data center.
String customKeyStoreId
A unique identifier for the new custom key store.
String keyId
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.
String granteePrincipal
The identity that gets the permissions specified in the grant.
To specify the grantee principal, use the Amazon Resource Name (ARN) of an Amazon Web Services principal. Valid principals include Amazon Web Services accounts, IAM users, IAM roles, federated users, and assumed role users. For help with the ARN syntax for a principal, see IAM ARNs in the Identity and Access Management User Guide .
String retiringPrincipal
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 principals include Amazon Web Services accounts, IAM users, IAM roles, federated users, and assumed role users. For help with the ARN syntax for a principal, see IAM ARNs in the Identity and Access Management User Guide .
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.
SdkInternalList<T> operations
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.
GrantConstraints constraints
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.
SdkInternalList<T> grantTokens
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.
String name
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.
String grantToken
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.
String grantId
The unique identifier for the grant.
You can use the GrantId in a ListGrants, RetireGrant, or RevokeGrant operation.
String policy
The key policy to attach to the KMS key.
If you provide a key policy, it must meet the following criteria:
The key policy must allow the calling principal to make a subsequent PutKeyPolicy request on the KMS
key. This reduces the risk that the KMS key becomes unmanageable. For more information, see Default key policy in the Key Management Service Developer Guide. (To omit this condition, set
BypassPolicyLockoutSafetyCheck to true.)
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, 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.
If you do not provide 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.
The key policy size quota is 32 kilobytes (32768 bytes).
For help writing and formatting a JSON policy document, see the IAM JSON Policy Reference in the Identity and Access Management User Guide .
String description
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.
String keyUsage
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.
String 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 supports both parameters.
String 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 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
String origin
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 this value to EXTERNAL. For more
information about importing key material into KMS, see Importing Key Material in
the Key Management Service Developer Guide. The EXTERNAL origin value is valid only for
symmetric KMS keys.
To create a KMS key in
an CloudHSM 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 CloudHSM
key store. The KeySpec value must be SYMMETRIC_DEFAULT.
To create a KMS key in an
external key store, set this value to EXTERNAL_KEY_STORE. You must also use the
CustomKeyStoreId parameter to identify the external key store and the XksKeyId
parameter to identify the associated external key. The KeySpec value must be
SYMMETRIC_DEFAULT.
String customKeyStoreId
Creates the KMS key in the specified custom key store.
The ConnectionState of the custom key store must be CONNECTED. To find the
CustomKeyStoreID and ConnectionState use the DescribeCustomKeyStores operation.
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.
When you create a KMS key in an CloudHSM key store, KMS generates a non-exportable 256-bit symmetric key in its
associated CloudHSM cluster and associates it with the KMS key. When you create a KMS key in an external key
store, you must use the XksKeyId parameter to specify an external key that serves as key material
for the KMS key.
Boolean bypassPolicyLockoutSafetyCheck
Skips ("bypasses") the key policy lockout safety check. The default value is false.
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, see Default key policy 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.
SdkInternalList<T> tags
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 for 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.
Boolean multiRegion
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 symmetric or asymmetric multi-Region key, and you can create a multi-Region key with imported key material. However, you cannot create a multi-Region key in a custom key store.
String xksKeyId
Identifies the external key that serves as key material for the KMS key in an external key store. Specify the ID that the external key store proxy uses to refer to the external key. For help, see the documentation for your external key store proxy.
This parameter is required for a KMS key with an Origin value of EXTERNAL_KEY_STORE. It
is not valid for KMS keys with any other Origin value.
The external key must be an existing 256-bit AES symmetric encryption key hosted outside of Amazon Web Services
in an external key manager associated with the external key store specified by the CustomKeyStoreId
parameter. This key must be enabled and configured to perform encryption and decryption. Each KMS key in an
external key store must use a different external key. For details, see Requirements for a KMS key in an
external key store in the Key Management Service Developer Guide.
Each KMS key in an external key store is associated two backing keys. One is key material that KMS generates. The other is the external key specified by this parameter. When you use the KMS key in an external key store to encrypt data, the encryption operation is performed first by KMS using the KMS key material, and then by the external key manager using the specified external key, a process known as double encryption. For details, see Double encryption in the Key Management Service Developer Guide.
KeyMetadata keyMetadata
Metadata associated with the KMS key.
String customKeyStoreId
A unique identifier for the custom key store.
String customKeyStoreName
The user-specified friendly name for the custom key store.
String cloudHsmClusterId
A unique identifier for the CloudHSM cluster that is associated with an CloudHSM key store. This field appears
only when the CustomKeyStoreType is AWS_CLOUDHSM.
String trustAnchorCertificate
The trust anchor certificate of the CloudHSM cluster associated with an CloudHSM key store. When you initialize the
cluster, you create this certificate and save it in the customerCA.crt file.
This field appears only when the CustomKeyStoreType is AWS_CLOUDHSM.
String connectionState
Indicates whether the custom key store is connected to its backing key store. For an CloudHSM key store, the
ConnectionState indicates whether it is connected to its CloudHSM cluster. For an external key
store, the ConnectionState indicates whether it is connected to the external key store proxy that
communicates with your external key manager.
You can create and use KMS keys in your custom key stores only when its ConnectionState is
CONNECTED.
The ConnectionState value is DISCONNECTED only if the key store has never been
connected or you use the DisconnectCustomKeyStore operation to disconnect it. If the value is
CONNECTED but you are having trouble using the custom key store, make sure that the backing key
store is reachable and active. For an CloudHSM key store, verify that its associated CloudHSM cluster is active
and contains at least one active HSM. For an external key store, verify that the external key store proxy and
external key manager are connected and enabled.
A value of FAILED indicates that an attempt to connect was unsuccessful. The
ConnectionErrorCode field in the response indicates the cause of the failure. For help resolving a
connection failure, see Troubleshooting a custom key
store in the Key Management Service Developer Guide.
String connectionErrorCode
Describes the connection error. This field appears in the response only when the ConnectionState is
FAILED.
Many failures can be resolved by updating the properties of the custom key store. To update a custom key store, disconnect it (DisconnectCustomKeyStore), correct the errors (UpdateCustomKeyStore), and try to connect again (ConnectCustomKeyStore). For additional help resolving these errors, see How to Fix a Connection Failure in Key Management Service Developer Guide.
All custom key stores:
INTERNAL_ERROR — KMS could not complete the request due to an internal error. Retry the request. For
ConnectCustomKeyStore requests, disconnect the custom key store before trying to connect again.
NETWORK_ERRORS — Network errors are preventing KMS from connecting the custom key store to its
backing key store.
CloudHSM key stores:
CLUSTER_NOT_FOUND — KMS cannot find the CloudHSM cluster with the specified cluster ID.
INSUFFICIENT_CLOUDHSM_HSMS — The associated CloudHSM cluster does not contain any active HSMs. To
connect a custom key store to its CloudHSM cluster, the cluster must contain at least one active HSM.
INSUFFICIENT_FREE_ADDRESSES_IN_SUBNET — At least one private subnet associated with the CloudHSM
cluster doesn't have any available IP addresses. A CloudHSM key store connection requires one free IP address in
each of the associated private subnets, although two are preferable. For details, see How to Fix a
Connection Failure in the Key Management Service Developer Guide.
INVALID_CREDENTIALS — The KeyStorePassword for the custom key store doesn't match the
current password of the kmsuser crypto user in the CloudHSM cluster. Before you can connect your
custom key store to its CloudHSM cluster, you must change the kmsuser account password and update
the KeyStorePassword value for the custom key store.
SUBNET_NOT_FOUND — A subnet in the CloudHSM cluster configuration was deleted. If KMS cannot find
all of the subnets in the cluster configuration, attempts to connect the custom key store to the CloudHSM cluster
fail. To fix this error, create a cluster from a recent backup and associate it with your custom key store. (This
process creates a new cluster configuration with a VPC and private subnets.) For details, see How to Fix a
Connection Failure in the Key Management Service Developer Guide.
USER_LOCKED_OUT — The kmsuser CU account is locked out of the associated CloudHSM
cluster due to too many failed password attempts. Before you can connect your custom key store to its CloudHSM
cluster, you must change the kmsuser account password and update the key store password value for
the custom key store.
USER_LOGGED_IN — The kmsuser CU account is logged into the associated CloudHSM cluster.
This prevents KMS from rotating the kmsuser account password and logging into the cluster. Before
you can connect your custom key store to its CloudHSM cluster, you must log the kmsuser CU out of
the cluster. If you changed the kmsuser password to log into the cluster, you must also and update
the key store password value for the custom key store. For help, see How to Log Out and
Reconnect in the Key Management Service Developer Guide.
USER_NOT_FOUND — KMS cannot find a kmsuser CU account in the associated CloudHSM
cluster. Before you can connect your custom key store to its CloudHSM cluster, you must create a
kmsuser CU account in the cluster, and then update the key store password value for the custom key
store.
External key stores:
INVALID_CREDENTIALS — One or both of the XksProxyAuthenticationCredential values is not
valid on the specified external key store proxy.
XKS_PROXY_ACCESS_DENIED — KMS requests are denied access to the external key store proxy. If the
external key store proxy has authorization rules, verify that they permit KMS to communicate with the proxy on
your behalf.
XKS_PROXY_INVALID_CONFIGURATION — A configuration error is preventing the external key store from
connecting to its proxy. Verify the value of the XksProxyUriPath.
XKS_PROXY_INVALID_RESPONSE — KMS cannot interpret the response from the external key store proxy. If
you see this connection error code repeatedly, notify your external key store proxy vendor.
XKS_PROXY_INVALID_TLS_CONFIGURATION — KMS cannot connect to the external key store proxy because the
TLS configuration is invalid. Verify that the XKS proxy supports TLS 1.2 or 1.3. Also, verify that the TLS
certificate is not expired, and that it matches the hostname in the XksProxyUriEndpoint value, and
that it is signed by a certificate authority included in the Trusted
Certificate Authorities list.
XKS_PROXY_NOT_REACHABLE — KMS can't communicate with your external key store proxy. Verify that the
XksProxyUriEndpoint and XksProxyUriPath are correct. Use the tools for your external
key store proxy to verify that the proxy is active and available on its network. Also, verify that your external
key manager instances are operating properly. Connection attempts fail with this connection error code if the
proxy reports that all external key manager instances are unavailable.
XKS_PROXY_TIMED_OUT — KMS can connect to the external key store proxy, but the proxy does not
respond to KMS in the time allotted. If you see this connection error code repeatedly, notify your external key
store proxy vendor.
XKS_VPC_ENDPOINT_SERVICE_INVALID_CONFIGURATION — The Amazon VPC endpoint service configuration
doesn't conform to the requirements for an KMS external key store.
The VPC endpoint service must be an endpoint service for interface endpoints in the caller's Amazon Web Services account.
It must have a network load balancer (NLB) connected to at least two subnets, each in a different Availability Zone.
The Allow principals list must include the KMS service principal for the Region,
cks.kms.<region>.amazonaws.com, such as cks.kms.us-east-1.amazonaws.com.
It must not require acceptance of connection requests.
It must have a private DNS name. The private DNS name for an external key store with
VPC_ENDPOINT_SERVICE connectivity must be unique in its Amazon Web Services Region.
The domain of the private DNS name must have a verification status of
verified.
The TLS certificate specifies the private DNS hostname at which the endpoint is reachable.
XKS_VPC_ENDPOINT_SERVICE_NOT_FOUND — KMS can't find the VPC endpoint service that it uses to
communicate with the external key store proxy. Verify that the XksProxyVpcEndpointServiceName is
correct and the KMS service principal has service consumer permissions on the Amazon VPC endpoint service.
Date creationDate
The date and time when the custom key store was created.
String customKeyStoreType
Indicates the type of the custom key store. AWS_CLOUDHSM indicates a custom key store backed by an
CloudHSM cluster. EXTERNAL_KEY_STORE indicates a custom key store backed by an external key store
proxy and external key manager outside of Amazon Web Services.
XksProxyConfigurationType xksProxyConfiguration
Configuration settings for the external key store proxy (XKS proxy). The external key store proxy translates KMS requests into a format that your external key manager can understand. The proxy configuration includes connection information that KMS requires.
This field appears only when the CustomKeyStoreType is EXTERNAL_KEY_STORE.
ByteBuffer ciphertextBlob
Ciphertext to be decrypted. The blob includes metadata.
SdkInternalMap<K,V> encryptionContext
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.
SdkInternalList<T> grantTokens
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.
String keyId
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.
String encryptionAlgorithm
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.
String keyId
The Amazon Resource Name (key ARN) of the KMS key that was used to decrypt the ciphertext.
ByteBuffer plaintext
Decrypted plaintext data. When you use the HTTP API or the Amazon Web Services CLI, the value is Base64-encoded. Otherwise, it is not Base64-encoded.
String encryptionAlgorithm
The encryption algorithm that was used to decrypt the ciphertext.
String aliasName
The alias to be deleted. The alias name must begin with alias/ followed by the alias name, such as
alias/ExampleAlias.
String customKeyStoreId
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.
String keyId
Identifies the KMS key from which you are deleting imported key material. The Origin of the KMS key
must be EXTERNAL.
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.
String customKeyStoreId
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, provide either the CustomKeyStoreId or
CustomKeyStoreName parameter, but not both.
String customKeyStoreName
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, provide either the CustomKeyStoreId or
CustomKeyStoreName parameter, but not both.
Integer limit
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.
String marker
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.
SdkInternalList<T> customKeyStores
Contains metadata about each custom key store.
String nextMarker
When Truncated is true, this element is present and contains the value to use for the
Marker parameter in a subsequent request.
Boolean truncated
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.
String keyId
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.
SdkInternalList<T> grantTokens
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.
KeyMetadata keyMetadata
Metadata associated with the key.
String keyId
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.
String keyId
Identifies a symmetric encryption KMS key. You cannot enable or disable automatic rotation of asymmetric KMS keys, HMAC KMS keys, KMS keys with imported key material, or KMS keys in a custom key store.
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.
String customKeyStoreId
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.
String keyId
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.
String keyId
Identifies a symmetric encryption KMS key. You cannot enable automatic rotation of asymmetric KMS keys, HMAC KMS keys, KMS keys with imported key material, or KMS keys in a custom key store. To enable or disable automatic rotation of a set of related multi-Region keys, set the property on the primary 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.
String keyId
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.
ByteBuffer plaintext
Data to be encrypted.
SdkInternalMap<K,V> encryptionContext
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.
SdkInternalList<T> grantTokens
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.
String encryptionAlgorithm
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.
The SM2PKE algorithm is only available in China Regions.
ByteBuffer ciphertextBlob
The encrypted plaintext. When you use the HTTP API or the Amazon Web Services CLI, the value is Base64-encoded. Otherwise, it is not Base64-encoded.
String keyId
The Amazon Resource Name (key ARN) of the KMS key that was used to encrypt the plaintext.
String encryptionAlgorithm
The encryption algorithm that was used to encrypt the plaintext.
SdkInternalMap<K,V> encryptionContext
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.
String keyId
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.
String keyPairSpec
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.
SdkInternalList<T> grantTokens
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.
ByteBuffer privateKeyCiphertextBlob
The encrypted copy of the private key. When you use the HTTP API or the Amazon Web Services CLI, the value is Base64-encoded. Otherwise, it is not Base64-encoded.
ByteBuffer privateKeyPlaintext
The plaintext copy of the private key. When you use the HTTP API or the Amazon Web Services CLI, the value is Base64-encoded. Otherwise, it is not Base64-encoded.
ByteBuffer publicKey
The public key (in plaintext). When you use the HTTP API or the Amazon Web Services CLI, the value is Base64-encoded. Otherwise, it is not Base64-encoded.
String keyId
The Amazon Resource Name (key ARN) of the KMS key that encrypted the private key.
String keyPairSpec
The type of data key pair that was generated.
SdkInternalMap<K,V> encryptionContext
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.
String keyId
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.
String keyPairSpec
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.
SdkInternalList<T> grantTokens
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.
ByteBuffer privateKeyCiphertextBlob
The encrypted copy of the private key. When you use the HTTP API or the Amazon Web Services CLI, the value is Base64-encoded. Otherwise, it is not Base64-encoded.
ByteBuffer publicKey
The public key (in plaintext). When you use the HTTP API or the Amazon Web Services CLI, the value is Base64-encoded. Otherwise, it is not Base64-encoded.
String keyId
The Amazon Resource Name (key ARN) of the KMS key that encrypted the private key.
String keyPairSpec
The type of data key pair that was generated.
String keyId
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.
SdkInternalMap<K,V> encryptionContext
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.
Integer numberOfBytes
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.
String keySpec
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.
SdkInternalList<T> grantTokens
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.
ByteBuffer ciphertextBlob
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.
ByteBuffer plaintext
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.
String keyId
The Amazon Resource Name (key ARN) of the KMS key that encrypted the data key.
String keyId
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.
SdkInternalMap<K,V> encryptionContext
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.
String keySpec
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.
Integer numberOfBytes
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.
SdkInternalList<T> grantTokens
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.
ByteBuffer ciphertextBlob
The encrypted 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.
String keyId
The Amazon Resource Name (key ARN) of the KMS key that encrypted the data key.
ByteBuffer message
The message to be hashed. Specify a message of up to 4,096 bytes.
GenerateMac and VerifyMac do not provide special handling for message digests. If you
generate an HMAC for a hash digest of a message, you must verify the HMAC of the same hash digest.
String keyId
The HMAC KMS key to use in the operation. The MAC algorithm computes the HMAC for the message and the key as described in RFC 2104.
To identify an HMAC KMS key, use the DescribeKey operation and see the KeySpec field in the
response.
String macAlgorithm
The MAC algorithm used in the operation.
The algorithm must be compatible with the HMAC KMS key that you specify. To find the MAC algorithms that your
HMAC KMS key supports, use the DescribeKey operation and see the MacAlgorithms field in the
DescribeKey response.
SdkInternalList<T> grantTokens
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.
ByteBuffer mac
The hash-based message authentication code (HMAC) that was generated for the specified message, HMAC KMS key, and MAC algorithm.
This is the standard, raw HMAC defined in RFC 2104.
String macAlgorithm
The MAC algorithm that was used to generate the HMAC.
String keyId
The HMAC KMS key used in the operation.
Integer numberOfBytes
The length of the random byte string. This parameter is required.
String customKeyStoreId
Generates the random byte string in the CloudHSM cluster that is associated with the specified CloudHSM key store. To find the ID of a custom key store, use the DescribeCustomKeyStores operation.
External key store IDs are not valid for this parameter. If you specify the ID of an external key store,
GenerateRandom throws an UnsupportedOperationException.
ByteBuffer plaintext
The random byte string. When you use the HTTP API or the Amazon Web Services CLI, the value is Base64-encoded. Otherwise, it is not Base64-encoded.
String keyId
Gets the key policy 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.
String policyName
Specifies the name of the key policy. The only valid name is default. To get the names of key
policies, use ListKeyPolicies.
String policy
A key policy document in JSON format.
String keyId
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.
Boolean keyRotationEnabled
A Boolean value that specifies whether key rotation is enabled.
String keyId
The identifier of the symmetric encryption KMS key into which you will import key material. The
Origin of the KMS key must be EXTERNAL.
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.
String wrappingAlgorithm
The algorithm you will use to encrypt the key material before using the ImportKeyMaterial operation to import it. For more information, see Encrypt the key material in the Key Management Service Developer Guide.
The RSAES_PKCS1_V1_5 wrapping algorithm is deprecated. We recommend that you begin using a different
wrapping algorithm immediately. KMS will end support for RSAES_PKCS1_V1_5 by October 1, 2023
pursuant to cryptographic
key management guidance from the National Institute of Standards and Technology (NIST).
String wrappingKeySpec
The type of wrapping key (public key) to return in the response. Only 2048-bit RSA public keys are supported.
String keyId
The Amazon Resource Name (key ARN) of the KMS
key to use in a subsequent ImportKeyMaterial request. This is the same KMS key specified in the
GetParametersForImport request.
ByteBuffer importToken
The import token to send in a subsequent ImportKeyMaterial request.
ByteBuffer publicKey
The public key to use to encrypt the key material before importing it with ImportKeyMaterial.
Date parametersValidTo
The time at which the import token and public key are no longer valid. After this time, you cannot use them to
make an ImportKeyMaterial request and you must send another GetParametersForImport request to
get new ones.
String keyId
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.
SdkInternalList<T> grantTokens
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.
String keyId
The Amazon Resource Name (key ARN) of the asymmetric KMS key from which the public key was downloaded.
ByteBuffer publicKey
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.
String 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 supports both fields.
String keySpec
The type of the of the public key that was downloaded.
String keyUsage
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.
SdkInternalList<T> encryptionAlgorithms
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.
SdkInternalList<T> signingAlgorithms
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.
SdkInternalMap<K,V> encryptionContextSubset
A list of key-value pairs that must be included in the encryption context of the cryptographic operation request. The grant allows the cryptographic operation only when the encryption context in the request includes the key-value pairs specified in this constraint, although it can include additional key-value pairs.
SdkInternalMap<K,V> encryptionContextEquals
A list of key-value pairs that must match the encryption context in the cryptographic operation request. The grant allows the operation only when the encryption context in the request is the same as the encryption context specified in this constraint.
String keyId
The unique identifier for the KMS key to which the grant applies.
String grantId
The unique identifier for the grant.
String name
The friendly name that identifies the grant. If a name was provided in the CreateGrant request, that name is returned. Otherwise this value is null.
Date creationDate
The date and time when the grant was created.
String granteePrincipal
The identity that gets the permissions in the grant.
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 Amazon
Web Services service, the GranteePrincipal field contains the service principal, which might represent several different grantee principals.
String retiringPrincipal
The principal that can retire the grant.
String issuingAccount
The Amazon Web Services account under which the grant was issued.
SdkInternalList<T> operations
The list of operations permitted by the grant.
GrantConstraints constraints
A list of key-value pairs that must be present in the encryption context of certain subsequent operations that the grant allows.
String keyId
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.
ByteBuffer importToken
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.
ByteBuffer encryptedKeyMaterial
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.
Date validTo
The date and time when the imported key material expires. This parameter is required when the value of the
ExpirationModel parameter is KEY_MATERIAL_EXPIRES. Otherwise it is not valid.
The value of this parameter must be a future date and time. The maximum value is 365 days from the request date.
When the key material expires, KMS deletes the key material from the KMS key. Without its key material, the KMS key is unusable. To use the KMS key in cryptographic operations, you must reimport the same key material.
You cannot change the ExpirationModel or ValidTo values for the current import after
the request completes. To change either value, you must delete (DeleteImportedKeyMaterial) and reimport
the key material.
String expirationModel
Specifies whether the key material expires. The default is KEY_MATERIAL_EXPIRES.
When the value of ExpirationModel is KEY_MATERIAL_EXPIRES, you must specify a value for
the ValidTo parameter. When value is KEY_MATERIAL_DOES_NOT_EXPIRE, you must omit the
ValidTo parameter.
You cannot change the ExpirationModel or ValidTo values for the current import after
the request completes. To change either value, you must delete (DeleteImportedKeyMaterial) and reimport
the key material.
String aWSAccountId
The twelve-digit account ID of the Amazon Web Services account that owns the KMS key.
String keyId
The globally unique identifier for the KMS key.
String arn
The Amazon Resource Name (ARN) of the KMS key. For examples, see Key Management Service (KMS) in the Example ARNs section of the Amazon Web Services General Reference.
Date creationDate
The date and time when the KMS key was created.
Boolean enabled
Specifies whether the KMS key is enabled. When KeyState is Enabled this value is true,
otherwise it is false.
String description
The description of the KMS key.
String keyUsage
The cryptographic operations for which you can use the KMS key.
String 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.
Date deletionDate
The date and time after which KMS deletes this KMS key. This value is present only when the KMS key is scheduled
for deletion, that is, when its KeyState is PendingDeletion.
When the primary key in a multi-Region key is scheduled for deletion but still has replica keys, its key state is
PendingReplicaDeletion and the length of its waiting period is displayed in the
PendingDeletionWindowInDays field.
Date validTo
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. This value is present only for KMS keys whose Origin is
EXTERNAL and whose ExpirationModel is KEY_MATERIAL_EXPIRES, otherwise this
value is omitted.
String origin
The source of the key material for the KMS key. When this value is AWS_KMS, KMS created the key
material. When this value is EXTERNAL, the key material was imported or the KMS key doesn't have any
key material. When this value is AWS_CLOUDHSM, the key material was created in the CloudHSM cluster
associated with a custom key store.
String customKeyStoreId
A unique identifier for the custom key store that contains the KMS key. This field is present only when the KMS key is created in a custom key store.
String cloudHsmClusterId
The cluster ID of the CloudHSM cluster that contains the key material for the KMS key. When you create a KMS key in an CloudHSM custom key store, KMS creates the key material for the KMS key in the associated CloudHSM cluster. This field is present only when the KMS key is created in an CloudHSM key store.
String expirationModel
Specifies whether the KMS key's key material expires. This value is present only when Origin is
EXTERNAL, otherwise this value is omitted.
String keyManager
The manager of the KMS key. KMS keys in your Amazon Web Services account are either customer managed or Amazon Web Services managed. For more information about the difference, see KMS keys in the Key Management Service Developer Guide.
String customerMasterKeySpec
Instead, use the KeySpec field.
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 supports both fields.
String keySpec
Describes the type of key material in the KMS key.
SdkInternalList<T> encryptionAlgorithms
The encryption algorithms that the KMS key supports. You cannot use the KMS key with other encryption algorithms within KMS.
This value is present only when the KeyUsage of the KMS key is ENCRYPT_DECRYPT.
SdkInternalList<T> signingAlgorithms
The signing algorithms that the KMS key supports. You cannot use the KMS key with other signing algorithms within KMS.
This field appears only when the KeyUsage of the KMS key is SIGN_VERIFY.
Boolean multiRegion
Indicates whether the KMS key is a multi-Region (True) or regional (False) key. This
value is True for multi-Region primary and replica keys and False for regional KMS
keys.
For more information about multi-Region keys, see Multi-Region keys in KMS in the Key Management Service Developer Guide.
MultiRegionConfiguration multiRegionConfiguration
Lists the primary and replica keys in same multi-Region key. This field is present only when the value of the
MultiRegion field is True.
For more information about any listed KMS key, use the DescribeKey operation.
MultiRegionKeyType indicates whether the KMS key is a PRIMARY or REPLICA
key.
PrimaryKey displays the key ARN and Region of the primary key. This field displays the current KMS
key if it is the primary key.
ReplicaKeys displays the key ARNs and Regions of all replica keys. This field includes the current
KMS key if it is a replica key.
Integer pendingDeletionWindowInDays
The waiting period before the primary key in a multi-Region key is deleted. This waiting period begins when the
last of its replica keys is deleted. This value is present only when the KeyState of the KMS key is
PendingReplicaDeletion. That indicates that the KMS key is the primary key in a multi-Region key, it
is scheduled for deletion, and it still has existing replica keys.
When a single-Region KMS key or a multi-Region replica key is scheduled for deletion, its deletion date is
displayed in the DeletionDate field. However, when the primary key in a multi-Region key is
scheduled for deletion, its waiting period doesn't begin until all of its replica keys are deleted. This value
displays that waiting period. When the last replica key in the multi-Region key is deleted, the
KeyState of the scheduled primary key changes from PendingReplicaDeletion to
PendingDeletion and the deletion date appears in the DeletionDate field.
SdkInternalList<T> macAlgorithms
The message authentication code (MAC) algorithm that the HMAC KMS key supports.
This value is present only when the KeyUsage of the KMS key is GENERATE_VERIFY_MAC.
XksKeyConfigurationType xksKeyConfiguration
Information about the external key that is associated with a KMS key in an external key store.
For more information, see External key in the Key Management Service Developer Guide.
String keyId
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.
Integer limit
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.
String marker
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.
SdkInternalList<T> aliases
A list of aliases.
String nextMarker
When Truncated is true, this element is present and contains the value to use for the
Marker parameter in a subsequent request.
Boolean truncated
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.
Integer limit
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.
String marker
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.
String keyId
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.
String grantId
Returns only the grant with the specified grant ID. The grant ID uniquely identifies the grant.
String granteePrincipal
Returns only grants where the specified principal is the grantee principal for the grant.
SdkInternalList<T> grants
A list of grants.
String nextMarker
When Truncated is true, this element is present and contains the value to use for the
Marker parameter in a subsequent request.
Boolean truncated
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.
String keyId
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.
Integer limit
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.
String marker
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.
SdkInternalList<T> policyNames
A list of key policy names. The only valid value is default.
String nextMarker
When Truncated is true, this element is present and contains the value to use for the
Marker parameter in a subsequent request.
Boolean truncated
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.
Integer limit
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.
String marker
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.
SdkInternalList<T> keys
A list of KMS keys.
String nextMarker
When Truncated is true, this element is present and contains the value to use for the
Marker parameter in a subsequent request.
Boolean truncated
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.
String keyId
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.
Integer limit
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.
String marker
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.
SdkInternalList<T> tags
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 for KMS in the Key Management Service Developer Guide.
String nextMarker
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.
Boolean truncated
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.
Integer limit
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.
String marker
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.
String retiringPrincipal
The retiring principal for which to list grants. Enter a principal in your Amazon Web Services account.
To specify the retiring principal, use the Amazon Resource Name (ARN) of an Amazon Web Services principal. Valid principals include Amazon Web Services accounts, IAM users, IAM roles, federated users, and assumed role users. For help with the ARN syntax for a principal, see IAM ARNs in the Identity and Access Management User Guide .
SdkInternalList<T> grants
A list of grants.
String nextMarker
When Truncated is true, this element is present and contains the value to use for the
Marker parameter in a subsequent request.
Boolean truncated
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.
String multiRegionKeyType
Indicates whether the KMS key is a PRIMARY or REPLICA key.
MultiRegionKey primaryKey
Displays the key ARN and Region of the primary key. This field includes the current KMS key if it is the primary key.
SdkInternalList<T> replicaKeys
displays the key ARNs and Regions of all replica keys. This field includes the current KMS key if it is a replica key.
String keyId
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.
String policyName
The name of the key policy. The only valid value is default.
String policy
The key policy to attach to the KMS key.
The key policy must meet the following criteria:
The key policy must allow the calling principal to make a subsequent PutKeyPolicy request on the KMS
key. This reduces the risk that the KMS key becomes unmanageable. For more information, see Default key policy in the Key Management Service Developer Guide. (To omit this condition, set
BypassPolicyLockoutSafetyCheck to true.)
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, 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 ( ) through the end of the ASCII character
range.
Printable characters in the Basic Latin and Latin-1 Supplement character set (through ÿ).
The tab ( ), line feed (
), and carriage return (
) 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 .
Boolean bypassPolicyLockoutSafetyCheck
Skips ("bypasses") the key policy lockout safety check. The default value is false.
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, see Default key policy 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.
ByteBuffer ciphertextBlob
Ciphertext of the data to reencrypt.
SdkInternalMap<K,V> sourceEncryptionContext
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.
String sourceKeyId
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.
String destinationKeyId
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.
SdkInternalMap<K,V> destinationEncryptionContext
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.
String sourceEncryptionAlgorithm
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.
String destinationEncryptionAlgorithm
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.
SdkInternalList<T> grantTokens
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.
ByteBuffer ciphertextBlob
The reencrypted data. When you use the HTTP API or the Amazon Web Services CLI, the value is Base64-encoded. Otherwise, it is not Base64-encoded.
String sourceKeyId
Unique identifier of the KMS key used to originally encrypt the data.
String keyId
The Amazon Resource Name (key ARN) of the KMS key that was used to reencrypt the data.
String sourceEncryptionAlgorithm
The encryption algorithm that was used to decrypt the ciphertext before it was reencrypted.
String destinationEncryptionAlgorithm
The encryption algorithm that was used to reencrypt the data.
String keyId
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.
String replicaRegion
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.
String policy
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:
The key policy must allow the calling principal to make a subsequent PutKeyPolicy request on the KMS
key. This reduces the risk that the KMS key becomes unmanageable. For more information, see Default key policy in the Key Management Service Developer Guide. (To omit this condition, set
BypassPolicyLockoutSafetyCheck to true.)
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, 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 ( ) through the end of the ASCII character
range.
Printable characters in the Basic Latin and Latin-1 Supplement character set (through ÿ).
The tab ( ), line feed (
), and carriage return (
) 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 .
Boolean bypassPolicyLockoutSafetyCheck
Skips ("bypasses") the key policy lockout safety check. The default value is false.
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, see Default key policy 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.
String description
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.
SdkInternalList<T> tags
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 for 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.
KeyMetadata replicaKeyMetadata
Displays details about the new replica key, including its Amazon Resource Name (key ARN) and Key states of KMS keys. It also includes the ARN and Amazon Web Services Region of its primary key and other replica keys.
String replicaPolicy
The key policy of the new replica key. The value is a key policy document in JSON format.
SdkInternalList<T> replicaTags
The tags on the new replica key. The value is a list of tag key and tag value pairs.
String grantToken
Identifies the grant to be retired. You can use a grant token to identify a new grant even before it has achieved eventual consistency.
Only the CreateGrant operation returns a grant token. For details, see Grant token and Eventual consistency in the Key Management Service Developer Guide.
String keyId
The key ARN KMS key associated with the grant. To find the key ARN, use the ListKeys operation.
For example: arn:aws:kms:us-east-2:444455556666:key/1234abcd-12ab-34cd-56ef-1234567890ab
String grantId
Identifies the grant to retire. To get the grant ID, use CreateGrant, ListGrants, or ListRetirableGrants.
Grant ID Example - 0123456789012345678901234567890123456789012345678901234567890123
String keyId
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.
String grantId
Identifies the grant to revoke. To get the grant ID, use CreateGrant, ListGrants, or ListRetirableGrants.
String keyId
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.
Integer pendingWindowInDays
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.
String keyId
The Amazon Resource Name (key ARN) of the KMS key whose deletion is scheduled.
Date deletionDate
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.
String 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.
Integer pendingWindowInDays
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.
String keyId
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.
ByteBuffer message
Specifies the message or message digest to sign. Messages can be 0-4096 bytes. To sign a larger message, provide a message digest.
If you provide a message digest, use the DIGEST value of MessageType to prevent the
digest from being hashed again while signing.
String messageType
Tells KMS whether the value of the Message parameter should be hashed as part of the signing
algorithm. Use RAW for unhashed messages; use DIGEST for message digests, which are
already hashed.
When the value of MessageType is RAW, KMS uses the standard signing algorithm, which
begins with a hash function. When the value is DIGEST, KMS skips the hashing step in the signing
algorithm.
Use the DIGEST value only when the value of the Message parameter is a message digest.
If you use the DIGEST value with an unhashed message, the security of the signing operation can be
compromised.
When the value of MessageTypeis DIGEST, the length of the Message value
must match the length of hashed messages for the specified signing algorithm.
You can submit a message digest and omit the MessageType or specify RAW so the digest
is hashed again while signing. However, this can cause verification failures when verifying with a system that
assumes a single hash.
The hashing algorithm in that Sign uses is based on the SigningAlgorithm value.
Signing algorithms that end in SHA_256 use the SHA_256 hashing algorithm.
Signing algorithms that end in SHA_384 use the SHA_384 hashing algorithm.
Signing algorithms that end in SHA_512 use the SHA_512 hashing algorithm.
SM2DSA uses the SM3 hashing algorithm. For details, see Offline verification with SM2 key pairs.
SdkInternalList<T> grantTokens
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.
String signingAlgorithm
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. When signing with RSA key pairs, RSASSA-PSS algorithms are preferred. We include RSASSA-PKCS1-v1_5 algorithms for compatibility with existing applications.
String keyId
The Amazon Resource Name (key ARN) of the asymmetric KMS key that was used to sign the message.
ByteBuffer signature
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.
String signingAlgorithm
The signing algorithm that was used to sign the message.
String keyId
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.
SdkInternalList<T> tags
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.
String keyId
Identifies the KMS key from which you are removing tags.
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.
SdkInternalList<T> tagKeys
One or more tag keys. Specify only the tag keys, not the tag values.
String aliasName
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.
String targetKeyId
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 or both HMAC) 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.
String customKeyStoreId
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.
String newCustomKeyStoreName
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 Amazon Web Services account.
To change this value, an CloudHSM key store must be disconnected. An external key store can be connected or disconnected.
String keyStorePassword
Enter the current password of the kmsuser crypto user (CU) in the CloudHSM cluster that is
associated with the custom key store. This parameter is valid only for custom key stores with a
CustomKeyStoreType of AWS_CLOUDHSM.
This parameter tells KMS the current password of the kmsuser crypto user (CU). It does not set or
change the password of any users in the CloudHSM cluster.
To change this value, the CloudHSM key store must be disconnected.
String cloudHsmClusterId
Associates the custom key store with a related CloudHSM cluster. This parameter is valid only for custom key
stores with a CustomKeyStoreType of AWS_CLOUDHSM.
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.
To change this value, the CloudHSM key store must be disconnected.
String xksProxyUriEndpoint
Changes the URI endpoint that KMS uses to connect to your external key store proxy (XKS proxy). This parameter is
valid only for custom key stores with a CustomKeyStoreType of EXTERNAL_KEY_STORE.
For external key stores with an XksProxyConnectivity value of PUBLIC_ENDPOINT, the
protocol must be HTTPS.
For external key stores with an XksProxyConnectivity value of VPC_ENDPOINT_SERVICE,
specify https:// followed by the private DNS name associated with the VPC endpoint service. Each
external key store must use a different private DNS name.
The combined XksProxyUriEndpoint and XksProxyUriPath values must be unique in the
Amazon Web Services account and Region.
To change this value, the external key store must be disconnected.
String xksProxyUriPath
Changes the base path to the proxy APIs for this external key store. To find this value, see the documentation
for your external key manager and external key store proxy (XKS proxy). This parameter is valid only for custom
key stores with a CustomKeyStoreType of EXTERNAL_KEY_STORE.
The value must start with / and must end with /kms/xks/v1, where v1
represents the version of the KMS external key store proxy API. You can include an optional prefix between the
required elements such as /example/kms/xks/v1.
The combined XksProxyUriEndpoint and XksProxyUriPath values must be unique in the
Amazon Web Services account and Region.
You can change this value when the external key store is connected or disconnected.
String xksProxyVpcEndpointServiceName
Changes the name that KMS uses to identify the Amazon VPC endpoint service for your external key store proxy (XKS
proxy). This parameter is valid when the CustomKeyStoreType is EXTERNAL_KEY_STORE and
the XksProxyConnectivity is VPC_ENDPOINT_SERVICE.
To change this value, the external key store must be disconnected.
XksProxyAuthenticationCredentialType xksProxyAuthenticationCredential
Changes the credentials that KMS uses to sign requests to the external key store proxy (XKS proxy). This
parameter is valid only for custom key stores with a CustomKeyStoreType of
EXTERNAL_KEY_STORE.
You must specify both the AccessKeyId and SecretAccessKey value in the authentication
credential, even if you are only updating one value.
This parameter doesn't establish or change your authentication credentials on the proxy. It just tells KMS the credential that you established with your external key store proxy. For example, if you rotate the credential on your external key store proxy, you can use this parameter to update the credential in KMS.
You can change this value when the external key store is connected or disconnected.
String xksProxyConnectivity
Changes the connectivity setting for the external key store. To indicate that the external key store proxy uses a
Amazon VPC endpoint service to communicate with KMS, specify VPC_ENDPOINT_SERVICE. Otherwise,
specify PUBLIC_ENDPOINT.
If you change the XksProxyConnectivity to VPC_ENDPOINT_SERVICE, you must also change
the XksProxyUriEndpoint and add an XksProxyVpcEndpointServiceName value.
If you change the XksProxyConnectivity to PUBLIC_ENDPOINT, you must also change the
XksProxyUriEndpoint and specify a null or empty string for the
XksProxyVpcEndpointServiceName value.
To change this value, the external key store must be disconnected.
String keyId
Updates the description of 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.
String description
New description for the KMS key.
String keyId
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.
String primaryRegion
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.
ByteBuffer message
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.
String keyId
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.
String macAlgorithm
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.
ByteBuffer mac
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.
SdkInternalList<T> grantTokens
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.
String keyId
The HMAC KMS key used in the verification.
Boolean macValid
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.
String macAlgorithm
The MAC algorithm used in the verification.
String keyId
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.
ByteBuffer message
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.
String messageType
Tells KMS whether the value of the Message parameter should be hashed as part of the signing
algorithm. Use RAW for unhashed messages; use DIGEST for message digests, which are
already hashed.
When the value of MessageType is RAW, KMS uses the standard signing algorithm, which
begins with a hash function. When the value is DIGEST, KMS skips the hashing step in the signing
algorithm.
Use the DIGEST value only when the value of the Message parameter is a message digest.
If you use the DIGEST value with an unhashed message, the security of the verification operation can
be compromised.
When the value of MessageTypeis DIGEST, the length of the Message value
must match the length of hashed messages for the specified signing algorithm.
You can submit a message digest and omit the MessageType or specify RAW so the digest
is hashed again while signing. However, if the signed message is hashed once while signing, but twice while
verifying, verification fails, even when the message hasn't changed.
The hashing algorithm in that Verify uses is based on the SigningAlgorithm value.
Signing algorithms that end in SHA_256 use the SHA_256 hashing algorithm.
Signing algorithms that end in SHA_384 use the SHA_384 hashing algorithm.
Signing algorithms that end in SHA_512 use the SHA_512 hashing algorithm.
SM2DSA uses the SM3 hashing algorithm. For details, see Offline verification with SM2 key pairs.
ByteBuffer signature
The signature that the Sign operation generated.
String signingAlgorithm
The signing algorithm that was used to sign the message. If you submit a different algorithm, the signature verification fails.
SdkInternalList<T> grantTokens
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.
String keyId
The Amazon Resource Name (key ARN) of the asymmetric KMS key that was used to verify the signature.
Boolean signatureValid
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.
String signingAlgorithm
The signing algorithm that was used to verify the signature.
String id
The ID of the external key in its external key manager. This is the ID that the external key store proxy uses to identify the external key.
String connectivity
Indicates whether the external key store proxy uses a public endpoint or an Amazon VPC endpoint service to communicate with KMS.
String accessKeyId
The part of the external key store proxy authentication credential that uniquely identifies the secret access key.
String uriEndpoint
The URI endpoint for the external key store proxy.
If the external key store proxy has a public endpoint, it is displayed here.
If the external key store proxy uses an Amazon VPC endpoint service name, this field displays the private DNS name associated with the VPC endpoint service.
String uriPath
The path to the external key store proxy APIs.
String vpcEndpointServiceName
The Amazon VPC endpoint service used to communicate with the external key store proxy. This field appears only when the external key store proxy uses an Amazon VPC endpoint service to communicate with KMS.
Copyright © 2023. All rights reserved.