CreateTimeOffRequest
¶
Source code in docs_src/capo_connectscheduling/types/create_time_off_request.py
approval_type
instance-attribute
¶
approval_type: ApprovalType
Controls who approves the request. AWAIT_APPROVAL waits for an ApproveTimeOff or RejectTimeOff call. AUTOMATIC has Connect Customer decide the request. For details, see CreateTimeOff.
client_token
instance-attribute
¶
client_token: NotRequired[ClientToken]
A unique, case-sensitive identifier that you provide to ensure that the operation completes no more than one time. If this token matches a previous request, Connect Customer returns the result of that request and doesn't create another time off request. If you don't provide a token, the AWS SDK populates this field. If you reuse a client token with a different request body, the request fails with ValidationException. For more information about idempotency, see Making retries safe with idempotent APIs.
description
instance-attribute
¶
description: NotRequired[Description]
A description recorded on the time off request. If you omit it, the request has no description.
end_at
instance-attribute
¶
end_at: datetime
The end of the time off window, exclusive. It must be after StartAt and no later than 24 months after the current date. Connect Customer stores the value as sent, to the millisecond.
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 ends the request REJECTED, unless the whole window is in the past. OVERRIDE records a WARNING and ends the request APPROVED, like the Override time off rules option in the Connect Customer admin website. OVERRIDE requires AUTOMATIC. With AWAIT_APPROVAL, OVERRIDE fails with ValidationException. Set it on ApproveTimeOff instead. OVERRIDE never waives CONFLICTING_TIME_OFF_REQUEST.
shift_activity_id
instance-attribute
¶
shift_activity_id: ShiftActivityIdOrArn
The identifier of the shift activity that defines the type of time off being requested. This can be the ID or the ARN of the shift activity. It must be a time off activity. Activities that aren't set as Requestable are accepted.
start_at
instance-attribute
¶
start_at: datetime
The start of the time off window, inclusive. It must be no earlier than one year before the current date. Connect Customer stores the value as sent, to the millisecond.
user_id
instance-attribute
¶
user_id: UserIdOrArn
The identifier of the user who the time off request is for. This can be the ID or the ARN of the user.