Skip to content

ApproveTimeOffRequest

Source code in docs_src/capo_connectscheduling/types/approve_time_off_request.py
class ApproveTimeOffRequest(TypedDict, closed=True):
    instance_id: "capo_connectscheduling.types.instance_id_or_arn.InstanceIdOrArn"
    """<p>The identifier of the Connect Customer instance. This can be the ID or the ARN of the instance. You can <a href="https://docs.aws.amazon.com/connect/latest/adminguide/find-instance-arn.html">find the instance ID</a> in the Amazon Resource Name (ARN) of the instance.</p>"""
    user_id: "capo_connectscheduling.types.user_id_or_arn.UserIdOrArn"
    """<p>The identifier of the user who the time off request belongs to. This can be the ID or the ARN of the user.</p>"""
    time_off_id: "capo_connectscheduling.types.time_off_id.TimeOffId"
    """<p>The unique identifier of the time off request to approve. If the time off request doesn't belong to <code>UserId</code>, the operation returns <code>ResourceNotFoundException</code>.</p>"""
    description: NotRequired["capo_connectscheduling.types.description.Description"]
    """<p>A description recorded with the approval. <code>GetTimeOff</code> doesn't return it.</p>"""
    rule_failure_action: NotRequired[
        "capo_connectscheduling.types.rule_failure_action.RuleFailureAction"
    ]
    """<p>Controls what happens when a configured rule fails. <code>REJECT</code>, the default, records an <code>ERROR</code> and leaves the request <code>REJECTED</code>. <code>OVERRIDE</code> records a <code>WARNING</code> and approves the request, like the <i>Override time off rules</i> option in the Connect Customer admin website. <code>OVERRIDE</code> never waives <code>CONFLICTING_TIME_OFF_REQUEST</code>.</p>"""

description instance-attribute

description: NotRequired[Description]

A description recorded with the approval. GetTimeOff doesn't return it.

instance_id instance-attribute

instance_id: InstanceIdOrArn

The identifier of the Connect Customer instance. This can be the ID or the ARN of the instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.

rule_failure_action instance-attribute

rule_failure_action: NotRequired[RuleFailureAction]

Controls what happens when a configured rule fails. REJECT, the default, records an ERROR and leaves the request REJECTED. OVERRIDE records a WARNING and approves the request, like the Override time off rules option in the Connect Customer admin website. OVERRIDE never waives CONFLICTING_TIME_OFF_REQUEST.

time_off_id instance-attribute

time_off_id: TimeOffId

The unique identifier of the time off request to approve. If the time off request doesn't belong to UserId, the operation returns ResourceNotFoundException.

user_id instance-attribute

user_id: UserIdOrArn

The identifier of the user who the time off request belongs to. This can be the ID or the ARN of the user.