Skip to content

Commit d6fd1a4

Browse files
author
awstools
committed
feat(client-payment-cryptography): Adding support to TR-31/TR-34 exports for optional headers, allowing customers to add additional metadata (such as key version and KSN) when exporting keys from the service.
1 parent a2fde81 commit d6fd1a4

22 files changed

+321
-98
lines changed

clients/client-payment-cryptography/src/commands/CreateAliasCommand.ts

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -33,7 +33,7 @@ export interface CreateAliasCommandOutput extends CreateAliasOutput, __MetadataB
3333
/**
3434
* <p>Creates an <i>alias</i>, or a friendly name, for an Amazon Web Services Payment Cryptography key. You can use an alias to identify a key in the console and when you call cryptographic operations such as <a href="https://docs.aws.amazon.com/payment-cryptography/latest/DataAPIReference/API_EncryptData.html">EncryptData</a> or <a href="https://docs.aws.amazon.com/payment-cryptography/latest/DataAPIReference/API_DecryptData.html">DecryptData</a>.</p>
3535
* <p>You can associate the alias with any key in the same Amazon Web Services Region. Each alias is associated with only one key at a time, but a key can have multiple aliases. You can't create an alias without a key. The alias must be unique in the account and Amazon Web Services Region, but you can create another alias with the same name in a different Amazon Web Services Region.</p>
36-
* <p>To change the key that's associated with the alias, call <a>UpdateAlias</a>. To delete the alias, call <a>DeleteAlias</a>. These operations don't affect the underlying key. To get the alias that you created, call <a>ListAliases</a>.</p>
36+
* <p>To change the key that's associated with the alias, call <a href="https://docs.aws.amazon.com/payment-cryptography/latest/APIReference/API_UpdateAlias.html">UpdateAlias</a>. To delete the alias, call <a href="https://docs.aws.amazon.com/payment-cryptography/latest/APIReference/API_DeleteAlias.html">DeleteAlias</a>. These operations don't affect the underlying key. To get the alias that you created, call <a href="https://docs.aws.amazon.com/payment-cryptography/latest/APIReference/API_ListAliases.html">ListAliases</a>.</p>
3737
* <p>
3838
* <b>Cross-account use</b>: This operation can't be used across different Amazon Web Services accounts.</p>
3939
* <p>
@@ -42,22 +42,22 @@ export interface CreateAliasCommandOutput extends CreateAliasOutput, __MetadataB
4242
* <ul>
4343
* <li>
4444
* <p>
45-
* <a>DeleteAlias</a>
45+
* <a href="https://docs.aws.amazon.com/payment-cryptography/latest/APIReference/API_DeleteAlias.html">DeleteAlias</a>
4646
* </p>
4747
* </li>
4848
* <li>
4949
* <p>
50-
* <a>GetAlias</a>
50+
* <a href="https://docs.aws.amazon.com/payment-cryptography/latest/APIReference/API_GetAlias.html">GetAlias</a>
5151
* </p>
5252
* </li>
5353
* <li>
5454
* <p>
55-
* <a>ListAliases</a>
55+
* <a href="https://docs.aws.amazon.com/payment-cryptography/latest/APIReference/API_ListAliases.html">ListAliases</a>
5656
* </p>
5757
* </li>
5858
* <li>
5959
* <p>
60-
* <a>UpdateAlias</a>
60+
* <a href="https://docs.aws.amazon.com/payment-cryptography/latest/APIReference/API_UpdateAlias.html">UpdateAlias</a>
6161
* </p>
6262
* </li>
6363
* </ul>

clients/client-payment-cryptography/src/commands/CreateKeyCommand.ts

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -43,17 +43,17 @@ export interface CreateKeyCommandOutput extends CreateKeyOutput, __MetadataBeare
4343
* <ul>
4444
* <li>
4545
* <p>
46-
* <a>DeleteKey</a>
46+
* <a href="https://docs.aws.amazon.com/payment-cryptography/latest/APIReference/API_DeleteKey.html">DeleteKey</a>
4747
* </p>
4848
* </li>
4949
* <li>
5050
* <p>
51-
* <a>GetKey</a>
51+
* <a href="https://docs.aws.amazon.com/payment-cryptography/latest/APIReference/API_GetKey.html">GetKey</a>
5252
* </p>
5353
* </li>
5454
* <li>
5555
* <p>
56-
* <a>ListKeys</a>
56+
* <a href="https://docs.aws.amazon.com/payment-cryptography/latest/APIReference/API_ListKeys.html">ListKeys</a>
5757
* </p>
5858
* </li>
5959
* </ul>

clients/client-payment-cryptography/src/commands/DeleteAliasCommand.ts

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -32,7 +32,7 @@ export interface DeleteAliasCommandOutput extends DeleteAliasOutput, __MetadataB
3232

3333
/**
3434
* <p>Deletes the alias, but doesn't affect the underlying key.</p>
35-
* <p>Each key can have multiple aliases. To get the aliases of all keys, use the <a>ListAliases</a> operation. To change the alias of a key, first use <a>DeleteAlias</a> to delete the current alias and then use <a>CreateAlias</a> to create a new alias. To associate an existing alias with a different key, call <a>UpdateAlias</a>.</p>
35+
* <p>Each key can have multiple aliases. To get the aliases of all keys, use the <a href="https://docs.aws.amazon.com/payment-cryptography/latest/APIReference/API_UpdateAlias.html">UpdateAlias</a> operation. To change the alias of a key, first use <a href="https://docs.aws.amazon.com/payment-cryptography/latest/APIReference/API_DeleteAlias.html">DeleteAlias</a> to delete the current alias and then use <a href="https://docs.aws.amazon.com/payment-cryptography/latest/APIReference/API_CreateAlias.html">CreateAlias</a> to create a new alias. To associate an existing alias with a different key, call <a href="https://docs.aws.amazon.com/payment-cryptography/latest/APIReference/API_UpdateAlias.html">UpdateAlias</a>.</p>
3636
* <p>
3737
* <b>Cross-account use:</b> This operation can't be used across different Amazon Web Services accounts.</p>
3838
* <p>
@@ -41,22 +41,22 @@ export interface DeleteAliasCommandOutput extends DeleteAliasOutput, __MetadataB
4141
* <ul>
4242
* <li>
4343
* <p>
44-
* <a>CreateAlias</a>
44+
* <a href="https://docs.aws.amazon.com/payment-cryptography/latest/APIReference/API_CreateAlias.html">CreateAlias</a>
4545
* </p>
4646
* </li>
4747
* <li>
4848
* <p>
49-
* <a>GetAlias</a>
49+
* <a href="https://docs.aws.amazon.com/payment-cryptography/latest/APIReference/API_GetAlias.html">GetAlias</a>
5050
* </p>
5151
* </li>
5252
* <li>
5353
* <p>
54-
* <a>ListAliases</a>
54+
* <a href="https://docs.aws.amazon.com/payment-cryptography/latest/APIReference/API_ListAliases.html">ListAliases</a>
5555
* </p>
5656
* </li>
5757
* <li>
5858
* <p>
59-
* <a>UpdateAlias</a>
59+
* <a href="https://docs.aws.amazon.com/payment-cryptography/latest/APIReference/API_UpdateAlias.html">UpdateAlias</a>
6060
* </p>
6161
* </li>
6262
* </ul>

clients/client-payment-cryptography/src/commands/DeleteKeyCommand.ts

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -33,7 +33,7 @@ export interface DeleteKeyCommandOutput extends DeleteKeyOutput, __MetadataBeare
3333
/**
3434
* <p>Deletes the key material and metadata associated with Amazon Web Services Payment Cryptography key.</p>
3535
* <p>Key deletion is irreversible. After a key is deleted, you can't perform cryptographic operations using the key. For example, you can't decrypt data that was encrypted by a deleted Amazon Web Services Payment Cryptography key, and the data may become unrecoverable. Because key deletion is destructive, Amazon Web Services Payment Cryptography has a safety mechanism to prevent accidental deletion of a key. When you call this operation, Amazon Web Services Payment Cryptography disables the specified key but doesn't delete it until after a waiting period set using <code>DeleteKeyInDays</code>. The default waiting period is 7 days. During the waiting period, the <code>KeyState</code> is <code>DELETE_PENDING</code>. After the key is deleted, the <code>KeyState</code> is <code>DELETE_COMPLETE</code>.</p>
36-
* <p>You should delete a key only when you are sure that you don't need to use it anymore and no other parties are utilizing this key. If you aren't sure, consider deactivating it instead by calling <a>StopKeyUsage</a>.</p>
36+
* <p>You should delete a key only when you are sure that you don't need to use it anymore and no other parties are utilizing this key. If you aren't sure, consider deactivating it instead by calling <a href="https://docs.aws.amazon.com/payment-cryptography/latest/APIReference/API_StopKeyUsage.html">StopKeyUsage</a>.</p>
3737
* <p>
3838
* <b>Cross-account use:</b> This operation can't be used across different Amazon Web Services accounts.</p>
3939
* <p>
@@ -42,17 +42,17 @@ export interface DeleteKeyCommandOutput extends DeleteKeyOutput, __MetadataBeare
4242
* <ul>
4343
* <li>
4444
* <p>
45-
* <a>RestoreKey</a>
45+
* <a href="https://docs.aws.amazon.com/payment-cryptography/latest/APIReference/API_RestoreKey.html">RestoreKey</a>
4646
* </p>
4747
* </li>
4848
* <li>
4949
* <p>
50-
* <a>StartKeyUsage</a>
50+
* <a href="https://docs.aws.amazon.com/payment-cryptography/latest/APIReference/API_StartKeyUsage.html">StartKeyUsage</a>
5151
* </p>
5252
* </li>
5353
* <li>
5454
* <p>
55-
* <a>StopKeyUsage</a>
55+
* <a href="https://docs.aws.amazon.com/payment-cryptography/latest/APIReference/API_StopKeyUsage.html">StopKeyUsage</a>
5656
* </p>
5757
* </li>
5858
* </ul>

0 commit comments

Comments
 (0)