import { NodeHttpOptions as __HttpOptions__ } from '@aws-sdk/types'; import * as __aws_sdk_types from '@aws-sdk/types'; /** * EncryptInput shape */ export interface EncryptInput { /** *

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

To specify a CMK, use its key ID, Amazon Resource Name (ARN), alias name, or alias ARN. When using an alias name, prefix it with "alias/". To specify a CMK in a different AWS account, you must use the key ARN or alias ARN.

For example:

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

*/ KeyId: string; /** *

Data to be encrypted.

*/ Plaintext: ArrayBuffer | ArrayBufferView | string; /** *

Name-value pair that specifies the encryption context to be used for authenticated encryption. If used here, the same value must be supplied to the Decrypt API or decryption will fail. For more information, see Encryption Context.

*/ EncryptionContext?: { [key: string]: string; } | Iterable<[string, string]>; /** *

A list of grant tokens.

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

*/ GrantTokens?: Array | Iterable; /** * The maximum number of times this operation should be retried. If set, this value will override the `maxRetries` configuration set on the client for this command. */ $maxRetries?: number; /** * An object that may be queried to determine if the underlying operation has been aborted. * * @see https://developer.mozilla.org/en-US/docs/Web/API/AbortSignal */ $abortSignal?: __aws_sdk_types.AbortSignal; /** * Per-request HTTP configuration options. If set, any options specified will override the corresponding HTTP option set on the client for this command. */ $httpOptions?: __HttpOptions__; }