ConnectScheduling / Client / put_time_off_balance
put_time_off_balance¶
- ConnectScheduling.Client.put_time_off_balance(**kwargs)¶
Sets the time off balance for one user and shift activity. The value replaces the existing balance rather than adjusting it, so you can safely retry the call. This operation can’t remove a balance. To remove one, upload a blank balance in the Connect Customer admin website. For more information, see Import an agent’s time off balance in the Connect Customer Administrator Guide.
See also: AWS API Documentation
Request Syntax
response = client.put_time_off_balance( InstanceId='string', UserId='string', ShiftActivityId='string', Balance={ 'Value': 123, 'Unit': 'MINUTES'|'HOURS'|'DAYS' } )
- 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 whose balance is being updated. This can be the ID or the ARN of the user.
ShiftActivityId (string) –
[REQUIRED]
The identifier of the shift activity that the balance applies to. This can be the ID or the ARN of the shift activity.
Balance (dict) –
[REQUIRED]
The new time off balance for the user and activity. It replaces the existing balance.
Value (integer) – [REQUIRED]
The number of units of time. You can use a negative value to report an overdrawn balance. The value must be within 876,000 hours (100 years) of zero: at most 52,560,000
MINUTES, 876,000HOURS, or 36,500DAYS.Unit (string) – [REQUIRED]
The unit the value is counted in.
- Return type:
dict
- Returns:
Response Syntax
{}Response Structure
(dict) –
The response for
PutTimeOffBalance.
Exceptions