GetEffectiveHoursOfOperations
Get the hours of operations with the effective override applied.
Request Syntax
GET /effective-hours-of-operations/InstanceId/HoursOfOperationId?fromDate=FromDate&toDate=ToDate HTTP/1.1
URI Request Parameters
The request uses the following URI parameters.
- FromDate
-
The date from when the hours of operation are listed.
Pattern:
^\d{4}-\d{2}-\d{2}$Required: Yes
- HoursOfOperationId
-
The identifier for the hours of operation.
Required: Yes
- InstanceId
-
The identifier of the Amazon Connect instance.
Length Constraints: Minimum length of 1. Maximum length of 100.
Required: Yes
- ToDate
-
The date until when the hours of operation are listed.
Pattern:
^\d{4}-\d{2}-\d{2}$Required: Yes
Request Body
The request does not have a request body.
Response Syntax
HTTP/1.1 200
Content-type: application/json
{
"EffectiveHoursOfOperationList": [
{
"Date": "string",
"OperationalHours": [
{
"End": {
"Hours": number,
"Minutes": number
},
"Start": {
"Hours": number,
"Minutes": number
}
}
]
}
],
"TimeZone": "string"
}Response Elements
If the action is successful, the service sends back an HTTP 200 response.
The following data is returned in JSON format by the service.
- EffectiveHoursOfOperationList
-
Information about the effective hours of operations.
Type: Array of EffectiveHoursOfOperations objects
- TimeZone
-
The time zone for the hours of operation.
Type: String
Errors
For information about the errors that are common to all actions, see Common Errors.
- InternalServiceException
-
Request processing failed because of an error or failure with the service.
- Message
-
The message.
HTTP Status Code: 500
- InvalidParameterException
-
One or more of the specified parameters are not valid.
- Message
-
The message about the parameters.
HTTP Status Code: 400
- InvalidRequestException
-
The request is not valid.
- Message
-
The message about the request.
- Reason
-
Reason why the request was invalid.
HTTP Status Code: 400
- ResourceNotFoundException
-
The specified resource was not found.
- Message
-
The message about the resource.
HTTP Status Code: 404
- ThrottlingException
-
The throttling limit has been exceeded.
HTTP Status Code: 429
See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
