ConnectScheduling / Client / create_time_off
create_time_off¶
- ConnectScheduling.Client.create_time_off(**kwargs)¶
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
GetTimeOffor use the time off state-change events.ApprovalTypecontrols 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.
ApprovalTypealone decides whether the request waits for approval. The operation fails withValidationExceptiononUserIdin 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
CancelTimeOffand create a new request. The new request has a newTimeOffId.Note
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
ApprovalTypeAUTOMATICwithRuleFailureActionOVERRIDEand 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.
See also: AWS API Documentation
Request Syntax
response = client.create_time_off( InstanceId='string', UserId='string', ShiftActivityId='string', StartAt=datetime(2015, 1, 1), EndAt=datetime(2015, 1, 1), Description='string', ApprovalType='AWAIT_APPROVAL'|'AUTOMATIC', RuleFailureAction='REJECT'|'OVERRIDE', ClientToken='string' )
- Parameters:
InstanceId (string) –
[REQUIRED]
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.
UserId (string) –
[REQUIRED]
The identifier of the user who the time off request is for. This can be the ID or the ARN of the user.
ShiftActivityId (string) –
[REQUIRED]
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.
StartAt (datetime) –
[REQUIRED]
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.
EndAt (datetime) –
[REQUIRED]
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 (string) – A description recorded on the time off request. If you omit it, the request has no description.
ApprovalType (string) –
[REQUIRED]
Controls who approves the request.
AWAIT_APPROVALwaits for anApproveTimeOfforRejectTimeOffcall.AUTOMATIChas Connect Customer decide the request. For details, seeCreateTimeOff.RuleFailureAction (string) – 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.ClientToken (string) –
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.This field is autopopulated if not provided.
- Return type:
dict
- Returns:
Response Syntax
{ 'TimeOffId': 'string' }
Response Structure
(dict) –
The response for
CreateTimeOff.TimeOffId (string) –
The identifier of the time off request.
Exceptions