Amazon Connect Scheduling 2026-07-16
- Client: Aws\ConnectScheduling\ConnectSchedulingClient
- Service ID: connectscheduling
- Version: 2026-07-16
This page describes the parameters and results for the operations of the Amazon Connect Scheduling (2026-07-16), and shows how to use the Aws\ConnectScheduling\ConnectSchedulingClient object to call the described operations. This documentation is specific to the 2026-07-16 API version of the service.
Operation Summary
Each of the following operations can be created from a client using
$client->getCommand('CommandName'), where "CommandName" is the
name of one of the following operations. Note: a command is a value that
encapsulates an operation and the parameters used to create an HTTP request.
You can also create and send a command immediately using the magic methods
available on a client object: $client->commandName(/* parameters */).
You can send the command asynchronously (returning a promise) by appending the
word "Async" to the operation name: $client->commandNameAsync(/* parameters */).
- ApproveTimeOff ( array $params = [] )
- Approves a time off request.
- CancelTimeOff ( array $params = [] )
- Cancels a time off request.
- CreateTimeOff ( array $params = [] )
- Creates a time off request for a user.
- GetTimeOff ( array $params = [] )
- Returns a time off request, including its current status and validation results.
- PutTimeOffBalance ( array $params = [] )
- Sets the time off balance for one user and shift activity.
- RejectTimeOff ( array $params = [] )
- Rejects a time off request.
Operations
ApproveTimeOff
$result = $client->approveTimeOff([/* ... */]); $promise = $client->approveTimeOffAsync([/* ... */]);
Approves a time off request. Evaluates agent time off balances and group time off allowances before approving. RuleFailureAction controls what happens when these evaluations fail. The request is rejected with CONFLICTING_TIME_OFF_REQUEST if it overlaps another time off request for the user that is APPROVED or being approved.
The time off request is processed asynchronously, so a successful call doesn't indicate the final status. Read the resulting status with GetTimeOff or from the time off state-change events.
Approving an APPROVED request succeeds without a change. Approving a REJECTED request evaluates the rules again, so it can end APPROVED or REJECTED, and repeating the call can give a different result. Check the status with GetTimeOff before you retry.
Returns ConflictException if the request is PENDING or CANCELLED. PENDING means Connect Customer is still processing the request asynchronously. Wait until GetTimeOff returns a status other than PENDING, and then retry.
When the approval succeeds, Connect Customer cancels any overtime or voluntary time off activity that overlaps the approved window.
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 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.
Parameter Syntax
$result = $client->approveTimeOff([
'Description' => '<string>',
'InstanceId' => '<string>', // REQUIRED
'RuleFailureAction' => 'REJECT|OVERRIDE',
'TimeOffId' => '<string>', // REQUIRED
'UserId' => '<string>', // REQUIRED
]);
Parameter Details
Members
- Description
-
- Type: string
A description recorded with the approval.
GetTimeOffdoesn't return it. - InstanceId
-
- Required: Yes
- Type: string
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.
- RuleFailureAction
-
- Type: string
Controls what happens when a configured rule fails.
REJECT, the default, records anERRORand leaves the requestREJECTED.OVERRIDErecords aWARNINGand approves the request, like the Override time off rules option in the Connect Customer admin website.OVERRIDEnever waivesCONFLICTING_TIME_OFF_REQUEST. - TimeOffId
-
- Required: Yes
- Type: string
The unique identifier of the time off request to approve. If the time off request doesn't belong to
UserId, the operation returnsResourceNotFoundException. - UserId
-
- Required: Yes
- Type: string
The identifier of the user who the time off request belongs to. This can be the ID or the ARN of the user.
Result Syntax
[]
Result Details
Errors
- InternalServerException:
The request processing failed because of an error or failure with the service.
- ValidationException:
The input fails to satisfy the constraints specified by an AWS service.
- ThrottlingException:
The request was denied due to request throttling.
- 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.
- ResourceNotFoundException:
The specified resource was not found.
Examples
Example 1: To approve a time off request past a failed rule
The following example approves a time off request with RuleFailureAction OVERRIDE, so a failed rule is recorded as a WARNING instead of rejecting the request.
$result = $client->approveTimeOff([
'Description' => 'Approved with coverage from the evening shift',
'InstanceId' => '12345678-1234-1234-1234-123456789012',
'RuleFailureAction' => 'OVERRIDE',
'TimeOffId' => 'abcdef12-3456-7890-abcd-ef1234567890',
'UserId' => '87654321-4321-4321-4321-210987654321',
]);
Result syntax:
[ ]
CancelTimeOff
$result = $client->cancelTimeOff([/* ... */]); $promise = $client->cancelTimeOffAsync([/* ... */]);
Cancels a time off request.
Cancelling a CANCELLED request succeeds without a change. Returns ConflictException if the request is PENDING, which means Connect Customer is still processing the request asynchronously. Wait until GetTimeOff returns a status other than PENDING, and then retry.
Parameter Syntax
$result = $client->cancelTimeOff([
'Description' => '<string>',
'InstanceId' => '<string>', // REQUIRED
'TimeOffId' => '<string>', // REQUIRED
'UserId' => '<string>', // REQUIRED
]);
Parameter Details
Members
- Description
-
- Type: string
A description recorded with the cancellation. It replaces the description of the time off request. If you omit it, the request's description is removed.
- InstanceId
-
- Required: Yes
- Type: string
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.
- TimeOffId
-
- Required: Yes
- Type: string
The unique identifier of the time off request to cancel. If the time off request doesn't belong to
UserId, the operation returnsResourceNotFoundException. - UserId
-
- Required: Yes
- Type: string
The identifier of the user who the time off request belongs to. This can be the ID or the ARN of the user.
Result Syntax
[]
Result Details
Errors
- InternalServerException:
The request processing failed because of an error or failure with the service.
- ValidationException:
The input fails to satisfy the constraints specified by an AWS service.
- ThrottlingException:
The request was denied due to request throttling.
- 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.
- ResourceNotFoundException:
The specified resource was not found.
Examples
Example 1: To cancel a time off request
The following example cancels a time off request and records the reason on the cancellation.
$result = $client->cancelTimeOff([
'Description' => 'Plans changed',
'InstanceId' => '12345678-1234-1234-1234-123456789012',
'TimeOffId' => 'abcdef12-3456-7890-abcd-ef1234567890',
'UserId' => '87654321-4321-4321-4321-210987654321',
]);
Result syntax:
[ ]
CreateTimeOff
$result = $client->createTimeOff([/* ... */]); $promise = $client->createTimeOffAsync([/* ... */]);
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.
Parameter Syntax
$result = $client->createTimeOff([
'ApprovalType' => 'AWAIT_APPROVAL|AUTOMATIC', // REQUIRED
'ClientToken' => '<string>',
'Description' => '<string>',
'EndAt' => <integer || string || DateTime>, // REQUIRED
'InstanceId' => '<string>', // REQUIRED
'RuleFailureAction' => 'REJECT|OVERRIDE',
'ShiftActivityId' => '<string>', // REQUIRED
'StartAt' => <integer || string || DateTime>, // REQUIRED
'UserId' => '<string>', // REQUIRED
]);
Parameter Details
Members
- ApprovalType
-
- Required: Yes
- Type: string
Controls who approves the request.
AWAIT_APPROVALwaits for anApproveTimeOfforRejectTimeOffcall.AUTOMATIChas Connect Customer decide the request. For details, seeCreateTimeOff. - ClientToken
-
- Type: 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. - Description
-
- Type: string
A description recorded on the time off request. If you omit it, the request has no description.
- EndAt
-
- Required: Yes
- Type: timestamp (string|DateTime or anything parsable by strtotime)
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. - InstanceId
-
- Required: Yes
- Type: string
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.
- RuleFailureAction
-
- Type: 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. - ShiftActivityId
-
- Required: Yes
- Type: string
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
-
- Required: Yes
- Type: timestamp (string|DateTime or anything parsable by strtotime)
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.
- UserId
-
- Required: Yes
- Type: string
The identifier of the user who the time off request is for. This can be the ID or the ARN of the user.
Result Syntax
[
'TimeOffId' => '<string>',
]
Result Details
Members
- TimeOffId
-
- Required: Yes
- Type: string
The identifier of the time off request.
Errors
- ServiceQuotaExceededException:
The request would cause a service quota to be exceeded.
- InternalServerException:
The request processing failed because of an error or failure with the service.
- ValidationException:
The input fails to satisfy the constraints specified by an AWS service.
- ThrottlingException:
The request was denied due to request throttling.
- 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.
- ResourceNotFoundException:
The specified resource was not found.
Examples
Example 1: 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.
$result = $client->createTimeOff([
'ApprovalType' => 'AWAIT_APPROVAL',
'Description' => 'Family event',
'EndAt' => ,
'InstanceId' => '12345678-1234-1234-1234-123456789012',
'ShiftActivityId' => '11112222-3333-4444-5555-666677778888',
'StartAt' => ,
'UserId' => '87654321-4321-4321-4321-210987654321',
]);
Result syntax:
[
'TimeOffId' => 'abcdef12-3456-7890-abcd-ef1234567890',
]
GetTimeOff
$result = $client->getTimeOff([/* ... */]); $promise = $client->getTimeOffAsync([/* ... */]);
Returns a time off request, including its current status and validation results.
Parameter Syntax
$result = $client->getTimeOff([
'InstanceId' => '<string>', // REQUIRED
'TimeOffId' => '<string>', // REQUIRED
'UserId' => '<string>', // REQUIRED
]);
Parameter Details
Members
- InstanceId
-
- Required: Yes
- Type: string
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.
- TimeOffId
-
- Required: Yes
- Type: string
The identifier of the time off request. If the time off request doesn't belong to
UserId, the operation returnsResourceNotFoundException. - UserId
-
- Required: Yes
- Type: string
The identifier of the user who the time off request belongs to. This can be the ID or the ARN of the user.
Result Syntax
[
'CreatedAt' => <DateTime>,
'CreatedBy' => [
'AWSIdentityArn' => '<string>',
'ConnectUserArn' => '<string>',
],
'Description' => '<string>',
'EndAt' => <DateTime>,
'ShiftActivityId' => '<string>',
'StartAt' => <DateTime>,
'Status' => 'PENDING|APPROVED|REJECTED|CANCELLED|AWAITING_APPROVAL',
'TimeOffId' => '<string>',
'UpdatedAt' => <DateTime>,
'UpdatedBy' => [
'AWSIdentityArn' => '<string>',
'ConnectUserArn' => '<string>',
],
'UserId' => '<string>',
'ValidationResults' => [
[
'Code' => 'INSUFFICIENT_USER_TIME_OFF_BALANCE|INSUFFICIENT_GROUP_TIME_OFF_ALLOWANCE|INSUFFICIENT_STAFFING_GROUP_TIME_OFF_ALLOWANCE|CONFLICTING_TIME_OFF_REQUEST',
'Severity' => 'WARNING|ERROR',
],
// ...
],
]
Result Details
Members
- CreatedAt
-
- Required: Yes
- Type: timestamp (string|DateTime or anything parsable by strtotime)
The timestamp when the time off request was created.
- CreatedBy
-
- Required: Yes
- Type: ActorInfo structure
The identity that created the request. Immutable for the life of the request.
- Description
-
- Type: string
The description of the time off request.
CreateTimeOffsets it, andCancelTimeOffreplaces or removes it. An edit in the Connect Customer admin website can also change it.GetTimeOffdoesn't return descriptions sent withApproveTimeOfforRejectTimeOff. - EndAt
-
- Required: Yes
- Type: timestamp (string|DateTime or anything parsable by strtotime)
The end of the time off window, exclusive, as sent to
CreateTimeOff. - ShiftActivityId
-
- Required: Yes
- Type: string
The identifier of the shift activity for the time off request.
- StartAt
-
- Required: Yes
- Type: timestamp (string|DateTime or anything parsable by strtotime)
The start of the time off window, inclusive, as sent to
CreateTimeOff. - Status
-
- Required: Yes
- Type: string
The status of the time off request.
-
PENDING: Connect Customer is processing a change to the request, which then changes to another status. An edit in the Connect Customer admin website can also make a requestPENDING, so anAPPROVEDrequest can becomePENDINGand then endAPPROVEDorREJECTED. -
AWAITING_APPROVAL: the request is waiting for anApproveTimeOfforRejectTimeOffcall.
- TimeOffId
-
- Required: Yes
- Type: string
The identifier of the time off request.
- UpdatedAt
-
- Required: Yes
- Type: timestamp (string|DateTime or anything parsable by strtotime)
The timestamp when the time off request was last modified.
- UpdatedBy
-
- Type: ActorInfo structure
The identity that made the most recent
ApproveTimeOff,RejectTimeOff, orCancelTimeOffcall on the request, or took the same action in the Connect Customer admin website. Absent until one of those actions is taken, including after Connect Customer decides anAUTOMATICrequest.UpdatedAtalso changes when aPENDINGrequest changes to another status and for other edits, which don't setUpdatedBy. - UserId
-
- Required: Yes
- Type: string
The identifier of the user the time off is for.
- ValidationResults
-
- Type: Array of TimeOffValidationResult structures
Warnings or failures produced while processing the time off request.
Errors
- InternalServerException:
The request processing failed because of an error or failure with the service.
- ValidationException:
The input fails to satisfy the constraints specified by an AWS service.
- ThrottlingException:
The request was denied due to request throttling.
- AccessDeniedException:
You do not have sufficient permissions to perform this action.
- ResourceNotFoundException:
The specified resource was not found.
Examples
Example 1: To get a time off request
The following example gets a time off request that was approved past a failed group allowance rule, which is reported as a WARNING.
$result = $client->getTimeOff([
'InstanceId' => '12345678-1234-1234-1234-123456789012',
'TimeOffId' => 'abcdef12-3456-7890-abcd-ef1234567890',
'UserId' => '87654321-4321-4321-4321-210987654321',
]);
Result syntax:
[
'CreatedAt' => ,
'CreatedBy' => [
'ConnectUserArn' => 'arn:aws:connect:us-west-2:123456789012:instance/12345678-1234-1234-1234-123456789012/agent/87654321-4321-4321-4321-210987654321',
],
'Description' => 'Family event',
'EndAt' => ,
'ShiftActivityId' => '11112222-3333-4444-5555-666677778888',
'StartAt' => ,
'Status' => 'APPROVED',
'TimeOffId' => 'abcdef12-3456-7890-abcd-ef1234567890',
'UpdatedAt' => ,
'UpdatedBy' => [
'ConnectUserArn' => 'arn:aws:connect:us-west-2:123456789012:instance/12345678-1234-1234-1234-123456789012/agent/99998888-7777-6666-5555-444433332222',
],
'UserId' => '87654321-4321-4321-4321-210987654321',
'ValidationResults' => [
[
'Code' => 'INSUFFICIENT_GROUP_TIME_OFF_ALLOWANCE',
'Severity' => 'WARNING',
],
],
]
PutTimeOffBalance
$result = $client->putTimeOffBalance([/* ... */]); $promise = $client->putTimeOffBalanceAsync([/* ... */]);
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.
Parameter Syntax
$result = $client->putTimeOffBalance([
'Balance' => [ // REQUIRED
'Unit' => 'MINUTES|HOURS|DAYS', // REQUIRED
'Value' => <integer>, // REQUIRED
],
'InstanceId' => '<string>', // REQUIRED
'ShiftActivityId' => '<string>', // REQUIRED
'UserId' => '<string>', // REQUIRED
]);
Parameter Details
Members
- Balance
-
- Required: Yes
- Type: Duration structure
The new time off balance for the user and activity. It replaces the existing balance.
- InstanceId
-
- Required: Yes
- Type: string
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.
- ShiftActivityId
-
- Required: Yes
- Type: string
The identifier of the shift activity that the balance applies to. This can be the ID or the ARN of the shift activity.
- UserId
-
- Required: Yes
- Type: string
The identifier of the user whose balance is being updated. This can be the ID or the ARN of the user.
Result Syntax
[]
Result Details
Errors
- InternalServerException:
The request processing failed because of an error or failure with the service.
- ValidationException:
The input fails to satisfy the constraints specified by an AWS service.
- ThrottlingException:
The request was denied due to request throttling.
- 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.
- ResourceNotFoundException:
The specified resource was not found.
Examples
Example 1: To set a user's time off balance
The following example sets a user's balance for one time off activity to 80 hours, replacing any existing balance.
$result = $client->putTimeOffBalance([
'Balance' => [
'Unit' => 'HOURS',
'Value' => 80,
],
'InstanceId' => '12345678-1234-1234-1234-123456789012',
'ShiftActivityId' => '11112222-3333-4444-5555-666677778888',
'UserId' => '87654321-4321-4321-4321-210987654321',
]);
Result syntax:
[ ]
RejectTimeOff
$result = $client->rejectTimeOff([/* ... */]); $promise = $client->rejectTimeOffAsync([/* ... */]);
Rejects a time off request.
Rejecting a REJECTED request succeeds without a change. Returns ConflictException if the request is PENDING or CANCELLED. PENDING means Connect Customer is still processing the request asynchronously. Wait until GetTimeOff returns a status other than PENDING, and then retry.
Parameter Syntax
$result = $client->rejectTimeOff([
'Description' => '<string>',
'InstanceId' => '<string>', // REQUIRED
'TimeOffId' => '<string>', // REQUIRED
'UserId' => '<string>', // REQUIRED
]);
Parameter Details
Members
- Description
-
- Type: string
A description recorded with the rejection, such as the reason.
GetTimeOffdoesn't return it. - InstanceId
-
- Required: Yes
- Type: string
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.
- TimeOffId
-
- Required: Yes
- Type: string
The unique identifier of the time off request to reject. If the time off request doesn't belong to
UserId, the operation returnsResourceNotFoundException. - UserId
-
- Required: Yes
- Type: string
The identifier of the user who the time off request belongs to. This can be the ID or the ARN of the user.
Result Syntax
[]
Result Details
Errors
- InternalServerException:
The request processing failed because of an error or failure with the service.
- ValidationException:
The input fails to satisfy the constraints specified by an AWS service.
- ThrottlingException:
The request was denied due to request throttling.
- 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.
- ResourceNotFoundException:
The specified resource was not found.
Examples
Example 1: To reject a time off request
The following example rejects a time off request and records the reason on the rejection.
$result = $client->rejectTimeOff([
'Description' => 'Not enough coverage for this shift',
'InstanceId' => '12345678-1234-1234-1234-123456789012',
'TimeOffId' => 'abcdef12-3456-7890-abcd-ef1234567890',
'UserId' => '87654321-4321-4321-4321-210987654321',
]);
Result syntax:
[ ]
Shapes
AccessDeniedException
Description
You do not have sufficient permissions to perform this action.
Members
- Message
-
- Required: Yes
- Type: string
ActorInfo
Description
Information about the identity that performed an action on a time off request: a Connect Customer user or an IAM or AWS STS identity. Exactly one member is set.
Members
- AWSIdentityArn
-
- Type: string
The IAM or AWS STS ARN of the identity that performed the action. Present when that identity is not a Connect Customer user.
- ConnectUserArn
-
- Type: string
The ARN of the Connect Customer user who performed the action.
ConflictException
Description
The request could not be processed because of a conflict with the current state of the resource.
Members
- Message
-
- Required: Yes
- Type: string
- ResourceId
-
- Type: string
The identifier or ARN of the resource that is in conflict.
- ResourceType
-
- Type: string
The type of the resource that is in conflict.
Duration
Description
A length of time, expressed as a value and the unit it is counted in.
Members
- Unit
-
- Required: Yes
- Type: string
The unit the value is counted in.
- Value
-
- Required: Yes
- Type: int
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.
InternalServerException
Description
The request processing failed because of an error or failure with the service.
Members
- Message
-
- Required: Yes
- Type: string
- RetryAfterSeconds
-
- Type: int
The number of seconds to wait before retrying.
ResourceNotFoundException
Description
The specified resource was not found.
Members
- Message
-
- Required: Yes
- Type: string
- ResourceId
-
- Type: string
The identifier or ARN of the resource that was not found.
- ResourceType
-
- Type: string
The type of the resource that was not found.
ServiceQuotaExceededException
Description
The request would cause a service quota to be exceeded.
Members
- Message
-
- Required: Yes
- Type: string
- QuotaCode
-
- Type: string
The code of the quota that would be exceeded, for use with the Service Quotas API.
- ResourceId
-
- Type: string
The identifier or ARN of the resource whose quota would be exceeded.
- ResourceType
-
- Type: string
The type of the resource whose quota would be exceeded.
- ServiceCode
-
- Type: string
The code of the service that owns the quota.
ThrottlingException
Description
The request was denied due to request throttling.
Members
- Message
-
- Required: Yes
- Type: string
- QuotaCode
-
- Type: string
The code of the quota that was throttled, for use with the Service Quotas API.
- RetryAfterSeconds
-
- Type: int
The number of seconds to wait before retrying.
- ServiceCode
-
- Type: string
The code of the service that owns the quota.
TimeOffValidationResult
Description
A warning or failure produced while processing the time off request.
Members
- Code
-
- Required: Yes
- Type: string
The specific reason for the validation result. New values may be added, so treat an unrecognized value as a generic failure of the reported severity.
-
INSUFFICIENT_USER_TIME_OFF_BALANCE: the user's time off balance for the activity is less than the time this request deducts. Connect Customer deducts only working time in the window. For details, see How the system calculates time off deductions in the Connect Customer Administrator Guide. -
INSUFFICIENT_GROUP_TIME_OFF_ALLOWANCE: the time off allowance of the user's forecast group or demand group for the activity is too low for this request. -
INSUFFICIENT_STAFFING_GROUP_TIME_OFF_ALLOWANCE: the daily time off allowance of the user's staffing group for the activity is too low for this request. -
CONFLICTING_TIME_OFF_REQUEST: the request overlaps another time off request for the user that isAPPROVEDor being approved. Requests inAWAITING_APPROVALdon't count. ForCreateTimeOffwithAUTOMATIC, overlapping overtime and voluntary time off also count.
- Severity
-
- Required: Yes
- Type: string
The severity of the validation result.
WARNINGis a breach of the configured rules that is not enough to reject the request, either because of the rules configuration or because the caller sentRuleFailureActionOVERRIDE.ERRORis a reason the request was rejected.
ValidationException
Description
The input fails to satisfy the constraints specified by an AWS service.
Members
- FieldList
-
- Type: Array of ValidationExceptionField structures
The specific input fields that failed validation, when
ReasonisFIELD_VALIDATION_FAILED. - Message
-
- Required: Yes
- Type: string
- Reason
-
- Type: string
The reason the input failed validation. Branch on this value rather than on the message wording.
ValidationExceptionField
Description
An input field that failed validation.
Members
- Message
-
- Required: Yes
- Type: string
A message describing why the field failed validation.
- Name
-
- Required: Yes
- Type: string
The path to the field that failed validation, using JSON pointer-style dotted notation for nested members.