create_time_off
async
¶
create_time_off(
instance_id: InstanceIdOrArn,
user_id: UserIdOrArn,
shift_activity_id: ShiftActivityIdOrArn,
start_at: datetime,
end_at: datetime,
approval_type: ApprovalType,
*,
config_overrides: Optional[AsyncConnectSchedulingClientConfig] = None,
description: Optional[Description] = None,
rule_failure_action: Optional[RuleFailureAction] = None,
client_token: Optional[ClientToken] = None,
) -> CreateTimeOffResponse
Creates a time off request for a user. You don't provide a status, because Connect Customer owns the request lifecycle. To get the decided status, call GetTimeOff or use the time off state-change events.
ApprovalType controls who approves the request. You can specify one of the following values:
-
AWAIT_APPROVAL: the request waits inAWAITING_APPROVALuntil you callApproveTimeOfforRejectTimeOff. Rule evaluation and the overlap check run at approval, not at creation. A waiting request doesn't reserve its window, so another request for the same window can be approved first. -
AUTOMATIC: Connect Customer evaluates the rules (time off balances and group allowances) and decides the request. The request can bePENDINGwhile Connect Customer decides, and then endsAPPROVEDorREJECTED. If it overlaps another time off request for the user, the requested time off endsREJECTEDwithCONFLICTING_TIME_OFF_REQUEST. It also endsREJECTEDif it overlaps overtime or voluntary time off. If the whole window is in the past, Connect Customer records failed rules asWARNINGand doesn't reject the request, whatever theRuleFailureAction.
The staffing group's Supervisor approval needed setting doesn't apply to this operation. ApprovalType alone decides whether the request waits for approval. The operation fails with ValidationException on UserId in the following cases:
-
The user isn't in a staffing group, or the staffing group isn't associated with a forecast group.
-
Time off isn't enabled for the user's staffing group, or the user's staff rules don't allow time off.
To change the dates of a request, cancel it with CancelTimeOff and create a new request. The new request has a new TimeOffId.
Connect Customer doesn't check whether the principal that calls this operation supervises the user. The staffing group's approval settings also don't apply. IAM permissions are the only control. If you allow a principal to call this operation, that principal can send ApprovalType AUTOMATIC with RuleFailureAction OVERRIDE and approve a request past failed rules. Grant permission for this operation only to principals that you trust to override time off rules.
For information about time off in the Connect Customer admin website, see Time off management in the Connect Customer Administrator Guide.
Parameters:
-
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.
-
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.
-
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(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.
-
end_at(datetime) –The end of the time off window, exclusive. It must be after
StartAtand no later than 24 months after the current date. Connect Customer stores the value as sent, to the millisecond. -
description(Optional[Description], default:None) –A description recorded on the time off request. If you omit it, the request has no description.
-
approval_type(ApprovalType) –Controls who approves the request.
AWAIT_APPROVALwaits for anApproveTimeOfforRejectTimeOffcall.AUTOMATIChas Connect Customer decide the request. For details, seeCreateTimeOff. -
rule_failure_action(Optional[RuleFailureAction], default:None) –Controls what happens when a configured rule fails.
REJECT, the default, records anERRORand ends the requestREJECTED, unless the whole window is in the past.OVERRIDErecords aWARNINGand ends the requestAPPROVED, like the Override time off rules option in the Connect Customer admin website.OVERRIDErequiresAUTOMATIC. WithAWAIT_APPROVAL,OVERRIDEfails withValidationException. Set it onApproveTimeOffinstead.OVERRIDEnever waivesCONFLICTING_TIME_OFF_REQUEST. -
client_token(Optional[ClientToken], default:None) –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.
Raises:
-
AccessDeniedException–You do not have sufficient permissions to perform this action.
-
ConflictException–The request could not be processed because of a conflict with the current state of the resource.
-
InternalServerException–The request processing failed because of an error or failure with the service.
-
ResourceNotFoundException–The specified resource was not found.
-
ServiceQuotaExceededException–The request would cause a service quota to be exceeded.
-
ThrottlingException–The request was denied due to request throttling.
-
ValidationException–The input fails to satisfy the constraints specified by an AWS service.
-
UnknownServiceError–The service returned an error code this client does not model.
Examples:
To create a time off request that waits for approval The following example creates a time off request for one day. The request is created in AWAITING_APPROVAL until an ApproveTimeOff or RejectTimeOff call decides it.
>>> await client.create_time_off(instance_id='12345678-1234-1234-1234-123456789012', user_id='87654321-4321-4321-4321-210987654321', shift_activity_id='11112222-3333-4444-5555-666677778888', start_at=1795424400, end_at=1795453200, description='Family event', approval_type='AWAIT_APPROVAL')
Source code in docs_src/capo_connectscheduling/_services/async_connect_scheduling.py
347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 | |