aws-sdk-pcaconnectorscep 1.0.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.
- checksums.yaml +7 -0
- data/CHANGELOG.md +8 -0
- data/LICENSE.txt +202 -0
- data/VERSION +1 -0
- data/lib/aws-sdk-pcaconnectorscep/client.rb +983 -0
- data/lib/aws-sdk-pcaconnectorscep/client_api.rb +437 -0
- data/lib/aws-sdk-pcaconnectorscep/customizations.rb +0 -0
- data/lib/aws-sdk-pcaconnectorscep/endpoint_parameters.rb +66 -0
- data/lib/aws-sdk-pcaconnectorscep/endpoint_provider.rb +54 -0
- data/lib/aws-sdk-pcaconnectorscep/endpoints.rb +184 -0
- data/lib/aws-sdk-pcaconnectorscep/errors.rb +218 -0
- data/lib/aws-sdk-pcaconnectorscep/plugins/endpoints.rb +94 -0
- data/lib/aws-sdk-pcaconnectorscep/resource.rb +26 -0
- data/lib/aws-sdk-pcaconnectorscep/types.rb +907 -0
- data/lib/aws-sdk-pcaconnectorscep/waiters.rb +15 -0
- data/lib/aws-sdk-pcaconnectorscep.rb +58 -0
- data/sig/client.rbs +198 -0
- data/sig/errors.rbs +48 -0
- data/sig/resource.rbs +79 -0
- data/sig/types.rbs +248 -0
- data/sig/waiters.rbs +13 -0
- metadata +100 -0
@@ -0,0 +1,907 @@
|
|
1
|
+
# frozen_string_literal: true
|
2
|
+
|
3
|
+
# WARNING ABOUT GENERATED CODE
|
4
|
+
#
|
5
|
+
# This file is generated. See the contributing guide for more information:
|
6
|
+
# https://github.com/aws/aws-sdk-ruby/blob/version-3/CONTRIBUTING.md
|
7
|
+
#
|
8
|
+
# WARNING ABOUT GENERATED CODE
|
9
|
+
|
10
|
+
module Aws::PcaConnectorScep
|
11
|
+
module Types
|
12
|
+
|
13
|
+
# You can receive this error if you attempt to perform an operation and
|
14
|
+
# you don't have the required permissions. This can be caused by
|
15
|
+
# insufficient permissions in policies attached to your Amazon Web
|
16
|
+
# Services Identity and Access Management (IAM) principal. It can also
|
17
|
+
# happen because of restrictions in place from an Amazon Web Services
|
18
|
+
# Organizations service control policy (SCP) that affects your Amazon
|
19
|
+
# Web Services account.
|
20
|
+
#
|
21
|
+
# @!attribute [rw] message
|
22
|
+
# @return [String]
|
23
|
+
#
|
24
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/pca-connector-scep-2018-05-10/AccessDeniedException AWS API Documentation
|
25
|
+
#
|
26
|
+
class AccessDeniedException < Struct.new(
|
27
|
+
:message)
|
28
|
+
SENSITIVE = []
|
29
|
+
include Aws::Structure
|
30
|
+
end
|
31
|
+
|
32
|
+
# The request is malformed or contains an error such as an invalid
|
33
|
+
# parameter value or a missing required parameter.
|
34
|
+
#
|
35
|
+
# @!attribute [rw] message
|
36
|
+
# @return [String]
|
37
|
+
#
|
38
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/pca-connector-scep-2018-05-10/BadRequestException AWS API Documentation
|
39
|
+
#
|
40
|
+
class BadRequestException < Struct.new(
|
41
|
+
:message)
|
42
|
+
SENSITIVE = []
|
43
|
+
include Aws::Structure
|
44
|
+
end
|
45
|
+
|
46
|
+
# For Connector for SCEP for general-purpose. An object containing
|
47
|
+
# information about the specified connector's SCEP challenge passwords.
|
48
|
+
#
|
49
|
+
# @!attribute [rw] arn
|
50
|
+
# The Amazon Resource Name (ARN) of the challenge.
|
51
|
+
# @return [String]
|
52
|
+
#
|
53
|
+
# @!attribute [rw] connector_arn
|
54
|
+
# The Amazon Resource Name (ARN) of the connector.
|
55
|
+
# @return [String]
|
56
|
+
#
|
57
|
+
# @!attribute [rw] created_at
|
58
|
+
# The date and time that the challenge was created.
|
59
|
+
# @return [Time]
|
60
|
+
#
|
61
|
+
# @!attribute [rw] updated_at
|
62
|
+
# The date and time that the challenge was updated.
|
63
|
+
# @return [Time]
|
64
|
+
#
|
65
|
+
# @!attribute [rw] password
|
66
|
+
# The SCEP challenge password, in UUID format.
|
67
|
+
# @return [String]
|
68
|
+
#
|
69
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/pca-connector-scep-2018-05-10/Challenge AWS API Documentation
|
70
|
+
#
|
71
|
+
class Challenge < Struct.new(
|
72
|
+
:arn,
|
73
|
+
:connector_arn,
|
74
|
+
:created_at,
|
75
|
+
:updated_at,
|
76
|
+
:password)
|
77
|
+
SENSITIVE = [:password]
|
78
|
+
include Aws::Structure
|
79
|
+
end
|
80
|
+
|
81
|
+
# Contains details about the connector's challenge.
|
82
|
+
#
|
83
|
+
# @!attribute [rw] arn
|
84
|
+
# The Amazon Resource Name (ARN) of the challenge.
|
85
|
+
# @return [String]
|
86
|
+
#
|
87
|
+
# @!attribute [rw] connector_arn
|
88
|
+
# The Amazon Resource Name (ARN) of the connector.
|
89
|
+
# @return [String]
|
90
|
+
#
|
91
|
+
# @!attribute [rw] created_at
|
92
|
+
# The date and time that the connector was created.
|
93
|
+
# @return [Time]
|
94
|
+
#
|
95
|
+
# @!attribute [rw] updated_at
|
96
|
+
# The date and time that the connector was updated.
|
97
|
+
# @return [Time]
|
98
|
+
#
|
99
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/pca-connector-scep-2018-05-10/ChallengeMetadata AWS API Documentation
|
100
|
+
#
|
101
|
+
class ChallengeMetadata < Struct.new(
|
102
|
+
:arn,
|
103
|
+
:connector_arn,
|
104
|
+
:created_at,
|
105
|
+
:updated_at)
|
106
|
+
SENSITIVE = []
|
107
|
+
include Aws::Structure
|
108
|
+
end
|
109
|
+
|
110
|
+
# Details about the specified challenge, returned by the
|
111
|
+
# [GetChallengeMetadata][1] action.
|
112
|
+
#
|
113
|
+
#
|
114
|
+
#
|
115
|
+
# [1]: https://docs.aws.amazon.com/C4SCEP_API/pca-connector-scep/latest/APIReference/API_GetChallengeMetadata.html
|
116
|
+
#
|
117
|
+
# @!attribute [rw] arn
|
118
|
+
# The Amazon Resource Name (ARN) of the challenge.
|
119
|
+
# @return [String]
|
120
|
+
#
|
121
|
+
# @!attribute [rw] connector_arn
|
122
|
+
# The Amazon Resource Name (ARN) of the connector.
|
123
|
+
# @return [String]
|
124
|
+
#
|
125
|
+
# @!attribute [rw] created_at
|
126
|
+
# The date and time that the challenge was created.
|
127
|
+
# @return [Time]
|
128
|
+
#
|
129
|
+
# @!attribute [rw] updated_at
|
130
|
+
# The date and time that the challenge was updated.
|
131
|
+
# @return [Time]
|
132
|
+
#
|
133
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/pca-connector-scep-2018-05-10/ChallengeMetadataSummary AWS API Documentation
|
134
|
+
#
|
135
|
+
class ChallengeMetadataSummary < Struct.new(
|
136
|
+
:arn,
|
137
|
+
:connector_arn,
|
138
|
+
:created_at,
|
139
|
+
:updated_at)
|
140
|
+
SENSITIVE = []
|
141
|
+
include Aws::Structure
|
142
|
+
end
|
143
|
+
|
144
|
+
# This request can't be completed for one of the following reasons
|
145
|
+
# because the requested resource was being concurrently modified by
|
146
|
+
# another request.
|
147
|
+
#
|
148
|
+
# @!attribute [rw] message
|
149
|
+
# @return [String]
|
150
|
+
#
|
151
|
+
# @!attribute [rw] resource_id
|
152
|
+
# The identifier of the Amazon Web Services resource.
|
153
|
+
# @return [String]
|
154
|
+
#
|
155
|
+
# @!attribute [rw] resource_type
|
156
|
+
# The resource type, which can be either `Connector` or `Challenge`.
|
157
|
+
# @return [String]
|
158
|
+
#
|
159
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/pca-connector-scep-2018-05-10/ConflictException AWS API Documentation
|
160
|
+
#
|
161
|
+
class ConflictException < Struct.new(
|
162
|
+
:message,
|
163
|
+
:resource_id,
|
164
|
+
:resource_type)
|
165
|
+
SENSITIVE = []
|
166
|
+
include Aws::Structure
|
167
|
+
end
|
168
|
+
|
169
|
+
# Connector for SCEP is a service that links Amazon Web Services Private
|
170
|
+
# Certificate Authority to your SCEP-enabled devices. The connector
|
171
|
+
# brokers the exchange of certificates from Amazon Web Services Private
|
172
|
+
# CA to your SCEP-enabled devices and mobile device management systems.
|
173
|
+
# The connector is a complex type that contains the connector's
|
174
|
+
# configuration settings.
|
175
|
+
#
|
176
|
+
# @!attribute [rw] arn
|
177
|
+
# The Amazon Resource Name (ARN) of the connector.
|
178
|
+
# @return [String]
|
179
|
+
#
|
180
|
+
# @!attribute [rw] certificate_authority_arn
|
181
|
+
# The Amazon Resource Name (ARN) of the certificate authority
|
182
|
+
# associated with the connector.
|
183
|
+
# @return [String]
|
184
|
+
#
|
185
|
+
# @!attribute [rw] type
|
186
|
+
# The connector type.
|
187
|
+
# @return [String]
|
188
|
+
#
|
189
|
+
# @!attribute [rw] mobile_device_management
|
190
|
+
# Contains settings relevant to the mobile device management system
|
191
|
+
# that you chose for the connector. If you didn't configure
|
192
|
+
# `MobileDeviceManagement`, then the connector is for general-purpose
|
193
|
+
# use and this object is empty.
|
194
|
+
# @return [Types::MobileDeviceManagement]
|
195
|
+
#
|
196
|
+
# @!attribute [rw] open_id_configuration
|
197
|
+
# Contains OpenID Connect (OIDC) parameters for use with Connector for
|
198
|
+
# SCEP for Microsoft Intune. For more information about using
|
199
|
+
# Connector for SCEP for Microsoft Intune, see [Using Connector for
|
200
|
+
# SCEP for Microsoft Intune][1].
|
201
|
+
#
|
202
|
+
#
|
203
|
+
#
|
204
|
+
# [1]: https://docs.aws.amazon.com/privateca/latest/userguide/scep-connector.htmlconnector-for-scep-intune.html
|
205
|
+
# @return [Types::OpenIdConfiguration]
|
206
|
+
#
|
207
|
+
# @!attribute [rw] status
|
208
|
+
# The connector's status.
|
209
|
+
# @return [String]
|
210
|
+
#
|
211
|
+
# @!attribute [rw] status_reason
|
212
|
+
# Information about why connector creation failed, if status is
|
213
|
+
# `FAILED`.
|
214
|
+
# @return [String]
|
215
|
+
#
|
216
|
+
# @!attribute [rw] endpoint
|
217
|
+
# The connector's HTTPS public SCEP URL.
|
218
|
+
# @return [String]
|
219
|
+
#
|
220
|
+
# @!attribute [rw] created_at
|
221
|
+
# The date and time that the connector was created.
|
222
|
+
# @return [Time]
|
223
|
+
#
|
224
|
+
# @!attribute [rw] updated_at
|
225
|
+
# The date and time that the connector was updated.
|
226
|
+
# @return [Time]
|
227
|
+
#
|
228
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/pca-connector-scep-2018-05-10/Connector AWS API Documentation
|
229
|
+
#
|
230
|
+
class Connector < Struct.new(
|
231
|
+
:arn,
|
232
|
+
:certificate_authority_arn,
|
233
|
+
:type,
|
234
|
+
:mobile_device_management,
|
235
|
+
:open_id_configuration,
|
236
|
+
:status,
|
237
|
+
:status_reason,
|
238
|
+
:endpoint,
|
239
|
+
:created_at,
|
240
|
+
:updated_at)
|
241
|
+
SENSITIVE = []
|
242
|
+
include Aws::Structure
|
243
|
+
end
|
244
|
+
|
245
|
+
# Lists the Amazon Web Services Private CA SCEP connectors belonging to
|
246
|
+
# your Amazon Web Services account.
|
247
|
+
#
|
248
|
+
# @!attribute [rw] arn
|
249
|
+
# The Amazon Resource Name (ARN) of the connector.
|
250
|
+
# @return [String]
|
251
|
+
#
|
252
|
+
# @!attribute [rw] certificate_authority_arn
|
253
|
+
# The Amazon Resource Name (ARN) of the connector's associated
|
254
|
+
# certificate authority.
|
255
|
+
# @return [String]
|
256
|
+
#
|
257
|
+
# @!attribute [rw] type
|
258
|
+
# The connector type.
|
259
|
+
# @return [String]
|
260
|
+
#
|
261
|
+
# @!attribute [rw] mobile_device_management
|
262
|
+
# Contains settings relevant to the mobile device management system
|
263
|
+
# that you chose for the connector. If you didn't configure
|
264
|
+
# `MobileDeviceManagement`, then the connector is for general-purpose
|
265
|
+
# use and this object is empty.
|
266
|
+
# @return [Types::MobileDeviceManagement]
|
267
|
+
#
|
268
|
+
# @!attribute [rw] open_id_configuration
|
269
|
+
# Contains OpenID Connect (OIDC) parameters for use with Microsoft
|
270
|
+
# Intune.
|
271
|
+
# @return [Types::OpenIdConfiguration]
|
272
|
+
#
|
273
|
+
# @!attribute [rw] status
|
274
|
+
# The connector's status. Status can be creating, active, deleting,
|
275
|
+
# or failed.
|
276
|
+
# @return [String]
|
277
|
+
#
|
278
|
+
# @!attribute [rw] status_reason
|
279
|
+
# Information about why connector creation failed, if status is
|
280
|
+
# `FAILED`.
|
281
|
+
# @return [String]
|
282
|
+
#
|
283
|
+
# @!attribute [rw] endpoint
|
284
|
+
# The connector's HTTPS public SCEP URL.
|
285
|
+
# @return [String]
|
286
|
+
#
|
287
|
+
# @!attribute [rw] created_at
|
288
|
+
# The date and time that the challenge was created.
|
289
|
+
# @return [Time]
|
290
|
+
#
|
291
|
+
# @!attribute [rw] updated_at
|
292
|
+
# The date and time that the challenge was updated.
|
293
|
+
# @return [Time]
|
294
|
+
#
|
295
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/pca-connector-scep-2018-05-10/ConnectorSummary AWS API Documentation
|
296
|
+
#
|
297
|
+
class ConnectorSummary < Struct.new(
|
298
|
+
:arn,
|
299
|
+
:certificate_authority_arn,
|
300
|
+
:type,
|
301
|
+
:mobile_device_management,
|
302
|
+
:open_id_configuration,
|
303
|
+
:status,
|
304
|
+
:status_reason,
|
305
|
+
:endpoint,
|
306
|
+
:created_at,
|
307
|
+
:updated_at)
|
308
|
+
SENSITIVE = []
|
309
|
+
include Aws::Structure
|
310
|
+
end
|
311
|
+
|
312
|
+
# @!attribute [rw] connector_arn
|
313
|
+
# The Amazon Resource Name (ARN) of the connector that you want to
|
314
|
+
# create a challenge for.
|
315
|
+
# @return [String]
|
316
|
+
#
|
317
|
+
# @!attribute [rw] client_token
|
318
|
+
# Custom string that can be used to distinguish between calls to the
|
319
|
+
# [CreateChallenge][1] action. Client tokens for `CreateChallenge`
|
320
|
+
# time out after five minutes. Therefore, if you call
|
321
|
+
# `CreateChallenge` multiple times with the same client token within
|
322
|
+
# five minutes, Connector for SCEP recognizes that you are requesting
|
323
|
+
# only one challenge and will only respond with one. If you change the
|
324
|
+
# client token for each call, Connector for SCEP recognizes that you
|
325
|
+
# are requesting multiple challenge passwords.
|
326
|
+
#
|
327
|
+
# **A suitable default value is auto-generated.** You should normally
|
328
|
+
# not need to pass this option.
|
329
|
+
#
|
330
|
+
#
|
331
|
+
#
|
332
|
+
# [1]: https://docs.aws.amazon.com/C4SCEP_API/pca-connector-scep/latest/APIReference/API_CreateChallenge.html
|
333
|
+
# @return [String]
|
334
|
+
#
|
335
|
+
# @!attribute [rw] tags
|
336
|
+
# The key-value pairs to associate with the resource.
|
337
|
+
# @return [Hash<String,String>]
|
338
|
+
#
|
339
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/pca-connector-scep-2018-05-10/CreateChallengeRequest AWS API Documentation
|
340
|
+
#
|
341
|
+
class CreateChallengeRequest < Struct.new(
|
342
|
+
:connector_arn,
|
343
|
+
:client_token,
|
344
|
+
:tags)
|
345
|
+
SENSITIVE = []
|
346
|
+
include Aws::Structure
|
347
|
+
end
|
348
|
+
|
349
|
+
# @!attribute [rw] challenge
|
350
|
+
# Returns the challenge details for the specified connector.
|
351
|
+
# @return [Types::Challenge]
|
352
|
+
#
|
353
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/pca-connector-scep-2018-05-10/CreateChallengeResponse AWS API Documentation
|
354
|
+
#
|
355
|
+
class CreateChallengeResponse < Struct.new(
|
356
|
+
:challenge)
|
357
|
+
SENSITIVE = []
|
358
|
+
include Aws::Structure
|
359
|
+
end
|
360
|
+
|
361
|
+
# @!attribute [rw] certificate_authority_arn
|
362
|
+
# The Amazon Resource Name (ARN) of the Amazon Web Services Private
|
363
|
+
# Certificate Authority certificate authority to use with this
|
364
|
+
# connector. Due to security vulnerabilities present in the SCEP
|
365
|
+
# protocol, we recommend using a private CA that's dedicated for use
|
366
|
+
# with the connector.
|
367
|
+
#
|
368
|
+
# To retrieve the private CAs associated with your account, you can
|
369
|
+
# call [ListCertificateAuthorities][1] using the Amazon Web Services
|
370
|
+
# Private CA API.
|
371
|
+
#
|
372
|
+
#
|
373
|
+
#
|
374
|
+
# [1]: https://docs.aws.amazon.com/privateca/latest/APIReference/API_ListCertificateAuthorities.html
|
375
|
+
# @return [String]
|
376
|
+
#
|
377
|
+
# @!attribute [rw] mobile_device_management
|
378
|
+
# If you don't supply a value, by default Connector for SCEP creates
|
379
|
+
# a connector for general-purpose use. A general-purpose connector is
|
380
|
+
# designed to work with clients or endpoints that support the SCEP
|
381
|
+
# protocol, except Connector for SCEP for Microsoft Intune. With
|
382
|
+
# connectors for general-purpose use, you manage SCEP challenge
|
383
|
+
# passwords using Connector for SCEP. For information about
|
384
|
+
# considerations and limitations with using Connector for SCEP, see
|
385
|
+
# [Considerations and Limitations][1].
|
386
|
+
#
|
387
|
+
# If you provide an `IntuneConfiguration`, Connector for SCEP creates
|
388
|
+
# a connector for use with Microsoft Intune, and you manage the
|
389
|
+
# challenge passwords using Microsoft Intune. For more information,
|
390
|
+
# see [Using Connector for SCEP for Microsoft Intune][2].
|
391
|
+
#
|
392
|
+
#
|
393
|
+
#
|
394
|
+
# [1]: https://docs.aws.amazon.com/privateca/latest/userguide/scep-connector.htmlc4scep-considerations-limitations.html
|
395
|
+
# [2]: https://docs.aws.amazon.com/privateca/latest/userguide/scep-connector.htmlconnector-for-scep-intune.html
|
396
|
+
# @return [Types::MobileDeviceManagement]
|
397
|
+
#
|
398
|
+
# @!attribute [rw] client_token
|
399
|
+
# Custom string that can be used to distinguish between calls to the
|
400
|
+
# [CreateChallenge][1] action. Client tokens for `CreateChallenge`
|
401
|
+
# time out after five minutes. Therefore, if you call
|
402
|
+
# `CreateChallenge` multiple times with the same client token within
|
403
|
+
# five minutes, Connector for SCEP recognizes that you are requesting
|
404
|
+
# only one challenge and will only respond with one. If you change the
|
405
|
+
# client token for each call, Connector for SCEP recognizes that you
|
406
|
+
# are requesting multiple challenge passwords.
|
407
|
+
#
|
408
|
+
# **A suitable default value is auto-generated.** You should normally
|
409
|
+
# not need to pass this option.
|
410
|
+
#
|
411
|
+
#
|
412
|
+
#
|
413
|
+
# [1]: https://docs.aws.amazon.com/C4SCEP_API/pca-connector-scep/latest/APIReference/API_CreateChallenge.html
|
414
|
+
# @return [String]
|
415
|
+
#
|
416
|
+
# @!attribute [rw] tags
|
417
|
+
# The key-value pairs to associate with the resource.
|
418
|
+
# @return [Hash<String,String>]
|
419
|
+
#
|
420
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/pca-connector-scep-2018-05-10/CreateConnectorRequest AWS API Documentation
|
421
|
+
#
|
422
|
+
class CreateConnectorRequest < Struct.new(
|
423
|
+
:certificate_authority_arn,
|
424
|
+
:mobile_device_management,
|
425
|
+
:client_token,
|
426
|
+
:tags)
|
427
|
+
SENSITIVE = []
|
428
|
+
include Aws::Structure
|
429
|
+
end
|
430
|
+
|
431
|
+
# @!attribute [rw] connector_arn
|
432
|
+
# Returns the Amazon Resource Name (ARN) of the connector.
|
433
|
+
# @return [String]
|
434
|
+
#
|
435
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/pca-connector-scep-2018-05-10/CreateConnectorResponse AWS API Documentation
|
436
|
+
#
|
437
|
+
class CreateConnectorResponse < Struct.new(
|
438
|
+
:connector_arn)
|
439
|
+
SENSITIVE = []
|
440
|
+
include Aws::Structure
|
441
|
+
end
|
442
|
+
|
443
|
+
# @!attribute [rw] challenge_arn
|
444
|
+
# The Amazon Resource Name (ARN) of the challenge password to delete.
|
445
|
+
# @return [String]
|
446
|
+
#
|
447
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/pca-connector-scep-2018-05-10/DeleteChallengeRequest AWS API Documentation
|
448
|
+
#
|
449
|
+
class DeleteChallengeRequest < Struct.new(
|
450
|
+
:challenge_arn)
|
451
|
+
SENSITIVE = []
|
452
|
+
include Aws::Structure
|
453
|
+
end
|
454
|
+
|
455
|
+
# @!attribute [rw] connector_arn
|
456
|
+
# The Amazon Resource Name (ARN) of the connector to delete.
|
457
|
+
# @return [String]
|
458
|
+
#
|
459
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/pca-connector-scep-2018-05-10/DeleteConnectorRequest AWS API Documentation
|
460
|
+
#
|
461
|
+
class DeleteConnectorRequest < Struct.new(
|
462
|
+
:connector_arn)
|
463
|
+
SENSITIVE = []
|
464
|
+
include Aws::Structure
|
465
|
+
end
|
466
|
+
|
467
|
+
# @!attribute [rw] challenge_arn
|
468
|
+
# The Amazon Resource Name (ARN) of the challenge.
|
469
|
+
# @return [String]
|
470
|
+
#
|
471
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/pca-connector-scep-2018-05-10/GetChallengeMetadataRequest AWS API Documentation
|
472
|
+
#
|
473
|
+
class GetChallengeMetadataRequest < Struct.new(
|
474
|
+
:challenge_arn)
|
475
|
+
SENSITIVE = []
|
476
|
+
include Aws::Structure
|
477
|
+
end
|
478
|
+
|
479
|
+
# @!attribute [rw] challenge_metadata
|
480
|
+
# The metadata for the challenge.
|
481
|
+
# @return [Types::ChallengeMetadata]
|
482
|
+
#
|
483
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/pca-connector-scep-2018-05-10/GetChallengeMetadataResponse AWS API Documentation
|
484
|
+
#
|
485
|
+
class GetChallengeMetadataResponse < Struct.new(
|
486
|
+
:challenge_metadata)
|
487
|
+
SENSITIVE = []
|
488
|
+
include Aws::Structure
|
489
|
+
end
|
490
|
+
|
491
|
+
# @!attribute [rw] challenge_arn
|
492
|
+
# The Amazon Resource Name (ARN) of the challenge.
|
493
|
+
# @return [String]
|
494
|
+
#
|
495
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/pca-connector-scep-2018-05-10/GetChallengePasswordRequest AWS API Documentation
|
496
|
+
#
|
497
|
+
class GetChallengePasswordRequest < Struct.new(
|
498
|
+
:challenge_arn)
|
499
|
+
SENSITIVE = []
|
500
|
+
include Aws::Structure
|
501
|
+
end
|
502
|
+
|
503
|
+
# @!attribute [rw] password
|
504
|
+
# The SCEP challenge password.
|
505
|
+
# @return [String]
|
506
|
+
#
|
507
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/pca-connector-scep-2018-05-10/GetChallengePasswordResponse AWS API Documentation
|
508
|
+
#
|
509
|
+
class GetChallengePasswordResponse < Struct.new(
|
510
|
+
:password)
|
511
|
+
SENSITIVE = [:password]
|
512
|
+
include Aws::Structure
|
513
|
+
end
|
514
|
+
|
515
|
+
# @!attribute [rw] connector_arn
|
516
|
+
# The Amazon Resource Name (ARN) of the connector.
|
517
|
+
# @return [String]
|
518
|
+
#
|
519
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/pca-connector-scep-2018-05-10/GetConnectorRequest AWS API Documentation
|
520
|
+
#
|
521
|
+
class GetConnectorRequest < Struct.new(
|
522
|
+
:connector_arn)
|
523
|
+
SENSITIVE = []
|
524
|
+
include Aws::Structure
|
525
|
+
end
|
526
|
+
|
527
|
+
# @!attribute [rw] connector
|
528
|
+
# The properties of the connector.
|
529
|
+
# @return [Types::Connector]
|
530
|
+
#
|
531
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/pca-connector-scep-2018-05-10/GetConnectorResponse AWS API Documentation
|
532
|
+
#
|
533
|
+
class GetConnectorResponse < Struct.new(
|
534
|
+
:connector)
|
535
|
+
SENSITIVE = []
|
536
|
+
include Aws::Structure
|
537
|
+
end
|
538
|
+
|
539
|
+
# The request processing has failed because of an unknown error,
|
540
|
+
# exception or failure with an internal server.
|
541
|
+
#
|
542
|
+
# @!attribute [rw] message
|
543
|
+
# @return [String]
|
544
|
+
#
|
545
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/pca-connector-scep-2018-05-10/InternalServerException AWS API Documentation
|
546
|
+
#
|
547
|
+
class InternalServerException < Struct.new(
|
548
|
+
:message)
|
549
|
+
SENSITIVE = []
|
550
|
+
include Aws::Structure
|
551
|
+
end
|
552
|
+
|
553
|
+
# Contains configuration details for use with Microsoft Intune. For
|
554
|
+
# information about using Connector for SCEP for Microsoft Intune, see
|
555
|
+
# [Using Connector for SCEP for Microsoft Intune][1].
|
556
|
+
#
|
557
|
+
# When you use Connector for SCEP for Microsoft Intune, certain
|
558
|
+
# functionalities are enabled by accessing Microsoft Intune through the
|
559
|
+
# Microsoft API. Your use of the Connector for SCEP and accompanying
|
560
|
+
# Amazon Web Services services doesn't remove your need to have a valid
|
561
|
+
# license for your use of the Microsoft Intune service. You should also
|
562
|
+
# review the [Microsoft Intune® App Protection Policies][2].
|
563
|
+
#
|
564
|
+
#
|
565
|
+
#
|
566
|
+
# [1]: https://docs.aws.amazon.com/privateca/latest/userguide/scep-connector.htmlconnector-for-scep-intune.html
|
567
|
+
# [2]: https://learn.microsoft.com/en-us/mem/intune/apps/app-protection-policy
|
568
|
+
#
|
569
|
+
# @!attribute [rw] azure_application_id
|
570
|
+
# The directory (tenant) ID from your Microsoft Entra ID app
|
571
|
+
# registration.
|
572
|
+
# @return [String]
|
573
|
+
#
|
574
|
+
# @!attribute [rw] domain
|
575
|
+
# The primary domain from your Microsoft Entra ID app registration.
|
576
|
+
# @return [String]
|
577
|
+
#
|
578
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/pca-connector-scep-2018-05-10/IntuneConfiguration AWS API Documentation
|
579
|
+
#
|
580
|
+
class IntuneConfiguration < Struct.new(
|
581
|
+
:azure_application_id,
|
582
|
+
:domain)
|
583
|
+
SENSITIVE = []
|
584
|
+
include Aws::Structure
|
585
|
+
end
|
586
|
+
|
587
|
+
# @!attribute [rw] max_results
|
588
|
+
# The maximum number of objects that you want Connector for SCEP to
|
589
|
+
# return for this request. If more objects are available, in the
|
590
|
+
# response, Connector for SCEP provides a `NextToken` value that you
|
591
|
+
# can use in a subsequent call to get the next batch of objects.
|
592
|
+
# @return [Integer]
|
593
|
+
#
|
594
|
+
# @!attribute [rw] next_token
|
595
|
+
# When you request a list of objects with a `MaxResults` setting, if
|
596
|
+
# the number of objects that are still available for retrieval exceeds
|
597
|
+
# the maximum you requested, Connector for SCEP returns a `NextToken`
|
598
|
+
# value in the response. To retrieve the next batch of objects, use
|
599
|
+
# the token returned from the prior request in your next request.
|
600
|
+
# @return [String]
|
601
|
+
#
|
602
|
+
# @!attribute [rw] connector_arn
|
603
|
+
# The Amazon Resource Name (ARN) of the connector.
|
604
|
+
# @return [String]
|
605
|
+
#
|
606
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/pca-connector-scep-2018-05-10/ListChallengeMetadataRequest AWS API Documentation
|
607
|
+
#
|
608
|
+
class ListChallengeMetadataRequest < Struct.new(
|
609
|
+
:max_results,
|
610
|
+
:next_token,
|
611
|
+
:connector_arn)
|
612
|
+
SENSITIVE = []
|
613
|
+
include Aws::Structure
|
614
|
+
end
|
615
|
+
|
616
|
+
# @!attribute [rw] challenges
|
617
|
+
# The challenge metadata for the challenges belonging to your Amazon
|
618
|
+
# Web Services account.
|
619
|
+
# @return [Array<Types::ChallengeMetadataSummary>]
|
620
|
+
#
|
621
|
+
# @!attribute [rw] next_token
|
622
|
+
# When you request a list of objects with a `MaxResults` setting, if
|
623
|
+
# the number of objects that are still available for retrieval exceeds
|
624
|
+
# the maximum you requested, Connector for SCEP returns a `NextToken`
|
625
|
+
# value in the response. To retrieve the next batch of objects, use
|
626
|
+
# the token returned from the prior request in your next request.
|
627
|
+
# @return [String]
|
628
|
+
#
|
629
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/pca-connector-scep-2018-05-10/ListChallengeMetadataResponse AWS API Documentation
|
630
|
+
#
|
631
|
+
class ListChallengeMetadataResponse < Struct.new(
|
632
|
+
:challenges,
|
633
|
+
:next_token)
|
634
|
+
SENSITIVE = []
|
635
|
+
include Aws::Structure
|
636
|
+
end
|
637
|
+
|
638
|
+
# @!attribute [rw] max_results
|
639
|
+
# The maximum number of objects that you want Connector for SCEP to
|
640
|
+
# return for this request. If more objects are available, in the
|
641
|
+
# response, Connector for SCEP provides a `NextToken` value that you
|
642
|
+
# can use in a subsequent call to get the next batch of objects.
|
643
|
+
# @return [Integer]
|
644
|
+
#
|
645
|
+
# @!attribute [rw] next_token
|
646
|
+
# When you request a list of objects with a `MaxResults` setting, if
|
647
|
+
# the number of objects that are still available for retrieval exceeds
|
648
|
+
# the maximum you requested, Connector for SCEP returns a `NextToken`
|
649
|
+
# value in the response. To retrieve the next batch of objects, use
|
650
|
+
# the token returned from the prior request in your next request.
|
651
|
+
# @return [String]
|
652
|
+
#
|
653
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/pca-connector-scep-2018-05-10/ListConnectorsRequest AWS API Documentation
|
654
|
+
#
|
655
|
+
class ListConnectorsRequest < Struct.new(
|
656
|
+
:max_results,
|
657
|
+
:next_token)
|
658
|
+
SENSITIVE = []
|
659
|
+
include Aws::Structure
|
660
|
+
end
|
661
|
+
|
662
|
+
# @!attribute [rw] connectors
|
663
|
+
# The connectors belonging to your Amazon Web Services account.
|
664
|
+
# @return [Array<Types::ConnectorSummary>]
|
665
|
+
#
|
666
|
+
# @!attribute [rw] next_token
|
667
|
+
# When you request a list of objects with a `MaxResults` setting, if
|
668
|
+
# the number of objects that are still available for retrieval exceeds
|
669
|
+
# the maximum you requested, Connector for SCEP returns a `NextToken`
|
670
|
+
# value in the response. To retrieve the next batch of objects, use
|
671
|
+
# the token returned from the prior request in your next request.
|
672
|
+
# @return [String]
|
673
|
+
#
|
674
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/pca-connector-scep-2018-05-10/ListConnectorsResponse AWS API Documentation
|
675
|
+
#
|
676
|
+
class ListConnectorsResponse < Struct.new(
|
677
|
+
:connectors,
|
678
|
+
:next_token)
|
679
|
+
SENSITIVE = []
|
680
|
+
include Aws::Structure
|
681
|
+
end
|
682
|
+
|
683
|
+
# @!attribute [rw] resource_arn
|
684
|
+
# The Amazon Resource Name (ARN) of the resource.
|
685
|
+
# @return [String]
|
686
|
+
#
|
687
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/pca-connector-scep-2018-05-10/ListTagsForResourceRequest AWS API Documentation
|
688
|
+
#
|
689
|
+
class ListTagsForResourceRequest < Struct.new(
|
690
|
+
:resource_arn)
|
691
|
+
SENSITIVE = []
|
692
|
+
include Aws::Structure
|
693
|
+
end
|
694
|
+
|
695
|
+
# @!attribute [rw] tags
|
696
|
+
# The key-value pairs to associate with the resource.
|
697
|
+
# @return [Hash<String,String>]
|
698
|
+
#
|
699
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/pca-connector-scep-2018-05-10/ListTagsForResourceResponse AWS API Documentation
|
700
|
+
#
|
701
|
+
class ListTagsForResourceResponse < Struct.new(
|
702
|
+
:tags)
|
703
|
+
SENSITIVE = []
|
704
|
+
include Aws::Structure
|
705
|
+
end
|
706
|
+
|
707
|
+
# If you don't supply a value, by default Connector for SCEP creates a
|
708
|
+
# connector for general-purpose use. A general-purpose connector is
|
709
|
+
# designed to work with clients or endpoints that support the SCEP
|
710
|
+
# protocol, except Connector for SCEP for Microsoft Intune. For
|
711
|
+
# information about considerations and limitations with using Connector
|
712
|
+
# for SCEP, see [Considerations and Limitations][1].
|
713
|
+
#
|
714
|
+
# If you provide an `IntuneConfiguration`, Connector for SCEP creates a
|
715
|
+
# connector for use with Microsoft Intune, and you manage the challenge
|
716
|
+
# passwords using Microsoft Intune. For more information, see [Using
|
717
|
+
# Connector for SCEP for Microsoft Intune][2].
|
718
|
+
#
|
719
|
+
#
|
720
|
+
#
|
721
|
+
# [1]: https://docs.aws.amazon.com/privateca/latest/userguide/scep-connector.htmlc4scep-considerations-limitations.html
|
722
|
+
# [2]: https://docs.aws.amazon.com/privateca/latest/userguide/scep-connector.htmlconnector-for-scep-intune.html
|
723
|
+
#
|
724
|
+
# @note MobileDeviceManagement is a union - when making an API calls you must set exactly one of the members.
|
725
|
+
#
|
726
|
+
# @note MobileDeviceManagement is a union - when returned from an API call exactly one value will be set and the returned type will be a subclass of MobileDeviceManagement corresponding to the set member.
|
727
|
+
#
|
728
|
+
# @!attribute [rw] intune
|
729
|
+
# Configuration settings for use with Microsoft Intune. For
|
730
|
+
# information about using Connector for SCEP for Microsoft Intune, see
|
731
|
+
# [Using Connector for SCEP for Microsoft Intune][1].
|
732
|
+
#
|
733
|
+
#
|
734
|
+
#
|
735
|
+
# [1]: https://docs.aws.amazon.com/privateca/latest/userguide/scep-connector.htmlconnector-for-scep-intune.html
|
736
|
+
# @return [Types::IntuneConfiguration]
|
737
|
+
#
|
738
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/pca-connector-scep-2018-05-10/MobileDeviceManagement AWS API Documentation
|
739
|
+
#
|
740
|
+
class MobileDeviceManagement < Struct.new(
|
741
|
+
:intune,
|
742
|
+
:unknown)
|
743
|
+
SENSITIVE = []
|
744
|
+
include Aws::Structure
|
745
|
+
include Aws::Structure::Union
|
746
|
+
|
747
|
+
class Intune < MobileDeviceManagement; end
|
748
|
+
class Unknown < MobileDeviceManagement; end
|
749
|
+
end
|
750
|
+
|
751
|
+
# Contains OpenID Connect (OIDC) parameters for use with Microsoft
|
752
|
+
# Intune. For more information about using Connector for SCEP for
|
753
|
+
# Microsoft Intune, see [Using Connector for SCEP for Microsoft
|
754
|
+
# Intune][1].
|
755
|
+
#
|
756
|
+
#
|
757
|
+
#
|
758
|
+
# [1]: https://docs.aws.amazon.com/privateca/latest/userguide/scep-connector.htmlconnector-for-scep-intune.html
|
759
|
+
#
|
760
|
+
# @!attribute [rw] issuer
|
761
|
+
# The issuer value to copy into your Microsoft Entra app
|
762
|
+
# registration's OIDC.
|
763
|
+
# @return [String]
|
764
|
+
#
|
765
|
+
# @!attribute [rw] subject
|
766
|
+
# The subject value to copy into your Microsoft Entra app
|
767
|
+
# registration's OIDC.
|
768
|
+
# @return [String]
|
769
|
+
#
|
770
|
+
# @!attribute [rw] audience
|
771
|
+
# The audience value to copy into your Microsoft Entra app
|
772
|
+
# registration's OIDC.
|
773
|
+
# @return [String]
|
774
|
+
#
|
775
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/pca-connector-scep-2018-05-10/OpenIdConfiguration AWS API Documentation
|
776
|
+
#
|
777
|
+
class OpenIdConfiguration < Struct.new(
|
778
|
+
:issuer,
|
779
|
+
:subject,
|
780
|
+
:audience)
|
781
|
+
SENSITIVE = []
|
782
|
+
include Aws::Structure
|
783
|
+
end
|
784
|
+
|
785
|
+
# The operation tried to access a nonexistent resource. The resource
|
786
|
+
# might be incorrectly specified, or it might have a status other than
|
787
|
+
# `ACTIVE`.
|
788
|
+
#
|
789
|
+
# @!attribute [rw] message
|
790
|
+
# @return [String]
|
791
|
+
#
|
792
|
+
# @!attribute [rw] resource_id
|
793
|
+
# The identifier of the Amazon Web Services resource.
|
794
|
+
# @return [String]
|
795
|
+
#
|
796
|
+
# @!attribute [rw] resource_type
|
797
|
+
# The resource type, which can be either `Connector` or `Challenge`.
|
798
|
+
# @return [String]
|
799
|
+
#
|
800
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/pca-connector-scep-2018-05-10/ResourceNotFoundException AWS API Documentation
|
801
|
+
#
|
802
|
+
class ResourceNotFoundException < Struct.new(
|
803
|
+
:message,
|
804
|
+
:resource_id,
|
805
|
+
:resource_type)
|
806
|
+
SENSITIVE = []
|
807
|
+
include Aws::Structure
|
808
|
+
end
|
809
|
+
|
810
|
+
# The request would cause a service quota to be exceeded.
|
811
|
+
#
|
812
|
+
# @!attribute [rw] message
|
813
|
+
# @return [String]
|
814
|
+
#
|
815
|
+
# @!attribute [rw] resource_type
|
816
|
+
# The resource type, which can be either `Connector` or `Challenge`.
|
817
|
+
# @return [String]
|
818
|
+
#
|
819
|
+
# @!attribute [rw] service_code
|
820
|
+
# Identifies the originating service.
|
821
|
+
# @return [String]
|
822
|
+
#
|
823
|
+
# @!attribute [rw] quota_code
|
824
|
+
# The quota identifier.
|
825
|
+
# @return [String]
|
826
|
+
#
|
827
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/pca-connector-scep-2018-05-10/ServiceQuotaExceededException AWS API Documentation
|
828
|
+
#
|
829
|
+
class ServiceQuotaExceededException < Struct.new(
|
830
|
+
:message,
|
831
|
+
:resource_type,
|
832
|
+
:service_code,
|
833
|
+
:quota_code)
|
834
|
+
SENSITIVE = []
|
835
|
+
include Aws::Structure
|
836
|
+
end
|
837
|
+
|
838
|
+
# @!attribute [rw] resource_arn
|
839
|
+
# The Amazon Resource Name (ARN) of the resource.
|
840
|
+
# @return [String]
|
841
|
+
#
|
842
|
+
# @!attribute [rw] tags
|
843
|
+
# The key-value pairs to associate with the resource.
|
844
|
+
# @return [Hash<String,String>]
|
845
|
+
#
|
846
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/pca-connector-scep-2018-05-10/TagResourceRequest AWS API Documentation
|
847
|
+
#
|
848
|
+
class TagResourceRequest < Struct.new(
|
849
|
+
:resource_arn,
|
850
|
+
:tags)
|
851
|
+
SENSITIVE = []
|
852
|
+
include Aws::Structure
|
853
|
+
end
|
854
|
+
|
855
|
+
# The limit on the number of requests per second was exceeded.
|
856
|
+
#
|
857
|
+
# @!attribute [rw] message
|
858
|
+
# @return [String]
|
859
|
+
#
|
860
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/pca-connector-scep-2018-05-10/ThrottlingException AWS API Documentation
|
861
|
+
#
|
862
|
+
class ThrottlingException < Struct.new(
|
863
|
+
:message)
|
864
|
+
SENSITIVE = []
|
865
|
+
include Aws::Structure
|
866
|
+
end
|
867
|
+
|
868
|
+
# @!attribute [rw] resource_arn
|
869
|
+
# The Amazon Resource Name (ARN) of the resource.
|
870
|
+
# @return [String]
|
871
|
+
#
|
872
|
+
# @!attribute [rw] tag_keys
|
873
|
+
# Specifies a list of tag keys that you want to remove from the
|
874
|
+
# specified resources.
|
875
|
+
# @return [Array<String>]
|
876
|
+
#
|
877
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/pca-connector-scep-2018-05-10/UntagResourceRequest AWS API Documentation
|
878
|
+
#
|
879
|
+
class UntagResourceRequest < Struct.new(
|
880
|
+
:resource_arn,
|
881
|
+
:tag_keys)
|
882
|
+
SENSITIVE = []
|
883
|
+
include Aws::Structure
|
884
|
+
end
|
885
|
+
|
886
|
+
# An input validation error occurred. For example, invalid characters in
|
887
|
+
# a name tag, or an invalid pagination token.
|
888
|
+
#
|
889
|
+
# @!attribute [rw] message
|
890
|
+
# @return [String]
|
891
|
+
#
|
892
|
+
# @!attribute [rw] reason
|
893
|
+
# The reason for the validation error, if available. The service
|
894
|
+
# doesn't return a reason for every validation exception.
|
895
|
+
# @return [String]
|
896
|
+
#
|
897
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/pca-connector-scep-2018-05-10/ValidationException AWS API Documentation
|
898
|
+
#
|
899
|
+
class ValidationException < Struct.new(
|
900
|
+
:message,
|
901
|
+
:reason)
|
902
|
+
SENSITIVE = []
|
903
|
+
include Aws::Structure
|
904
|
+
end
|
905
|
+
|
906
|
+
end
|
907
|
+
end
|