aws-sdk-securityir 1.11.0 → 1.12.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- checksums.yaml +4 -4
- data/CHANGELOG.md +5 -0
- data/VERSION +1 -1
- data/lib/aws-sdk-securityir/client.rb +187 -53
- data/lib/aws-sdk-securityir/client_api.rb +25 -0
- data/lib/aws-sdk-securityir/types.rb +294 -52
- data/lib/aws-sdk-securityir.rb +1 -1
- data/sig/client.rbs +14 -6
- data/sig/types.rbs +22 -5
- metadata +1 -1
@@ -11,6 +11,7 @@ module Aws::SecurityIR
|
|
11
11
|
module Types
|
12
12
|
|
13
13
|
# @!attribute [rw] message
|
14
|
+
# The ID of the resource which lead to the access denial.
|
14
15
|
# @return [String]
|
15
16
|
#
|
16
17
|
# @see http://docs.aws.amazon.com/goto/WebAPI/security-ir-2018-05-10/AccessDeniedException AWS API Documentation
|
@@ -29,6 +30,13 @@ module Aws::SecurityIR
|
|
29
30
|
# @!attribute [rw] account_ids
|
30
31
|
# Optional element to query the membership relationship status to a
|
31
32
|
# provided list of account IDs.
|
33
|
+
#
|
34
|
+
# <note markdown="1"> AWS account ID's may appear less than 12 characters and need to be
|
35
|
+
# zero-prepended. An example would be `123123123` which is nine
|
36
|
+
# digits, and with zero-prepend would be `000123123123`. Not
|
37
|
+
# zero-prepending to 12 digits could result in errors.
|
38
|
+
#
|
39
|
+
# </note>
|
32
40
|
# @return [Array<String>]
|
33
41
|
#
|
34
42
|
# @see http://docs.aws.amazon.com/goto/WebAPI/security-ir-2018-05-10/BatchGetMemberAccountDetailsRequest AWS API Documentation
|
@@ -46,7 +54,7 @@ module Aws::SecurityIR
|
|
46
54
|
# @return [Array<Types::GetMembershipAccountDetailItem>]
|
47
55
|
#
|
48
56
|
# @!attribute [rw] errors
|
49
|
-
# The response element providing
|
57
|
+
# The response element providing error messages for requests to
|
50
58
|
# GetMembershipAccountDetails.
|
51
59
|
# @return [Array<Types::GetMembershipAccountDetailError>]
|
52
60
|
#
|
@@ -150,13 +158,13 @@ module Aws::SecurityIR
|
|
150
158
|
|
151
159
|
# @!attribute [rw] case_status
|
152
160
|
# A response element providing responses for requests to CloseCase.
|
153
|
-
# This element responds
|
161
|
+
# This element responds `Closed ` if successful.
|
154
162
|
# @return [String]
|
155
163
|
#
|
156
164
|
# @!attribute [rw] closed_date
|
157
165
|
# A response element providing responses for requests to CloseCase.
|
158
|
-
# This element responds with the
|
159
|
-
#
|
166
|
+
# This element responds with the ISO-8601 formatted timestamp of the
|
167
|
+
# moment when the case was closed.
|
160
168
|
# @return [Time]
|
161
169
|
#
|
162
170
|
# @see http://docs.aws.amazon.com/goto/WebAPI/security-ir-2018-05-10/CloseCaseResponse AWS API Documentation
|
@@ -169,14 +177,15 @@ module Aws::SecurityIR
|
|
169
177
|
end
|
170
178
|
|
171
179
|
# @!attribute [rw] message
|
180
|
+
# The exception message.
|
172
181
|
# @return [String]
|
173
182
|
#
|
174
183
|
# @!attribute [rw] resource_id
|
175
|
-
#
|
184
|
+
# The ID of the conflicting resource.
|
176
185
|
# @return [String]
|
177
186
|
#
|
178
187
|
# @!attribute [rw] resource_type
|
179
|
-
#
|
188
|
+
# The type of the conflicting resource.
|
180
189
|
# @return [String]
|
181
190
|
#
|
182
191
|
# @see http://docs.aws.amazon.com/goto/WebAPI/security-ir-2018-05-10/ConflictException AWS API Documentation
|
@@ -195,7 +204,13 @@ module Aws::SecurityIR
|
|
195
204
|
# @return [String]
|
196
205
|
#
|
197
206
|
# @!attribute [rw] client_token
|
198
|
-
#
|
207
|
+
# <note markdown="1"> The `clientToken` field is an idempotency key
|
208
|
+
# used to ensure that
|
209
|
+
# repeated attempts for a single action will be ignored by the server
|
210
|
+
# during retries. A caller supplied unique ID (typically a UUID)
|
211
|
+
# should be provided.
|
212
|
+
#
|
213
|
+
# </note>
|
199
214
|
#
|
200
215
|
# **A suitable default value is auto-generated.** You should normally
|
201
216
|
# not need to pass this option.
|
@@ -229,7 +244,13 @@ module Aws::SecurityIR
|
|
229
244
|
end
|
230
245
|
|
231
246
|
# @!attribute [rw] client_token
|
232
|
-
#
|
247
|
+
# <note markdown="1"> The `clientToken` field is an idempotency key
|
248
|
+
# used to ensure that
|
249
|
+
# repeated attempts for a single action will be ignored by the server
|
250
|
+
# during retries. A caller supplied unique ID (typically a UUID)
|
251
|
+
# should be provided.
|
252
|
+
#
|
253
|
+
# </note>
|
233
254
|
#
|
234
255
|
# **A suitable default value is auto-generated.** You should normally
|
235
256
|
# not need to pass this option.
|
@@ -237,8 +258,7 @@ module Aws::SecurityIR
|
|
237
258
|
#
|
238
259
|
# @!attribute [rw] resolver_type
|
239
260
|
# Required element used in combination with CreateCase to identify the
|
240
|
-
# resolver type.
|
241
|
-
# aws-supported.
|
261
|
+
# resolver type.
|
242
262
|
# @return [String]
|
243
263
|
#
|
244
264
|
# @!attribute [rw] title
|
@@ -247,8 +267,9 @@ module Aws::SecurityIR
|
|
247
267
|
# @return [String]
|
248
268
|
#
|
249
269
|
# @!attribute [rw] description
|
250
|
-
# Required element used in combination with CreateCase
|
251
|
-
#
|
270
|
+
# Required element used in combination with CreateCase
|
271
|
+
#
|
272
|
+
# to provide a description for the new case.
|
252
273
|
# @return [String]
|
253
274
|
#
|
254
275
|
# @!attribute [rw] engagement_type
|
@@ -265,6 +286,13 @@ module Aws::SecurityIR
|
|
265
286
|
# @!attribute [rw] impacted_accounts
|
266
287
|
# Required element used in combination with CreateCase to provide a
|
267
288
|
# list of impacted accounts.
|
289
|
+
#
|
290
|
+
# <note markdown="1"> AWS account ID's may appear less than 12 characters and need to be
|
291
|
+
# zero-prepended. An example would be `123123123` which is nine
|
292
|
+
# digits, and with zero-prepend would be `000123123123`. Not
|
293
|
+
# zero-prepending to 12 digits could result in errors.
|
294
|
+
#
|
295
|
+
# </note>
|
268
296
|
# @return [Array<String>]
|
269
297
|
#
|
270
298
|
# @!attribute [rw] watchers
|
@@ -326,19 +354,25 @@ module Aws::SecurityIR
|
|
326
354
|
end
|
327
355
|
|
328
356
|
# @!attribute [rw] client_token
|
329
|
-
#
|
357
|
+
# <note markdown="1"> The `clientToken` field is an idempotency key
|
358
|
+
# used to ensure that
|
359
|
+
# repeated attempts for a single action will be ignored by the server
|
360
|
+
# during retries. A caller supplied unique ID (typically a UUID)
|
361
|
+
# should be provided.
|
362
|
+
#
|
363
|
+
# </note>
|
330
364
|
#
|
331
365
|
# **A suitable default value is auto-generated.** You should normally
|
332
366
|
# not need to pass this option.
|
333
367
|
# @return [String]
|
334
368
|
#
|
335
369
|
# @!attribute [rw] membership_name
|
336
|
-
# Required element
|
370
|
+
# Required element used in combination with CreateMembership to create
|
337
371
|
# a name for the membership.
|
338
372
|
# @return [String]
|
339
373
|
#
|
340
374
|
# @!attribute [rw] incident_response_team
|
341
|
-
# Required element
|
375
|
+
# Required element used in combination with CreateMembership to add
|
342
376
|
# customer incident response team members and trusted partners to the
|
343
377
|
# membership.
|
344
378
|
# @return [Array<Types::IncidentResponder>]
|
@@ -352,6 +386,25 @@ module Aws::SecurityIR
|
|
352
386
|
# Optional element for customer configured tags.
|
353
387
|
# @return [Hash<String,String>]
|
354
388
|
#
|
389
|
+
# @!attribute [rw] cover_entire_organization
|
390
|
+
# The `coverEntireOrganization` parameter is a boolean flag that
|
391
|
+
# determines whether the membership should be applied to the entire
|
392
|
+
# Amazon Web Services Organization. When set to true, the membership
|
393
|
+
# will be created for all accounts within the organization. When set
|
394
|
+
# to false, the membership will only be created for specified
|
395
|
+
# accounts.
|
396
|
+
#
|
397
|
+
# This parameter is optional. If not specified, the default value is
|
398
|
+
# false.
|
399
|
+
#
|
400
|
+
# * If set to *true*: The membership will automatically include all
|
401
|
+
# existing and future accounts in the Amazon Web Services
|
402
|
+
# Organization.
|
403
|
+
#
|
404
|
+
# * If set to *false*: The membership will only apply to explicitly
|
405
|
+
# specified accounts.
|
406
|
+
# @return [Boolean]
|
407
|
+
#
|
355
408
|
# @see http://docs.aws.amazon.com/goto/WebAPI/security-ir-2018-05-10/CreateMembershipRequest AWS API Documentation
|
356
409
|
#
|
357
410
|
class CreateMembershipRequest < Struct.new(
|
@@ -359,7 +412,8 @@ module Aws::SecurityIR
|
|
359
412
|
:membership_name,
|
360
413
|
:incident_response_team,
|
361
414
|
:opt_in_features,
|
362
|
-
:tags
|
415
|
+
:tags,
|
416
|
+
:cover_entire_organization)
|
363
417
|
SENSITIVE = [:membership_name]
|
364
418
|
include Aws::Structure
|
365
419
|
end
|
@@ -411,7 +465,7 @@ module Aws::SecurityIR
|
|
411
465
|
|
412
466
|
# @!attribute [rw] case_id
|
413
467
|
# Required element for GetCaseAttachmentUploadUrl to identify the case
|
414
|
-
# ID for uploading an attachment
|
468
|
+
# ID for uploading an attachment.
|
415
469
|
# @return [String]
|
416
470
|
#
|
417
471
|
# @!attribute [rw] file_name
|
@@ -421,11 +475,17 @@ module Aws::SecurityIR
|
|
421
475
|
#
|
422
476
|
# @!attribute [rw] content_length
|
423
477
|
# Required element for GetCaseAttachmentUploadUrl to identify the size
|
424
|
-
#
|
478
|
+
# of the file attachment.
|
425
479
|
# @return [Integer]
|
426
480
|
#
|
427
481
|
# @!attribute [rw] client_token
|
428
|
-
#
|
482
|
+
# <note markdown="1"> The `clientToken` field is an idempotency key
|
483
|
+
# used to ensure that
|
484
|
+
# repeated attempts for a single action will be ignored by the server
|
485
|
+
# during retries. A caller supplied unique ID (typically a UUID)
|
486
|
+
# should be provided.
|
487
|
+
#
|
488
|
+
# </note>
|
429
489
|
#
|
430
490
|
# **A suitable default value is auto-generated.** You should normally
|
431
491
|
# not need to pass this option.
|
@@ -443,7 +503,7 @@ module Aws::SecurityIR
|
|
443
503
|
end
|
444
504
|
|
445
505
|
# @!attribute [rw] attachment_presigned_url
|
446
|
-
# Response element providing the Amazon S3 presigned
|
506
|
+
# Response element providing the Amazon S3 presigned URL to upload the
|
447
507
|
# attachment.
|
448
508
|
# @return [String]
|
449
509
|
#
|
@@ -513,8 +573,8 @@ module Aws::SecurityIR
|
|
513
573
|
# @return [Array<Types::ThreatActorIp>]
|
514
574
|
#
|
515
575
|
# @!attribute [rw] pending_action
|
516
|
-
# Response element for GetCase that
|
517
|
-
#
|
576
|
+
# Response element for GetCase that identifies the case is waiting on
|
577
|
+
# customer input.
|
518
578
|
# @return [String]
|
519
579
|
#
|
520
580
|
# @!attribute [rw] impacted_accounts
|
@@ -544,7 +604,7 @@ module Aws::SecurityIR
|
|
544
604
|
#
|
545
605
|
# @!attribute [rw] resolver_type
|
546
606
|
# Response element for GetCase that provides the current resolver
|
547
|
-
# types.
|
607
|
+
# types.
|
548
608
|
# @return [String]
|
549
609
|
#
|
550
610
|
# @!attribute [rw] impacted_services
|
@@ -645,13 +705,13 @@ module Aws::SecurityIR
|
|
645
705
|
# @return [String]
|
646
706
|
#
|
647
707
|
# @!attribute [rw] account_id
|
648
|
-
# Response element for GetMembership that provides the
|
649
|
-
#
|
708
|
+
# Response element for GetMembership that provides the account
|
709
|
+
# configured to manage the membership.
|
650
710
|
# @return [String]
|
651
711
|
#
|
652
712
|
# @!attribute [rw] region
|
653
|
-
# Response element for GetMembership that provides the
|
654
|
-
#
|
713
|
+
# Response element for GetMembership that provides the region
|
714
|
+
# configured to manage the membership.
|
655
715
|
# @return [String]
|
656
716
|
#
|
657
717
|
# @!attribute [rw] membership_name
|
@@ -698,6 +758,20 @@ module Aws::SecurityIR
|
|
698
758
|
# features have been enabled.
|
699
759
|
# @return [Array<Types::OptInFeature>]
|
700
760
|
#
|
761
|
+
# @!attribute [rw] membership_accounts_configurations
|
762
|
+
# The `membershipAccountsConfigurations` field contains the
|
763
|
+
# configuration details for member accounts within the Amazon Web
|
764
|
+
# Services Organizations membership structure.
|
765
|
+
#
|
766
|
+
# This field returns a structure containing information about:
|
767
|
+
#
|
768
|
+
# * Account configurations for member accounts
|
769
|
+
#
|
770
|
+
# * Membership settings and preferences
|
771
|
+
#
|
772
|
+
# * Account-level permissions and roles
|
773
|
+
# @return [Types::MembershipAccountsConfigurations]
|
774
|
+
#
|
701
775
|
# @see http://docs.aws.amazon.com/goto/WebAPI/security-ir-2018-05-10/GetMembershipResponse AWS API Documentation
|
702
776
|
#
|
703
777
|
class GetMembershipResponse < Struct.new(
|
@@ -712,7 +786,8 @@ module Aws::SecurityIR
|
|
712
786
|
:customer_type,
|
713
787
|
:number_of_accounts_covered,
|
714
788
|
:incident_response_team,
|
715
|
-
:opt_in_features
|
789
|
+
:opt_in_features,
|
790
|
+
:membership_accounts_configurations)
|
716
791
|
SENSITIVE = [:membership_name]
|
717
792
|
include Aws::Structure
|
718
793
|
end
|
@@ -748,11 +823,11 @@ module Aws::SecurityIR
|
|
748
823
|
end
|
749
824
|
|
750
825
|
# @!attribute [rw] message
|
826
|
+
# The exception message.
|
751
827
|
# @return [String]
|
752
828
|
#
|
753
829
|
# @!attribute [rw] retry_after_seconds
|
754
|
-
#
|
755
|
-
# retried.
|
830
|
+
# The number of seconds after which to retry the request.
|
756
831
|
# @return [Integer]
|
757
832
|
#
|
758
833
|
# @see http://docs.aws.amazon.com/goto/WebAPI/security-ir-2018-05-10/InternalServerException AWS API Documentation
|
@@ -765,6 +840,7 @@ module Aws::SecurityIR
|
|
765
840
|
end
|
766
841
|
|
767
842
|
# @!attribute [rw] message
|
843
|
+
# The exception message.
|
768
844
|
# @return [String]
|
769
845
|
#
|
770
846
|
# @see http://docs.aws.amazon.com/goto/WebAPI/security-ir-2018-05-10/InvalidTokenException AWS API Documentation
|
@@ -776,7 +852,9 @@ module Aws::SecurityIR
|
|
776
852
|
end
|
777
853
|
|
778
854
|
# @!attribute [rw] next_token
|
779
|
-
#
|
855
|
+
# An optional string that, if supplied, must be copied from the output
|
856
|
+
# of a previous call to ListCaseEdits. When provided in this manner,
|
857
|
+
# the API fetches the next page of results.
|
780
858
|
# @return [String]
|
781
859
|
#
|
782
860
|
# @!attribute [rw] max_results
|
@@ -800,12 +878,13 @@ module Aws::SecurityIR
|
|
800
878
|
end
|
801
879
|
|
802
880
|
# @!attribute [rw] next_token
|
803
|
-
#
|
881
|
+
# An optional string that, if supplied on subsequent calls to
|
882
|
+
# ListCaseEdits, allows the API to fetch the next page of results.
|
804
883
|
# @return [String]
|
805
884
|
#
|
806
885
|
# @!attribute [rw] items
|
807
|
-
# Response element for ListCaseEdits that includes the action,
|
808
|
-
#
|
886
|
+
# Response element for ListCaseEdits that includes the action, event
|
887
|
+
# timestamp, message, and principal for the response.
|
809
888
|
# @return [Array<Types::CaseEditItem>]
|
810
889
|
#
|
811
890
|
# @!attribute [rw] total
|
@@ -871,7 +950,9 @@ module Aws::SecurityIR
|
|
871
950
|
end
|
872
951
|
|
873
952
|
# @!attribute [rw] next_token
|
874
|
-
#
|
953
|
+
# An optional string that, if supplied, must be copied from the output
|
954
|
+
# of a previous call to ListCases. When provided in this manner, the
|
955
|
+
# API fetches the next page of results.
|
875
956
|
# @return [String]
|
876
957
|
#
|
877
958
|
# @!attribute [rw] max_results
|
@@ -888,7 +969,8 @@ module Aws::SecurityIR
|
|
888
969
|
end
|
889
970
|
|
890
971
|
# @!attribute [rw] next_token
|
891
|
-
#
|
972
|
+
# An optional string that, if supplied on subsequent calls to
|
973
|
+
# ListCases, allows the API to fetch the next page of results.
|
892
974
|
# @return [String]
|
893
975
|
#
|
894
976
|
# @!attribute [rw] items
|
@@ -945,7 +1027,9 @@ module Aws::SecurityIR
|
|
945
1027
|
end
|
946
1028
|
|
947
1029
|
# @!attribute [rw] next_token
|
948
|
-
#
|
1030
|
+
# An optional string that, if supplied, must be copied from the output
|
1031
|
+
# of a previous call to ListComments. When provided in this manner,
|
1032
|
+
# the API fetches the next page of results.
|
949
1033
|
# @return [String]
|
950
1034
|
#
|
951
1035
|
# @!attribute [rw] max_results
|
@@ -967,7 +1051,8 @@ module Aws::SecurityIR
|
|
967
1051
|
end
|
968
1052
|
|
969
1053
|
# @!attribute [rw] next_token
|
970
|
-
#
|
1054
|
+
# An optional string that, if supplied on subsequent calls to
|
1055
|
+
# ListComments, allows the API to fetch the next page of results.
|
971
1056
|
# @return [String]
|
972
1057
|
#
|
973
1058
|
# @!attribute [rw] items
|
@@ -1019,7 +1104,9 @@ module Aws::SecurityIR
|
|
1019
1104
|
end
|
1020
1105
|
|
1021
1106
|
# @!attribute [rw] next_token
|
1022
|
-
#
|
1107
|
+
# An optional string that, if supplied, must be copied from the output
|
1108
|
+
# of a previous call to ListMemberships. When provided in this manner,
|
1109
|
+
# the API fetches the next page of results.
|
1023
1110
|
# @return [String]
|
1024
1111
|
#
|
1025
1112
|
# @!attribute [rw] max_results
|
@@ -1037,7 +1124,8 @@ module Aws::SecurityIR
|
|
1037
1124
|
end
|
1038
1125
|
|
1039
1126
|
# @!attribute [rw] next_token
|
1040
|
-
#
|
1127
|
+
# An optional string that, if supplied on subsequent calls to
|
1128
|
+
# ListMemberships, allows the API to fetch the next page of results.
|
1041
1129
|
# @return [String]
|
1042
1130
|
#
|
1043
1131
|
# @!attribute [rw] items
|
@@ -1081,6 +1169,114 @@ module Aws::SecurityIR
|
|
1081
1169
|
include Aws::Structure
|
1082
1170
|
end
|
1083
1171
|
|
1172
|
+
# The `MembershipAccountsConfigurations` structure defines the
|
1173
|
+
# configuration settings for managing membership accounts withinAmazon
|
1174
|
+
# Web Services.
|
1175
|
+
#
|
1176
|
+
# This structure contains settings that determine how member accounts
|
1177
|
+
# are configured and managed within your organization, including:
|
1178
|
+
#
|
1179
|
+
# * Account configuration preferences
|
1180
|
+
#
|
1181
|
+
# * Membership validation rules
|
1182
|
+
#
|
1183
|
+
# * Account access settings
|
1184
|
+
#
|
1185
|
+
# You can use this structure to define and maintain standardized
|
1186
|
+
# configurations across multiple member accounts in your organization.
|
1187
|
+
#
|
1188
|
+
# @!attribute [rw] cover_entire_organization
|
1189
|
+
# The `coverEntireOrganization` field is a boolean value that
|
1190
|
+
# determines whether the membership configuration applies to all
|
1191
|
+
# accounts within an Amazon Web Services Organization.
|
1192
|
+
#
|
1193
|
+
# When set to `true`, the configuration will be applied across all
|
1194
|
+
# accounts in the organization. When set to `false`, the configuration
|
1195
|
+
# will only apply to specifically designated accounts under the AWS
|
1196
|
+
# Organizational Units specificied.
|
1197
|
+
# @return [Boolean]
|
1198
|
+
#
|
1199
|
+
# @!attribute [rw] organizational_units
|
1200
|
+
# A list of organizational unit IDs that follow the pattern
|
1201
|
+
# `ou-[0-9a-z]{4,32}-[a-z0-9]{8,32}`. These IDs represent the
|
1202
|
+
# organizational units within an Amazon Web Services Organizations
|
1203
|
+
# structure that are covered by the membership.
|
1204
|
+
#
|
1205
|
+
# Each organizational unit ID in the list must:
|
1206
|
+
#
|
1207
|
+
# * Begin with the prefix 'ou-'
|
1208
|
+
#
|
1209
|
+
# * Contain between 4 and 32 alphanumeric characters in the first
|
1210
|
+
# segment
|
1211
|
+
#
|
1212
|
+
# * Contain between 8 and 32 alphanumeric characters in the second
|
1213
|
+
# segment
|
1214
|
+
# @return [Array<String>]
|
1215
|
+
#
|
1216
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/security-ir-2018-05-10/MembershipAccountsConfigurations AWS API Documentation
|
1217
|
+
#
|
1218
|
+
class MembershipAccountsConfigurations < Struct.new(
|
1219
|
+
:cover_entire_organization,
|
1220
|
+
:organizational_units)
|
1221
|
+
SENSITIVE = []
|
1222
|
+
include Aws::Structure
|
1223
|
+
end
|
1224
|
+
|
1225
|
+
# The `MembershipAccountsConfigurationsUpdate`structure represents the
|
1226
|
+
# configuration updates for member accounts within an Amazon Web
|
1227
|
+
# Services organization.
|
1228
|
+
#
|
1229
|
+
# This structure is used to modify existing account configurations and
|
1230
|
+
# settings for members in the organization. When applying updates,
|
1231
|
+
# ensure all required fields are properly specified to maintain account
|
1232
|
+
# consistency.
|
1233
|
+
#
|
1234
|
+
# Key considerations when using this structure:
|
1235
|
+
#
|
1236
|
+
# * All configuration changes are validated before being applied
|
1237
|
+
#
|
1238
|
+
# * Updates are processed asynchronously in the background
|
1239
|
+
#
|
1240
|
+
# * Configuration changes may take several minutes to propagate across
|
1241
|
+
# all affected accounts
|
1242
|
+
#
|
1243
|
+
# @!attribute [rw] cover_entire_organization
|
1244
|
+
# The `coverEntireOrganization` field is a boolean value that
|
1245
|
+
# determines whether the membership configuration should be applied
|
1246
|
+
# across the entire Amazon Web Services Organization.
|
1247
|
+
#
|
1248
|
+
# When set to `true`, the configuration will be applied to all
|
1249
|
+
# accounts within the organization. When set to `false`, the
|
1250
|
+
# configuration will only apply to specifically designated accounts.
|
1251
|
+
# @return [Boolean]
|
1252
|
+
#
|
1253
|
+
# @!attribute [rw] organizational_units_to_add
|
1254
|
+
# A list of organizational unit IDs to add to the membership
|
1255
|
+
# configuration. Each organizational unit ID must match the pattern
|
1256
|
+
# `ou-[0-9a-z]{4,32}-[a-z0-9]{8,32}`.
|
1257
|
+
#
|
1258
|
+
# The list must contain between 1 and 5 organizational unit IDs.
|
1259
|
+
# @return [Array<String>]
|
1260
|
+
#
|
1261
|
+
# @!attribute [rw] organizational_units_to_remove
|
1262
|
+
# A list of organizational unit IDs to remove from the membership
|
1263
|
+
# configuration. Each organizational unit ID must match the pattern
|
1264
|
+
# `ou-[0-9a-z]{4,32}-[a-z0-9]{8,32}`.
|
1265
|
+
#
|
1266
|
+
# The list must contain between 1 and 5 organizational unit IDs per
|
1267
|
+
# invocation of the API request.
|
1268
|
+
# @return [Array<String>]
|
1269
|
+
#
|
1270
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/security-ir-2018-05-10/MembershipAccountsConfigurationsUpdate AWS API Documentation
|
1271
|
+
#
|
1272
|
+
class MembershipAccountsConfigurationsUpdate < Struct.new(
|
1273
|
+
:cover_entire_organization,
|
1274
|
+
:organizational_units_to_add,
|
1275
|
+
:organizational_units_to_remove)
|
1276
|
+
SENSITIVE = []
|
1277
|
+
include Aws::Structure
|
1278
|
+
end
|
1279
|
+
|
1084
1280
|
# @!attribute [rw] feature_name
|
1085
1281
|
# @return [String]
|
1086
1282
|
#
|
@@ -1097,6 +1293,7 @@ module Aws::SecurityIR
|
|
1097
1293
|
end
|
1098
1294
|
|
1099
1295
|
# @!attribute [rw] message
|
1296
|
+
# The exception message.
|
1100
1297
|
# @return [String]
|
1101
1298
|
#
|
1102
1299
|
# @see http://docs.aws.amazon.com/goto/WebAPI/security-ir-2018-05-10/ResourceNotFoundException AWS API Documentation
|
@@ -1108,6 +1305,7 @@ module Aws::SecurityIR
|
|
1108
1305
|
end
|
1109
1306
|
|
1110
1307
|
# @!attribute [rw] message
|
1308
|
+
# The exception message.
|
1111
1309
|
# @return [String]
|
1112
1310
|
#
|
1113
1311
|
# @see http://docs.aws.amazon.com/goto/WebAPI/security-ir-2018-05-10/SecurityIncidentResponseNotActiveException AWS API Documentation
|
@@ -1119,22 +1317,25 @@ module Aws::SecurityIR
|
|
1119
1317
|
end
|
1120
1318
|
|
1121
1319
|
# @!attribute [rw] message
|
1320
|
+
# The exception message.
|
1122
1321
|
# @return [String]
|
1123
1322
|
#
|
1124
1323
|
# @!attribute [rw] resource_id
|
1125
|
-
#
|
1324
|
+
# The ID of the requested resource which lead to the service quota
|
1325
|
+
# exception.
|
1126
1326
|
# @return [String]
|
1127
1327
|
#
|
1128
1328
|
# @!attribute [rw] resource_type
|
1129
|
-
#
|
1329
|
+
# The type of the requested resource which lead to the service quota
|
1330
|
+
# exception.
|
1130
1331
|
# @return [String]
|
1131
1332
|
#
|
1132
1333
|
# @!attribute [rw] service_code
|
1133
|
-
#
|
1334
|
+
# The service code of the quota.
|
1134
1335
|
# @return [String]
|
1135
1336
|
#
|
1136
1337
|
# @!attribute [rw] quota_code
|
1137
|
-
#
|
1338
|
+
# The code of the quota.
|
1138
1339
|
# @return [String]
|
1139
1340
|
#
|
1140
1341
|
# @see http://docs.aws.amazon.com/goto/WebAPI/security-ir-2018-05-10/ServiceQuotaExceededException AWS API Documentation
|
@@ -1188,19 +1389,19 @@ module Aws::SecurityIR
|
|
1188
1389
|
end
|
1189
1390
|
|
1190
1391
|
# @!attribute [rw] message
|
1392
|
+
# The exception message.
|
1191
1393
|
# @return [String]
|
1192
1394
|
#
|
1193
1395
|
# @!attribute [rw] service_code
|
1194
|
-
#
|
1396
|
+
# The service code of the exception.
|
1195
1397
|
# @return [String]
|
1196
1398
|
#
|
1197
1399
|
# @!attribute [rw] quota_code
|
1198
|
-
#
|
1400
|
+
# The quota code of the exception.
|
1199
1401
|
# @return [String]
|
1200
1402
|
#
|
1201
1403
|
# @!attribute [rw] retry_after_seconds
|
1202
|
-
#
|
1203
|
-
# retried.
|
1404
|
+
# The number of seconds after which to retry the request.
|
1204
1405
|
# @return [Integer]
|
1205
1406
|
#
|
1206
1407
|
# @see http://docs.aws.amazon.com/goto/WebAPI/security-ir-2018-05-10/ThrottlingException AWS API Documentation
|
@@ -1353,11 +1554,25 @@ module Aws::SecurityIR
|
|
1353
1554
|
# @!attribute [rw] impacted_accounts_to_add
|
1354
1555
|
# Optional element for UpdateCase to provide content to add accounts
|
1355
1556
|
# impacted.
|
1557
|
+
#
|
1558
|
+
# <note markdown="1"> AWS account ID's may appear less than 12 characters and need to be
|
1559
|
+
# zero-prepended. An example would be `123123123` which is nine
|
1560
|
+
# digits, and with zero-prepend would be `000123123123`. Not
|
1561
|
+
# zero-prepending to 12 digits could result in errors.
|
1562
|
+
#
|
1563
|
+
# </note>
|
1356
1564
|
# @return [Array<String>]
|
1357
1565
|
#
|
1358
1566
|
# @!attribute [rw] impacted_accounts_to_delete
|
1359
1567
|
# Optional element for UpdateCase to provide content to add accounts
|
1360
1568
|
# impacted.
|
1569
|
+
#
|
1570
|
+
# <note markdown="1"> AWS account ID's may appear less than 12 characters and need to be
|
1571
|
+
# zero-prepended. An example would be `123123123` which is nine
|
1572
|
+
# digits, and with zero-prepend would be `000123123123`. Not
|
1573
|
+
# zero-prepending to 12 digits could result in errors.
|
1574
|
+
#
|
1575
|
+
# </note>
|
1361
1576
|
# @return [Array<String>]
|
1362
1577
|
#
|
1363
1578
|
# @see http://docs.aws.amazon.com/goto/WebAPI/security-ir-2018-05-10/UpdateCaseRequest AWS API Documentation
|
@@ -1438,13 +1653,40 @@ module Aws::SecurityIR
|
|
1438
1653
|
# features for the service.
|
1439
1654
|
# @return [Array<Types::OptInFeature>]
|
1440
1655
|
#
|
1656
|
+
# @!attribute [rw] membership_accounts_configurations_update
|
1657
|
+
# The `membershipAccountsConfigurationsUpdate` field in the
|
1658
|
+
# `UpdateMembershipRequest` structure allows you to update the
|
1659
|
+
# configuration settings for accounts within a membership.
|
1660
|
+
#
|
1661
|
+
# This field is optional and contains a structure of type
|
1662
|
+
# `MembershipAccountsConfigurationsUpdate ` that specifies the updated
|
1663
|
+
# account configurations for the membership.
|
1664
|
+
# @return [Types::MembershipAccountsConfigurationsUpdate]
|
1665
|
+
#
|
1666
|
+
# @!attribute [rw] undo_membership_cancellation
|
1667
|
+
# The `undoMembershipCancellation` parameter is a boolean flag that
|
1668
|
+
# indicates whether to reverse a previously requested membership
|
1669
|
+
# cancellation. When set to true, this will revoke the cancellation
|
1670
|
+
# request and maintain the membership status.
|
1671
|
+
#
|
1672
|
+
# This parameter is optional and can be used in scenarios where you
|
1673
|
+
# need to restore a membership that was marked for cancellation but
|
1674
|
+
# hasn't been fully terminated yet.
|
1675
|
+
#
|
1676
|
+
# * If set to `true`, the cancellation request will be revoked
|
1677
|
+
#
|
1678
|
+
# * If set to `false` the service will throw a ValidationException.
|
1679
|
+
# @return [Boolean]
|
1680
|
+
#
|
1441
1681
|
# @see http://docs.aws.amazon.com/goto/WebAPI/security-ir-2018-05-10/UpdateMembershipRequest AWS API Documentation
|
1442
1682
|
#
|
1443
1683
|
class UpdateMembershipRequest < Struct.new(
|
1444
1684
|
:membership_id,
|
1445
1685
|
:membership_name,
|
1446
1686
|
:incident_response_team,
|
1447
|
-
:opt_in_features
|
1687
|
+
:opt_in_features,
|
1688
|
+
:membership_accounts_configurations_update,
|
1689
|
+
:undo_membership_cancellation)
|
1448
1690
|
SENSITIVE = [:membership_name]
|
1449
1691
|
include Aws::Structure
|
1450
1692
|
end
|
@@ -1498,15 +1740,15 @@ module Aws::SecurityIR
|
|
1498
1740
|
end
|
1499
1741
|
|
1500
1742
|
# @!attribute [rw] message
|
1743
|
+
# The exception message.
|
1501
1744
|
# @return [String]
|
1502
1745
|
#
|
1503
1746
|
# @!attribute [rw] reason
|
1504
|
-
#
|
1747
|
+
# The reason for the exception.
|
1505
1748
|
# @return [String]
|
1506
1749
|
#
|
1507
1750
|
# @!attribute [rw] field_list
|
1508
|
-
#
|
1509
|
-
# applicable.
|
1751
|
+
# The fields which lead to the exception.
|
1510
1752
|
# @return [Array<Types::ValidationExceptionField>]
|
1511
1753
|
#
|
1512
1754
|
# @see http://docs.aws.amazon.com/goto/WebAPI/security-ir-2018-05-10/ValidationException AWS API Documentation
|