Skip to content

TimeOffValidationResult

Source code in docs_src/capo_connectscheduling/types/time_off_validation_result.py
class TimeOffValidationResult(TypedDict, closed=True):
    severity: "capo_connectscheduling.types.time_off_validation_severity.TimeOffValidationSeverity"
    """<p>The severity of the validation result. <code>WARNING</code> is a breach of the configured rules that is not enough to reject the request, either because of the rules configuration or because the caller sent <code>RuleFailureAction</code> <code>OVERRIDE</code>. <code>ERROR</code> is a reason the request was rejected.</p>"""
    code: "capo_connectscheduling.types.time_off_validation_code.TimeOffValidationCode"
    """<p>The specific reason for the validation result. New values may be added, so treat an unrecognized value as a generic failure of the reported severity.</p> <ul> <li> <p> <code>INSUFFICIENT_USER_TIME_OFF_BALANCE</code>: the user's time off balance for the activity is less than the time this request deducts. Connect Customer deducts only working time in the window. For details, see <a href="https://docs.aws.amazon.com/connect/latest/adminguide/upload-timeoff-balance.html#how-system-calculates-time-off-deductions">How the system calculates time off deductions</a> in the <i>Connect Customer Administrator Guide</i>.</p> </li> <li> <p> <code>INSUFFICIENT_GROUP_TIME_OFF_ALLOWANCE</code>: the time off allowance of the user's forecast group or demand group for the activity is too low for this request.</p> </li> <li> <p> <code>INSUFFICIENT_STAFFING_GROUP_TIME_OFF_ALLOWANCE</code>: the daily time off allowance of the user's staffing group for the activity is too low for this request.</p> </li> <li> <p> <code>CONFLICTING_TIME_OFF_REQUEST</code>: the request overlaps another time off request for the user that is <code>APPROVED</code> or being approved. Requests in <code>AWAITING_APPROVAL</code> don't count. For <code>CreateTimeOff</code> with <code>AUTOMATIC</code>, overlapping overtime and voluntary time off also count.</p> </li> </ul>"""

code instance-attribute

The specific reason for the validation result. New values may be added, so treat an unrecognized value as a generic failure of the reported severity.

  • INSUFFICIENT_USER_TIME_OFF_BALANCE: the user's time off balance for the activity is less than the time this request deducts. Connect Customer deducts only working time in the window. For details, see How the system calculates time off deductions in the Connect Customer Administrator Guide.

  • INSUFFICIENT_GROUP_TIME_OFF_ALLOWANCE: the time off allowance of the user's forecast group or demand group for the activity is too low for this request.

  • INSUFFICIENT_STAFFING_GROUP_TIME_OFF_ALLOWANCE: the daily time off allowance of the user's staffing group for the activity is too low for this request.

  • CONFLICTING_TIME_OFF_REQUEST: the request overlaps another time off request for the user that is APPROVED or being approved. Requests in AWAITING_APPROVAL don't count. For CreateTimeOff with AUTOMATIC, overlapping overtime and voluntary time off also count.

severity instance-attribute

The severity of the validation result. WARNING is a breach of the configured rules that is not enough to reject the request, either because of the rules configuration or because the caller sent RuleFailureAction OVERRIDE. ERROR is a reason the request was rejected.