@aws-sdk/client-payment-cryptography 3.883.0 → 3.886.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +40 -0
- package/dist-cjs/index.js +336 -169
- package/dist-es/PaymentCryptography.js +10 -0
- package/dist-es/commands/AddKeyReplicationRegionsCommand.js +22 -0
- package/dist-es/commands/DisableDefaultKeyReplicationRegionsCommand.js +22 -0
- package/dist-es/commands/EnableDefaultKeyReplicationRegionsCommand.js +22 -0
- package/dist-es/commands/GetDefaultKeyReplicationRegionsCommand.js +22 -0
- package/dist-es/commands/GetParametersForExportCommand.js +1 -2
- package/dist-es/commands/GetParametersForImportCommand.js +1 -2
- package/dist-es/commands/GetPublicKeyCertificateCommand.js +1 -2
- package/dist-es/commands/RemoveKeyReplicationRegionsCommand.js +22 -0
- package/dist-es/commands/index.js +5 -0
- package/dist-es/models/models_0.js +112 -134
- package/dist-es/protocols/Aws_json1_0.js +112 -3
- package/dist-types/PaymentCryptography.d.ts +36 -0
- package/dist-types/PaymentCryptographyClient.d.ts +7 -2
- package/dist-types/commands/AddKeyReplicationRegionsCommand.d.ts +135 -0
- package/dist-types/commands/CreateAliasCommand.d.ts +8 -8
- package/dist-types/commands/CreateKeyCommand.d.ts +20 -8
- package/dist-types/commands/DeleteAliasCommand.d.ts +7 -7
- package/dist-types/commands/DeleteKeyCommand.d.ts +16 -7
- package/dist-types/commands/DisableDefaultKeyReplicationRegionsCommand.d.ts +97 -0
- package/dist-types/commands/EnableDefaultKeyReplicationRegionsCommand.d.ts +97 -0
- package/dist-types/commands/ExportKeyCommand.d.ts +7 -7
- package/dist-types/commands/GetAliasCommand.d.ts +6 -6
- package/dist-types/commands/GetDefaultKeyReplicationRegionsCommand.d.ts +93 -0
- package/dist-types/commands/GetKeyCommand.d.ts +16 -7
- package/dist-types/commands/GetParametersForExportCommand.d.ts +8 -8
- package/dist-types/commands/GetParametersForImportCommand.d.ts +8 -8
- package/dist-types/commands/GetPublicKeyCertificateCommand.d.ts +6 -6
- package/dist-types/commands/ImportKeyCommand.d.ts +20 -8
- package/dist-types/commands/ListAliasesCommand.d.ts +6 -6
- package/dist-types/commands/ListKeysCommand.d.ts +8 -6
- package/dist-types/commands/ListTagsForResourceCommand.d.ts +6 -6
- package/dist-types/commands/RemoveKeyReplicationRegionsCommand.d.ts +135 -0
- package/dist-types/commands/RestoreKeyCommand.d.ts +17 -8
- package/dist-types/commands/StartKeyUsageCommand.d.ts +17 -8
- package/dist-types/commands/StopKeyUsageCommand.d.ts +17 -8
- package/dist-types/commands/TagResourceCommand.d.ts +8 -8
- package/dist-types/commands/UntagResourceCommand.d.ts +7 -7
- package/dist-types/commands/UpdateAliasCommand.d.ts +7 -7
- package/dist-types/commands/index.d.ts +5 -0
- package/dist-types/models/models_0.d.ts +538 -364
- package/dist-types/protocols/Aws_json1_0.d.ts +45 -0
- package/dist-types/ts3.4/PaymentCryptography.d.ts +98 -0
- package/dist-types/ts3.4/PaymentCryptographyClient.d.ts +30 -0
- package/dist-types/ts3.4/commands/AddKeyReplicationRegionsCommand.d.ts +51 -0
- package/dist-types/ts3.4/commands/DisableDefaultKeyReplicationRegionsCommand.d.ts +51 -0
- package/dist-types/ts3.4/commands/EnableDefaultKeyReplicationRegionsCommand.d.ts +51 -0
- package/dist-types/ts3.4/commands/GetDefaultKeyReplicationRegionsCommand.d.ts +51 -0
- package/dist-types/ts3.4/commands/RemoveKeyReplicationRegionsCommand.d.ts +51 -0
- package/dist-types/ts3.4/commands/index.d.ts +5 -0
- package/dist-types/ts3.4/models/models_0.d.ts +159 -120
- package/dist-types/ts3.4/protocols/Aws_json1_0.d.ts +60 -0
- package/package.json +3 -3
|
@@ -1,7 +1,7 @@
|
|
|
1
1
|
import { ExceptionOptionType as __ExceptionOptionType } from "@smithy/smithy-client";
|
|
2
2
|
import { PaymentCryptographyServiceException as __BaseException } from "./PaymentCryptographyServiceException";
|
|
3
3
|
/**
|
|
4
|
-
* <p>You do not have sufficient access to perform this action.</p>
|
|
4
|
+
* <p>You do not have sufficient access to perform this action.</p> <p>This exception is thrown when the caller lacks the necessary IAM permissions to perform the requested operation. Verify that your IAM policy includes the required permissions for the specific Amazon Web Services Payment Cryptography action you're attempting.</p>
|
|
5
5
|
* @public
|
|
6
6
|
*/
|
|
7
7
|
export declare class AccessDeniedException extends __BaseException {
|
|
@@ -14,235 +14,20 @@ export declare class AccessDeniedException extends __BaseException {
|
|
|
14
14
|
constructor(opts: __ExceptionOptionType<AccessDeniedException, __BaseException>);
|
|
15
15
|
}
|
|
16
16
|
/**
|
|
17
|
-
* <p>
|
|
18
|
-
* @public
|
|
19
|
-
*/
|
|
20
|
-
export interface Alias {
|
|
21
|
-
/**
|
|
22
|
-
* <p>A friendly name that you can use to refer to a key. The value must begin with <code>alias/</code>.</p> <important> <p>Do not include confidential or sensitive information in this field. This field may be displayed in plaintext in CloudTrail logs and other output.</p> </important>
|
|
23
|
-
* @public
|
|
24
|
-
*/
|
|
25
|
-
AliasName: string | undefined;
|
|
26
|
-
/**
|
|
27
|
-
* <p>The <code>KeyARN</code> of the key associated with the alias.</p>
|
|
28
|
-
* @public
|
|
29
|
-
*/
|
|
30
|
-
KeyArn?: string | undefined;
|
|
31
|
-
}
|
|
32
|
-
/**
|
|
33
|
-
* <p>This request can cause an inconsistent state for the resource.</p>
|
|
34
|
-
* @public
|
|
35
|
-
*/
|
|
36
|
-
export declare class ConflictException extends __BaseException {
|
|
37
|
-
readonly name: "ConflictException";
|
|
38
|
-
readonly $fault: "client";
|
|
39
|
-
Message?: string | undefined;
|
|
40
|
-
/**
|
|
41
|
-
* @internal
|
|
42
|
-
*/
|
|
43
|
-
constructor(opts: __ExceptionOptionType<ConflictException, __BaseException>);
|
|
44
|
-
}
|
|
45
|
-
/**
|
|
46
|
-
* @public
|
|
47
|
-
*/
|
|
48
|
-
export interface CreateAliasInput {
|
|
49
|
-
/**
|
|
50
|
-
* <p>A friendly name that you can use to refer to a key. An alias must begin with <code>alias/</code> followed by a name, for example <code>alias/ExampleAlias</code>. It can contain only alphanumeric characters, forward slashes (/), underscores (_), and dashes (-).</p> <important> <p>Don't include personal, confidential or sensitive information in this field. This field may be displayed in plaintext in CloudTrail logs and other output.</p> </important>
|
|
51
|
-
* @public
|
|
52
|
-
*/
|
|
53
|
-
AliasName: string | undefined;
|
|
54
|
-
/**
|
|
55
|
-
* <p>The <code>KeyARN</code> of the key to associate with the alias.</p>
|
|
56
|
-
* @public
|
|
57
|
-
*/
|
|
58
|
-
KeyArn?: string | undefined;
|
|
59
|
-
}
|
|
60
|
-
/**
|
|
61
|
-
* @public
|
|
62
|
-
*/
|
|
63
|
-
export interface CreateAliasOutput {
|
|
64
|
-
/**
|
|
65
|
-
* <p>The alias for the key.</p>
|
|
66
|
-
* @public
|
|
67
|
-
*/
|
|
68
|
-
Alias: Alias | undefined;
|
|
69
|
-
}
|
|
70
|
-
/**
|
|
71
|
-
* <p>The request processing has failed because of an unknown error, exception, or failure.</p>
|
|
72
|
-
* @public
|
|
73
|
-
*/
|
|
74
|
-
export declare class InternalServerException extends __BaseException {
|
|
75
|
-
readonly name: "InternalServerException";
|
|
76
|
-
readonly $fault: "server";
|
|
77
|
-
Message?: string | undefined;
|
|
78
|
-
/**
|
|
79
|
-
* @internal
|
|
80
|
-
*/
|
|
81
|
-
constructor(opts: __ExceptionOptionType<InternalServerException, __BaseException>);
|
|
82
|
-
}
|
|
83
|
-
/**
|
|
84
|
-
* <p>The request was denied due to an invalid resource error.</p>
|
|
85
|
-
* @public
|
|
86
|
-
*/
|
|
87
|
-
export declare class ResourceNotFoundException extends __BaseException {
|
|
88
|
-
readonly name: "ResourceNotFoundException";
|
|
89
|
-
readonly $fault: "client";
|
|
90
|
-
/**
|
|
91
|
-
* <p>The string for the exception.</p>
|
|
92
|
-
* @public
|
|
93
|
-
*/
|
|
94
|
-
ResourceId?: string | undefined;
|
|
95
|
-
/**
|
|
96
|
-
* @internal
|
|
97
|
-
*/
|
|
98
|
-
constructor(opts: __ExceptionOptionType<ResourceNotFoundException, __BaseException>);
|
|
99
|
-
}
|
|
100
|
-
/**
|
|
101
|
-
* <p>This request would cause a service quota to be exceeded.</p>
|
|
102
|
-
* @public
|
|
103
|
-
*/
|
|
104
|
-
export declare class ServiceQuotaExceededException extends __BaseException {
|
|
105
|
-
readonly name: "ServiceQuotaExceededException";
|
|
106
|
-
readonly $fault: "client";
|
|
107
|
-
Message?: string | undefined;
|
|
108
|
-
/**
|
|
109
|
-
* @internal
|
|
110
|
-
*/
|
|
111
|
-
constructor(opts: __ExceptionOptionType<ServiceQuotaExceededException, __BaseException>);
|
|
112
|
-
}
|
|
113
|
-
/**
|
|
114
|
-
* <p>The service cannot complete the request.</p>
|
|
115
|
-
* @public
|
|
116
|
-
*/
|
|
117
|
-
export declare class ServiceUnavailableException extends __BaseException {
|
|
118
|
-
readonly name: "ServiceUnavailableException";
|
|
119
|
-
readonly $fault: "server";
|
|
120
|
-
Message?: string | undefined;
|
|
121
|
-
/**
|
|
122
|
-
* @internal
|
|
123
|
-
*/
|
|
124
|
-
constructor(opts: __ExceptionOptionType<ServiceUnavailableException, __BaseException>);
|
|
125
|
-
}
|
|
126
|
-
/**
|
|
127
|
-
* <p>The request was denied due to request throttling.</p>
|
|
128
|
-
* @public
|
|
129
|
-
*/
|
|
130
|
-
export declare class ThrottlingException extends __BaseException {
|
|
131
|
-
readonly name: "ThrottlingException";
|
|
132
|
-
readonly $fault: "client";
|
|
133
|
-
Message?: string | undefined;
|
|
134
|
-
/**
|
|
135
|
-
* @internal
|
|
136
|
-
*/
|
|
137
|
-
constructor(opts: __ExceptionOptionType<ThrottlingException, __BaseException>);
|
|
138
|
-
}
|
|
139
|
-
/**
|
|
140
|
-
* <p>The request was denied due to an invalid request error.</p>
|
|
141
|
-
* @public
|
|
142
|
-
*/
|
|
143
|
-
export declare class ValidationException extends __BaseException {
|
|
144
|
-
readonly name: "ValidationException";
|
|
145
|
-
readonly $fault: "client";
|
|
146
|
-
Message?: string | undefined;
|
|
147
|
-
/**
|
|
148
|
-
* @internal
|
|
149
|
-
*/
|
|
150
|
-
constructor(opts: __ExceptionOptionType<ValidationException, __BaseException>);
|
|
151
|
-
}
|
|
152
|
-
/**
|
|
17
|
+
* <p>Input parameters for adding replication regions to a specific key.</p>
|
|
153
18
|
* @public
|
|
154
19
|
*/
|
|
155
|
-
export interface
|
|
156
|
-
/**
|
|
157
|
-
* <p>A friendly name that you can use to refer Amazon Web Services Payment Cryptography key. This value must begin with <code>alias/</code> followed by a name, such as <code>alias/ExampleAlias</code>.</p>
|
|
158
|
-
* @public
|
|
159
|
-
*/
|
|
160
|
-
AliasName: string | undefined;
|
|
161
|
-
}
|
|
162
|
-
/**
|
|
163
|
-
* @public
|
|
164
|
-
*/
|
|
165
|
-
export interface DeleteAliasOutput {
|
|
166
|
-
}
|
|
167
|
-
/**
|
|
168
|
-
* @public
|
|
169
|
-
*/
|
|
170
|
-
export interface GetAliasInput {
|
|
171
|
-
/**
|
|
172
|
-
* <p>The alias of the Amazon Web Services Payment Cryptography key.</p>
|
|
173
|
-
* @public
|
|
174
|
-
*/
|
|
175
|
-
AliasName: string | undefined;
|
|
176
|
-
}
|
|
177
|
-
/**
|
|
178
|
-
* @public
|
|
179
|
-
*/
|
|
180
|
-
export interface GetAliasOutput {
|
|
181
|
-
/**
|
|
182
|
-
* <p>The alias of the Amazon Web Services Payment Cryptography key.</p>
|
|
183
|
-
* @public
|
|
184
|
-
*/
|
|
185
|
-
Alias: Alias | undefined;
|
|
186
|
-
}
|
|
187
|
-
/**
|
|
188
|
-
* @public
|
|
189
|
-
*/
|
|
190
|
-
export interface ListAliasesInput {
|
|
191
|
-
/**
|
|
192
|
-
* <p>The <code>keyARN</code> for which you want to list all aliases.</p>
|
|
193
|
-
* @public
|
|
194
|
-
*/
|
|
195
|
-
KeyArn?: string | undefined;
|
|
196
|
-
/**
|
|
197
|
-
* <p>Use this parameter in a subsequent request after you receive a response with truncated results. Set it to the value of <code>NextToken</code> from the truncated response you just received.</p>
|
|
198
|
-
* @public
|
|
199
|
-
*/
|
|
200
|
-
NextToken?: string | undefined;
|
|
201
|
-
/**
|
|
202
|
-
* <p>Use this parameter to specify the maximum number of items to return. When this value is present, Amazon Web Services Payment Cryptography does not return more than the specified number of items, but it might return fewer.</p> <p>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.</p>
|
|
203
|
-
* @public
|
|
204
|
-
*/
|
|
205
|
-
MaxResults?: number | undefined;
|
|
206
|
-
}
|
|
207
|
-
/**
|
|
208
|
-
* @public
|
|
209
|
-
*/
|
|
210
|
-
export interface ListAliasesOutput {
|
|
211
|
-
/**
|
|
212
|
-
* <p>The list of aliases. Each alias describes the <code>KeyArn</code> contained within.</p>
|
|
213
|
-
* @public
|
|
214
|
-
*/
|
|
215
|
-
Aliases: Alias[] | undefined;
|
|
216
|
-
/**
|
|
217
|
-
* <p>The token for the next set of results, or an empty or null value if there are no more results.</p>
|
|
218
|
-
* @public
|
|
219
|
-
*/
|
|
220
|
-
NextToken?: string | undefined;
|
|
221
|
-
}
|
|
222
|
-
/**
|
|
223
|
-
* @public
|
|
224
|
-
*/
|
|
225
|
-
export interface UpdateAliasInput {
|
|
226
|
-
/**
|
|
227
|
-
* <p>The alias whose associated key is changing.</p>
|
|
228
|
-
* @public
|
|
229
|
-
*/
|
|
230
|
-
AliasName: string | undefined;
|
|
20
|
+
export interface AddKeyReplicationRegionsInput {
|
|
231
21
|
/**
|
|
232
|
-
* <p>The
|
|
22
|
+
* <p>The key identifier (ARN or alias) of the key for which to add replication regions.</p> <p>This key must exist and be in a valid state for replication operations.</p>
|
|
233
23
|
* @public
|
|
234
24
|
*/
|
|
235
|
-
|
|
236
|
-
}
|
|
237
|
-
/**
|
|
238
|
-
* @public
|
|
239
|
-
*/
|
|
240
|
-
export interface UpdateAliasOutput {
|
|
25
|
+
KeyIdentifier: string | undefined;
|
|
241
26
|
/**
|
|
242
|
-
* <p>The
|
|
27
|
+
* <p>The list of Amazon Web Services Regions to add to the key's replication configuration.</p> <p>Each region must be a valid Amazon Web Services Region where Amazon Web Services Payment Cryptography is available. The key will be replicated to these regions, allowing cryptographic operations to be performed closer to your applications.</p>
|
|
243
28
|
* @public
|
|
244
29
|
*/
|
|
245
|
-
|
|
30
|
+
ReplicationRegions: string[] | undefined;
|
|
246
31
|
}
|
|
247
32
|
/**
|
|
248
33
|
* @public
|
|
@@ -395,46 +180,453 @@ export declare const KeyUsage: {
|
|
|
395
180
|
/**
|
|
396
181
|
* @public
|
|
397
182
|
*/
|
|
398
|
-
export type KeyUsage = (typeof KeyUsage)[keyof typeof KeyUsage];
|
|
183
|
+
export type KeyUsage = (typeof KeyUsage)[keyof typeof KeyUsage];
|
|
184
|
+
/**
|
|
185
|
+
* <p>The role of the key, the algorithm it supports, and the cryptographic operations allowed with the key. This data is immutable after the key is created.</p>
|
|
186
|
+
* @public
|
|
187
|
+
*/
|
|
188
|
+
export interface KeyAttributes {
|
|
189
|
+
/**
|
|
190
|
+
* <p>The cryptographic usage of an Amazon Web Services Payment Cryptography key as defined in section A.5.2 of the TR-31 spec.</p>
|
|
191
|
+
* @public
|
|
192
|
+
*/
|
|
193
|
+
KeyUsage: KeyUsage | undefined;
|
|
194
|
+
/**
|
|
195
|
+
* <p>The type of Amazon Web Services Payment Cryptography key to create, which determines the classification of the cryptographic method and whether Amazon Web Services Payment Cryptography key contains a symmetric key or an asymmetric key pair.</p>
|
|
196
|
+
* @public
|
|
197
|
+
*/
|
|
198
|
+
KeyClass: KeyClass | undefined;
|
|
199
|
+
/**
|
|
200
|
+
* <p>The key algorithm to be use during creation of an Amazon Web Services Payment Cryptography key.</p> <p>For symmetric keys, Amazon Web Services Payment Cryptography supports <code>AES</code> and <code>TDES</code> algorithms. For asymmetric keys, Amazon Web Services Payment Cryptography supports <code>RSA</code> and <code>ECC_NIST</code> algorithms.</p>
|
|
201
|
+
* @public
|
|
202
|
+
*/
|
|
203
|
+
KeyAlgorithm: KeyAlgorithm | undefined;
|
|
204
|
+
/**
|
|
205
|
+
* <p>The list of cryptographic operations that you can perform using the key.</p>
|
|
206
|
+
* @public
|
|
207
|
+
*/
|
|
208
|
+
KeyModesOfUse: KeyModesOfUse | undefined;
|
|
209
|
+
}
|
|
210
|
+
/**
|
|
211
|
+
* @public
|
|
212
|
+
* @enum
|
|
213
|
+
*/
|
|
214
|
+
export declare const KeyCheckValueAlgorithm: {
|
|
215
|
+
readonly ANSI_X9_24: "ANSI_X9_24";
|
|
216
|
+
readonly CMAC: "CMAC";
|
|
217
|
+
readonly HMAC: "HMAC";
|
|
218
|
+
readonly SHA_1: "SHA_1";
|
|
219
|
+
};
|
|
220
|
+
/**
|
|
221
|
+
* @public
|
|
222
|
+
*/
|
|
223
|
+
export type KeyCheckValueAlgorithm = (typeof KeyCheckValueAlgorithm)[keyof typeof KeyCheckValueAlgorithm];
|
|
224
|
+
/**
|
|
225
|
+
* @public
|
|
226
|
+
* @enum
|
|
227
|
+
*/
|
|
228
|
+
export declare const KeyOrigin: {
|
|
229
|
+
readonly AWS_PAYMENT_CRYPTOGRAPHY: "AWS_PAYMENT_CRYPTOGRAPHY";
|
|
230
|
+
readonly EXTERNAL: "EXTERNAL";
|
|
231
|
+
};
|
|
232
|
+
/**
|
|
233
|
+
* @public
|
|
234
|
+
*/
|
|
235
|
+
export type KeyOrigin = (typeof KeyOrigin)[keyof typeof KeyOrigin];
|
|
236
|
+
/**
|
|
237
|
+
* @public
|
|
238
|
+
* @enum
|
|
239
|
+
*/
|
|
240
|
+
export declare const KeyState: {
|
|
241
|
+
readonly CREATE_COMPLETE: "CREATE_COMPLETE";
|
|
242
|
+
readonly CREATE_IN_PROGRESS: "CREATE_IN_PROGRESS";
|
|
243
|
+
readonly DELETE_COMPLETE: "DELETE_COMPLETE";
|
|
244
|
+
readonly DELETE_PENDING: "DELETE_PENDING";
|
|
245
|
+
};
|
|
246
|
+
/**
|
|
247
|
+
* @public
|
|
248
|
+
*/
|
|
249
|
+
export type KeyState = (typeof KeyState)[keyof typeof KeyState];
|
|
250
|
+
/**
|
|
251
|
+
* @public
|
|
252
|
+
* @enum
|
|
253
|
+
*/
|
|
254
|
+
export declare const MultiRegionKeyType: {
|
|
255
|
+
readonly PRIMARY: "PRIMARY";
|
|
256
|
+
readonly REPLICA: "REPLICA";
|
|
257
|
+
};
|
|
258
|
+
/**
|
|
259
|
+
* @public
|
|
260
|
+
*/
|
|
261
|
+
export type MultiRegionKeyType = (typeof MultiRegionKeyType)[keyof typeof MultiRegionKeyType];
|
|
262
|
+
/**
|
|
263
|
+
* @public
|
|
264
|
+
* @enum
|
|
265
|
+
*/
|
|
266
|
+
export declare const KeyReplicationState: {
|
|
267
|
+
readonly DELETE_IN_PROGRESS: "DELETE_IN_PROGRESS";
|
|
268
|
+
readonly FAILED: "FAILED";
|
|
269
|
+
readonly IN_PROGRESS: "IN_PROGRESS";
|
|
270
|
+
readonly SYNCHRONIZED: "SYNCHRONIZED";
|
|
271
|
+
};
|
|
272
|
+
/**
|
|
273
|
+
* @public
|
|
274
|
+
*/
|
|
275
|
+
export type KeyReplicationState = (typeof KeyReplicationState)[keyof typeof KeyReplicationState];
|
|
276
|
+
/**
|
|
277
|
+
* <p>Represents the replication status information for a key in a replication region.</p> <p>This structure contains details about the current state of key replication, including any status messages and operational information about the replication process.</p>
|
|
278
|
+
* @public
|
|
279
|
+
*/
|
|
280
|
+
export interface ReplicationStatusType {
|
|
281
|
+
/**
|
|
282
|
+
* Defines the replication state of a key
|
|
283
|
+
* @public
|
|
284
|
+
*/
|
|
285
|
+
Status: KeyReplicationState | undefined;
|
|
286
|
+
/**
|
|
287
|
+
* <p>A message that provides additional information about the current replication status of the key.</p> <p>This field contains details about any issues or progress updates related to key replication operations. It may include information about replication failures, synchronization status, or other operational details.</p>
|
|
288
|
+
* @public
|
|
289
|
+
*/
|
|
290
|
+
StatusMessage?: string | undefined;
|
|
291
|
+
}
|
|
292
|
+
/**
|
|
293
|
+
* <p>Metadata about an Amazon Web Services Payment Cryptography key.</p>
|
|
294
|
+
* @public
|
|
295
|
+
*/
|
|
296
|
+
export interface Key {
|
|
297
|
+
/**
|
|
298
|
+
* <p>The Amazon Resource Name (ARN) of the key.</p>
|
|
299
|
+
* @public
|
|
300
|
+
*/
|
|
301
|
+
KeyArn: string | undefined;
|
|
302
|
+
/**
|
|
303
|
+
* <p>The role of the key, the algorithm it supports, and the cryptographic operations allowed with the key. This data is immutable after the key is created.</p>
|
|
304
|
+
* @public
|
|
305
|
+
*/
|
|
306
|
+
KeyAttributes: KeyAttributes | undefined;
|
|
307
|
+
/**
|
|
308
|
+
* <p>The key check value (KCV) is used to check if all parties holding a given key have the same key or to detect that a key has changed.</p>
|
|
309
|
+
* @public
|
|
310
|
+
*/
|
|
311
|
+
KeyCheckValue: string | undefined;
|
|
312
|
+
/**
|
|
313
|
+
* <p>The algorithm that Amazon Web Services Payment Cryptography uses to calculate the key check value (KCV). It is used to validate the key integrity.</p> <p>For TDES keys, the KCV is computed by encrypting 8 bytes, each with value of zero, with the key to be checked and retaining the 3 highest order bytes of the encrypted result. For AES keys, the KCV is computed using a CMAC algorithm where the input data is 16 bytes of zero and retaining the 3 highest order bytes of the encrypted result.</p>
|
|
314
|
+
* @public
|
|
315
|
+
*/
|
|
316
|
+
KeyCheckValueAlgorithm: KeyCheckValueAlgorithm | undefined;
|
|
317
|
+
/**
|
|
318
|
+
* <p>Specifies whether the key is enabled. </p>
|
|
319
|
+
* @public
|
|
320
|
+
*/
|
|
321
|
+
Enabled: boolean | undefined;
|
|
322
|
+
/**
|
|
323
|
+
* <p>Specifies whether the key is exportable. This data is immutable after the key is created.</p>
|
|
324
|
+
* @public
|
|
325
|
+
*/
|
|
326
|
+
Exportable: boolean | undefined;
|
|
327
|
+
/**
|
|
328
|
+
* <p>The state of key that is being created or deleted.</p>
|
|
329
|
+
* @public
|
|
330
|
+
*/
|
|
331
|
+
KeyState: KeyState | undefined;
|
|
332
|
+
/**
|
|
333
|
+
* <p>The source of the key material. For keys created within Amazon Web Services Payment Cryptography, the value is <code>AWS_PAYMENT_CRYPTOGRAPHY</code>. For keys imported into Amazon Web Services Payment Cryptography, the value is <code>EXTERNAL</code>.</p>
|
|
334
|
+
* @public
|
|
335
|
+
*/
|
|
336
|
+
KeyOrigin: KeyOrigin | undefined;
|
|
337
|
+
/**
|
|
338
|
+
* <p>The date and time when the key was created.</p>
|
|
339
|
+
* @public
|
|
340
|
+
*/
|
|
341
|
+
CreateTimestamp: Date | undefined;
|
|
342
|
+
/**
|
|
343
|
+
* <p>The date and time after which Amazon Web Services Payment Cryptography will start using the key material for cryptographic operations.</p>
|
|
344
|
+
* @public
|
|
345
|
+
*/
|
|
346
|
+
UsageStartTimestamp?: Date | undefined;
|
|
347
|
+
/**
|
|
348
|
+
* <p>The date and time after which Amazon Web Services Payment Cryptography will stop using the key material for cryptographic operations.</p>
|
|
349
|
+
* @public
|
|
350
|
+
*/
|
|
351
|
+
UsageStopTimestamp?: Date | undefined;
|
|
352
|
+
/**
|
|
353
|
+
* <p>The date and time after which Amazon Web Services Payment Cryptography will delete the key. This value is present only when <code>KeyState</code> is <code>DELETE_PENDING</code> and the key is scheduled for deletion.</p>
|
|
354
|
+
* @public
|
|
355
|
+
*/
|
|
356
|
+
DeletePendingTimestamp?: Date | undefined;
|
|
357
|
+
/**
|
|
358
|
+
* <p>The date and time after which Amazon Web Services Payment Cryptography will delete the key. This value is present only when when the <code>KeyState</code> is <code>DELETE_COMPLETE</code> and the Amazon Web Services Payment Cryptography key is deleted.</p>
|
|
359
|
+
* @public
|
|
360
|
+
*/
|
|
361
|
+
DeleteTimestamp?: Date | undefined;
|
|
362
|
+
/**
|
|
363
|
+
* <p>The cryptographic usage of an ECDH derived key as defined in section A.5.2 of the TR-31 spec.</p>
|
|
364
|
+
* @public
|
|
365
|
+
*/
|
|
366
|
+
DeriveKeyUsage?: DeriveKeyUsage | undefined;
|
|
367
|
+
/**
|
|
368
|
+
* <p>Indicates whether this key is a multi-region key and its role in the multi-region key hierarchy.</p> <p>Multi-region keys allow the same key material to be used across multiple Amazon Web Services Regions. This field specifies whether the key is a primary key (which can be replicated to other regions) or a replica key (which is a copy of a primary key in another region).</p>
|
|
369
|
+
* @public
|
|
370
|
+
*/
|
|
371
|
+
MultiRegionKeyType?: MultiRegionKeyType | undefined;
|
|
372
|
+
/**
|
|
373
|
+
* <p>An Amazon Web Services Region identifier in the standard format (e.g., <code>us-east-1</code>, <code>eu-west-1</code>).</p> <p>Used to specify regions for key replication operations. The region must be a valid Amazon Web Services Region where Amazon Web Services Payment Cryptography is available.</p>
|
|
374
|
+
* @public
|
|
375
|
+
*/
|
|
376
|
+
PrimaryRegion?: string | undefined;
|
|
377
|
+
/**
|
|
378
|
+
* <p>Information about the replication status of the key across different regions.</p> <p>This field provides details about the current state of key replication, including any status messages or operational information. It helps track the progress and health of key replication operations.</p>
|
|
379
|
+
* @public
|
|
380
|
+
*/
|
|
381
|
+
ReplicationStatus?: Record<string, ReplicationStatusType> | undefined;
|
|
382
|
+
/**
|
|
383
|
+
* <p>Indicates whether this key is using the account's default replication regions configuration.</p> <p>When set to <code>true</code>, the key automatically replicates to the regions specified in the account's default replication settings. When set to <code>false</code>, the key has a custom replication configuration that overrides the account defaults.</p>
|
|
384
|
+
* @public
|
|
385
|
+
*/
|
|
386
|
+
UsingDefaultReplicationRegions?: boolean | undefined;
|
|
387
|
+
}
|
|
388
|
+
/**
|
|
389
|
+
* <p>Output from adding replication regions to a key.</p>
|
|
390
|
+
* @public
|
|
391
|
+
*/
|
|
392
|
+
export interface AddKeyReplicationRegionsOutput {
|
|
393
|
+
/**
|
|
394
|
+
* <p>The updated key metadata after adding the replication regions.</p> <p>This includes the current state of the key and its replication configuration.</p>
|
|
395
|
+
* @public
|
|
396
|
+
*/
|
|
397
|
+
Key: Key | undefined;
|
|
398
|
+
}
|
|
399
|
+
/**
|
|
400
|
+
* <p>This request can cause an inconsistent state for the resource.</p> <p>The requested operation conflicts with the current state of the resource. For example, attempting to delete a key that is currently being used, or trying to create a resource that already exists.</p>
|
|
401
|
+
* @public
|
|
402
|
+
*/
|
|
403
|
+
export declare class ConflictException extends __BaseException {
|
|
404
|
+
readonly name: "ConflictException";
|
|
405
|
+
readonly $fault: "client";
|
|
406
|
+
Message?: string | undefined;
|
|
407
|
+
/**
|
|
408
|
+
* @internal
|
|
409
|
+
*/
|
|
410
|
+
constructor(opts: __ExceptionOptionType<ConflictException, __BaseException>);
|
|
411
|
+
}
|
|
412
|
+
/**
|
|
413
|
+
* <p>The request processing has failed because of an unknown error, exception, or failure.</p> <p>This indicates a server-side error within the Amazon Web Services Payment Cryptography service. If this error persists, contact support for assistance.</p>
|
|
414
|
+
* @public
|
|
415
|
+
*/
|
|
416
|
+
export declare class InternalServerException extends __BaseException {
|
|
417
|
+
readonly name: "InternalServerException";
|
|
418
|
+
readonly $fault: "server";
|
|
419
|
+
Message?: string | undefined;
|
|
420
|
+
/**
|
|
421
|
+
* @internal
|
|
422
|
+
*/
|
|
423
|
+
constructor(opts: __ExceptionOptionType<InternalServerException, __BaseException>);
|
|
424
|
+
}
|
|
425
|
+
/**
|
|
426
|
+
* <p>The request was denied due to resource not found.</p> <p>The specified key, alias, or other resource does not exist in your account or region. Verify that the resource identifier is correct and that the resource exists in the expected region.</p>
|
|
427
|
+
* @public
|
|
428
|
+
*/
|
|
429
|
+
export declare class ResourceNotFoundException extends __BaseException {
|
|
430
|
+
readonly name: "ResourceNotFoundException";
|
|
431
|
+
readonly $fault: "client";
|
|
432
|
+
/**
|
|
433
|
+
* <p>The identifier of the resource that was not found.</p> <p>This field contains the specific resource identifier (such as a key ARN or alias name) that could not be located.</p>
|
|
434
|
+
* @public
|
|
435
|
+
*/
|
|
436
|
+
ResourceId?: string | undefined;
|
|
437
|
+
/**
|
|
438
|
+
* @internal
|
|
439
|
+
*/
|
|
440
|
+
constructor(opts: __ExceptionOptionType<ResourceNotFoundException, __BaseException>);
|
|
441
|
+
}
|
|
442
|
+
/**
|
|
443
|
+
* <p>This request would cause a service quota to be exceeded.</p> <p>You have reached the maximum number of keys, aliases, or other resources allowed in your account. Review your current usage and consider deleting unused resources or requesting a quota increase.</p>
|
|
444
|
+
* @public
|
|
445
|
+
*/
|
|
446
|
+
export declare class ServiceQuotaExceededException extends __BaseException {
|
|
447
|
+
readonly name: "ServiceQuotaExceededException";
|
|
448
|
+
readonly $fault: "client";
|
|
449
|
+
Message?: string | undefined;
|
|
450
|
+
/**
|
|
451
|
+
* @internal
|
|
452
|
+
*/
|
|
453
|
+
constructor(opts: __ExceptionOptionType<ServiceQuotaExceededException, __BaseException>);
|
|
454
|
+
}
|
|
455
|
+
/**
|
|
456
|
+
* <p>The request was denied due to request throttling.</p> <p>You have exceeded the rate limits for Amazon Web Services Payment Cryptography API calls. Implement exponential backoff and retry logic in your application to handle throttling gracefully.</p>
|
|
457
|
+
* @public
|
|
458
|
+
*/
|
|
459
|
+
export declare class ThrottlingException extends __BaseException {
|
|
460
|
+
readonly name: "ThrottlingException";
|
|
461
|
+
readonly $fault: "client";
|
|
462
|
+
Message?: string | undefined;
|
|
463
|
+
/**
|
|
464
|
+
* @internal
|
|
465
|
+
*/
|
|
466
|
+
constructor(opts: __ExceptionOptionType<ThrottlingException, __BaseException>);
|
|
467
|
+
}
|
|
468
|
+
/**
|
|
469
|
+
* <p>The request was denied due to an invalid request error.</p> <p>One or more parameters in your request are invalid. Check the parameter values, formats, and constraints specified in the API documentation.</p>
|
|
470
|
+
* @public
|
|
471
|
+
*/
|
|
472
|
+
export declare class ValidationException extends __BaseException {
|
|
473
|
+
readonly name: "ValidationException";
|
|
474
|
+
readonly $fault: "client";
|
|
475
|
+
Message?: string | undefined;
|
|
476
|
+
/**
|
|
477
|
+
* @internal
|
|
478
|
+
*/
|
|
479
|
+
constructor(opts: __ExceptionOptionType<ValidationException, __BaseException>);
|
|
480
|
+
}
|
|
481
|
+
/**
|
|
482
|
+
* <p>Contains information about an alias.</p>
|
|
483
|
+
* @public
|
|
484
|
+
*/
|
|
485
|
+
export interface Alias {
|
|
486
|
+
/**
|
|
487
|
+
* <p>A friendly name that you can use to refer to a key. The value must begin with <code>alias/</code>.</p> <important> <p>Do not include confidential or sensitive information in this field. This field may be displayed in plaintext in CloudTrail logs and other output.</p> </important>
|
|
488
|
+
* @public
|
|
489
|
+
*/
|
|
490
|
+
AliasName: string | undefined;
|
|
491
|
+
/**
|
|
492
|
+
* <p>The <code>KeyARN</code> of the key associated with the alias.</p>
|
|
493
|
+
* @public
|
|
494
|
+
*/
|
|
495
|
+
KeyArn?: string | undefined;
|
|
496
|
+
}
|
|
497
|
+
/**
|
|
498
|
+
* @public
|
|
499
|
+
*/
|
|
500
|
+
export interface CreateAliasInput {
|
|
501
|
+
/**
|
|
502
|
+
* <p>A friendly name that you can use to refer to a key. An alias must begin with <code>alias/</code> followed by a name, for example <code>alias/ExampleAlias</code>. It can contain only alphanumeric characters, forward slashes (/), underscores (_), and dashes (-).</p> <important> <p>Don't include personal, confidential or sensitive information in this field. This field may be displayed in plaintext in CloudTrail logs and other output.</p> </important>
|
|
503
|
+
* @public
|
|
504
|
+
*/
|
|
505
|
+
AliasName: string | undefined;
|
|
506
|
+
/**
|
|
507
|
+
* <p>The <code>KeyARN</code> of the key to associate with the alias.</p>
|
|
508
|
+
* @public
|
|
509
|
+
*/
|
|
510
|
+
KeyArn?: string | undefined;
|
|
511
|
+
}
|
|
512
|
+
/**
|
|
513
|
+
* @public
|
|
514
|
+
*/
|
|
515
|
+
export interface CreateAliasOutput {
|
|
516
|
+
/**
|
|
517
|
+
* <p>The alias for the key.</p>
|
|
518
|
+
* @public
|
|
519
|
+
*/
|
|
520
|
+
Alias: Alias | undefined;
|
|
521
|
+
}
|
|
522
|
+
/**
|
|
523
|
+
* <p>The service cannot complete the request.</p> <p>The Amazon Web Services Payment Cryptography service is temporarily unavailable. This is typically a temporary condition - retry your request after a brief delay.</p>
|
|
524
|
+
* @public
|
|
525
|
+
*/
|
|
526
|
+
export declare class ServiceUnavailableException extends __BaseException {
|
|
527
|
+
readonly name: "ServiceUnavailableException";
|
|
528
|
+
readonly $fault: "server";
|
|
529
|
+
Message?: string | undefined;
|
|
530
|
+
/**
|
|
531
|
+
* @internal
|
|
532
|
+
*/
|
|
533
|
+
constructor(opts: __ExceptionOptionType<ServiceUnavailableException, __BaseException>);
|
|
534
|
+
}
|
|
535
|
+
/**
|
|
536
|
+
* @public
|
|
537
|
+
*/
|
|
538
|
+
export interface DeleteAliasInput {
|
|
539
|
+
/**
|
|
540
|
+
* <p>A friendly name that you can use to refer Amazon Web Services Payment Cryptography key. This value must begin with <code>alias/</code> followed by a name, such as <code>alias/ExampleAlias</code>.</p>
|
|
541
|
+
* @public
|
|
542
|
+
*/
|
|
543
|
+
AliasName: string | undefined;
|
|
544
|
+
}
|
|
545
|
+
/**
|
|
546
|
+
* @public
|
|
547
|
+
*/
|
|
548
|
+
export interface DeleteAliasOutput {
|
|
549
|
+
}
|
|
550
|
+
/**
|
|
551
|
+
* @public
|
|
552
|
+
*/
|
|
553
|
+
export interface GetAliasInput {
|
|
554
|
+
/**
|
|
555
|
+
* <p>The alias of the Amazon Web Services Payment Cryptography key.</p>
|
|
556
|
+
* @public
|
|
557
|
+
*/
|
|
558
|
+
AliasName: string | undefined;
|
|
559
|
+
}
|
|
560
|
+
/**
|
|
561
|
+
* @public
|
|
562
|
+
*/
|
|
563
|
+
export interface GetAliasOutput {
|
|
564
|
+
/**
|
|
565
|
+
* <p>The alias of the Amazon Web Services Payment Cryptography key.</p>
|
|
566
|
+
* @public
|
|
567
|
+
*/
|
|
568
|
+
Alias: Alias | undefined;
|
|
569
|
+
}
|
|
399
570
|
/**
|
|
400
|
-
* <p>The role of the key, the algorithm it supports, and the cryptographic operations allowed with the key. This data is immutable after the key is created.</p>
|
|
401
571
|
* @public
|
|
402
572
|
*/
|
|
403
|
-
export interface
|
|
573
|
+
export interface ListAliasesInput {
|
|
404
574
|
/**
|
|
405
|
-
* <p>The
|
|
575
|
+
* <p>The <code>keyARN</code> for which you want to list all aliases.</p>
|
|
406
576
|
* @public
|
|
407
577
|
*/
|
|
408
|
-
|
|
578
|
+
KeyArn?: string | undefined;
|
|
409
579
|
/**
|
|
410
|
-
* <p>
|
|
580
|
+
* <p>Use this parameter in a subsequent request after you receive a response with truncated results. Set it to the value of <code>NextToken</code> from the truncated response you just received.</p>
|
|
411
581
|
* @public
|
|
412
582
|
*/
|
|
413
|
-
|
|
583
|
+
NextToken?: string | undefined;
|
|
414
584
|
/**
|
|
415
|
-
* <p>
|
|
585
|
+
* <p>Use this parameter to specify the maximum number of items to return. When this value is present, Amazon Web Services Payment Cryptography does not return more than the specified number of items, but it might return fewer.</p> <p>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.</p>
|
|
416
586
|
* @public
|
|
417
587
|
*/
|
|
418
|
-
|
|
588
|
+
MaxResults?: number | undefined;
|
|
589
|
+
}
|
|
590
|
+
/**
|
|
591
|
+
* @public
|
|
592
|
+
*/
|
|
593
|
+
export interface ListAliasesOutput {
|
|
419
594
|
/**
|
|
420
|
-
* <p>The list of
|
|
595
|
+
* <p>The list of aliases. Each alias describes the <code>KeyArn</code> contained within.</p>
|
|
421
596
|
* @public
|
|
422
597
|
*/
|
|
423
|
-
|
|
598
|
+
Aliases: Alias[] | undefined;
|
|
599
|
+
/**
|
|
600
|
+
* <p>The token for the next set of results, or an empty or null value if there are no more results.</p>
|
|
601
|
+
* @public
|
|
602
|
+
*/
|
|
603
|
+
NextToken?: string | undefined;
|
|
424
604
|
}
|
|
425
605
|
/**
|
|
426
606
|
* @public
|
|
427
|
-
* @enum
|
|
428
607
|
*/
|
|
429
|
-
export
|
|
430
|
-
|
|
431
|
-
|
|
432
|
-
|
|
433
|
-
|
|
608
|
+
export interface UpdateAliasInput {
|
|
609
|
+
/**
|
|
610
|
+
* <p>The alias whose associated key is changing.</p>
|
|
611
|
+
* @public
|
|
612
|
+
*/
|
|
613
|
+
AliasName: string | undefined;
|
|
614
|
+
/**
|
|
615
|
+
* <p>The <code>KeyARN</code> for the key that you are updating or removing from the alias.</p>
|
|
616
|
+
* @public
|
|
617
|
+
*/
|
|
618
|
+
KeyArn?: string | undefined;
|
|
619
|
+
}
|
|
434
620
|
/**
|
|
435
621
|
* @public
|
|
436
622
|
*/
|
|
437
|
-
export
|
|
623
|
+
export interface UpdateAliasOutput {
|
|
624
|
+
/**
|
|
625
|
+
* <p>The alias name.</p>
|
|
626
|
+
* @public
|
|
627
|
+
*/
|
|
628
|
+
Alias: Alias | undefined;
|
|
629
|
+
}
|
|
438
630
|
/**
|
|
439
631
|
* <p>A structure that contains information about a tag.</p>
|
|
440
632
|
* @public
|
|
@@ -485,108 +677,11 @@ export interface CreateKeyInput {
|
|
|
485
677
|
* @public
|
|
486
678
|
*/
|
|
487
679
|
DeriveKeyUsage?: DeriveKeyUsage | undefined;
|
|
488
|
-
}
|
|
489
|
-
/**
|
|
490
|
-
* @public
|
|
491
|
-
* @enum
|
|
492
|
-
*/
|
|
493
|
-
export declare const KeyOrigin: {
|
|
494
|
-
readonly AWS_PAYMENT_CRYPTOGRAPHY: "AWS_PAYMENT_CRYPTOGRAPHY";
|
|
495
|
-
readonly EXTERNAL: "EXTERNAL";
|
|
496
|
-
};
|
|
497
|
-
/**
|
|
498
|
-
* @public
|
|
499
|
-
*/
|
|
500
|
-
export type KeyOrigin = (typeof KeyOrigin)[keyof typeof KeyOrigin];
|
|
501
|
-
/**
|
|
502
|
-
* @public
|
|
503
|
-
* @enum
|
|
504
|
-
*/
|
|
505
|
-
export declare const KeyState: {
|
|
506
|
-
readonly CREATE_COMPLETE: "CREATE_COMPLETE";
|
|
507
|
-
readonly CREATE_IN_PROGRESS: "CREATE_IN_PROGRESS";
|
|
508
|
-
readonly DELETE_COMPLETE: "DELETE_COMPLETE";
|
|
509
|
-
readonly DELETE_PENDING: "DELETE_PENDING";
|
|
510
|
-
};
|
|
511
|
-
/**
|
|
512
|
-
* @public
|
|
513
|
-
*/
|
|
514
|
-
export type KeyState = (typeof KeyState)[keyof typeof KeyState];
|
|
515
|
-
/**
|
|
516
|
-
* <p>Metadata about an Amazon Web Services Payment Cryptography key.</p>
|
|
517
|
-
* @public
|
|
518
|
-
*/
|
|
519
|
-
export interface Key {
|
|
520
|
-
/**
|
|
521
|
-
* <p>The Amazon Resource Name (ARN) of the key.</p>
|
|
522
|
-
* @public
|
|
523
|
-
*/
|
|
524
|
-
KeyArn: string | undefined;
|
|
525
|
-
/**
|
|
526
|
-
* <p>The role of the key, the algorithm it supports, and the cryptographic operations allowed with the key. This data is immutable after the key is created.</p>
|
|
527
|
-
* @public
|
|
528
|
-
*/
|
|
529
|
-
KeyAttributes: KeyAttributes | undefined;
|
|
530
|
-
/**
|
|
531
|
-
* <p>The key check value (KCV) is used to check if all parties holding a given key have the same key or to detect that a key has changed.</p>
|
|
532
|
-
* @public
|
|
533
|
-
*/
|
|
534
|
-
KeyCheckValue: string | undefined;
|
|
535
|
-
/**
|
|
536
|
-
* <p>The algorithm that Amazon Web Services Payment Cryptography uses to calculate the key check value (KCV). It is used to validate the key integrity.</p> <p>For TDES keys, the KCV is computed by encrypting 8 bytes, each with value of zero, with the key to be checked and retaining the 3 highest order bytes of the encrypted result. For AES keys, the KCV is computed using a CMAC algorithm where the input data is 16 bytes of zero and retaining the 3 highest order bytes of the encrypted result.</p>
|
|
537
|
-
* @public
|
|
538
|
-
*/
|
|
539
|
-
KeyCheckValueAlgorithm: KeyCheckValueAlgorithm | undefined;
|
|
540
|
-
/**
|
|
541
|
-
* <p>Specifies whether the key is enabled. </p>
|
|
542
|
-
* @public
|
|
543
|
-
*/
|
|
544
|
-
Enabled: boolean | undefined;
|
|
545
|
-
/**
|
|
546
|
-
* <p>Specifies whether the key is exportable. This data is immutable after the key is created.</p>
|
|
547
|
-
* @public
|
|
548
|
-
*/
|
|
549
|
-
Exportable: boolean | undefined;
|
|
550
|
-
/**
|
|
551
|
-
* <p>The state of key that is being created or deleted.</p>
|
|
552
|
-
* @public
|
|
553
|
-
*/
|
|
554
|
-
KeyState: KeyState | undefined;
|
|
555
|
-
/**
|
|
556
|
-
* <p>The source of the key material. For keys created within Amazon Web Services Payment Cryptography, the value is <code>AWS_PAYMENT_CRYPTOGRAPHY</code>. For keys imported into Amazon Web Services Payment Cryptography, the value is <code>EXTERNAL</code>.</p>
|
|
557
|
-
* @public
|
|
558
|
-
*/
|
|
559
|
-
KeyOrigin: KeyOrigin | undefined;
|
|
560
|
-
/**
|
|
561
|
-
* <p>The date and time when the key was created.</p>
|
|
562
|
-
* @public
|
|
563
|
-
*/
|
|
564
|
-
CreateTimestamp: Date | undefined;
|
|
565
|
-
/**
|
|
566
|
-
* <p>The date and time after which Amazon Web Services Payment Cryptography will start using the key material for cryptographic operations.</p>
|
|
567
|
-
* @public
|
|
568
|
-
*/
|
|
569
|
-
UsageStartTimestamp?: Date | undefined;
|
|
570
|
-
/**
|
|
571
|
-
* <p>The date and time after which Amazon Web Services Payment Cryptography will stop using the key material for cryptographic operations.</p>
|
|
572
|
-
* @public
|
|
573
|
-
*/
|
|
574
|
-
UsageStopTimestamp?: Date | undefined;
|
|
575
|
-
/**
|
|
576
|
-
* <p>The date and time after which Amazon Web Services Payment Cryptography will delete the key. This value is present only when <code>KeyState</code> is <code>DELETE_PENDING</code> and the key is scheduled for deletion.</p>
|
|
577
|
-
* @public
|
|
578
|
-
*/
|
|
579
|
-
DeletePendingTimestamp?: Date | undefined;
|
|
580
|
-
/**
|
|
581
|
-
* <p>The date and time after which Amazon Web Services Payment Cryptography will delete the key. This value is present only when when the <code>KeyState</code> is <code>DELETE_COMPLETE</code> and the Amazon Web Services Payment Cryptography key is deleted.</p>
|
|
582
|
-
* @public
|
|
583
|
-
*/
|
|
584
|
-
DeleteTimestamp?: Date | undefined;
|
|
585
680
|
/**
|
|
586
|
-
* <p>
|
|
681
|
+
* <p>A list of Amazon Web Services Regions for key replication operations.</p> <p>Each region in the list must be a valid Amazon Web Services Region identifier where Amazon Web Services Payment Cryptography is available. This list is used to specify which regions should be added to or removed from a key's replication configuration.</p>
|
|
587
682
|
* @public
|
|
588
683
|
*/
|
|
589
|
-
|
|
684
|
+
ReplicationRegions?: string[] | undefined;
|
|
590
685
|
}
|
|
591
686
|
/**
|
|
592
687
|
* @public
|
|
@@ -653,6 +748,50 @@ export declare namespace DiffieHellmanDerivationData {
|
|
|
653
748
|
}
|
|
654
749
|
const visit: <T>(value: DiffieHellmanDerivationData, visitor: Visitor<T>) => T;
|
|
655
750
|
}
|
|
751
|
+
/**
|
|
752
|
+
* <p>Input parameters for disabling default key replication regions for the account.</p>
|
|
753
|
+
* @public
|
|
754
|
+
*/
|
|
755
|
+
export interface DisableDefaultKeyReplicationRegionsInput {
|
|
756
|
+
/**
|
|
757
|
+
* <p>The list of Amazon Web Services Regions to remove from the account's default replication regions.</p> <p>New keys created after this operation will not automatically be replicated to these regions, though existing keys with replication to these regions will be unaffected.</p>
|
|
758
|
+
* @public
|
|
759
|
+
*/
|
|
760
|
+
ReplicationRegions: string[] | undefined;
|
|
761
|
+
}
|
|
762
|
+
/**
|
|
763
|
+
* <p>Output from disabling default key replication regions for the account.</p>
|
|
764
|
+
* @public
|
|
765
|
+
*/
|
|
766
|
+
export interface DisableDefaultKeyReplicationRegionsOutput {
|
|
767
|
+
/**
|
|
768
|
+
* <p>The remaining list of regions where default key replication is still enabled for the account.</p> <p>This reflects the account's default replication configuration after removing the specified regions.</p>
|
|
769
|
+
* @public
|
|
770
|
+
*/
|
|
771
|
+
EnabledReplicationRegions: string[] | undefined;
|
|
772
|
+
}
|
|
773
|
+
/**
|
|
774
|
+
* <p>Input parameters for enabling default key replication regions for the account.</p>
|
|
775
|
+
* @public
|
|
776
|
+
*/
|
|
777
|
+
export interface EnableDefaultKeyReplicationRegionsInput {
|
|
778
|
+
/**
|
|
779
|
+
* <p>The list of Amazon Web Services Regions to enable as default replication regions for the account.</p> <p>New keys created in this account will automatically be replicated to these regions unless explicitly overridden during key creation.</p>
|
|
780
|
+
* @public
|
|
781
|
+
*/
|
|
782
|
+
ReplicationRegions: string[] | undefined;
|
|
783
|
+
}
|
|
784
|
+
/**
|
|
785
|
+
* <p>Output from enabling default key replication regions for the account.</p>
|
|
786
|
+
* @public
|
|
787
|
+
*/
|
|
788
|
+
export interface EnableDefaultKeyReplicationRegionsOutput {
|
|
789
|
+
/**
|
|
790
|
+
* <p>The complete list of regions where default key replication is now enabled for the account.</p> <p>This includes both previously enabled regions and the newly added regions from this operation.</p>
|
|
791
|
+
* @public
|
|
792
|
+
*/
|
|
793
|
+
EnabledReplicationRegions: string[] | undefined;
|
|
794
|
+
}
|
|
656
795
|
/**
|
|
657
796
|
* <p>Parameter information for IPEK generation during export.</p>
|
|
658
797
|
* @public
|
|
@@ -1051,6 +1190,23 @@ export interface ExportKeyOutput {
|
|
|
1051
1190
|
*/
|
|
1052
1191
|
WrappedKey?: WrappedKey | undefined;
|
|
1053
1192
|
}
|
|
1193
|
+
/**
|
|
1194
|
+
* <p>Input parameters for retrieving the account's default key replication regions. This operation requires no input parameters.</p>
|
|
1195
|
+
* @public
|
|
1196
|
+
*/
|
|
1197
|
+
export interface GetDefaultKeyReplicationRegionsInput {
|
|
1198
|
+
}
|
|
1199
|
+
/**
|
|
1200
|
+
* <p>Output containing the account's current default key replication configuration.</p>
|
|
1201
|
+
* @public
|
|
1202
|
+
*/
|
|
1203
|
+
export interface GetDefaultKeyReplicationRegionsOutput {
|
|
1204
|
+
/**
|
|
1205
|
+
* <p>The list of regions where default key replication is currently enabled for the account.</p> <p>New keys created in this account will automatically be replicated to these regions unless explicitly configured otherwise during key creation.</p>
|
|
1206
|
+
* @public
|
|
1207
|
+
*/
|
|
1208
|
+
EnabledReplicationRegions: string[] | undefined;
|
|
1209
|
+
}
|
|
1054
1210
|
/**
|
|
1055
1211
|
* @public
|
|
1056
1212
|
*/
|
|
@@ -1066,7 +1222,7 @@ export interface GetKeyInput {
|
|
|
1066
1222
|
*/
|
|
1067
1223
|
export interface GetKeyOutput {
|
|
1068
1224
|
/**
|
|
1069
|
-
* <p>
|
|
1225
|
+
* <p>Contains the key metadata, including both immutable and mutable attributes for the key, but does not include actual cryptographic key material.</p>
|
|
1070
1226
|
* @public
|
|
1071
1227
|
*/
|
|
1072
1228
|
Key: Key | undefined;
|
|
@@ -1501,6 +1657,11 @@ export interface ImportKeyInput {
|
|
|
1501
1657
|
* @public
|
|
1502
1658
|
*/
|
|
1503
1659
|
Tags?: Tag[] | undefined;
|
|
1660
|
+
/**
|
|
1661
|
+
* <p>A list of Amazon Web Services Regions for key replication operations.</p> <p>Each region in the list must be a valid Amazon Web Services Region identifier where Amazon Web Services Payment Cryptography is available. This list is used to specify which regions should be added to or removed from a key's replication configuration.</p>
|
|
1662
|
+
* @public
|
|
1663
|
+
*/
|
|
1664
|
+
ReplicationRegions?: string[] | undefined;
|
|
1504
1665
|
}
|
|
1505
1666
|
/**
|
|
1506
1667
|
* @public
|
|
@@ -1567,6 +1728,16 @@ export interface KeySummary {
|
|
|
1567
1728
|
* @public
|
|
1568
1729
|
*/
|
|
1569
1730
|
Enabled: boolean | undefined;
|
|
1731
|
+
/**
|
|
1732
|
+
* Defines the replication type of a key
|
|
1733
|
+
* @public
|
|
1734
|
+
*/
|
|
1735
|
+
MultiRegionKeyType?: MultiRegionKeyType | undefined;
|
|
1736
|
+
/**
|
|
1737
|
+
* <p>An Amazon Web Services Region identifier in the standard format (e.g., <code>us-east-1</code>, <code>eu-west-1</code>).</p> <p>Used to specify regions for key replication operations. The region must be a valid Amazon Web Services Region where Amazon Web Services Payment Cryptography is available.</p>
|
|
1738
|
+
* @public
|
|
1739
|
+
*/
|
|
1740
|
+
PrimaryRegion?: string | undefined;
|
|
1570
1741
|
}
|
|
1571
1742
|
/**
|
|
1572
1743
|
* @public
|
|
@@ -1583,6 +1754,33 @@ export interface ListKeysOutput {
|
|
|
1583
1754
|
*/
|
|
1584
1755
|
NextToken?: string | undefined;
|
|
1585
1756
|
}
|
|
1757
|
+
/**
|
|
1758
|
+
* <p>Input parameters for removing replication regions from a specific key.</p>
|
|
1759
|
+
* @public
|
|
1760
|
+
*/
|
|
1761
|
+
export interface RemoveKeyReplicationRegionsInput {
|
|
1762
|
+
/**
|
|
1763
|
+
* <p>The key identifier (ARN or alias) of the key from which to remove replication regions.</p> <p>This key must exist and have replication enabled in the specified regions.</p>
|
|
1764
|
+
* @public
|
|
1765
|
+
*/
|
|
1766
|
+
KeyIdentifier: string | undefined;
|
|
1767
|
+
/**
|
|
1768
|
+
* <p>The list of Amazon Web Services Regions to remove from the key's replication configuration.</p> <p>The key will no longer be available for cryptographic operations in these regions after removal. Ensure no active operations depend on the key in these regions before removal.</p>
|
|
1769
|
+
* @public
|
|
1770
|
+
*/
|
|
1771
|
+
ReplicationRegions: string[] | undefined;
|
|
1772
|
+
}
|
|
1773
|
+
/**
|
|
1774
|
+
* <p>Output from removing replication regions from a key.</p>
|
|
1775
|
+
* @public
|
|
1776
|
+
*/
|
|
1777
|
+
export interface RemoveKeyReplicationRegionsOutput {
|
|
1778
|
+
/**
|
|
1779
|
+
* <p>The updated key metadata after removing the replication regions.</p> <p>This reflects the current state of the key and its updated replication configuration.</p>
|
|
1780
|
+
* @public
|
|
1781
|
+
*/
|
|
1782
|
+
Key: Key | undefined;
|
|
1783
|
+
}
|
|
1586
1784
|
/**
|
|
1587
1785
|
* @public
|
|
1588
1786
|
*/
|
|
@@ -1726,10 +1924,6 @@ export declare const KeyBlockHeadersFilterSensitiveLog: (obj: KeyBlockHeaders) =
|
|
|
1726
1924
|
* @internal
|
|
1727
1925
|
*/
|
|
1728
1926
|
export declare const ExportDiffieHellmanTr31KeyBlockFilterSensitiveLog: (obj: ExportDiffieHellmanTr31KeyBlock) => any;
|
|
1729
|
-
/**
|
|
1730
|
-
* @internal
|
|
1731
|
-
*/
|
|
1732
|
-
export declare const ExportKeyCryptogramFilterSensitiveLog: (obj: ExportKeyCryptogram) => any;
|
|
1733
1927
|
/**
|
|
1734
1928
|
* @internal
|
|
1735
1929
|
*/
|
|
@@ -1754,18 +1948,6 @@ export declare const WrappedKeyFilterSensitiveLog: (obj: WrappedKey) => any;
|
|
|
1754
1948
|
* @internal
|
|
1755
1949
|
*/
|
|
1756
1950
|
export declare const ExportKeyOutputFilterSensitiveLog: (obj: ExportKeyOutput) => any;
|
|
1757
|
-
/**
|
|
1758
|
-
* @internal
|
|
1759
|
-
*/
|
|
1760
|
-
export declare const GetParametersForExportOutputFilterSensitiveLog: (obj: GetParametersForExportOutput) => any;
|
|
1761
|
-
/**
|
|
1762
|
-
* @internal
|
|
1763
|
-
*/
|
|
1764
|
-
export declare const GetParametersForImportOutputFilterSensitiveLog: (obj: GetParametersForImportOutput) => any;
|
|
1765
|
-
/**
|
|
1766
|
-
* @internal
|
|
1767
|
-
*/
|
|
1768
|
-
export declare const GetPublicKeyCertificateOutputFilterSensitiveLog: (obj: GetPublicKeyCertificateOutput) => any;
|
|
1769
1951
|
/**
|
|
1770
1952
|
* @internal
|
|
1771
1953
|
*/
|
|
@@ -1774,10 +1956,6 @@ export declare const ImportDiffieHellmanTr31KeyBlockFilterSensitiveLog: (obj: Im
|
|
|
1774
1956
|
* @internal
|
|
1775
1957
|
*/
|
|
1776
1958
|
export declare const ImportKeyCryptogramFilterSensitiveLog: (obj: ImportKeyCryptogram) => any;
|
|
1777
|
-
/**
|
|
1778
|
-
* @internal
|
|
1779
|
-
*/
|
|
1780
|
-
export declare const RootCertificatePublicKeyFilterSensitiveLog: (obj: RootCertificatePublicKey) => any;
|
|
1781
1959
|
/**
|
|
1782
1960
|
* @internal
|
|
1783
1961
|
*/
|
|
@@ -1786,10 +1964,6 @@ export declare const ImportTr31KeyBlockFilterSensitiveLog: (obj: ImportTr31KeyBl
|
|
|
1786
1964
|
* @internal
|
|
1787
1965
|
*/
|
|
1788
1966
|
export declare const ImportTr34KeyBlockFilterSensitiveLog: (obj: ImportTr34KeyBlock) => any;
|
|
1789
|
-
/**
|
|
1790
|
-
* @internal
|
|
1791
|
-
*/
|
|
1792
|
-
export declare const TrustedCertificatePublicKeyFilterSensitiveLog: (obj: TrustedCertificatePublicKey) => any;
|
|
1793
1967
|
/**
|
|
1794
1968
|
* @internal
|
|
1795
1969
|
*/
|