Package-level declarations

Types

Link copied to clipboard
data class ContactChannelTargetInfo(val channelId: String, val retryIntervalInMinutes: Int)

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

Link copied to clipboard
data class ContactStage(val durationInMinutes: Int? = null, val rotationIds: List<String>? = null, val targets: List<ContactTargets>? = null)

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

Link copied to clipboard
data class ContactTargetInfo(val contactId: String, val isEssential: Boolean)

The contact that SSM Incident Manager is engaging during an incident.

Link copied to clipboard
data class ContactTargets(val channelTargetInfo: ContactChannelTargetInfo? = null, val contactTargetInfo: ContactTargetInfo? = null)

The contacts or contact methods that the escalation plan or engagement plan is engaging.

Link copied to clipboard
data class GetContactChannelResult(val arn: String? = null, val channelAddress: String? = null, val channelName: String? = null)
Link copied to clipboard
data class GetContactResult(val arn: String? = null, val displayName: String? = null, val tags: List<Tag>? = null)
Link copied to clipboard
data class GetPlanResult(val arn: String? = null, val stages: List<PlanStage>? = null)
Link copied to clipboard
data class GetRotationResult(val arn: String? = null, val contactIds: List<String>? = null, val name: String? = null, val recurrence: RotationRecurrenceSettings? = null, val startTime: String? = null, val tags: List<Tag>? = null, val timeZoneId: String? = null)
Link copied to clipboard
data class PlanChannelTargetInfo(val channelId: String, val retryIntervalInMinutes: Int)

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

Link copied to clipboard
data class PlanContactTargetInfo(val contactId: String, val isEssential: Boolean)

The contact that SSM Incident Manager is engaging during an incident.

Link copied to clipboard
data class PlanStage(val durationInMinutes: Int, val targets: List<PlanTargets>? = null)

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

Link copied to clipboard
data class PlanTargets(val channelTargetInfo: PlanChannelTargetInfo? = null, val contactTargetInfo: PlanContactTargetInfo? = null)

The contacts or contact methods that the escalation plan or engagement plan is engaging.

Link copied to clipboard
data class RotationCoverageTime(val endTime: String, val startTime: String)

StartTime and EndTime for the Shift

Link copied to clipboard
data class RotationMonthlySetting(val dayOfMonth: Int, val handOffTime: String)

DayOfWeek for Month and HandOff Time for Monthly Recurring Rotation.

Link copied to clipboard
data class RotationRecurrenceSettings(val dailySettings: List<String>? = null, val monthlySettings: List<RotationMonthlySetting>? = null, val numberOfOnCalls: Int? = null, val recurrenceMultiplier: Int? = null, val shiftCoverages: List<RotationShiftCoverage>? = null, val weeklySettings: List<RotationWeeklySetting>? = null)

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

Link copied to clipboard
data class RotationShiftCoverage(val coverageTimes: List<RotationCoverageTime>, val dayOfWeek: RotationDayOfWeek)

Information about the days of the week included in on-call rotation coverage.

Link copied to clipboard
data class RotationWeeklySetting(val dayOfWeek: RotationDayOfWeek, val handOffTime: String)

DayOfWeek for Rotation and HandOff Time for Weekly Recurring Rotation.