{ "smithy": "2.0", "shapes": { "com.amazonaws.connectscheduling#ARN": { "type": "string", "traits": { "smithy.api#length": { "min": 0, "max": 2048 } } }, "com.amazonaws.connectscheduling#AccessDeniedException": { "type": "structure", "members": { "Message": { "target": "com.amazonaws.connectscheduling#Message", "traits": { "smithy.api#required": {} } } }, "traits": { "smithy.api#documentation": "
You do not have sufficient permissions to perform this action.
", "smithy.api#error": "client", "smithy.api#httpError": 403 } }, "com.amazonaws.connectscheduling#ActorInfo": { "type": "union", "members": { "ConnectUserArn": { "target": "com.amazonaws.connectscheduling#ARN", "traits": { "smithy.api#documentation": "The ARN of the Connect Customer user who performed the action.
" } }, "AWSIdentityArn": { "target": "com.amazonaws.connectscheduling#ARN", "traits": { "smithy.api#documentation": "The IAM or AWS STS ARN of the identity that performed the action. Present when that identity is not a Connect Customer user.
" } } }, "traits": { "smithy.api#documentation": "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.
" } }, "com.amazonaws.connectscheduling#AmazonConnectScheduling": { "type": "service", "version": "2026-07-16", "operations": [ { "target": "com.amazonaws.connectscheduling#ApproveTimeOff" }, { "target": "com.amazonaws.connectscheduling#CancelTimeOff" }, { "target": "com.amazonaws.connectscheduling#CreateTimeOff" }, { "target": "com.amazonaws.connectscheduling#GetTimeOff" }, { "target": "com.amazonaws.connectscheduling#PutTimeOffBalance" }, { "target": "com.amazonaws.connectscheduling#RejectTimeOff" } ], "traits": { "aws.api#service": { "sdkId": "ConnectScheduling", "arnNamespace": "connect", "cloudTrailEventSource": "connect.amazonaws.com" }, "aws.auth#sigv4": { "name": "connect" }, "aws.protocols#restJson1": {}, "smithy.api#documentation": "Use the Amazon Connect Scheduling API to work programmatically with Connect Customer forecasting, capacity planning, and scheduling, and to integrate these capabilities with your own systems. In the Connect Customer admin website, you use them to forecast contact volume, plan capacity, and create and manage agent schedules.
For more information, see Forecasting & agent scheduling in the Connect Customer Administrator Guide.
", "smithy.api#title": "Amazon Connect Scheduling", "smithy.rules#endpointBdd": { "version": "1.1", "parameters": { "Region": { "builtIn": "AWS::Region", "required": false, "documentation": "The AWS region used to dispatch the request.", "type": "string" }, "UseDualStack": { "builtIn": "AWS::UseDualStack", "required": true, "default": false, "documentation": "When true, use the dual-stack endpoint. If the configured endpoint does not support dual-stack, dispatching the request MAY return an error.", "type": "boolean" }, "UseFIPS": { "builtIn": "AWS::UseFIPS", "required": true, "default": false, "documentation": "When true, send this request to the FIPS-compliant regional endpoint. If the configured endpoint does not have a FIPS compliant endpoint, dispatching the request will return an error.", "type": "boolean" }, "Endpoint": { "builtIn": "SDK::Endpoint", "required": false, "documentation": "Override the endpoint used to send this request", "type": "string" } }, "conditions": [ { "fn": "isSet", "argv": [ { "ref": "Endpoint" } ] }, { "fn": "isSet", "argv": [ { "ref": "Region" } ] }, { "fn": "aws.partition", "argv": [ { "ref": "Region" } ], "assign": "PartitionResult" }, { "fn": "booleanEquals", "argv": [ { "ref": "UseFIPS" }, true ] }, { "fn": "booleanEquals", "argv": [ { "ref": "UseDualStack" }, true ] }, { "fn": "booleanEquals", "argv": [ { "fn": "getAttr", "argv": [ { "ref": "PartitionResult" }, "supportsDualStack" ] }, true ] }, { "fn": "booleanEquals", "argv": [ { "fn": "getAttr", "argv": [ { "ref": "PartitionResult" }, "supportsFIPS" ] }, true ] } ], "results": [ { "conditions": [], "error": "Invalid Configuration: FIPS and custom endpoint are not supported", "type": "error" }, { "conditions": [], "error": "Invalid Configuration: Dualstack and custom endpoint are not supported", "type": "error" }, { "conditions": [], "endpoint": { "url": { "ref": "Endpoint" }, "properties": {}, "headers": {} }, "type": "endpoint" }, { "conditions": [], "endpoint": { "url": "https://connect-fips.{Region}.{PartitionResult#dualStackDnsSuffix}", "properties": {}, "headers": {} }, "type": "endpoint" }, { "conditions": [], "error": "FIPS and DualStack are enabled, but this partition does not support one or both", "type": "error" }, { "conditions": [], "endpoint": { "url": "https://connect-fips.{Region}.{PartitionResult#dnsSuffix}", "properties": {}, "headers": {} }, "type": "endpoint" }, { "conditions": [], "error": "FIPS is enabled but this partition does not support FIPS", "type": "error" }, { "conditions": [], "endpoint": { "url": "https://connect.{Region}.{PartitionResult#dualStackDnsSuffix}", "properties": {}, "headers": {} }, "type": "endpoint" }, { "conditions": [], "error": "DualStack is enabled but this partition does not support DualStack", "type": "error" }, { "conditions": [], "endpoint": { "url": "https://connect.{Region}.{PartitionResult#dnsSuffix}", "properties": {}, "headers": {} }, "type": "endpoint" }, { "conditions": [], "error": "Invalid Configuration: Missing Region", "type": "error" } ], "root": 2, "nodeCount": 13, "nodes": "/////wAAAAH/////AAAAAAAAAAwAAAADAAAAAQAAAAQF9eELAAAAAgAAAAUF9eELAAAAAwAAAAgAAAAGAAAABAAAAAcF9eEKAAAABQX14QgF9eEJAAAABAAAAAoAAAAJAAAABgX14QYF9eEHAAAABQAAAAsF9eEFAAAABgX14QQF9eEFAAAAAwX14QEAAAANAAAABAX14QIF9eED" }, "smithy.rules#endpointRuleSet": { "version": "1.0", "parameters": { "Region": { "builtIn": "AWS::Region", "required": false, "documentation": "The AWS region used to dispatch the request.", "type": "string" }, "UseDualStack": { "builtIn": "AWS::UseDualStack", "required": true, "default": false, "documentation": "When true, use the dual-stack endpoint. If the configured endpoint does not support dual-stack, dispatching the request MAY return an error.", "type": "boolean" }, "UseFIPS": { "builtIn": "AWS::UseFIPS", "required": true, "default": false, "documentation": "When true, send this request to the FIPS-compliant regional endpoint. If the configured endpoint does not have a FIPS compliant endpoint, dispatching the request will return an error.", "type": "boolean" }, "Endpoint": { "builtIn": "SDK::Endpoint", "required": false, "documentation": "Override the endpoint used to send this request", "type": "string" } }, "rules": [ { "conditions": [ { "fn": "isSet", "argv": [ { "ref": "Endpoint" } ] } ], "rules": [ { "conditions": [ { "fn": "booleanEquals", "argv": [ { "ref": "UseFIPS" }, true ] } ], "error": "Invalid Configuration: FIPS and custom endpoint are not supported", "type": "error" }, { "conditions": [], "rules": [ { "conditions": [ { "fn": "booleanEquals", "argv": [ { "ref": "UseDualStack" }, true ] } ], "error": "Invalid Configuration: Dualstack and custom endpoint are not supported", "type": "error" }, { "conditions": [], "endpoint": { "url": { "ref": "Endpoint" }, "properties": {}, "headers": {} }, "type": "endpoint" } ], "type": "tree" } ], "type": "tree" }, { "conditions": [], "rules": [ { "conditions": [ { "fn": "isSet", "argv": [ { "ref": "Region" } ] } ], "rules": [ { "conditions": [ { "fn": "aws.partition", "argv": [ { "ref": "Region" } ], "assign": "PartitionResult" } ], "rules": [ { "conditions": [ { "fn": "booleanEquals", "argv": [ { "ref": "UseFIPS" }, true ] }, { "fn": "booleanEquals", "argv": [ { "ref": "UseDualStack" }, true ] } ], "rules": [ { "conditions": [ { "fn": "booleanEquals", "argv": [ true, { "fn": "getAttr", "argv": [ { "ref": "PartitionResult" }, "supportsFIPS" ] } ] }, { "fn": "booleanEquals", "argv": [ true, { "fn": "getAttr", "argv": [ { "ref": "PartitionResult" }, "supportsDualStack" ] } ] } ], "rules": [ { "conditions": [], "rules": [ { "conditions": [], "endpoint": { "url": "https://connect-fips.{Region}.{PartitionResult#dualStackDnsSuffix}", "properties": {}, "headers": {} }, "type": "endpoint" } ], "type": "tree" } ], "type": "tree" }, { "conditions": [], "error": "FIPS and DualStack are enabled, but this partition does not support one or both", "type": "error" } ], "type": "tree" }, { "conditions": [ { "fn": "booleanEquals", "argv": [ { "ref": "UseFIPS" }, true ] } ], "rules": [ { "conditions": [ { "fn": "booleanEquals", "argv": [ { "fn": "getAttr", "argv": [ { "ref": "PartitionResult" }, "supportsFIPS" ] }, true ] } ], "rules": [ { "conditions": [], "rules": [ { "conditions": [], "endpoint": { "url": "https://connect-fips.{Region}.{PartitionResult#dnsSuffix}", "properties": {}, "headers": {} }, "type": "endpoint" } ], "type": "tree" } ], "type": "tree" }, { "conditions": [], "error": "FIPS is enabled but this partition does not support FIPS", "type": "error" } ], "type": "tree" }, { "conditions": [ { "fn": "booleanEquals", "argv": [ { "ref": "UseDualStack" }, true ] } ], "rules": [ { "conditions": [ { "fn": "booleanEquals", "argv": [ true, { "fn": "getAttr", "argv": [ { "ref": "PartitionResult" }, "supportsDualStack" ] } ] } ], "rules": [ { "conditions": [], "rules": [ { "conditions": [], "endpoint": { "url": "https://connect.{Region}.{PartitionResult#dualStackDnsSuffix}", "properties": {}, "headers": {} }, "type": "endpoint" } ], "type": "tree" } ], "type": "tree" }, { "conditions": [], "error": "DualStack is enabled but this partition does not support DualStack", "type": "error" } ], "type": "tree" }, { "conditions": [], "rules": [ { "conditions": [], "endpoint": { "url": "https://connect.{Region}.{PartitionResult#dnsSuffix}", "properties": {}, "headers": {} }, "type": "endpoint" } ], "type": "tree" } ], "type": "tree" } ], "type": "tree" }, { "conditions": [], "error": "Invalid Configuration: Missing Region", "type": "error" } ], "type": "tree" } ] }, "smithy.rules#endpointTests": { "testCases": [ { "documentation": "For region us-east-1 with FIPS enabled and DualStack enabled", "expect": { "endpoint": { "url": "https://connect-fips.us-east-1.api.aws" } }, "params": { "Region": "us-east-1", "UseFIPS": true, "UseDualStack": true } }, { "documentation": "For region us-east-1 with FIPS enabled and DualStack disabled", "expect": { "endpoint": { "url": "https://connect-fips.us-east-1.amazonaws.com" } }, "params": { "Region": "us-east-1", "UseFIPS": true, "UseDualStack": false } }, { "documentation": "For region us-east-1 with FIPS disabled and DualStack enabled", "expect": { "endpoint": { "url": "https://connect.us-east-1.api.aws" } }, "params": { "Region": "us-east-1", "UseFIPS": false, "UseDualStack": true } }, { "documentation": "For region us-east-1 with FIPS disabled and DualStack disabled", "expect": { "endpoint": { "url": "https://connect.us-east-1.amazonaws.com" } }, "params": { "Region": "us-east-1", "UseFIPS": false, "UseDualStack": false } }, { "documentation": "For region cn-north-1 with FIPS enabled and DualStack enabled", "expect": { "endpoint": { "url": "https://connect-fips.cn-north-1.api.amazonwebservices.com.cn" } }, "params": { "Region": "cn-north-1", "UseFIPS": true, "UseDualStack": true } }, { "documentation": "For region cn-north-1 with FIPS enabled and DualStack disabled", "expect": { "endpoint": { "url": "https://connect-fips.cn-north-1.amazonaws.com.cn" } }, "params": { "Region": "cn-north-1", "UseFIPS": true, "UseDualStack": false } }, { "documentation": "For region cn-north-1 with FIPS disabled and DualStack enabled", "expect": { "endpoint": { "url": "https://connect.cn-north-1.api.amazonwebservices.com.cn" } }, "params": { "Region": "cn-north-1", "UseFIPS": false, "UseDualStack": true } }, { "documentation": "For region cn-north-1 with FIPS disabled and DualStack disabled", "expect": { "endpoint": { "url": "https://connect.cn-north-1.amazonaws.com.cn" } }, "params": { "Region": "cn-north-1", "UseFIPS": false, "UseDualStack": false } }, { "documentation": "For region us-gov-east-1 with FIPS enabled and DualStack enabled", "expect": { "endpoint": { "url": "https://connect-fips.us-gov-east-1.api.aws" } }, "params": { "Region": "us-gov-east-1", "UseFIPS": true, "UseDualStack": true } }, { "documentation": "For region us-gov-east-1 with FIPS enabled and DualStack disabled", "expect": { "endpoint": { "url": "https://connect-fips.us-gov-east-1.amazonaws.com" } }, "params": { "Region": "us-gov-east-1", "UseFIPS": true, "UseDualStack": false } }, { "documentation": "For region us-gov-east-1 with FIPS disabled and DualStack enabled", "expect": { "endpoint": { "url": "https://connect.us-gov-east-1.api.aws" } }, "params": { "Region": "us-gov-east-1", "UseFIPS": false, "UseDualStack": true } }, { "documentation": "For region us-gov-east-1 with FIPS disabled and DualStack disabled", "expect": { "endpoint": { "url": "https://connect.us-gov-east-1.amazonaws.com" } }, "params": { "Region": "us-gov-east-1", "UseFIPS": false, "UseDualStack": false } }, { "documentation": "For region us-iso-east-1 with FIPS enabled and DualStack disabled", "expect": { "endpoint": { "url": "https://connect-fips.us-iso-east-1.c2s.ic.gov" } }, "params": { "Region": "us-iso-east-1", "UseFIPS": true, "UseDualStack": false } }, { "documentation": "For region us-iso-east-1 with FIPS disabled and DualStack disabled", "expect": { "endpoint": { "url": "https://connect.us-iso-east-1.c2s.ic.gov" } }, "params": { "Region": "us-iso-east-1", "UseFIPS": false, "UseDualStack": false } }, { "documentation": "For region us-isob-east-1 with FIPS enabled and DualStack disabled", "expect": { "endpoint": { "url": "https://connect-fips.us-isob-east-1.sc2s.sgov.gov" } }, "params": { "Region": "us-isob-east-1", "UseFIPS": true, "UseDualStack": false } }, { "documentation": "For region us-isob-east-1 with FIPS disabled and DualStack disabled", "expect": { "endpoint": { "url": "https://connect.us-isob-east-1.sc2s.sgov.gov" } }, "params": { "Region": "us-isob-east-1", "UseFIPS": false, "UseDualStack": false } }, { "documentation": "For custom endpoint with region set and fips disabled and dualstack disabled", "expect": { "endpoint": { "url": "https://example.com" } }, "params": { "Region": "us-east-1", "UseFIPS": false, "UseDualStack": false, "Endpoint": "https://example.com" } }, { "documentation": "For custom endpoint with region not set and fips disabled and dualstack disabled", "expect": { "endpoint": { "url": "https://example.com" } }, "params": { "UseFIPS": false, "UseDualStack": false, "Endpoint": "https://example.com" } }, { "documentation": "For custom endpoint with fips enabled and dualstack disabled", "expect": { "error": "Invalid Configuration: FIPS and custom endpoint are not supported" }, "params": { "Region": "us-east-1", "UseFIPS": true, "UseDualStack": false, "Endpoint": "https://example.com" } }, { "documentation": "For custom endpoint with fips disabled and dualstack enabled", "expect": { "error": "Invalid Configuration: Dualstack and custom endpoint are not supported" }, "params": { "Region": "us-east-1", "UseFIPS": false, "UseDualStack": true, "Endpoint": "https://example.com" } }, { "documentation": "Missing region", "expect": { "error": "Invalid Configuration: Missing Region" } } ], "version": "1.0" } } }, "com.amazonaws.connectscheduling#ApprovalType": { "type": "enum", "members": { "AWAIT_APPROVAL": { "target": "smithy.api#Unit", "traits": { "smithy.api#documentation": "The request is created in AWAITING_APPROVAL and rests there until an explicit ApproveTimeOff or RejectTimeOff call decides it.
Connect Customer decides the request itself, with no second decision call needed. The request may be PENDING while that decision is processed, then ends APPROVED or REJECTED. Does not bypass rule evaluation.
Controls who approves a time off request. Use it on CreateTimeOff only, because ApproveTimeOff already names its own decision. AWAIT_APPROVAL waits for an ApproveTimeOff or RejectTimeOff call. AUTOMATIC has Connect Customer decide the request.
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.
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.
", "smithy.api#httpLabel": {}, "smithy.api#required": {} } }, "UserId": { "target": "com.amazonaws.connectscheduling#UserIdOrArn", "traits": { "smithy.api#documentation": "The identifier of the user who the time off request belongs to. This can be the ID or the ARN of the user.
", "smithy.api#httpLabel": {}, "smithy.api#required": {} } }, "TimeOffId": { "target": "com.amazonaws.connectscheduling#TimeOffId", "traits": { "smithy.api#documentation": "The unique identifier of the time off request to approve. If the time off request doesn't belong to UserId, the operation returns ResourceNotFoundException.
A description recorded with the approval. GetTimeOff doesn't return it.
Controls what happens when a configured rule fails. REJECT, the default, records an ERROR and leaves the request REJECTED. OVERRIDE records a WARNING and approves the request, like the Override time off rules option in the Connect Customer admin website. OVERRIDE never waives CONFLICTING_TIME_OFF_REQUEST.
The request for ApproveTimeOff.
The response for ApproveTimeOff.
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.
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.
", "smithy.api#httpLabel": {}, "smithy.api#required": {} } }, "UserId": { "target": "com.amazonaws.connectscheduling#UserIdOrArn", "traits": { "smithy.api#documentation": "The identifier of the user who the time off request belongs to. This can be the ID or the ARN of the user.
", "smithy.api#httpLabel": {}, "smithy.api#required": {} } }, "TimeOffId": { "target": "com.amazonaws.connectscheduling#TimeOffId", "traits": { "smithy.api#documentation": "The unique identifier of the time off request to cancel. If the time off request doesn't belong to UserId, the operation returns ResourceNotFoundException.
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.
" } } }, "traits": { "smithy.api#documentation": "The request for CancelTimeOff.
The response for CancelTimeOff.
The identifier or ARN of the resource that is in conflict.
" } }, "ResourceType": { "target": "smithy.api#String", "traits": { "smithy.api#documentation": "The type of the resource that is in conflict.
" } } }, "traits": { "smithy.api#documentation": "The request could not be processed because of a conflict with the current state of the resource.
", "smithy.api#error": "client", "smithy.api#httpError": 409 } }, "com.amazonaws.connectscheduling#CreateTimeOff": { "type": "operation", "input": { "target": "com.amazonaws.connectscheduling#CreateTimeOffRequest" }, "output": { "target": "com.amazonaws.connectscheduling#CreateTimeOffResponse" }, "errors": [ { "target": "com.amazonaws.connectscheduling#AccessDeniedException" }, { "target": "com.amazonaws.connectscheduling#ConflictException" }, { "target": "com.amazonaws.connectscheduling#InternalServerException" }, { "target": "com.amazonaws.connectscheduling#ResourceNotFoundException" }, { "target": "com.amazonaws.connectscheduling#ServiceQuotaExceededException" }, { "target": "com.amazonaws.connectscheduling#ThrottlingException" }, { "target": "com.amazonaws.connectscheduling#ValidationException" } ], "traits": { "smithy.api#documentation": "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 in AWAITING_APPROVAL until you call ApproveTimeOff or RejectTimeOff. 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 be PENDING while Connect Customer decides, and then ends APPROVED or REJECTED. If it overlaps another time off request for the user, the requested time off ends REJECTED with CONFLICTING_TIME_OFF_REQUEST. It also ends REJECTED if it overlaps overtime or voluntary time off. If the whole window is in the past, Connect Customer records failed rules as WARNING and doesn't reject the request, whatever the RuleFailureAction.
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.
", "smithy.api#examples": [ { "title": "To create a time off request that waits for approval", "documentation": "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.", "input": { "InstanceId": "12345678-1234-1234-1234-123456789012", "UserId": "87654321-4321-4321-4321-210987654321", "ShiftActivityId": "11112222-3333-4444-5555-666677778888", "StartAt": 1795424400, "EndAt": 1795453200, "Description": "Family event", "ApprovalType": "AWAIT_APPROVAL" }, "output": { "TimeOffId": "abcdef12-3456-7890-abcd-ef1234567890" } } ], "smithy.api#http": { "method": "POST", "uri": "/scheduling/instances/{InstanceId}/users/{UserId}/timeoffs", "code": 200 } } }, "com.amazonaws.connectscheduling#CreateTimeOffRequest": { "type": "structure", "members": { "InstanceId": { "target": "com.amazonaws.connectscheduling#InstanceIdOrArn", "traits": { "smithy.api#documentation": "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.
", "smithy.api#httpLabel": {}, "smithy.api#required": {} } }, "UserId": { "target": "com.amazonaws.connectscheduling#UserIdOrArn", "traits": { "smithy.api#documentation": "The identifier of the user who the time off request is for. This can be the ID or the ARN of the user.
", "smithy.api#httpLabel": {}, "smithy.api#required": {} } }, "ShiftActivityId": { "target": "com.amazonaws.connectscheduling#ShiftActivityIdOrArn", "traits": { "smithy.api#documentation": "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.
", "smithy.api#required": {} } }, "StartAt": { "target": "smithy.api#Timestamp", "traits": { "smithy.api#documentation": "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.
", "smithy.api#required": {} } }, "EndAt": { "target": "smithy.api#Timestamp", "traits": { "smithy.api#documentation": "The end of the time off window, exclusive. It must be after StartAt and no later than 24 months after the current date. Connect Customer stores the value as sent, to the millisecond.
A description recorded on the time off request. If you omit it, the request has no description.
" } }, "ApprovalType": { "target": "com.amazonaws.connectscheduling#ApprovalType", "traits": { "smithy.api#documentation": "Controls who approves the request. AWAIT_APPROVAL waits for an ApproveTimeOff or RejectTimeOff call. AUTOMATIC has Connect Customer decide the request. For details, see CreateTimeOff.
Controls what happens when a configured rule fails. REJECT, the default, records an ERROR and ends the request REJECTED, unless the whole window is in the past. OVERRIDE records a WARNING and ends the request APPROVED, like the Override time off rules option in the Connect Customer admin website. OVERRIDE requires AUTOMATIC. With AWAIT_APPROVAL, OVERRIDE fails with ValidationException. Set it on ApproveTimeOff instead. OVERRIDE never waives CONFLICTING_TIME_OFF_REQUEST.
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.
The request for CreateTimeOff.
The identifier of the time off request.
", "smithy.api#required": {} } } }, "traits": { "smithy.api#documentation": "The response for CreateTimeOff.
A description recorded on a time off request. This field is sensitive, and CloudTrail redacts it. To send no description, omit the member instead of sending an empty string.
", "smithy.api#length": { "min": 1, "max": 500 }, "smithy.api#sensitive": {} } }, "com.amazonaws.connectscheduling#Duration": { "type": "structure", "members": { "Value": { "target": "com.amazonaws.connectscheduling#DurationValue", "traits": { "smithy.api#documentation": "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,000 HOURS, or 36,500 DAYS.
The unit the value is counted in.
", "smithy.api#required": {} } } }, "traits": { "smithy.api#documentation": "A length of time, expressed as a value and the unit it is counted in.
" } }, "com.amazonaws.connectscheduling#DurationUnit": { "type": "enum", "members": { "MINUTES": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "MINUTES" } }, "HOURS": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "HOURS" } }, "DAYS": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "DAYS" } } }, "traits": { "smithy.api#documentation": "The unit a Duration value is counted in.
" } }, "com.amazonaws.connectscheduling#DurationValue": { "type": "integer", "traits": { "smithy.api#documentation": "A number of time units, which can be negative. It must stay within 876,000 hours (100 years) of zero: at most 52,560,000 MINUTES, 876,000 HOURS, or 36,500 DAYS.
Returns a time off request, including its current status and validation results.
", "smithy.api#examples": [ { "title": "To get a time off request", "documentation": "The following example gets a time off request that was approved past a failed group allowance rule, which is reported as a WARNING.", "input": { "InstanceId": "12345678-1234-1234-1234-123456789012", "UserId": "87654321-4321-4321-4321-210987654321", "TimeOffId": "abcdef12-3456-7890-abcd-ef1234567890" }, "output": { "TimeOffId": "abcdef12-3456-7890-abcd-ef1234567890", "UserId": "87654321-4321-4321-4321-210987654321", "ShiftActivityId": "11112222-3333-4444-5555-666677778888", "StartAt": 1795424400, "EndAt": 1795453200, "Status": "APPROVED", "Description": "Family event", "ValidationResults": [ { "Severity": "WARNING", "Code": "INSUFFICIENT_GROUP_TIME_OFF_ALLOWANCE" } ], "CreatedBy": { "ConnectUserArn": "arn:aws:connect:us-west-2:123456789012:instance/12345678-1234-1234-1234-123456789012/agent/87654321-4321-4321-4321-210987654321" }, "CreatedAt": 1793644200, "UpdatedBy": { "ConnectUserArn": "arn:aws:connect:us-west-2:123456789012:instance/12345678-1234-1234-1234-123456789012/agent/99998888-7777-6666-5555-444433332222" }, "UpdatedAt": 1793721900 } } ], "smithy.api#http": { "method": "GET", "uri": "/scheduling/instances/{InstanceId}/users/{UserId}/timeoffs/{TimeOffId}", "code": 200 }, "smithy.api#readonly": {}, "smithy.test#smokeTests": [ { "id": "GetTimeOffFailure", "params": { "InstanceId": "00000000-0000-0000-0000-000000000000", "UserId": "00000000-0000-0000-0000-000000000000", "TimeOffId": "00000000-0000-0000-0000-000000000000" }, "expect": { "failure": {} }, "vendorParamsShape": "aws.test#AwsVendorParams", "vendorParams": { "region": "us-west-2" } } ] } }, "com.amazonaws.connectscheduling#GetTimeOffRequest": { "type": "structure", "members": { "InstanceId": { "target": "com.amazonaws.connectscheduling#InstanceIdOrArn", "traits": { "smithy.api#documentation": "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.
", "smithy.api#httpLabel": {}, "smithy.api#required": {} } }, "UserId": { "target": "com.amazonaws.connectscheduling#UserIdOrArn", "traits": { "smithy.api#documentation": "The identifier of the user who the time off request belongs to. This can be the ID or the ARN of the user.
", "smithy.api#httpLabel": {}, "smithy.api#required": {} } }, "TimeOffId": { "target": "com.amazonaws.connectscheduling#TimeOffId", "traits": { "smithy.api#documentation": "The identifier of the time off request. If the time off request doesn't belong to UserId, the operation returns ResourceNotFoundException.
The request for GetTimeOff.
The identifier of the time off request.
", "smithy.api#required": {} } }, "UserId": { "target": "com.amazonaws.connectscheduling#UserId", "traits": { "smithy.api#documentation": "The identifier of the user the time off is for.
", "smithy.api#required": {} } }, "ShiftActivityId": { "target": "com.amazonaws.connectscheduling#ShiftActivityId", "traits": { "smithy.api#documentation": "The identifier of the shift activity for the time off request.
", "smithy.api#required": {} } }, "StartAt": { "target": "smithy.api#Timestamp", "traits": { "smithy.api#documentation": "The start of the time off window, inclusive, as sent to CreateTimeOff.
The end of the time off window, exclusive, as sent to CreateTimeOff.
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 request PENDING, so an APPROVED request can become PENDING and then end APPROVED or REJECTED.
AWAITING_APPROVAL: the request is waiting for an ApproveTimeOff or RejectTimeOff call.
The description of the time off request. CreateTimeOff sets it, and CancelTimeOff replaces or removes it. An edit in the Connect Customer admin website can also change it. GetTimeOff doesn't return descriptions sent with ApproveTimeOff or RejectTimeOff.
Warnings or failures produced while processing the time off request.
" } }, "CreatedBy": { "target": "com.amazonaws.connectscheduling#ActorInfo", "traits": { "smithy.api#documentation": "The identity that created the request. Immutable for the life of the request.
", "smithy.api#required": {} } }, "CreatedAt": { "target": "smithy.api#Timestamp", "traits": { "smithy.api#documentation": "The timestamp when the time off request was created.
", "smithy.api#required": {} } }, "UpdatedBy": { "target": "com.amazonaws.connectscheduling#ActorInfo", "traits": { "smithy.api#documentation": "The identity that made the most recent ApproveTimeOff, RejectTimeOff, or CancelTimeOff call 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 an AUTOMATIC request. UpdatedAt also changes when a PENDING request changes to another status and for other edits, which don't set UpdatedBy.
The timestamp when the time off request was last modified.
", "smithy.api#required": {} } } }, "traits": { "smithy.api#documentation": "The response for GetTimeOff.
The number of seconds to wait before retrying.
", "smithy.api#httpHeader": "Retry-After" } } }, "traits": { "smithy.api#documentation": "The request processing failed because of an error or failure with the service.
", "smithy.api#error": "server", "smithy.api#httpError": 500, "smithy.api#retryable": {} } }, "com.amazonaws.connectscheduling#Message": { "type": "string" }, "com.amazonaws.connectscheduling#PutTimeOffBalance": { "type": "operation", "input": { "target": "com.amazonaws.connectscheduling#PutTimeOffBalanceRequest" }, "output": { "target": "com.amazonaws.connectscheduling#PutTimeOffBalanceResponse" }, "errors": [ { "target": "com.amazonaws.connectscheduling#AccessDeniedException" }, { "target": "com.amazonaws.connectscheduling#ConflictException" }, { "target": "com.amazonaws.connectscheduling#InternalServerException" }, { "target": "com.amazonaws.connectscheduling#ResourceNotFoundException" }, { "target": "com.amazonaws.connectscheduling#ThrottlingException" }, { "target": "com.amazonaws.connectscheduling#ValidationException" } ], "traits": { "smithy.api#documentation": "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.
", "smithy.api#examples": [ { "title": "To set a user's time off balance", "documentation": "The following example sets a user's balance for one time off activity to 80 hours, replacing any existing balance.", "input": { "InstanceId": "12345678-1234-1234-1234-123456789012", "UserId": "87654321-4321-4321-4321-210987654321", "ShiftActivityId": "11112222-3333-4444-5555-666677778888", "Balance": { "Value": 80, "Unit": "HOURS" } }, "output": {} } ], "smithy.api#http": { "method": "PUT", "uri": "/scheduling/instances/{InstanceId}/users/{UserId}/timeoff-balances/{ShiftActivityId}", "code": 200 }, "smithy.api#idempotent": {} } }, "com.amazonaws.connectscheduling#PutTimeOffBalanceRequest": { "type": "structure", "members": { "InstanceId": { "target": "com.amazonaws.connectscheduling#InstanceIdOrArn", "traits": { "smithy.api#documentation": "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.
", "smithy.api#httpLabel": {}, "smithy.api#required": {} } }, "UserId": { "target": "com.amazonaws.connectscheduling#UserIdOrArn", "traits": { "smithy.api#documentation": "The identifier of the user whose balance is being updated. This can be the ID or the ARN of the user.
", "smithy.api#httpLabel": {}, "smithy.api#required": {} } }, "ShiftActivityId": { "target": "com.amazonaws.connectscheduling#ShiftActivityIdOrArn", "traits": { "smithy.api#documentation": "The identifier of the shift activity that the balance applies to. This can be the ID or the ARN of the shift activity.
", "smithy.api#httpLabel": {}, "smithy.api#required": {} } }, "Balance": { "target": "com.amazonaws.connectscheduling#Duration", "traits": { "smithy.api#documentation": "The new time off balance for the user and activity. It replaces the existing balance.
", "smithy.api#required": {} } } }, "traits": { "smithy.api#documentation": "The request for PutTimeOffBalance.
The response for PutTimeOffBalance.
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.
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.
", "smithy.api#httpLabel": {}, "smithy.api#required": {} } }, "UserId": { "target": "com.amazonaws.connectscheduling#UserIdOrArn", "traits": { "smithy.api#documentation": "The identifier of the user who the time off request belongs to. This can be the ID or the ARN of the user.
", "smithy.api#httpLabel": {}, "smithy.api#required": {} } }, "TimeOffId": { "target": "com.amazonaws.connectscheduling#TimeOffId", "traits": { "smithy.api#documentation": "The unique identifier of the time off request to reject. If the time off request doesn't belong to UserId, the operation returns ResourceNotFoundException.
A description recorded with the rejection, such as the reason. GetTimeOff doesn't return it.
The request for RejectTimeOff.
The response for RejectTimeOff.
The identifier or ARN of the resource that was not found.
" } }, "ResourceType": { "target": "smithy.api#String", "traits": { "smithy.api#documentation": "The type of the resource that was not found.
" } } }, "traits": { "smithy.api#documentation": "The specified resource was not found.
", "smithy.api#error": "client", "smithy.api#httpError": 404 } }, "com.amazonaws.connectscheduling#RuleFailureAction": { "type": "enum", "members": { "REJECT": { "target": "smithy.api#Unit", "traits": { "smithy.api#documentation": "The failed rule is recorded as an ERROR and the request ends REJECTED.
The failed rule is recorded as a WARNING instead and the request ends APPROVED. Overlap with another time off request for the user that is APPROVED or being approved (CONFLICTING_TIME_OFF_REQUEST) is always an ERROR and is never waived.
Controls what happens when a configured rule fails during rule evaluation. REJECT records the failure as an ERROR and ends the request REJECTED. OVERRIDE records it as a WARNING and ends the request APPROVED.
The code of the quota that would be exceeded, for use with the Service Quotas API.
" } }, "ServiceCode": { "target": "smithy.api#String", "traits": { "smithy.api#documentation": "The code of the service that owns the quota.
" } }, "ResourceId": { "target": "smithy.api#String", "traits": { "smithy.api#documentation": "The identifier or ARN of the resource whose quota would be exceeded.
" } }, "ResourceType": { "target": "smithy.api#String", "traits": { "smithy.api#documentation": "The type of the resource whose quota would be exceeded.
" } } }, "traits": { "smithy.api#documentation": "The request would cause a service quota to be exceeded.
", "smithy.api#error": "client", "smithy.api#httpError": 402 } }, "com.amazonaws.connectscheduling#ShiftActivityId": { "type": "string", "traits": { "smithy.api#documentation": "The identifier of the shift activity associated with the time off request.
", "smithy.api#length": { "min": 1, "max": 255 } } }, "com.amazonaws.connectscheduling#ShiftActivityIdOrArn": { "type": "string", "traits": { "smithy.api#documentation": "The identifier of the shift activity. You can specify either of the following:
The shift activity ID.
The ARN of the shift activity.
The response returns ShiftActivityId.
The code of the quota that was throttled, for use with the Service Quotas API.
" } }, "ServiceCode": { "target": "smithy.api#String", "traits": { "smithy.api#documentation": "The code of the service that owns the quota.
" } }, "RetryAfterSeconds": { "target": "smithy.api#Integer", "traits": { "smithy.api#documentation": "The number of seconds to wait before retrying.
", "smithy.api#httpHeader": "Retry-After" } } }, "traits": { "smithy.api#documentation": "The request was denied due to request throttling.
", "smithy.api#error": "client", "smithy.api#httpError": 429, "smithy.api#retryable": { "throttling": true } } }, "com.amazonaws.connectscheduling#TimeOffId": { "type": "string", "traits": { "smithy.api#documentation": "The identifier of the time off request. Connect Customer generates it.
", "smithy.api#length": { "min": 1, "max": 64 }, "smithy.api#pattern": "^[a-z0-9-]+$" } }, "com.amazonaws.connectscheduling#TimeOffStatus": { "type": "enum", "members": { "PENDING": { "target": "smithy.api#Unit", "traits": { "smithy.api#documentation": "Connect Customer is processing a change to the request, such as a create, approval, rejection, or cancellation, or an edit in the Connect Customer admin website. The request changes to another status when processing completes.
", "smithy.api#enumValue": "PENDING" } }, "APPROVED": { "target": "smithy.api#Unit", "traits": { "smithy.api#documentation": "The request passed rule evaluation, or a failed rule was overridden with RuleFailureAction OVERRIDE, and the time off is applied to the user's schedule.
The request was rejected, either explicitly or by a failed rule during rule evaluation.
", "smithy.api#enumValue": "REJECTED" } }, "CANCELLED": { "target": "smithy.api#Unit", "traits": { "smithy.api#documentation": "The request is cancelled.
", "smithy.api#enumValue": "CANCELLED" } }, "AWAITING_APPROVAL": { "target": "smithy.api#Unit", "traits": { "smithy.api#documentation": "The request is waiting for an ApproveTimeOff or RejectTimeOff decision.
The status of a time off request. PENDING means Connect Customer is processing a change to the request. AWAITING_APPROVAL means the request is waiting for a decision.
The user's own time off balance for the requested activity is less than the time this request deducts. Connect Customer deducts only working time in the request window, not the full window.
", "smithy.api#enumValue": "INSUFFICIENT_USER_TIME_OFF_BALANCE" } }, "INSUFFICIENT_GROUP_TIME_OFF_ALLOWANCE": { "target": "smithy.api#Unit", "traits": { "smithy.api#documentation": "The time off allowance shared by the user's forecast or demand group for the requested activity is too low to cover this request.
", "smithy.api#enumValue": "INSUFFICIENT_GROUP_TIME_OFF_ALLOWANCE" } }, "INSUFFICIENT_STAFFING_GROUP_TIME_OFF_ALLOWANCE": { "target": "smithy.api#Unit", "traits": { "smithy.api#documentation": "The daily time off allowance shared by the user's staffing group for the requested activity is too low to cover this request.
", "smithy.api#enumValue": "INSUFFICIENT_STAFFING_GROUP_TIME_OFF_ALLOWANCE" } }, "CONFLICTING_TIME_OFF_REQUEST": { "target": "smithy.api#Unit", "traits": { "smithy.api#documentation": "The requested period overlaps another time off request for the user that is APPROVED or being approved. On CreateTimeOff with AUTOMATIC, overlapping overtime and voluntary time off activities count too. ApproveTimeOff cancels them instead.
The specific reason for a time off validation result. New values may be added over time, so treat an unrecognized value as a generic failure of the severity reported with it.
" } }, "com.amazonaws.connectscheduling#TimeOffValidationResult": { "type": "structure", "members": { "Severity": { "target": "com.amazonaws.connectscheduling#TimeOffValidationSeverity", "traits": { "smithy.api#documentation": "The severity of the validation result. WARNING is a breach of the configured rules that is not enough to reject the request, either because of the rules configuration or because the caller sent RuleFailureAction OVERRIDE. ERROR is a reason the request was rejected.
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 is APPROVED or being approved. Requests in AWAITING_APPROVAL don't count. For CreateTimeOff with AUTOMATIC, overlapping overtime and voluntary time off also count.
A warning or failure produced while processing the time off request.
" } }, "com.amazonaws.connectscheduling#TimeOffValidationResults": { "type": "list", "member": { "target": "com.amazonaws.connectscheduling#TimeOffValidationResult" }, "traits": { "smithy.api#documentation": "A list of warnings or failures produced while processing the time off request.
" } }, "com.amazonaws.connectscheduling#TimeOffValidationSeverity": { "type": "enum", "members": { "WARNING": { "target": "smithy.api#Unit", "traits": { "smithy.api#documentation": "This validation result is a breach of the configured rules that is not sufficient to reject the request, either due to rules configuration or because the caller sent RuleFailureAction OVERRIDE.
This validation result is a reason the request was rejected.
", "smithy.api#enumValue": "ERROR" } } }, "traits": { "smithy.api#documentation": "The severity of a time off validation result.
" } }, "com.amazonaws.connectscheduling#UserId": { "type": "string", "traits": { "smithy.api#documentation": "The identifier of the user.
", "smithy.api#length": { "min": 1, "max": 255 } } }, "com.amazonaws.connectscheduling#UserIdOrArn": { "type": "string", "traits": { "smithy.api#documentation": "The identifier of the user. You can specify either of the following:
The user ID.
The ARN of the user.
The response returns UserId.
The reason the input failed validation. Branch on this value rather than on the message wording.
" } }, "FieldList": { "target": "com.amazonaws.connectscheduling#ValidationExceptionFieldList", "traits": { "smithy.api#documentation": "The specific input fields that failed validation, when Reason is FIELD_VALIDATION_FAILED.
The input fails to satisfy the constraints specified by an AWS service.
", "smithy.api#error": "client", "smithy.api#httpError": 400 } }, "com.amazonaws.connectscheduling#ValidationExceptionField": { "type": "structure", "members": { "Name": { "target": "smithy.api#String", "traits": { "smithy.api#documentation": "The path to the field that failed validation, using JSON pointer-style dotted notation for nested members.
", "smithy.api#required": {} } }, "Message": { "target": "smithy.api#String", "traits": { "smithy.api#documentation": "A message describing why the field failed validation.
", "smithy.api#required": {} } } }, "traits": { "smithy.api#documentation": "An input field that failed validation.
" } }, "com.amazonaws.connectscheduling#ValidationExceptionFieldList": { "type": "list", "member": { "target": "com.amazonaws.connectscheduling#ValidationExceptionField" }, "traits": { "smithy.api#documentation": "A list of input fields that failed validation.
" } }, "com.amazonaws.connectscheduling#ValidationExceptionReason": { "type": "enum", "members": { "UNKNOWN_OPERATION": { "target": "smithy.api#Unit", "traits": { "smithy.api#documentation": "The request referenced an operation that does not exist.
", "smithy.api#enumValue": "UNKNOWN_OPERATION" } }, "CANNOT_PARSE": { "target": "smithy.api#Unit", "traits": { "smithy.api#documentation": "The request body could not be parsed.
", "smithy.api#enumValue": "CANNOT_PARSE" } }, "FIELD_VALIDATION_FAILED": { "target": "smithy.api#Unit", "traits": { "smithy.api#documentation": "One or more input fields failed validation. See FieldList.
The input is invalid for a reason not covered by the other values.
", "smithy.api#enumValue": "OTHER" } } }, "traits": { "smithy.api#documentation": "The reason an input failed validation. New values may be added over time, so treat an unrecognized value as a generic validation failure.
" } } } }