aws-sdk-mpa 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,2151 @@
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::MPA
11
+ module Types
12
+
13
+ # You do not have sufficient access to perform this action. Check your
14
+ # permissions, and try again.
15
+ #
16
+ # @!attribute [rw] message
17
+ # Message for the `AccessDeniedException` error.
18
+ # @return [String]
19
+ #
20
+ # @see http://docs.aws.amazon.com/goto/WebAPI/mpa-2022-07-26/AccessDeniedException AWS API Documentation
21
+ #
22
+ class AccessDeniedException < Struct.new(
23
+ :message)
24
+ SENSITIVE = []
25
+ include Aws::Structure
26
+ end
27
+
28
+ # Strategy for how an approval team grants approval.
29
+ #
30
+ # @note ApprovalStrategy is a union - when making an API calls you must set exactly one of the members.
31
+ #
32
+ # @!attribute [rw] mof_n
33
+ # Minimum number of approvals (M) required for a total number of
34
+ # approvers (N).
35
+ # @return [Types::MofNApprovalStrategy]
36
+ #
37
+ # @see http://docs.aws.amazon.com/goto/WebAPI/mpa-2022-07-26/ApprovalStrategy AWS API Documentation
38
+ #
39
+ class ApprovalStrategy < Struct.new(
40
+ :mof_n,
41
+ :unknown)
42
+ SENSITIVE = []
43
+ include Aws::Structure
44
+ include Aws::Structure::Union
45
+
46
+ class MofN < ApprovalStrategy; end
47
+ class Unknown < ApprovalStrategy; end
48
+ end
49
+
50
+ # Contains details for how an approval team grants approval.
51
+ #
52
+ # @note ApprovalStrategyResponse is a union - when returned from an API call exactly one value will be set and the returned type will be a subclass of ApprovalStrategyResponse corresponding to the set member.
53
+ #
54
+ # @!attribute [rw] mof_n
55
+ # Minimum number of approvals (M) required for a total number of
56
+ # approvers (N).
57
+ # @return [Types::MofNApprovalStrategy]
58
+ #
59
+ # @see http://docs.aws.amazon.com/goto/WebAPI/mpa-2022-07-26/ApprovalStrategyResponse AWS API Documentation
60
+ #
61
+ class ApprovalStrategyResponse < Struct.new(
62
+ :mof_n,
63
+ :unknown)
64
+ SENSITIVE = []
65
+ include Aws::Structure
66
+ include Aws::Structure::Union
67
+
68
+ class MofN < ApprovalStrategyResponse; end
69
+ class Unknown < ApprovalStrategyResponse; end
70
+ end
71
+
72
+ # Contains details for an approver.
73
+ #
74
+ # @!attribute [rw] primary_identity_id
75
+ # ID for the user.
76
+ # @return [String]
77
+ #
78
+ # @!attribute [rw] primary_identity_source_arn
79
+ # Amazon Resource Name (ARN) for the identity source. The identity
80
+ # source manages the user authentication for approvers.
81
+ # @return [String]
82
+ #
83
+ # @see http://docs.aws.amazon.com/goto/WebAPI/mpa-2022-07-26/ApprovalTeamRequestApprover AWS API Documentation
84
+ #
85
+ class ApprovalTeamRequestApprover < Struct.new(
86
+ :primary_identity_id,
87
+ :primary_identity_source_arn)
88
+ SENSITIVE = []
89
+ include Aws::Structure
90
+ end
91
+
92
+ # @!attribute [rw] session_arn
93
+ # Amazon Resource Name (ARN) for the session.
94
+ # @return [String]
95
+ #
96
+ # @see http://docs.aws.amazon.com/goto/WebAPI/mpa-2022-07-26/CancelSessionRequest AWS API Documentation
97
+ #
98
+ class CancelSessionRequest < Struct.new(
99
+ :session_arn)
100
+ SENSITIVE = []
101
+ include Aws::Structure
102
+ end
103
+
104
+ # @see http://docs.aws.amazon.com/goto/WebAPI/mpa-2022-07-26/CancelSessionResponse AWS API Documentation
105
+ #
106
+ class CancelSessionResponse < Aws::EmptyStructure; end
107
+
108
+ # The request cannot be completed because it conflicts with the current
109
+ # state of a resource.
110
+ #
111
+ # @!attribute [rw] message
112
+ # Message for the `ConflictException` error.
113
+ # @return [String]
114
+ #
115
+ # @see http://docs.aws.amazon.com/goto/WebAPI/mpa-2022-07-26/ConflictException AWS API Documentation
116
+ #
117
+ class ConflictException < Struct.new(
118
+ :message)
119
+ SENSITIVE = []
120
+ include Aws::Structure
121
+ end
122
+
123
+ # @!attribute [rw] client_token
124
+ # Unique, case-sensitive identifier that you provide to ensure the
125
+ # idempotency of the request. If not provided, the Amazon Web Services
126
+ # populates this field.
127
+ #
128
+ # <note markdown="1"> **What is idempotency?**
129
+ #
130
+ # When you make a mutating API request, the request typically returns
131
+ # a result before the operation's asynchronous workflows have
132
+ # completed. Operations might also time out or encounter other server
133
+ # issues before they complete, even though the request has already
134
+ # returned a result. This could make it difficult to determine whether
135
+ # the request succeeded or not, and could lead to multiple retries to
136
+ # ensure that the operation completes successfully. However, if the
137
+ # original request and the subsequent retries are successful, the
138
+ # operation is completed multiple times. This means that you might
139
+ # create more resources than you intended.
140
+ #
141
+ # *Idempotency* ensures that an API request completes no more than one
142
+ # time. With an idempotent request, if the original request completes
143
+ # successfully, any subsequent retries complete successfully without
144
+ # performing any further actions.
145
+ #
146
+ # </note>
147
+ #
148
+ # **A suitable default value is auto-generated.** You should normally
149
+ # not need to pass this option.
150
+ # @return [String]
151
+ #
152
+ # @!attribute [rw] approval_strategy
153
+ # An `ApprovalStrategy` object. Contains details for how the team
154
+ # grants approval.
155
+ # @return [Types::ApprovalStrategy]
156
+ #
157
+ # @!attribute [rw] approvers
158
+ # An array of `ApprovalTeamRequesterApprovers` objects. Contains
159
+ # details for the approvers in the team.
160
+ # @return [Array<Types::ApprovalTeamRequestApprover>]
161
+ #
162
+ # @!attribute [rw] description
163
+ # Description for the team.
164
+ # @return [String]
165
+ #
166
+ # @!attribute [rw] policies
167
+ # An array of `PolicyReference` objects. Contains a list of policies
168
+ # that define the permissions for team resources.
169
+ #
170
+ # The protected operation for a service integration might require
171
+ # specific permissions. For more information, see [How other services
172
+ # work with Multi-party approval][1] in the *Multi-party approval User
173
+ # Guide*.
174
+ #
175
+ #
176
+ #
177
+ # [1]: https://docs.aws.amazon.com/mpa/latest/userguide/mpa-integrations.html
178
+ # @return [Array<Types::PolicyReference>]
179
+ #
180
+ # @!attribute [rw] name
181
+ # Name of the team.
182
+ # @return [String]
183
+ #
184
+ # @!attribute [rw] tags
185
+ # Tags you want to attach to the team.
186
+ # @return [Hash<String,String>]
187
+ #
188
+ # @see http://docs.aws.amazon.com/goto/WebAPI/mpa-2022-07-26/CreateApprovalTeamRequest AWS API Documentation
189
+ #
190
+ class CreateApprovalTeamRequest < Struct.new(
191
+ :client_token,
192
+ :approval_strategy,
193
+ :approvers,
194
+ :description,
195
+ :policies,
196
+ :name,
197
+ :tags)
198
+ SENSITIVE = [:description, :tags]
199
+ include Aws::Structure
200
+ end
201
+
202
+ # @!attribute [rw] creation_time
203
+ # Timestamp when the team was created.
204
+ # @return [Time]
205
+ #
206
+ # @!attribute [rw] arn
207
+ # Amazon Resource Name (ARN) for the team that was created.
208
+ # @return [String]
209
+ #
210
+ # @!attribute [rw] name
211
+ # Name of the team that was created.
212
+ # @return [String]
213
+ #
214
+ # @!attribute [rw] version_id
215
+ # Version ID for the team that was created. When a team is updated,
216
+ # the version ID changes.
217
+ # @return [String]
218
+ #
219
+ # @see http://docs.aws.amazon.com/goto/WebAPI/mpa-2022-07-26/CreateApprovalTeamResponse AWS API Documentation
220
+ #
221
+ class CreateApprovalTeamResponse < Struct.new(
222
+ :creation_time,
223
+ :arn,
224
+ :name,
225
+ :version_id)
226
+ SENSITIVE = []
227
+ include Aws::Structure
228
+ end
229
+
230
+ # @!attribute [rw] identity_source_parameters
231
+ # A ` IdentitySourceParameters` object. Contains details for the
232
+ # resource that provides identities to the identity source. For
233
+ # example, an IAM Identity Center instance.
234
+ # @return [Types::IdentitySourceParameters]
235
+ #
236
+ # @!attribute [rw] client_token
237
+ # Unique, case-sensitive identifier that you provide to ensure the
238
+ # idempotency of the request. If not provided, the Amazon Web Services
239
+ # populates this field.
240
+ #
241
+ # <note markdown="1"> **What is idempotency?**
242
+ #
243
+ # When you make a mutating API request, the request typically returns
244
+ # a result before the operation's asynchronous workflows have
245
+ # completed. Operations might also time out or encounter other server
246
+ # issues before they complete, even though the request has already
247
+ # returned a result. This could make it difficult to determine whether
248
+ # the request succeeded or not, and could lead to multiple retries to
249
+ # ensure that the operation completes successfully. However, if the
250
+ # original request and the subsequent retries are successful, the
251
+ # operation is completed multiple times. This means that you might
252
+ # create more resources than you intended.
253
+ #
254
+ # *Idempotency* ensures that an API request completes no more than one
255
+ # time. With an idempotent request, if the original request completes
256
+ # successfully, any subsequent retries complete successfully without
257
+ # performing any further actions.
258
+ #
259
+ # </note>
260
+ #
261
+ # **A suitable default value is auto-generated.** You should normally
262
+ # not need to pass this option.
263
+ # @return [String]
264
+ #
265
+ # @!attribute [rw] tags
266
+ # Tag you want to attach to the identity source.
267
+ # @return [Hash<String,String>]
268
+ #
269
+ # @see http://docs.aws.amazon.com/goto/WebAPI/mpa-2022-07-26/CreateIdentitySourceRequest AWS API Documentation
270
+ #
271
+ class CreateIdentitySourceRequest < Struct.new(
272
+ :identity_source_parameters,
273
+ :client_token,
274
+ :tags)
275
+ SENSITIVE = [:tags]
276
+ include Aws::Structure
277
+ end
278
+
279
+ # @!attribute [rw] identity_source_type
280
+ # The type of resource that provided identities to the identity
281
+ # source. For example, an IAM Identity Center instance.
282
+ # @return [String]
283
+ #
284
+ # @!attribute [rw] identity_source_arn
285
+ # Amazon Resource Name (ARN) for the identity source that was created.
286
+ # @return [String]
287
+ #
288
+ # @!attribute [rw] creation_time
289
+ # Timestamp when the identity source was created.
290
+ # @return [Time]
291
+ #
292
+ # @see http://docs.aws.amazon.com/goto/WebAPI/mpa-2022-07-26/CreateIdentitySourceResponse AWS API Documentation
293
+ #
294
+ class CreateIdentitySourceResponse < Struct.new(
295
+ :identity_source_type,
296
+ :identity_source_arn,
297
+ :creation_time)
298
+ SENSITIVE = []
299
+ include Aws::Structure
300
+ end
301
+
302
+ # @!attribute [rw] identity_source_arn
303
+ # Amazon Resource Name (ARN) for identity source.
304
+ # @return [String]
305
+ #
306
+ # @see http://docs.aws.amazon.com/goto/WebAPI/mpa-2022-07-26/DeleteIdentitySourceRequest AWS API Documentation
307
+ #
308
+ class DeleteIdentitySourceRequest < Struct.new(
309
+ :identity_source_arn)
310
+ SENSITIVE = []
311
+ include Aws::Structure
312
+ end
313
+
314
+ # @!attribute [rw] arn
315
+ # Amaazon Resource Name (ARN) for the team.
316
+ # @return [String]
317
+ #
318
+ # @!attribute [rw] version_id
319
+ # Version ID for the team.
320
+ # @return [String]
321
+ #
322
+ # @see http://docs.aws.amazon.com/goto/WebAPI/mpa-2022-07-26/DeleteInactiveApprovalTeamVersionRequest AWS API Documentation
323
+ #
324
+ class DeleteInactiveApprovalTeamVersionRequest < Struct.new(
325
+ :arn,
326
+ :version_id)
327
+ SENSITIVE = []
328
+ include Aws::Structure
329
+ end
330
+
331
+ # @see http://docs.aws.amazon.com/goto/WebAPI/mpa-2022-07-26/DeleteInactiveApprovalTeamVersionResponse AWS API Documentation
332
+ #
333
+ class DeleteInactiveApprovalTeamVersionResponse < Aws::EmptyStructure; end
334
+
335
+ # Contains the filter to apply to requests. You can specify up to 10
336
+ # filters for a request.
337
+ #
338
+ # @!attribute [rw] field_name
339
+ # Name of the filter to use.
340
+ #
341
+ # <note markdown="1"> **Supported filters**
342
+ #
343
+ # The supported filters for ListSessions are: `ActionName`,
344
+ # `SessionStatus`, and `InitationTime`.
345
+ #
346
+ # </note>
347
+ # @return [String]
348
+ #
349
+ # @!attribute [rw] operator
350
+ # Operator to use for filtering.
351
+ #
352
+ # * `EQ`: Equal to the specified value
353
+ #
354
+ # * `NE`: Not equal to the specified value
355
+ #
356
+ # * `GT`: Greater than the specified value
357
+ #
358
+ # * `LT`: Less than the specified value
359
+ #
360
+ # * `GTE`: Greater than or equal to the specified value
361
+ #
362
+ # * `LTE`: Less than or equal to the specified value
363
+ #
364
+ # * `CONTAINS`: Contains the specified value
365
+ #
366
+ # * `NOT_CONTAINS`: Does not contain the specified value
367
+ #
368
+ # * `BETWEEN`: Between two values, inclusive of the specified values.
369
+ #
370
+ # <note markdown="1"> **Supported operators for each filter**:
371
+ #
372
+ # * `ActionName`: `EQ` \| `NE` \| `CONTAINS` \| `NOT_CONTAINS`
373
+ #
374
+ # * `SessionStatus`: `EQ` \| `NE`
375
+ #
376
+ # * `InitiationTime`: `GT` \| `LT` \| `GTE` \| `LTE` \| `BETWEEN`
377
+ #
378
+ # </note>
379
+ # @return [String]
380
+ #
381
+ # @!attribute [rw] value
382
+ # Value to use for filtering. For the `BETWEEN` operator, specify
383
+ # values in the format `a AND b` (`AND` is case-insensitive).
384
+ # @return [String]
385
+ #
386
+ # @see http://docs.aws.amazon.com/goto/WebAPI/mpa-2022-07-26/Filter AWS API Documentation
387
+ #
388
+ class Filter < Struct.new(
389
+ :field_name,
390
+ :operator,
391
+ :value)
392
+ SENSITIVE = []
393
+ include Aws::Structure
394
+ end
395
+
396
+ # @!attribute [rw] arn
397
+ # Amazon Resource Name (ARN) for the team.
398
+ # @return [String]
399
+ #
400
+ # @see http://docs.aws.amazon.com/goto/WebAPI/mpa-2022-07-26/GetApprovalTeamRequest AWS API Documentation
401
+ #
402
+ class GetApprovalTeamRequest < Struct.new(
403
+ :arn)
404
+ SENSITIVE = []
405
+ include Aws::Structure
406
+ end
407
+
408
+ # @!attribute [rw] creation_time
409
+ # Timestamp when the team was created.
410
+ # @return [Time]
411
+ #
412
+ # @!attribute [rw] approval_strategy
413
+ # An `ApprovalStrategyResponse` object. Contains details for how the
414
+ # team grants approval.
415
+ # @return [Types::ApprovalStrategyResponse]
416
+ #
417
+ # @!attribute [rw] number_of_approvers
418
+ # Total number of approvers in the team.
419
+ # @return [Integer]
420
+ #
421
+ # @!attribute [rw] approvers
422
+ # An array of `GetApprovalTeamResponseApprover ` objects. Contains
423
+ # details for the approvers in the team.
424
+ # @return [Array<Types::GetApprovalTeamResponseApprover>]
425
+ #
426
+ # @!attribute [rw] arn
427
+ # Amazon Resource Name (ARN) for the team.
428
+ # @return [String]
429
+ #
430
+ # @!attribute [rw] description
431
+ # Description for the team.
432
+ # @return [String]
433
+ #
434
+ # @!attribute [rw] name
435
+ # Name of the approval team.
436
+ # @return [String]
437
+ #
438
+ # @!attribute [rw] status
439
+ # Status for the team. For more information, see [Team health][1] in
440
+ # the *Multi-party approval User Guide*.
441
+ #
442
+ #
443
+ #
444
+ # [1]: https://docs.aws.amazon.com/mpa/latest/userguide/mpa-health.html
445
+ # @return [String]
446
+ #
447
+ # @!attribute [rw] status_code
448
+ # Status code for the approval team. For more information, see [Team
449
+ # health][1] in the *Multi-party approval User Guide*.
450
+ #
451
+ #
452
+ #
453
+ # [1]: https://docs.aws.amazon.com/mpa/latest/userguide/mpa-health.html
454
+ # @return [String]
455
+ #
456
+ # @!attribute [rw] status_message
457
+ # Message describing the status for the team.
458
+ # @return [String]
459
+ #
460
+ # @!attribute [rw] update_session_arn
461
+ # Amazon Resource Name (ARN) for the session.
462
+ # @return [String]
463
+ #
464
+ # @!attribute [rw] version_id
465
+ # Version ID for the team.
466
+ # @return [String]
467
+ #
468
+ # @!attribute [rw] policies
469
+ # An array of `PolicyReference` objects. Contains a list of policies
470
+ # that define the permissions for team resources.
471
+ #
472
+ # The protected operation for a service integration might require
473
+ # specific permissions. For more information, see [How other services
474
+ # work with Multi-party approval][1] in the *Multi-party approval User
475
+ # Guide*.
476
+ #
477
+ #
478
+ #
479
+ # [1]: https://docs.aws.amazon.com/mpa/latest/userguide/mpa-integrations.html
480
+ # @return [Array<Types::PolicyReference>]
481
+ #
482
+ # @!attribute [rw] last_update_time
483
+ # Timestamp when the team was last updated.
484
+ # @return [Time]
485
+ #
486
+ # @!attribute [rw] pending_update
487
+ # A `PendingUpdate` object. Contains details for the pending updates
488
+ # for the team, if applicable.
489
+ # @return [Types::PendingUpdate]
490
+ #
491
+ # @see http://docs.aws.amazon.com/goto/WebAPI/mpa-2022-07-26/GetApprovalTeamResponse AWS API Documentation
492
+ #
493
+ class GetApprovalTeamResponse < Struct.new(
494
+ :creation_time,
495
+ :approval_strategy,
496
+ :number_of_approvers,
497
+ :approvers,
498
+ :arn,
499
+ :description,
500
+ :name,
501
+ :status,
502
+ :status_code,
503
+ :status_message,
504
+ :update_session_arn,
505
+ :version_id,
506
+ :policies,
507
+ :last_update_time,
508
+ :pending_update)
509
+ SENSITIVE = [:description]
510
+ include Aws::Structure
511
+ end
512
+
513
+ # Contains details for an approver.
514
+ #
515
+ # @!attribute [rw] approver_id
516
+ # ID for the approver.
517
+ # @return [String]
518
+ #
519
+ # @!attribute [rw] response_time
520
+ # Timestamp when the approver responded to an approval team
521
+ # invitation.
522
+ # @return [Time]
523
+ #
524
+ # @!attribute [rw] primary_identity_id
525
+ # ID for the user.
526
+ # @return [String]
527
+ #
528
+ # @!attribute [rw] primary_identity_source_arn
529
+ # Amazon Resource Name (ARN) for the identity source. The identity
530
+ # source manages the user authentication for approvers.
531
+ # @return [String]
532
+ #
533
+ # @!attribute [rw] primary_identity_status
534
+ # Status for the identity source. For example, if an approver has
535
+ # accepted a team invitation with a user authentication method managed
536
+ # by the identity source.
537
+ # @return [String]
538
+ #
539
+ # @see http://docs.aws.amazon.com/goto/WebAPI/mpa-2022-07-26/GetApprovalTeamResponseApprover AWS API Documentation
540
+ #
541
+ class GetApprovalTeamResponseApprover < Struct.new(
542
+ :approver_id,
543
+ :response_time,
544
+ :primary_identity_id,
545
+ :primary_identity_source_arn,
546
+ :primary_identity_status)
547
+ SENSITIVE = []
548
+ include Aws::Structure
549
+ end
550
+
551
+ # @!attribute [rw] identity_source_arn
552
+ # Amazon Resource Name (ARN) for the identity source.
553
+ # @return [String]
554
+ #
555
+ # @see http://docs.aws.amazon.com/goto/WebAPI/mpa-2022-07-26/GetIdentitySourceRequest AWS API Documentation
556
+ #
557
+ class GetIdentitySourceRequest < Struct.new(
558
+ :identity_source_arn)
559
+ SENSITIVE = []
560
+ include Aws::Structure
561
+ end
562
+
563
+ # @!attribute [rw] identity_source_type
564
+ # The type of resource that provided identities to the identity
565
+ # source. For example, an IAM Identity Center instance.
566
+ # @return [String]
567
+ #
568
+ # @!attribute [rw] identity_source_parameters
569
+ # A ` IdentitySourceParameters` object. Contains details for the
570
+ # resource that provides identities to the identity source. For
571
+ # example, an IAM Identity Center instance.
572
+ # @return [Types::IdentitySourceParametersForGet]
573
+ #
574
+ # @!attribute [rw] identity_source_arn
575
+ # Amazon Resource Name (ARN) for the identity source.
576
+ # @return [String]
577
+ #
578
+ # @!attribute [rw] creation_time
579
+ # Timestamp when the identity source was created.
580
+ # @return [Time]
581
+ #
582
+ # @!attribute [rw] status
583
+ # Status for the identity source. For example, if the identity source
584
+ # is `ACTIVE`.
585
+ # @return [String]
586
+ #
587
+ # @!attribute [rw] status_code
588
+ # Status code of the identity source.
589
+ # @return [String]
590
+ #
591
+ # @!attribute [rw] status_message
592
+ # Message describing the status for the identity source.
593
+ # @return [String]
594
+ #
595
+ # @see http://docs.aws.amazon.com/goto/WebAPI/mpa-2022-07-26/GetIdentitySourceResponse AWS API Documentation
596
+ #
597
+ class GetIdentitySourceResponse < Struct.new(
598
+ :identity_source_type,
599
+ :identity_source_parameters,
600
+ :identity_source_arn,
601
+ :creation_time,
602
+ :status,
603
+ :status_code,
604
+ :status_message)
605
+ SENSITIVE = []
606
+ include Aws::Structure
607
+ end
608
+
609
+ # @!attribute [rw] policy_version_arn
610
+ # Amazon Resource Name (ARN) for the policy.
611
+ # @return [String]
612
+ #
613
+ # @see http://docs.aws.amazon.com/goto/WebAPI/mpa-2022-07-26/GetPolicyVersionRequest AWS API Documentation
614
+ #
615
+ class GetPolicyVersionRequest < Struct.new(
616
+ :policy_version_arn)
617
+ SENSITIVE = []
618
+ include Aws::Structure
619
+ end
620
+
621
+ # @!attribute [rw] policy_version
622
+ # A `PolicyVersion` object. Contains details for the version of the
623
+ # policy. Policies define the permissions for team resources.
624
+ #
625
+ # The protected operation for a service integration might require
626
+ # specific permissions. For more information, see [How other services
627
+ # work with Multi-party approval][1] in the *Multi-party approval User
628
+ # Guide*.
629
+ #
630
+ #
631
+ #
632
+ # [1]: https://docs.aws.amazon.com/mpa/latest/userguide/mpa-integrations.html
633
+ # @return [Types::PolicyVersion]
634
+ #
635
+ # @see http://docs.aws.amazon.com/goto/WebAPI/mpa-2022-07-26/GetPolicyVersionResponse AWS API Documentation
636
+ #
637
+ class GetPolicyVersionResponse < Struct.new(
638
+ :policy_version)
639
+ SENSITIVE = []
640
+ include Aws::Structure
641
+ end
642
+
643
+ # @!attribute [rw] resource_arn
644
+ # Amazon Resource Name (ARN) for the resource.
645
+ # @return [String]
646
+ #
647
+ # @!attribute [rw] policy_name
648
+ # Name of the policy.
649
+ # @return [String]
650
+ #
651
+ # @!attribute [rw] policy_type
652
+ # The type of policy.
653
+ # @return [String]
654
+ #
655
+ # @see http://docs.aws.amazon.com/goto/WebAPI/mpa-2022-07-26/GetResourcePolicyRequest AWS API Documentation
656
+ #
657
+ class GetResourcePolicyRequest < Struct.new(
658
+ :resource_arn,
659
+ :policy_name,
660
+ :policy_type)
661
+ SENSITIVE = []
662
+ include Aws::Structure
663
+ end
664
+
665
+ # @!attribute [rw] resource_arn
666
+ # Amazon Resource Name (ARN) for the resource.
667
+ # @return [String]
668
+ #
669
+ # @!attribute [rw] policy_type
670
+ # The type of policy
671
+ # @return [String]
672
+ #
673
+ # @!attribute [rw] policy_version_arn
674
+ # Amazon Resource Name (ARN) for the policy version.
675
+ # @return [String]
676
+ #
677
+ # @!attribute [rw] policy_name
678
+ # Name of the policy.
679
+ # @return [String]
680
+ #
681
+ # @!attribute [rw] policy_document
682
+ # Document that contains the contents for the policy.
683
+ # @return [String]
684
+ #
685
+ # @see http://docs.aws.amazon.com/goto/WebAPI/mpa-2022-07-26/GetResourcePolicyResponse AWS API Documentation
686
+ #
687
+ class GetResourcePolicyResponse < Struct.new(
688
+ :resource_arn,
689
+ :policy_type,
690
+ :policy_version_arn,
691
+ :policy_name,
692
+ :policy_document)
693
+ SENSITIVE = [:policy_document]
694
+ include Aws::Structure
695
+ end
696
+
697
+ # @!attribute [rw] session_arn
698
+ # Amazon Resource Name (ARN) for the session.
699
+ # @return [String]
700
+ #
701
+ # @see http://docs.aws.amazon.com/goto/WebAPI/mpa-2022-07-26/GetSessionRequest AWS API Documentation
702
+ #
703
+ class GetSessionRequest < Struct.new(
704
+ :session_arn)
705
+ SENSITIVE = []
706
+ include Aws::Structure
707
+ end
708
+
709
+ # @!attribute [rw] session_arn
710
+ # Amazon Resource Name (ARN) for the session.
711
+ # @return [String]
712
+ #
713
+ # @!attribute [rw] approval_team_arn
714
+ # Amazon Resource Name (ARN) for the approval team.
715
+ # @return [String]
716
+ #
717
+ # @!attribute [rw] approval_team_name
718
+ # Name of the approval team.
719
+ # @return [String]
720
+ #
721
+ # @!attribute [rw] protected_resource_arn
722
+ # Amazon Resource Name (ARN) for the protected operation.
723
+ # @return [String]
724
+ #
725
+ # @!attribute [rw] approval_strategy
726
+ # An `ApprovalStrategyResponse` object. Contains details for how the
727
+ # team grants approval
728
+ # @return [Types::ApprovalStrategyResponse]
729
+ #
730
+ # @!attribute [rw] number_of_approvers
731
+ # Total number of approvers in the session.
732
+ # @return [Integer]
733
+ #
734
+ # @!attribute [rw] initiation_time
735
+ # Timestamp when the session was initiated.
736
+ # @return [Time]
737
+ #
738
+ # @!attribute [rw] expiration_time
739
+ # Timestamp when the session will expire.
740
+ # @return [Time]
741
+ #
742
+ # @!attribute [rw] completion_time
743
+ # Timestamp when the session completed.
744
+ # @return [Time]
745
+ #
746
+ # @!attribute [rw] description
747
+ # Description for the session.
748
+ # @return [String]
749
+ #
750
+ # @!attribute [rw] metadata
751
+ # Metadata for the session.
752
+ # @return [Hash<String,String>]
753
+ #
754
+ # @!attribute [rw] status
755
+ # Status for the session. For example, if the team has approved the
756
+ # requested operation.
757
+ # @return [String]
758
+ #
759
+ # @!attribute [rw] status_code
760
+ # Status code of the session.
761
+ # @return [String]
762
+ #
763
+ # @!attribute [rw] status_message
764
+ # Message describing the status for session.
765
+ # @return [String]
766
+ #
767
+ # @!attribute [rw] execution_status
768
+ # Status for the protected operation. For example, if the operation is
769
+ # `PENDING`.
770
+ # @return [String]
771
+ #
772
+ # @!attribute [rw] action_name
773
+ # Name of the protected operation.
774
+ # @return [String]
775
+ #
776
+ # @!attribute [rw] requester_service_principal
777
+ # [Service principal][1] for the service associated with the protected
778
+ # operation.
779
+ #
780
+ #
781
+ #
782
+ # [1]: https://docs.aws.amazon.com/IAM/latest/UserGuide/reference_policies_elements_principal.html#principal-services
783
+ # @return [String]
784
+ #
785
+ # @!attribute [rw] requester_principal_arn
786
+ # [IAM principal][1] that made the operation request.
787
+ #
788
+ #
789
+ #
790
+ # [1]: https://docs.aws.amazon.com/IAM/latest/UserGuide/intro-structure.html#intro-structure-request
791
+ # @return [String]
792
+ #
793
+ # @!attribute [rw] requester_account_id
794
+ # ID for the account that made the operation request.
795
+ # @return [String]
796
+ #
797
+ # @!attribute [rw] requester_region
798
+ # Amazon Web Services Region where the operation request originated.
799
+ # @return [String]
800
+ #
801
+ # @!attribute [rw] requester_comment
802
+ # Message from the account that made the operation request
803
+ # @return [String]
804
+ #
805
+ # @!attribute [rw] action_completion_strategy
806
+ # Strategy for executing the protected operation.
807
+ # `AUTO_COMPLETION_UPON_APPROVAL` means the operation is automatically
808
+ # executed using the requester's permissions, if approved.
809
+ # @return [String]
810
+ #
811
+ # @!attribute [rw] approver_responses
812
+ # An array of `GetSessionResponseApproverResponse` objects. Contains
813
+ # details for approver responses in the session.
814
+ # @return [Array<Types::GetSessionResponseApproverResponse>]
815
+ #
816
+ # @see http://docs.aws.amazon.com/goto/WebAPI/mpa-2022-07-26/GetSessionResponse AWS API Documentation
817
+ #
818
+ class GetSessionResponse < Struct.new(
819
+ :session_arn,
820
+ :approval_team_arn,
821
+ :approval_team_name,
822
+ :protected_resource_arn,
823
+ :approval_strategy,
824
+ :number_of_approvers,
825
+ :initiation_time,
826
+ :expiration_time,
827
+ :completion_time,
828
+ :description,
829
+ :metadata,
830
+ :status,
831
+ :status_code,
832
+ :status_message,
833
+ :execution_status,
834
+ :action_name,
835
+ :requester_service_principal,
836
+ :requester_principal_arn,
837
+ :requester_account_id,
838
+ :requester_region,
839
+ :requester_comment,
840
+ :action_completion_strategy,
841
+ :approver_responses)
842
+ SENSITIVE = [:description, :metadata, :requester_comment]
843
+ include Aws::Structure
844
+ end
845
+
846
+ # Contains details for an approver response in an approval session.
847
+ #
848
+ # @!attribute [rw] approver_id
849
+ # ID for the approver.
850
+ # @return [String]
851
+ #
852
+ # @!attribute [rw] identity_source_arn
853
+ # Amazon Resource Name (ARN) for the identity source. The identity
854
+ # source manages the user authentication for approvers.
855
+ # @return [String]
856
+ #
857
+ # @!attribute [rw] identity_id
858
+ # ID for the identity source. The identity source manages the user
859
+ # authentication for approvers.
860
+ # @return [String]
861
+ #
862
+ # @!attribute [rw] response
863
+ # Response to the operation request.
864
+ # @return [String]
865
+ #
866
+ # @!attribute [rw] response_time
867
+ # Timestamp when a approver responded to the operation request.
868
+ # @return [Time]
869
+ #
870
+ # @see http://docs.aws.amazon.com/goto/WebAPI/mpa-2022-07-26/GetSessionResponseApproverResponse AWS API Documentation
871
+ #
872
+ class GetSessionResponseApproverResponse < Struct.new(
873
+ :approver_id,
874
+ :identity_source_arn,
875
+ :identity_id,
876
+ :response,
877
+ :response_time)
878
+ SENSITIVE = []
879
+ include Aws::Structure
880
+ end
881
+
882
+ # IAM Identity Center credentials. For more information see, [IAM
883
+ # Identity Center][1] .
884
+ #
885
+ #
886
+ #
887
+ # [1]: http://aws.amazon.com/identity-center/
888
+ #
889
+ # @!attribute [rw] instance_arn
890
+ # Amazon Resource Name (ARN) for the IAM Identity Center instance.
891
+ # @return [String]
892
+ #
893
+ # @!attribute [rw] region
894
+ # Amazon Web Services Region where the IAM Identity Center instance is
895
+ # located.
896
+ # @return [String]
897
+ #
898
+ # @see http://docs.aws.amazon.com/goto/WebAPI/mpa-2022-07-26/IamIdentityCenter AWS API Documentation
899
+ #
900
+ class IamIdentityCenter < Struct.new(
901
+ :instance_arn,
902
+ :region)
903
+ SENSITIVE = []
904
+ include Aws::Structure
905
+ end
906
+
907
+ # IAM Identity Center credentials. For more information see, [IAM
908
+ # Identity Center][1] .
909
+ #
910
+ #
911
+ #
912
+ # [1]: http://aws.amazon.com/identity-center/
913
+ #
914
+ # @!attribute [rw] instance_arn
915
+ # Amazon Resource Name (ARN) for the IAM Identity Center instance.
916
+ # @return [String]
917
+ #
918
+ # @!attribute [rw] approval_portal_url
919
+ # URL for the approval portal associated with the IAM Identity Center
920
+ # instance.
921
+ # @return [String]
922
+ #
923
+ # @!attribute [rw] region
924
+ # Amazon Web Services Region where the IAM Identity Center instance is
925
+ # located.
926
+ # @return [String]
927
+ #
928
+ # @see http://docs.aws.amazon.com/goto/WebAPI/mpa-2022-07-26/IamIdentityCenterForGet AWS API Documentation
929
+ #
930
+ class IamIdentityCenterForGet < Struct.new(
931
+ :instance_arn,
932
+ :approval_portal_url,
933
+ :region)
934
+ SENSITIVE = []
935
+ include Aws::Structure
936
+ end
937
+
938
+ # IAM Identity Center credentials. For more information see, [IAM
939
+ # Identity Center][1] .
940
+ #
941
+ #
942
+ #
943
+ # [1]: http://aws.amazon.com/identity-center/
944
+ #
945
+ # @!attribute [rw] instance_arn
946
+ # Amazon Resource Name (ARN) for the IAM Identity Center instance.
947
+ # @return [String]
948
+ #
949
+ # @!attribute [rw] approval_portal_url
950
+ # URL for the approval portal associated with the IAM Identity Center
951
+ # instance.
952
+ # @return [String]
953
+ #
954
+ # @!attribute [rw] region
955
+ # Amazon Web Services Region where the IAM Identity Center instance is
956
+ # located.
957
+ # @return [String]
958
+ #
959
+ # @see http://docs.aws.amazon.com/goto/WebAPI/mpa-2022-07-26/IamIdentityCenterForList AWS API Documentation
960
+ #
961
+ class IamIdentityCenterForList < Struct.new(
962
+ :instance_arn,
963
+ :approval_portal_url,
964
+ :region)
965
+ SENSITIVE = []
966
+ include Aws::Structure
967
+ end
968
+
969
+ # Contains details for an identity source. For more information, see
970
+ # [Identity source][1] in the *Multi-party approval User Guide*.
971
+ #
972
+ #
973
+ #
974
+ # [1]: https://docs.aws.amazon.com/mpa/latest/userguide/mpa-concepts.html
975
+ #
976
+ # @!attribute [rw] identity_source_type
977
+ # The type of resource that provided identities to the identity
978
+ # source. For example, an IAM Identity Center instance.
979
+ # @return [String]
980
+ #
981
+ # @!attribute [rw] identity_source_parameters
982
+ # A `IdentitySourceParametersForList` object. Contains details for the
983
+ # resource that provides identities to the identity source. For
984
+ # example, an IAM Identity Center instance.
985
+ # @return [Types::IdentitySourceParametersForList]
986
+ #
987
+ # @!attribute [rw] identity_source_arn
988
+ # Amazon Resource Name (ARN) for the identity source.
989
+ # @return [String]
990
+ #
991
+ # @!attribute [rw] creation_time
992
+ # Timestamp when the identity source was created.
993
+ # @return [Time]
994
+ #
995
+ # @!attribute [rw] status
996
+ # Status for the identity source. For example, if the identity source
997
+ # is `ACTIVE`.
998
+ # @return [String]
999
+ #
1000
+ # @!attribute [rw] status_code
1001
+ # Status code of the identity source.
1002
+ # @return [String]
1003
+ #
1004
+ # @!attribute [rw] status_message
1005
+ # Message describing the status for the identity source.
1006
+ # @return [String]
1007
+ #
1008
+ # @see http://docs.aws.amazon.com/goto/WebAPI/mpa-2022-07-26/IdentitySourceForList AWS API Documentation
1009
+ #
1010
+ class IdentitySourceForList < Struct.new(
1011
+ :identity_source_type,
1012
+ :identity_source_parameters,
1013
+ :identity_source_arn,
1014
+ :creation_time,
1015
+ :status,
1016
+ :status_code,
1017
+ :status_message)
1018
+ SENSITIVE = []
1019
+ include Aws::Structure
1020
+ end
1021
+
1022
+ # Contains details for the resource that provides identities to the
1023
+ # identity source. For example, an IAM Identity Center instance.
1024
+ #
1025
+ # @!attribute [rw] iam_identity_center
1026
+ # IAM Identity Center credentials.
1027
+ # @return [Types::IamIdentityCenter]
1028
+ #
1029
+ # @see http://docs.aws.amazon.com/goto/WebAPI/mpa-2022-07-26/IdentitySourceParameters AWS API Documentation
1030
+ #
1031
+ class IdentitySourceParameters < Struct.new(
1032
+ :iam_identity_center)
1033
+ SENSITIVE = []
1034
+ include Aws::Structure
1035
+ end
1036
+
1037
+ # Contains details for the resource that provides identities to the
1038
+ # identity source. For example, an IAM Identity Center instance. For
1039
+ # more information, see [Identity source][1] in the *Multi-party
1040
+ # approval User Guide*.
1041
+ #
1042
+ #
1043
+ #
1044
+ # [1]: https://docs.aws.amazon.com/mpa/latest/userguide/mpa-concepts.html
1045
+ #
1046
+ # @note IdentitySourceParametersForGet is a union - when returned from an API call exactly one value will be set and the returned type will be a subclass of IdentitySourceParametersForGet corresponding to the set member.
1047
+ #
1048
+ # @!attribute [rw] iam_identity_center
1049
+ # IAM Identity Center credentials.
1050
+ # @return [Types::IamIdentityCenterForGet]
1051
+ #
1052
+ # @see http://docs.aws.amazon.com/goto/WebAPI/mpa-2022-07-26/IdentitySourceParametersForGet AWS API Documentation
1053
+ #
1054
+ class IdentitySourceParametersForGet < Struct.new(
1055
+ :iam_identity_center,
1056
+ :unknown)
1057
+ SENSITIVE = []
1058
+ include Aws::Structure
1059
+ include Aws::Structure::Union
1060
+
1061
+ class IamIdentityCenter < IdentitySourceParametersForGet; end
1062
+ class Unknown < IdentitySourceParametersForGet; end
1063
+ end
1064
+
1065
+ # Contains details for the resource that provides identities to the
1066
+ # identity source. For example, an IAM Identity Center instance. For
1067
+ # more information, see [Identity source][1] in the *Multi-party
1068
+ # approval User Guide*.
1069
+ #
1070
+ #
1071
+ #
1072
+ # [1]: https://docs.aws.amazon.com/mpa/latest/userguide/mpa-concepts.html
1073
+ #
1074
+ # @note IdentitySourceParametersForList is a union - when returned from an API call exactly one value will be set and the returned type will be a subclass of IdentitySourceParametersForList corresponding to the set member.
1075
+ #
1076
+ # @!attribute [rw] iam_identity_center
1077
+ # IAM Identity Center credentials.
1078
+ # @return [Types::IamIdentityCenterForList]
1079
+ #
1080
+ # @see http://docs.aws.amazon.com/goto/WebAPI/mpa-2022-07-26/IdentitySourceParametersForList AWS API Documentation
1081
+ #
1082
+ class IdentitySourceParametersForList < Struct.new(
1083
+ :iam_identity_center,
1084
+ :unknown)
1085
+ SENSITIVE = []
1086
+ include Aws::Structure
1087
+ include Aws::Structure::Union
1088
+
1089
+ class IamIdentityCenter < IdentitySourceParametersForList; end
1090
+ class Unknown < IdentitySourceParametersForList; end
1091
+ end
1092
+
1093
+ # The service encountered an internal error. Try your request again. If
1094
+ # the problem persists, contact Amazon Web Services Support.
1095
+ #
1096
+ # @!attribute [rw] message
1097
+ # Message for the `InternalServerException` error.
1098
+ # @return [String]
1099
+ #
1100
+ # @see http://docs.aws.amazon.com/goto/WebAPI/mpa-2022-07-26/InternalServerException AWS API Documentation
1101
+ #
1102
+ class InternalServerException < Struct.new(
1103
+ :message)
1104
+ SENSITIVE = []
1105
+ include Aws::Structure
1106
+ end
1107
+
1108
+ # The request contains an invalid parameter value.
1109
+ #
1110
+ # @!attribute [rw] message
1111
+ # Message for the `InvalidParameterException` error.
1112
+ # @return [String]
1113
+ #
1114
+ # @see http://docs.aws.amazon.com/goto/WebAPI/mpa-2022-07-26/InvalidParameterException AWS API Documentation
1115
+ #
1116
+ class InvalidParameterException < Struct.new(
1117
+ :message)
1118
+ SENSITIVE = []
1119
+ include Aws::Structure
1120
+ end
1121
+
1122
+ # @!attribute [rw] max_results
1123
+ # The maximum number of items to return in the response. If more
1124
+ # results exist than the specified `MaxResults` value, a token is
1125
+ # included in the response so that you can retrieve the remaining
1126
+ # results.
1127
+ # @return [Integer]
1128
+ #
1129
+ # @!attribute [rw] next_token
1130
+ # If present, indicates that more output is available than is included
1131
+ # in the current response. Use this value in the `NextToken` request
1132
+ # parameter in a next call to the operation to get more output. You
1133
+ # can repeat this until the `NextToken` response element returns
1134
+ # `null`.
1135
+ # @return [String]
1136
+ #
1137
+ # @see http://docs.aws.amazon.com/goto/WebAPI/mpa-2022-07-26/ListApprovalTeamsRequest AWS API Documentation
1138
+ #
1139
+ class ListApprovalTeamsRequest < Struct.new(
1140
+ :max_results,
1141
+ :next_token)
1142
+ SENSITIVE = []
1143
+ include Aws::Structure
1144
+ end
1145
+
1146
+ # @!attribute [rw] next_token
1147
+ # If present, indicates that more output is available than is included
1148
+ # in the current response. Use this value in the `NextToken` request
1149
+ # parameter in a next call to the operation to get more output. You
1150
+ # can repeat this until the `NextToken` response element returns
1151
+ # `null`.
1152
+ # @return [String]
1153
+ #
1154
+ # @!attribute [rw] approval_teams
1155
+ # An array of `ListApprovalTeamsResponseApprovalTeam` objects.
1156
+ # Contains details for approval teams.
1157
+ # @return [Array<Types::ListApprovalTeamsResponseApprovalTeam>]
1158
+ #
1159
+ # @see http://docs.aws.amazon.com/goto/WebAPI/mpa-2022-07-26/ListApprovalTeamsResponse AWS API Documentation
1160
+ #
1161
+ class ListApprovalTeamsResponse < Struct.new(
1162
+ :next_token,
1163
+ :approval_teams)
1164
+ SENSITIVE = []
1165
+ include Aws::Structure
1166
+ end
1167
+
1168
+ # Contains details for an approval team
1169
+ #
1170
+ # @!attribute [rw] creation_time
1171
+ # Timestamp when the team was created.
1172
+ # @return [Time]
1173
+ #
1174
+ # @!attribute [rw] approval_strategy
1175
+ # An `ApprovalStrategyResponse` object. Contains details for how an
1176
+ # approval team grants approval.
1177
+ # @return [Types::ApprovalStrategyResponse]
1178
+ #
1179
+ # @!attribute [rw] number_of_approvers
1180
+ # Total number of approvers in the team.
1181
+ # @return [Integer]
1182
+ #
1183
+ # @!attribute [rw] arn
1184
+ # Amazon Resource Name (ARN) for the team.
1185
+ # @return [String]
1186
+ #
1187
+ # @!attribute [rw] name
1188
+ # Name of the team.
1189
+ # @return [String]
1190
+ #
1191
+ # @!attribute [rw] description
1192
+ # Description for the team.
1193
+ # @return [String]
1194
+ #
1195
+ # @!attribute [rw] status
1196
+ # Status for the team. For more information, see [Team health][1] in
1197
+ # the *Multi-party approval User Guide*.
1198
+ #
1199
+ #
1200
+ #
1201
+ # [1]: https://docs.aws.amazon.com/mpa/latest/userguide/mpa-health.html
1202
+ # @return [String]
1203
+ #
1204
+ # @!attribute [rw] status_code
1205
+ # Status code for the team. For more information, see [Team health][1]
1206
+ # in the *Multi-party approval User Guide*.
1207
+ #
1208
+ #
1209
+ #
1210
+ # [1]: https://docs.aws.amazon.com/mpa/latest/userguide/mpa-health.html
1211
+ # @return [String]
1212
+ #
1213
+ # @!attribute [rw] status_message
1214
+ # Message describing the status for the team.
1215
+ # @return [String]
1216
+ #
1217
+ # @see http://docs.aws.amazon.com/goto/WebAPI/mpa-2022-07-26/ListApprovalTeamsResponseApprovalTeam AWS API Documentation
1218
+ #
1219
+ class ListApprovalTeamsResponseApprovalTeam < Struct.new(
1220
+ :creation_time,
1221
+ :approval_strategy,
1222
+ :number_of_approvers,
1223
+ :arn,
1224
+ :name,
1225
+ :description,
1226
+ :status,
1227
+ :status_code,
1228
+ :status_message)
1229
+ SENSITIVE = [:description]
1230
+ include Aws::Structure
1231
+ end
1232
+
1233
+ # @!attribute [rw] max_results
1234
+ # The maximum number of items to return in the response. If more
1235
+ # results exist than the specified `MaxResults` value, a token is
1236
+ # included in the response so that you can retrieve the remaining
1237
+ # results.
1238
+ # @return [Integer]
1239
+ #
1240
+ # @!attribute [rw] next_token
1241
+ # If present, indicates that more output is available than is included
1242
+ # in the current response. Use this value in the `NextToken` request
1243
+ # parameter in a next call to the operation to get more output. You
1244
+ # can repeat this until the `NextToken` response element returns
1245
+ # `null`.
1246
+ # @return [String]
1247
+ #
1248
+ # @see http://docs.aws.amazon.com/goto/WebAPI/mpa-2022-07-26/ListIdentitySourcesRequest AWS API Documentation
1249
+ #
1250
+ class ListIdentitySourcesRequest < Struct.new(
1251
+ :max_results,
1252
+ :next_token)
1253
+ SENSITIVE = []
1254
+ include Aws::Structure
1255
+ end
1256
+
1257
+ # @!attribute [rw] next_token
1258
+ # If present, indicates that more output is available than is included
1259
+ # in the current response. Use this value in the `NextToken` request
1260
+ # parameter in a next call to the operation to get more output. You
1261
+ # can repeat this until the `NextToken` response element returns
1262
+ # `null`.
1263
+ # @return [String]
1264
+ #
1265
+ # @!attribute [rw] identity_sources
1266
+ # A `IdentitySources`. Contains details for identity sources.
1267
+ # @return [Array<Types::IdentitySourceForList>]
1268
+ #
1269
+ # @see http://docs.aws.amazon.com/goto/WebAPI/mpa-2022-07-26/ListIdentitySourcesResponse AWS API Documentation
1270
+ #
1271
+ class ListIdentitySourcesResponse < Struct.new(
1272
+ :next_token,
1273
+ :identity_sources)
1274
+ SENSITIVE = []
1275
+ include Aws::Structure
1276
+ end
1277
+
1278
+ # @!attribute [rw] max_results
1279
+ # The maximum number of items to return in the response. If more
1280
+ # results exist than the specified `MaxResults` value, a token is
1281
+ # included in the response so that you can retrieve the remaining
1282
+ # results.
1283
+ # @return [Integer]
1284
+ #
1285
+ # @!attribute [rw] next_token
1286
+ # If present, indicates that more output is available than is included
1287
+ # in the current response. Use this value in the `NextToken` request
1288
+ # parameter in a next call to the operation to get more output. You
1289
+ # can repeat this until the `NextToken` response element returns
1290
+ # `null`.
1291
+ # @return [String]
1292
+ #
1293
+ # @see http://docs.aws.amazon.com/goto/WebAPI/mpa-2022-07-26/ListPoliciesRequest AWS API Documentation
1294
+ #
1295
+ class ListPoliciesRequest < Struct.new(
1296
+ :max_results,
1297
+ :next_token)
1298
+ SENSITIVE = []
1299
+ include Aws::Structure
1300
+ end
1301
+
1302
+ # @!attribute [rw] next_token
1303
+ # If present, indicates that more output is available than is included
1304
+ # in the current response. Use this value in the `NextToken` request
1305
+ # parameter in a next call to the operation to get more output. You
1306
+ # can repeat this until the `NextToken` response element returns
1307
+ # `null`.
1308
+ # @return [String]
1309
+ #
1310
+ # @!attribute [rw] policies
1311
+ # An array of `Policy` objects. Contains a list of policies that
1312
+ # define the permissions for team resources.
1313
+ #
1314
+ # The protected operation for a service integration might require
1315
+ # specific permissions. For more information, see [How other services
1316
+ # work with Multi-party approval][1] in the *Multi-party approval User
1317
+ # Guide*.
1318
+ #
1319
+ #
1320
+ #
1321
+ # [1]: https://docs.aws.amazon.com/mpa/latest/userguide/mpa-integrations.html
1322
+ # @return [Array<Types::Policy>]
1323
+ #
1324
+ # @see http://docs.aws.amazon.com/goto/WebAPI/mpa-2022-07-26/ListPoliciesResponse AWS API Documentation
1325
+ #
1326
+ class ListPoliciesResponse < Struct.new(
1327
+ :next_token,
1328
+ :policies)
1329
+ SENSITIVE = []
1330
+ include Aws::Structure
1331
+ end
1332
+
1333
+ # @!attribute [rw] max_results
1334
+ # The maximum number of items to return in the response. If more
1335
+ # results exist than the specified `MaxResults` value, a token is
1336
+ # included in the response so that you can retrieve the remaining
1337
+ # results.
1338
+ # @return [Integer]
1339
+ #
1340
+ # @!attribute [rw] next_token
1341
+ # If present, indicates that more output is available than is included
1342
+ # in the current response. Use this value in the `NextToken` request
1343
+ # parameter in a next call to the operation to get more output. You
1344
+ # can repeat this until the `NextToken` response element returns
1345
+ # `null`.
1346
+ # @return [String]
1347
+ #
1348
+ # @!attribute [rw] policy_arn
1349
+ # Amazon Resource Name (ARN) for the policy.
1350
+ # @return [String]
1351
+ #
1352
+ # @see http://docs.aws.amazon.com/goto/WebAPI/mpa-2022-07-26/ListPolicyVersionsRequest AWS API Documentation
1353
+ #
1354
+ class ListPolicyVersionsRequest < Struct.new(
1355
+ :max_results,
1356
+ :next_token,
1357
+ :policy_arn)
1358
+ SENSITIVE = []
1359
+ include Aws::Structure
1360
+ end
1361
+
1362
+ # @!attribute [rw] next_token
1363
+ # If present, indicates that more output is available than is included
1364
+ # in the current response. Use this value in the `NextToken` request
1365
+ # parameter in a next call to the operation to get more output. You
1366
+ # can repeat this until the `NextToken` response element returns
1367
+ # `null`.
1368
+ # @return [String]
1369
+ #
1370
+ # @!attribute [rw] policy_versions
1371
+ # An array of `PolicyVersionSummary` objects. Contains details for the
1372
+ # version of the policies that define the permissions for team
1373
+ # resources.
1374
+ #
1375
+ # The protected operation for a service integration might require
1376
+ # specific permissions. For more information, see [How other services
1377
+ # work with Multi-party approval][1] in the *Multi-party approval User
1378
+ # Guide*.
1379
+ #
1380
+ #
1381
+ #
1382
+ # [1]: https://docs.aws.amazon.com/mpa/latest/userguide/mpa-integrations.html
1383
+ # @return [Array<Types::PolicyVersionSummary>]
1384
+ #
1385
+ # @see http://docs.aws.amazon.com/goto/WebAPI/mpa-2022-07-26/ListPolicyVersionsResponse AWS API Documentation
1386
+ #
1387
+ class ListPolicyVersionsResponse < Struct.new(
1388
+ :next_token,
1389
+ :policy_versions)
1390
+ SENSITIVE = []
1391
+ include Aws::Structure
1392
+ end
1393
+
1394
+ # @!attribute [rw] resource_arn
1395
+ # Amazon Resource Name (ARN) for the resource.
1396
+ # @return [String]
1397
+ #
1398
+ # @!attribute [rw] max_results
1399
+ # The maximum number of items to return in the response. If more
1400
+ # results exist than the specified `MaxResults` value, a token is
1401
+ # included in the response so that you can retrieve the remaining
1402
+ # results.
1403
+ # @return [Integer]
1404
+ #
1405
+ # @!attribute [rw] next_token
1406
+ # If present, indicates that more output is available than is included
1407
+ # in the current response. Use this value in the `NextToken` request
1408
+ # parameter in a next call to the operation to get more output. You
1409
+ # can repeat this until the `NextToken` response element returns
1410
+ # `null`.
1411
+ # @return [String]
1412
+ #
1413
+ # @see http://docs.aws.amazon.com/goto/WebAPI/mpa-2022-07-26/ListResourcePoliciesRequest AWS API Documentation
1414
+ #
1415
+ class ListResourcePoliciesRequest < Struct.new(
1416
+ :resource_arn,
1417
+ :max_results,
1418
+ :next_token)
1419
+ SENSITIVE = []
1420
+ include Aws::Structure
1421
+ end
1422
+
1423
+ # @!attribute [rw] next_token
1424
+ # If present, indicates that more output is available than is included
1425
+ # in the current response. Use this value in the `NextToken` request
1426
+ # parameter in a next call to the operation to get more output. You
1427
+ # can repeat this until the `NextToken` response element returns
1428
+ # `null`.
1429
+ # @return [String]
1430
+ #
1431
+ # @!attribute [rw] resource_policies
1432
+ # An array of `ListResourcePoliciesResponseResourcePolicy` objects.
1433
+ # Contains details about the policy for the resource.
1434
+ # @return [Array<Types::ListResourcePoliciesResponseResourcePolicy>]
1435
+ #
1436
+ # @see http://docs.aws.amazon.com/goto/WebAPI/mpa-2022-07-26/ListResourcePoliciesResponse AWS API Documentation
1437
+ #
1438
+ class ListResourcePoliciesResponse < Struct.new(
1439
+ :next_token,
1440
+ :resource_policies)
1441
+ SENSITIVE = []
1442
+ include Aws::Structure
1443
+ end
1444
+
1445
+ # Contains details about a policy for a resource.
1446
+ #
1447
+ # @!attribute [rw] policy_arn
1448
+ # Amazon Resource Name (ARN) for policy.
1449
+ # @return [String]
1450
+ #
1451
+ # @!attribute [rw] policy_type
1452
+ # The type of policy.
1453
+ # @return [String]
1454
+ #
1455
+ # @!attribute [rw] policy_name
1456
+ # Name of the policy.
1457
+ # @return [String]
1458
+ #
1459
+ # @see http://docs.aws.amazon.com/goto/WebAPI/mpa-2022-07-26/ListResourcePoliciesResponseResourcePolicy AWS API Documentation
1460
+ #
1461
+ class ListResourcePoliciesResponseResourcePolicy < Struct.new(
1462
+ :policy_arn,
1463
+ :policy_type,
1464
+ :policy_name)
1465
+ SENSITIVE = []
1466
+ include Aws::Structure
1467
+ end
1468
+
1469
+ # @!attribute [rw] approval_team_arn
1470
+ # Amazon Resource Name (ARN) for the approval team.
1471
+ # @return [String]
1472
+ #
1473
+ # @!attribute [rw] max_results
1474
+ # The maximum number of items to return in the response. If more
1475
+ # results exist than the specified `MaxResults` value, a token is
1476
+ # included in the response so that you can retrieve the remaining
1477
+ # results.
1478
+ # @return [Integer]
1479
+ #
1480
+ # @!attribute [rw] next_token
1481
+ # If present, indicates that more output is available than is included
1482
+ # in the current response. Use this value in the `NextToken` request
1483
+ # parameter in a next call to the operation to get more output. You
1484
+ # can repeat this until the `NextToken` response element returns
1485
+ # `null`.
1486
+ # @return [String]
1487
+ #
1488
+ # @!attribute [rw] filters
1489
+ # An array of `Filter` objects. Contains the filter to apply when
1490
+ # listing sessions.
1491
+ # @return [Array<Types::Filter>]
1492
+ #
1493
+ # @see http://docs.aws.amazon.com/goto/WebAPI/mpa-2022-07-26/ListSessionsRequest AWS API Documentation
1494
+ #
1495
+ class ListSessionsRequest < Struct.new(
1496
+ :approval_team_arn,
1497
+ :max_results,
1498
+ :next_token,
1499
+ :filters)
1500
+ SENSITIVE = []
1501
+ include Aws::Structure
1502
+ end
1503
+
1504
+ # @!attribute [rw] next_token
1505
+ # If present, indicates that more output is available than is included
1506
+ # in the current response. Use this value in the `NextToken` request
1507
+ # parameter in a next call to the operation to get more output. You
1508
+ # can repeat this until the `NextToken` response element returns
1509
+ # `null`.
1510
+ # @return [String]
1511
+ #
1512
+ # @!attribute [rw] sessions
1513
+ # An array of `ListSessionsResponseSession` objects. Contains details
1514
+ # for the sessions.
1515
+ # @return [Array<Types::ListSessionsResponseSession>]
1516
+ #
1517
+ # @see http://docs.aws.amazon.com/goto/WebAPI/mpa-2022-07-26/ListSessionsResponse AWS API Documentation
1518
+ #
1519
+ class ListSessionsResponse < Struct.new(
1520
+ :next_token,
1521
+ :sessions)
1522
+ SENSITIVE = []
1523
+ include Aws::Structure
1524
+ end
1525
+
1526
+ # Contains details for an approval session. For more information, see
1527
+ # [Session][1] in the *Multi-party approval User Guide*
1528
+ #
1529
+ #
1530
+ #
1531
+ # [1]: https://docs.aws.amazon.com/mpa/latest/userguide/mpa-health.html
1532
+ #
1533
+ # @!attribute [rw] session_arn
1534
+ # Amazon Resource Name (ARN) for the session.
1535
+ # @return [String]
1536
+ #
1537
+ # @!attribute [rw] approval_team_name
1538
+ # Name of the approval team.
1539
+ # @return [String]
1540
+ #
1541
+ # @!attribute [rw] approval_team_arn
1542
+ # Amazon Resource Name (ARN) for the approval team.
1543
+ # @return [String]
1544
+ #
1545
+ # @!attribute [rw] initiation_time
1546
+ # Timestamp when the session was initiated.
1547
+ # @return [Time]
1548
+ #
1549
+ # @!attribute [rw] expiration_time
1550
+ # Timestamp when the session was expire.
1551
+ # @return [Time]
1552
+ #
1553
+ # @!attribute [rw] completion_time
1554
+ # Timestamp when the session was completed.
1555
+ # @return [Time]
1556
+ #
1557
+ # @!attribute [rw] description
1558
+ # Description for the team.
1559
+ # @return [String]
1560
+ #
1561
+ # @!attribute [rw] action_name
1562
+ # Name of the protected operation.
1563
+ # @return [String]
1564
+ #
1565
+ # @!attribute [rw] protected_resource_arn
1566
+ # Amazon Resource Name (ARN) for the protected operation.
1567
+ # @return [String]
1568
+ #
1569
+ # @!attribute [rw] requester_service_principal
1570
+ # [Service principal][1] for the service associated with the protected
1571
+ # operation.
1572
+ #
1573
+ #
1574
+ #
1575
+ # [1]: https://docs.aws.amazon.com/IAM/latest/UserGuide/reference_policies_elements_principal.html#principal-services
1576
+ # @return [String]
1577
+ #
1578
+ # @!attribute [rw] requester_principal_arn
1579
+ # [IAM principal][1] that made the operation request.
1580
+ #
1581
+ #
1582
+ #
1583
+ # [1]: https://docs.aws.amazon.com/IAM/latest/UserGuide/intro-structure.html#intro-structure-request
1584
+ # @return [String]
1585
+ #
1586
+ # @!attribute [rw] requester_region
1587
+ # Amazon Web Services Region where the operation request originated.
1588
+ # @return [String]
1589
+ #
1590
+ # @!attribute [rw] requester_account_id
1591
+ # ID for the account that made the operation request.
1592
+ # @return [String]
1593
+ #
1594
+ # @!attribute [rw] status
1595
+ # Status for the protected operation. For example, if the operation is
1596
+ # `PENDING`.
1597
+ # @return [String]
1598
+ #
1599
+ # @!attribute [rw] status_code
1600
+ # Status code of the session.
1601
+ # @return [String]
1602
+ #
1603
+ # @!attribute [rw] status_message
1604
+ # Message describing the status for session.
1605
+ # @return [String]
1606
+ #
1607
+ # @!attribute [rw] action_completion_strategy
1608
+ # Strategy for executing the protected operation.
1609
+ # `AUTO_COMPLETION_UPON_APPROVAL` means the operation is executed
1610
+ # automatically using the requester's permissions, if approved.
1611
+ # @return [String]
1612
+ #
1613
+ # @see http://docs.aws.amazon.com/goto/WebAPI/mpa-2022-07-26/ListSessionsResponseSession AWS API Documentation
1614
+ #
1615
+ class ListSessionsResponseSession < Struct.new(
1616
+ :session_arn,
1617
+ :approval_team_name,
1618
+ :approval_team_arn,
1619
+ :initiation_time,
1620
+ :expiration_time,
1621
+ :completion_time,
1622
+ :description,
1623
+ :action_name,
1624
+ :protected_resource_arn,
1625
+ :requester_service_principal,
1626
+ :requester_principal_arn,
1627
+ :requester_region,
1628
+ :requester_account_id,
1629
+ :status,
1630
+ :status_code,
1631
+ :status_message,
1632
+ :action_completion_strategy)
1633
+ SENSITIVE = [:description]
1634
+ include Aws::Structure
1635
+ end
1636
+
1637
+ # @!attribute [rw] resource_arn
1638
+ # Amazon Resource Name (ARN) for the resource.
1639
+ # @return [String]
1640
+ #
1641
+ # @see http://docs.aws.amazon.com/goto/WebAPI/mpa-2022-07-26/ListTagsForResourceRequest AWS API Documentation
1642
+ #
1643
+ class ListTagsForResourceRequest < Struct.new(
1644
+ :resource_arn)
1645
+ SENSITIVE = []
1646
+ include Aws::Structure
1647
+ end
1648
+
1649
+ # @!attribute [rw] tags
1650
+ # Tags attached to the resource.
1651
+ # @return [Hash<String,String>]
1652
+ #
1653
+ # @see http://docs.aws.amazon.com/goto/WebAPI/mpa-2022-07-26/ListTagsForResourceResponse AWS API Documentation
1654
+ #
1655
+ class ListTagsForResourceResponse < Struct.new(
1656
+ :tags)
1657
+ SENSITIVE = [:tags]
1658
+ include Aws::Structure
1659
+ end
1660
+
1661
+ # Strategy for how an approval team grants approval.
1662
+ #
1663
+ # @!attribute [rw] min_approvals_required
1664
+ # Minimum number of approvals (M) required for a total number of
1665
+ # approvers (N).
1666
+ # @return [Integer]
1667
+ #
1668
+ # @see http://docs.aws.amazon.com/goto/WebAPI/mpa-2022-07-26/MofNApprovalStrategy AWS API Documentation
1669
+ #
1670
+ class MofNApprovalStrategy < Struct.new(
1671
+ :min_approvals_required)
1672
+ SENSITIVE = []
1673
+ include Aws::Structure
1674
+ end
1675
+
1676
+ # Contains details for the pending updates for an approval team, if
1677
+ # applicable.
1678
+ #
1679
+ # @!attribute [rw] version_id
1680
+ # Version ID for the team.
1681
+ # @return [String]
1682
+ #
1683
+ # @!attribute [rw] description
1684
+ # Description for the team.
1685
+ # @return [String]
1686
+ #
1687
+ # @!attribute [rw] approval_strategy
1688
+ # An `ApprovalStrategyResponse` object. Contains details for how the
1689
+ # team grants approval.
1690
+ # @return [Types::ApprovalStrategyResponse]
1691
+ #
1692
+ # @!attribute [rw] number_of_approvers
1693
+ # Total number of approvers in the team.
1694
+ # @return [Integer]
1695
+ #
1696
+ # @!attribute [rw] status
1697
+ # Status for the team. For more information, see [Team health][1] in
1698
+ # the *Multi-party approval User Guide*.
1699
+ #
1700
+ #
1701
+ #
1702
+ # [1]: https://docs.aws.amazon.com/mpa/latest/userguide/mpa-health.html
1703
+ # @return [String]
1704
+ #
1705
+ # @!attribute [rw] status_code
1706
+ # Status code for the update. For more information, see [Team
1707
+ # health][1] in the *Multi-party approval User Guide*.
1708
+ #
1709
+ #
1710
+ #
1711
+ # [1]: https://docs.aws.amazon.com/mpa/latest/userguide/mpa-health.html
1712
+ # @return [String]
1713
+ #
1714
+ # @!attribute [rw] status_message
1715
+ # Message describing the status for the team.
1716
+ # @return [String]
1717
+ #
1718
+ # @!attribute [rw] approvers
1719
+ # An array of `GetApprovalTeamResponseApprover ` objects. Contains
1720
+ # details for the approvers in the team.
1721
+ # @return [Array<Types::GetApprovalTeamResponseApprover>]
1722
+ #
1723
+ # @!attribute [rw] update_initiation_time
1724
+ # Timestamp when the update request was initiated.
1725
+ # @return [Time]
1726
+ #
1727
+ # @see http://docs.aws.amazon.com/goto/WebAPI/mpa-2022-07-26/PendingUpdate AWS API Documentation
1728
+ #
1729
+ class PendingUpdate < Struct.new(
1730
+ :version_id,
1731
+ :description,
1732
+ :approval_strategy,
1733
+ :number_of_approvers,
1734
+ :status,
1735
+ :status_code,
1736
+ :status_message,
1737
+ :approvers,
1738
+ :update_initiation_time)
1739
+ SENSITIVE = []
1740
+ include Aws::Structure
1741
+ end
1742
+
1743
+ # Contains details for a policy. Policies define what operations a team
1744
+ # that define the permissions for team resources.
1745
+ #
1746
+ # The protected operation for a service integration might require
1747
+ # specific permissions. For more information, see [How other services
1748
+ # work with Multi-party approval][1] in the *Multi-party approval User
1749
+ # Guide*.
1750
+ #
1751
+ #
1752
+ #
1753
+ # [1]: https://docs.aws.amazon.com/mpa/latest/userguide/mpa-integrations.html
1754
+ #
1755
+ # @!attribute [rw] arn
1756
+ # Amazon Resource Name (ARN) for the policy.
1757
+ # @return [String]
1758
+ #
1759
+ # @!attribute [rw] default_version
1760
+ # Determines if the specified policy is the default for the team.
1761
+ # @return [Integer]
1762
+ #
1763
+ # @!attribute [rw] policy_type
1764
+ # The type of policy.
1765
+ # @return [String]
1766
+ #
1767
+ # @!attribute [rw] name
1768
+ # Name of the policy.
1769
+ # @return [String]
1770
+ #
1771
+ # @see http://docs.aws.amazon.com/goto/WebAPI/mpa-2022-07-26/Policy AWS API Documentation
1772
+ #
1773
+ class Policy < Struct.new(
1774
+ :arn,
1775
+ :default_version,
1776
+ :policy_type,
1777
+ :name)
1778
+ SENSITIVE = []
1779
+ include Aws::Structure
1780
+ end
1781
+
1782
+ # Contains the Amazon Resource Name (ARN) for a policy. Policies define
1783
+ # what operations a team that define the permissions for team resources.
1784
+ #
1785
+ # The protected operation for a service integration might require
1786
+ # specific permissions. For more information, see [How other services
1787
+ # work with Multi-party approval][1] in the *Multi-party approval User
1788
+ # Guide*.
1789
+ #
1790
+ #
1791
+ #
1792
+ # [1]: https://docs.aws.amazon.com/mpa/latest/userguide/mpa-integrations.html
1793
+ #
1794
+ # @!attribute [rw] policy_arn
1795
+ # Amazon Resource Name (ARN) for the policy.
1796
+ # @return [String]
1797
+ #
1798
+ # @see http://docs.aws.amazon.com/goto/WebAPI/mpa-2022-07-26/PolicyReference AWS API Documentation
1799
+ #
1800
+ class PolicyReference < Struct.new(
1801
+ :policy_arn)
1802
+ SENSITIVE = []
1803
+ include Aws::Structure
1804
+ end
1805
+
1806
+ # Contains details for the version of a policy. Policies define what
1807
+ # operations a team that define the permissions for team resources.
1808
+ #
1809
+ # The protected operation for a service integration might require
1810
+ # specific permissions. For more information, see [How other services
1811
+ # work with Multi-party approval][1] in the *Multi-party approval User
1812
+ # Guide*.
1813
+ #
1814
+ #
1815
+ #
1816
+ # [1]: https://docs.aws.amazon.com/mpa/latest/userguide/mpa-integrations.html
1817
+ #
1818
+ # @!attribute [rw] arn
1819
+ # Amazon Resource Name (ARN) for the team.
1820
+ # @return [String]
1821
+ #
1822
+ # @!attribute [rw] policy_arn
1823
+ # Amazon Resource Name (ARN) for the policy.
1824
+ # @return [String]
1825
+ #
1826
+ # @!attribute [rw] version_id
1827
+ # Verison ID
1828
+ # @return [Integer]
1829
+ #
1830
+ # @!attribute [rw] policy_type
1831
+ # The type of policy.
1832
+ # @return [String]
1833
+ #
1834
+ # @!attribute [rw] is_default
1835
+ # Determines if the specified policy is the default for the team.
1836
+ # @return [Boolean]
1837
+ #
1838
+ # @!attribute [rw] name
1839
+ # Name of the policy.
1840
+ # @return [String]
1841
+ #
1842
+ # @!attribute [rw] status
1843
+ # Status for the policy. For example, if the policy is [attachable][1]
1844
+ # or [deprecated][2].
1845
+ #
1846
+ #
1847
+ #
1848
+ # [1]: https://docs.aws.amazon.com/IAM/latest/UserGuide/id_groups_manage_attach-policy.html
1849
+ # [2]: https://docs.aws.amazon.com/access_policies_managed-deprecated.html
1850
+ # @return [String]
1851
+ #
1852
+ # @!attribute [rw] creation_time
1853
+ # Timestamp when the policy was created.
1854
+ # @return [Time]
1855
+ #
1856
+ # @!attribute [rw] last_updated_time
1857
+ # Timestamp when the policy was last updated.
1858
+ # @return [Time]
1859
+ #
1860
+ # @!attribute [rw] document
1861
+ # Document that contains the policy contents.
1862
+ # @return [String]
1863
+ #
1864
+ # @see http://docs.aws.amazon.com/goto/WebAPI/mpa-2022-07-26/PolicyVersion AWS API Documentation
1865
+ #
1866
+ class PolicyVersion < Struct.new(
1867
+ :arn,
1868
+ :policy_arn,
1869
+ :version_id,
1870
+ :policy_type,
1871
+ :is_default,
1872
+ :name,
1873
+ :status,
1874
+ :creation_time,
1875
+ :last_updated_time,
1876
+ :document)
1877
+ SENSITIVE = [:document]
1878
+ include Aws::Structure
1879
+ end
1880
+
1881
+ # Contains details for the version of a policy. Policies define what
1882
+ # operations a team that define the permissions for team resources.
1883
+ #
1884
+ # The protected operation for a service integration might require
1885
+ # specific permissions. For more information, see [How other services
1886
+ # work with Multi-party approval][1] in the *Multi-party approval User
1887
+ # Guide*.
1888
+ #
1889
+ #
1890
+ #
1891
+ # [1]: https://docs.aws.amazon.com/mpa/latest/userguide/mpa-integrations.html
1892
+ #
1893
+ # @!attribute [rw] arn
1894
+ # Amazon Resource Name (ARN) for the team.
1895
+ # @return [String]
1896
+ #
1897
+ # @!attribute [rw] policy_arn
1898
+ # Amazon Resource Name (ARN) for the policy.
1899
+ # @return [String]
1900
+ #
1901
+ # @!attribute [rw] version_id
1902
+ # Version ID for the policy.
1903
+ # @return [Integer]
1904
+ #
1905
+ # @!attribute [rw] policy_type
1906
+ # The type of policy.
1907
+ # @return [String]
1908
+ #
1909
+ # @!attribute [rw] is_default
1910
+ # Determines if the specified policy is the default for the team.
1911
+ # @return [Boolean]
1912
+ #
1913
+ # @!attribute [rw] name
1914
+ # Name of the policy
1915
+ # @return [String]
1916
+ #
1917
+ # @!attribute [rw] status
1918
+ # Status for the policy. For example, if the policy is [attachable][1]
1919
+ # or [deprecated][2].
1920
+ #
1921
+ #
1922
+ #
1923
+ # [1]: https://docs.aws.amazon.com/IAM/latest/UserGuide/id_groups_manage_attach-policy.html
1924
+ # [2]: https://docs.aws.amazon.com/access_policies_managed-deprecated.html
1925
+ # @return [String]
1926
+ #
1927
+ # @!attribute [rw] creation_time
1928
+ # Timestamp when the policy was created.
1929
+ # @return [Time]
1930
+ #
1931
+ # @!attribute [rw] last_updated_time
1932
+ # Timestamp when the policy was last updated.
1933
+ # @return [Time]
1934
+ #
1935
+ # @see http://docs.aws.amazon.com/goto/WebAPI/mpa-2022-07-26/PolicyVersionSummary AWS API Documentation
1936
+ #
1937
+ class PolicyVersionSummary < Struct.new(
1938
+ :arn,
1939
+ :policy_arn,
1940
+ :version_id,
1941
+ :policy_type,
1942
+ :is_default,
1943
+ :name,
1944
+ :status,
1945
+ :creation_time,
1946
+ :last_updated_time)
1947
+ SENSITIVE = []
1948
+ include Aws::Structure
1949
+ end
1950
+
1951
+ # The specified resource doesn't exist. Check the resource ID, and try
1952
+ # again.
1953
+ #
1954
+ # @!attribute [rw] message
1955
+ # Message for the `ResourceNotFoundException` error.
1956
+ # @return [String]
1957
+ #
1958
+ # @see http://docs.aws.amazon.com/goto/WebAPI/mpa-2022-07-26/ResourceNotFoundException AWS API Documentation
1959
+ #
1960
+ class ResourceNotFoundException < Struct.new(
1961
+ :message)
1962
+ SENSITIVE = []
1963
+ include Aws::Structure
1964
+ end
1965
+
1966
+ # The request exceeds the service quota for your account. Request a
1967
+ # quota increase or reduce your request size.
1968
+ #
1969
+ # @!attribute [rw] message
1970
+ # Message for the `ServiceQuotaExceededException` error.
1971
+ # @return [String]
1972
+ #
1973
+ # @see http://docs.aws.amazon.com/goto/WebAPI/mpa-2022-07-26/ServiceQuotaExceededException AWS API Documentation
1974
+ #
1975
+ class ServiceQuotaExceededException < Struct.new(
1976
+ :message)
1977
+ SENSITIVE = []
1978
+ include Aws::Structure
1979
+ end
1980
+
1981
+ # @!attribute [rw] pending_window_days
1982
+ # Number of days between when the team approves the delete request and
1983
+ # when the team is deleted.
1984
+ # @return [Integer]
1985
+ #
1986
+ # @!attribute [rw] arn
1987
+ # Amazon Resource Name (ARN) for the team.
1988
+ # @return [String]
1989
+ #
1990
+ # @see http://docs.aws.amazon.com/goto/WebAPI/mpa-2022-07-26/StartActiveApprovalTeamDeletionRequest AWS API Documentation
1991
+ #
1992
+ class StartActiveApprovalTeamDeletionRequest < Struct.new(
1993
+ :pending_window_days,
1994
+ :arn)
1995
+ SENSITIVE = []
1996
+ include Aws::Structure
1997
+ end
1998
+
1999
+ # @!attribute [rw] deletion_completion_time
2000
+ # Timestamp when the deletion process is scheduled to complete.
2001
+ # @return [Time]
2002
+ #
2003
+ # @!attribute [rw] deletion_start_time
2004
+ # Timestamp when the deletion process was initiated.
2005
+ # @return [Time]
2006
+ #
2007
+ # @see http://docs.aws.amazon.com/goto/WebAPI/mpa-2022-07-26/StartActiveApprovalTeamDeletionResponse AWS API Documentation
2008
+ #
2009
+ class StartActiveApprovalTeamDeletionResponse < Struct.new(
2010
+ :deletion_completion_time,
2011
+ :deletion_start_time)
2012
+ SENSITIVE = []
2013
+ include Aws::Structure
2014
+ end
2015
+
2016
+ # @!attribute [rw] resource_arn
2017
+ # Amazon Resource Name (ARN) for the resource you want to tag.
2018
+ # @return [String]
2019
+ #
2020
+ # @!attribute [rw] tags
2021
+ # Tags that you have added to the specified resource.
2022
+ # @return [Hash<String,String>]
2023
+ #
2024
+ # @see http://docs.aws.amazon.com/goto/WebAPI/mpa-2022-07-26/TagResourceRequest AWS API Documentation
2025
+ #
2026
+ class TagResourceRequest < Struct.new(
2027
+ :resource_arn,
2028
+ :tags)
2029
+ SENSITIVE = [:tags]
2030
+ include Aws::Structure
2031
+ end
2032
+
2033
+ # @see http://docs.aws.amazon.com/goto/WebAPI/mpa-2022-07-26/TagResourceResponse AWS API Documentation
2034
+ #
2035
+ class TagResourceResponse < Aws::EmptyStructure; end
2036
+
2037
+ # The request was denied due to request throttling.
2038
+ #
2039
+ # @!attribute [rw] message
2040
+ # Message for the `ThrottlingException` error.
2041
+ # @return [String]
2042
+ #
2043
+ # @see http://docs.aws.amazon.com/goto/WebAPI/mpa-2022-07-26/ThrottlingException AWS API Documentation
2044
+ #
2045
+ class ThrottlingException < Struct.new(
2046
+ :message)
2047
+ SENSITIVE = []
2048
+ include Aws::Structure
2049
+ end
2050
+
2051
+ # The request exceeds the maximum number of tags allowed for this
2052
+ # resource. Remove some tags, and try again.
2053
+ #
2054
+ # @!attribute [rw] message
2055
+ # Message for the `TooManyTagsException` error.
2056
+ # @return [String]
2057
+ #
2058
+ # @!attribute [rw] resource_name
2059
+ # Name of the resource for the `TooManyTagsException` error.
2060
+ # @return [String]
2061
+ #
2062
+ # @see http://docs.aws.amazon.com/goto/WebAPI/mpa-2022-07-26/TooManyTagsException AWS API Documentation
2063
+ #
2064
+ class TooManyTagsException < Struct.new(
2065
+ :message,
2066
+ :resource_name)
2067
+ SENSITIVE = []
2068
+ include Aws::Structure
2069
+ end
2070
+
2071
+ # @!attribute [rw] resource_arn
2072
+ # Amazon Resource Name (ARN) for the resource you want to untag.
2073
+ # @return [String]
2074
+ #
2075
+ # @!attribute [rw] tag_keys
2076
+ # Array of tag key-value pairs that you want to untag.
2077
+ # @return [Array<String>]
2078
+ #
2079
+ # @see http://docs.aws.amazon.com/goto/WebAPI/mpa-2022-07-26/UntagResourceRequest AWS API Documentation
2080
+ #
2081
+ class UntagResourceRequest < Struct.new(
2082
+ :resource_arn,
2083
+ :tag_keys)
2084
+ SENSITIVE = [:tag_keys]
2085
+ include Aws::Structure
2086
+ end
2087
+
2088
+ # @see http://docs.aws.amazon.com/goto/WebAPI/mpa-2022-07-26/UntagResourceResponse AWS API Documentation
2089
+ #
2090
+ class UntagResourceResponse < Aws::EmptyStructure; end
2091
+
2092
+ # @!attribute [rw] approval_strategy
2093
+ # An `ApprovalStrategy` object. Contains details for how the team
2094
+ # grants approval.
2095
+ # @return [Types::ApprovalStrategy]
2096
+ #
2097
+ # @!attribute [rw] approvers
2098
+ # An array of `ApprovalTeamRequestApprover` objects. Contains details
2099
+ # for the approvers in the team.
2100
+ # @return [Array<Types::ApprovalTeamRequestApprover>]
2101
+ #
2102
+ # @!attribute [rw] description
2103
+ # Description for the team.
2104
+ # @return [String]
2105
+ #
2106
+ # @!attribute [rw] arn
2107
+ # Amazon Resource Name (ARN) for the team.
2108
+ # @return [String]
2109
+ #
2110
+ # @see http://docs.aws.amazon.com/goto/WebAPI/mpa-2022-07-26/UpdateApprovalTeamRequest AWS API Documentation
2111
+ #
2112
+ class UpdateApprovalTeamRequest < Struct.new(
2113
+ :approval_strategy,
2114
+ :approvers,
2115
+ :description,
2116
+ :arn)
2117
+ SENSITIVE = [:description]
2118
+ include Aws::Structure
2119
+ end
2120
+
2121
+ # @!attribute [rw] version_id
2122
+ # Version ID for the team that was created. When an approval team is
2123
+ # updated, the version ID changes.
2124
+ # @return [String]
2125
+ #
2126
+ # @see http://docs.aws.amazon.com/goto/WebAPI/mpa-2022-07-26/UpdateApprovalTeamResponse AWS API Documentation
2127
+ #
2128
+ class UpdateApprovalTeamResponse < Struct.new(
2129
+ :version_id)
2130
+ SENSITIVE = []
2131
+ include Aws::Structure
2132
+ end
2133
+
2134
+ # The input fails to satisfy the constraints specified by an Amazon Web
2135
+ # Services service.
2136
+ #
2137
+ # @!attribute [rw] message
2138
+ # Message for the `ValidationException` error.
2139
+ # @return [String]
2140
+ #
2141
+ # @see http://docs.aws.amazon.com/goto/WebAPI/mpa-2022-07-26/ValidationException AWS API Documentation
2142
+ #
2143
+ class ValidationException < Struct.new(
2144
+ :message)
2145
+ SENSITIVE = []
2146
+ include Aws::Structure
2147
+ end
2148
+
2149
+ end
2150
+ end
2151
+