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 726 727 728 729 730 731 732 733 734 735 736 737 738 739 740 741 742 743 744 745 746 747 748 749 750 751 752 753 754 755 756 757 758 759 760 761 762 763 764 765 766 767 768 769 770 771 772 773 774 775 776 777 778 779 780 781 782 783 784 785 786 787 788 789 790 791 792 793 794 795 796 797
|
// Code generated by smithy-go-codegen DO NOT EDIT.
package types
import (
smithydocument "github.com/aws/smithy-go/document"
"time"
)
// The action that starts at the beginning of an incident. The response plan
// defines the action.
//
// The following types satisfy this interface:
//
// ActionMemberSsmAutomation
type Action interface {
isAction()
}
// The Systems Manager automation document to start as the runbook at the beginning
// of the incident.
type ActionMemberSsmAutomation struct {
Value SsmAutomation
noSmithyDocumentSerde
}
func (*ActionMemberSsmAutomation) isAction() {}
// Defines the Amazon Web Services Region and KMS key to add to the replication
// set.
type AddRegionAction struct {
// The Amazon Web Services Region name to add to the replication set.
//
// This member is required.
RegionName *string
// The KMS key ID to use to encrypt your replication set.
SseKmsKeyId *string
noSmithyDocumentSerde
}
// Use the AttributeValueList to filter by string or integer values.
//
// The following types satisfy this interface:
//
// AttributeValueListMemberIntegerValues
// AttributeValueListMemberStringValues
type AttributeValueList interface {
isAttributeValueList()
}
// The list of integer values that the filter matches.
type AttributeValueListMemberIntegerValues struct {
Value []int32
noSmithyDocumentSerde
}
func (*AttributeValueListMemberIntegerValues) isAttributeValueList() {}
// The list of string values that the filter matches.
type AttributeValueListMemberStringValues struct {
Value []string
noSmithyDocumentSerde
}
func (*AttributeValueListMemberStringValues) isAttributeValueList() {}
// The Systems Manager automation document process to start as the runbook at the
// beginning of the incident.
//
// The following types satisfy this interface:
//
// AutomationExecutionMemberSsmExecutionArn
type AutomationExecution interface {
isAutomationExecution()
}
// The Amazon Resource Name (ARN) of the automation process.
type AutomationExecutionMemberSsmExecutionArn struct {
Value string
noSmithyDocumentSerde
}
func (*AutomationExecutionMemberSsmExecutionArn) isAutomationExecution() {}
// The Chatbot chat channel used for collaboration during an incident.
//
// The following types satisfy this interface:
//
// ChatChannelMemberChatbotSns
// ChatChannelMemberEmpty
type ChatChannel interface {
isChatChannel()
}
// The Amazon SNS targets that Chatbot uses to notify the chat channel of updates
// to an incident. You can also make updates to the incident through the chat
// channel by using the Amazon SNS topics.
type ChatChannelMemberChatbotSns struct {
Value []string
noSmithyDocumentSerde
}
func (*ChatChannelMemberChatbotSns) isChatChannel() {}
// Used to remove the chat channel from an incident record or response plan.
type ChatChannelMemberEmpty struct {
Value EmptyChatChannel
noSmithyDocumentSerde
}
func (*ChatChannelMemberEmpty) isChatChannel() {}
// A conditional statement with which to compare a value, after a timestamp, before
// a timestamp, or equal to a string or integer. If multiple conditions are
// specified, the conditionals become an ANDed statement. If multiple values are
// specified for a conditional, the values are ORd.
//
// The following types satisfy this interface:
//
// ConditionMemberAfter
// ConditionMemberBefore
// ConditionMemberEquals
type Condition interface {
isCondition()
}
// After the specified timestamp.
type ConditionMemberAfter struct {
Value time.Time
noSmithyDocumentSerde
}
func (*ConditionMemberAfter) isCondition() {}
// Before the specified timestamp
type ConditionMemberBefore struct {
Value time.Time
noSmithyDocumentSerde
}
func (*ConditionMemberBefore) isCondition() {}
// The value is equal to the provided string or integer.
type ConditionMemberEquals struct {
Value AttributeValueList
noSmithyDocumentSerde
}
func (*ConditionMemberEquals) isCondition() {}
// Defines the information about the Amazon Web Services Region you're deleting
// from your replication set.
type DeleteRegionAction struct {
// The name of the Amazon Web Services Region you're deleting from the replication
// set.
//
// This member is required.
RegionName *string
noSmithyDocumentSerde
}
// The dynamic SSM parameter value.
//
// The following types satisfy this interface:
//
// DynamicSsmParameterValueMemberVariable
type DynamicSsmParameterValue interface {
isDynamicSsmParameterValue()
}
// Variable dynamic parameters. A parameter value is determined when an incident is
// created.
type DynamicSsmParameterValueMemberVariable struct {
Value VariableType
noSmithyDocumentSerde
}
func (*DynamicSsmParameterValueMemberVariable) isDynamicSsmParameterValue() {}
// Used to remove the chat channel from an incident record or response plan.
type EmptyChatChannel struct {
noSmithyDocumentSerde
}
// Details about a timeline event during an incident.
type EventSummary struct {
// The timeline event ID.
//
// This member is required.
EventId *string
// The time that the event occurred.
//
// This member is required.
EventTime *time.Time
// The type of event. The timeline event must be Custom Event.
//
// This member is required.
EventType *string
// The time that the timeline event was last updated.
//
// This member is required.
EventUpdatedTime *time.Time
// The Amazon Resource Name (ARN) of the incident that the event happened during.
//
// This member is required.
IncidentRecordArn *string
noSmithyDocumentSerde
}
// Filter the selection by using a condition.
type Filter struct {
// The condition accepts before or after a specified time, equal to a string, or
// equal to an integer.
//
// This member is required.
Condition Condition
// The key that you're filtering on.
//
// This member is required.
Key *string
noSmithyDocumentSerde
}
// The record of the incident that's created when an incident occurs.
type IncidentRecord struct {
// The Amazon Resource Name (ARN) of the incident record.
//
// This member is required.
Arn *string
// The time that Incident Manager created the incident record.
//
// This member is required.
CreationTime *time.Time
// The string Incident Manager uses to prevent duplicate incidents from being
// created by the same incident in the same account.
//
// This member is required.
DedupeString *string
// The impact of the incident on customers and applications.
//
// This member is required.
Impact *int32
// Details about the action that started the incident.
//
// This member is required.
IncidentRecordSource *IncidentRecordSource
// Who modified the incident most recently.
//
// This member is required.
LastModifiedBy *string
// The time at which the incident was most recently modified.
//
// This member is required.
LastModifiedTime *time.Time
// The current status of the incident.
//
// This member is required.
Status IncidentRecordStatus
// The title of the incident.
//
// This member is required.
Title *string
// The runbook, or automation document, that's run at the beginning of the
// incident.
AutomationExecutions []AutomationExecution
// The chat channel used for collaboration during an incident.
ChatChannel ChatChannel
// The Amazon SNS targets that are notified when updates are made to an incident.
NotificationTargets []NotificationTargetItem
// The time at which the incident was resolved. This appears as a timeline event.
ResolvedTime *time.Time
// The summary of the incident. The summary is a brief synopsis of what occurred,
// what's currently happening, and context of the incident.
Summary *string
noSmithyDocumentSerde
}
// Details about what created the incident record and when it was created.
type IncidentRecordSource struct {
// The principal that started the incident.
//
// This member is required.
CreatedBy *string
// The service that started the incident. This can be manually created from
// Incident Manager, automatically created using an Amazon CloudWatch alarm, or
// Amazon EventBridge event.
//
// This member is required.
Source *string
// The service principal that assumed the role specified in createdBy. If no
// service principal assumed the role this will be left blank.
InvokedBy *string
// The resource that caused the incident to be created.
ResourceArn *string
noSmithyDocumentSerde
}
// Details describing an incident record.
type IncidentRecordSummary struct {
// The Amazon Resource Name (ARN) of the incident.
//
// This member is required.
Arn *string
// The time the incident was created.
//
// This member is required.
CreationTime *time.Time
// Defines the impact to customers and applications.
//
// This member is required.
Impact *int32
// What caused Incident Manager to create the incident.
//
// This member is required.
IncidentRecordSource *IncidentRecordSource
// The current status of the incident.
//
// This member is required.
Status IncidentRecordStatus
// The title of the incident. This value is either provided by the response plan or
// overwritten on creation.
//
// This member is required.
Title *string
// The time the incident was resolved.
ResolvedTime *time.Time
noSmithyDocumentSerde
}
// Basic details used in creating a response plan. The response plan is then used
// to create an incident record.
type IncidentTemplate struct {
// The impact of the incident on your customers and applications.
//
// This member is required.
Impact *int32
// The title of the incident.
//
// This member is required.
Title *string
// Used to stop Incident Manager from creating multiple incident records for the
// same incident.
DedupeString *string
// Tags to apply to an incident when calling the StartIncident API action.
IncidentTags map[string]string
// The Amazon SNS targets that are notified when updates are made to an incident.
NotificationTargets []NotificationTargetItem
// The summary of the incident. The summary is a brief synopsis of what occurred,
// what's currently happening, and context.
Summary *string
noSmithyDocumentSerde
}
// Details and type of a related item.
type ItemIdentifier struct {
// The type of related item.
//
// This member is required.
Type ItemType
// Details about the related item.
//
// This member is required.
Value ItemValue
noSmithyDocumentSerde
}
// Describes a related item.
//
// The following types satisfy this interface:
//
// ItemValueMemberArn
// ItemValueMemberMetricDefinition
// ItemValueMemberUrl
type ItemValue interface {
isItemValue()
}
// The Amazon Resource Name (ARN) of the related item, if the related item is an
// Amazon resource.
type ItemValueMemberArn struct {
Value string
noSmithyDocumentSerde
}
func (*ItemValueMemberArn) isItemValue() {}
// The metric definition, if the related item is a metric in Amazon CloudWatch.
type ItemValueMemberMetricDefinition struct {
Value string
noSmithyDocumentSerde
}
func (*ItemValueMemberMetricDefinition) isItemValue() {}
// The URL, if the related item is a non-Amazon Web Services resource.
type ItemValueMemberUrl struct {
Value string
noSmithyDocumentSerde
}
func (*ItemValueMemberUrl) isItemValue() {}
// The SNS targets that are notified when updates are made to an incident.
//
// The following types satisfy this interface:
//
// NotificationTargetItemMemberSnsTopicArn
type NotificationTargetItem interface {
isNotificationTargetItem()
}
// The Amazon Resource Name (ARN) of the SNS topic.
type NotificationTargetItemMemberSnsTopicArn struct {
Value string
noSmithyDocumentSerde
}
func (*NotificationTargetItemMemberSnsTopicArn) isNotificationTargetItem() {}
// Information about a Amazon Web Services Region in your replication set.
type RegionInfo struct {
// The status of the Amazon Web Services Region in the replication set.
//
// This member is required.
Status RegionStatus
// The most recent date and time that Incident Manager updated the Amazon Web
// Services Region's status.
//
// This member is required.
StatusUpdateDateTime *time.Time
// The ID of the KMS key used to encrypt the data in this Amazon Web Services
// Region.
SseKmsKeyId *string
// Information displayed about the status of the Amazon Web Services Region.
StatusMessage *string
noSmithyDocumentSerde
}
// The mapping between a Amazon Web Services Region and the key that's used to
// encrypt the data.
type RegionMapInputValue struct {
// The KMS key used to encrypt the data in your replication set.
SseKmsKeyId *string
noSmithyDocumentSerde
}
// Resources that responders use to triage and mitigate the incident.
type RelatedItem struct {
// Details about the related item.
//
// This member is required.
Identifier *ItemIdentifier
// The title of the related item.
Title *string
noSmithyDocumentSerde
}
// Details about the related item you're adding.
//
// The following types satisfy this interface:
//
// RelatedItemsUpdateMemberItemToAdd
// RelatedItemsUpdateMemberItemToRemove
type RelatedItemsUpdate interface {
isRelatedItemsUpdate()
}
// Details about the related item you're adding.
type RelatedItemsUpdateMemberItemToAdd struct {
Value RelatedItem
noSmithyDocumentSerde
}
func (*RelatedItemsUpdateMemberItemToAdd) isRelatedItemsUpdate() {}
// Details about the related item you're deleting.
type RelatedItemsUpdateMemberItemToRemove struct {
Value ItemIdentifier
noSmithyDocumentSerde
}
func (*RelatedItemsUpdateMemberItemToRemove) isRelatedItemsUpdate() {}
// The set of Amazon Web Services Region that your Incident Manager data will be
// replicated to and the KMS key used to encrypt the data.
type ReplicationSet struct {
// Details about who created the replication set.
//
// This member is required.
CreatedBy *string
// When the replication set was created.
//
// This member is required.
CreatedTime *time.Time
// Determines if the replication set deletion protection is enabled or not. If
// deletion protection is enabled, you can't delete the last Amazon Web Services
// Region in the replication set.
//
// This member is required.
DeletionProtected *bool
// Who last modified the replication set.
//
// This member is required.
LastModifiedBy *string
// When the replication set was last updated.
//
// This member is required.
LastModifiedTime *time.Time
// The map between each Amazon Web Services Region in your replication set and the
// KMS key that's used to encrypt the data in that Region.
//
// This member is required.
RegionMap map[string]RegionInfo
// The status of the replication set. If the replication set is still pending, you
// can't use Incident Manager functionality.
//
// This member is required.
Status ReplicationSetStatus
// The Amazon Resource Name (ARN) of the replication set.
Arn *string
noSmithyDocumentSerde
}
// The resource policy that allows Incident Manager to perform actions on resources
// on your behalf.
type ResourcePolicy struct {
// The JSON blob that describes the policy.
//
// This member is required.
PolicyDocument *string
// The ID of the resource policy.
//
// This member is required.
PolicyId *string
// The Amazon Web Services Region that policy allows resources to be used in.
//
// This member is required.
RamResourceShareRegion *string
noSmithyDocumentSerde
}
// Details of the response plan that are used when creating an incident.
type ResponsePlanSummary struct {
// The Amazon Resource Name (ARN) of the response plan.
//
// This member is required.
Arn *string
// The name of the response plan. This can't include spaces.
//
// This member is required.
Name *string
// The human readable name of the response plan. This can include spaces.
DisplayName *string
noSmithyDocumentSerde
}
// Details about the Systems Manager automation document that will be used as a
// runbook during an incident.
type SsmAutomation struct {
// The automation document's name.
//
// This member is required.
DocumentName *string
// The Amazon Resource Name (ARN) of the role that the automation document will
// assume when running commands.
//
// This member is required.
RoleArn *string
// The automation document's version to use when running.
DocumentVersion *string
// The key-value pair to resolve dynamic parameter values when processing a Systems
// Manager Automation runbook.
DynamicParameters map[string]DynamicSsmParameterValue
// The key-value pair parameters to use when running the automation document.
Parameters map[string][]string
// The account that the automation document will be run in. This can be in either
// the management account or an application account.
TargetAccount SsmTargetAccount
noSmithyDocumentSerde
}
// A significant event that happened during the incident.
type TimelineEvent struct {
// A short description of the event.
//
// This member is required.
EventData *string
// The ID of the timeline event.
//
// This member is required.
EventId *string
// The time that the event occurred.
//
// This member is required.
EventTime *time.Time
// The type of event that occurred. Currently Incident Manager supports only the
// Custom Event type.
//
// This member is required.
EventType *string
// The time that the timeline event was last updated.
//
// This member is required.
EventUpdatedTime *time.Time
// The Amazon Resource Name (ARN) of the incident that the event occurred during.
//
// This member is required.
IncidentRecordArn *string
noSmithyDocumentSerde
}
// Details about what caused the incident to be created in Incident Manager.
type TriggerDetails struct {
// Identifies the service that sourced the event. All events sourced from within
// Amazon Web Services begin with "aws." Customer-generated events can have any
// value here, as long as it doesn't begin with "aws." We recommend the use of Java
// package-name style reverse domain-name strings.
//
// This member is required.
Source *string
// The time that the incident was detected.
//
// This member is required.
Timestamp *time.Time
// Raw data passed from either Amazon EventBridge, Amazon CloudWatch, or Incident
// Manager when an incident is created.
RawData *string
// The Amazon Resource Name (ARN) of the source that detected the incident.
TriggerArn *string
noSmithyDocumentSerde
}
// Details used when updating the replication set.
//
// The following types satisfy this interface:
//
// UpdateReplicationSetActionMemberAddRegionAction
// UpdateReplicationSetActionMemberDeleteRegionAction
type UpdateReplicationSetAction interface {
isUpdateReplicationSetAction()
}
// Details about the Amazon Web Services Region that you're adding to the
// replication set.
type UpdateReplicationSetActionMemberAddRegionAction struct {
Value AddRegionAction
noSmithyDocumentSerde
}
func (*UpdateReplicationSetActionMemberAddRegionAction) isUpdateReplicationSetAction() {}
// Details about the Amazon Web Services Region that you're deleting to the
// replication set.
type UpdateReplicationSetActionMemberDeleteRegionAction struct {
Value DeleteRegionAction
noSmithyDocumentSerde
}
func (*UpdateReplicationSetActionMemberDeleteRegionAction) isUpdateReplicationSetAction() {}
type noSmithyDocumentSerde = smithydocument.NoSerde
// UnknownUnionMember is returned when a union member is returned over the wire,
// but has an unknown tag.
type UnknownUnionMember struct {
Tag string
Value []byte
noSmithyDocumentSerde
}
func (*UnknownUnionMember) isAction() {}
func (*UnknownUnionMember) isAttributeValueList() {}
func (*UnknownUnionMember) isAutomationExecution() {}
func (*UnknownUnionMember) isChatChannel() {}
func (*UnknownUnionMember) isCondition() {}
func (*UnknownUnionMember) isDynamicSsmParameterValue() {}
func (*UnknownUnionMember) isItemValue() {}
func (*UnknownUnionMember) isNotificationTargetItem() {}
func (*UnknownUnionMember) isRelatedItemsUpdate() {}
func (*UnknownUnionMember) isUpdateReplicationSetAction() {}
|