types

package
v1.23.0 Latest Latest
Warning

This package is not in the latest version of its module.

 Go to latest Published: Sep 18, 2023 License: Apache-2.0 Imports: 4 Imported by: 1

Documentation

Index

Examples

Constants

This section is empty.

Variables

This section is empty.

Functions

This section is empty.

Types

type AccessDeniedException 

type AccessDeniedException struct {
	Message *string

	ErrorCodeOverride *string
	// contains filtered or unexported fields
}

You don't have sufficient access to perform this operation.

func (*AccessDeniedException) Error 

func (e *AccessDeniedException) Error() string

func (*AccessDeniedException) ErrorCode 

func (e *AccessDeniedException) ErrorCode() string

func (*AccessDeniedException) ErrorFault 

func (e *AccessDeniedException) ErrorFault() smithy.ErrorFault

func (*AccessDeniedException) ErrorMessage 

func (e *AccessDeniedException) ErrorMessage() string

type Action 

type Action interface {
	// contains filtered or unexported methods
}

The action that starts at the beginning of an incident. The response plan defines the action.

The following types satisfy this interface: 

ActionMemberSsmAutomation
Example (OutputUsage) 
package main

import (
	"fmt"
	"github.com/aws/aws-sdk-go-v2/service/ssmincidents/types"
)

func main() {
	var union types.Action
	// type switches can be used to check the union value
	switch v := union.(type) {
	case *types.ActionMemberSsmAutomation:
		_ = v.Value // Value is types.SsmAutomation

	case *types.UnknownUnionMember:
		fmt.Println("unknown tag:", v.Tag)

	default:
		fmt.Println("union is nil or unknown type")

	}
}

Output:

type ActionMemberSsmAutomation 

type ActionMemberSsmAutomation struct {
	Value SsmAutomation
	// contains filtered or unexported fields
}

The Systems Manager automation document to start as the runbook at the beginning of the incident.

type AddRegionAction 

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
	// contains filtered or unexported fields
}

Defines the Amazon Web Services Region and KMS key to add to the replication set.

type AttributeValueList 

type AttributeValueList interface {
	// contains filtered or unexported methods
}

Use the AttributeValueList to filter by string or integer values.

The following types satisfy this interface: 

AttributeValueListMemberIntegerValues
AttributeValueListMemberStringValues
Example (OutputUsage) 
package main

import (
	"fmt"
	"github.com/aws/aws-sdk-go-v2/service/ssmincidents/types"
)

func main() {
	var union types.AttributeValueList
	// type switches can be used to check the union value
	switch v := union.(type) {
	case *types.AttributeValueListMemberIntegerValues:
		_ = v.Value // Value is []int32

	case *types.AttributeValueListMemberStringValues:
		_ = v.Value // Value is []string

	case *types.UnknownUnionMember:
		fmt.Println("unknown tag:", v.Tag)

	default:
		fmt.Println("union is nil or unknown type")

	}
}

Output:

type AttributeValueListMemberIntegerValues 

type AttributeValueListMemberIntegerValues struct {
	Value []int32
	// contains filtered or unexported fields
}

The list of integer values that the filter matches.

type AttributeValueListMemberStringValues 

type AttributeValueListMemberStringValues struct {
	Value []string
	// contains filtered or unexported fields
}

The list of string values that the filter matches.

type AutomationExecution 

type AutomationExecution interface {
	// contains filtered or unexported methods
}

The Systems Manager automation document process to start as the runbook at the beginning of the incident.

The following types satisfy this interface: 

AutomationExecutionMemberSsmExecutionArn
Example (OutputUsage) 
package main

import (
	"fmt"
	"github.com/aws/aws-sdk-go-v2/service/ssmincidents/types"
)

func main() {
	var union types.AutomationExecution
	// type switches can be used to check the union value
	switch v := union.(type) {
	case *types.AutomationExecutionMemberSsmExecutionArn:
		_ = v.Value // Value is string

	case *types.UnknownUnionMember:
		fmt.Println("unknown tag:", v.Tag)

	default:
		fmt.Println("union is nil or unknown type")

	}
}

Output:

type AutomationExecutionMemberSsmExecutionArn 

type AutomationExecutionMemberSsmExecutionArn struct {
	Value string
	// contains filtered or unexported fields
}

The Amazon Resource Name (ARN) of the automation process.

type ChatChannel 

type ChatChannel interface {
	// contains filtered or unexported methods
}

The Chatbot chat channel used for collaboration during an incident.

The following types satisfy this interface: 

ChatChannelMemberChatbotSns
ChatChannelMemberEmpty
Example (OutputUsage) 
package main

import (
	"fmt"
	"github.com/aws/aws-sdk-go-v2/service/ssmincidents/types"
)

func main() {
	var union types.ChatChannel
	// type switches can be used to check the union value
	switch v := union.(type) {
	case *types.ChatChannelMemberChatbotSns:
		_ = v.Value // Value is []string

	case *types.ChatChannelMemberEmpty:
		_ = v.Value // Value is types.EmptyChatChannel

	case *types.UnknownUnionMember:
		fmt.Println("unknown tag:", v.Tag)

	default:
		fmt.Println("union is nil or unknown type")

	}
}

Output:

type ChatChannelMemberChatbotSns 

type ChatChannelMemberChatbotSns struct {
	Value []string
	// contains filtered or unexported fields
}

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 ChatChannelMemberEmpty 

type ChatChannelMemberEmpty struct {
	Value EmptyChatChannel
	// contains filtered or unexported fields
}

Used to remove the chat channel from an incident record or response plan.

type Condition 

type Condition interface {
	// contains filtered or unexported methods
}

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 AND ed statement. If multiple values are specified for a conditional, the values are OR d.

The following types satisfy this interface: 

ConditionMemberAfter
ConditionMemberBefore
ConditionMemberEquals
Example (OutputUsage) 
package main

import (
	"fmt"
	"github.com/aws/aws-sdk-go-v2/service/ssmincidents/types"
)

func main() {
	var union types.Condition
	// type switches can be used to check the union value
	switch v := union.(type) {
	case *types.ConditionMemberAfter:
		_ = v.Value // Value is time.Time

	case *types.ConditionMemberBefore:
		_ = v.Value // Value is time.Time

	case *types.ConditionMemberEquals:
		_ = v.Value // Value is types.AttributeValueList

	case *types.UnknownUnionMember:
		fmt.Println("unknown tag:", v.Tag)

	default:
		fmt.Println("union is nil or unknown type")

	}
}

Output:

type ConditionMemberAfter 

type ConditionMemberAfter struct {
	Value time.Time
	// contains filtered or unexported fields
}

After the specified timestamp.

type ConditionMemberBefore 

type ConditionMemberBefore struct {
	Value time.Time
	// contains filtered or unexported fields
}

Before the specified timestamp

type ConditionMemberEquals 

type ConditionMemberEquals struct {
	Value AttributeValueList
	// contains filtered or unexported fields
}

The value is equal to the provided string or integer.

type ConflictException 

type ConflictException struct {
	Message *string

	ErrorCodeOverride *string

	ResourceIdentifier *string
	ResourceType       ResourceType
	RetryAfter         *time.Time
	// contains filtered or unexported fields
}

Updating or deleting a resource causes an inconsistent state.

func (*ConflictException) Error 

func (e *ConflictException) Error() string

func (*ConflictException) ErrorCode 

func (e *ConflictException) ErrorCode() string

func (*ConflictException) ErrorFault 

func (e *ConflictException) ErrorFault() smithy.ErrorFault

func (*ConflictException) ErrorMessage 

func (e *ConflictException) ErrorMessage() string

type DeleteRegionAction 

type DeleteRegionAction struct {

	// The name of the Amazon Web Services Region you're deleting from the replication
	// set.
	//
	// This member is required.
	RegionName *string
	// contains filtered or unexported fields
}

Defines the information about the Amazon Web Services Region you're deleting from your replication set.

type DynamicSsmParameterValue added in v1.14.0 

type DynamicSsmParameterValue interface {
	// contains filtered or unexported methods
}

The dynamic SSM parameter value.

The following types satisfy this interface: 

DynamicSsmParameterValueMemberVariable
Example (OutputUsage) 
package main

import (
	"fmt"
	"github.com/aws/aws-sdk-go-v2/service/ssmincidents/types"
)

func main() {
	var union types.DynamicSsmParameterValue
	// type switches can be used to check the union value
	switch v := union.(type) {
	case *types.DynamicSsmParameterValueMemberVariable:
		_ = v.Value // Value is types.VariableType

	case *types.UnknownUnionMember:
		fmt.Println("unknown tag:", v.Tag)

	default:
		fmt.Println("union is nil or unknown type")

	}
}

Output:

type DynamicSsmParameterValueMemberVariable added in v1.14.0 

type DynamicSsmParameterValueMemberVariable struct {
	Value VariableType
	// contains filtered or unexported fields
}

Variable dynamic parameters. A parameter value is determined when an incident is created.

type EmptyChatChannel 

type EmptyChatChannel struct {
	// contains filtered or unexported fields
}

Used to remove the chat channel from an incident record or response plan.

type EventReference added in v1.18.0 

type EventReference interface {
	// contains filtered or unexported methods
}

An item referenced in a TimelineEvent that is involved in or somehow associated with an incident. You can specify an Amazon Resource Name (ARN) for an Amazon Web Services resource or a RelatedItem ID.

The following types satisfy this interface: 

EventReferenceMemberRelatedItemId
EventReferenceMemberResource
Example (OutputUsage) 
package main

import (
	"fmt"
	"github.com/aws/aws-sdk-go-v2/service/ssmincidents/types"
)

func main() {
	var union types.EventReference
	// type switches can be used to check the union value
	switch v := union.(type) {
	case *types.EventReferenceMemberRelatedItemId:
		_ = v.Value // Value is string

	case *types.EventReferenceMemberResource:
		_ = v.Value // Value is string

	case *types.UnknownUnionMember:
		fmt.Println("unknown tag:", v.Tag)

	default:
		fmt.Println("union is nil or unknown type")

	}
}

Output:

type EventReferenceMemberRelatedItemId added in v1.18.0 

type EventReferenceMemberRelatedItemId struct {
	Value string
	// contains filtered or unexported fields
}

The ID of a RelatedItem referenced in a TimelineEvent .

type EventReferenceMemberResource added in v1.18.0 

type EventReferenceMemberResource struct {
	Value string
	// contains filtered or unexported fields
}

The Amazon Resource Name (ARN) of an Amazon Web Services resource referenced in a TimelineEvent .

type EventSummary 

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

	// A list of references in a TimelineEvent .
	EventReferences []EventReference
	// contains filtered or unexported fields
}

Details about a timeline event during an incident.

type Filter 

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
	// contains filtered or unexported fields
}

Filter the selection by using a condition.

type IncidentRecord 

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
	// contains filtered or unexported fields
}

The record of the incident that's created when an incident occurs.

type IncidentRecordSource 

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
	// contains filtered or unexported fields
}

Details about what created the incident record and when it was created.

type IncidentRecordStatus 

type IncidentRecordStatus string
const (
	IncidentRecordStatusOpen     IncidentRecordStatus = "OPEN"
	IncidentRecordStatusResolved IncidentRecordStatus = "RESOLVED"
)

Enum values for IncidentRecordStatus

func (IncidentRecordStatus) Values 

func (IncidentRecordStatus) Values() []IncidentRecordStatus

Values returns all known values for IncidentRecordStatus. Note that this can be expanded in the future, and so it is only as up to date as the client. The ordering of this slice is not guaranteed to be stable across updates.

type IncidentRecordSummary 

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
	// contains filtered or unexported fields
}

Details describing an incident record.

type IncidentTemplate 

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 assign to the template. When the StartIncident API action is called,
	// Incident Manager assigns the tags specified in the template to the incident.
	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
	// contains filtered or unexported fields
}

Basic details used in creating a response plan. The response plan is then used to create an incident record.

type Integration added in v1.19.0 

type Integration interface {
	// contains filtered or unexported methods
}

Information about third-party services integrated into a response plan.

The following types satisfy this interface: 

IntegrationMemberPagerDutyConfiguration
Example (OutputUsage) 
package main

import (
	"fmt"
	"github.com/aws/aws-sdk-go-v2/service/ssmincidents/types"
)

func main() {
	var union types.Integration
	// type switches can be used to check the union value
	switch v := union.(type) {
	case *types.IntegrationMemberPagerDutyConfiguration:
		_ = v.Value // Value is types.PagerDutyConfiguration

	case *types.UnknownUnionMember:
		fmt.Println("unknown tag:", v.Tag)

	default:
		fmt.Println("union is nil or unknown type")

	}
}

Output:

type IntegrationMemberPagerDutyConfiguration added in v1.19.0 

type IntegrationMemberPagerDutyConfiguration struct {
	Value PagerDutyConfiguration
	// contains filtered or unexported fields
}

Information about the PagerDuty service where the response plan creates an incident.

type InternalServerException 

type InternalServerException struct {
	Message *string

	ErrorCodeOverride *string
	// contains filtered or unexported fields
}

The request processing has failed because of an unknown error, exception or failure.

func (*InternalServerException) Error 

func (e *InternalServerException) Error() string

func (*InternalServerException) ErrorCode 

func (e *InternalServerException) ErrorCode() string

func (*InternalServerException) ErrorFault 

func (e *InternalServerException) ErrorFault() smithy.ErrorFault

func (*InternalServerException) ErrorMessage 

func (e *InternalServerException) ErrorMessage() string

type ItemIdentifier 

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
	// contains filtered or unexported fields
}

Details and type of a related item.

type ItemType 

type ItemType string
const (
	ItemTypeAnalysis         ItemType = "ANALYSIS"
	ItemTypeIncident         ItemType = "INCIDENT"
	ItemTypeMetric           ItemType = "METRIC"
	ItemTypeParent           ItemType = "PARENT"
	ItemTypeAttachment       ItemType = "ATTACHMENT"
	ItemTypeOther            ItemType = "OTHER"
	ItemTypeAutomation       ItemType = "AUTOMATION"
	ItemTypeInvolvedResource ItemType = "INVOLVED_RESOURCE"
	ItemTypeTask             ItemType = "TASK"
)

Enum values for ItemType

func (ItemType) Values 

func (ItemType) Values() []ItemType

Values returns all known values for ItemType. Note that this can be expanded in the future, and so it is only as up to date as the client. The ordering of this slice is not guaranteed to be stable across updates.

type ItemValue 

type ItemValue interface {
	// contains filtered or unexported methods
}

Describes a related item.

The following types satisfy this interface: 

ItemValueMemberArn
ItemValueMemberMetricDefinition
ItemValueMemberPagerDutyIncidentDetail
ItemValueMemberUrl
Example (OutputUsage) 
package main

import (
	"fmt"
	"github.com/aws/aws-sdk-go-v2/service/ssmincidents/types"
)

func main() {
	var union types.ItemValue
	// type switches can be used to check the union value
	switch v := union.(type) {
	case *types.ItemValueMemberArn:
		_ = v.Value // Value is string

	case *types.ItemValueMemberMetricDefinition:
		_ = v.Value // Value is string

	case *types.ItemValueMemberPagerDutyIncidentDetail:
		_ = v.Value // Value is types.PagerDutyIncidentDetail

	case *types.ItemValueMemberUrl:
		_ = v.Value // Value is string

	case *types.UnknownUnionMember:
		fmt.Println("unknown tag:", v.Tag)

	default:
		fmt.Println("union is nil or unknown type")

	}
}

Output:

type ItemValueMemberArn 

type ItemValueMemberArn struct {
	Value string
	// contains filtered or unexported fields
}

The Amazon Resource Name (ARN) of the related item, if the related item is an Amazon resource.

type ItemValueMemberMetricDefinition 

type ItemValueMemberMetricDefinition struct {
	Value string
	// contains filtered or unexported fields
}

The metric definition, if the related item is a metric in Amazon CloudWatch.

type ItemValueMemberPagerDutyIncidentDetail added in v1.19.0 

type ItemValueMemberPagerDutyIncidentDetail struct {
	Value PagerDutyIncidentDetail
	// contains filtered or unexported fields
}

Details about an incident that is associated with a PagerDuty incident.

type ItemValueMemberUrl 

type ItemValueMemberUrl struct {
	Value string
	// contains filtered or unexported fields
}

The URL, if the related item is a non-Amazon Web Services resource.

type NotificationTargetItem 

type NotificationTargetItem interface {
	// contains filtered or unexported methods
}

The SNS targets that are notified when updates are made to an incident.

The following types satisfy this interface: 

NotificationTargetItemMemberSnsTopicArn
Example (OutputUsage) 
package main

import (
	"fmt"
	"github.com/aws/aws-sdk-go-v2/service/ssmincidents/types"
)

func main() {
	var union types.NotificationTargetItem
	// type switches can be used to check the union value
	switch v := union.(type) {
	case *types.NotificationTargetItemMemberSnsTopicArn:
		_ = v.Value // Value is string

	case *types.UnknownUnionMember:
		fmt.Println("unknown tag:", v.Tag)

	default:
		fmt.Println("union is nil or unknown type")

	}
}

Output:

type NotificationTargetItemMemberSnsTopicArn 

type NotificationTargetItemMemberSnsTopicArn struct {
	Value string
	// contains filtered or unexported fields
}

The Amazon Resource Name (ARN) of the SNS topic.

type PagerDutyConfiguration added in v1.19.0 

type PagerDutyConfiguration struct {

	// The name of the PagerDuty configuration.
	//
	// This member is required.
	Name *string

	// Details about the PagerDuty service associated with the configuration.
	//
	// This member is required.
	PagerDutyIncidentConfiguration *PagerDutyIncidentConfiguration

	// The ID of the Amazon Web Services Secrets Manager secret that stores your
	// PagerDuty key, either a General Access REST API Key or User Token REST API Key,
	// and other user credentials.
	//
	// This member is required.
	SecretId *string
	// contains filtered or unexported fields
}

Details about the PagerDuty configuration for a response plan.

type PagerDutyIncidentConfiguration added in v1.19.0 

type PagerDutyIncidentConfiguration struct {

	// The ID of the PagerDuty service that the response plan associates with an
	// incident when it launches.
	//
	// This member is required.
	ServiceId *string
	// contains filtered or unexported fields
}

Details about the PagerDuty service where the response plan creates an incident.

type PagerDutyIncidentDetail added in v1.19.0 

type PagerDutyIncidentDetail struct {

	// The ID of the incident associated with the PagerDuty service for the response
	// plan.
	//
	// This member is required.
	Id *string

	// Indicates whether to resolve the PagerDuty incident when you resolve the
	// associated Incident Manager incident.
	AutoResolve *bool

	// The ID of the Amazon Web Services Secrets Manager secret that stores your
	// PagerDuty key, either a General Access REST API Key or User Token REST API Key,
	// and other user credentials.
	SecretId *string
	// contains filtered or unexported fields
}

Details about the PagerDuty incident associated with an incident created by an Incident Manager response plan.

type RegionInfo 

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
	// contains filtered or unexported fields
}

Information about a Amazon Web Services Region in your replication set.

type RegionMapInputValue 

type RegionMapInputValue struct {

	// The KMS key used to encrypt the data in your replication set.
	SseKmsKeyId *string
	// contains filtered or unexported fields
}

The mapping between a Amazon Web Services Region and the key that's used to encrypt the data.

type RegionStatus 

type RegionStatus string
const (
	// All operations have completed successfully and the region is ready to use
	RegionStatusActive RegionStatus = "ACTIVE"
	// The region is in the process of being created.
	RegionStatusCreating RegionStatus = "CREATING"
	// The region is in the process of being deleted.
	RegionStatusDeleting RegionStatus = "DELETING"
	// The region is not healthy and we cannot automatically fix it.
	RegionStatusFailed RegionStatus = "FAILED"
)

Enum values for RegionStatus

func (RegionStatus) Values 

func (RegionStatus) Values() []RegionStatus

Values returns all known values for RegionStatus. Note that this can be expanded in the future, and so it is only as up to date as the client. The ordering of this slice is not guaranteed to be stable across updates.

type RelatedItem 

type RelatedItem struct {

	// Details about the related item.
	//
	// This member is required.
	Identifier *ItemIdentifier

	// A unique ID for a RelatedItem . Don't specify this parameter when you add a
	// RelatedItem by using the UpdateRelatedItems API action.
	GeneratedId *string

	// The title of the related item.
	Title *string
	// contains filtered or unexported fields
}

Resources that responders use to triage and mitigate the incident.

type RelatedItemsUpdate 

type RelatedItemsUpdate interface {
	// contains filtered or unexported methods
}

Details about the related item you're adding.

The following types satisfy this interface: 

RelatedItemsUpdateMemberItemToAdd
RelatedItemsUpdateMemberItemToRemove
Example (OutputUsage) 
package main

import (
	"fmt"
	"github.com/aws/aws-sdk-go-v2/service/ssmincidents/types"
)

func main() {
	var union types.RelatedItemsUpdate
	// type switches can be used to check the union value
	switch v := union.(type) {
	case *types.RelatedItemsUpdateMemberItemToAdd:
		_ = v.Value // Value is types.RelatedItem

	case *types.RelatedItemsUpdateMemberItemToRemove:
		_ = v.Value // Value is types.ItemIdentifier

	case *types.UnknownUnionMember:
		fmt.Println("unknown tag:", v.Tag)

	default:
		fmt.Println("union is nil or unknown type")

	}
}

Output:

type RelatedItemsUpdateMemberItemToAdd 

type RelatedItemsUpdateMemberItemToAdd struct {
	Value RelatedItem
	// contains filtered or unexported fields
}

Details about the related item you're adding.

type RelatedItemsUpdateMemberItemToRemove 

type RelatedItemsUpdateMemberItemToRemove struct {
	Value ItemIdentifier
	// contains filtered or unexported fields
}

Details about the related item you're deleting.

type ReplicationSet 

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
	// contains filtered or unexported fields
}

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 ReplicationSetStatus 

type ReplicationSetStatus string
const (
	// All operations have completed successfully and the replication set is ready to
	// use
	ReplicationSetStatusActive ReplicationSetStatus = "ACTIVE"
	// Replication set is in the process of being created.
	ReplicationSetStatusCreating ReplicationSetStatus = "CREATING"
	// Replication set is in the process of being updated.
	ReplicationSetStatusUpdating ReplicationSetStatus = "UPDATING"
	// Replication set is in the process of being deleted.
	ReplicationSetStatusDeleting ReplicationSetStatus = "DELETING"
	// Replication set is not healthy and we cannot fix it.
	ReplicationSetStatusFailed ReplicationSetStatus = "FAILED"
)

Enum values for ReplicationSetStatus

func (ReplicationSetStatus) Values 

func (ReplicationSetStatus) Values() []ReplicationSetStatus

Values returns all known values for ReplicationSetStatus. Note that this can be expanded in the future, and so it is only as up to date as the client. The ordering of this slice is not guaranteed to be stable across updates.

type ResourceNotFoundException 

type ResourceNotFoundException struct {
	Message *string

	ErrorCodeOverride *string

	ResourceIdentifier *string
	ResourceType       ResourceType
	// contains filtered or unexported fields
}

Request references a resource which doesn't exist.

func (*ResourceNotFoundException) Error 

func (e *ResourceNotFoundException) Error() string

func (*ResourceNotFoundException) ErrorCode 

func (e *ResourceNotFoundException) ErrorCode() string

func (*ResourceNotFoundException) ErrorFault 

func (e *ResourceNotFoundException) ErrorFault() smithy.ErrorFault

func (*ResourceNotFoundException) ErrorMessage 

func (e *ResourceNotFoundException) ErrorMessage() string

type ResourcePolicy 

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
	// contains filtered or unexported fields
}

The resource policy that allows Incident Manager to perform actions on resources on your behalf.

type ResourceType 

type ResourceType string
const (
	ResourceTypeResponsePlan   ResourceType = "RESPONSE_PLAN"
	ResourceTypeIncidentRecord ResourceType = "INCIDENT_RECORD"
	ResourceTypeTimelineEvent  ResourceType = "TIMELINE_EVENT"
	ResourceTypeReplicationSet ResourceType = "REPLICATION_SET"
	ResourceTypeResourcePolicy ResourceType = "RESOURCE_POLICY"
)

Enum values for ResourceType

func (ResourceType) Values 

func (ResourceType) Values() []ResourceType

Values returns all known values for ResourceType. Note that this can be expanded in the future, and so it is only as up to date as the client. The ordering of this slice is not guaranteed to be stable across updates.

type ResponsePlanSummary 

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
	// contains filtered or unexported fields
}

Details of the response plan that are used when creating an incident.

type ServiceCode 

type ServiceCode string
const (
	ServiceCodeSsmIncidents ServiceCode = "ssm-incidents"
)

Enum values for ServiceCode

func (ServiceCode) Values 

func (ServiceCode) Values() []ServiceCode

Values returns all known values for ServiceCode. Note that this can be expanded in the future, and so it is only as up to date as the client. The ordering of this slice is not guaranteed to be stable across updates.

type ServiceQuotaExceededException 

type ServiceQuotaExceededException struct {
	Message *string

	ErrorCodeOverride *string

	ResourceIdentifier *string
	ResourceType       ResourceType
	ServiceCode        ServiceCode
	QuotaCode          *string
	// contains filtered or unexported fields
}

Request would cause a service quota to be exceeded.

func (*ServiceQuotaExceededException) Error 

func (e *ServiceQuotaExceededException) Error() string

func (*ServiceQuotaExceededException) ErrorCode 

func (e *ServiceQuotaExceededException) ErrorCode() string

func (*ServiceQuotaExceededException) ErrorFault 

func (e *ServiceQuotaExceededException) ErrorFault() smithy.ErrorFault

func (*ServiceQuotaExceededException) ErrorMessage 

func (e *ServiceQuotaExceededException) ErrorMessage() string

type SortOrder 

type SortOrder string
const (
	SortOrderAscending  SortOrder = "ASCENDING"
	SortOrderDescending SortOrder = "DESCENDING"
)

Enum values for SortOrder

func (SortOrder) Values 

func (SortOrder) Values() []SortOrder

Values returns all known values for SortOrder. Note that this can be expanded in the future, and so it is only as up to date as the client. The ordering of this slice is not guaranteed to be stable across updates.

type SsmAutomation 

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
	// contains filtered or unexported fields
}

Details about the Systems Manager automation document that will be used as a runbook during an incident.

type SsmTargetAccount 

type SsmTargetAccount string
const (
	SsmTargetAccountResponsePlanOwnerAccount SsmTargetAccount = "RESPONSE_PLAN_OWNER_ACCOUNT"
	SsmTargetAccountImpactedAccount          SsmTargetAccount = "IMPACTED_ACCOUNT"
)

Enum values for SsmTargetAccount

func (SsmTargetAccount) Values 

func (SsmTargetAccount) Values() []SsmTargetAccount

Values returns all known values for SsmTargetAccount. Note that this can be expanded in the future, and so it is only as up to date as the client. The ordering of this slice is not guaranteed to be stable across updates.

type ThrottlingException 

type ThrottlingException struct {
	Message *string

	ErrorCodeOverride *string

	ServiceCode ServiceCode
	QuotaCode   *string
	// contains filtered or unexported fields
}

The request was denied due to request throttling.

func (*ThrottlingException) Error 

func (e *ThrottlingException) Error() string

func (*ThrottlingException) ErrorCode 

func (e *ThrottlingException) ErrorCode() string

func (*ThrottlingException) ErrorFault 

func (e *ThrottlingException) ErrorFault() smithy.ErrorFault

func (*ThrottlingException) ErrorMessage 

func (e *ThrottlingException) ErrorMessage() string

type TimelineEvent 

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

	// A list of references in a TimelineEvent .
	EventReferences []EventReference
	// contains filtered or unexported fields
}

A significant event that happened during the incident.

type TimelineEventSort 

type TimelineEventSort string
const (
	TimelineEventSortEventTime TimelineEventSort = "EVENT_TIME"
)

Enum values for TimelineEventSort

func (TimelineEventSort) Values 

func (TimelineEventSort) Values() []TimelineEventSort

Values returns all known values for TimelineEventSort. Note that this can be expanded in the future, and so it is only as up to date as the client. The ordering of this slice is not guaranteed to be stable across updates.

type TriggerDetails 

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
	// contains filtered or unexported fields
}

Details about what caused the incident to be created in Incident Manager.

type UnknownUnionMember 

type UnknownUnionMember struct {
	Tag   string
	Value []byte
	// contains filtered or unexported fields
}

UnknownUnionMember is returned when a union member is returned over the wire, but has an unknown tag.

type UpdateReplicationSetAction 

type UpdateReplicationSetAction interface {
	// contains filtered or unexported methods
}

Details used when updating the replication set.

The following types satisfy this interface: 

UpdateReplicationSetActionMemberAddRegionAction
UpdateReplicationSetActionMemberDeleteRegionAction
Example (OutputUsage) 
package main

import (
	"fmt"
	"github.com/aws/aws-sdk-go-v2/service/ssmincidents/types"
)

func main() {
	var union types.UpdateReplicationSetAction
	// type switches can be used to check the union value
	switch v := union.(type) {
	case *types.UpdateReplicationSetActionMemberAddRegionAction:
		_ = v.Value // Value is types.AddRegionAction

	case *types.UpdateReplicationSetActionMemberDeleteRegionAction:
		_ = v.Value // Value is types.DeleteRegionAction

	case *types.UnknownUnionMember:
		fmt.Println("unknown tag:", v.Tag)

	default:
		fmt.Println("union is nil or unknown type")

	}
}

Output:

type UpdateReplicationSetActionMemberAddRegionAction 

type UpdateReplicationSetActionMemberAddRegionAction struct {
	Value AddRegionAction
	// contains filtered or unexported fields
}

Details about the Amazon Web Services Region that you're adding to the replication set.

type UpdateReplicationSetActionMemberDeleteRegionAction 

type UpdateReplicationSetActionMemberDeleteRegionAction struct {
	Value DeleteRegionAction
	// contains filtered or unexported fields
}

Details about the Amazon Web Services Region that you're deleting to the replication set.

type ValidationException 

type ValidationException struct {
	Message *string

	ErrorCodeOverride *string
	// contains filtered or unexported fields
}

The input fails to satisfy the constraints specified by an Amazon Web Services service.

func (*ValidationException) Error 

func (e *ValidationException) Error() string

func (*ValidationException) ErrorCode 

func (e *ValidationException) ErrorCode() string

func (*ValidationException) ErrorFault 

func (e *ValidationException) ErrorFault() smithy.ErrorFault

func (*ValidationException) ErrorMessage 

func (e *ValidationException) ErrorMessage() string

type VariableType added in v1.14.0 

type VariableType string
const (
	VariableTypeIncidentRecordArn VariableType = "INCIDENT_RECORD_ARN"
	VariableTypeInvolvedResources VariableType = "INVOLVED_RESOURCES"
)

Enum values for VariableType

func (VariableType) Values added in v1.14.0 

func (VariableType) Values() []VariableType

Values returns all known values for VariableType. Note that this can be expanded in the future, and so it is only as up to date as the client. The ordering of this slice is not guaranteed to be stable across updates.

Source Files

View all Source files

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL
go.dev uses cookies from Google to deliver and enhance the quality of its services and to analyze traffic. Learn more.