File: types.go

package info (click to toggle)
golang-github-aws-aws-sdk-go-v2 1.30.3-1
  • links: PTS, VCS
  • area: main
  • in suites: forky, sid, trixie
  • size: 662,428 kB
  • sloc: java: 16,875; makefile: 432; sh: 175
file content (725 lines) | stat: -rw-r--r-- 28,104 bytes parent folder | download | duplicates (3)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
// Code generated by smithy-go-codegen DO NOT EDIT.

package types

import (
	smithydocument "github.com/aws/smithy-go/document"
	"time"
)

// The number of entities in an account that are impacted by a specific event
// aggregated by the entity status codes.
type AccountEntityAggregate struct {

	// The 12-digit Amazon Web Services account numbers that contains the affected
	// entities.
	AccountId *string

	// The number of entities that match the filter criteria for the specified events.
	Count int32

	// The number of affected entities aggregated by the entity status codes.
	Statuses map[string]int32

	noSmithyDocumentSerde
}

// Information about an entity that is affected by a Health event.
type AffectedEntity struct {

	// The 12-digit Amazon Web Services account number that contains the affected
	// entity.
	AwsAccountId *string

	// The unique identifier for the entity. Format:
	// arn:aws:health:entity-region:aws-account:entity/entity-id . Example:
	// arn:aws:health:us-east-1:111222333444:entity/AVh5GGT7ul1arKr1sE1K
	EntityArn *string

	// The URL of the affected entity.
	EntityUrl *string

	// The ID of the affected entity.
	EntityValue *string

	// The unique identifier for the event. The event ARN has the
	// arn:aws:health:event-region::event/SERVICE/EVENT_TYPE_CODE/EVENT_TYPE_PLUS_ID
	// format.
	//
	// For example, an event ARN might look like the following:
	//
	//     arn:aws:health:us-east-1::event/EC2/EC2_INSTANCE_RETIREMENT_SCHEDULED/EC2_INSTANCE_RETIREMENT_SCHEDULED_ABC123-DEF456
	EventArn *string

	// The most recent time that the entity was updated.
	LastUpdatedTime *time.Time

	// The most recent status of the entity affected by the event. The possible values
	// are IMPAIRED , UNIMPAIRED , and UNKNOWN .
	StatusCode EntityStatusCode

	// A map of entity tags attached to the affected entity.
	//
	// Currently, the tags property isn't supported.
	Tags map[string]string

	noSmithyDocumentSerde
}

// A range of dates and times that is used by the [EventFilter] and [EntityFilter] objects. If from is set
// and to is set: match items where the timestamp ( startTime , endTime , or
// lastUpdatedTime ) is between from and to inclusive. If from is set and to is
// not set: match items where the timestamp value is equal to or after from . If
// from is not set and to is set: match items where the timestamp value is equal
// to or before to .
//
// [EntityFilter]: https://docs.aws.amazon.com/health/latest/APIReference/API_EntityFilter.html
// [EventFilter]: https://docs.aws.amazon.com/health/latest/APIReference/API_EventFilter.html
type DateTimeRange struct {

	// The starting date and time of a time range.
	From *time.Time

	// The ending date and time of a time range.
	To *time.Time

	noSmithyDocumentSerde
}

// A JSON set of elements including the awsAccountId , eventArn and a set of
// statusCodes .
type EntityAccountFilter struct {

	// The unique identifier for the event. The event ARN has the
	// arn:aws:health:event-region::event/SERVICE/EVENT_TYPE_CODE/EVENT_TYPE_PLUS_ID
	// format.
	//
	// For example, an event ARN might look like the following:
	//
	//     arn:aws:health:us-east-1::event/EC2/EC2_INSTANCE_RETIREMENT_SCHEDULED/EC2_INSTANCE_RETIREMENT_SCHEDULED_ABC123-DEF456
	//
	// This member is required.
	EventArn *string

	// The 12-digit Amazon Web Services account numbers that contains the affected
	// entities.
	AwsAccountId *string

	// A list of entity status codes.
	StatusCodes []EntityStatusCode

	noSmithyDocumentSerde
}

// The number of entities that are affected by one or more events. Returned by the [DescribeEntityAggregates]
// operation.
//
// [DescribeEntityAggregates]: https://docs.aws.amazon.com/health/latest/APIReference/API_DescribeEntityAggregates.html
type EntityAggregate struct {

	// The number of entities that match the criteria for the specified events.
	Count int32

	// The unique identifier for the event. The event ARN has the
	// arn:aws:health:event-region::event/SERVICE/EVENT_TYPE_CODE/EVENT_TYPE_PLUS_ID
	// format.
	//
	// For example, an event ARN might look like the following:
	//
	//     arn:aws:health:us-east-1::event/EC2/EC2_INSTANCE_RETIREMENT_SCHEDULED/EC2_INSTANCE_RETIREMENT_SCHEDULED_ABC123-DEF456
	EventArn *string

	// The number of affected entities aggregated by the entity status codes.
	Statuses map[string]int32

	noSmithyDocumentSerde
}

// The values to use to filter results from the [DescribeAffectedEntities] operation.
//
// [DescribeAffectedEntities]: https://docs.aws.amazon.com/health/latest/APIReference/API_DescribeAffectedEntities.html
type EntityFilter struct {

	// A list of event ARNs (unique identifiers). For example:
	// "arn:aws:health:us-east-1::event/EC2/EC2_INSTANCE_RETIREMENT_SCHEDULED/EC2_INSTANCE_RETIREMENT_SCHEDULED_ABC123-CDE456",
	// "arn:aws:health:us-west-1::event/EBS/AWS_EBS_LOST_VOLUME/AWS_EBS_LOST_VOLUME_CHI789_JKL101"
	//
	// This member is required.
	EventArns []string

	// A list of entity ARNs (unique identifiers).
	EntityArns []string

	// A list of IDs for affected entities.
	EntityValues []string

	// A list of the most recent dates and times that the entity was updated.
	LastUpdatedTimes []DateTimeRange

	// A list of entity status codes ( IMPAIRED , UNIMPAIRED , or UNKNOWN ).
	StatusCodes []EntityStatusCode

	// A map of entity tags attached to the affected entity.
	//
	// Currently, the tags property isn't supported.
	Tags []map[string]string

	noSmithyDocumentSerde
}

// Summary information about an Health event.
//
// Health events can be public or account-specific:
//
//   - Public events might be service events that are not specific to an Amazon
//     Web Services account. For example, if there is an issue with an Amazon Web
//     Services Region, Health provides information about the event, even if you don't
//     use services or resources in that Region.
//
//   - Account-specific events are specific to either your Amazon Web Services
//     account or an account in your organization. For example, if there's an issue
//     with Amazon Elastic Compute Cloud in a Region that you use, Health provides
//     information about the event and the affected resources in the account.
//
// You can determine if an event is public or account-specific by using the
// eventScopeCode parameter. For more information, see [eventScopeCode].
//
// [eventScopeCode]: https://docs.aws.amazon.com/health/latest/APIReference/API_Event.html#AWSHealth-Type-Event-eventScopeCode
type Event struct {

	// The unique identifier for the event. The event ARN has the
	// arn:aws:health:event-region::event/SERVICE/EVENT_TYPE_CODE/EVENT_TYPE_PLUS_ID
	// format.
	//
	// For example, an event ARN might look like the following:
	//
	//     arn:aws:health:us-east-1::event/EC2/EC2_INSTANCE_RETIREMENT_SCHEDULED/EC2_INSTANCE_RETIREMENT_SCHEDULED_ABC123-DEF456
	Arn *string

	// The Amazon Web Services Availability Zone of the event. For example, us-east-1a.
	AvailabilityZone *string

	// The date and time that the event ended.
	EndTime *time.Time

	// This parameter specifies if the Health event is a public Amazon Web Service
	// event or an account-specific event.
	//
	//   - If the eventScopeCode value is PUBLIC , then the affectedAccounts value is
	//   always empty.
	//
	//   - If the eventScopeCode value is ACCOUNT_SPECIFIC , then the affectedAccounts
	//   value lists the affected Amazon Web Services accounts in your organization. For
	//   example, if an event affects a service such as Amazon Elastic Compute Cloud and
	//   you have Amazon Web Services accounts that use that service, those account IDs
	//   appear in the response.
	//
	//   - If the eventScopeCode value is NONE , then the eventArn that you specified
	//   in the request is invalid or doesn't exist.
	EventScopeCode EventScopeCode

	// A list of event type category codes. Possible values are issue ,
	// accountNotification , or scheduledChange . Currently, the investigation value
	// isn't supported at this time.
	EventTypeCategory EventTypeCategory

	// The unique identifier for the event type. The format is AWS_SERVICE_DESCRIPTION
	// ; for example, AWS_EC2_SYSTEM_MAINTENANCE_EVENT .
	EventTypeCode *string

	// The most recent date and time that the event was updated.
	LastUpdatedTime *time.Time

	// The Amazon Web Services Region name of the event.
	Region *string

	// The Amazon Web Service that is affected by the event. For example, EC2 , RDS .
	Service *string

	// The date and time that the event began.
	StartTime *time.Time

	// The most recent status of the event. Possible values are open , closed , and
	// upcoming .
	StatusCode EventStatusCode

	noSmithyDocumentSerde
}

// The values used to filter results from the [DescribeEventDetailsForOrganization] and [DescribeAffectedEntitiesForOrganization] operations.
//
// [DescribeEventDetailsForOrganization]: https://docs.aws.amazon.com/health/latest/APIReference/API_DescribeEventDetailsForOrganization.html
// [DescribeAffectedEntitiesForOrganization]: https://docs.aws.amazon.com/health/latest/APIReference/API_DescribeAffectedEntitiesForOrganization.html
type EventAccountFilter struct {

	// The unique identifier for the event. The event ARN has the
	// arn:aws:health:event-region::event/SERVICE/EVENT_TYPE_CODE/EVENT_TYPE_PLUS_ID
	// format.
	//
	// For example, an event ARN might look like the following:
	//
	//     arn:aws:health:us-east-1::event/EC2/EC2_INSTANCE_RETIREMENT_SCHEDULED/EC2_INSTANCE_RETIREMENT_SCHEDULED_ABC123-DEF456
	//
	// This member is required.
	EventArn *string

	// The 12-digit Amazon Web Services account numbers that contains the affected
	// entities.
	AwsAccountId *string

	noSmithyDocumentSerde
}

// The number of events of each issue type. Returned by the [DescribeEventAggregates] operation.
//
// [DescribeEventAggregates]: https://docs.aws.amazon.com/health/latest/APIReference/API_DescribeEventAggregates.html
type EventAggregate struct {

	// The issue type for the associated count.
	AggregateValue *string

	// The number of events of the associated issue type.
	Count int32

	noSmithyDocumentSerde
}

// The detailed description of the event. Included in the information returned by
// the [DescribeEventDetails]operation.
//
// [DescribeEventDetails]: https://docs.aws.amazon.com/health/latest/APIReference/API_DescribeEventDetails.html
type EventDescription struct {

	// The most recent description of the event.
	LatestDescription *string

	noSmithyDocumentSerde
}

// Detailed information about an event. A combination of an [Event] object, an [EventDescription] object,
// and additional metadata about the event. Returned by the [DescribeEventDetails]operation.
//
// [DescribeEventDetails]: https://docs.aws.amazon.com/health/latest/APIReference/API_DescribeEventDetails.html
// [Event]: https://docs.aws.amazon.com/health/latest/APIReference/API_Event.html
// [EventDescription]: https://docs.aws.amazon.com/health/latest/APIReference/API_EventDescription.html
type EventDetails struct {

	// Summary information about the event.
	Event *Event

	// The most recent description of the event.
	EventDescription *EventDescription

	// Additional metadata about the event.
	EventMetadata map[string]string

	noSmithyDocumentSerde
}

// Error information returned when a [DescribeEventDetails] operation can't find a specified event.
//
// [DescribeEventDetails]: https://docs.aws.amazon.com/health/latest/APIReference/API_DescribeEventDetails.html
type EventDetailsErrorItem struct {

	// A message that describes the error.
	ErrorMessage *string

	// The name of the error.
	ErrorName *string

	// The unique identifier for the event. The event ARN has the
	// arn:aws:health:event-region::event/SERVICE/EVENT_TYPE_CODE/EVENT_TYPE_PLUS_ID
	// format.
	//
	// For example, an event ARN might look like the following:
	//
	//     arn:aws:health:us-east-1::event/EC2/EC2_INSTANCE_RETIREMENT_SCHEDULED/EC2_INSTANCE_RETIREMENT_SCHEDULED_ABC123-DEF456
	EventArn *string

	noSmithyDocumentSerde
}

// The values to use to filter results from the [DescribeEvents] and [DescribeEventAggregates] operations.
//
// [DescribeEvents]: https://docs.aws.amazon.com/health/latest/APIReference/API_DescribeEvents.html
// [DescribeEventAggregates]: https://docs.aws.amazon.com/health/latest/APIReference/API_DescribeEventAggregates.html
type EventFilter struct {

	// A list of Amazon Web Services Availability Zones.
	AvailabilityZones []string

	// A list of dates and times that the event ended.
	EndTimes []DateTimeRange

	// A list of entity ARNs (unique identifiers).
	EntityArns []string

	// A list of entity identifiers, such as EC2 instance IDs ( i-34ab692e ) or EBS
	// volumes ( vol-426ab23e ).
	EntityValues []string

	// A list of event ARNs (unique identifiers). For example:
	// "arn:aws:health:us-east-1::event/EC2/EC2_INSTANCE_RETIREMENT_SCHEDULED/EC2_INSTANCE_RETIREMENT_SCHEDULED_ABC123-CDE456",
	// "arn:aws:health:us-west-1::event/EBS/AWS_EBS_LOST_VOLUME/AWS_EBS_LOST_VOLUME_CHI789_JKL101"
	EventArns []string

	// A list of event status codes.
	EventStatusCodes []EventStatusCode

	// A list of event type category codes. Possible values are issue ,
	// accountNotification , or scheduledChange . Currently, the investigation value
	// isn't supported at this time.
	EventTypeCategories []EventTypeCategory

	// A list of unique identifiers for event types. For example,
	// "AWS_EC2_SYSTEM_MAINTENANCE_EVENT","AWS_RDS_MAINTENANCE_SCHEDULED".
	EventTypeCodes []string

	// A list of dates and times that the event was last updated.
	LastUpdatedTimes []DateTimeRange

	// A list of Amazon Web Services Regions.
	Regions []string

	// The Amazon Web Services associated with the event. For example, EC2 , RDS .
	Services []string

	// A list of dates and times that the event began.
	StartTimes []DateTimeRange

	// A map of entity tags attached to the affected entity.
	//
	// Currently, the tags property isn't supported.
	Tags []map[string]string

	noSmithyDocumentSerde
}

// Contains the metadata about a type of event that is reported by Health. The
// EventType shows the category, service, and the event type code of the event. For
// example, an issue might be the category, EC2 the service, and
// AWS_EC2_SYSTEM_MAINTENANCE_EVENT the event type code.
//
// You can use the [DescribeEventTypes] API operation to return this information about an event.
//
// You can also use the Amazon CloudWatch Events console to create a rule so that
// you can get notified or take action when Health delivers a specific event to
// your Amazon Web Services account. For more information, see [Monitor for Health events with Amazon CloudWatch Events]in the Health User
// Guide.
//
// [Monitor for Health events with Amazon CloudWatch Events]: https://docs.aws.amazon.com/health/latest/ug/cloudwatch-events-health.html
// [DescribeEventTypes]: https://docs.aws.amazon.com/health/latest/APIReference/API_DescribeEventTypes.html
type EventType struct {

	// A list of event type category codes. Possible values are issue ,
	// accountNotification , or scheduledChange . Currently, the investigation value
	// isn't supported at this time.
	Category EventTypeCategory

	// The unique identifier for the event type. The format is AWS_SERVICE_DESCRIPTION
	// ; for example, AWS_EC2_SYSTEM_MAINTENANCE_EVENT .
	Code *string

	// The Amazon Web Service that is affected by the event. For example, EC2 , RDS .
	Service *string

	noSmithyDocumentSerde
}

// The values to use to filter results from the [DescribeEventTypes] operation.
//
// [DescribeEventTypes]: https://docs.aws.amazon.com/health/latest/APIReference/API_DescribeEventTypes.html
type EventTypeFilter struct {

	// A list of event type category codes. Possible values are issue ,
	// accountNotification , or scheduledChange . Currently, the investigation value
	// isn't supported at this time.
	EventTypeCategories []EventTypeCategory

	// A list of event type codes.
	EventTypeCodes []string

	// The Amazon Web Services associated with the event. For example, EC2 , RDS .
	Services []string

	noSmithyDocumentSerde
}

// Error information returned when a [DescribeAffectedEntitiesForOrganization] operation can't find or process a specific
// entity.
//
// [DescribeAffectedEntitiesForOrganization]: https://docs.aws.amazon.com/health/latest/APIReference/API_DescribeAffectedEntitiesForOrganization.html
type OrganizationAffectedEntitiesErrorItem struct {

	// The 12-digit Amazon Web Services account numbers that contains the affected
	// entities.
	AwsAccountId *string

	// A message that describes the error. Follow the error message and retry your
	// request.
	//
	// For example, the InvalidAccountInputError error message appears if you call the
	// DescribeAffectedEntitiesForOrganization operation and specify the
	// AccountSpecific value for the EventScopeCode parameter, but don't specify an
	// Amazon Web Services account.
	ErrorMessage *string

	// The name of the error.
	ErrorName *string

	// The unique identifier for the event. The event ARN has the
	// arn:aws:health:event-region::event/SERVICE/EVENT_TYPE_CODE/EVENT_TYPE_PLUS_ID
	// format.
	//
	// For example, an event ARN might look like the following:
	//
	//     arn:aws:health:us-east-1::event/EC2/EC2_INSTANCE_RETIREMENT_SCHEDULED/EC2_INSTANCE_RETIREMENT_SCHEDULED_ABC123-DEF456
	EventArn *string

	noSmithyDocumentSerde
}

// The aggregate results of entities affected by the specified event in your
// organization. The results are aggregated by the entity status codes for the
// specified set of accountsIDs.
type OrganizationEntityAggregate struct {

	// A list of entity aggregates for each of the specified accounts in your
	// organization that are affected by a specific event. If there are no
	// awsAccountIds provided in the request, this field will be empty in the response.
	Accounts []AccountEntityAggregate

	// The number of entities for the organization that match the filter criteria for
	// the specified events.
	Count int32

	// A list of event ARNs (unique identifiers). For example:
	// "arn:aws:health:us-east-1::event/EC2/EC2_INSTANCE_RETIREMENT_SCHEDULED/EC2_INSTANCE_RETIREMENT_SCHEDULED_ABC123-CDE456",
	// "arn:aws:health:us-west-1::event/EBS/AWS_EBS_LOST_VOLUME/AWS_EBS_LOST_VOLUME_CHI789_JKL101"
	EventArn *string

	// The number of affected entities aggregated by the entitiy status codes.
	Statuses map[string]int32

	noSmithyDocumentSerde
}

// Summary information about an event, returned by the [DescribeEventsForOrganization] operation.
//
// [DescribeEventsForOrganization]: https://docs.aws.amazon.com/health/latest/APIReference/API_DescribeEventsForOrganization.html
type OrganizationEvent struct {

	// The unique identifier for the event. The event ARN has the
	// arn:aws:health:event-region::event/SERVICE/EVENT_TYPE_CODE/EVENT_TYPE_PLUS_ID
	// format.
	//
	// For example, an event ARN might look like the following:
	//
	//     arn:aws:health:us-east-1::event/EC2/EC2_INSTANCE_RETIREMENT_SCHEDULED/EC2_INSTANCE_RETIREMENT_SCHEDULED_ABC123-DEF456
	Arn *string

	// The date and time that the event ended.
	EndTime *time.Time

	// This parameter specifies if the Health event is a public Amazon Web Service
	// event or an account-specific event.
	//
	//   - If the eventScopeCode value is PUBLIC , then the affectedAccounts value is
	//   always empty.
	//
	//   - If the eventScopeCode value is ACCOUNT_SPECIFIC , then the affectedAccounts
	//   value lists the affected Amazon Web Services accounts in your organization. For
	//   example, if an event affects a service such as Amazon Elastic Compute Cloud and
	//   you have Amazon Web Services accounts that use that service, those account IDs
	//   appear in the response.
	//
	//   - If the eventScopeCode value is NONE , then the eventArn that you specified
	//   in the request is invalid or doesn't exist.
	EventScopeCode EventScopeCode

	// A list of event type category codes. Possible values are issue ,
	// accountNotification , or scheduledChange . Currently, the investigation value
	// isn't supported at this time.
	EventTypeCategory EventTypeCategory

	// The unique identifier for the event type. The format is AWS_SERVICE_DESCRIPTION
	// . For example, AWS_EC2_SYSTEM_MAINTENANCE_EVENT .
	EventTypeCode *string

	// The most recent date and time that the event was updated.
	LastUpdatedTime *time.Time

	// The Amazon Web Services Region name of the event.
	Region *string

	// The Amazon Web Service that is affected by the event, such as EC2 and RDS.
	Service *string

	// The date and time that the event began.
	StartTime *time.Time

	// The most recent status of the event. Possible values are open , closed , and
	// upcoming .
	StatusCode EventStatusCode

	noSmithyDocumentSerde
}

// Detailed information about an event. A combination of an [Event] object, an [EventDescription] object,
// and additional metadata about the event. Returned by the [DescribeEventDetailsForOrganization]operation.
//
// [DescribeEventDetailsForOrganization]: https://docs.aws.amazon.com/health/latest/APIReference/API_DescribeEventDetailsForOrganization.html
// [Event]: https://docs.aws.amazon.com/health/latest/APIReference/API_Event.html
// [EventDescription]: https://docs.aws.amazon.com/health/latest/APIReference/API_EventDescription.html
type OrganizationEventDetails struct {

	// The 12-digit Amazon Web Services account numbers that contains the affected
	// entities.
	AwsAccountId *string

	// Summary information about an Health event.
	//
	// Health events can be public or account-specific:
	//
	//   - Public events might be service events that are not specific to an Amazon
	//   Web Services account. For example, if there is an issue with an Amazon Web
	//   Services Region, Health provides information about the event, even if you don't
	//   use services or resources in that Region.
	//
	//   - Account-specific events are specific to either your Amazon Web Services
	//   account or an account in your organization. For example, if there's an issue
	//   with Amazon Elastic Compute Cloud in a Region that you use, Health provides
	//   information about the event and the affected resources in the account.
	//
	// You can determine if an event is public or account-specific by using the
	// eventScopeCode parameter. For more information, see [eventScopeCode].
	//
	// [eventScopeCode]: https://docs.aws.amazon.com/health/latest/APIReference/API_Event.html#AWSHealth-Type-Event-eventScopeCode
	Event *Event

	// The detailed description of the event. Included in the information returned by
	// the [DescribeEventDetails]operation.
	//
	// [DescribeEventDetails]: https://docs.aws.amazon.com/health/latest/APIReference/API_DescribeEventDetails.html
	EventDescription *EventDescription

	// Additional metadata about the event.
	EventMetadata map[string]string

	noSmithyDocumentSerde
}

// Error information returned when a [DescribeEventDetailsForOrganization] operation can't find a specified event.
//
// [DescribeEventDetailsForOrganization]: https://docs.aws.amazon.com/health/latest/APIReference/API_DescribeEventDetailsForOrganization.html
type OrganizationEventDetailsErrorItem struct {

	// Error information returned when a [DescribeEventDetailsForOrganization] operation can't find a specified event.
	//
	// [DescribeEventDetailsForOrganization]: https://docs.aws.amazon.com/health/latest/APIReference/API_DescribeEventDetailsForOrganization.html
	AwsAccountId *string

	// A message that describes the error.
	//
	// If you call the DescribeEventDetailsForOrganization operation and receive one
	// of the following errors, follow the recommendations in the message:
	//
	//   - We couldn't find a public event that matches your request. To find an event
	//   that is account specific, you must enter an Amazon Web Services account ID in
	//   the request.
	//
	//   - We couldn't find an account specific event for the specified Amazon Web
	//   Services account. To find an event that is public, you must enter a null value
	//   for the Amazon Web Services account ID in the request.
	//
	//   - Your Amazon Web Services account doesn't include the Amazon Web Services
	//   Support plan required to use the Health API. You must have either a Business,
	//   Enterprise On-Ramp, or Enterprise Support plan.
	ErrorMessage *string

	// The name of the error.
	ErrorName *string

	// The unique identifier for the event. The event ARN has the
	// arn:aws:health:event-region::event/SERVICE/EVENT_TYPE_CODE/EVENT_TYPE_PLUS_ID
	// format.
	//
	// For example, an event ARN might look like the following:
	//
	//     arn:aws:health:us-east-1::event/EC2/EC2_INSTANCE_RETIREMENT_SCHEDULED/EC2_INSTANCE_RETIREMENT_SCHEDULED_ABC123-DEF456
	EventArn *string

	noSmithyDocumentSerde
}

// The values to filter results from the [DescribeEventsForOrganization] operation.
//
// [DescribeEventsForOrganization]: https://docs.aws.amazon.com/health/latest/APIReference/API_DescribeEventsForOrganization.html
type OrganizationEventFilter struct {

	// A list of 12-digit Amazon Web Services account numbers that contains the
	// affected entities.
	AwsAccountIds []string

	// A range of dates and times that is used by the [EventFilter] and [EntityFilter] objects. If from is set
	// and to is set: match items where the timestamp ( startTime , endTime , or
	// lastUpdatedTime ) is between from and to inclusive. If from is set and to is
	// not set: match items where the timestamp value is equal to or after from . If
	// from is not set and to is set: match items where the timestamp value is equal
	// to or before to .
	//
	// [EntityFilter]: https://docs.aws.amazon.com/health/latest/APIReference/API_EntityFilter.html
	// [EventFilter]: https://docs.aws.amazon.com/health/latest/APIReference/API_EventFilter.html
	EndTime *DateTimeRange

	// A list of entity ARNs (unique identifiers).
	EntityArns []string

	// A list of entity identifiers, such as EC2 instance IDs (i-34ab692e) or EBS
	// volumes (vol-426ab23e).
	EntityValues []string

	// A list of event status codes.
	EventStatusCodes []EventStatusCode

	// A list of event type category codes. Possible values are issue ,
	// accountNotification , or scheduledChange . Currently, the investigation value
	// isn't supported at this time.
	EventTypeCategories []EventTypeCategory

	// A list of unique identifiers for event types. For example,
	// "AWS_EC2_SYSTEM_MAINTENANCE_EVENT","AWS_RDS_MAINTENANCE_SCHEDULED".
	EventTypeCodes []string

	// A range of dates and times that is used by the [EventFilter] and [EntityFilter] objects. If from is set
	// and to is set: match items where the timestamp ( startTime , endTime , or
	// lastUpdatedTime ) is between from and to inclusive. If from is set and to is
	// not set: match items where the timestamp value is equal to or after from . If
	// from is not set and to is set: match items where the timestamp value is equal
	// to or before to .
	//
	// [EntityFilter]: https://docs.aws.amazon.com/health/latest/APIReference/API_EntityFilter.html
	// [EventFilter]: https://docs.aws.amazon.com/health/latest/APIReference/API_EventFilter.html
	LastUpdatedTime *DateTimeRange

	// A list of Amazon Web Services Regions.
	Regions []string

	// The Amazon Web Services associated with the event. For example, EC2 , RDS .
	Services []string

	// A range of dates and times that is used by the [EventFilter] and [EntityFilter] objects. If from is set
	// and to is set: match items where the timestamp ( startTime , endTime , or
	// lastUpdatedTime ) is between from and to inclusive. If from is set and to is
	// not set: match items where the timestamp value is equal to or after from . If
	// from is not set and to is set: match items where the timestamp value is equal
	// to or before to .
	//
	// [EntityFilter]: https://docs.aws.amazon.com/health/latest/APIReference/API_EntityFilter.html
	// [EventFilter]: https://docs.aws.amazon.com/health/latest/APIReference/API_EventFilter.html
	StartTime *DateTimeRange

	noSmithyDocumentSerde
}

type noSmithyDocumentSerde = smithydocument.NoSerde