aws-sdk-accountaccess 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.
@@ -0,0 +1,925 @@
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::AccountAccess
11
+ module Types
12
+
13
+ # You do not have sufficient access to perform this operation.
14
+ #
15
+ # @!attribute [rw] message
16
+ # @return [String]
17
+ #
18
+ # @see http://docs.aws.amazon.com/goto/WebAPI/account-access-2018-05-10/AccessDeniedException AWS API Documentation
19
+ #
20
+ class AccessDeniedException < Struct.new(
21
+ :message)
22
+ SENSITIVE = []
23
+ include Aws::Structure
24
+ end
25
+
26
+ # The resource you are trying to create already exists. To retrieve the
27
+ # existing resource, use the corresponding Get operation.
28
+ #
29
+ # @!attribute [rw] message
30
+ # @return [String]
31
+ #
32
+ # @see http://docs.aws.amazon.com/goto/WebAPI/account-access-2018-05-10/AlreadyCreatedException AWS API Documentation
33
+ #
34
+ class AlreadyCreatedException < Struct.new(
35
+ :message)
36
+ SENSITIVE = []
37
+ include Aws::Structure
38
+ end
39
+
40
+ # Contains summary information about an account access manager
41
+ # application.
42
+ #
43
+ # @!attribute [rw] application_arn
44
+ # The ARN of the application.
45
+ # @return [String]
46
+ #
47
+ # @!attribute [rw] tenant_id
48
+ # The tenant identifier associated with the application.
49
+ # @return [String]
50
+ #
51
+ # @!attribute [rw] created_at
52
+ # The date and time when the application was created.
53
+ # @return [Time]
54
+ #
55
+ # @!attribute [rw] updated_at
56
+ # The date and time when the application was last updated.
57
+ # @return [Time]
58
+ #
59
+ # @see http://docs.aws.amazon.com/goto/WebAPI/account-access-2018-05-10/ApplicationSummary AWS API Documentation
60
+ #
61
+ class ApplicationSummary < Struct.new(
62
+ :application_arn,
63
+ :tenant_id,
64
+ :created_at,
65
+ :updated_at)
66
+ SENSITIVE = []
67
+ include Aws::Structure
68
+ end
69
+
70
+ # The request conflicts with the current state of the resource.
71
+ #
72
+ # @!attribute [rw] message
73
+ # @return [String]
74
+ #
75
+ # @see http://docs.aws.amazon.com/goto/WebAPI/account-access-2018-05-10/ConflictException AWS API Documentation
76
+ #
77
+ class ConflictException < Struct.new(
78
+ :message)
79
+ SENSITIVE = []
80
+ include Aws::Structure
81
+ end
82
+
83
+ # @!attribute [rw] identity_source
84
+ # Specifies the identity source for the application. The identity
85
+ # source defines the IAM Identity Center instance that provides
86
+ # principals for entitlements.
87
+ # @return [Types::IdentitySource]
88
+ #
89
+ # @!attribute [rw] tags
90
+ # Specifies the tags to assign to the application.
91
+ # @return [Hash<String,String>]
92
+ #
93
+ # @see http://docs.aws.amazon.com/goto/WebAPI/account-access-2018-05-10/CreateApplicationRequest AWS API Documentation
94
+ #
95
+ class CreateApplicationRequest < Struct.new(
96
+ :identity_source,
97
+ :tags)
98
+ SENSITIVE = []
99
+ include Aws::Structure
100
+ end
101
+
102
+ # @!attribute [rw] application_arn
103
+ # The Amazon Resource Name (ARN) of the created application.
104
+ # @return [String]
105
+ #
106
+ # @see http://docs.aws.amazon.com/goto/WebAPI/account-access-2018-05-10/CreateApplicationResponse AWS API Documentation
107
+ #
108
+ class CreateApplicationResponse < Struct.new(
109
+ :application_arn)
110
+ SENSITIVE = []
111
+ include Aws::Structure
112
+ end
113
+
114
+ # @!attribute [rw] application_arn
115
+ # Specifies the ARN of the application to create the entitlement for.
116
+ # @return [String]
117
+ #
118
+ # @!attribute [rw] entitlement
119
+ # Specifies the entitlement configuration, including the principal and
120
+ # the IAM role to grant access to.
121
+ # @return [Types::Entitlement]
122
+ #
123
+ # @see http://docs.aws.amazon.com/goto/WebAPI/account-access-2018-05-10/CreateEntitlementRequest AWS API Documentation
124
+ #
125
+ class CreateEntitlementRequest < Struct.new(
126
+ :application_arn,
127
+ :entitlement)
128
+ SENSITIVE = []
129
+ include Aws::Structure
130
+ end
131
+
132
+ # @!attribute [rw] entitlement_id
133
+ # The unique identifier of the created entitlement.
134
+ # @return [String]
135
+ #
136
+ # @see http://docs.aws.amazon.com/goto/WebAPI/account-access-2018-05-10/CreateEntitlementResponse AWS API Documentation
137
+ #
138
+ class CreateEntitlementResponse < Struct.new(
139
+ :entitlement_id)
140
+ SENSITIVE = []
141
+ include Aws::Structure
142
+ end
143
+
144
+ # @!attribute [rw] application_arn
145
+ # Specifies the ARN of the application to delete.
146
+ # @return [String]
147
+ #
148
+ # @see http://docs.aws.amazon.com/goto/WebAPI/account-access-2018-05-10/DeleteApplicationRequest AWS API Documentation
149
+ #
150
+ class DeleteApplicationRequest < Struct.new(
151
+ :application_arn)
152
+ SENSITIVE = []
153
+ include Aws::Structure
154
+ end
155
+
156
+ # @see http://docs.aws.amazon.com/goto/WebAPI/account-access-2018-05-10/DeleteApplicationResponse AWS API Documentation
157
+ #
158
+ class DeleteApplicationResponse < Aws::EmptyStructure; end
159
+
160
+ # @!attribute [rw] application_arn
161
+ # Specifies the ARN of the application that the entitlement belongs
162
+ # to.
163
+ # @return [String]
164
+ #
165
+ # @!attribute [rw] entitlement_id
166
+ # Specifies the unique identifier of the entitlement to delete.
167
+ # @return [String]
168
+ #
169
+ # @see http://docs.aws.amazon.com/goto/WebAPI/account-access-2018-05-10/DeleteEntitlementRequest AWS API Documentation
170
+ #
171
+ class DeleteEntitlementRequest < Struct.new(
172
+ :application_arn,
173
+ :entitlement_id)
174
+ SENSITIVE = []
175
+ include Aws::Structure
176
+ end
177
+
178
+ # @see http://docs.aws.amazon.com/goto/WebAPI/account-access-2018-05-10/DeleteEntitlementResponse AWS API Documentation
179
+ #
180
+ class DeleteEntitlementResponse < Aws::EmptyStructure; end
181
+
182
+ # Specifies the entitlement configuration for an account access manager
183
+ # application, defining which principal can assume which IAM role.
184
+ #
185
+ # @note Entitlement is a union - when making an API calls you must set exactly one of the members.
186
+ #
187
+ # @!attribute [rw] principal_role
188
+ # The principal-to-role mapping for the entitlement.
189
+ # @return [Types::PrincipalRoleEntitlement]
190
+ #
191
+ # @see http://docs.aws.amazon.com/goto/WebAPI/account-access-2018-05-10/Entitlement AWS API Documentation
192
+ #
193
+ class Entitlement < Struct.new(
194
+ :principal_role,
195
+ :unknown)
196
+ SENSITIVE = []
197
+ include Aws::Structure
198
+ include Aws::Structure::Union
199
+
200
+ class PrincipalRole < Entitlement; end
201
+ class Unknown < Entitlement; end
202
+ end
203
+
204
+ # Contains detailed information about an entitlement, including the
205
+ # principal, IAM role, and target account.
206
+ #
207
+ # @note EntitlementDetails is a union - when returned from an API call exactly one value will be set and the returned type will be a subclass of EntitlementDetails corresponding to the set member.
208
+ #
209
+ # @!attribute [rw] principal_role
210
+ # The principal-to-role mapping details for the entitlement, including
211
+ # the target account.
212
+ # @return [Types::PrincipalRoleEntitlementDetails]
213
+ #
214
+ # @see http://docs.aws.amazon.com/goto/WebAPI/account-access-2018-05-10/EntitlementDetails AWS API Documentation
215
+ #
216
+ class EntitlementDetails < Struct.new(
217
+ :principal_role,
218
+ :unknown)
219
+ SENSITIVE = []
220
+ include Aws::Structure
221
+ include Aws::Structure::Union
222
+
223
+ class PrincipalRole < EntitlementDetails; end
224
+ class Unknown < EntitlementDetails; end
225
+ end
226
+
227
+ # Specifies filter criteria for listing entitlements.
228
+ #
229
+ # @!attribute [rw] principal_role
230
+ # The principal-to-role filter criteria for narrowing entitlement
231
+ # results.
232
+ # @return [Types::PrincipalRoleEntitlementFilter]
233
+ #
234
+ # @see http://docs.aws.amazon.com/goto/WebAPI/account-access-2018-05-10/EntitlementFilter AWS API Documentation
235
+ #
236
+ class EntitlementFilter < Struct.new(
237
+ :principal_role)
238
+ SENSITIVE = []
239
+ include Aws::Structure
240
+ end
241
+
242
+ # Contains summary information about an entitlement.
243
+ #
244
+ # @note EntitlementSummary is a union - when returned from an API call exactly one value will be set and the returned type will be a subclass of EntitlementSummary corresponding to the set member.
245
+ #
246
+ # @!attribute [rw] principal_role
247
+ # The principal-to-role mapping summary for the entitlement.
248
+ # @return [Types::PrincipalRoleEntitlementSummary]
249
+ #
250
+ # @see http://docs.aws.amazon.com/goto/WebAPI/account-access-2018-05-10/EntitlementSummary AWS API Documentation
251
+ #
252
+ class EntitlementSummary < Struct.new(
253
+ :principal_role,
254
+ :unknown)
255
+ SENSITIVE = []
256
+ include Aws::Structure
257
+ include Aws::Structure::Union
258
+
259
+ class PrincipalRole < EntitlementSummary; end
260
+ class Unknown < EntitlementSummary; end
261
+ end
262
+
263
+ # Contains information about an entitlement in a list result.
264
+ #
265
+ # @!attribute [rw] entitlement_id
266
+ # The unique identifier of the entitlement.
267
+ # @return [String]
268
+ #
269
+ # @!attribute [rw] entitlement
270
+ # The summary information for the entitlement.
271
+ # @return [Types::EntitlementSummary]
272
+ #
273
+ # @!attribute [rw] created_at
274
+ # The date and time when the entitlement was created.
275
+ # @return [Time]
276
+ #
277
+ # @see http://docs.aws.amazon.com/goto/WebAPI/account-access-2018-05-10/EntitlementsListMember AWS API Documentation
278
+ #
279
+ class EntitlementsListMember < Struct.new(
280
+ :entitlement_id,
281
+ :entitlement,
282
+ :created_at)
283
+ SENSITIVE = []
284
+ include Aws::Structure
285
+ end
286
+
287
+ # Contains information about an error that occurred during application
288
+ # processing.
289
+ #
290
+ # @!attribute [rw] code
291
+ # The error code that identifies the type of error.
292
+ # @return [String]
293
+ #
294
+ # @!attribute [rw] message
295
+ # A human-readable message that describes the error.
296
+ # @return [String]
297
+ #
298
+ # @see http://docs.aws.amazon.com/goto/WebAPI/account-access-2018-05-10/ErrorDetails AWS API Documentation
299
+ #
300
+ class ErrorDetails < Struct.new(
301
+ :code,
302
+ :message)
303
+ SENSITIVE = []
304
+ include Aws::Structure
305
+ end
306
+
307
+ # @!attribute [rw] application_arn
308
+ # Specifies the ARN of the application to retrieve.
309
+ # @return [String]
310
+ #
311
+ # @see http://docs.aws.amazon.com/goto/WebAPI/account-access-2018-05-10/GetApplicationRequest AWS API Documentation
312
+ #
313
+ class GetApplicationRequest < Struct.new(
314
+ :application_arn)
315
+ SENSITIVE = []
316
+ include Aws::Structure
317
+ end
318
+
319
+ # @!attribute [rw] identity_source
320
+ # The identity source details for the application, including the IAM
321
+ # Identity Center instance configuration.
322
+ # @return [Types::IdentitySourceDetails]
323
+ #
324
+ # @!attribute [rw] status
325
+ # The current status of the application.
326
+ # @return [String]
327
+ #
328
+ # @!attribute [rw] tenant_id
329
+ # The tenant identifier associated with the application.
330
+ # @return [String]
331
+ #
332
+ # @!attribute [rw] created_at
333
+ # The date and time when the application was created.
334
+ # @return [Time]
335
+ #
336
+ # @!attribute [rw] updated_at
337
+ # The date and time when the application was last updated.
338
+ # @return [Time]
339
+ #
340
+ # @!attribute [rw] tags
341
+ # The tags associated with the application.
342
+ # @return [Hash<String,String>]
343
+ #
344
+ # @!attribute [rw] error
345
+ # The error details if the application is in a failed state.
346
+ # @return [Types::ErrorDetails]
347
+ #
348
+ # @see http://docs.aws.amazon.com/goto/WebAPI/account-access-2018-05-10/GetApplicationResponse AWS API Documentation
349
+ #
350
+ class GetApplicationResponse < Struct.new(
351
+ :identity_source,
352
+ :status,
353
+ :tenant_id,
354
+ :created_at,
355
+ :updated_at,
356
+ :tags,
357
+ :error)
358
+ SENSITIVE = []
359
+ include Aws::Structure
360
+ end
361
+
362
+ # @!attribute [rw] application_arn
363
+ # Specifies the ARN of the application that the entitlement belongs
364
+ # to.
365
+ # @return [String]
366
+ #
367
+ # @!attribute [rw] entitlement_id
368
+ # Specifies the unique identifier of the entitlement to retrieve.
369
+ # @return [String]
370
+ #
371
+ # @see http://docs.aws.amazon.com/goto/WebAPI/account-access-2018-05-10/GetEntitlementRequest AWS API Documentation
372
+ #
373
+ class GetEntitlementRequest < Struct.new(
374
+ :application_arn,
375
+ :entitlement_id)
376
+ SENSITIVE = []
377
+ include Aws::Structure
378
+ end
379
+
380
+ # @!attribute [rw] application_arn
381
+ # The ARN of the application that the entitlement belongs to.
382
+ # @return [String]
383
+ #
384
+ # @!attribute [rw] entitlement_id
385
+ # The unique identifier of the entitlement.
386
+ # @return [String]
387
+ #
388
+ # @!attribute [rw] entitlement
389
+ # The entitlement details, including the principal, IAM role, and
390
+ # target account.
391
+ # @return [Types::EntitlementDetails]
392
+ #
393
+ # @!attribute [rw] created_at
394
+ # The date and time when the entitlement was created.
395
+ # @return [Time]
396
+ #
397
+ # @see http://docs.aws.amazon.com/goto/WebAPI/account-access-2018-05-10/GetEntitlementResponse AWS API Documentation
398
+ #
399
+ class GetEntitlementResponse < Struct.new(
400
+ :application_arn,
401
+ :entitlement_id,
402
+ :entitlement,
403
+ :created_at)
404
+ SENSITIVE = []
405
+ include Aws::Structure
406
+ end
407
+
408
+ # Specifies the IAM Identity Center instance to use as the identity
409
+ # source for an application.
410
+ #
411
+ # @!attribute [rw] instance_arn
412
+ # The ARN of the IAM Identity Center instance.
413
+ # @return [String]
414
+ #
415
+ # @see http://docs.aws.amazon.com/goto/WebAPI/account-access-2018-05-10/IdentityCenter AWS API Documentation
416
+ #
417
+ class IdentityCenter < Struct.new(
418
+ :instance_arn)
419
+ SENSITIVE = []
420
+ include Aws::Structure
421
+ end
422
+
423
+ # Contains detailed information about the IAM Identity Center
424
+ # configuration for an application.
425
+ #
426
+ # @!attribute [rw] instance_arn
427
+ # The ARN of the IAM Identity Center instance.
428
+ # @return [String]
429
+ #
430
+ # @!attribute [rw] application_arn
431
+ # The ARN of the IAM Identity Center application created for this
432
+ # account access manager application.
433
+ # @return [String]
434
+ #
435
+ # @see http://docs.aws.amazon.com/goto/WebAPI/account-access-2018-05-10/IdentityCenterDetails AWS API Documentation
436
+ #
437
+ class IdentityCenterDetails < Struct.new(
438
+ :instance_arn,
439
+ :application_arn)
440
+ SENSITIVE = []
441
+ include Aws::Structure
442
+ end
443
+
444
+ # Identifies a user or group from IAM Identity Center.
445
+ #
446
+ # @note IdentityCenterPrincipal is a union - when making an API calls you must set exactly one of the members.
447
+ #
448
+ # @note IdentityCenterPrincipal is a union - when returned from an API call exactly one value will be set and the returned type will be a subclass of IdentityCenterPrincipal corresponding to the set member.
449
+ #
450
+ # @!attribute [rw] user_id
451
+ # The unique identifier of a user in IAM Identity Center.
452
+ # @return [String]
453
+ #
454
+ # @!attribute [rw] group_id
455
+ # The unique identifier of a group in IAM Identity Center.
456
+ # @return [String]
457
+ #
458
+ # @see http://docs.aws.amazon.com/goto/WebAPI/account-access-2018-05-10/IdentityCenterPrincipal AWS API Documentation
459
+ #
460
+ class IdentityCenterPrincipal < Struct.new(
461
+ :user_id,
462
+ :group_id,
463
+ :unknown)
464
+ SENSITIVE = []
465
+ include Aws::Structure
466
+ include Aws::Structure::Union
467
+
468
+ class UserId < IdentityCenterPrincipal; end
469
+ class GroupId < IdentityCenterPrincipal; end
470
+ class Unknown < IdentityCenterPrincipal; end
471
+ end
472
+
473
+ # Specifies filter criteria for an IAM Identity Center principal.
474
+ #
475
+ # @note IdentityCenterPrincipalFilter is a union - when making an API calls you must set exactly one of the members.
476
+ #
477
+ # @!attribute [rw] user_id
478
+ # The unique identifier of a user in IAM Identity Center to filter by.
479
+ # @return [String]
480
+ #
481
+ # @!attribute [rw] group_id
482
+ # The unique identifier of a group in IAM Identity Center to filter
483
+ # by.
484
+ # @return [String]
485
+ #
486
+ # @see http://docs.aws.amazon.com/goto/WebAPI/account-access-2018-05-10/IdentityCenterPrincipalFilter AWS API Documentation
487
+ #
488
+ class IdentityCenterPrincipalFilter < Struct.new(
489
+ :user_id,
490
+ :group_id,
491
+ :unknown)
492
+ SENSITIVE = []
493
+ include Aws::Structure
494
+ include Aws::Structure::Union
495
+
496
+ class UserId < IdentityCenterPrincipalFilter; end
497
+ class GroupId < IdentityCenterPrincipalFilter; end
498
+ class Unknown < IdentityCenterPrincipalFilter; end
499
+ end
500
+
501
+ # Specifies the identity source for an account access manager
502
+ # application.
503
+ #
504
+ # @note IdentitySource is a union - when making an API calls you must set exactly one of the members.
505
+ #
506
+ # @!attribute [rw] identity_center
507
+ # The IAM Identity Center instance to use as the identity source.
508
+ # @return [Types::IdentityCenter]
509
+ #
510
+ # @see http://docs.aws.amazon.com/goto/WebAPI/account-access-2018-05-10/IdentitySource AWS API Documentation
511
+ #
512
+ class IdentitySource < Struct.new(
513
+ :identity_center,
514
+ :unknown)
515
+ SENSITIVE = []
516
+ include Aws::Structure
517
+ include Aws::Structure::Union
518
+
519
+ class IdentityCenter < IdentitySource; end
520
+ class Unknown < IdentitySource; end
521
+ end
522
+
523
+ # Contains detailed information about the identity source for an
524
+ # application.
525
+ #
526
+ # @note IdentitySourceDetails is a union - when returned from an API call exactly one value will be set and the returned type will be a subclass of IdentitySourceDetails corresponding to the set member.
527
+ #
528
+ # @!attribute [rw] identity_center
529
+ # The IAM Identity Center configuration details for the identity
530
+ # source.
531
+ # @return [Types::IdentityCenterDetails]
532
+ #
533
+ # @see http://docs.aws.amazon.com/goto/WebAPI/account-access-2018-05-10/IdentitySourceDetails AWS API Documentation
534
+ #
535
+ class IdentitySourceDetails < Struct.new(
536
+ :identity_center,
537
+ :unknown)
538
+ SENSITIVE = []
539
+ include Aws::Structure
540
+ include Aws::Structure::Union
541
+
542
+ class IdentityCenter < IdentitySourceDetails; end
543
+ class Unknown < IdentitySourceDetails; end
544
+ end
545
+
546
+ # An internal service error occurred. Try your request again later.
547
+ #
548
+ # @!attribute [rw] message
549
+ # @return [String]
550
+ #
551
+ # @see http://docs.aws.amazon.com/goto/WebAPI/account-access-2018-05-10/InternalServerException AWS API Documentation
552
+ #
553
+ class InternalServerException < Struct.new(
554
+ :message)
555
+ SENSITIVE = []
556
+ include Aws::Structure
557
+ end
558
+
559
+ # @!attribute [rw] max_results
560
+ # Specifies the maximum number of results to return in a single call.
561
+ # @return [Integer]
562
+ #
563
+ # @!attribute [rw] next_token
564
+ # Specifies the pagination token from a previous call to retrieve the
565
+ # next set of results.
566
+ # @return [String]
567
+ #
568
+ # @see http://docs.aws.amazon.com/goto/WebAPI/account-access-2018-05-10/ListApplicationsRequest AWS API Documentation
569
+ #
570
+ class ListApplicationsRequest < Struct.new(
571
+ :max_results,
572
+ :next_token)
573
+ SENSITIVE = []
574
+ include Aws::Structure
575
+ end
576
+
577
+ # @!attribute [rw] applications
578
+ # The list of applications.
579
+ # @return [Array<Types::ApplicationSummary>]
580
+ #
581
+ # @!attribute [rw] next_token
582
+ # The pagination token to use in a subsequent request to retrieve the
583
+ # next set of results. This value is null when there are no more
584
+ # results to return.
585
+ # @return [String]
586
+ #
587
+ # @see http://docs.aws.amazon.com/goto/WebAPI/account-access-2018-05-10/ListApplicationsResponse AWS API Documentation
588
+ #
589
+ class ListApplicationsResponse < Struct.new(
590
+ :applications,
591
+ :next_token)
592
+ SENSITIVE = []
593
+ include Aws::Structure
594
+ end
595
+
596
+ # @!attribute [rw] application_arn
597
+ # Specifies the ARN of the application to list entitlements for.
598
+ # @return [String]
599
+ #
600
+ # @!attribute [rw] filter
601
+ # Specifies filter criteria to narrow the entitlements returned. You
602
+ # can filter by principal, IAM role, or account.
603
+ # @return [Types::EntitlementFilter]
604
+ #
605
+ # @!attribute [rw] next_token
606
+ # Specifies the pagination token from a previous call to retrieve the
607
+ # next set of results.
608
+ # @return [String]
609
+ #
610
+ # @!attribute [rw] max_results
611
+ # Specifies the maximum number of results to return in a single call.
612
+ # @return [Integer]
613
+ #
614
+ # @see http://docs.aws.amazon.com/goto/WebAPI/account-access-2018-05-10/ListEntitlementsRequest AWS API Documentation
615
+ #
616
+ class ListEntitlementsRequest < Struct.new(
617
+ :application_arn,
618
+ :filter,
619
+ :next_token,
620
+ :max_results)
621
+ SENSITIVE = []
622
+ include Aws::Structure
623
+ end
624
+
625
+ # @!attribute [rw] entitlements
626
+ # The list of entitlements for the specified application.
627
+ # @return [Array<Types::EntitlementsListMember>]
628
+ #
629
+ # @!attribute [rw] next_token
630
+ # The pagination token to use in a subsequent request to retrieve the
631
+ # next set of results. This value is null when there are no more
632
+ # results to return.
633
+ # @return [String]
634
+ #
635
+ # @see http://docs.aws.amazon.com/goto/WebAPI/account-access-2018-05-10/ListEntitlementsResponse AWS API Documentation
636
+ #
637
+ class ListEntitlementsResponse < Struct.new(
638
+ :entitlements,
639
+ :next_token)
640
+ SENSITIVE = []
641
+ include Aws::Structure
642
+ end
643
+
644
+ # @!attribute [rw] resource_arn
645
+ # Specifies the ARN of the resource to list tags for.
646
+ # @return [String]
647
+ #
648
+ # @see http://docs.aws.amazon.com/goto/WebAPI/account-access-2018-05-10/ListTagsForResourceRequest AWS API Documentation
649
+ #
650
+ class ListTagsForResourceRequest < Struct.new(
651
+ :resource_arn)
652
+ SENSITIVE = []
653
+ include Aws::Structure
654
+ end
655
+
656
+ # @!attribute [rw] tags
657
+ # The tags associated with the resource.
658
+ # @return [Hash<String,String>]
659
+ #
660
+ # @see http://docs.aws.amazon.com/goto/WebAPI/account-access-2018-05-10/ListTagsForResourceResponse AWS API Documentation
661
+ #
662
+ class ListTagsForResourceResponse < Struct.new(
663
+ :tags)
664
+ SENSITIVE = []
665
+ include Aws::Structure
666
+ end
667
+
668
+ # Identifies a principal (user or group) that can be granted
669
+ # entitlements.
670
+ #
671
+ # @note Principal is a union - when making an API calls you must set exactly one of the members.
672
+ #
673
+ # @note Principal is a union - when returned from an API call exactly one value will be set and the returned type will be a subclass of Principal corresponding to the set member.
674
+ #
675
+ # @!attribute [rw] identity_center
676
+ # The IAM Identity Center principal (user or group).
677
+ # @return [Types::IdentityCenterPrincipal]
678
+ #
679
+ # @see http://docs.aws.amazon.com/goto/WebAPI/account-access-2018-05-10/Principal AWS API Documentation
680
+ #
681
+ class Principal < Struct.new(
682
+ :identity_center,
683
+ :unknown)
684
+ SENSITIVE = []
685
+ include Aws::Structure
686
+ include Aws::Structure::Union
687
+
688
+ class IdentityCenter < Principal; end
689
+ class Unknown < Principal; end
690
+ end
691
+
692
+ # Specifies filter criteria for a principal.
693
+ #
694
+ # @note PrincipalFilter is a union - when making an API calls you must set exactly one of the members.
695
+ #
696
+ # @!attribute [rw] identity_center
697
+ # The IAM Identity Center principal filter criteria.
698
+ # @return [Types::IdentityCenterPrincipalFilter]
699
+ #
700
+ # @see http://docs.aws.amazon.com/goto/WebAPI/account-access-2018-05-10/PrincipalFilter AWS API Documentation
701
+ #
702
+ class PrincipalFilter < Struct.new(
703
+ :identity_center,
704
+ :unknown)
705
+ SENSITIVE = []
706
+ include Aws::Structure
707
+ include Aws::Structure::Union
708
+
709
+ class IdentityCenter < PrincipalFilter; end
710
+ class Unknown < PrincipalFilter; end
711
+ end
712
+
713
+ # Specifies a principal-to-role entitlement that grants an IAM Identity
714
+ # Center principal permission to assume an IAM role.
715
+ #
716
+ # @!attribute [rw] principal
717
+ # The principal (user or group) that is granted access to assume the
718
+ # IAM role.
719
+ # @return [Types::Principal]
720
+ #
721
+ # @!attribute [rw] role_arn
722
+ # The ARN of the IAM role that the principal can assume.
723
+ # @return [String]
724
+ #
725
+ # @see http://docs.aws.amazon.com/goto/WebAPI/account-access-2018-05-10/PrincipalRoleEntitlement AWS API Documentation
726
+ #
727
+ class PrincipalRoleEntitlement < Struct.new(
728
+ :principal,
729
+ :role_arn)
730
+ SENSITIVE = []
731
+ include Aws::Structure
732
+ end
733
+
734
+ # Contains detailed information about a principal-to-role entitlement,
735
+ # including the target account.
736
+ #
737
+ # @!attribute [rw] principal
738
+ # The principal (user or group) that is granted access to assume the
739
+ # IAM role.
740
+ # @return [Types::Principal]
741
+ #
742
+ # @!attribute [rw] role_arn
743
+ # The ARN of the IAM role that the principal can assume.
744
+ # @return [String]
745
+ #
746
+ # @!attribute [rw] account
747
+ # The 12-digit Amazon Web Services account ID where the IAM role
748
+ # resides.
749
+ # @return [String]
750
+ #
751
+ # @!attribute [rw] account_name
752
+ # The friendly name of the Amazon Web Services account where the IAM
753
+ # role resides.
754
+ # @return [String]
755
+ #
756
+ # @see http://docs.aws.amazon.com/goto/WebAPI/account-access-2018-05-10/PrincipalRoleEntitlementDetails AWS API Documentation
757
+ #
758
+ class PrincipalRoleEntitlementDetails < Struct.new(
759
+ :principal,
760
+ :role_arn,
761
+ :account,
762
+ :account_name)
763
+ SENSITIVE = []
764
+ include Aws::Structure
765
+ end
766
+
767
+ # Specifies filter criteria for principal-to-role entitlements. All
768
+ # specified criteria must match for an entitlement to be returned.
769
+ #
770
+ # @!attribute [rw] principal
771
+ # The principal to filter entitlements by.
772
+ # @return [Types::PrincipalFilter]
773
+ #
774
+ # @!attribute [rw] role_arn
775
+ # The IAM role ARN to filter entitlements by.
776
+ # @return [String]
777
+ #
778
+ # @!attribute [rw] account
779
+ # The 12-digit Amazon Web Services account ID to filter entitlements
780
+ # by.
781
+ # @return [String]
782
+ #
783
+ # @see http://docs.aws.amazon.com/goto/WebAPI/account-access-2018-05-10/PrincipalRoleEntitlementFilter AWS API Documentation
784
+ #
785
+ class PrincipalRoleEntitlementFilter < Struct.new(
786
+ :principal,
787
+ :role_arn,
788
+ :account)
789
+ SENSITIVE = []
790
+ include Aws::Structure
791
+ end
792
+
793
+ # Contains summary information about a principal-to-role entitlement.
794
+ #
795
+ # @!attribute [rw] principal
796
+ # The principal (user or group) that is granted access to assume the
797
+ # IAM role.
798
+ # @return [Types::Principal]
799
+ #
800
+ # @!attribute [rw] role_arn
801
+ # The ARN of the IAM role that the principal can assume.
802
+ # @return [String]
803
+ #
804
+ # @!attribute [rw] account
805
+ # The 12-digit Amazon Web Services account ID where the IAM role
806
+ # resides.
807
+ # @return [String]
808
+ #
809
+ # @!attribute [rw] account_name
810
+ # The friendly name of the Amazon Web Services account where the IAM
811
+ # role resides.
812
+ # @return [String]
813
+ #
814
+ # @see http://docs.aws.amazon.com/goto/WebAPI/account-access-2018-05-10/PrincipalRoleEntitlementSummary AWS API Documentation
815
+ #
816
+ class PrincipalRoleEntitlementSummary < Struct.new(
817
+ :principal,
818
+ :role_arn,
819
+ :account,
820
+ :account_name)
821
+ SENSITIVE = []
822
+ include Aws::Structure
823
+ end
824
+
825
+ # The specified resource does not exist. Verify that the resource
826
+ # identifier is correct and that the resource exists in the current
827
+ # Region.
828
+ #
829
+ # @!attribute [rw] message
830
+ # @return [String]
831
+ #
832
+ # @see http://docs.aws.amazon.com/goto/WebAPI/account-access-2018-05-10/ResourceNotFoundException AWS API Documentation
833
+ #
834
+ class ResourceNotFoundException < Struct.new(
835
+ :message)
836
+ SENSITIVE = []
837
+ include Aws::Structure
838
+ end
839
+
840
+ # The request exceeds a service quota for your account.
841
+ #
842
+ # @!attribute [rw] message
843
+ # @return [String]
844
+ #
845
+ # @see http://docs.aws.amazon.com/goto/WebAPI/account-access-2018-05-10/ServiceQuotaExceededException AWS API Documentation
846
+ #
847
+ class ServiceQuotaExceededException < Struct.new(
848
+ :message)
849
+ SENSITIVE = []
850
+ include Aws::Structure
851
+ end
852
+
853
+ # @!attribute [rw] resource_arn
854
+ # Specifies the ARN of the resource to add tags to.
855
+ # @return [String]
856
+ #
857
+ # @!attribute [rw] tags
858
+ # Specifies the tags to add to the resource.
859
+ # @return [Hash<String,String>]
860
+ #
861
+ # @see http://docs.aws.amazon.com/goto/WebAPI/account-access-2018-05-10/TagResourceRequest AWS API Documentation
862
+ #
863
+ class TagResourceRequest < Struct.new(
864
+ :resource_arn,
865
+ :tags)
866
+ SENSITIVE = []
867
+ include Aws::Structure
868
+ end
869
+
870
+ # @see http://docs.aws.amazon.com/goto/WebAPI/account-access-2018-05-10/TagResourceResponse AWS API Documentation
871
+ #
872
+ class TagResourceResponse < Aws::EmptyStructure; end
873
+
874
+ # The request was denied due to request throttling. Try your request
875
+ # again later.
876
+ #
877
+ # @!attribute [rw] message
878
+ # @return [String]
879
+ #
880
+ # @see http://docs.aws.amazon.com/goto/WebAPI/account-access-2018-05-10/ThrottlingException AWS API Documentation
881
+ #
882
+ class ThrottlingException < Struct.new(
883
+ :message)
884
+ SENSITIVE = []
885
+ include Aws::Structure
886
+ end
887
+
888
+ # @!attribute [rw] resource_arn
889
+ # Specifies the ARN of the resource to remove tags from.
890
+ # @return [String]
891
+ #
892
+ # @!attribute [rw] tag_keys
893
+ # Specifies the tag keys to remove from the resource.
894
+ # @return [Array<String>]
895
+ #
896
+ # @see http://docs.aws.amazon.com/goto/WebAPI/account-access-2018-05-10/UntagResourceRequest AWS API Documentation
897
+ #
898
+ class UntagResourceRequest < Struct.new(
899
+ :resource_arn,
900
+ :tag_keys)
901
+ SENSITIVE = []
902
+ include Aws::Structure
903
+ end
904
+
905
+ # @see http://docs.aws.amazon.com/goto/WebAPI/account-access-2018-05-10/UntagResourceResponse AWS API Documentation
906
+ #
907
+ class UntagResourceResponse < Aws::EmptyStructure; end
908
+
909
+ # The input does not satisfy the constraints specified by the service.
910
+ # Check your request parameters and retry the request.
911
+ #
912
+ # @!attribute [rw] message
913
+ # @return [String]
914
+ #
915
+ # @see http://docs.aws.amazon.com/goto/WebAPI/account-access-2018-05-10/ValidationException AWS API Documentation
916
+ #
917
+ class ValidationException < Struct.new(
918
+ :message)
919
+ SENSITIVE = []
920
+ include Aws::Structure
921
+ end
922
+
923
+ end
924
+ end
925
+