aws-sdk-connectscheduling 1.0.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
@@ -0,0 +1,722 @@
1
+ # frozen_string_literal: true
2
+
3
+ # WARNING ABOUT GENERATED CODE
4
+ #
5
+ # This file is generated. See the contributing guide for more information:
6
+ # https://github.com/aws/aws-sdk-ruby/blob/version-3/CONTRIBUTING.md
7
+ #
8
+ # WARNING ABOUT GENERATED CODE
9
+
10
+ module Aws::ConnectScheduling
11
+ module Types
12
+
13
+ # You do not have sufficient permissions to perform this action.
14
+ #
15
+ # @!attribute [rw] message
16
+ # @return [String]
17
+ #
18
+ # @see http://docs.aws.amazon.com/goto/WebAPI/connectscheduling-2026-07-16/AccessDeniedException AWS API Documentation
19
+ #
20
+ class AccessDeniedException < Struct.new(
21
+ :message)
22
+ SENSITIVE = []
23
+ include Aws::Structure
24
+ end
25
+
26
+ # Information about the identity that performed an action on a time off
27
+ # request: a Connect Customer user or an IAM or AWS STS identity.
28
+ # Exactly one member is set.
29
+ #
30
+ # @note ActorInfo is a union - when returned from an API call exactly one value will be set and the returned type will be a subclass of ActorInfo corresponding to the set member.
31
+ #
32
+ # @!attribute [rw] connect_user_arn
33
+ # The ARN of the Connect Customer user who performed the action.
34
+ # @return [String]
35
+ #
36
+ # @!attribute [rw] aws_identity_arn
37
+ # The IAM or AWS STS ARN of the identity that performed the action.
38
+ # Present when that identity is not a Connect Customer user.
39
+ # @return [String]
40
+ #
41
+ # @see http://docs.aws.amazon.com/goto/WebAPI/connectscheduling-2026-07-16/ActorInfo AWS API Documentation
42
+ #
43
+ class ActorInfo < Struct.new(
44
+ :connect_user_arn,
45
+ :aws_identity_arn,
46
+ :unknown)
47
+ SENSITIVE = []
48
+ include Aws::Structure
49
+ include Aws::Structure::Union
50
+
51
+ class ConnectUserArn < ActorInfo; end
52
+ class AwsIdentityArn < ActorInfo; end
53
+ class Unknown < ActorInfo; end
54
+ end
55
+
56
+ # The request for `ApproveTimeOff`.
57
+ #
58
+ # @!attribute [rw] instance_id
59
+ # The identifier of the Connect Customer instance. This can be the ID
60
+ # or the ARN of the instance. You can [find the instance ID][1] in the
61
+ # Amazon Resource Name (ARN) of the instance.
62
+ #
63
+ #
64
+ #
65
+ # [1]: https://docs.aws.amazon.com/connect/latest/adminguide/find-instance-arn.html
66
+ # @return [String]
67
+ #
68
+ # @!attribute [rw] user_id
69
+ # The identifier of the user who the time off request belongs to. This
70
+ # can be the ID or the ARN of the user.
71
+ # @return [String]
72
+ #
73
+ # @!attribute [rw] time_off_id
74
+ # The unique identifier of the time off request to approve. If the
75
+ # time off request doesn't belong to `UserId`, the operation returns
76
+ # `ResourceNotFoundException`.
77
+ # @return [String]
78
+ #
79
+ # @!attribute [rw] description
80
+ # A description recorded with the approval. `GetTimeOff` doesn't
81
+ # return it.
82
+ # @return [String]
83
+ #
84
+ # @!attribute [rw] rule_failure_action
85
+ # Controls what happens when a configured rule fails. `REJECT`, the
86
+ # default, records an `ERROR` and leaves the request `REJECTED`.
87
+ # `OVERRIDE` records a `WARNING` and approves the request, like the
88
+ # *Override time off rules* option in the Connect Customer admin
89
+ # website. `OVERRIDE` never waives `CONFLICTING_TIME_OFF_REQUEST`.
90
+ # @return [String]
91
+ #
92
+ # @see http://docs.aws.amazon.com/goto/WebAPI/connectscheduling-2026-07-16/ApproveTimeOffRequest AWS API Documentation
93
+ #
94
+ class ApproveTimeOffRequest < Struct.new(
95
+ :instance_id,
96
+ :user_id,
97
+ :time_off_id,
98
+ :description,
99
+ :rule_failure_action)
100
+ SENSITIVE = [:description]
101
+ include Aws::Structure
102
+ end
103
+
104
+ # The response for `ApproveTimeOff`.
105
+ #
106
+ # @see http://docs.aws.amazon.com/goto/WebAPI/connectscheduling-2026-07-16/ApproveTimeOffResponse AWS API Documentation
107
+ #
108
+ class ApproveTimeOffResponse < Aws::EmptyStructure; end
109
+
110
+ # The request for `CancelTimeOff`.
111
+ #
112
+ # @!attribute [rw] instance_id
113
+ # The identifier of the Connect Customer instance. This can be the ID
114
+ # or the ARN of the instance. You can [find the instance ID][1] in the
115
+ # Amazon Resource Name (ARN) of the instance.
116
+ #
117
+ #
118
+ #
119
+ # [1]: https://docs.aws.amazon.com/connect/latest/adminguide/find-instance-arn.html
120
+ # @return [String]
121
+ #
122
+ # @!attribute [rw] user_id
123
+ # The identifier of the user who the time off request belongs to. This
124
+ # can be the ID or the ARN of the user.
125
+ # @return [String]
126
+ #
127
+ # @!attribute [rw] time_off_id
128
+ # The unique identifier of the time off request to cancel. If the time
129
+ # off request doesn't belong to `UserId`, the operation returns
130
+ # `ResourceNotFoundException`.
131
+ # @return [String]
132
+ #
133
+ # @!attribute [rw] description
134
+ # A description recorded with the cancellation. It replaces the
135
+ # description of the time off request. If you omit it, the request's
136
+ # description is removed.
137
+ # @return [String]
138
+ #
139
+ # @see http://docs.aws.amazon.com/goto/WebAPI/connectscheduling-2026-07-16/CancelTimeOffRequest AWS API Documentation
140
+ #
141
+ class CancelTimeOffRequest < Struct.new(
142
+ :instance_id,
143
+ :user_id,
144
+ :time_off_id,
145
+ :description)
146
+ SENSITIVE = [:description]
147
+ include Aws::Structure
148
+ end
149
+
150
+ # The response for `CancelTimeOff`.
151
+ #
152
+ # @see http://docs.aws.amazon.com/goto/WebAPI/connectscheduling-2026-07-16/CancelTimeOffResponse AWS API Documentation
153
+ #
154
+ class CancelTimeOffResponse < Aws::EmptyStructure; end
155
+
156
+ # The request could not be processed because of a conflict with the
157
+ # current state of the resource.
158
+ #
159
+ # @!attribute [rw] message
160
+ # @return [String]
161
+ #
162
+ # @!attribute [rw] resource_id
163
+ # The identifier or ARN of the resource that is in conflict.
164
+ # @return [String]
165
+ #
166
+ # @!attribute [rw] resource_type
167
+ # The type of the resource that is in conflict.
168
+ # @return [String]
169
+ #
170
+ # @see http://docs.aws.amazon.com/goto/WebAPI/connectscheduling-2026-07-16/ConflictException AWS API Documentation
171
+ #
172
+ class ConflictException < Struct.new(
173
+ :message,
174
+ :resource_id,
175
+ :resource_type)
176
+ SENSITIVE = []
177
+ include Aws::Structure
178
+ end
179
+
180
+ # The request for `CreateTimeOff`.
181
+ #
182
+ # @!attribute [rw] instance_id
183
+ # The identifier of the Connect Customer instance. This can be the ID
184
+ # or the ARN of the instance. You can [find the instance ID][1] in the
185
+ # Amazon Resource Name (ARN) of the instance.
186
+ #
187
+ #
188
+ #
189
+ # [1]: https://docs.aws.amazon.com/connect/latest/adminguide/find-instance-arn.html
190
+ # @return [String]
191
+ #
192
+ # @!attribute [rw] user_id
193
+ # The identifier of the user who the time off request is for. This can
194
+ # be the ID or the ARN of the user.
195
+ # @return [String]
196
+ #
197
+ # @!attribute [rw] shift_activity_id
198
+ # The identifier of the shift activity that defines the type of time
199
+ # off being requested. This can be the ID or the ARN of the shift
200
+ # activity. It must be a time off activity. Activities that aren't
201
+ # set as *Requestable* are accepted.
202
+ # @return [String]
203
+ #
204
+ # @!attribute [rw] start_at
205
+ # The start of the time off window, inclusive. It must be no earlier
206
+ # than one year before the current date. Connect Customer stores the
207
+ # value as sent, to the millisecond.
208
+ # @return [Time]
209
+ #
210
+ # @!attribute [rw] end_at
211
+ # The end of the time off window, exclusive. It must be after
212
+ # `StartAt` and no later than 24 months after the current date.
213
+ # Connect Customer stores the value as sent, to the millisecond.
214
+ # @return [Time]
215
+ #
216
+ # @!attribute [rw] description
217
+ # A description recorded on the time off request. If you omit it, the
218
+ # request has no description.
219
+ # @return [String]
220
+ #
221
+ # @!attribute [rw] approval_type
222
+ # Controls who approves the request. `AWAIT_APPROVAL` waits for an
223
+ # `ApproveTimeOff` or `RejectTimeOff` call. `AUTOMATIC` has Connect
224
+ # Customer decide the request. For details, see `CreateTimeOff`.
225
+ # @return [String]
226
+ #
227
+ # @!attribute [rw] rule_failure_action
228
+ # Controls what happens when a configured rule fails. `REJECT`, the
229
+ # default, records an `ERROR` and ends the request `REJECTED`, unless
230
+ # the whole window is in the past. `OVERRIDE` records a `WARNING` and
231
+ # ends the request `APPROVED`, like the *Override time off rules*
232
+ # option in the Connect Customer admin website. `OVERRIDE` requires
233
+ # `AUTOMATIC`. With `AWAIT_APPROVAL`, `OVERRIDE` fails with
234
+ # `ValidationException`. Set it on `ApproveTimeOff` instead.
235
+ # `OVERRIDE` never waives `CONFLICTING_TIME_OFF_REQUEST`.
236
+ # @return [String]
237
+ #
238
+ # @!attribute [rw] client_token
239
+ # A unique, case-sensitive identifier that you provide to ensure that
240
+ # the operation completes no more than one time. If this token matches
241
+ # a previous request, Connect Customer returns the result of that
242
+ # request and doesn't create another time off request. If you don't
243
+ # provide a token, the AWS SDK populates this field. If you reuse a
244
+ # client token with a different request body, the request fails with
245
+ # `ValidationException`. For more information about idempotency, see
246
+ # [Making retries safe with idempotent APIs][1].
247
+ #
248
+ # **A suitable default value is auto-generated.** You should normally
249
+ # not need to pass this option.
250
+ #
251
+ #
252
+ #
253
+ # [1]: https://aws.amazon.com/builders-library/making-retries-safe-with-idempotent-APIs/
254
+ # @return [String]
255
+ #
256
+ # @see http://docs.aws.amazon.com/goto/WebAPI/connectscheduling-2026-07-16/CreateTimeOffRequest AWS API Documentation
257
+ #
258
+ class CreateTimeOffRequest < Struct.new(
259
+ :instance_id,
260
+ :user_id,
261
+ :shift_activity_id,
262
+ :start_at,
263
+ :end_at,
264
+ :description,
265
+ :approval_type,
266
+ :rule_failure_action,
267
+ :client_token)
268
+ SENSITIVE = [:description]
269
+ include Aws::Structure
270
+ end
271
+
272
+ # The response for `CreateTimeOff`.
273
+ #
274
+ # @!attribute [rw] time_off_id
275
+ # The identifier of the time off request.
276
+ # @return [String]
277
+ #
278
+ # @see http://docs.aws.amazon.com/goto/WebAPI/connectscheduling-2026-07-16/CreateTimeOffResponse AWS API Documentation
279
+ #
280
+ class CreateTimeOffResponse < Struct.new(
281
+ :time_off_id)
282
+ SENSITIVE = []
283
+ include Aws::Structure
284
+ end
285
+
286
+ # A length of time, expressed as a value and the unit it is counted in.
287
+ #
288
+ # @!attribute [rw] value
289
+ # The number of units of time. You can use a negative value to report
290
+ # an overdrawn balance. The value must be within 876,000 hours (100
291
+ # years) of zero: at most 52,560,000 `MINUTES`, 876,000 `HOURS`, or
292
+ # 36,500 `DAYS`.
293
+ # @return [Integer]
294
+ #
295
+ # @!attribute [rw] unit
296
+ # The unit the value is counted in.
297
+ # @return [String]
298
+ #
299
+ # @see http://docs.aws.amazon.com/goto/WebAPI/connectscheduling-2026-07-16/Duration AWS API Documentation
300
+ #
301
+ class Duration < Struct.new(
302
+ :value,
303
+ :unit)
304
+ SENSITIVE = []
305
+ include Aws::Structure
306
+ end
307
+
308
+ # The request for `GetTimeOff`.
309
+ #
310
+ # @!attribute [rw] instance_id
311
+ # The identifier of the Connect Customer instance. This can be the ID
312
+ # or the ARN of the instance. You can [find the instance ID][1] in the
313
+ # Amazon Resource Name (ARN) of the instance.
314
+ #
315
+ #
316
+ #
317
+ # [1]: https://docs.aws.amazon.com/connect/latest/adminguide/find-instance-arn.html
318
+ # @return [String]
319
+ #
320
+ # @!attribute [rw] user_id
321
+ # The identifier of the user who the time off request belongs to. This
322
+ # can be the ID or the ARN of the user.
323
+ # @return [String]
324
+ #
325
+ # @!attribute [rw] time_off_id
326
+ # The identifier of the time off request. If the time off request
327
+ # doesn't belong to `UserId`, the operation returns
328
+ # `ResourceNotFoundException`.
329
+ # @return [String]
330
+ #
331
+ # @see http://docs.aws.amazon.com/goto/WebAPI/connectscheduling-2026-07-16/GetTimeOffRequest AWS API Documentation
332
+ #
333
+ class GetTimeOffRequest < Struct.new(
334
+ :instance_id,
335
+ :user_id,
336
+ :time_off_id)
337
+ SENSITIVE = []
338
+ include Aws::Structure
339
+ end
340
+
341
+ # The response for `GetTimeOff`.
342
+ #
343
+ # @!attribute [rw] time_off_id
344
+ # The identifier of the time off request.
345
+ # @return [String]
346
+ #
347
+ # @!attribute [rw] user_id
348
+ # The identifier of the user the time off is for.
349
+ # @return [String]
350
+ #
351
+ # @!attribute [rw] shift_activity_id
352
+ # The identifier of the shift activity for the time off request.
353
+ # @return [String]
354
+ #
355
+ # @!attribute [rw] start_at
356
+ # The start of the time off window, inclusive, as sent to
357
+ # `CreateTimeOff`.
358
+ # @return [Time]
359
+ #
360
+ # @!attribute [rw] end_at
361
+ # The end of the time off window, exclusive, as sent to
362
+ # `CreateTimeOff`.
363
+ # @return [Time]
364
+ #
365
+ # @!attribute [rw] status
366
+ # The status of the time off request.
367
+ #
368
+ # * `PENDING`: Connect Customer is processing a change to the request,
369
+ # which then changes to another status. An edit in the Connect
370
+ # Customer admin website can also make a request `PENDING`, so an
371
+ # `APPROVED` request can become `PENDING` and then end `APPROVED` or
372
+ # `REJECTED`.
373
+ #
374
+ # * `AWAITING_APPROVAL`: the request is waiting for an
375
+ # `ApproveTimeOff` or `RejectTimeOff` call.
376
+ # @return [String]
377
+ #
378
+ # @!attribute [rw] description
379
+ # The description of the time off request. `CreateTimeOff` sets it,
380
+ # and `CancelTimeOff` replaces or removes it. An edit in the Connect
381
+ # Customer admin website can also change it. `GetTimeOff` doesn't
382
+ # return descriptions sent with `ApproveTimeOff` or `RejectTimeOff`.
383
+ # @return [String]
384
+ #
385
+ # @!attribute [rw] validation_results
386
+ # Warnings or failures produced while processing the time off request.
387
+ # @return [Array<Types::TimeOffValidationResult>]
388
+ #
389
+ # @!attribute [rw] created_by
390
+ # The identity that created the request. Immutable for the life of the
391
+ # request.
392
+ # @return [Types::ActorInfo]
393
+ #
394
+ # @!attribute [rw] created_at
395
+ # The timestamp when the time off request was created.
396
+ # @return [Time]
397
+ #
398
+ # @!attribute [rw] updated_by
399
+ # The identity that made the most recent `ApproveTimeOff`,
400
+ # `RejectTimeOff`, or `CancelTimeOff` call on the request, or took the
401
+ # same action in the Connect Customer admin website. Absent until one
402
+ # of those actions is taken, including after Connect Customer decides
403
+ # an `AUTOMATIC` request. `UpdatedAt` also changes when a `PENDING`
404
+ # request changes to another status and for other edits, which don't
405
+ # set `UpdatedBy`.
406
+ # @return [Types::ActorInfo]
407
+ #
408
+ # @!attribute [rw] updated_at
409
+ # The timestamp when the time off request was last modified.
410
+ # @return [Time]
411
+ #
412
+ # @see http://docs.aws.amazon.com/goto/WebAPI/connectscheduling-2026-07-16/GetTimeOffResponse AWS API Documentation
413
+ #
414
+ class GetTimeOffResponse < Struct.new(
415
+ :time_off_id,
416
+ :user_id,
417
+ :shift_activity_id,
418
+ :start_at,
419
+ :end_at,
420
+ :status,
421
+ :description,
422
+ :validation_results,
423
+ :created_by,
424
+ :created_at,
425
+ :updated_by,
426
+ :updated_at)
427
+ SENSITIVE = [:description]
428
+ include Aws::Structure
429
+ end
430
+
431
+ # The request processing failed because of an error or failure with the
432
+ # service.
433
+ #
434
+ # @!attribute [rw] message
435
+ # @return [String]
436
+ #
437
+ # @!attribute [rw] retry_after_seconds
438
+ # The number of seconds to wait before retrying.
439
+ # @return [Integer]
440
+ #
441
+ # @see http://docs.aws.amazon.com/goto/WebAPI/connectscheduling-2026-07-16/InternalServerException AWS API Documentation
442
+ #
443
+ class InternalServerException < Struct.new(
444
+ :message,
445
+ :retry_after_seconds)
446
+ SENSITIVE = []
447
+ include Aws::Structure
448
+ end
449
+
450
+ # The request for `PutTimeOffBalance`.
451
+ #
452
+ # @!attribute [rw] instance_id
453
+ # The identifier of the Connect Customer instance. This can be the ID
454
+ # or the ARN of the instance. You can [find the instance ID][1] in the
455
+ # Amazon Resource Name (ARN) of the instance.
456
+ #
457
+ #
458
+ #
459
+ # [1]: https://docs.aws.amazon.com/connect/latest/adminguide/find-instance-arn.html
460
+ # @return [String]
461
+ #
462
+ # @!attribute [rw] user_id
463
+ # The identifier of the user whose balance is being updated. This can
464
+ # be the ID or the ARN of the user.
465
+ # @return [String]
466
+ #
467
+ # @!attribute [rw] shift_activity_id
468
+ # The identifier of the shift activity that the balance applies to.
469
+ # This can be the ID or the ARN of the shift activity.
470
+ # @return [String]
471
+ #
472
+ # @!attribute [rw] balance
473
+ # The new time off balance for the user and activity. It replaces the
474
+ # existing balance.
475
+ # @return [Types::Duration]
476
+ #
477
+ # @see http://docs.aws.amazon.com/goto/WebAPI/connectscheduling-2026-07-16/PutTimeOffBalanceRequest AWS API Documentation
478
+ #
479
+ class PutTimeOffBalanceRequest < Struct.new(
480
+ :instance_id,
481
+ :user_id,
482
+ :shift_activity_id,
483
+ :balance)
484
+ SENSITIVE = []
485
+ include Aws::Structure
486
+ end
487
+
488
+ # The response for `PutTimeOffBalance`.
489
+ #
490
+ # @see http://docs.aws.amazon.com/goto/WebAPI/connectscheduling-2026-07-16/PutTimeOffBalanceResponse AWS API Documentation
491
+ #
492
+ class PutTimeOffBalanceResponse < Aws::EmptyStructure; end
493
+
494
+ # The request for `RejectTimeOff`.
495
+ #
496
+ # @!attribute [rw] instance_id
497
+ # The identifier of the Connect Customer instance. This can be the ID
498
+ # or the ARN of the instance. You can [find the instance ID][1] in the
499
+ # Amazon Resource Name (ARN) of the instance.
500
+ #
501
+ #
502
+ #
503
+ # [1]: https://docs.aws.amazon.com/connect/latest/adminguide/find-instance-arn.html
504
+ # @return [String]
505
+ #
506
+ # @!attribute [rw] user_id
507
+ # The identifier of the user who the time off request belongs to. This
508
+ # can be the ID or the ARN of the user.
509
+ # @return [String]
510
+ #
511
+ # @!attribute [rw] time_off_id
512
+ # The unique identifier of the time off request to reject. If the time
513
+ # off request doesn't belong to `UserId`, the operation returns
514
+ # `ResourceNotFoundException`.
515
+ # @return [String]
516
+ #
517
+ # @!attribute [rw] description
518
+ # A description recorded with the rejection, such as the reason.
519
+ # `GetTimeOff` doesn't return it.
520
+ # @return [String]
521
+ #
522
+ # @see http://docs.aws.amazon.com/goto/WebAPI/connectscheduling-2026-07-16/RejectTimeOffRequest AWS API Documentation
523
+ #
524
+ class RejectTimeOffRequest < Struct.new(
525
+ :instance_id,
526
+ :user_id,
527
+ :time_off_id,
528
+ :description)
529
+ SENSITIVE = [:description]
530
+ include Aws::Structure
531
+ end
532
+
533
+ # The response for `RejectTimeOff`.
534
+ #
535
+ # @see http://docs.aws.amazon.com/goto/WebAPI/connectscheduling-2026-07-16/RejectTimeOffResponse AWS API Documentation
536
+ #
537
+ class RejectTimeOffResponse < Aws::EmptyStructure; end
538
+
539
+ # The specified resource was not found.
540
+ #
541
+ # @!attribute [rw] message
542
+ # @return [String]
543
+ #
544
+ # @!attribute [rw] resource_id
545
+ # The identifier or ARN of the resource that was not found.
546
+ # @return [String]
547
+ #
548
+ # @!attribute [rw] resource_type
549
+ # The type of the resource that was not found.
550
+ # @return [String]
551
+ #
552
+ # @see http://docs.aws.amazon.com/goto/WebAPI/connectscheduling-2026-07-16/ResourceNotFoundException AWS API Documentation
553
+ #
554
+ class ResourceNotFoundException < Struct.new(
555
+ :message,
556
+ :resource_id,
557
+ :resource_type)
558
+ SENSITIVE = []
559
+ include Aws::Structure
560
+ end
561
+
562
+ # The request would cause a service quota to be exceeded.
563
+ #
564
+ # @!attribute [rw] message
565
+ # @return [String]
566
+ #
567
+ # @!attribute [rw] quota_code
568
+ # The code of the quota that would be exceeded, for use with the
569
+ # Service Quotas API.
570
+ # @return [String]
571
+ #
572
+ # @!attribute [rw] service_code
573
+ # The code of the service that owns the quota.
574
+ # @return [String]
575
+ #
576
+ # @!attribute [rw] resource_id
577
+ # The identifier or ARN of the resource whose quota would be exceeded.
578
+ # @return [String]
579
+ #
580
+ # @!attribute [rw] resource_type
581
+ # The type of the resource whose quota would be exceeded.
582
+ # @return [String]
583
+ #
584
+ # @see http://docs.aws.amazon.com/goto/WebAPI/connectscheduling-2026-07-16/ServiceQuotaExceededException AWS API Documentation
585
+ #
586
+ class ServiceQuotaExceededException < Struct.new(
587
+ :message,
588
+ :quota_code,
589
+ :service_code,
590
+ :resource_id,
591
+ :resource_type)
592
+ SENSITIVE = []
593
+ include Aws::Structure
594
+ end
595
+
596
+ # The request was denied due to request throttling.
597
+ #
598
+ # @!attribute [rw] message
599
+ # @return [String]
600
+ #
601
+ # @!attribute [rw] quota_code
602
+ # The code of the quota that was throttled, for use with the Service
603
+ # Quotas API.
604
+ # @return [String]
605
+ #
606
+ # @!attribute [rw] service_code
607
+ # The code of the service that owns the quota.
608
+ # @return [String]
609
+ #
610
+ # @!attribute [rw] retry_after_seconds
611
+ # The number of seconds to wait before retrying.
612
+ # @return [Integer]
613
+ #
614
+ # @see http://docs.aws.amazon.com/goto/WebAPI/connectscheduling-2026-07-16/ThrottlingException AWS API Documentation
615
+ #
616
+ class ThrottlingException < Struct.new(
617
+ :message,
618
+ :quota_code,
619
+ :service_code,
620
+ :retry_after_seconds)
621
+ SENSITIVE = []
622
+ include Aws::Structure
623
+ end
624
+
625
+ # A warning or failure produced while processing the time off request.
626
+ #
627
+ # @!attribute [rw] severity
628
+ # The severity of the validation result. `WARNING` is a breach of the
629
+ # configured rules that is not enough to reject the request, either
630
+ # because of the rules configuration or because the caller sent
631
+ # `RuleFailureAction` `OVERRIDE`. `ERROR` is a reason the request was
632
+ # rejected.
633
+ # @return [String]
634
+ #
635
+ # @!attribute [rw] code
636
+ # The specific reason for the validation result. New values may be
637
+ # added, so treat an unrecognized value as a generic failure of the
638
+ # reported severity.
639
+ #
640
+ # * `INSUFFICIENT_USER_TIME_OFF_BALANCE`: the user's time off balance
641
+ # for the activity is less than the time this request deducts.
642
+ # Connect Customer deducts only working time in the window. For
643
+ # details, see [How the system calculates time off deductions][1] in
644
+ # the *Connect Customer Administrator Guide*.
645
+ #
646
+ # * `INSUFFICIENT_GROUP_TIME_OFF_ALLOWANCE`: the time off allowance of
647
+ # the user's forecast group or demand group for the activity is too
648
+ # low for this request.
649
+ #
650
+ # * `INSUFFICIENT_STAFFING_GROUP_TIME_OFF_ALLOWANCE`: the daily time
651
+ # off allowance of the user's staffing group for the activity is
652
+ # too low for this request.
653
+ #
654
+ # * `CONFLICTING_TIME_OFF_REQUEST`: the request overlaps another time
655
+ # off request for the user that is `APPROVED` or being approved.
656
+ # Requests in `AWAITING_APPROVAL` don't count. For `CreateTimeOff`
657
+ # with `AUTOMATIC`, overlapping overtime and voluntary time off also
658
+ # count.
659
+ #
660
+ #
661
+ #
662
+ # [1]: https://docs.aws.amazon.com/connect/latest/adminguide/upload-timeoff-balance.html#how-system-calculates-time-off-deductions
663
+ # @return [String]
664
+ #
665
+ # @see http://docs.aws.amazon.com/goto/WebAPI/connectscheduling-2026-07-16/TimeOffValidationResult AWS API Documentation
666
+ #
667
+ class TimeOffValidationResult < Struct.new(
668
+ :severity,
669
+ :code)
670
+ SENSITIVE = []
671
+ include Aws::Structure
672
+ end
673
+
674
+ # The input fails to satisfy the constraints specified by an AWS
675
+ # service.
676
+ #
677
+ # @!attribute [rw] message
678
+ # @return [String]
679
+ #
680
+ # @!attribute [rw] reason
681
+ # The reason the input failed validation. Branch on this value rather
682
+ # than on the message wording.
683
+ # @return [String]
684
+ #
685
+ # @!attribute [rw] field_list
686
+ # The specific input fields that failed validation, when `Reason` is
687
+ # `FIELD_VALIDATION_FAILED`.
688
+ # @return [Array<Types::ValidationExceptionField>]
689
+ #
690
+ # @see http://docs.aws.amazon.com/goto/WebAPI/connectscheduling-2026-07-16/ValidationException AWS API Documentation
691
+ #
692
+ class ValidationException < Struct.new(
693
+ :message,
694
+ :reason,
695
+ :field_list)
696
+ SENSITIVE = []
697
+ include Aws::Structure
698
+ end
699
+
700
+ # An input field that failed validation.
701
+ #
702
+ # @!attribute [rw] name
703
+ # The path to the field that failed validation, using JSON
704
+ # pointer-style dotted notation for nested members.
705
+ # @return [String]
706
+ #
707
+ # @!attribute [rw] message
708
+ # A message describing why the field failed validation.
709
+ # @return [String]
710
+ #
711
+ # @see http://docs.aws.amazon.com/goto/WebAPI/connectscheduling-2026-07-16/ValidationExceptionField AWS API Documentation
712
+ #
713
+ class ValidationExceptionField < Struct.new(
714
+ :name,
715
+ :message)
716
+ SENSITIVE = []
717
+ include Aws::Structure
718
+ end
719
+
720
+ end
721
+ end
722
+