@aws-sdk/client-pca-connector-scep 3.595.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.
Files changed (143) hide show
  1. package/LICENSE +201 -0
  2. package/README.md +305 -0
  3. package/dist-cjs/PcaConnectorScep.js +35 -0
  4. package/dist-cjs/PcaConnectorScepClient.js +56 -0
  5. package/dist-cjs/auth/httpAuthExtensionConfiguration.js +43 -0
  6. package/dist-cjs/auth/httpAuthSchemeProvider.js +47 -0
  7. package/dist-cjs/commands/CreateChallengeCommand.js +29 -0
  8. package/dist-cjs/commands/CreateConnectorCommand.js +28 -0
  9. package/dist-cjs/commands/DeleteChallengeCommand.js +28 -0
  10. package/dist-cjs/commands/DeleteConnectorCommand.js +28 -0
  11. package/dist-cjs/commands/GetChallengeMetadataCommand.js +28 -0
  12. package/dist-cjs/commands/GetChallengePasswordCommand.js +29 -0
  13. package/dist-cjs/commands/GetConnectorCommand.js +28 -0
  14. package/dist-cjs/commands/ListChallengeMetadataCommand.js +28 -0
  15. package/dist-cjs/commands/ListConnectorsCommand.js +28 -0
  16. package/dist-cjs/commands/ListTagsForResourceCommand.js +28 -0
  17. package/dist-cjs/commands/TagResourceCommand.js +28 -0
  18. package/dist-cjs/commands/UntagResourceCommand.js +28 -0
  19. package/dist-cjs/commands/index.js +15 -0
  20. package/dist-cjs/endpoint/EndpointParameters.js +18 -0
  21. package/dist-cjs/endpoint/endpointResolver.js +14 -0
  22. package/dist-cjs/endpoint/ruleset.js +7 -0
  23. package/dist-cjs/extensionConfiguration.js +2 -0
  24. package/dist-cjs/index.js +11 -0
  25. package/dist-cjs/models/PcaConnectorScepServiceException.js +12 -0
  26. package/dist-cjs/models/index.js +4 -0
  27. package/dist-cjs/models/models_0.js +177 -0
  28. package/dist-cjs/pagination/Interfaces.js +2 -0
  29. package/dist-cjs/pagination/ListChallengeMetadataPaginator.js +7 -0
  30. package/dist-cjs/pagination/ListConnectorsPaginator.js +7 -0
  31. package/dist-cjs/pagination/index.js +6 -0
  32. package/dist-cjs/protocols/Aws_restJson1.js +565 -0
  33. package/dist-cjs/runtimeConfig.browser.js +39 -0
  34. package/dist-cjs/runtimeConfig.js +49 -0
  35. package/dist-cjs/runtimeConfig.native.js +15 -0
  36. package/dist-cjs/runtimeConfig.shared.js +34 -0
  37. package/dist-cjs/runtimeExtensions.js +25 -0
  38. package/dist-es/PcaConnectorScep.js +31 -0
  39. package/dist-es/PcaConnectorScepClient.js +52 -0
  40. package/dist-es/auth/httpAuthExtensionConfiguration.js +38 -0
  41. package/dist-es/auth/httpAuthSchemeProvider.js +41 -0
  42. package/dist-es/commands/CreateChallengeCommand.js +25 -0
  43. package/dist-es/commands/CreateConnectorCommand.js +24 -0
  44. package/dist-es/commands/DeleteChallengeCommand.js +24 -0
  45. package/dist-es/commands/DeleteConnectorCommand.js +24 -0
  46. package/dist-es/commands/GetChallengeMetadataCommand.js +24 -0
  47. package/dist-es/commands/GetChallengePasswordCommand.js +25 -0
  48. package/dist-es/commands/GetConnectorCommand.js +24 -0
  49. package/dist-es/commands/ListChallengeMetadataCommand.js +24 -0
  50. package/dist-es/commands/ListConnectorsCommand.js +24 -0
  51. package/dist-es/commands/ListTagsForResourceCommand.js +24 -0
  52. package/dist-es/commands/TagResourceCommand.js +24 -0
  53. package/dist-es/commands/UntagResourceCommand.js +24 -0
  54. package/dist-es/commands/index.js +12 -0
  55. package/dist-es/endpoint/EndpointParameters.js +14 -0
  56. package/dist-es/endpoint/endpointResolver.js +10 -0
  57. package/dist-es/endpoint/ruleset.js +4 -0
  58. package/dist-es/extensionConfiguration.js +1 -0
  59. package/dist-es/index.js +6 -0
  60. package/dist-es/models/PcaConnectorScepServiceException.js +8 -0
  61. package/dist-es/models/index.js +1 -0
  62. package/dist-es/models/models_0.js +163 -0
  63. package/dist-es/pagination/Interfaces.js +1 -0
  64. package/dist-es/pagination/ListChallengeMetadataPaginator.js +4 -0
  65. package/dist-es/pagination/ListConnectorsPaginator.js +4 -0
  66. package/dist-es/pagination/index.js +3 -0
  67. package/dist-es/protocols/Aws_restJson1.js +538 -0
  68. package/dist-es/runtimeConfig.browser.js +34 -0
  69. package/dist-es/runtimeConfig.js +44 -0
  70. package/dist-es/runtimeConfig.native.js +11 -0
  71. package/dist-es/runtimeConfig.shared.js +30 -0
  72. package/dist-es/runtimeExtensions.js +21 -0
  73. package/dist-types/PcaConnectorScep.d.ts +99 -0
  74. package/dist-types/PcaConnectorScepClient.d.ts +187 -0
  75. package/dist-types/auth/httpAuthExtensionConfiguration.d.ts +29 -0
  76. package/dist-types/auth/httpAuthSchemeProvider.d.ts +61 -0
  77. package/dist-types/commands/CreateChallengeCommand.d.ts +101 -0
  78. package/dist-types/commands/CreateConnectorCommand.d.ts +97 -0
  79. package/dist-types/commands/DeleteChallengeCommand.d.ts +82 -0
  80. package/dist-types/commands/DeleteConnectorCommand.d.ts +82 -0
  81. package/dist-types/commands/GetChallengeMetadataCommand.d.ts +85 -0
  82. package/dist-types/commands/GetChallengePasswordCommand.d.ts +80 -0
  83. package/dist-types/commands/GetConnectorCommand.d.ts +100 -0
  84. package/dist-types/commands/ListChallengeMetadataCommand.d.ts +90 -0
  85. package/dist-types/commands/ListConnectorsCommand.d.ts +101 -0
  86. package/dist-types/commands/ListTagsForResourceCommand.d.ts +86 -0
  87. package/dist-types/commands/TagResourceCommand.d.ts +81 -0
  88. package/dist-types/commands/UntagResourceCommand.d.ts +81 -0
  89. package/dist-types/commands/index.d.ts +12 -0
  90. package/dist-types/endpoint/EndpointParameters.d.ts +40 -0
  91. package/dist-types/endpoint/endpointResolver.d.ts +5 -0
  92. package/dist-types/endpoint/ruleset.d.ts +2 -0
  93. package/dist-types/extensionConfiguration.d.ts +9 -0
  94. package/dist-types/index.d.ts +18 -0
  95. package/dist-types/models/PcaConnectorScepServiceException.d.ts +14 -0
  96. package/dist-types/models/index.d.ts +1 -0
  97. package/dist-types/models/models_0.d.ts +763 -0
  98. package/dist-types/pagination/Interfaces.d.ts +8 -0
  99. package/dist-types/pagination/ListChallengeMetadataPaginator.d.ts +7 -0
  100. package/dist-types/pagination/ListConnectorsPaginator.d.ts +7 -0
  101. package/dist-types/pagination/index.d.ts +3 -0
  102. package/dist-types/protocols/Aws_restJson1.d.ts +110 -0
  103. package/dist-types/runtimeConfig.browser.d.ts +45 -0
  104. package/dist-types/runtimeConfig.d.ts +45 -0
  105. package/dist-types/runtimeConfig.native.d.ts +44 -0
  106. package/dist-types/runtimeConfig.shared.d.ts +21 -0
  107. package/dist-types/runtimeExtensions.d.ts +17 -0
  108. package/dist-types/ts3.4/PcaConnectorScep.d.ts +212 -0
  109. package/dist-types/ts3.4/PcaConnectorScepClient.d.ts +195 -0
  110. package/dist-types/ts3.4/auth/httpAuthExtensionConfiguration.d.ts +32 -0
  111. package/dist-types/ts3.4/auth/httpAuthSchemeProvider.d.ts +44 -0
  112. package/dist-types/ts3.4/commands/CreateChallengeCommand.d.ts +39 -0
  113. package/dist-types/ts3.4/commands/CreateConnectorCommand.d.ts +39 -0
  114. package/dist-types/ts3.4/commands/DeleteChallengeCommand.d.ts +34 -0
  115. package/dist-types/ts3.4/commands/DeleteConnectorCommand.d.ts +34 -0
  116. package/dist-types/ts3.4/commands/GetChallengeMetadataCommand.d.ts +40 -0
  117. package/dist-types/ts3.4/commands/GetChallengePasswordCommand.d.ts +40 -0
  118. package/dist-types/ts3.4/commands/GetConnectorCommand.d.ts +36 -0
  119. package/dist-types/ts3.4/commands/ListChallengeMetadataCommand.d.ts +40 -0
  120. package/dist-types/ts3.4/commands/ListConnectorsCommand.d.ts +39 -0
  121. package/dist-types/ts3.4/commands/ListTagsForResourceCommand.d.ts +40 -0
  122. package/dist-types/ts3.4/commands/TagResourceCommand.d.ts +34 -0
  123. package/dist-types/ts3.4/commands/UntagResourceCommand.d.ts +34 -0
  124. package/dist-types/ts3.4/commands/index.d.ts +12 -0
  125. package/dist-types/ts3.4/endpoint/EndpointParameters.d.ts +51 -0
  126. package/dist-types/ts3.4/endpoint/endpointResolver.d.ts +8 -0
  127. package/dist-types/ts3.4/endpoint/ruleset.d.ts +2 -0
  128. package/dist-types/ts3.4/extensionConfiguration.d.ts +9 -0
  129. package/dist-types/ts3.4/index.d.ts +9 -0
  130. package/dist-types/ts3.4/models/PcaConnectorScepServiceException.d.ts +9 -0
  131. package/dist-types/ts3.4/models/index.d.ts +1 -0
  132. package/dist-types/ts3.4/models/models_0.d.ts +257 -0
  133. package/dist-types/ts3.4/pagination/Interfaces.d.ts +6 -0
  134. package/dist-types/ts3.4/pagination/ListChallengeMetadataPaginator.d.ts +11 -0
  135. package/dist-types/ts3.4/pagination/ListConnectorsPaginator.d.ts +11 -0
  136. package/dist-types/ts3.4/pagination/index.d.ts +3 -0
  137. package/dist-types/ts3.4/protocols/Aws_restJson1.d.ts +149 -0
  138. package/dist-types/ts3.4/runtimeConfig.browser.d.ts +87 -0
  139. package/dist-types/ts3.4/runtimeConfig.d.ts +91 -0
  140. package/dist-types/ts3.4/runtimeConfig.native.d.ts +81 -0
  141. package/dist-types/ts3.4/runtimeConfig.shared.d.ts +23 -0
  142. package/dist-types/ts3.4/runtimeExtensions.d.ts +13 -0
  143. package/package.json +103 -0
@@ -0,0 +1,763 @@
1
+ import { ExceptionOptionType as __ExceptionOptionType } from "@smithy/smithy-client";
2
+ import { PcaConnectorScepServiceException as __BaseException } from "./PcaConnectorScepServiceException";
3
+ /**
4
+ * <p>You can receive this error if you attempt to perform an operation and you don't have
5
+ * the required permissions. This can be caused by insufficient permissions in policies
6
+ * attached to your Amazon Web Services Identity and Access Management (IAM) principal. It can also happen
7
+ * because of restrictions in place from an Amazon Web Services Organizations service control policy (SCP)
8
+ * that affects your Amazon Web Services account.</p>
9
+ * @public
10
+ */
11
+ export declare class AccessDeniedException extends __BaseException {
12
+ readonly name: "AccessDeniedException";
13
+ readonly $fault: "client";
14
+ Message: string | undefined;
15
+ /**
16
+ * @internal
17
+ */
18
+ constructor(opts: __ExceptionOptionType<AccessDeniedException, __BaseException>);
19
+ }
20
+ /**
21
+ * <p>The request is malformed or contains an error such as an invalid parameter value or a missing required parameter.</p>
22
+ * @public
23
+ */
24
+ export declare class BadRequestException extends __BaseException {
25
+ readonly name: "BadRequestException";
26
+ readonly $fault: "client";
27
+ Message: string | undefined;
28
+ /**
29
+ * @internal
30
+ */
31
+ constructor(opts: __ExceptionOptionType<BadRequestException, __BaseException>);
32
+ }
33
+ /**
34
+ * <p>For Connector for SCEP for general-purpose. An object containing information about the specified connector's SCEP challenge passwords.</p>
35
+ * @public
36
+ */
37
+ export interface Challenge {
38
+ /**
39
+ * <p>The Amazon Resource Name (ARN) of the challenge.</p>
40
+ * @public
41
+ */
42
+ Arn?: string;
43
+ /**
44
+ * <p>The Amazon Resource Name (ARN) of the connector.</p>
45
+ * @public
46
+ */
47
+ ConnectorArn?: string;
48
+ /**
49
+ * <p>The date and time that the challenge was created.</p>
50
+ * @public
51
+ */
52
+ CreatedAt?: Date;
53
+ /**
54
+ * <p>The date and time that the challenge was updated.</p>
55
+ * @public
56
+ */
57
+ UpdatedAt?: Date;
58
+ /**
59
+ * <p>The SCEP challenge password, in UUID format.</p>
60
+ * @public
61
+ */
62
+ Password?: string;
63
+ }
64
+ /**
65
+ * <p>Contains details about the connector's challenge.</p>
66
+ * @public
67
+ */
68
+ export interface ChallengeMetadata {
69
+ /**
70
+ * <p>The Amazon Resource Name (ARN) of the challenge.</p>
71
+ * @public
72
+ */
73
+ Arn?: string;
74
+ /**
75
+ * <p>The Amazon Resource Name (ARN) of the connector.</p>
76
+ * @public
77
+ */
78
+ ConnectorArn?: string;
79
+ /**
80
+ * <p>The date and time that the connector was created.</p>
81
+ * @public
82
+ */
83
+ CreatedAt?: Date;
84
+ /**
85
+ * <p>The date and time that the connector was updated.</p>
86
+ * @public
87
+ */
88
+ UpdatedAt?: Date;
89
+ }
90
+ /**
91
+ * <p>Details about the specified challenge, returned by the <a href="https://docs.aws.amazon.com/C4SCEP_API/pca-connector-scep/latest/APIReference/API_GetChallengeMetadata.html">GetChallengeMetadata</a> action.</p>
92
+ * @public
93
+ */
94
+ export interface ChallengeMetadataSummary {
95
+ /**
96
+ * <p>The Amazon Resource Name (ARN) of the challenge.</p>
97
+ * @public
98
+ */
99
+ Arn?: string;
100
+ /**
101
+ * <p>The Amazon Resource Name (ARN) of the connector.</p>
102
+ * @public
103
+ */
104
+ ConnectorArn?: string;
105
+ /**
106
+ * <p>The date and time that the challenge was created.</p>
107
+ * @public
108
+ */
109
+ CreatedAt?: Date;
110
+ /**
111
+ * <p>The date and time that the challenge was updated.</p>
112
+ * @public
113
+ */
114
+ UpdatedAt?: Date;
115
+ }
116
+ /**
117
+ * <p>This request can't be completed for one of the following reasons because the requested
118
+ * resource was being concurrently modified by another request.</p>
119
+ * @public
120
+ */
121
+ export declare class ConflictException extends __BaseException {
122
+ readonly name: "ConflictException";
123
+ readonly $fault: "client";
124
+ Message: string | undefined;
125
+ /**
126
+ * <p>The identifier of the Amazon Web Services resource.</p>
127
+ * @public
128
+ */
129
+ ResourceId: string | undefined;
130
+ /**
131
+ * <p>The resource type, which can be either <code>Connector</code> or <code>Challenge</code>.</p>
132
+ * @public
133
+ */
134
+ ResourceType: string | undefined;
135
+ /**
136
+ * @internal
137
+ */
138
+ constructor(opts: __ExceptionOptionType<ConflictException, __BaseException>);
139
+ }
140
+ /**
141
+ * @public
142
+ */
143
+ export interface CreateChallengeRequest {
144
+ /**
145
+ * <p>The Amazon Resource Name (ARN) of the connector that you want to create a challenge for.</p>
146
+ * @public
147
+ */
148
+ ConnectorArn: string | undefined;
149
+ /**
150
+ * <p>Custom string that can be used to distinguish between calls to the <a href="https://docs.aws.amazon.com/C4SCEP_API/pca-connector-scep/latest/APIReference/API_CreateChallenge.html">CreateChallenge</a> action. Client tokens for <code>CreateChallenge</code> time out after five minutes. Therefore, if you call <code>CreateChallenge</code> multiple times with the same client token within five minutes, Connector for SCEP recognizes that you are requesting only one challenge and will only respond with one. If you change the client token for each call, Connector for SCEP recognizes that you are requesting multiple challenge passwords.</p>
151
+ * @public
152
+ */
153
+ ClientToken?: string;
154
+ /**
155
+ * <p>The key-value pairs to associate with the resource.</p>
156
+ * @public
157
+ */
158
+ Tags?: Record<string, string>;
159
+ }
160
+ /**
161
+ * @public
162
+ */
163
+ export interface CreateChallengeResponse {
164
+ /**
165
+ * <p>Returns the challenge details for the specified connector.</p>
166
+ * @public
167
+ */
168
+ Challenge?: Challenge;
169
+ }
170
+ /**
171
+ * <p>The request processing has failed because of an unknown error, exception or failure with
172
+ * an internal server.</p>
173
+ * @public
174
+ */
175
+ export declare class InternalServerException extends __BaseException {
176
+ readonly name: "InternalServerException";
177
+ readonly $fault: "server";
178
+ $retryable: {};
179
+ Message: string | undefined;
180
+ /**
181
+ * @internal
182
+ */
183
+ constructor(opts: __ExceptionOptionType<InternalServerException, __BaseException>);
184
+ }
185
+ /**
186
+ * <p>The operation tried to access a nonexistent resource. The resource might be incorrectly specified, or it might have a status other than <code>ACTIVE</code>.</p>
187
+ * @public
188
+ */
189
+ export declare class ResourceNotFoundException extends __BaseException {
190
+ readonly name: "ResourceNotFoundException";
191
+ readonly $fault: "client";
192
+ Message: string | undefined;
193
+ /**
194
+ * <p>The identifier of the Amazon Web Services resource.</p>
195
+ * @public
196
+ */
197
+ ResourceId: string | undefined;
198
+ /**
199
+ * <p>The resource type, which can be either <code>Connector</code> or <code>Challenge</code>.</p>
200
+ * @public
201
+ */
202
+ ResourceType: string | undefined;
203
+ /**
204
+ * @internal
205
+ */
206
+ constructor(opts: __ExceptionOptionType<ResourceNotFoundException, __BaseException>);
207
+ }
208
+ /**
209
+ * <p>The request would cause a service quota to be exceeded.</p>
210
+ * @public
211
+ */
212
+ export declare class ServiceQuotaExceededException extends __BaseException {
213
+ readonly name: "ServiceQuotaExceededException";
214
+ readonly $fault: "client";
215
+ Message: string | undefined;
216
+ /**
217
+ * <p>The resource type, which can be either <code>Connector</code> or <code>Challenge</code>.</p>
218
+ * @public
219
+ */
220
+ ResourceType: string | undefined;
221
+ /**
222
+ * <p>Identifies the originating service.</p>
223
+ * @public
224
+ */
225
+ ServiceCode: string | undefined;
226
+ /**
227
+ * <p>The quota identifier.</p>
228
+ * @public
229
+ */
230
+ QuotaCode: string | undefined;
231
+ /**
232
+ * @internal
233
+ */
234
+ constructor(opts: __ExceptionOptionType<ServiceQuotaExceededException, __BaseException>);
235
+ }
236
+ /**
237
+ * <p>The limit on the number of requests per second was exceeded.</p>
238
+ * @public
239
+ */
240
+ export declare class ThrottlingException extends __BaseException {
241
+ readonly name: "ThrottlingException";
242
+ readonly $fault: "client";
243
+ $retryable: {
244
+ throttling: boolean;
245
+ };
246
+ Message: string | undefined;
247
+ /**
248
+ * @internal
249
+ */
250
+ constructor(opts: __ExceptionOptionType<ThrottlingException, __BaseException>);
251
+ }
252
+ /**
253
+ * @public
254
+ * @enum
255
+ */
256
+ export declare const ValidationExceptionReason: {
257
+ readonly CA_CERT_VALIDITY_TOO_SHORT: "CA_CERT_VALIDITY_TOO_SHORT";
258
+ readonly INVALID_CA_USAGE_MODE: "INVALID_CA_USAGE_MODE";
259
+ readonly INVALID_CONNECTOR_TYPE: "INVALID_CONNECTOR_TYPE";
260
+ readonly INVALID_STATE: "INVALID_STATE";
261
+ readonly NO_CLIENT_TOKEN: "NO_CLIENT_TOKEN";
262
+ readonly OTHER: "OTHER";
263
+ readonly UNKNOWN_OPERATION: "UNKNOWN_OPERATION";
264
+ };
265
+ /**
266
+ * @public
267
+ */
268
+ export type ValidationExceptionReason = (typeof ValidationExceptionReason)[keyof typeof ValidationExceptionReason];
269
+ /**
270
+ * <p>An input validation error occurred. For example, invalid characters in a name tag, or an invalid pagination token.</p>
271
+ * @public
272
+ */
273
+ export declare class ValidationException extends __BaseException {
274
+ readonly name: "ValidationException";
275
+ readonly $fault: "client";
276
+ Message: string | undefined;
277
+ /**
278
+ * <p>The reason for the validation error, if available. The service doesn't return a reason for every validation exception.</p>
279
+ * @public
280
+ */
281
+ Reason?: ValidationExceptionReason;
282
+ /**
283
+ * @internal
284
+ */
285
+ constructor(opts: __ExceptionOptionType<ValidationException, __BaseException>);
286
+ }
287
+ /**
288
+ * @public
289
+ */
290
+ export interface DeleteChallengeRequest {
291
+ /**
292
+ * <p>The Amazon Resource Name (ARN) of the challenge password to delete.</p>
293
+ * @public
294
+ */
295
+ ChallengeArn: string | undefined;
296
+ }
297
+ /**
298
+ * @public
299
+ */
300
+ export interface GetChallengeMetadataRequest {
301
+ /**
302
+ * <p>The Amazon Resource Name (ARN) of the challenge.</p>
303
+ * @public
304
+ */
305
+ ChallengeArn: string | undefined;
306
+ }
307
+ /**
308
+ * @public
309
+ */
310
+ export interface GetChallengeMetadataResponse {
311
+ /**
312
+ * <p>The metadata for the challenge.</p>
313
+ * @public
314
+ */
315
+ ChallengeMetadata?: ChallengeMetadata;
316
+ }
317
+ /**
318
+ * @public
319
+ */
320
+ export interface GetChallengePasswordRequest {
321
+ /**
322
+ * <p>The Amazon Resource Name (ARN) of the challenge.</p>
323
+ * @public
324
+ */
325
+ ChallengeArn: string | undefined;
326
+ }
327
+ /**
328
+ * @public
329
+ */
330
+ export interface GetChallengePasswordResponse {
331
+ /**
332
+ * <p>The SCEP challenge password.</p>
333
+ * @public
334
+ */
335
+ Password?: string;
336
+ }
337
+ /**
338
+ * @public
339
+ */
340
+ export interface ListChallengeMetadataRequest {
341
+ /**
342
+ * <p>The maximum number of objects that you want Connector for SCEP to return for this request. If more
343
+ * objects are available, in the response, Connector for SCEP provides a
344
+ * <code>NextToken</code> value that you can use in a subsequent call to get the next batch of objects.</p>
345
+ * @public
346
+ */
347
+ MaxResults?: number;
348
+ /**
349
+ * <p>When you request a list of objects with a <code>MaxResults</code> setting, if the number of objects that are still available
350
+ * for retrieval exceeds the maximum you requested, Connector for SCEP returns a <code>NextToken</code>
351
+ * value in the response. To retrieve the next batch of objects, use the token returned from the prior request in your next request.</p>
352
+ * @public
353
+ */
354
+ NextToken?: string;
355
+ /**
356
+ * <p>The Amazon Resource Name (ARN) of the connector.</p>
357
+ * @public
358
+ */
359
+ ConnectorArn: string | undefined;
360
+ }
361
+ /**
362
+ * @public
363
+ */
364
+ export interface ListChallengeMetadataResponse {
365
+ /**
366
+ * <p>The challenge metadata for the challenges belonging to your Amazon Web Services account.</p>
367
+ * @public
368
+ */
369
+ Challenges?: ChallengeMetadataSummary[];
370
+ /**
371
+ * <p>When you request a list of objects with a <code>MaxResults</code> setting, if the number of objects that are still available
372
+ * for retrieval exceeds the maximum you requested, Connector for SCEP returns a <code>NextToken</code>
373
+ * value in the response. To retrieve the next batch of objects, use the token returned from the prior request in your next request.</p>
374
+ * @public
375
+ */
376
+ NextToken?: string;
377
+ }
378
+ /**
379
+ * <p>Contains configuration details for use with Microsoft Intune. For information about using Connector for SCEP for Microsoft Intune, see <a href="https://docs.aws.amazon.com/privateca/latest/userguide/scep-connector.htmlconnector-for-scep-intune.html">Using Connector for SCEP for Microsoft Intune</a>.</p>
380
+ * <p>When you use Connector for SCEP for Microsoft Intune, certain functionalities are enabled by accessing Microsoft Intune through the Microsoft API. Your use of the Connector for SCEP and accompanying Amazon Web Services services doesn't remove your need to have a valid license for your use of the Microsoft Intune service. You should also review the <a href="https://learn.microsoft.com/en-us/mem/intune/apps/app-protection-policy">Microsoft Intune® App Protection Policies</a>.</p>
381
+ * @public
382
+ */
383
+ export interface IntuneConfiguration {
384
+ /**
385
+ * <p>The directory (tenant) ID from your Microsoft Entra ID app registration.</p>
386
+ * @public
387
+ */
388
+ AzureApplicationId: string | undefined;
389
+ /**
390
+ * <p>The primary domain from your Microsoft Entra ID app registration.</p>
391
+ * @public
392
+ */
393
+ Domain: string | undefined;
394
+ }
395
+ /**
396
+ * <p>If you don't supply a value, by default Connector for SCEP creates a connector for general-purpose use. A general-purpose connector is designed to work with clients or endpoints that support the SCEP protocol, except Connector for SCEP for Microsoft Intune. For information about considerations and limitations with using Connector for SCEP, see <a href="https://docs.aws.amazon.com/privateca/latest/userguide/scep-connector.htmlc4scep-considerations-limitations.html">Considerations and Limitations</a>.</p>
397
+ * <p>If you provide an <code>IntuneConfiguration</code>, Connector for SCEP creates a connector for use with Microsoft Intune, and you manage the challenge passwords using Microsoft Intune. For more information, see <a href="https://docs.aws.amazon.com/privateca/latest/userguide/scep-connector.htmlconnector-for-scep-intune.html">Using Connector for SCEP for Microsoft Intune</a>.</p>
398
+ * @public
399
+ */
400
+ export type MobileDeviceManagement = MobileDeviceManagement.IntuneMember | MobileDeviceManagement.$UnknownMember;
401
+ /**
402
+ * @public
403
+ */
404
+ export declare namespace MobileDeviceManagement {
405
+ /**
406
+ * <p>Configuration settings for use with Microsoft Intune. For information about using Connector for SCEP for Microsoft Intune, see <a href="https://docs.aws.amazon.com/privateca/latest/userguide/scep-connector.htmlconnector-for-scep-intune.html">Using Connector for SCEP for Microsoft Intune</a>.</p>
407
+ * @public
408
+ */
409
+ interface IntuneMember {
410
+ Intune: IntuneConfiguration;
411
+ $unknown?: never;
412
+ }
413
+ /**
414
+ * @public
415
+ */
416
+ interface $UnknownMember {
417
+ Intune?: never;
418
+ $unknown: [string, any];
419
+ }
420
+ interface Visitor<T> {
421
+ Intune: (value: IntuneConfiguration) => T;
422
+ _: (name: string, value: any) => T;
423
+ }
424
+ const visit: <T>(value: MobileDeviceManagement, visitor: Visitor<T>) => T;
425
+ }
426
+ /**
427
+ * <p>Contains OpenID Connect (OIDC) parameters for use with Microsoft Intune. For more information about using Connector for SCEP for Microsoft Intune, see <a href="https://docs.aws.amazon.com/privateca/latest/userguide/scep-connector.htmlconnector-for-scep-intune.html">Using Connector for SCEP for Microsoft Intune</a>.</p>
428
+ * @public
429
+ */
430
+ export interface OpenIdConfiguration {
431
+ /**
432
+ * <p>The issuer value to copy into your Microsoft Entra app registration's OIDC.</p>
433
+ * @public
434
+ */
435
+ Issuer?: string;
436
+ /**
437
+ * <p>The subject value to copy into your Microsoft Entra app registration's OIDC.</p>
438
+ * @public
439
+ */
440
+ Subject?: string;
441
+ /**
442
+ * <p>The audience value to copy into your Microsoft Entra app registration's OIDC.</p>
443
+ * @public
444
+ */
445
+ Audience?: string;
446
+ }
447
+ /**
448
+ * @public
449
+ * @enum
450
+ */
451
+ export declare const ConnectorStatus: {
452
+ readonly ACTIVE: "ACTIVE";
453
+ readonly CREATING: "CREATING";
454
+ readonly DELETING: "DELETING";
455
+ readonly FAILED: "FAILED";
456
+ };
457
+ /**
458
+ * @public
459
+ */
460
+ export type ConnectorStatus = (typeof ConnectorStatus)[keyof typeof ConnectorStatus];
461
+ /**
462
+ * @public
463
+ * @enum
464
+ */
465
+ export declare const ConnectorStatusReason: {
466
+ readonly INTERNAL_FAILURE: "INTERNAL_FAILURE";
467
+ readonly PRIVATECA_ACCESS_DENIED: "PRIVATECA_ACCESS_DENIED";
468
+ readonly PRIVATECA_INVALID_STATE: "PRIVATECA_INVALID_STATE";
469
+ readonly PRIVATECA_RESOURCE_NOT_FOUND: "PRIVATECA_RESOURCE_NOT_FOUND";
470
+ };
471
+ /**
472
+ * @public
473
+ */
474
+ export type ConnectorStatusReason = (typeof ConnectorStatusReason)[keyof typeof ConnectorStatusReason];
475
+ /**
476
+ * @public
477
+ * @enum
478
+ */
479
+ export declare const ConnectorType: {
480
+ readonly GENERAL_PURPOSE: "GENERAL_PURPOSE";
481
+ readonly INTUNE: "INTUNE";
482
+ };
483
+ /**
484
+ * @public
485
+ */
486
+ export type ConnectorType = (typeof ConnectorType)[keyof typeof ConnectorType];
487
+ /**
488
+ * <p>Connector for SCEP is a service that links Amazon Web Services Private Certificate Authority to your SCEP-enabled devices. The connector brokers the exchange of certificates from Amazon Web Services Private CA to your SCEP-enabled devices and mobile device management systems. The connector is a complex type that contains the connector's configuration settings.</p>
489
+ * @public
490
+ */
491
+ export interface Connector {
492
+ /**
493
+ * <p>The Amazon Resource Name (ARN) of the connector.</p>
494
+ * @public
495
+ */
496
+ Arn?: string;
497
+ /**
498
+ * <p>The Amazon Resource Name (ARN) of the certificate authority associated with the connector.</p>
499
+ * @public
500
+ */
501
+ CertificateAuthorityArn?: string;
502
+ /**
503
+ * <p>The connector type.</p>
504
+ * @public
505
+ */
506
+ Type?: ConnectorType;
507
+ /**
508
+ * <p>Contains settings relevant to the mobile device management system that you chose for the connector. If you didn't configure <code>MobileDeviceManagement</code>, then the connector is for general-purpose use and this object is empty.</p>
509
+ * @public
510
+ */
511
+ MobileDeviceManagement?: MobileDeviceManagement;
512
+ /**
513
+ * <p>Contains OpenID Connect (OIDC) parameters for use with Connector for SCEP for Microsoft Intune. For more information about using Connector for SCEP for Microsoft Intune, see <a href="https://docs.aws.amazon.com/privateca/latest/userguide/scep-connector.htmlconnector-for-scep-intune.html">Using Connector for SCEP for Microsoft Intune</a>.</p>
514
+ * @public
515
+ */
516
+ OpenIdConfiguration?: OpenIdConfiguration;
517
+ /**
518
+ * <p>The connector's status.</p>
519
+ * @public
520
+ */
521
+ Status?: ConnectorStatus;
522
+ /**
523
+ * <p>Information about why connector creation failed, if status is <code>FAILED</code>.</p>
524
+ * @public
525
+ */
526
+ StatusReason?: ConnectorStatusReason;
527
+ /**
528
+ * <p>The connector's HTTPS public SCEP URL.</p>
529
+ * @public
530
+ */
531
+ Endpoint?: string;
532
+ /**
533
+ * <p>The date and time that the connector was created.</p>
534
+ * @public
535
+ */
536
+ CreatedAt?: Date;
537
+ /**
538
+ * <p>The date and time that the connector was updated.</p>
539
+ * @public
540
+ */
541
+ UpdatedAt?: Date;
542
+ }
543
+ /**
544
+ * <p>Lists the Amazon Web Services Private CA SCEP connectors belonging to your Amazon Web Services account.</p>
545
+ * @public
546
+ */
547
+ export interface ConnectorSummary {
548
+ /**
549
+ * <p>The Amazon Resource Name (ARN) of the connector.</p>
550
+ * @public
551
+ */
552
+ Arn?: string;
553
+ /**
554
+ * <p>The Amazon Resource Name (ARN) of the connector's associated certificate authority.</p>
555
+ * @public
556
+ */
557
+ CertificateAuthorityArn?: string;
558
+ /**
559
+ * <p>The connector type.</p>
560
+ * @public
561
+ */
562
+ Type?: ConnectorType;
563
+ /**
564
+ * <p>Contains settings relevant to the mobile device management system that you chose for the connector. If you didn't configure <code>MobileDeviceManagement</code>, then the connector is for general-purpose use and this object is empty.</p>
565
+ * @public
566
+ */
567
+ MobileDeviceManagement?: MobileDeviceManagement;
568
+ /**
569
+ * <p>Contains OpenID Connect (OIDC) parameters for use with Microsoft Intune.</p>
570
+ * @public
571
+ */
572
+ OpenIdConfiguration?: OpenIdConfiguration;
573
+ /**
574
+ * <p>The connector's status. Status can be creating, active, deleting, or failed.</p>
575
+ * @public
576
+ */
577
+ Status?: ConnectorStatus;
578
+ /**
579
+ * <p>Information about why connector creation failed, if status is <code>FAILED</code>.</p>
580
+ * @public
581
+ */
582
+ StatusReason?: ConnectorStatusReason;
583
+ /**
584
+ * <p>The connector's HTTPS public SCEP URL.</p>
585
+ * @public
586
+ */
587
+ Endpoint?: string;
588
+ /**
589
+ * <p>The date and time that the challenge was created.</p>
590
+ * @public
591
+ */
592
+ CreatedAt?: Date;
593
+ /**
594
+ * <p>The date and time that the challenge was updated.</p>
595
+ * @public
596
+ */
597
+ UpdatedAt?: Date;
598
+ }
599
+ /**
600
+ * @public
601
+ */
602
+ export interface CreateConnectorRequest {
603
+ /**
604
+ * <p>The Amazon Resource Name (ARN) of the Amazon Web Services Private Certificate Authority certificate authority to use with this connector. Due to security vulnerabilities present in the SCEP protocol, we recommend using a private CA that's dedicated for use with the connector.</p>
605
+ * <p>To retrieve the private CAs associated with your account, you can call <a href="https://docs.aws.amazon.com/privateca/latest/APIReference/API_ListCertificateAuthorities.html">ListCertificateAuthorities</a> using the Amazon Web Services Private CA API.</p>
606
+ * @public
607
+ */
608
+ CertificateAuthorityArn: string | undefined;
609
+ /**
610
+ * <p>If you don't supply a value, by default Connector for SCEP creates a connector for general-purpose use. A general-purpose connector is designed to work with clients or endpoints that support the SCEP protocol, except Connector for SCEP for Microsoft Intune. With connectors for general-purpose use, you manage SCEP challenge passwords using Connector for SCEP. For information about considerations and limitations with using Connector for SCEP, see <a href="https://docs.aws.amazon.com/privateca/latest/userguide/scep-connector.htmlc4scep-considerations-limitations.html">Considerations and Limitations</a>.</p>
611
+ * <p>If you provide an <code>IntuneConfiguration</code>, Connector for SCEP creates a connector for use with Microsoft Intune, and you manage the challenge passwords using Microsoft Intune. For more information, see <a href="https://docs.aws.amazon.com/privateca/latest/userguide/scep-connector.htmlconnector-for-scep-intune.html">Using Connector for SCEP for Microsoft Intune</a>.</p>
612
+ * @public
613
+ */
614
+ MobileDeviceManagement?: MobileDeviceManagement;
615
+ /**
616
+ * <p>Custom string that can be used to distinguish between calls to the <a href="https://docs.aws.amazon.com/C4SCEP_API/pca-connector-scep/latest/APIReference/API_CreateChallenge.html">CreateChallenge</a> action. Client tokens for <code>CreateChallenge</code> time out after five minutes. Therefore, if you call <code>CreateChallenge</code> multiple times with the same client token within five minutes, Connector for SCEP recognizes that you are requesting only one challenge and will only respond with one. If you change the client token for each call, Connector for SCEP recognizes that you are requesting multiple challenge passwords.</p>
617
+ * @public
618
+ */
619
+ ClientToken?: string;
620
+ /**
621
+ * <p>The key-value pairs to associate with the resource.</p>
622
+ * @public
623
+ */
624
+ Tags?: Record<string, string>;
625
+ }
626
+ /**
627
+ * @public
628
+ */
629
+ export interface CreateConnectorResponse {
630
+ /**
631
+ * <p>Returns the Amazon Resource Name (ARN) of the connector.</p>
632
+ * @public
633
+ */
634
+ ConnectorArn?: string;
635
+ }
636
+ /**
637
+ * @public
638
+ */
639
+ export interface DeleteConnectorRequest {
640
+ /**
641
+ * <p>The Amazon Resource Name (ARN) of the connector to delete.</p>
642
+ * @public
643
+ */
644
+ ConnectorArn: string | undefined;
645
+ }
646
+ /**
647
+ * @public
648
+ */
649
+ export interface GetConnectorRequest {
650
+ /**
651
+ * <p>The Amazon Resource Name (ARN) of the connector.</p>
652
+ * @public
653
+ */
654
+ ConnectorArn: string | undefined;
655
+ }
656
+ /**
657
+ * @public
658
+ */
659
+ export interface GetConnectorResponse {
660
+ /**
661
+ * <p>The properties of the connector.</p>
662
+ * @public
663
+ */
664
+ Connector?: Connector;
665
+ }
666
+ /**
667
+ * @public
668
+ */
669
+ export interface ListConnectorsRequest {
670
+ /**
671
+ * <p>The maximum number of objects that you want Connector for SCEP to return for this request. If more
672
+ * objects are available, in the response, Connector for SCEP provides a
673
+ * <code>NextToken</code> value that you can use in a subsequent call to get the next batch of objects.</p>
674
+ * @public
675
+ */
676
+ MaxResults?: number;
677
+ /**
678
+ * <p>When you request a list of objects with a <code>MaxResults</code> setting, if the number of objects that are still available
679
+ * for retrieval exceeds the maximum you requested, Connector for SCEP returns a <code>NextToken</code>
680
+ * value in the response. To retrieve the next batch of objects, use the token returned from the prior request in your next request.</p>
681
+ * @public
682
+ */
683
+ NextToken?: string;
684
+ }
685
+ /**
686
+ * @public
687
+ */
688
+ export interface ListConnectorsResponse {
689
+ /**
690
+ * <p>The connectors belonging to your Amazon Web Services account.</p>
691
+ * @public
692
+ */
693
+ Connectors?: ConnectorSummary[];
694
+ /**
695
+ * <p>When you request a list of objects with a <code>MaxResults</code> setting, if the number of objects that are still available
696
+ * for retrieval exceeds the maximum you requested, Connector for SCEP returns a <code>NextToken</code>
697
+ * value in the response. To retrieve the next batch of objects, use the token returned from the prior request in your next request.</p>
698
+ * @public
699
+ */
700
+ NextToken?: string;
701
+ }
702
+ /**
703
+ * @public
704
+ */
705
+ export interface ListTagsForResourceRequest {
706
+ /**
707
+ * <p>The Amazon Resource Name (ARN) of the resource.</p>
708
+ * @public
709
+ */
710
+ ResourceArn: string | undefined;
711
+ }
712
+ /**
713
+ * @public
714
+ */
715
+ export interface ListTagsForResourceResponse {
716
+ /**
717
+ * <p>The key-value pairs to associate with the resource.</p>
718
+ * @public
719
+ */
720
+ Tags?: Record<string, string>;
721
+ }
722
+ /**
723
+ * @public
724
+ */
725
+ export interface TagResourceRequest {
726
+ /**
727
+ * <p>The Amazon Resource Name (ARN) of the resource.</p>
728
+ * @public
729
+ */
730
+ ResourceArn: string | undefined;
731
+ /**
732
+ * <p>The key-value pairs to associate with the resource.</p>
733
+ * @public
734
+ */
735
+ Tags: Record<string, string> | undefined;
736
+ }
737
+ /**
738
+ * @public
739
+ */
740
+ export interface UntagResourceRequest {
741
+ /**
742
+ * <p>The Amazon Resource Name (ARN) of the resource.</p>
743
+ * @public
744
+ */
745
+ ResourceArn: string | undefined;
746
+ /**
747
+ * <p>Specifies a list of tag keys that you want to remove from the specified resources.</p>
748
+ * @public
749
+ */
750
+ TagKeys: string[] | undefined;
751
+ }
752
+ /**
753
+ * @internal
754
+ */
755
+ export declare const ChallengeFilterSensitiveLog: (obj: Challenge) => any;
756
+ /**
757
+ * @internal
758
+ */
759
+ export declare const CreateChallengeResponseFilterSensitiveLog: (obj: CreateChallengeResponse) => any;
760
+ /**
761
+ * @internal
762
+ */
763
+ export declare const GetChallengePasswordResponseFilterSensitiveLog: (obj: GetChallengePasswordResponse) => any;