aws-sdk-rolesanywhere 1.2.0 → 1.4.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.
@@ -41,21 +41,13 @@ module Aws::RolesAnywhere
41
41
  # @return [String]
42
42
  #
43
43
  # @!attribute [rw] require_instance_properties
44
- # Specifies whether instance properties are required in
45
- # [CreateSession][1] requests with this profile.
46
- #
47
- #
48
- #
49
- # [1]: https://docs.aws.amazon.com/rolesanywhere/latest/APIReference/API_CreateSession.html
44
+ # Specifies whether instance properties are required in temporary
45
+ # credential requests with this profile.
50
46
  # @return [Boolean]
51
47
  #
52
48
  # @!attribute [rw] role_arns
53
- # A list of IAM roles that this profile can assume in a
54
- # [CreateSession][1] operation.
55
- #
56
- #
57
- #
58
- # [1]: https://docs.aws.amazon.com/rolesanywhere/latest/APIReference/API_CreateSession.html
49
+ # A list of IAM roles that this profile can assume in a temporary
50
+ # credential request.
59
51
  # @return [Array<String>]
60
52
  #
61
53
  # @!attribute [rw] session_policy
@@ -90,6 +82,11 @@ module Aws::RolesAnywhere
90
82
  # The name of the trust anchor.
91
83
  # @return [String]
92
84
  #
85
+ # @!attribute [rw] notification_settings
86
+ # A list of notification settings to be associated to the trust
87
+ # anchor.
88
+ # @return [Array<Types::NotificationSetting>]
89
+ #
93
90
  # @!attribute [rw] source
94
91
  # The trust anchor type and its related certificate data.
95
92
  # @return [Types::Source]
@@ -103,28 +100,22 @@ module Aws::RolesAnywhere
103
100
  class CreateTrustAnchorRequest < Struct.new(
104
101
  :enabled,
105
102
  :name,
103
+ :notification_settings,
106
104
  :source,
107
105
  :tags)
108
106
  SENSITIVE = []
109
107
  include Aws::Structure
110
108
  end
111
109
 
112
- # A record of a presented X509 credential to [CreateSession][1].
113
- #
114
- #
115
- #
116
- # [1]: https://docs.aws.amazon.com/rolesanywhere/latest/APIReference/API_CreateSession.html
110
+ # A record of a presented X509 credential from a temporary credential
111
+ # request.
117
112
  #
118
113
  # @!attribute [rw] enabled
119
114
  # Indicates whether the credential is enabled.
120
115
  # @return [Boolean]
121
116
  #
122
117
  # @!attribute [rw] failed
123
- # Indicates whether the [CreateSession][1] operation was successful.
124
- #
125
- #
126
- #
127
- # [1]: https://docs.aws.amazon.com/rolesanywhere/latest/APIReference/API_CreateSession.html
118
+ # Indicates whether the temporary credential request was successful.
128
119
  # @return [Boolean]
129
120
  #
130
121
  # @!attribute [rw] issuer
@@ -134,11 +125,7 @@ module Aws::RolesAnywhere
134
125
  #
135
126
  # @!attribute [rw] seen_at
136
127
  # The ISO-8601 time stamp of when the certificate was last used in a
137
- # [CreateSession][1] operation.
138
- #
139
- #
140
- #
141
- # [1]: https://docs.aws.amazon.com/rolesanywhere/latest/APIReference/API_CreateSession.html
128
+ # temporary credential request.
142
129
  # @return [Time]
143
130
  #
144
131
  # @!attribute [rw] serial_number
@@ -230,7 +217,7 @@ module Aws::RolesAnywhere
230
217
  end
231
218
 
232
219
  # @!attribute [rw] crl_data
233
- # The x509 v3 specified certificate revocation list
220
+ # The x509 v3 specified certificate revocation list (CRL).
234
221
  # @return [String]
235
222
  #
236
223
  # @!attribute [rw] enabled
@@ -266,11 +253,7 @@ module Aws::RolesAnywhere
266
253
  # authenticating instance.
267
254
  #
268
255
  # @!attribute [rw] failed
269
- # Indicates whether the [CreateSession][1] operation was successful.
270
- #
271
- #
272
- #
273
- # [1]: https://docs.aws.amazon.com/rolesanywhere/latest/APIReference/API_CreateSession.html
256
+ # Indicates whether the temporary credential request was successful.
274
257
  # @return [Boolean]
275
258
  #
276
259
  # @!attribute [rw] properties
@@ -279,11 +262,7 @@ module Aws::RolesAnywhere
279
262
  #
280
263
  # @!attribute [rw] seen_at
281
264
  # The ISO-8601 time stamp of when the certificate was last used in a
282
- # [CreateSession][1] operation.
283
- #
284
- #
285
- #
286
- # [1]: https://docs.aws.amazon.com/rolesanywhere/latest/APIReference/API_CreateSession.html
265
+ # temporary credential request.
287
266
  # @return [Time]
288
267
  #
289
268
  # @see http://docs.aws.amazon.com/goto/WebAPI/rolesanywhere-2018-05-10/InstanceProperty AWS API Documentation
@@ -302,8 +281,8 @@ module Aws::RolesAnywhere
302
281
  #
303
282
  # @!attribute [rw] next_token
304
283
  # A token that indicates where the output should continue from, if a
305
- # previous operation did not show all results. To get the next
306
- # results, call the operation again with this value.
284
+ # previous request did not show all results. To get the next results,
285
+ # make the request again with this value.
307
286
  # @return [String]
308
287
  #
309
288
  # @see http://docs.aws.amazon.com/goto/WebAPI/rolesanywhere-2018-05-10/ListCrlsResponse AWS API Documentation
@@ -317,8 +296,8 @@ module Aws::RolesAnywhere
317
296
 
318
297
  # @!attribute [rw] next_token
319
298
  # A token that indicates where the output should continue from, if a
320
- # previous operation did not show all results. To get the next
321
- # results, call the operation again with this value.
299
+ # previous request did not show all results. To get the next results,
300
+ # make the request again with this value.
322
301
  # @return [String]
323
302
  #
324
303
  # @!attribute [rw] profiles
@@ -336,8 +315,8 @@ module Aws::RolesAnywhere
336
315
 
337
316
  # @!attribute [rw] next_token
338
317
  # A token that indicates where the output should continue from, if a
339
- # previous operation did not show all results. To get the next
340
- # results, call the operation again with this value.
318
+ # previous request did not show all results. To get the next results,
319
+ # make the request again with this value.
341
320
  # @return [String]
342
321
  #
343
322
  # @!attribute [rw] page_size
@@ -355,8 +334,8 @@ module Aws::RolesAnywhere
355
334
 
356
335
  # @!attribute [rw] next_token
357
336
  # A token that indicates where the output should continue from, if a
358
- # previous operation did not show all results. To get the next
359
- # results, call the operation again with this value.
337
+ # previous request did not show all results. To get the next results,
338
+ # make the request again with this value.
360
339
  # @return [String]
361
340
  #
362
341
  # @!attribute [rw] subjects
@@ -398,8 +377,8 @@ module Aws::RolesAnywhere
398
377
 
399
378
  # @!attribute [rw] next_token
400
379
  # A token that indicates where the output should continue from, if a
401
- # previous operation did not show all results. To get the next
402
- # results, call the operation again with this value.
380
+ # previous request did not show all results. To get the next results,
381
+ # make the request again with this value.
403
382
  # @return [String]
404
383
  #
405
384
  # @!attribute [rw] trust_anchors
@@ -415,6 +394,114 @@ module Aws::RolesAnywhere
415
394
  include Aws::Structure
416
395
  end
417
396
 
397
+ # Customizable notification settings that will be applied to
398
+ # notification events. IAM Roles Anywhere consumes these settings while
399
+ # notifying across multiple channels - CloudWatch metrics, EventBridge,
400
+ # and Health Dashboard.
401
+ #
402
+ # @!attribute [rw] channel
403
+ # The specified channel of notification. IAM Roles Anywhere uses
404
+ # CloudWatch metrics, EventBridge, and Health Dashboard to notify for
405
+ # an event.
406
+ #
407
+ # <note markdown="1"> In the absence of a specific channel, IAM Roles Anywhere applies
408
+ # this setting to 'ALL' channels.
409
+ #
410
+ # </note>
411
+ # @return [String]
412
+ #
413
+ # @!attribute [rw] enabled
414
+ # Indicates whether the notification setting is enabled.
415
+ # @return [Boolean]
416
+ #
417
+ # @!attribute [rw] event
418
+ # The event to which this notification setting is applied.
419
+ # @return [String]
420
+ #
421
+ # @!attribute [rw] threshold
422
+ # The number of days before a notification event. This value is
423
+ # required for a notification setting that is enabled.
424
+ # @return [Integer]
425
+ #
426
+ # @see http://docs.aws.amazon.com/goto/WebAPI/rolesanywhere-2018-05-10/NotificationSetting AWS API Documentation
427
+ #
428
+ class NotificationSetting < Struct.new(
429
+ :channel,
430
+ :enabled,
431
+ :event,
432
+ :threshold)
433
+ SENSITIVE = []
434
+ include Aws::Structure
435
+ end
436
+
437
+ # The state of a notification setting.
438
+ #
439
+ # A notification setting includes information such as event name,
440
+ # threshold, status of the notification setting, and the channel to
441
+ # notify.
442
+ #
443
+ # @!attribute [rw] channel
444
+ # The specified channel of notification. IAM Roles Anywhere uses
445
+ # CloudWatch metrics, EventBridge, and Health Dashboard to notify for
446
+ # an event.
447
+ #
448
+ # <note markdown="1"> In the absence of a specific channel, IAM Roles Anywhere applies
449
+ # this setting to 'ALL' channels.
450
+ #
451
+ # </note>
452
+ # @return [String]
453
+ #
454
+ # @!attribute [rw] configured_by
455
+ # The principal that configured the notification setting. For default
456
+ # settings configured by IAM Roles Anywhere, the value is
457
+ # `rolesanywhere.amazonaws.com`, and for customized notifications
458
+ # settings, it is the respective account ID.
459
+ # @return [String]
460
+ #
461
+ # @!attribute [rw] enabled
462
+ # Indicates whether the notification setting is enabled.
463
+ # @return [Boolean]
464
+ #
465
+ # @!attribute [rw] event
466
+ # The event to which this notification setting is applied.
467
+ # @return [String]
468
+ #
469
+ # @!attribute [rw] threshold
470
+ # The number of days before a notification event.
471
+ # @return [Integer]
472
+ #
473
+ # @see http://docs.aws.amazon.com/goto/WebAPI/rolesanywhere-2018-05-10/NotificationSettingDetail AWS API Documentation
474
+ #
475
+ class NotificationSettingDetail < Struct.new(
476
+ :channel,
477
+ :configured_by,
478
+ :enabled,
479
+ :event,
480
+ :threshold)
481
+ SENSITIVE = []
482
+ include Aws::Structure
483
+ end
484
+
485
+ # A notification setting key to reset. A notification setting key
486
+ # includes the event and the channel.
487
+ #
488
+ # @!attribute [rw] channel
489
+ # The specified channel of notification.
490
+ # @return [String]
491
+ #
492
+ # @!attribute [rw] event
493
+ # The notification setting event to reset.
494
+ # @return [String]
495
+ #
496
+ # @see http://docs.aws.amazon.com/goto/WebAPI/rolesanywhere-2018-05-10/NotificationSettingKey AWS API Documentation
497
+ #
498
+ class NotificationSettingKey < Struct.new(
499
+ :channel,
500
+ :event)
501
+ SENSITIVE = []
502
+ include Aws::Structure
503
+ end
504
+
418
505
  # The state of the profile after a read or write operation.
419
506
  #
420
507
  # @!attribute [rw] created_at
@@ -451,21 +538,13 @@ module Aws::RolesAnywhere
451
538
  # @return [String]
452
539
  #
453
540
  # @!attribute [rw] require_instance_properties
454
- # Specifies whether instance properties are required in
455
- # [CreateSession][1] requests with this profile.
456
- #
457
- #
458
- #
459
- # [1]: https://docs.aws.amazon.com/rolesanywhere/latest/APIReference/API_CreateSession.html
541
+ # Specifies whether instance properties are required in temporary
542
+ # credential requests with this profile.
460
543
  # @return [Boolean]
461
544
  #
462
545
  # @!attribute [rw] role_arns
463
- # A list of IAM roles that this profile can assume in a
464
- # [CreateSession][1] operation.
465
- #
466
- #
467
- #
468
- # [1]: https://docs.aws.amazon.com/rolesanywhere/latest/APIReference/API_CreateSession.html
546
+ # A list of IAM roles that this profile can assume in a temporary
547
+ # credential request.
469
548
  # @return [Array<String>]
470
549
  #
471
550
  # @!attribute [rw] session_policy
@@ -508,6 +587,66 @@ module Aws::RolesAnywhere
508
587
  include Aws::Structure
509
588
  end
510
589
 
590
+ # @!attribute [rw] notification_settings
591
+ # A list of notification settings to be associated to the trust
592
+ # anchor.
593
+ # @return [Array<Types::NotificationSetting>]
594
+ #
595
+ # @!attribute [rw] trust_anchor_id
596
+ # The unique identifier of the trust anchor.
597
+ # @return [String]
598
+ #
599
+ # @see http://docs.aws.amazon.com/goto/WebAPI/rolesanywhere-2018-05-10/PutNotificationSettingsRequest AWS API Documentation
600
+ #
601
+ class PutNotificationSettingsRequest < Struct.new(
602
+ :notification_settings,
603
+ :trust_anchor_id)
604
+ SENSITIVE = []
605
+ include Aws::Structure
606
+ end
607
+
608
+ # @!attribute [rw] trust_anchor
609
+ # The state of the trust anchor after a read or write operation.
610
+ # @return [Types::TrustAnchorDetail]
611
+ #
612
+ # @see http://docs.aws.amazon.com/goto/WebAPI/rolesanywhere-2018-05-10/PutNotificationSettingsResponse AWS API Documentation
613
+ #
614
+ class PutNotificationSettingsResponse < Struct.new(
615
+ :trust_anchor)
616
+ SENSITIVE = []
617
+ include Aws::Structure
618
+ end
619
+
620
+ # @!attribute [rw] notification_setting_keys
621
+ # A list of notification setting keys to reset. A notification setting
622
+ # key includes the event and the channel.
623
+ # @return [Array<Types::NotificationSettingKey>]
624
+ #
625
+ # @!attribute [rw] trust_anchor_id
626
+ # The unique identifier of the trust anchor.
627
+ # @return [String]
628
+ #
629
+ # @see http://docs.aws.amazon.com/goto/WebAPI/rolesanywhere-2018-05-10/ResetNotificationSettingsRequest AWS API Documentation
630
+ #
631
+ class ResetNotificationSettingsRequest < Struct.new(
632
+ :notification_setting_keys,
633
+ :trust_anchor_id)
634
+ SENSITIVE = []
635
+ include Aws::Structure
636
+ end
637
+
638
+ # @!attribute [rw] trust_anchor
639
+ # The state of the trust anchor after a read or write operation.
640
+ # @return [Types::TrustAnchorDetail]
641
+ #
642
+ # @see http://docs.aws.amazon.com/goto/WebAPI/rolesanywhere-2018-05-10/ResetNotificationSettingsResponse AWS API Documentation
643
+ #
644
+ class ResetNotificationSettingsResponse < Struct.new(
645
+ :trust_anchor)
646
+ SENSITIVE = []
647
+ include Aws::Structure
648
+ end
649
+
511
650
  # The resource could not be found.
512
651
  #
513
652
  # @!attribute [rw] message
@@ -595,14 +734,9 @@ module Aws::RolesAnywhere
595
734
  # @note SourceData is a union - when returned from an API call exactly one value will be set and the returned type will be a subclass of SourceData corresponding to the set member.
596
735
  #
597
736
  # @!attribute [rw] acm_pca_arn
598
- # The root certificate of the Certificate Manager Private Certificate
599
- # Authority specified by this ARN is used in trust validation for
600
- # [CreateSession][1] operations. Included for trust anchors of type
601
- # `AWS_ACM_PCA`.
602
- #
603
- #
604
- #
605
- # [1]: https://docs.aws.amazon.com/rolesanywhere/latest/APIReference/API_CreateSession.html
737
+ # The root certificate of the Private Certificate Authority specified
738
+ # by this ARN is used in trust validation for temporary credential
739
+ # requests. Included for trust anchors of type `AWS_ACM_PCA`.
606
740
  # @return [String]
607
741
  #
608
742
  # @!attribute [rw] x509_certificate_data
@@ -633,7 +767,7 @@ module Aws::RolesAnywhere
633
767
  #
634
768
  # @!attribute [rw] credentials
635
769
  # The temporary session credentials vended at the last authenticating
636
- # call with this Subject.
770
+ # call with this subject.
637
771
  # @return [Array<Types::CredentialSummary>]
638
772
  #
639
773
  # @!attribute [rw] enabled
@@ -645,7 +779,7 @@ module Aws::RolesAnywhere
645
779
  # @return [Array<Types::InstanceProperty>]
646
780
  #
647
781
  # @!attribute [rw] last_seen_at
648
- # The ISO-8601 timestamp of the last time this Subject requested
782
+ # The ISO-8601 timestamp of the last time this subject requested
649
783
  # temporary session credentials.
650
784
  # @return [Time]
651
785
  #
@@ -693,29 +827,20 @@ module Aws::RolesAnywhere
693
827
  include Aws::Structure
694
828
  end
695
829
 
696
- # A summary representation of Subject resources returned in read
697
- # operations; primarily ListSubjects.
830
+ # A summary representation of subjects.
698
831
  #
699
832
  # @!attribute [rw] created_at
700
833
  # The ISO-8601 time stamp of when the certificate was first used in a
701
- # [CreateSession][1] operation.
702
- #
703
- #
704
- #
705
- # [1]: https://docs.aws.amazon.com/rolesanywhere/latest/APIReference/API_CreateSession.html
834
+ # temporary credential request.
706
835
  # @return [Time]
707
836
  #
708
837
  # @!attribute [rw] enabled
709
- # The enabled status of the Subject.
838
+ # The enabled status of the subject.
710
839
  # @return [Boolean]
711
840
  #
712
841
  # @!attribute [rw] last_seen_at
713
842
  # The ISO-8601 time stamp of when the certificate was last used in a
714
- # [CreateSession][1] operation.
715
- #
716
- #
717
- #
718
- # [1]: https://docs.aws.amazon.com/rolesanywhere/latest/APIReference/API_CreateSession.html
843
+ # temporary credential request.
719
844
  # @return [Time]
720
845
  #
721
846
  # @!attribute [rw] subject_arn
@@ -815,6 +940,11 @@ module Aws::RolesAnywhere
815
940
  # The name of the trust anchor.
816
941
  # @return [String]
817
942
  #
943
+ # @!attribute [rw] notification_settings
944
+ # A list of notification settings to be associated to the trust
945
+ # anchor.
946
+ # @return [Array<Types::NotificationSettingDetail>]
947
+ #
818
948
  # @!attribute [rw] source
819
949
  # The trust anchor type and its related certificate data.
820
950
  # @return [Types::Source]
@@ -837,6 +967,7 @@ module Aws::RolesAnywhere
837
967
  :created_at,
838
968
  :enabled,
839
969
  :name,
970
+ :notification_settings,
840
971
  :source,
841
972
  :trust_anchor_arn,
842
973
  :trust_anchor_id,
@@ -879,7 +1010,7 @@ module Aws::RolesAnywhere
879
1010
  class UntagResourceResponse < Aws::EmptyStructure; end
880
1011
 
881
1012
  # @!attribute [rw] crl_data
882
- # The x509 v3 specified certificate revocation list
1013
+ # The x509 v3 specified certificate revocation list (CRL).
883
1014
  # @return [String]
884
1015
  #
885
1016
  # @!attribute [rw] crl_id
@@ -918,12 +1049,8 @@ module Aws::RolesAnywhere
918
1049
  # @return [String]
919
1050
  #
920
1051
  # @!attribute [rw] role_arns
921
- # A list of IAM roles that this profile can assume in a
922
- # [CreateSession][1] operation.
923
- #
924
- #
925
- #
926
- # [1]: https://docs.aws.amazon.com/rolesanywhere/latest/APIReference/API_CreateSession.html
1052
+ # A list of IAM roles that this profile can assume in a temporary
1053
+ # credential request.
927
1054
  # @return [Array<String>]
928
1055
  #
929
1056
  # @!attribute [rw] session_policy
@@ -52,6 +52,6 @@ require_relative 'aws-sdk-rolesanywhere/customizations'
52
52
  # @!group service
53
53
  module Aws::RolesAnywhere
54
54
 
55
- GEM_VERSION = '1.2.0'
55
+ GEM_VERSION = '1.4.0'
56
56
 
57
57
  end
metadata CHANGED
@@ -1,14 +1,14 @@
1
1
  --- !ruby/object:Gem::Specification
2
2
  name: aws-sdk-rolesanywhere
3
3
  version: !ruby/object:Gem::Version
4
- version: 1.2.0
4
+ version: 1.4.0
5
5
  platform: ruby
6
6
  authors:
7
7
  - Amazon Web Services
8
8
  autorequire:
9
9
  bindir: bin
10
10
  cert_chain: []
11
- date: 2023-01-18 00:00:00.000000000 Z
11
+ date: 2023-05-31 00:00:00.000000000 Z
12
12
  dependencies:
13
13
  - !ruby/object:Gem::Dependency
14
14
  name: aws-sdk-core
@@ -19,7 +19,7 @@ dependencies:
19
19
  version: '3'
20
20
  - - ">="
21
21
  - !ruby/object:Gem::Version
22
- version: 3.165.0
22
+ version: 3.174.0
23
23
  type: :runtime
24
24
  prerelease: false
25
25
  version_requirements: !ruby/object:Gem::Requirement
@@ -29,7 +29,7 @@ dependencies:
29
29
  version: '3'
30
30
  - - ">="
31
31
  - !ruby/object:Gem::Version
32
- version: 3.165.0
32
+ version: 3.174.0
33
33
  - !ruby/object:Gem::Dependency
34
34
  name: aws-sigv4
35
35
  requirement: !ruby/object:Gem::Requirement