aws-sdk-securityir 1.0.0

Sign up to get free protection for your applications and to get access to all the features.
@@ -0,0 +1,1558 @@
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::SecurityIR
11
+ module Types
12
+
13
+ # @!attribute [rw] message
14
+ # @return [String]
15
+ #
16
+ # @see http://docs.aws.amazon.com/goto/WebAPI/security-ir-2018-05-10/AccessDeniedException AWS API Documentation
17
+ #
18
+ class AccessDeniedException < Struct.new(
19
+ :message)
20
+ SENSITIVE = []
21
+ include Aws::Structure
22
+ end
23
+
24
+ # @!attribute [rw] membership_id
25
+ # Required element used in combination with
26
+ # BatchGetMemberAccountDetails to identify the membership ID to query.
27
+ # @return [String]
28
+ #
29
+ # @!attribute [rw] account_ids
30
+ # Optional element to query the membership relationship status to a
31
+ # provided list of account IDs.
32
+ # @return [Array<String>]
33
+ #
34
+ # @see http://docs.aws.amazon.com/goto/WebAPI/security-ir-2018-05-10/BatchGetMemberAccountDetailsRequest AWS API Documentation
35
+ #
36
+ class BatchGetMemberAccountDetailsRequest < Struct.new(
37
+ :membership_id,
38
+ :account_ids)
39
+ SENSITIVE = []
40
+ include Aws::Structure
41
+ end
42
+
43
+ # @!attribute [rw] items
44
+ # The response element providing responses for requests to
45
+ # GetMembershipAccountDetails.
46
+ # @return [Array<Types::GetMembershipAccountDetailItem>]
47
+ #
48
+ # @!attribute [rw] errors
49
+ # The response element providing errors messages for requests to
50
+ # GetMembershipAccountDetails.
51
+ # @return [Array<Types::GetMembershipAccountDetailError>]
52
+ #
53
+ # @see http://docs.aws.amazon.com/goto/WebAPI/security-ir-2018-05-10/BatchGetMemberAccountDetailsResponse AWS API Documentation
54
+ #
55
+ class BatchGetMemberAccountDetailsResponse < Struct.new(
56
+ :items,
57
+ :errors)
58
+ SENSITIVE = []
59
+ include Aws::Structure
60
+ end
61
+
62
+ # @!attribute [rw] membership_id
63
+ # Required element used in combination with CancelMembershipRequest to
64
+ # identify the membership ID to cancel.
65
+ # @return [String]
66
+ #
67
+ # @see http://docs.aws.amazon.com/goto/WebAPI/security-ir-2018-05-10/CancelMembershipRequest AWS API Documentation
68
+ #
69
+ class CancelMembershipRequest < Struct.new(
70
+ :membership_id)
71
+ SENSITIVE = []
72
+ include Aws::Structure
73
+ end
74
+
75
+ # @!attribute [rw] membership_id
76
+ # The response element providing responses for requests to
77
+ # CancelMembershipRequest.
78
+ # @return [String]
79
+ #
80
+ # @see http://docs.aws.amazon.com/goto/WebAPI/security-ir-2018-05-10/CancelMembershipResponse AWS API Documentation
81
+ #
82
+ class CancelMembershipResponse < Struct.new(
83
+ :membership_id)
84
+ SENSITIVE = []
85
+ include Aws::Structure
86
+ end
87
+
88
+ # @!attribute [rw] attachment_id
89
+ # @return [String]
90
+ #
91
+ # @!attribute [rw] file_name
92
+ # @return [String]
93
+ #
94
+ # @!attribute [rw] attachment_status
95
+ # @return [String]
96
+ #
97
+ # @!attribute [rw] creator
98
+ # @return [String]
99
+ #
100
+ # @!attribute [rw] created_date
101
+ # @return [Time]
102
+ #
103
+ # @see http://docs.aws.amazon.com/goto/WebAPI/security-ir-2018-05-10/CaseAttachmentAttributes AWS API Documentation
104
+ #
105
+ class CaseAttachmentAttributes < Struct.new(
106
+ :attachment_id,
107
+ :file_name,
108
+ :attachment_status,
109
+ :creator,
110
+ :created_date)
111
+ SENSITIVE = [:file_name]
112
+ include Aws::Structure
113
+ end
114
+
115
+ # @!attribute [rw] event_timestamp
116
+ # @return [Time]
117
+ #
118
+ # @!attribute [rw] principal
119
+ # @return [String]
120
+ #
121
+ # @!attribute [rw] action
122
+ # @return [String]
123
+ #
124
+ # @!attribute [rw] message
125
+ # @return [String]
126
+ #
127
+ # @see http://docs.aws.amazon.com/goto/WebAPI/security-ir-2018-05-10/CaseEditItem AWS API Documentation
128
+ #
129
+ class CaseEditItem < Struct.new(
130
+ :event_timestamp,
131
+ :principal,
132
+ :action,
133
+ :message)
134
+ SENSITIVE = []
135
+ include Aws::Structure
136
+ end
137
+
138
+ # @!attribute [rw] case_id
139
+ # Required element used in combination with CloseCase to identify the
140
+ # case ID to close.
141
+ # @return [String]
142
+ #
143
+ # @see http://docs.aws.amazon.com/goto/WebAPI/security-ir-2018-05-10/CloseCaseRequest AWS API Documentation
144
+ #
145
+ class CloseCaseRequest < Struct.new(
146
+ :case_id)
147
+ SENSITIVE = []
148
+ include Aws::Structure
149
+ end
150
+
151
+ # @!attribute [rw] case_status
152
+ # A response element providing responses for requests to CloseCase.
153
+ # This element responds with the case status following the action.
154
+ # @return [String]
155
+ #
156
+ # @!attribute [rw] closed_date
157
+ # A response element providing responses for requests to CloseCase.
158
+ # This element responds with the case closure date following the
159
+ # action.
160
+ # @return [Time]
161
+ #
162
+ # @see http://docs.aws.amazon.com/goto/WebAPI/security-ir-2018-05-10/CloseCaseResponse AWS API Documentation
163
+ #
164
+ class CloseCaseResponse < Struct.new(
165
+ :case_status,
166
+ :closed_date)
167
+ SENSITIVE = []
168
+ include Aws::Structure
169
+ end
170
+
171
+ # @!attribute [rw] message
172
+ # @return [String]
173
+ #
174
+ # @!attribute [rw] resource_id
175
+ # Element providing the ID of the resource affected.
176
+ # @return [String]
177
+ #
178
+ # @!attribute [rw] resource_type
179
+ # Element providing the type of the resource affected.
180
+ # @return [String]
181
+ #
182
+ # @see http://docs.aws.amazon.com/goto/WebAPI/security-ir-2018-05-10/ConflictException AWS API Documentation
183
+ #
184
+ class ConflictException < Struct.new(
185
+ :message,
186
+ :resource_id,
187
+ :resource_type)
188
+ SENSITIVE = []
189
+ include Aws::Structure
190
+ end
191
+
192
+ # @!attribute [rw] case_id
193
+ # Required element used in combination with CreateCaseComment to
194
+ # specify a case ID.
195
+ # @return [String]
196
+ #
197
+ # @!attribute [rw] client_token
198
+ # An optional element used in combination with CreateCaseComment.
199
+ #
200
+ # **A suitable default value is auto-generated.** You should normally
201
+ # not need to pass this option.
202
+ # @return [String]
203
+ #
204
+ # @!attribute [rw] body
205
+ # Required element used in combination with CreateCaseComment to add
206
+ # content for the new comment.
207
+ # @return [String]
208
+ #
209
+ # @see http://docs.aws.amazon.com/goto/WebAPI/security-ir-2018-05-10/CreateCaseCommentRequest AWS API Documentation
210
+ #
211
+ class CreateCaseCommentRequest < Struct.new(
212
+ :case_id,
213
+ :client_token,
214
+ :body)
215
+ SENSITIVE = [:body]
216
+ include Aws::Structure
217
+ end
218
+
219
+ # @!attribute [rw] comment_id
220
+ # Response element indicating the new comment ID.
221
+ # @return [String]
222
+ #
223
+ # @see http://docs.aws.amazon.com/goto/WebAPI/security-ir-2018-05-10/CreateCaseCommentResponse AWS API Documentation
224
+ #
225
+ class CreateCaseCommentResponse < Struct.new(
226
+ :comment_id)
227
+ SENSITIVE = []
228
+ include Aws::Structure
229
+ end
230
+
231
+ # @!attribute [rw] client_token
232
+ # Required element used in combination with CreateCase.
233
+ #
234
+ # **A suitable default value is auto-generated.** You should normally
235
+ # not need to pass this option.
236
+ # @return [String]
237
+ #
238
+ # @!attribute [rw] resolver_type
239
+ # Required element used in combination with CreateCase to identify the
240
+ # resolver type. Available resolvers include self-supported \|
241
+ # aws-supported.
242
+ # @return [String]
243
+ #
244
+ # @!attribute [rw] title
245
+ # Required element used in combination with CreateCase to provide a
246
+ # title for the new case.
247
+ # @return [String]
248
+ #
249
+ # @!attribute [rw] description
250
+ # Required element used in combination with CreateCase to provide a
251
+ # description for the new case.
252
+ # @return [String]
253
+ #
254
+ # @!attribute [rw] engagement_type
255
+ # Required element used in combination with CreateCase to provide an
256
+ # engagement type for the new cases. Available engagement types
257
+ # include Security Incident \| Investigation
258
+ # @return [String]
259
+ #
260
+ # @!attribute [rw] reported_incident_start_date
261
+ # Required element used in combination with CreateCase to provide an
262
+ # initial start date for the unauthorized activity.
263
+ # @return [Time]
264
+ #
265
+ # @!attribute [rw] impacted_accounts
266
+ # Required element used in combination with CreateCase to provide a
267
+ # list of impacted accounts.
268
+ # @return [Array<String>]
269
+ #
270
+ # @!attribute [rw] watchers
271
+ # Required element used in combination with CreateCase to provide a
272
+ # list of entities to receive notifications for case updates.
273
+ # @return [Array<Types::Watcher>]
274
+ #
275
+ # @!attribute [rw] threat_actor_ip_addresses
276
+ # An optional element used in combination with CreateCase to provide a
277
+ # list of suspicious internet protocol addresses associated with
278
+ # unauthorized activity.
279
+ # @return [Array<Types::ThreatActorIp>]
280
+ #
281
+ # @!attribute [rw] impacted_services
282
+ # An optional element used in combination with CreateCase to provide a
283
+ # list of services impacted.
284
+ # @return [Array<String>]
285
+ #
286
+ # @!attribute [rw] impacted_aws_regions
287
+ # An optional element used in combination with CreateCase to provide a
288
+ # list of impacted regions.
289
+ # @return [Array<Types::ImpactedAwsRegion>]
290
+ #
291
+ # @!attribute [rw] tags
292
+ # An optional element used in combination with CreateCase to add
293
+ # customer specified tags to a case.
294
+ # @return [Hash<String,String>]
295
+ #
296
+ # @see http://docs.aws.amazon.com/goto/WebAPI/security-ir-2018-05-10/CreateCaseRequest AWS API Documentation
297
+ #
298
+ class CreateCaseRequest < Struct.new(
299
+ :client_token,
300
+ :resolver_type,
301
+ :title,
302
+ :description,
303
+ :engagement_type,
304
+ :reported_incident_start_date,
305
+ :impacted_accounts,
306
+ :watchers,
307
+ :threat_actor_ip_addresses,
308
+ :impacted_services,
309
+ :impacted_aws_regions,
310
+ :tags)
311
+ SENSITIVE = [:title, :description]
312
+ include Aws::Structure
313
+ end
314
+
315
+ # @!attribute [rw] case_id
316
+ # A response element providing responses for requests to CreateCase.
317
+ # This element responds with the case ID.
318
+ # @return [String]
319
+ #
320
+ # @see http://docs.aws.amazon.com/goto/WebAPI/security-ir-2018-05-10/CreateCaseResponse AWS API Documentation
321
+ #
322
+ class CreateCaseResponse < Struct.new(
323
+ :case_id)
324
+ SENSITIVE = []
325
+ include Aws::Structure
326
+ end
327
+
328
+ # @!attribute [rw] client_token
329
+ # An optional element used in combination with CreateMembership.
330
+ #
331
+ # **A suitable default value is auto-generated.** You should normally
332
+ # not need to pass this option.
333
+ # @return [String]
334
+ #
335
+ # @!attribute [rw] membership_name
336
+ # Required element use in combination with CreateMembership to create
337
+ # a name for the membership.
338
+ # @return [String]
339
+ #
340
+ # @!attribute [rw] incident_response_team
341
+ # Required element use in combination with CreateMembership to add
342
+ # customer incident response team members and trusted partners to the
343
+ # membership.
344
+ # @return [Array<Types::IncidentResponder>]
345
+ #
346
+ # @!attribute [rw] opt_in_features
347
+ # Optional element to enable the monitoring and investigation opt-in
348
+ # features for the service.
349
+ # @return [Array<Types::OptInFeature>]
350
+ #
351
+ # @!attribute [rw] tags
352
+ # Optional element for customer configured tags.
353
+ # @return [Hash<String,String>]
354
+ #
355
+ # @see http://docs.aws.amazon.com/goto/WebAPI/security-ir-2018-05-10/CreateMembershipRequest AWS API Documentation
356
+ #
357
+ class CreateMembershipRequest < Struct.new(
358
+ :client_token,
359
+ :membership_name,
360
+ :incident_response_team,
361
+ :opt_in_features,
362
+ :tags)
363
+ SENSITIVE = [:membership_name]
364
+ include Aws::Structure
365
+ end
366
+
367
+ # @!attribute [rw] membership_id
368
+ # Response element for CreateMembership providing the newly created
369
+ # membership ID.
370
+ # @return [String]
371
+ #
372
+ # @see http://docs.aws.amazon.com/goto/WebAPI/security-ir-2018-05-10/CreateMembershipResponse AWS API Documentation
373
+ #
374
+ class CreateMembershipResponse < Struct.new(
375
+ :membership_id)
376
+ SENSITIVE = []
377
+ include Aws::Structure
378
+ end
379
+
380
+ # @!attribute [rw] case_id
381
+ # Required element for GetCaseAttachmentDownloadUrl to identify the
382
+ # case ID for downloading an attachment from.
383
+ # @return [String]
384
+ #
385
+ # @!attribute [rw] attachment_id
386
+ # Required element for GetCaseAttachmentDownloadUrl to identify the
387
+ # attachment ID for downloading an attachment.
388
+ # @return [String]
389
+ #
390
+ # @see http://docs.aws.amazon.com/goto/WebAPI/security-ir-2018-05-10/GetCaseAttachmentDownloadUrlRequest AWS API Documentation
391
+ #
392
+ class GetCaseAttachmentDownloadUrlRequest < Struct.new(
393
+ :case_id,
394
+ :attachment_id)
395
+ SENSITIVE = []
396
+ include Aws::Structure
397
+ end
398
+
399
+ # @!attribute [rw] attachment_presigned_url
400
+ # Response element providing the Amazon S3 presigned URL to download
401
+ # an attachment.
402
+ # @return [String]
403
+ #
404
+ # @see http://docs.aws.amazon.com/goto/WebAPI/security-ir-2018-05-10/GetCaseAttachmentDownloadUrlResponse AWS API Documentation
405
+ #
406
+ class GetCaseAttachmentDownloadUrlResponse < Struct.new(
407
+ :attachment_presigned_url)
408
+ SENSITIVE = [:attachment_presigned_url]
409
+ include Aws::Structure
410
+ end
411
+
412
+ # @!attribute [rw] case_id
413
+ # Required element for GetCaseAttachmentUploadUrl to identify the case
414
+ # ID for uploading an attachment to.
415
+ # @return [String]
416
+ #
417
+ # @!attribute [rw] file_name
418
+ # Required element for GetCaseAttachmentUploadUrl to identify the file
419
+ # name of the attachment to upload.
420
+ # @return [String]
421
+ #
422
+ # @!attribute [rw] content_length
423
+ # Required element for GetCaseAttachmentUploadUrl to identify the size
424
+ # od the file attachment.
425
+ # @return [Integer]
426
+ #
427
+ # @!attribute [rw] client_token
428
+ # Optional element for customer provided token.
429
+ #
430
+ # **A suitable default value is auto-generated.** You should normally
431
+ # not need to pass this option.
432
+ # @return [String]
433
+ #
434
+ # @see http://docs.aws.amazon.com/goto/WebAPI/security-ir-2018-05-10/GetCaseAttachmentUploadUrlRequest AWS API Documentation
435
+ #
436
+ class GetCaseAttachmentUploadUrlRequest < Struct.new(
437
+ :case_id,
438
+ :file_name,
439
+ :content_length,
440
+ :client_token)
441
+ SENSITIVE = [:file_name]
442
+ include Aws::Structure
443
+ end
444
+
445
+ # @!attribute [rw] attachment_presigned_url
446
+ # Response element providing the Amazon S3 presigned UTL to upload the
447
+ # attachment.
448
+ # @return [String]
449
+ #
450
+ # @see http://docs.aws.amazon.com/goto/WebAPI/security-ir-2018-05-10/GetCaseAttachmentUploadUrlResponse AWS API Documentation
451
+ #
452
+ class GetCaseAttachmentUploadUrlResponse < Struct.new(
453
+ :attachment_presigned_url)
454
+ SENSITIVE = [:attachment_presigned_url]
455
+ include Aws::Structure
456
+ end
457
+
458
+ # @!attribute [rw] case_id
459
+ # Required element for GetCase to identify the requested case ID.
460
+ # @return [String]
461
+ #
462
+ # @see http://docs.aws.amazon.com/goto/WebAPI/security-ir-2018-05-10/GetCaseRequest AWS API Documentation
463
+ #
464
+ class GetCaseRequest < Struct.new(
465
+ :case_id)
466
+ SENSITIVE = []
467
+ include Aws::Structure
468
+ end
469
+
470
+ # @!attribute [rw] title
471
+ # Response element for GetCase that provides the case title.
472
+ # @return [String]
473
+ #
474
+ # @!attribute [rw] case_arn
475
+ # Response element for GetCase that provides the case ARN
476
+ # @return [String]
477
+ #
478
+ # @!attribute [rw] description
479
+ # Response element for GetCase that provides contents of the case
480
+ # description.
481
+ # @return [String]
482
+ #
483
+ # @!attribute [rw] case_status
484
+ # Response element for GetCase that provides the case status. Options
485
+ # for statuses include `Submitted | Detection and Analysis |
486
+ # Eradication, Containment and Recovery | Post-Incident Activities |
487
+ # Closed `
488
+ # @return [String]
489
+ #
490
+ # @!attribute [rw] engagement_type
491
+ # Response element for GetCase that provides the engagement type.
492
+ # Options for engagement type include `Active Security Event |
493
+ # Investigations`
494
+ # @return [String]
495
+ #
496
+ # @!attribute [rw] reported_incident_start_date
497
+ # Response element for GetCase that provides the customer provided
498
+ # incident start date.
499
+ # @return [Time]
500
+ #
501
+ # @!attribute [rw] actual_incident_start_date
502
+ # Response element for GetCase that provides the actual incident start
503
+ # date as identified by data analysis during the investigation.
504
+ # @return [Time]
505
+ #
506
+ # @!attribute [rw] impacted_aws_regions
507
+ # Response element for GetCase that provides the impacted regions.
508
+ # @return [Array<Types::ImpactedAwsRegion>]
509
+ #
510
+ # @!attribute [rw] threat_actor_ip_addresses
511
+ # Response element for GetCase that provides a list of suspicious IP
512
+ # addresses associated with unauthorized activity.
513
+ # @return [Array<Types::ThreatActorIp>]
514
+ #
515
+ # @!attribute [rw] pending_action
516
+ # Response element for GetCase that provides identifies the case is
517
+ # waiting on customer input.
518
+ # @return [String]
519
+ #
520
+ # @!attribute [rw] impacted_accounts
521
+ # Response element for GetCase that provides a list of impacted
522
+ # accounts.
523
+ # @return [Array<String>]
524
+ #
525
+ # @!attribute [rw] watchers
526
+ # Response element for GetCase that provides a list of Watchers added
527
+ # to the case.
528
+ # @return [Array<Types::Watcher>]
529
+ #
530
+ # @!attribute [rw] created_date
531
+ # Response element for GetCase that provides the date the case was
532
+ # created.
533
+ # @return [Time]
534
+ #
535
+ # @!attribute [rw] last_updated_date
536
+ # Response element for GetCase that provides the date a case was last
537
+ # modified.
538
+ # @return [Time]
539
+ #
540
+ # @!attribute [rw] closure_code
541
+ # Response element for GetCase that provides the summary code for why
542
+ # a case was closed.
543
+ # @return [String]
544
+ #
545
+ # @!attribute [rw] resolver_type
546
+ # Response element for GetCase that provides the current resolver
547
+ # types. Options include ` self-supported | AWS-supported`.
548
+ # @return [String]
549
+ #
550
+ # @!attribute [rw] impacted_services
551
+ # Response element for GetCase that provides a list of impacted
552
+ # services.
553
+ # @return [Array<String>]
554
+ #
555
+ # @!attribute [rw] case_attachments
556
+ # Response element for GetCase that provides a list of current case
557
+ # attachments.
558
+ # @return [Array<Types::CaseAttachmentAttributes>]
559
+ #
560
+ # @!attribute [rw] closed_date
561
+ # Response element for GetCase that provides the date a specified case
562
+ # was closed.
563
+ # @return [Time]
564
+ #
565
+ # @see http://docs.aws.amazon.com/goto/WebAPI/security-ir-2018-05-10/GetCaseResponse AWS API Documentation
566
+ #
567
+ class GetCaseResponse < Struct.new(
568
+ :title,
569
+ :case_arn,
570
+ :description,
571
+ :case_status,
572
+ :engagement_type,
573
+ :reported_incident_start_date,
574
+ :actual_incident_start_date,
575
+ :impacted_aws_regions,
576
+ :threat_actor_ip_addresses,
577
+ :pending_action,
578
+ :impacted_accounts,
579
+ :watchers,
580
+ :created_date,
581
+ :last_updated_date,
582
+ :closure_code,
583
+ :resolver_type,
584
+ :impacted_services,
585
+ :case_attachments,
586
+ :closed_date)
587
+ SENSITIVE = [:title, :description]
588
+ include Aws::Structure
589
+ end
590
+
591
+ # @!attribute [rw] account_id
592
+ # @return [String]
593
+ #
594
+ # @!attribute [rw] error
595
+ # @return [String]
596
+ #
597
+ # @!attribute [rw] message
598
+ # @return [String]
599
+ #
600
+ # @see http://docs.aws.amazon.com/goto/WebAPI/security-ir-2018-05-10/GetMembershipAccountDetailError AWS API Documentation
601
+ #
602
+ class GetMembershipAccountDetailError < Struct.new(
603
+ :account_id,
604
+ :error,
605
+ :message)
606
+ SENSITIVE = []
607
+ include Aws::Structure
608
+ end
609
+
610
+ # @!attribute [rw] account_id
611
+ # @return [String]
612
+ #
613
+ # @!attribute [rw] relationship_status
614
+ # @return [String]
615
+ #
616
+ # @!attribute [rw] relationship_type
617
+ # @return [String]
618
+ #
619
+ # @see http://docs.aws.amazon.com/goto/WebAPI/security-ir-2018-05-10/GetMembershipAccountDetailItem AWS API Documentation
620
+ #
621
+ class GetMembershipAccountDetailItem < Struct.new(
622
+ :account_id,
623
+ :relationship_status,
624
+ :relationship_type)
625
+ SENSITIVE = []
626
+ include Aws::Structure
627
+ end
628
+
629
+ # @!attribute [rw] membership_id
630
+ # Required element for GetMembership to identify the membership ID to
631
+ # query.
632
+ # @return [String]
633
+ #
634
+ # @see http://docs.aws.amazon.com/goto/WebAPI/security-ir-2018-05-10/GetMembershipRequest AWS API Documentation
635
+ #
636
+ class GetMembershipRequest < Struct.new(
637
+ :membership_id)
638
+ SENSITIVE = []
639
+ include Aws::Structure
640
+ end
641
+
642
+ # @!attribute [rw] membership_id
643
+ # Response element for GetMembership that provides the queried
644
+ # membership ID.
645
+ # @return [String]
646
+ #
647
+ # @!attribute [rw] account_id
648
+ # Response element for GetMembership that provides the configured
649
+ # account for managing the membership.
650
+ # @return [String]
651
+ #
652
+ # @!attribute [rw] region
653
+ # Response element for GetMembership that provides the configured
654
+ # region for managing the membership.
655
+ # @return [String]
656
+ #
657
+ # @!attribute [rw] membership_name
658
+ # Response element for GetMembership that provides the configured
659
+ # membership name.
660
+ # @return [String]
661
+ #
662
+ # @!attribute [rw] membership_arn
663
+ # Response element for GetMembership that provides the membership ARN.
664
+ # @return [String]
665
+ #
666
+ # @!attribute [rw] membership_status
667
+ # Response element for GetMembership that provides the current
668
+ # membership status.
669
+ # @return [String]
670
+ #
671
+ # @!attribute [rw] membership_activation_timestamp
672
+ # Response element for GetMembership that provides the configured
673
+ # membership activation timestamp.
674
+ # @return [Time]
675
+ #
676
+ # @!attribute [rw] membership_deactivation_timestamp
677
+ # Response element for GetMembership that provides the configured
678
+ # membership name deactivation timestamp.
679
+ # @return [Time]
680
+ #
681
+ # @!attribute [rw] customer_type
682
+ # Response element for GetMembership that provides the configured
683
+ # membership type. Options include ` Standalone | Organizations`.
684
+ # @return [String]
685
+ #
686
+ # @!attribute [rw] number_of_accounts_covered
687
+ # Response element for GetMembership that provides the number of
688
+ # accounts in the membership.
689
+ # @return [Integer]
690
+ #
691
+ # @!attribute [rw] incident_response_team
692
+ # Response element for GetMembership that provides the configured
693
+ # membership incident response team members.
694
+ # @return [Array<Types::IncidentResponder>]
695
+ #
696
+ # @!attribute [rw] opt_in_features
697
+ # Response element for GetMembership that provides the if opt-in
698
+ # features have been enabled.
699
+ # @return [Array<Types::OptInFeature>]
700
+ #
701
+ # @see http://docs.aws.amazon.com/goto/WebAPI/security-ir-2018-05-10/GetMembershipResponse AWS API Documentation
702
+ #
703
+ class GetMembershipResponse < Struct.new(
704
+ :membership_id,
705
+ :account_id,
706
+ :region,
707
+ :membership_name,
708
+ :membership_arn,
709
+ :membership_status,
710
+ :membership_activation_timestamp,
711
+ :membership_deactivation_timestamp,
712
+ :customer_type,
713
+ :number_of_accounts_covered,
714
+ :incident_response_team,
715
+ :opt_in_features)
716
+ SENSITIVE = [:membership_name]
717
+ include Aws::Structure
718
+ end
719
+
720
+ # @!attribute [rw] region
721
+ # @return [String]
722
+ #
723
+ # @see http://docs.aws.amazon.com/goto/WebAPI/security-ir-2018-05-10/ImpactedAwsRegion AWS API Documentation
724
+ #
725
+ class ImpactedAwsRegion < Struct.new(
726
+ :region)
727
+ SENSITIVE = []
728
+ include Aws::Structure
729
+ end
730
+
731
+ # @!attribute [rw] name
732
+ # @return [String]
733
+ #
734
+ # @!attribute [rw] job_title
735
+ # @return [String]
736
+ #
737
+ # @!attribute [rw] email
738
+ # @return [String]
739
+ #
740
+ # @see http://docs.aws.amazon.com/goto/WebAPI/security-ir-2018-05-10/IncidentResponder AWS API Documentation
741
+ #
742
+ class IncidentResponder < Struct.new(
743
+ :name,
744
+ :job_title,
745
+ :email)
746
+ SENSITIVE = [:name, :job_title, :email]
747
+ include Aws::Structure
748
+ end
749
+
750
+ # @!attribute [rw] message
751
+ # @return [String]
752
+ #
753
+ # @!attribute [rw] retry_after_seconds
754
+ # Element providing advice to clients on when the call can be safely
755
+ # retried.
756
+ # @return [Integer]
757
+ #
758
+ # @see http://docs.aws.amazon.com/goto/WebAPI/security-ir-2018-05-10/InternalServerException AWS API Documentation
759
+ #
760
+ class InternalServerException < Struct.new(
761
+ :message,
762
+ :retry_after_seconds)
763
+ SENSITIVE = []
764
+ include Aws::Structure
765
+ end
766
+
767
+ # @!attribute [rw] message
768
+ # @return [String]
769
+ #
770
+ # @see http://docs.aws.amazon.com/goto/WebAPI/security-ir-2018-05-10/InvalidTokenException AWS API Documentation
771
+ #
772
+ class InvalidTokenException < Struct.new(
773
+ :message)
774
+ SENSITIVE = []
775
+ include Aws::Structure
776
+ end
777
+
778
+ # @!attribute [rw] next_token
779
+ # Optional element for a customer provided token.
780
+ # @return [String]
781
+ #
782
+ # @!attribute [rw] max_results
783
+ # Optional element to identify how many results to obtain. There is a
784
+ # maximum value of 25.
785
+ # @return [Integer]
786
+ #
787
+ # @!attribute [rw] case_id
788
+ # Required element used with ListCaseEdits to identify the case to
789
+ # query.
790
+ # @return [String]
791
+ #
792
+ # @see http://docs.aws.amazon.com/goto/WebAPI/security-ir-2018-05-10/ListCaseEditsRequest AWS API Documentation
793
+ #
794
+ class ListCaseEditsRequest < Struct.new(
795
+ :next_token,
796
+ :max_results,
797
+ :case_id)
798
+ SENSITIVE = []
799
+ include Aws::Structure
800
+ end
801
+
802
+ # @!attribute [rw] next_token
803
+ # Optional element.
804
+ # @return [String]
805
+ #
806
+ # @!attribute [rw] items
807
+ # Response element for ListCaseEdits that includes the action,
808
+ # eventtimestamp, message, and principal for the response.
809
+ # @return [Array<Types::CaseEditItem>]
810
+ #
811
+ # @!attribute [rw] total
812
+ # Response element for ListCaseEdits that identifies the total number
813
+ # of edits.
814
+ # @return [Integer]
815
+ #
816
+ # @see http://docs.aws.amazon.com/goto/WebAPI/security-ir-2018-05-10/ListCaseEditsResponse AWS API Documentation
817
+ #
818
+ class ListCaseEditsResponse < Struct.new(
819
+ :next_token,
820
+ :items,
821
+ :total)
822
+ SENSITIVE = []
823
+ include Aws::Structure
824
+ end
825
+
826
+ # @!attribute [rw] case_id
827
+ # @return [String]
828
+ #
829
+ # @!attribute [rw] last_updated_date
830
+ # @return [Time]
831
+ #
832
+ # @!attribute [rw] title
833
+ # @return [String]
834
+ #
835
+ # @!attribute [rw] case_arn
836
+ # @return [String]
837
+ #
838
+ # @!attribute [rw] engagement_type
839
+ # @return [String]
840
+ #
841
+ # @!attribute [rw] case_status
842
+ # @return [String]
843
+ #
844
+ # @!attribute [rw] created_date
845
+ # @return [Time]
846
+ #
847
+ # @!attribute [rw] closed_date
848
+ # @return [Time]
849
+ #
850
+ # @!attribute [rw] resolver_type
851
+ # @return [String]
852
+ #
853
+ # @!attribute [rw] pending_action
854
+ # @return [String]
855
+ #
856
+ # @see http://docs.aws.amazon.com/goto/WebAPI/security-ir-2018-05-10/ListCasesItem AWS API Documentation
857
+ #
858
+ class ListCasesItem < Struct.new(
859
+ :case_id,
860
+ :last_updated_date,
861
+ :title,
862
+ :case_arn,
863
+ :engagement_type,
864
+ :case_status,
865
+ :created_date,
866
+ :closed_date,
867
+ :resolver_type,
868
+ :pending_action)
869
+ SENSITIVE = [:title]
870
+ include Aws::Structure
871
+ end
872
+
873
+ # @!attribute [rw] next_token
874
+ # Optional element.
875
+ # @return [String]
876
+ #
877
+ # @!attribute [rw] max_results
878
+ # Optional element for ListCases to limit the number of responses.
879
+ # @return [Integer]
880
+ #
881
+ # @see http://docs.aws.amazon.com/goto/WebAPI/security-ir-2018-05-10/ListCasesRequest AWS API Documentation
882
+ #
883
+ class ListCasesRequest < Struct.new(
884
+ :next_token,
885
+ :max_results)
886
+ SENSITIVE = []
887
+ include Aws::Structure
888
+ end
889
+
890
+ # @!attribute [rw] next_token
891
+ # Optional element.
892
+ # @return [String]
893
+ #
894
+ # @!attribute [rw] items
895
+ # Response element for ListCases that includes caseARN, caseID,
896
+ # caseStatus, closedDate, createdDate, engagementType,
897
+ # lastUpdatedDate, pendingAction, resolverType, and title for each
898
+ # response.
899
+ # @return [Array<Types::ListCasesItem>]
900
+ #
901
+ # @!attribute [rw] total
902
+ # Response element for ListCases providing the total number of
903
+ # responses.
904
+ # @return [Integer]
905
+ #
906
+ # @see http://docs.aws.amazon.com/goto/WebAPI/security-ir-2018-05-10/ListCasesResponse AWS API Documentation
907
+ #
908
+ class ListCasesResponse < Struct.new(
909
+ :next_token,
910
+ :items,
911
+ :total)
912
+ SENSITIVE = []
913
+ include Aws::Structure
914
+ end
915
+
916
+ # @!attribute [rw] comment_id
917
+ # @return [String]
918
+ #
919
+ # @!attribute [rw] created_date
920
+ # @return [Time]
921
+ #
922
+ # @!attribute [rw] last_updated_date
923
+ # @return [Time]
924
+ #
925
+ # @!attribute [rw] creator
926
+ # @return [String]
927
+ #
928
+ # @!attribute [rw] last_updated_by
929
+ # @return [String]
930
+ #
931
+ # @!attribute [rw] body
932
+ # @return [String]
933
+ #
934
+ # @see http://docs.aws.amazon.com/goto/WebAPI/security-ir-2018-05-10/ListCommentsItem AWS API Documentation
935
+ #
936
+ class ListCommentsItem < Struct.new(
937
+ :comment_id,
938
+ :created_date,
939
+ :last_updated_date,
940
+ :creator,
941
+ :last_updated_by,
942
+ :body)
943
+ SENSITIVE = [:body]
944
+ include Aws::Structure
945
+ end
946
+
947
+ # @!attribute [rw] next_token
948
+ # Optional element.
949
+ # @return [String]
950
+ #
951
+ # @!attribute [rw] max_results
952
+ # Optional element for ListComments to limit the number of responses.
953
+ # @return [Integer]
954
+ #
955
+ # @!attribute [rw] case_id
956
+ # Required element for ListComments to designate the case to query.
957
+ # @return [String]
958
+ #
959
+ # @see http://docs.aws.amazon.com/goto/WebAPI/security-ir-2018-05-10/ListCommentsRequest AWS API Documentation
960
+ #
961
+ class ListCommentsRequest < Struct.new(
962
+ :next_token,
963
+ :max_results,
964
+ :case_id)
965
+ SENSITIVE = []
966
+ include Aws::Structure
967
+ end
968
+
969
+ # @!attribute [rw] next_token
970
+ # Optional request elements.
971
+ # @return [String]
972
+ #
973
+ # @!attribute [rw] items
974
+ # Response element for ListComments providing the body, commentID,
975
+ # createDate, creator, lastUpdatedBy and lastUpdatedDate for each
976
+ # response.
977
+ # @return [Array<Types::ListCommentsItem>]
978
+ #
979
+ # @!attribute [rw] total
980
+ # Response element for ListComments identifying the number of
981
+ # responses.
982
+ # @return [Integer]
983
+ #
984
+ # @see http://docs.aws.amazon.com/goto/WebAPI/security-ir-2018-05-10/ListCommentsResponse AWS API Documentation
985
+ #
986
+ class ListCommentsResponse < Struct.new(
987
+ :next_token,
988
+ :items,
989
+ :total)
990
+ SENSITIVE = []
991
+ include Aws::Structure
992
+ end
993
+
994
+ # @!attribute [rw] membership_id
995
+ # @return [String]
996
+ #
997
+ # @!attribute [rw] account_id
998
+ # @return [String]
999
+ #
1000
+ # @!attribute [rw] region
1001
+ # @return [String]
1002
+ #
1003
+ # @!attribute [rw] membership_arn
1004
+ # @return [String]
1005
+ #
1006
+ # @!attribute [rw] membership_status
1007
+ # @return [String]
1008
+ #
1009
+ # @see http://docs.aws.amazon.com/goto/WebAPI/security-ir-2018-05-10/ListMembershipItem AWS API Documentation
1010
+ #
1011
+ class ListMembershipItem < Struct.new(
1012
+ :membership_id,
1013
+ :account_id,
1014
+ :region,
1015
+ :membership_arn,
1016
+ :membership_status)
1017
+ SENSITIVE = []
1018
+ include Aws::Structure
1019
+ end
1020
+
1021
+ # @!attribute [rw] next_token
1022
+ # Optional element.
1023
+ # @return [String]
1024
+ #
1025
+ # @!attribute [rw] max_results
1026
+ # Request element for ListMemberships to limit the number of
1027
+ # responses.
1028
+ # @return [Integer]
1029
+ #
1030
+ # @see http://docs.aws.amazon.com/goto/WebAPI/security-ir-2018-05-10/ListMembershipsRequest AWS API Documentation
1031
+ #
1032
+ class ListMembershipsRequest < Struct.new(
1033
+ :next_token,
1034
+ :max_results)
1035
+ SENSITIVE = []
1036
+ include Aws::Structure
1037
+ end
1038
+
1039
+ # @!attribute [rw] next_token
1040
+ # Optional element.
1041
+ # @return [String]
1042
+ #
1043
+ # @!attribute [rw] items
1044
+ # Request element for ListMemberships including the accountID,
1045
+ # membershipARN, membershipID, membershipStatus, and region for each
1046
+ # response.
1047
+ # @return [Array<Types::ListMembershipItem>]
1048
+ #
1049
+ # @see http://docs.aws.amazon.com/goto/WebAPI/security-ir-2018-05-10/ListMembershipsResponse AWS API Documentation
1050
+ #
1051
+ class ListMembershipsResponse < Struct.new(
1052
+ :next_token,
1053
+ :items)
1054
+ SENSITIVE = []
1055
+ include Aws::Structure
1056
+ end
1057
+
1058
+ # @!attribute [rw] resource_arn
1059
+ # Required element for ListTagsForResource to provide the ARN to
1060
+ # identify a specific resource.
1061
+ # @return [String]
1062
+ #
1063
+ # @see http://docs.aws.amazon.com/goto/WebAPI/security-ir-2018-05-10/ListTagsForResourceInput AWS API Documentation
1064
+ #
1065
+ class ListTagsForResourceInput < Struct.new(
1066
+ :resource_arn)
1067
+ SENSITIVE = []
1068
+ include Aws::Structure
1069
+ end
1070
+
1071
+ # @!attribute [rw] tags
1072
+ # Response element for ListTagsForResource providing content for each
1073
+ # configured tag.
1074
+ # @return [Hash<String,String>]
1075
+ #
1076
+ # @see http://docs.aws.amazon.com/goto/WebAPI/security-ir-2018-05-10/ListTagsForResourceOutput AWS API Documentation
1077
+ #
1078
+ class ListTagsForResourceOutput < Struct.new(
1079
+ :tags)
1080
+ SENSITIVE = []
1081
+ include Aws::Structure
1082
+ end
1083
+
1084
+ # @!attribute [rw] feature_name
1085
+ # @return [String]
1086
+ #
1087
+ # @!attribute [rw] is_enabled
1088
+ # @return [Boolean]
1089
+ #
1090
+ # @see http://docs.aws.amazon.com/goto/WebAPI/security-ir-2018-05-10/OptInFeature AWS API Documentation
1091
+ #
1092
+ class OptInFeature < Struct.new(
1093
+ :feature_name,
1094
+ :is_enabled)
1095
+ SENSITIVE = []
1096
+ include Aws::Structure
1097
+ end
1098
+
1099
+ # @!attribute [rw] message
1100
+ # @return [String]
1101
+ #
1102
+ # @see http://docs.aws.amazon.com/goto/WebAPI/security-ir-2018-05-10/ResourceNotFoundException AWS API Documentation
1103
+ #
1104
+ class ResourceNotFoundException < Struct.new(
1105
+ :message)
1106
+ SENSITIVE = []
1107
+ include Aws::Structure
1108
+ end
1109
+
1110
+ # @!attribute [rw] message
1111
+ # @return [String]
1112
+ #
1113
+ # @see http://docs.aws.amazon.com/goto/WebAPI/security-ir-2018-05-10/SecurityIncidentResponseNotActiveException AWS API Documentation
1114
+ #
1115
+ class SecurityIncidentResponseNotActiveException < Struct.new(
1116
+ :message)
1117
+ SENSITIVE = []
1118
+ include Aws::Structure
1119
+ end
1120
+
1121
+ # @!attribute [rw] message
1122
+ # @return [String]
1123
+ #
1124
+ # @!attribute [rw] resource_id
1125
+ # Element that provides the ID of the resource affected.
1126
+ # @return [String]
1127
+ #
1128
+ # @!attribute [rw] resource_type
1129
+ # Element that provides the type of the resource affected.
1130
+ # @return [String]
1131
+ #
1132
+ # @!attribute [rw] service_code
1133
+ # Element that provides the originating service who made the call.
1134
+ # @return [String]
1135
+ #
1136
+ # @!attribute [rw] quota_code
1137
+ # Element that provides the quota that was exceeded.
1138
+ # @return [String]
1139
+ #
1140
+ # @see http://docs.aws.amazon.com/goto/WebAPI/security-ir-2018-05-10/ServiceQuotaExceededException AWS API Documentation
1141
+ #
1142
+ class ServiceQuotaExceededException < Struct.new(
1143
+ :message,
1144
+ :resource_id,
1145
+ :resource_type,
1146
+ :service_code,
1147
+ :quota_code)
1148
+ SENSITIVE = []
1149
+ include Aws::Structure
1150
+ end
1151
+
1152
+ # @!attribute [rw] resource_arn
1153
+ # Required element for TagResource to identify the ARN for the
1154
+ # resource to add a tag to.
1155
+ # @return [String]
1156
+ #
1157
+ # @!attribute [rw] tags
1158
+ # Required element for ListTagsForResource to provide the content for
1159
+ # a tag.
1160
+ # @return [Hash<String,String>]
1161
+ #
1162
+ # @see http://docs.aws.amazon.com/goto/WebAPI/security-ir-2018-05-10/TagResourceInput AWS API Documentation
1163
+ #
1164
+ class TagResourceInput < Struct.new(
1165
+ :resource_arn,
1166
+ :tags)
1167
+ SENSITIVE = []
1168
+ include Aws::Structure
1169
+ end
1170
+
1171
+ # @see http://docs.aws.amazon.com/goto/WebAPI/security-ir-2018-05-10/TagResourceOutput AWS API Documentation
1172
+ #
1173
+ class TagResourceOutput < Aws::EmptyStructure; end
1174
+
1175
+ # @!attribute [rw] ip_address
1176
+ # @return [String]
1177
+ #
1178
+ # @!attribute [rw] user_agent
1179
+ # @return [String]
1180
+ #
1181
+ # @see http://docs.aws.amazon.com/goto/WebAPI/security-ir-2018-05-10/ThreatActorIp AWS API Documentation
1182
+ #
1183
+ class ThreatActorIp < Struct.new(
1184
+ :ip_address,
1185
+ :user_agent)
1186
+ SENSITIVE = [:ip_address]
1187
+ include Aws::Structure
1188
+ end
1189
+
1190
+ # @!attribute [rw] message
1191
+ # @return [String]
1192
+ #
1193
+ # @!attribute [rw] service_code
1194
+ # Element providing the service code of the originating service.
1195
+ # @return [String]
1196
+ #
1197
+ # @!attribute [rw] quota_code
1198
+ # Element providing the quota of the originating service.
1199
+ # @return [String]
1200
+ #
1201
+ # @!attribute [rw] retry_after_seconds
1202
+ # Element providing advice to clients on when the call can be safely
1203
+ # retried.
1204
+ # @return [Integer]
1205
+ #
1206
+ # @see http://docs.aws.amazon.com/goto/WebAPI/security-ir-2018-05-10/ThrottlingException AWS API Documentation
1207
+ #
1208
+ class ThrottlingException < Struct.new(
1209
+ :message,
1210
+ :service_code,
1211
+ :quota_code,
1212
+ :retry_after_seconds)
1213
+ SENSITIVE = []
1214
+ include Aws::Structure
1215
+ end
1216
+
1217
+ # @!attribute [rw] resource_arn
1218
+ # Required element for UnTagResource to identify the ARN for the
1219
+ # resource to remove a tag from.
1220
+ # @return [String]
1221
+ #
1222
+ # @!attribute [rw] tag_keys
1223
+ # Required element for UnTagResource to identify tag to remove.
1224
+ # @return [Array<String>]
1225
+ #
1226
+ # @see http://docs.aws.amazon.com/goto/WebAPI/security-ir-2018-05-10/UntagResourceInput AWS API Documentation
1227
+ #
1228
+ class UntagResourceInput < Struct.new(
1229
+ :resource_arn,
1230
+ :tag_keys)
1231
+ SENSITIVE = []
1232
+ include Aws::Structure
1233
+ end
1234
+
1235
+ # @see http://docs.aws.amazon.com/goto/WebAPI/security-ir-2018-05-10/UntagResourceOutput AWS API Documentation
1236
+ #
1237
+ class UntagResourceOutput < Aws::EmptyStructure; end
1238
+
1239
+ # @!attribute [rw] case_id
1240
+ # Required element for UpdateCaseComment to identify the case ID
1241
+ # containing the comment to be updated.
1242
+ # @return [String]
1243
+ #
1244
+ # @!attribute [rw] comment_id
1245
+ # Required element for UpdateCaseComment to identify the case ID to be
1246
+ # updated.
1247
+ # @return [String]
1248
+ #
1249
+ # @!attribute [rw] body
1250
+ # Required element for UpdateCaseComment to identify the content for
1251
+ # the comment to be updated.
1252
+ # @return [String]
1253
+ #
1254
+ # @see http://docs.aws.amazon.com/goto/WebAPI/security-ir-2018-05-10/UpdateCaseCommentRequest AWS API Documentation
1255
+ #
1256
+ class UpdateCaseCommentRequest < Struct.new(
1257
+ :case_id,
1258
+ :comment_id,
1259
+ :body)
1260
+ SENSITIVE = [:body]
1261
+ include Aws::Structure
1262
+ end
1263
+
1264
+ # @!attribute [rw] comment_id
1265
+ # Response element for UpdateCaseComment providing the updated comment
1266
+ # ID.
1267
+ # @return [String]
1268
+ #
1269
+ # @!attribute [rw] body
1270
+ # Response element for UpdateCaseComment providing the updated comment
1271
+ # content.
1272
+ # @return [String]
1273
+ #
1274
+ # @see http://docs.aws.amazon.com/goto/WebAPI/security-ir-2018-05-10/UpdateCaseCommentResponse AWS API Documentation
1275
+ #
1276
+ class UpdateCaseCommentResponse < Struct.new(
1277
+ :comment_id,
1278
+ :body)
1279
+ SENSITIVE = [:body]
1280
+ include Aws::Structure
1281
+ end
1282
+
1283
+ # @!attribute [rw] case_id
1284
+ # Required element for UpdateCase to identify the case ID for updates.
1285
+ # @return [String]
1286
+ #
1287
+ # @!attribute [rw] title
1288
+ # Optional element for UpdateCase to provide content for the title
1289
+ # field.
1290
+ # @return [String]
1291
+ #
1292
+ # @!attribute [rw] description
1293
+ # Optional element for UpdateCase to provide content for the
1294
+ # description field.
1295
+ # @return [String]
1296
+ #
1297
+ # @!attribute [rw] reported_incident_start_date
1298
+ # Optional element for UpdateCase to provide content for the customer
1299
+ # reported incident start date field.
1300
+ # @return [Time]
1301
+ #
1302
+ # @!attribute [rw] actual_incident_start_date
1303
+ # Optional element for UpdateCase to provide content for the incident
1304
+ # start date field.
1305
+ # @return [Time]
1306
+ #
1307
+ # @!attribute [rw] engagement_type
1308
+ # Optional element for UpdateCase to provide content for the
1309
+ # engagement type field. `Available engagement types include Security
1310
+ # Incident | Investigation`.
1311
+ # @return [String]
1312
+ #
1313
+ # @!attribute [rw] watchers_to_add
1314
+ # Optional element for UpdateCase to provide content to add additional
1315
+ # watchers to a case.
1316
+ # @return [Array<Types::Watcher>]
1317
+ #
1318
+ # @!attribute [rw] watchers_to_delete
1319
+ # Optional element for UpdateCase to provide content to remove
1320
+ # existing watchers from a case.
1321
+ # @return [Array<Types::Watcher>]
1322
+ #
1323
+ # @!attribute [rw] threat_actor_ip_addresses_to_add
1324
+ # Optional element for UpdateCase to provide content to add additional
1325
+ # suspicious IP addresses related to a case.
1326
+ # @return [Array<Types::ThreatActorIp>]
1327
+ #
1328
+ # @!attribute [rw] threat_actor_ip_addresses_to_delete
1329
+ # Optional element for UpdateCase to provide content to remove
1330
+ # suspicious IP addresses from a case.
1331
+ # @return [Array<Types::ThreatActorIp>]
1332
+ #
1333
+ # @!attribute [rw] impacted_services_to_add
1334
+ # Optional element for UpdateCase to provide content to add services
1335
+ # impacted.
1336
+ # @return [Array<String>]
1337
+ #
1338
+ # @!attribute [rw] impacted_services_to_delete
1339
+ # Optional element for UpdateCase to provide content to remove
1340
+ # services impacted.
1341
+ # @return [Array<String>]
1342
+ #
1343
+ # @!attribute [rw] impacted_aws_regions_to_add
1344
+ # Optional element for UpdateCase to provide content to add regions
1345
+ # impacted.
1346
+ # @return [Array<Types::ImpactedAwsRegion>]
1347
+ #
1348
+ # @!attribute [rw] impacted_aws_regions_to_delete
1349
+ # Optional element for UpdateCase to provide content to remove regions
1350
+ # impacted.
1351
+ # @return [Array<Types::ImpactedAwsRegion>]
1352
+ #
1353
+ # @!attribute [rw] impacted_accounts_to_add
1354
+ # Optional element for UpdateCase to provide content to add accounts
1355
+ # impacted.
1356
+ # @return [Array<String>]
1357
+ #
1358
+ # @!attribute [rw] impacted_accounts_to_delete
1359
+ # Optional element for UpdateCase to provide content to add accounts
1360
+ # impacted.
1361
+ # @return [Array<String>]
1362
+ #
1363
+ # @see http://docs.aws.amazon.com/goto/WebAPI/security-ir-2018-05-10/UpdateCaseRequest AWS API Documentation
1364
+ #
1365
+ class UpdateCaseRequest < Struct.new(
1366
+ :case_id,
1367
+ :title,
1368
+ :description,
1369
+ :reported_incident_start_date,
1370
+ :actual_incident_start_date,
1371
+ :engagement_type,
1372
+ :watchers_to_add,
1373
+ :watchers_to_delete,
1374
+ :threat_actor_ip_addresses_to_add,
1375
+ :threat_actor_ip_addresses_to_delete,
1376
+ :impacted_services_to_add,
1377
+ :impacted_services_to_delete,
1378
+ :impacted_aws_regions_to_add,
1379
+ :impacted_aws_regions_to_delete,
1380
+ :impacted_accounts_to_add,
1381
+ :impacted_accounts_to_delete)
1382
+ SENSITIVE = [:title, :description]
1383
+ include Aws::Structure
1384
+ end
1385
+
1386
+ # @see http://docs.aws.amazon.com/goto/WebAPI/security-ir-2018-05-10/UpdateCaseResponse AWS API Documentation
1387
+ #
1388
+ class UpdateCaseResponse < Aws::EmptyStructure; end
1389
+
1390
+ # @!attribute [rw] case_id
1391
+ # Required element for UpdateCaseStatus to identify the case to
1392
+ # update.
1393
+ # @return [String]
1394
+ #
1395
+ # @!attribute [rw] case_status
1396
+ # Required element for UpdateCaseStatus to identify the status for a
1397
+ # case. Options include `Submitted | Detection and Analysis |
1398
+ # Containment, Eradication and Recovery | Post-incident Activities`.
1399
+ # @return [String]
1400
+ #
1401
+ # @see http://docs.aws.amazon.com/goto/WebAPI/security-ir-2018-05-10/UpdateCaseStatusRequest AWS API Documentation
1402
+ #
1403
+ class UpdateCaseStatusRequest < Struct.new(
1404
+ :case_id,
1405
+ :case_status)
1406
+ SENSITIVE = []
1407
+ include Aws::Structure
1408
+ end
1409
+
1410
+ # @!attribute [rw] case_status
1411
+ # Response element for UpdateCaseStatus showing the newly configured
1412
+ # status.
1413
+ # @return [String]
1414
+ #
1415
+ # @see http://docs.aws.amazon.com/goto/WebAPI/security-ir-2018-05-10/UpdateCaseStatusResponse AWS API Documentation
1416
+ #
1417
+ class UpdateCaseStatusResponse < Struct.new(
1418
+ :case_status)
1419
+ SENSITIVE = []
1420
+ include Aws::Structure
1421
+ end
1422
+
1423
+ # @!attribute [rw] membership_id
1424
+ # Required element for UpdateMembership to identify the membership to
1425
+ # update.
1426
+ # @return [String]
1427
+ #
1428
+ # @!attribute [rw] membership_name
1429
+ # Optional element for UpdateMembership to update the membership name.
1430
+ # @return [String]
1431
+ #
1432
+ # @!attribute [rw] incident_response_team
1433
+ # Optional element for UpdateMembership to update the membership name.
1434
+ # @return [Array<Types::IncidentResponder>]
1435
+ #
1436
+ # @!attribute [rw] opt_in_features
1437
+ # Optional element for UpdateMembership to enable or disable opt-in
1438
+ # features for the service.
1439
+ # @return [Array<Types::OptInFeature>]
1440
+ #
1441
+ # @see http://docs.aws.amazon.com/goto/WebAPI/security-ir-2018-05-10/UpdateMembershipRequest AWS API Documentation
1442
+ #
1443
+ class UpdateMembershipRequest < Struct.new(
1444
+ :membership_id,
1445
+ :membership_name,
1446
+ :incident_response_team,
1447
+ :opt_in_features)
1448
+ SENSITIVE = [:membership_name]
1449
+ include Aws::Structure
1450
+ end
1451
+
1452
+ # @see http://docs.aws.amazon.com/goto/WebAPI/security-ir-2018-05-10/UpdateMembershipResponse AWS API Documentation
1453
+ #
1454
+ class UpdateMembershipResponse < Aws::EmptyStructure; end
1455
+
1456
+ # @!attribute [rw] case_id
1457
+ # Required element for UpdateResolverType to identify the case to
1458
+ # update.
1459
+ # @return [String]
1460
+ #
1461
+ # @!attribute [rw] resolver_type
1462
+ # Required element for UpdateResolverType to identify the new
1463
+ # resolver.
1464
+ # @return [String]
1465
+ #
1466
+ # @see http://docs.aws.amazon.com/goto/WebAPI/security-ir-2018-05-10/UpdateResolverTypeRequest AWS API Documentation
1467
+ #
1468
+ class UpdateResolverTypeRequest < Struct.new(
1469
+ :case_id,
1470
+ :resolver_type)
1471
+ SENSITIVE = []
1472
+ include Aws::Structure
1473
+ end
1474
+
1475
+ # @!attribute [rw] case_id
1476
+ # Response element for UpdateResolver identifying the case ID being
1477
+ # updated.
1478
+ # @return [String]
1479
+ #
1480
+ # @!attribute [rw] case_status
1481
+ # Response element for UpdateResolver identifying the current status
1482
+ # of the case.
1483
+ # @return [String]
1484
+ #
1485
+ # @!attribute [rw] resolver_type
1486
+ # Response element for UpdateResolver identifying the current resolver
1487
+ # of the case.
1488
+ # @return [String]
1489
+ #
1490
+ # @see http://docs.aws.amazon.com/goto/WebAPI/security-ir-2018-05-10/UpdateResolverTypeResponse AWS API Documentation
1491
+ #
1492
+ class UpdateResolverTypeResponse < Struct.new(
1493
+ :case_id,
1494
+ :case_status,
1495
+ :resolver_type)
1496
+ SENSITIVE = []
1497
+ include Aws::Structure
1498
+ end
1499
+
1500
+ # @!attribute [rw] message
1501
+ # @return [String]
1502
+ #
1503
+ # @!attribute [rw] reason
1504
+ # Element that provides the reason the request failed validation.
1505
+ # @return [String]
1506
+ #
1507
+ # @!attribute [rw] field_list
1508
+ # Element that provides the list of field(s) that caused the error, if
1509
+ # applicable.
1510
+ # @return [Array<Types::ValidationExceptionField>]
1511
+ #
1512
+ # @see http://docs.aws.amazon.com/goto/WebAPI/security-ir-2018-05-10/ValidationException AWS API Documentation
1513
+ #
1514
+ class ValidationException < Struct.new(
1515
+ :message,
1516
+ :reason,
1517
+ :field_list)
1518
+ SENSITIVE = []
1519
+ include Aws::Structure
1520
+ end
1521
+
1522
+ # @!attribute [rw] name
1523
+ # @return [String]
1524
+ #
1525
+ # @!attribute [rw] message
1526
+ # @return [String]
1527
+ #
1528
+ # @see http://docs.aws.amazon.com/goto/WebAPI/security-ir-2018-05-10/ValidationExceptionField AWS API Documentation
1529
+ #
1530
+ class ValidationExceptionField < Struct.new(
1531
+ :name,
1532
+ :message)
1533
+ SENSITIVE = []
1534
+ include Aws::Structure
1535
+ end
1536
+
1537
+ # @!attribute [rw] email
1538
+ # @return [String]
1539
+ #
1540
+ # @!attribute [rw] name
1541
+ # @return [String]
1542
+ #
1543
+ # @!attribute [rw] job_title
1544
+ # @return [String]
1545
+ #
1546
+ # @see http://docs.aws.amazon.com/goto/WebAPI/security-ir-2018-05-10/Watcher AWS API Documentation
1547
+ #
1548
+ class Watcher < Struct.new(
1549
+ :email,
1550
+ :name,
1551
+ :job_title)
1552
+ SENSITIVE = [:email, :name, :job_title]
1553
+ include Aws::Structure
1554
+ end
1555
+
1556
+ end
1557
+ end
1558
+