class Aws::KMS::Types::DeriveSharedSecretRequest

@see docs.aws.amazon.com/goto/WebAPI/kms-2014-11-01/DeriveSharedSecretRequest AWS API Documentation
@return [Types::RecipientInfo] : docs.aws.amazon.com/kms/latest/developerguide/services-nitro-enclaves.html [2]: docs.aws.amazon.com/enclaves/latest/user/developing-applications.html#sdk [1]: docs.aws.amazon.com/AWSEC2/latest/UserGuide/nitro-enclave-how.html#term-attestdoc uses KMS] in the *Key Management Service Developer Guide*.
Services Nitro Enclaves, see [How Amazon Web Services Nitro Enclaves
For information about the interaction between KMS and Amazon Web
empty.
parameter. The ‘SharedSecret` field in the response is null or
the `KeyId` parameter and public key specified by the `PublicKey`
the encrypted shared secret derived from the KMS key specified by
in the enclave. The `CiphertextBlob` field in the response contains
response. This ciphertext can be decrypted only with the private key
resulting ciphertext in the `CiphertextForRecipient` field in the
the public key in the attestation document, and returns the
of the shared secret, KMS encrypts the plaintext shared secret under
When you use this parameter, instead of returning a plaintext copy
the attestation document for the enclave.
the Recipient parameter from any Amazon Web Services SDK to provide
Enclaves SDK] to generate the attestation document and then use
Web Services Nitro Enclaves, use the [Amazon Web Services Nitro
Services Nitro Enclaves. To call DeriveSharedSecret for an Amazon
This parameter only supports attestation documents for Amazon Web
`RSAES_OAEP_SHA_256`.
public key. The only valid encryption algorithm is
enclave and the encryption algorithm to use with the enclave’s
A signed [attestation document] from an Amazon Web Services Nitro
@!attribute [rw] recipient
@return [Boolean] : docs.aws.amazon.com/kms/latest/developerguide/testing-permissions.html permissions][1] in the *Key Management Service Developer Guide*.
To learn more about how to use this parameter, see [Testing your
parameter.
Checks if your request will succeed. ‘DryRun` is an optional
@!attribute [rw] dry_run
@return [Array<String>] : docs.aws.amazon.com/kms/latest/developerguide/using-grant-token.html [1]: docs.aws.amazon.com/kms/latest/developerguide/grants.html#grant_token token][2] in the *Key Management Service Developer Guide*.
For more information, see [Grant token] and [Using a grant
from a new grant that has not yet achieved *eventual consistency*.
Use a grant token when your permission to call this operation comes
A list of grant tokens.
@!attribute [rw] grant_tokens
@return [String] : docs.aws.amazon.com/cli/v1/userguide/cli-chap-welcome.html [1]: tools.ietf.org/html/rfc5280 (`fileb://<path-to-file>`) or in-line using a Base64 encoded string.
You can specify the public key as binary data in a file using fileb
</note>
resulting in a `ValidationException`.
Web Services CLI Base64-encodes the public key a second time,
the DER-encoded X.509 public key in a file. Otherwise, the Amazon
<note markdown=“1”> If you use [Amazon Web Services CLI version 1], you must provide
the required DER-encoded format.
GetPublicKey returns the public key of an asymmetric KMS key pair in
`SubjectPublicKeyInfo` (SPKI), as defined in [RFC 5280].
The public key must be a DER-encoded X.509 public key, also known as
curve (ECC) or SM2 (China Regions only) key pair.
Specifies the public key in your peer’s NIST-recommended elliptic
@!attribute [rw] public_key
@return [String]
secret. The only valid value is ‘ECDH`.
Specifies the key agreement algorithm used to derive the shared
@!attribute [rw] key_agreement_algorithm
@return [String]
DescribeKey. To get the alias name and alias ARN, use ListAliases.
To get the key ID and key ARN for a KMS key, use ListKeys or
* Alias ARN: `arn:aws:kms:us-east-2:111122223333:alias/ExampleAlias`
* Alias name: `alias/ExampleAlias`
`arn:aws:kms:us-east-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab`
* Key ARN:
* Key ID: `1234abcd-12ab-34cd-56ef-1234567890ab`
For example:
the key ARN or alias ARN.
a KMS key in a different Amazon Web Services account, you must use
ARN. When using an alias name, prefix it with `“alias/”`. To specify
To specify a KMS key, use its key ID, key ARN, alias name, or alias
DescribeKey operation.
`KEY_AGREEMENT`. To find the `KeyUsage` of a KMS key, use the
derive the shared secret. The key usage of the KMS key must be
only) KMS key. KMS uses the private key in the specified key pair to
Identifies an asymmetric NIST-recommended ECC or SM2 (China Regions
@!attribute [rw] key_id

class Aws::KMS::Types::DeriveSharedSecretRequest

Namespace

Included Modules

Defined in