types

package
v1.17.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: 0

Documentation

Index

Constants

This section is empty.

Variables

This section is empty.

Functions

This section is empty.

Types

type AcceptCodeValidation added in v1.3.0 

type AcceptCodeValidation string
const (
	AcceptCodeValidationIgnore  AcceptCodeValidation = "IGNORE"
	AcceptCodeValidationEnforce AcceptCodeValidation = "ENFORCE"
)

Enum values for AcceptCodeValidation

func (AcceptCodeValidation) Values added in v1.3.0 

func (AcceptCodeValidation) Values() []AcceptCodeValidation

Values returns all known values for AcceptCodeValidation. 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 AcceptType 

type AcceptType string
const (
	AcceptTypeDelivered AcceptType = "DELIVERED"
	AcceptTypeRead      AcceptType = "READ"
)

Enum values for AcceptType

func (AcceptType) Values 

func (AcceptType) Values() []AcceptType

Values returns all known values for AcceptType. 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 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 ActivationStatus 

type ActivationStatus string
const (
	ActivationStatusActivated    ActivationStatus = "ACTIVATED"
	ActivationStatusNotActivated ActivationStatus = "NOT_ACTIVATED"
)

Enum values for ActivationStatus

func (ActivationStatus) Values 

func (ActivationStatus) Values() []ActivationStatus

Values returns all known values for ActivationStatus. 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 ChannelTargetInfo 

type ChannelTargetInfo struct {

	// The Amazon Resource Name (ARN) of the contact channel.
	//
	// This member is required.
	ContactChannelId *string

	// The number of minutes to wait to retry sending engagement in the case the
	// engagement initially fails.
	RetryIntervalInMinutes *int32
	// contains filtered or unexported fields
}

Information about the contact channel that Incident Manager uses to engage the contact.

type ChannelType 

type ChannelType string
const (
	ChannelTypeSms   ChannelType = "SMS"
	ChannelTypeVoice ChannelType = "VOICE"
	ChannelTypeEmail ChannelType = "EMAIL"
)

Enum values for ChannelType

func (ChannelType) Values 

func (ChannelType) Values() []ChannelType

Values returns all known values for ChannelType. 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 ConflictException 

type ConflictException struct {
	Message *string

	ErrorCodeOverride *string

	ResourceId        *string
	ResourceType      *string
	DependentEntities []DependentEntity
	// 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 Contact 

type Contact struct {

	// The unique and identifiable alias of the contact or escalation plan.
	//
	// This member is required.
	Alias *string

	// The Amazon Resource Name (ARN) of the contact or escalation plan.
	//
	// This member is required.
	ContactArn *string

	// Refers to the type of contact. A single contact is type PERSONAL and an
	// escalation plan is type ESCALATION .
	//
	// This member is required.
	Type ContactType

	// The full name of the contact or escalation plan.
	DisplayName *string
	// contains filtered or unexported fields
}

A personal contact or escalation plan that Incident Manager engages during an incident.

type ContactChannel 

type ContactChannel struct {

	// A Boolean value describing if the contact channel has been activated or not. If
	// the contact channel isn't activated, Incident Manager can't engage the contact
	// through it.
	//
	// This member is required.
	ActivationStatus ActivationStatus

	// The ARN of the contact that contains the contact channel.
	//
	// This member is required.
	ContactArn *string

	// The Amazon Resource Name (ARN) of the contact channel.
	//
	// This member is required.
	ContactChannelArn *string

	// The details that Incident Manager uses when trying to engage the contact
	// channel.
	//
	// This member is required.
	DeliveryAddress *ContactChannelAddress

	// The name of the contact channel.
	//
	// This member is required.
	Name *string

	// The type of the contact channel. Incident Manager supports three contact
	// methods:
	//   - SMS
	//   - VOICE
	//   - EMAIL
	Type ChannelType
	// contains filtered or unexported fields
}

The method that Incident Manager uses to engage a contact.

type ContactChannelAddress 

type ContactChannelAddress struct {

	// The format is dependent on the type of the contact channel. The following are
	// the expected formats:
	//   - SMS - '+' followed by the country code and phone number
	//   - VOICE - '+' followed by the country code and phone number
	//   - EMAIL - any standard email format
	SimpleAddress *string
	// contains filtered or unexported fields
}

The details that Incident Manager uses when trying to engage the contact channel.

type ContactTargetInfo 

type ContactTargetInfo struct {

	// A Boolean value determining if the contact's acknowledgement stops the progress
	// of stages in the plan.
	//
	// This member is required.
	IsEssential *bool

	// The Amazon Resource Name (ARN) of the contact.
	ContactId *string
	// contains filtered or unexported fields
}

The contact that Incident Manager is engaging during an incident.

type ContactType 

type ContactType string
const (
	ContactTypePersonal       ContactType = "PERSONAL"
	ContactTypeEscalation     ContactType = "ESCALATION"
	ContactTypeOncallSchedule ContactType = "ONCALL_SCHEDULE"
)

Enum values for ContactType

func (ContactType) Values 

func (ContactType) Values() []ContactType

Values returns all known values for ContactType. 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 CoverageTime added in v1.15.0 

type CoverageTime struct {

	// Information about when the on-call rotation shift ends.
	End *HandOffTime

	// Information about when the on-call rotation shift begins.
	Start *HandOffTime
	// contains filtered or unexported fields
}

Information about when an on-call shift begins and ends.

type DataEncryptionException 

type DataEncryptionException struct {
	Message *string

	ErrorCodeOverride *string
	// contains filtered or unexported fields
}

The operation failed to due an encryption key error.

func (*DataEncryptionException) Error 

func (e *DataEncryptionException) Error() string

func (*DataEncryptionException) ErrorCode 

func (e *DataEncryptionException) ErrorCode() string

func (*DataEncryptionException) ErrorFault 

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

func (*DataEncryptionException) ErrorMessage 

func (e *DataEncryptionException) ErrorMessage() string

type DayOfWeek added in v1.15.0 

type DayOfWeek string
const (
	DayOfWeekMon DayOfWeek = "MON"
	DayOfWeekTue DayOfWeek = "TUE"
	DayOfWeekWed DayOfWeek = "WED"
	DayOfWeekThu DayOfWeek = "THU"
	DayOfWeekFri DayOfWeek = "FRI"
	DayOfWeekSat DayOfWeek = "SAT"
	DayOfWeekSun DayOfWeek = "SUN"
)

Enum values for DayOfWeek

func (DayOfWeek) Values added in v1.15.0 

func (DayOfWeek) Values() []DayOfWeek

Values returns all known values for DayOfWeek. 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 DependentEntity added in v1.15.0 

type DependentEntity struct {

	// The Amazon Resource Names (ARNs) of the dependent resources.
	//
	// This member is required.
	DependentResourceIds []string

	// The type of relationship between one resource and the other resource that it is
	// related to or depends on.
	//
	// This member is required.
	RelationType *string
	// contains filtered or unexported fields
}

Information about a resource that another resource is related to or depends on. For example, if a contact is a member of a rotation, the rotation is a dependent entity of the contact.

type Engagement 

type Engagement struct {

	// The ARN of the escalation plan or contact that Incident Manager is engaging.
	//
	// This member is required.
	ContactArn *string

	// The Amazon Resource Name (ARN) of the engagement.
	//
	// This member is required.
	EngagementArn *string

	// The user that started the engagement.
	//
	// This member is required.
	Sender *string

	// The ARN of the incident that's engaging the contact.
	IncidentId *string

	// The time that the engagement began.
	StartTime *time.Time

	// The time that the engagement ended.
	StopTime *time.Time
	// contains filtered or unexported fields
}

Incident Manager reaching out to a contact or escalation plan to engage contact during an incident.

type HandOffTime added in v1.15.0 

type HandOffTime struct {

	// The hour when an on-call rotation shift begins or ends.
	//
	// This member is required.
	HourOfDay int32

	// The minute when an on-call rotation shift begins or ends.
	//
	// This member is required.
	MinuteOfHour int32
	// contains filtered or unexported fields
}

Details about when an on-call rotation shift begins or ends.

type InternalServerException 

type InternalServerException struct {
	Message *string

	ErrorCodeOverride *string

	RetryAfterSeconds int32
	// contains filtered or unexported fields
}

Unexpected error occurred while processing the request.

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 MonthlySetting added in v1.15.0 

type MonthlySetting struct {

	// The day of the month when monthly recurring on-call rotations begin.
	//
	// This member is required.
	DayOfMonth *int32

	// The time of day when a monthly recurring on-call shift rotation begins.
	//
	// This member is required.
	HandOffTime *HandOffTime
	// contains filtered or unexported fields
}

Information about on-call rotations that recur monthly.

type Page 

type Page struct {

	// The ARN of the contact that Incident Manager is engaging.
	//
	// This member is required.
	ContactArn *string

	// The ARN of the engagement that this page is part of.
	//
	// This member is required.
	EngagementArn *string

	// The Amazon Resource Name (ARN) of the page to the contact channel.
	//
	// This member is required.
	PageArn *string

	// The user that started the engagement.
	//
	// This member is required.
	Sender *string

	// The time the message was delivered to the contact channel.
	DeliveryTime *time.Time

	// The ARN of the incident that's engaging the contact channel.
	IncidentId *string

	// The time that the contact channel acknowledged engagement.
	ReadTime *time.Time

	// The time that Incident Manager engaged the contact channel.
	SentTime *time.Time
	// contains filtered or unexported fields
}

Incident Manager engaging a contact's contact channel.

type Plan 

type Plan struct {

	// The Amazon Resource Names (ARNs) of the on-call rotations associated with the
	// plan.
	RotationIds []string

	// A list of stages that the escalation plan or engagement plan uses to engage
	// contacts and contact methods.
	Stages []Stage
	// contains filtered or unexported fields
}

Information about the stages and on-call rotation teams associated with an escalation plan or engagement plan.

type PreviewOverride added in v1.15.0 

type PreviewOverride struct {

	// Information about the time a rotation override would end.
	EndTime *time.Time

	// Information about contacts to add to an on-call rotation override.
	NewMembers []string

	// Information about the time a rotation override would begin.
	StartTime *time.Time
	// contains filtered or unexported fields
}

Information about contacts and times that an on-call override replaces.

type Receipt 

type Receipt struct {

	// The time receipt was SENT , DELIVERED , or READ .
	//
	// This member is required.
	ReceiptTime *time.Time

	// The type follows the engagement cycle, SENT , DELIVERED , and READ .
	//
	// This member is required.
	ReceiptType ReceiptType

	// The Amazon Resource Name (ARN) of the contact channel Incident Manager engaged.
	ContactChannelArn *string

	// Information provided during the page acknowledgement.
	ReceiptInfo *string
	// contains filtered or unexported fields
}

Records events during an engagement.

type ReceiptType 

type ReceiptType string
const (
	ReceiptTypeDelivered ReceiptType = "DELIVERED"
	ReceiptTypeError     ReceiptType = "ERROR"
	ReceiptTypeRead      ReceiptType = "READ"
	ReceiptTypeSent      ReceiptType = "SENT"
	ReceiptTypeStop      ReceiptType = "STOP"
)

Enum values for ReceiptType

func (ReceiptType) Values 

func (ReceiptType) Values() []ReceiptType

Values returns all known values for ReceiptType. 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 RecurrenceSettings added in v1.15.0 

type RecurrenceSettings struct {

	// The number of contacts, or shift team members designated to be on call
	// concurrently during a shift. For example, in an on-call schedule containing ten
	// contacts, a value of 2 designates that two of them are on call at any given
	// time.
	//
	// This member is required.
	NumberOfOnCalls *int32

	// The number of days, weeks, or months a single rotation lasts.
	//
	// This member is required.
	RecurrenceMultiplier *int32

	// Information about on-call rotations that recur daily.
	DailySettings []HandOffTime

	// Information about on-call rotations that recur monthly.
	MonthlySettings []MonthlySetting

	// Information about the days of the week included in on-call rotation coverage.
	ShiftCoverages map[string][]CoverageTime

	// Information about on-call rotations that recur weekly.
	WeeklySettings []WeeklySetting
	// contains filtered or unexported fields
}

Information about when an on-call rotation is in effect and how long the rotation period lasts.

type ResolutionContact added in v1.15.0 

type ResolutionContact struct {

	// The Amazon Resource Name (ARN) of a contact in the engagement resolution
	// process.
	//
	// This member is required.
	ContactArn *string

	// The type of contact for a resolution step.
	//
	// This member is required.
	Type ContactType

	// The stage in the escalation plan that resolves to this contact.
	StageIndex *int32
	// contains filtered or unexported fields
}

Information about the engagement resolution steps. The resolution starts from the first contact, which can be an escalation plan, then resolves to an on-call rotation, and finally to a personal contact. The ResolutionContact structure describes the information for each node or step in that process. It contains information about different contact types, such as the escalation, rotation, and personal contacts.

type ResourceNotFoundException 

type ResourceNotFoundException struct {
	Message *string

	ErrorCodeOverride *string

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

Request references a resource that 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 Rotation added in v1.15.0 

type Rotation struct {

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

	// The Amazon Resource Name (ARN) of the rotation.
	//
	// This member is required.
	RotationArn *string

	// The Amazon Resource Names (ARNs) of the contacts assigned to the rotation team.
	ContactIds []string

	// Information about when an on-call rotation is in effect and how long the
	// rotation period lasts.
	Recurrence *RecurrenceSettings

	// The date and time the rotation becomes active.
	StartTime *time.Time

	// The time zone the rotation’s activity is based on, in Internet Assigned Numbers
	// Authority (IANA) format. For example: "America/Los_Angeles", "UTC", or
	// "Asia/Seoul".
	TimeZoneId *string
	// contains filtered or unexported fields
}

Information about a rotation in an on-call schedule.

type RotationOverride added in v1.15.0 

type RotationOverride struct {

	// The time a rotation override was created.
	//
	// This member is required.
	CreateTime *time.Time

	// The time a rotation override ends.
	//
	// This member is required.
	EndTime *time.Time

	// The Amazon Resource Names (ARNs) of the contacts assigned to the override of
	// the on-call rotation.
	//
	// This member is required.
	NewContactIds []string

	// The Amazon Resource Name (ARN) of the override to an on-call rotation.
	//
	// This member is required.
	RotationOverrideId *string

	// The time a rotation override begins.
	//
	// This member is required.
	StartTime *time.Time
	// contains filtered or unexported fields
}

Information about an override specified for an on-call rotation.

type RotationShift added in v1.15.0 

type RotationShift struct {

	// The time a shift rotation ends.
	//
	// This member is required.
	EndTime *time.Time

	// The time a shift rotation begins.
	//
	// This member is required.
	StartTime *time.Time

	// The Amazon Resource Names (ARNs) of the contacts who are part of the shift
	// rotation.
	ContactIds []string

	// Additional information about an on-call rotation shift.
	ShiftDetails *ShiftDetails

	// The type of shift rotation.
	Type ShiftType
	// contains filtered or unexported fields
}

Information about a shift that belongs to an on-call rotation.

type ServiceQuotaExceededException 

type ServiceQuotaExceededException struct {
	Message *string

	ErrorCodeOverride *string

	ResourceId   *string
	ResourceType *string
	QuotaCode    *string
	ServiceCode  *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 ShiftDetails added in v1.15.0 

type ShiftDetails struct {

	// The Amazon Resources Names (ARNs) of the contacts who were replaced in a shift
	// when an override was created. If the override is deleted, these contacts are
	// restored to the shift.
	//
	// This member is required.
	OverriddenContactIds []string
	// contains filtered or unexported fields
}

Information about overrides to an on-call rotation shift.

type ShiftType added in v1.15.0 

type ShiftType string
const (
	ShiftTypeRegular    ShiftType = "REGULAR"
	ShiftTypeOverridden ShiftType = "OVERRIDDEN"
)

Enum values for ShiftType

func (ShiftType) Values added in v1.15.0 

func (ShiftType) Values() []ShiftType

Values returns all known values for ShiftType. 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 Stage 

type Stage struct {

	// The time to wait until beginning the next stage. The duration can only be set
	// to 0 if a target is specified.
	//
	// This member is required.
	DurationInMinutes *int32

	// The contacts or contact methods that the escalation plan or engagement plan is
	// engaging.
	//
	// This member is required.
	Targets []Target
	// contains filtered or unexported fields
}

A set amount of time that an escalation plan or engagement plan engages the specified contacts or contact methods.

type Tag 

type Tag struct {

	// Name of the object key.
	Key *string

	// Value of the tag.
	Value *string
	// contains filtered or unexported fields
}

A container of a key-value name pair.

type Target 

type Target struct {

	// Information about the contact channel Incident Manager is engaging.
	ChannelTargetInfo *ChannelTargetInfo

	// Information about the contact that Incident Manager is engaging.
	ContactTargetInfo *ContactTargetInfo
	// contains filtered or unexported fields
}

The contact or contact channel that's being engaged.

type ThrottlingException 

type ThrottlingException struct {
	Message *string

	ErrorCodeOverride *string

	QuotaCode         *string
	ServiceCode       *string
	RetryAfterSeconds int32
	// 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 TimeRange 

type TimeRange struct {

	// The end of the time range.
	EndTime *time.Time

	// The start of the time range.
	StartTime *time.Time
	// contains filtered or unexported fields
}

A range of between two set times

type ValidationException 

type ValidationException struct {
	Message *string

	ErrorCodeOverride *string

	Reason ValidationExceptionReason
	Fields []ValidationExceptionField
	// 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 ValidationExceptionField 

type ValidationExceptionField struct {

	// Information about what caused the field to cause an exception.
	//
	// This member is required.
	Message *string

	// The name of the field that caused the exception.
	//
	// This member is required.
	Name *string
	// contains filtered or unexported fields
}

Provides information about which field caused the exception.

type ValidationExceptionReason 

type ValidationExceptionReason string
const (
	ValidationExceptionReasonUnknownOperation      ValidationExceptionReason = "UNKNOWN_OPERATION"
	ValidationExceptionReasonCannotParse           ValidationExceptionReason = "CANNOT_PARSE"
	ValidationExceptionReasonFieldValidationFailed ValidationExceptionReason = "FIELD_VALIDATION_FAILED"
	ValidationExceptionReasonOther                 ValidationExceptionReason = "OTHER"
)

Enum values for ValidationExceptionReason

func (ValidationExceptionReason) Values 

func (ValidationExceptionReason) Values() []ValidationExceptionReason

Values returns all known values for ValidationExceptionReason. 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 WeeklySetting added in v1.15.0 

type WeeklySetting struct {

	// The day of the week when weekly recurring on-call shift rotations begins.
	//
	// This member is required.
	DayOfWeek DayOfWeek

	// The time of day when a weekly recurring on-call shift rotation begins.
	//
	// This member is required.
	HandOffTime *HandOffTime
	// contains filtered or unexported fields
}

Information about rotations that recur weekly.

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.